Layerswap Docs

The onSwapStatusChange callback fires from the Widget’s Processing screen for ls_transfer_pending, completed, failed, and expired. Use it to mirror progress in your own UI or analytics.

<LayerswapWidget
  config={widgetConfig}
  callbacks={{
    onSwapStatusChange: (event) => {
      console.log("Swap status:", event)
    },
  }}
/>

Callback Argument Value

type SwapStatusEvent = {
  type: SwapStatus;
  swapId: string;
  path?: 'Processing';
};

type EmittedSwapStatus =
  | 'ls_transfer_pending'
  | 'completed'
  | 'failed'
  | 'expired';

path identifies the Widget screen that emitted the event; today the only value is Processing. See Swap lifecycle & statuses for the meaning of each status.

Start here

Configuration

Production

Guides & tools

Self-bundled Widget

onSwapStatusChange

Callback Argument Value

​Callback Argument Value

Callback Argument Value