getVaultDetails

Returns the full details of a single Earn vault

Function Signature

client.earn.getVaultDetails(
  vaultId: string,
  options?: {
    traceContext?: TraceContext;
  }
): Promise<EarnVaultDetails>

Description

Returns the full details of one Earn vault, including the on-chain fields you need to display and transact against it, such as the vault and asset addresses and assetDecimals.

Available as client.earn on DynamicEvmWalletClient and DynamicSvmWalletClient.

Parameters

Required Parameters

• vaultId (string): The vault identifier from listVaults.

Optional Parameters

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

Returns

• Promise<EarnVaultDetails>: The vault’s full details.

Example

import { authenticatedEvmClient } from './client';

const evmClient = await authenticatedEvmClient();
const vault = await evmClient.earn.getVaultDetails('steakhouse-prime-usdc');

console.log(vault.assetSymbol, vault.assetDecimals);

Error Handling

Fails with an HTTP 403 error when Earn is not enabled for your environment, or an HTTP 404 error when the vaultId is unknown.

See Also

• Earn
• listVaults