Skip to content

API ReferenceTransactions, wallets, and signaturesType Alias

WorkflowExecuteFunction

type WorkflowExecuteFunction = (h?, isCancelled?) => Promise<WorkflowExecutionResult>;

The function that may be called to execute this workflow.

Full validation runs once immediately before the invocation’s first new wallet prompt. Domain issues, typed infrastructure failure, and cancellation resolve as exclusive outcomes without changing queued operation statuses. A valid preflight enters the existing operation executor and returns executed with its final operation snapshot. Receipt recovery for an already-submitted Indeterminate transaction runs before preflight and does not create a new signature request. An Indeterminate operation with no recorded transactionHash (its send failed in transit) has nothing to observe: the run stops there without preflight, without a prompt, and without resending it, and later operations stay Queued.

Overlapping calls join one active run for this workflow. Each call remains a distinct participant and receives independently cloned updates.

Parameters

ParameterTypeDescription
h?WalletOperationWorkflowUpdateHandlerThe optional update handler function capable of handling status updates as this workflow is executed.
isCancelled?() => booleanAn optional live predicate called at operation boundaries. Execution stops only when every joined participant is currently cancelled; a call without a predicate remains active. Prefer this over AbortSignal — signals are one-shot and cannot be reset, which causes spurious aborts in React StrictMode.

Returns

Promise<WorkflowExecutionResult>

The exclusive preflight or wallet-execution outcome.