Skip to main content

calculateOnchainEarnings

Calculate/refresh onchain earnings for a wallet. Triggers a recalculation on the backend.

Signature​

calculateOnchainEarnings(walletAddress: string): Promise<OnchainEarningsResponse>

Parameters​

ParameterTypeRequiredDescription
walletAddressstring✅Smart wallet address

Returns​

Updated onchain earnings data

Return Type​

// TokenEarnings is a record of token symbols to amounts
type TokenEarnings = Record<string, number>;  // e.g., { "USDC": 100.5, "WETH": 0.025 }

interface OnchainEarningsResponse {
  success: boolean;
  data: {
    walletAddress: string;
    totalEarningsByToken: TokenEarnings;
    lifetimeEarningsByToken: TokenEarnings;
    currentEarningsByChain: Record<string, TokenEarnings>;
    unrealizedEarningsByChain: Record<string, TokenEarnings>;
    lastCheckTimestamp?: string;
  };
}

Example​

const earnings = await sdk.calculateOnchainEarnings("0x...");

console.log("Total earnings by token:", earnings.data.totalEarningsByToken);
// { "USDC": 150.50, "WETH": 0.05 }

console.log("USDC earnings:", earnings.data.totalEarningsByToken["USDC"]);
console.log("WETH earnings:", earnings.data.totalEarningsByToken["WETH"]);