@arkade-os/sdk Documentation - v0.4.54
    Preparing search index...

    Function onchainRail

    • On-chain BTC send via collaborative exit — the Wallet-only on-chain path (no swap). Matches a bare BTC address or the on-chain part of a unified BIP21 URI and offboards VTXOs to the address via Ramps.offboard, which owns fee-aware coin selection, dust-safe change, and settlement.

      offboard deducts its fee from the amount it is handed, so the rail grosses the amount up first: the recipient receives exactly quote.amount, matching the receiver-exact semantics of every other rail (see RouteQuote). quote.total is the offboard amount; the per-input intent fees offboard shaves off the selected VTXOs are additional and depend on the selection, so they are not part of the quote.

      An explicit amount is mandatory. To sweep the full balance, call Ramps.offboard(address, feeInfo) directly — the router has no amountless path.

      Returns PaymentRail