Skip to content

API ReferenceVaults, collateral, and riskInterface

CollateralReservation

Generic vault reservation facts. The reserving contract does not imply a product such as a LOC or pool.

Properties

accountAddress

accountAddress: `0x${string}`;

Account whose collateral was reserved.


active

active: boolean;

Indexed reads retain deleted reservations as inactive; chain reads return undefined for erased storage.


claimableAmount

claimableAmount: bigint;

Current amount claimable by the reserving contract, in the reserved token. Zero after deletion.


claimFeeBasisPoints

claimFeeBasisPoints: number;

Claim fee fixed when the reservation was created.


reference

reference: CollateralReservationReference;

Portable chain, vault and reservation identity, including historical vaults.


reserved

reserved: TokenAmount;

Current reserved amount. Zero after the reservation is deleted.


reservingContractAddress

reservingContractAddress: `0x${string}`;

Contract authorized to claim the reservation; its address alone does not identify its product.