Skip to main content

getOnchainEarnings

Get onchain earnings for a wallet including total, current, and lifetime earnings.

Signature​

getOnchainEarnings(walletAddress: string): Promise<OnchainEarningsResponse>

Parameters​

ParameterTypeRequiredDescription
walletAddressstring✅Smart wallet address

Returns​

Onchain earnings data with breakdowns by chain

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.getOnchainEarnings("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"]);

// Earnings by chain
console.log("Earnings by chain:", earnings.data.currentEarningsByChain);
// { "8453": { "USDC": 50.25, "WETH": 0.02 }, "42161": { "USDC": 100.25 } }