broadcastFlow

broadcastFlow

Records that a flow transaction has been broadcast. For wallet sources, pass the txHash from the on-chain transaction. For exchange sources, txHash can be omitted.

Most integrations should use submitFlowTransaction instead, which calls broadcastFlow automatically after signing. Use broadcastFlow directly only when you handle signing and broadcasting yourself.

When to call

• For a wallet source, call broadcastFlow after the on-chain transaction is submitted and executionState is signing. Pass its transaction hash.
• For an exchange source, call it after the user completes the exchange transfer and executionState is source_attached. The transaction hash is optional.

Before retrying after an interruption or network error, call getFlow. If the state is already broadcasted or source_confirmed, the broadcast was recorded successfully; poll the flow instead of calling broadcastFlow again. If the flow is cancelled, expired, or failed, create a new flow for another attempt.

Calling broadcastFlow from any other state returns 409. If a transaction hash was already recorded, re-fetch the flow to verify its state instead of retrying the same broadcast call.

Usage

import { broadcastFlow } from '@dynamic-labs-sdk/client';

const flow = await broadcastFlow({
  flowId: 'your-flow-id',
  txHash: '0xabc123def456...',
});

Parameters

Parameter	Type	Description
flowId	string	The flow ID.
txHash	string (optional)	The on-chain transaction hash. Required for wallet sources, optional for exchange sources.

Returns

Promise<Flow> — the flow with executionState: 'broadcasted'.

After broadcast, the flow cannot be cancelled. The backend begins monitoring the blockchain and orchestrating settlement.

Examples

Wallet source

import { broadcastFlow } from '@dynamic-labs-sdk/client';

const flow = await broadcastFlow({
  flowId: 'your-flow-id',
  txHash: '0xabc123def456...',
});

Exchange source

import { broadcastFlow } from '@dynamic-labs-sdk/client';

// No txHash needed — the user completed payment on the exchange
const flow = await broadcastFlow({
  flowId: 'your-flow-id',
});

React

import { useBroadcastFlow } from '@dynamic-labs-sdk/react-hooks';

function BroadcastButton({ flowId, txHash }) {
  const { mutate: broadcast, isPending } = useBroadcastFlow();

  return (
    <button onClick={() => broadcast({ flowId, txHash })} disabled={isPending}>
      {isPending ? 'Broadcasting...' : 'Broadcast'}
    </button>
  );
}

Related

• Fireblocks Flow JavaScript SDK guide - End-to-end flow guide
• submitFlowTransaction - Recommended: handles prepare, sign, and broadcast
• prepareFlowSigning - Prepare signing payload
• getFlow - Poll flow state after broadcast