RedeemLOCFormProps

Beta

Properties for the RedeemLOCForm component.

Failure reaches this form through issues, which carries only what a field can own. A consumer rendering it outside RedeemLOCFlow is therefore responsible for reporting a settlement’s remaining message itself — the form has no channel for a wallet or preflight failure, by design.

Remarks

Part of the SDK’s experimental React component surface — may change or be removed without notice and is not part of the compatibility contract. The supported React surface is the hooks and the provider.

Properties

defaultDestinationAddress?

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

Beta

---

destinationAddressReadOnly?

optional destinationAddressReadOnly?: boolean;

Beta

---

formValues?

optional formValues?: RedeemLOCFormValues;

Beta

Values used to restore the form after a failed or interrupted run.

---

issues?

optional issues?: ValidationIssue[];

Beta

Issues a prior execution of this form’s workflow settled with. They are mapped onto the matching fields exactly as prepare-time validation is; an issue no field owns lands on the form root.

---

loc

loc: OutstandingLetterOfCredit;

Beta

---

onPrepareWorkflow?

optional onPrepareWorkflow?: (workflow, values) => void;

Beta

Receives the prepared workflow and the values needed to restore the form.

The values are what let a failed redemption return the user here with what they entered still in place, rather than to an empty form.

Parameters

Parameter	Type
workflow	WalletOperationWorkflow
values	RedeemLOCFormValues

Returns

void

---

redeemLiquidation?

optional redeemLiquidation?: RedeemLiquidationSource;

Beta

Fixed or per-submission liquidator selection. When omitted, the form uses LOCConfig.redeemLiquidation; null explicitly disables that provider default. A prop selection replaces the provider selection as a whole, including route params. Resolver functions receive the submitted LOC, amount, and destination and may be async.