claimEarnRewards

​

Function Signature

claimEarnRewards(params: {
  vaultId: string;
  walletMetadata: WalletMetadata;
  password?: string;
  externalServerKeyShares?: ServerKeyShare[];
  sponsored?: boolean;
  rpcUrl?: string;
  chainId?: string;
  context?: SignMessageContext;
  onStepChange?: (step: EarnExecutionStep) => void;
  onTransactionStepChange?: (step: EarnTransactionStepProgress) => void;
  traceContext?: TraceContext;
}): Promise<EarnTransactionResult>

​

Description

​

Parameters

​

Required Parameters

• vaultId (string): The vault identifier from listVaults.
• walletMetadata (WalletMetadata): Non-sensitive wallet metadata persisted from createWalletAccount() / importPrivateKey(). Its chainName must be 'SVM'.

​

Optional Parameters

• password (string): Required if the wallet was created with backUpToDynamic: true. Used for backup decryption when externalServerKeyShares is not provided.
• externalServerKeyShares (ServerKeyShare[]): Caller-supplied plaintext shares.
• sponsored (boolean): When true, sponsors every transaction in the sequence. See SVM Gas Sponsorship.
• rpcUrl (string): Solana RPC endpoint. Defaults to the public cluster for the payload’s chainId (101 mainnet, 103 devnet).
• chainId (string): The Solana chain identifier.
• context (SignMessageContext): Signing context forwarded to the transaction signer.
• onStepChange ((step: EarnExecutionStep) => void): Reports transaction once per transaction in the sequence.
• onTransactionStepChange ((step: EarnTransactionStepProgress) => void): Invoked as each transaction is about to be signed, with its ordinal, the total, and an optional label.
• traceContext (TraceContext): Trace context forwarded to the Dynamic API.

​

Returns

• Promise<EarnTransactionResult>: An object with transactionHash, the signature of the last transaction in the sequence.

​

Example

import { authenticatedSvmClient } from './client';

const svmClient = await authenticatedSvmClient();

const { transactionHash } = await svmClient.claimEarnRewards({
  vaultId: 'kamino-usdc-steakhouse',
  walletMetadata,
  externalServerKeyShares,
  password: 'user-password',
});

​

Error Handling

​

See Also

• Earn
• getRewards
• executeEarnTransaction