Skip to content

API ReferenceReact componentsInterface

CreateLOCFormProps

Beta

Properties for the CreateLOCForm component.

Failure reaches this form through issues, which carries only what a field can own. A consumer rendering it outside CreateLOCFlow 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

allowedTokenAddresses?

optional allowedTokenAddresses?: `0x${string}`[];

Beta

Deprecated

Use staticLOCTokenAddressAllowlist.


beneficiary?

optional beneficiary?: HardcodedField<`0x${string}`>;

Beta


config?

optional config?: CreateLOCComponentConfig;

Beta

Per-render creation config. Defined values override LOCConfig.createLOC; undefined inherits, while a null tag disables its provider source.


defaultBeneficiaryAddress?

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

Beta


expiration?

optional expiration?: HardcodedField<Date>;

Beta


formValues?

optional formValues?: CreateLOCFormValues;

Beta

Values used to initialize or restore the form. Preserve tagValues from onPrepareWorkflow to restore structured reference inputs by stable key.


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.


onPrepareWorkflow?

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

Beta

Receives the prepared workflow and the values needed to restore the form. Structured tags provide both the complete values.tag and editable-only values.tagValues.

Parameters

ParameterType
workflowWalletOperationWorkflow
valuesCreateLOCFormValues

Returns

void


staticLOCTokenAddressAllowlist?

optional staticLOCTokenAddressAllowlist?: `0x${string}`[];

Beta