Skip to main content

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.

​
vault.claimYieldTo(ClaimYieldTo)

Claim yield from a vault’s reward distributor and send it to a specified address.

​
ClaimYieldTo Type Parameters

ParameterTypeRequiredDescription
claimerSignerSignerRequiredSigner that submits the claim. Must be connected to a provider.
vaultstringRequiredVault address.
tostringRequiredRecipient address for the claimed yield.

​
Returns

FieldTypeDescription
statusclaimedStatus of the operation.
vaultstringVault address.
rewardDistributorstringReward distributor contract address.
claimerstringAddress that submitted the transaction.
recipientstringAddress that received the yield.
receiptTransactionReceiptTransaction receipt for the claim call.

​
Usage

​
TypeScript

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 alice = new Wallet(process.env.ALICE_PRIVATE_KEY!, provider);

  // 2. Recipient of yield
  const charlie = process.env.CHARLIE_PUBLIC_ADDRESS!

  // 3. Claim yield to Bob
  const result = await rwa_sdk.vault.claimYieldTo({
    claimerSigner: alice,
    vault: "0x907229D0A25A5Bb16F0ff3D890f38Eb4Ad52Ea1a",
    to: charlie
  });
  console.log("Result", result);
}

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

​
JavaScript

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 alice = new Wallet(process.env.ALICE_PRIVATE_KEY, provider);

  // 2. Recipient of yield
  const charlie = process.env.CHARLIE_PUBLIC_ADDRESS

  // 3. Claim yield to Bob
  const result = await rwa_sdk.vault.claimYieldTo({
    claimerSigner: alice,
    vault: "0x907229D0A25A5Bb16F0ff3D890f38Eb4Ad52Ea1a",
    to: charlie
  });
  console.log("Result", result);
}

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

​
Example outputs

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