Skip to content

API ReferenceLOC lifecycleType Alias

RedeemLOCSignatureParams

type RedeemLOCSignatureParams = object;

Parameters for the beneficiary’s EIP-712 RedeemAuthorization. Every field is bound into the signature, so the resulting bytes authorize exactly one redemption of redeemAmount from LOC id to destinationAddress while the LOC still holds locCreditedAmount.

Properties

destinationAddress?

optional destinationAddress?: Address;

Account the redeemed tokens must be sent to. Defaults to the connected signer (the beneficiary); the redeemer must pass the same address as RedeemLOCParams.destinationAddress. Explicit undefined is equivalent to omission.


expectedSigner?

optional expectedSigner?: Address;

Account whose authorization is being built. Defaults to the signer.


id

id: bigint;

ID of the LOC the beneficiary authorizes redeeming (LetterOfCreditReference.id).


locCreditedAmount

locCreditedAmount: bigint;

The LOC’s current remaining OutstandingLetterOfCredit.remainingCredited at signing time. Bound into the signature so it becomes invalid if the LOC is partially redeemed before the authorization is used.


nonce?

optional nonce?: bigint;

Beneficiary’s redeem-authorization nonce to sign with. Defaults to the account’s next unused nonce; set explicitly only when pre-signing several authorizations that will be submitted in order. Explicit undefined is equivalent to omission.


redeemAmount

redeemAmount: bigint;

Credited-token amount the holder may redeem, in the credited token’s smallest unit; the redemption must use exactly this amount.