Skip to content

API ReferenceVaults, collateral, and riskInterface

GetRequiredCollateralForDynamicLOCParams

Properties

collateralTokenAddress

collateralTokenAddress: `0x${string}`;

Token that will back the LOC (the input side of the oracle price).


creationCollateralFactorBasisPoints?

optional creationCollateralFactorBasisPoints?: bigint;

Override for the pair’s creation collateral factor. Omit to read it from the LetterOfCredit contract; pass 0n (a disabled pair) and the result is undefined without any network call.


creditedTokenAmount

creditedTokenAmount: TokenAmount;

Token and amount the LOC will credit, in the credited token’s smallest unit.


oraclePrice?

optional oraclePrice?: Price;

Override for the collateral-to-credited price (see Price). Omit to fetch a fresh Pyth price via getPrice; supply one to keep several calculations on the same quote.