claimEarnRewards

​

Function Signature

claimEarnRewards(params: {
  vaultId: string;
  walletMetadata: WalletMetadata;
  password?: string;
  externalServerKeyShares?: ServerKeyShare[];
  sponsored?: boolean;
  chain?: Chain;
  rpcUrl?: string;
  onStepChange?: (step: EarnExecutionStep) => 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 'EVM'.

​

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, relays the claim as a gasless transaction. See EVM Gas Sponsorship.
• chain (Chain): The viem chain for the vault. Its id must match the vault’s chainId. When omitted, the chain is built from rpcUrl, so one of chain or rpcUrl is required.
• rpcUrl (string): RPC endpoint for the vault’s chain.
• onStepChange ((step: EarnExecutionStep) => void): Reports transaction as execution proceeds.
• traceContext (TraceContext): Trace context forwarded to the Dynamic API.

​

Returns

• Promise<EarnTransactionResult>: An object with transactionHash, the hash of the claim transaction.

​

Example

import { authenticatedEvmClient } from './client';

const evmClient = await authenticatedEvmClient();

const { transactionHash } = await evmClient.claimEarnRewards({
  vaultId: 'steakhouse-prime-usdc',
  walletMetadata,
  externalServerKeyShares,
  password: 'user-password',
  rpcUrl: 'https://mainnet.base.org',
});

​

Error Handling

​

See Also

• Earn
• getRewards
• executeEarnTransaction