> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peaq.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Claim Yield

## `vault.claimYield(ClaimYield)`

Claim yield from a vault’s reward distributor. Yield is sent to the claimer.

### ClaimYield Type Parameters

| Parameter         | Type     | Required | Description                                                |
| ----------------- | -------- | -------- | ---------------------------------------------------------- |
| **claimerSigner** | `Signer` | Required | Signer that claims yield. Must be connected to a provider. |
| **vault**         | `string` | Required | Vault address.                                             |

### Returns

| Field                 | Type                 | Description                                                  |
| --------------------- | -------------------- | ------------------------------------------------------------ |
| **status**            | `claimed`            | Status of the operation.                                     |
| **vault**             | `string`             | Vault address.                                               |
| **rewardDistributor** | `string`             | Reward distributor contract address.                         |
| **claimer**           | `string`             | Address that submitted the transaction (recipient of yield). |
| **receipt**           | `TransactionReceipt` | Transaction receipt for the claim call.                      |

### Usage

#### TypeScript

```TypeScript theme={"theme":{"light":"github-light-default","dark":"github-dark"}}
import 'dotenv/config';
import { RWA, Chain, type SDKInit } from "@peaq-network/rwa";
import { JsonRpcProvider, Wallet } from "ethers";

async function main() {
  // 0. Create RWA instance and get provider
  const provider = new JsonRpcProvider(process.env.HTTPS_BASE_URL);
  const init: SDKInit = { chainId: Chain.AGUNG, provider: provider };
  const rwa_sdk = new RWA(init);

  // 1. Claimer signer
  const bob = new Wallet(process.env.BOB_PRIVATE_KEY!, provider);

  // 2. Claim yield
  const result = await rwa_sdk.vault.claimYield({
    claimerSigner: bob,
    vault: "0x907229D0A25A5Bb16F0ff3D890f38Eb4Ad52Ea1a"
  });
  console.log("Result", result);
}

main().catch((err) => {
  console.error(err);
  process.exit(1);
});
```

#### JavaScript

```js theme={"theme":{"light":"github-light-default","dark":"github-dark"}}
import 'dotenv/config';
import { RWA, Chain } from "@peaq-network/rwa";
import { JsonRpcProvider, Wallet } from "ethers";

async function main() {
  // 0. Create RWA instance and get provider
  const provider = new JsonRpcProvider(process.env.HTTPS_BASE_URL);
  const rwa_sdk = new RWA({ chainId: Chain.AGUNG, provider });

  // 1. Claimer signer
  const bob = new Wallet(process.env.BOB_PRIVATE_KEY, provider);

  // 2. Claim yield
  const result = await rwa_sdk.vault.claimYield({
    claimerSigner: bob,
    vault: "0x907229D0A25A5Bb16F0ff3D890f38Eb4Ad52Ea1a"
  });
  console.log("Result", result);
}

main().catch((err) => {
  console.error(err);
  process.exit(1);
});
```

### Example outputs

```
Result {
  status: 'claimed',
  vault: '0x907229D0A25A5Bb16F0ff3D890f38Eb4Ad52Ea1a',
  rewardDistributor: '0x...',
  claimer: '0x16cd4D21537eD8F33bE08271A9FA6DCC426709b2',
  receipt: ContractTransactionReceipt {
    ...
  }
}
```