executeEarnTransaction

​

Function Signature

executeEarnTransaction(params: {
  signingPayload: EarnSigningPayload;
  walletMetadata: WalletMetadata;
  password?: string;
  externalServerKeyShares?: ServerKeyShare[];
  sponsored?: boolean;
  chain?: Chain;
  rpcUrl?: string;
  onStepChange?: (step: EarnExecutionStep) => void;
  traceContext?: TraceContext;
}): Promise<EarnTransactionResult>

​

Description

​

Parameters

​

Required Parameters

• signingPayload (EarnSigningPayload): The payload from prepareDeposit, prepareWithdrawal, or prepareClaimRewards.
• 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. If omitted, the SDK recovers from backup using password.
• sponsored (boolean): When true, relays the approval and vault call as one gasless batch. See EVM Gas Sponsorship.
• chain (Chain): The viem chain for the vault. Its id must match the payload’s chainId. When omitted, the chain is built from the payload’s chainId and rpcUrl, so one of chain or rpcUrl is required.
• rpcUrl (string): RPC endpoint for the vault’s chain. Also used by the relayer to read the wallet’s on-chain state when sponsored is set.
• onStepChange ((step: EarnExecutionStep) => void): Reports approval then transaction as execution proceeds.
• traceContext (TraceContext): Trace context forwarded to the Dynamic API.

​

Returns

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

​

Example

import { authenticatedEvmClient } from './client';
import { base } from 'viem/chains';

const evmClient = await authenticatedEvmClient();

const signingPayload = await evmClient.earn.prepareDeposit({
  vaultId: 'steakhouse-prime-usdc',
  ownerAddress: walletMetadata.accountAddress,
  amount: '12.5',
});

const { transactionHash } = await evmClient.executeEarnTransaction({
  signingPayload,
  walletMetadata,
  externalServerKeyShares,
  password: 'user-password',
  chain: base,
  onStepChange: (step) => console.log(`Step: ${step}`),
});

​

Error Handling

​

See Also

• Earn
• depositToEarnVault
• withdrawFromEarnVault
• claimEarnRewards