Skip to content

API ReferenceReact componentsFunction

RedeemLOCFlow()

function RedeemLOCFlow(props): Element;

Beta

A complete Beneficiary UI: list the LOCs issued to the connected account, open one, redeem or cancel it, and sign each workflow. When a redemption fails, the flow returns to the same LOC’s form with the user’s values restored, shows field problems on the form, and reports any other failure in a banner.

When the wallet cannot confirm whether a transaction was sent, the signing step shows UnconfirmedTransaction in place of the transaction list. The flow holds there until the user retries or leaves, and an account change dismisses it with the rest of the run.

Parameters

ParameterTypeDescription
propsRedeemLOCFlowPropsThe flow’s headings, liquidator selection, and cancellation authorization.
props.cancelAuthorization?CancelLOCAuthorizationSourceBeta The Beneficiary authorization attached when canceling a LOC from its details: a signature, a function that returns one for the selected LOC, or null to attach none. Omit it to use LOCConfig’s cancelAuthorization. The connected Beneficiary can cancel without one.
props.className?stringExtra class names for the flow’s outer element.
props.description?stringThe subtitle shown under title. Defaults to Manage and redeem LOCs issued to you here.
props.redeemLiquidation?RedeemLiquidationSourceBeta The liquidator the redeem form uses: a fixed { liquidator, liquidatorParams } selection, a function called at submission with the LOC, amount, and destination that returns one, or null for self-liquidation. It replaces LOCConfig’s redeemLiquidation as a whole; omit it to use that setting.
props.title?stringThe heading over the LOC list. Defaults to Letters of credit.

Returns

Element

The Beneficiary LOC flow.

Remarks

Beta: it may change or be removed without notice and is not part of the compatibility contract. The provider and hooks are the supported React surface.