Skip to content

API ReferenceVaults, collateral, and riskInterface

DeriveWithdrawableCollateralParams

Inputs for a withdrawal preview over explicitly supplied current-state reads.

Properties

accountAddress

accountAddress: `0x${string}`;

Account that owns the balances and creates the LOCs.


balances

balances: readonly CollateralTokenBalance[];

Vault-scoped balances, including each vault to preview.


chainId

chainId: bigint;

Chain shared by the balances and LOCs.


evaluatedAtTimestamp

evaluatedAtTimestamp: bigint;

Unix-second clock; equality with expiration permits cancellation.


locContractAddress

locContractAddress: `0x${string}`;

LOC proxy whose expired reservations may be released.


locs

locs: readonly OutstandingLetterOfCredit[];

Current outstanding LOCs; incomplete discovery produces an incomplete preview.