getPerformance

Returns the indexed performance of an owner’s Earn vault position

Function Signature

client.earn.getPerformance(params: {
  vaultId: string;
  ownerAddress: string;
  traceContext?: TraceContext;
}): Promise<EarnVaultPositionPerformance>

Description

Returns the indexed performance of an owner’s position in an Earn vault, including profit-and-loss fields such as pnl and pnlUsd. The data comes from the indexer, so it trails the chain head.

Available as client.earn on DynamicEvmWalletClient and DynamicSvmWalletClient.

Aave vaults reject performance requests with an HTTP 400 error. This is a provider limitation, not a bug. See Provider support.

Parameters

Required Parameters

• vaultId (string): The vault identifier from listVaults.
• ownerAddress (string): The wallet address that owns the position.

Optional Parameters

• traceContext (TraceContext): Trace context forwarded to the Dynamic API.

Returns

• Promise<EarnVaultPositionPerformance>: The position’s indexed performance. Amounts are raw-unit strings.

Example

import { authenticatedEvmClient } from './client';

const evmClient = await authenticatedEvmClient();

const performance = await evmClient.earn.getPerformance({
  vaultId: 'steakhouse-prime-usdc',
  ownerAddress: walletMetadata.accountAddress,
});

console.log(`PnL: ${performance.pnlUsd} USD`);

Error Handling

Fails with an HTTP 403 error when Earn is not enabled for your environment, or an HTTP 400 error when the vault’s provider does not support performance lookups.

See Also

• Earn
• getPosition
• getEarnings