Skip to content

API ReferenceLOC lifecycleInterface

LetterOfCreditOrigin

Immutable creation facts. Token amounts use smallest units and exclude mutable display metadata.

Properties

beneficiary

beneficiary: `0x${string}`;

Beneficiary recorded at creation; may itself be a contract.


collateralContractAddress

collateralContractAddress: `0x${string}`;

Original collateral vault, retained even after the profile changes vaults.


createdIn

createdIn: LetterOfCreditTransactionReference;

Transaction that created the LOC, supplying its creation date and block provenance.


creationKind

creationKind: 'static' | 'dynamic';

Static uses the credited token as collateral; dynamic uses a different token.


creator

creator: `0x${string}`;

Account that created the LOC and supplied its collateral.


credited

credited: TokenAmount;

Original credit obligation, before redemption or a full-conversion reset.


initialExpirationTimestamp

initialExpirationTimestamp: bigint;

Expiration at creation in Unix seconds, before any extensions.


originalClaimableCollateral

originalClaimableCollateral: bigint;

Initial amount claimable by the LOC contract, in original-collateral smallest units.


originalCollateral

originalCollateral: TokenAmount;

Initial reserved collateral, before modifications, liquidation or redemption.


originatingCollateralReservation

originatingCollateralReservation:
| CollateralReservationReference
| null;

Nullable only when legacy creation evidence cannot establish the reservation relationship.


reference

reference: LetterOfCreditReference;

Stable identity shared by the aggregate and its history.


tag

tag: `0x${string}` | null;

Null for an untagged creation or a version without tags.