Skip to content

API ReferenceVaults, collateral, and riskFunction

vaultCollateralBalanceQuery()

function vaultCollateralBalanceQuery(sdk, params): AnvilQueryDefinition<CollateralBalance>;

Defines the current available/reserved balance for one account and token in one vault.

Parameters

ParameterTypeDescription
sdkAnvilSDKSDK selecting the provider chain and compatible vault interface.
paramsGetVaultCollateralBalanceParamsToken, optional account and optional historical vault. Defaults are captured when defining the query.

Returns

AnvilQueryDefinition<CollateralBalance>

A serializable query identity and a narrow chain read, independent of token metadata, reservations and periphery.

Throws

InvalidArgumentError during execution for an invalid vault or token; WalletNotConnectedError when no account is available; ConfigError for a provider/profile chain mismatch. Provider errors propagate.

Example

const query = vaultCollateralBalanceQuery(sdk, { tokenAddress, accountAddress });