Skip to main content

Function Signature

Description

Returns every Earn vault enabled for your environment. Each summary carries the fields needed to browse vaults, including vaultId, provider, chainId, chainName, assetSymbol, curator, netApy, and tvlUsd. netApy and tvlUsd come from live market data on a best-effort basis, so both can be null when that data is unavailable. Available as client.earn on DynamicEvmWalletClient and DynamicSvmWalletClient.

Parameters

Optional Parameters

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

Returns

  • Promise<EarnVaultSummary[]>: The vaults enabled for the environment. Empty when none are enabled.

Example

Error Handling

Fails with an HTTP 403 error when Earn is not enabled for your environment.

See Also

Last modified on October 29, 2026