Skip to content

API ReferenceLOC lifecycleInterface

OutstandingLetterOfCredit

Contract-resident LOC state. Creation provenance and current market/configuration inputs are separate reads.

Properties

backing

backing:
| {
claimableCollateral: bigint;
collateral: TokenAmount;
kind: "reserved";
reservation: CollateralReservationReference;
}
| {
amount: bigint;
kind: "converted";
};

Either a live vault reservation or credited tokens held after full conversion.

Union Members

Type Literal
{
claimableCollateral: bigint;
collateral: TokenAmount;
kind: 'reserved';
reservation: CollateralReservationReference;
}
claimableCollateral
claimableCollateral: bigint;

Current amount claimable by the LOC contract, in collateral-token smallest units.

collateral
collateral: TokenAmount;

Current total reserved collateral; claimableCollateral is its claimable portion.

kind
kind: 'reserved';
reservation
reservation: CollateralReservationReference;

Exact reservation recovered from contract storage, including its historical vault.


Type Literal
{
amount: bigint;
kind: 'converted';
}
amount
amount: bigint;

Held amount in the remainingCredited token. Conversion resets the remaining obligation to the received amount; any prior shortfall belongs to lifecycle.

kind
kind: 'converted';

beneficiary

beneficiary: `0x${string}`;

Beneficiary address stored by the LOC contract.


creationKind

creationKind: 'static' | 'dynamic';

Creation-time token relationship; full conversion does not change a dynamic LOC to static.


creator

creator: `0x${string}`;

Creator address stored by the LOC contract.


expirationTimestamp

expirationTimestamp: bigint;

Current expiration in Unix seconds. Expired unresolved LOCs still have outstanding state.


reference

reference: LetterOfCreditReference;

Portable identity of the contract storage read.


remainingCredited

remainingCredited: TokenAmount;

Remaining credit obligation; full conversion resets it to the amount actually received.