UseLiquidationDetailsParams

Inputs to useLiquidationDetails. All fields are optional so the hook can be mounted before a form is complete; it computes only once every input it needs is present.

Remarks

The same fields are forwarded to useRiskFactor for the risk half of the result; requiredCollateral is derived from creditedAmount alone. It is the collateral needed to meet the pair’s creation minimum — the bar a new LOC must clear, which is lower than the liquidation threshold. Leave either token unset to pause the hook.

Properties

collateralAmount?

optional collateralAmount?: bigint;

Collateral currently locked (or proposed) for this dynamic LOC, in the collateral token’s smallest unit. Feeds the risk-factor half of the result only; risk fields stay undefined until both amounts are positive.

---

collateralToken?

optional collateralToken?: `0x${string}`;

ERC-20 the LOC is collateralized in. With creditedToken it selects the oracle pair price and the pair’s configured collateral factors.

---

creditedAmount?

optional creditedAmount?: bigint;

Amount the LOC promises the beneficiary, in the credited token’s smallest unit. Drives both halves of the result: the risk factor (against collateralAmount) and requiredCollateral.

---

creditedToken?

optional creditedToken?: `0x${string}`;

ERC-20 the LOC credits to the beneficiary. Must differ from collateralToken; a static LOC has no oracle price and no liquidation.