Skip to main content

Run the BTC interactions example

Use examples/btc-interactions-flow to inspect Bitcoin wallet profile and supply flows.

Mainnet transactions

This example uses bundled mainnet canister and production service defaults. A wallet action can transfer real Bitcoin. Review every destination and amount before you confirm a transaction.

The example covers the following areas:

AreaWhat to inspect
Wallet connectionDynamic-powered Bitcoin wallet setup
Profile setupclient.accounts.createProfile(...) with BTC signatures
Pool selectionBTC pool loading and amount formatting
Supply interactionclient.lending.supply(...) with BTC transfer execution
Activity trackingStatus lookup for submitted BTC activity IDs

Start the example

Use Node.js 20.19 or later in the 20.x line, or Node.js 22.12 or later. Use pnpm 11 or later and a Bitcoin mainnet wallet.

To start the example, follow these steps:

  1. From the SDK root, install the workspace dependencies:

    pnpm install
  2. Start the example:

    pnpm --filter @liquidium/example-btc-interactions-flow dev
  3. Open the local URL that Vite prints.

The page shows Liquidium BTC Interactions Flow when the example starts.