executeEarnTransaction

​

Function Signature

executeEarnTransaction(params: {
  signingPayload: EarnSigningPayload;
  walletMetadata: WalletMetadata;
  password?: string;
  externalServerKeyShares?: ServerKeyShare[];
  sponsored?: boolean;
  rpcUrl?: string;
  chainId?: string;
  context?: SignMessageContext;
  onStepChange?: (step: EarnExecutionStep) => void;
  onTransactionStepChange?: (step: EarnTransactionStepProgress) => void;
}): 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 '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 through Dynamic gas sponsorship. Vault transactions are built with the owner as fee payer, unlike the browser SDK which sponsors automatically. 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.

​

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 signingPayload = await svmClient.earn.prepareDeposit({
  vaultId: 'kamino-usdc-steakhouse',
  ownerAddress: walletMetadata.accountAddress,
  amount: '12.5',
});

const { transactionHash } = await svmClient.executeEarnTransaction({
  signingPayload,
  walletMetadata,
  externalServerKeyShares,
  password: 'user-password',
  onTransactionStepChange: ({ ordinal, total }) =>
    console.log(`Sent transaction ${ordinal + 1} of ${total}`),
});

​

Error Handling

​

See Also

• Earn
• depositToEarnVault
• withdrawFromEarnVault
• claimEarnRewards