getYieldEarnings

getYieldEarnings

Gets a wallet’s Earn earnings across every vault it holds on one chain: aggregate USD totals plus a per-vault breakdown.

For Morpho vaults, the values are indexed by Morpho rather than read on-chain, so they trail the chain head by a short delay. getYieldPosition stays the source of truth for what a position is worth right now; use this function for earnings and PNL. Morpho aggregates per chain, so chainId is required and Vault V1 positions are not covered.

The response combines positions from every provider on the chain. Not every provider reports a cost basis for a position. For a vault whose provider does not, the entry in vaults still carries assets and assetsUsd, but pnl, pnlUsd, and roe are null. Those positions add to totalAssetsUsd and add nothing to totalPnlUsd, so totalPnlUsd covers only positions from providers that report a cost basis.

Aggregate totals come back in USD only, because per-vault earnings are denominated in different underlying assets and are not additive. A vault with no USD price is skipped from the totals, not counted as zero.

Positions in vaults the environment does not offer are still included, with vaultId set to null for those entries.

This function covers Morpho and Aave positions on EVM chains. It requires an EVM wallet account, so a Solana wallet account is rejected with an HTTP 400 error, and positions in Solana vaults are not included in any result. To show a wallet’s balance in a Solana vault, use getYieldPosition.

Usage

import { getYieldEarnings } from '@dynamic-labs-sdk/client';

const earnings = await getYieldEarnings({
  chainId: 8453, // Base
  walletAccount,
});

console.log(earnings.totalPnlUsd); // aggregate PNL in USD
console.log(earnings.vaults.length); // per-vault breakdown

Parameters

Parameter	Type	Description
chainId	number	EVM chain ID on which the wallet’s earnings are aggregated (e.g. 8453 for Base).
walletAccount	WalletAccount	The EVM wallet account whose earnings are being read.
client	DynamicClient (optional)	The Dynamic client instance. Only required when using multiple Dynamic clients.

Returns

Promise<YieldEarnings> - The wallet’s aggregate USD totals and per-vault earnings.

Field	Type	Description
chainId	number	The chain the earnings were aggregated on.
ownerAddress	string	The wallet address the earnings were read for.
totalAssetsUsd	number	Total position value across vaults, in USD.
totalPnlUsd	number	Total profit or loss across vaults whose provider reports it, in USD.
vaults	YieldVaultEarnings[]	Per-vault earnings entries.

Each entry in vaults:

Field	Type	Description
vaultId	string | null	Opaque vault identifier, or null for vaults the environment does not offer.
vaultAddress	string	Contract address of the vault.
assets	string	Current position value in raw underlying-token units. Divide by assetDecimals before display.
assetsUsd	number | null	Position value in USD, or null when the vault has no USD price.
pnl	string | null	Profit or loss in raw underlying-token units. null when the provider does not report a cost basis.
pnlUsd	number | null	Profit or loss in USD, or null when the vault has no USD price or the provider does not report a cost basis.
roe	number | null	Time-weighted, non-annualized return as a decimal. null when there is too little history or the provider does not report a cost basis.

Examples

List per-vault earnings

import { getYieldDetails, getYieldEarnings } from '@dynamic-labs-sdk/client';
import { formatUnits } from 'viem';

const earnings = await getYieldEarnings({ chainId: 8453, walletAccount });

for (const vault of earnings.vaults) {
  if (vault.vaultId === null || vault.pnl === null) {
    continue; // vault not offered here, or no PNL available (for example, the provider reports no cost basis)
  }

  // `pnl` is a raw string in the vault's underlying-token units, like `assets`
  // from getYieldPosition, so format it with the vault's `assetDecimals`.
  const details = await getYieldDetails({ vaultId: vault.vaultId });
  const pnl = formatUnits(BigInt(vault.pnl), details.assetDecimals);
  console.log(`${details.assetSymbol}: ${pnl} (${vault.pnlUsd ?? 'n/a'} USD)`);
}

React

useGetYieldEarnings is a query hook that stays disabled until walletAccount is defined, safe to render before a wallet is connected.

import { useGetYieldEarnings } from '@dynamic-labs-sdk/react-hooks';
import type { WalletAccount } from '@dynamic-labs-sdk/client';

function TotalEarnings({
  chainId,
  walletAccount,
}: {
  chainId: number;
  walletAccount: WalletAccount | undefined;
}) {
  const { data: earnings, isLoading } = useGetYieldEarnings({
    chainId,
    walletAccount,
  });

  if (isLoading) {
    return <p>Loading earnings...</p>;
  }

  return <p>Total PNL: ${earnings?.totalPnlUsd.toFixed(2) ?? '0.00'}</p>;
}

Related

• getYieldPerformance - The wallet’s earnings in a single vault
• getYieldPosition - The wallet’s current balance in a vault
• listYieldVaults - The vaults available to the environment