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

    Interface RouteQuote

    A priced route. The three amounts are receiver-exact and mean the same thing on every rail, so options() can be ranked on cost and a rail swapped without changing what the recipient gets:

    • amount — sats delivered to the recipient.
    • fee — sats charged on top, by the rail and its counterparty.
    • totalamount + fee; the sats that leave the wallet.

    Rails whose underlying primitive deducts its fee (the collaborative exit) gross the amount up to honour this; rails that add it on top pass it through.

    fee is a pre-send estimate wherever the true cost is only fixed later: the swap rails quote from Boltz's advertised pricing and are superseded by the amount Boltz returns at swap creation, and the collaborative exit does not include the per-input intent fees, which depend on the VTXO selection made at settlement. Treat it as a display and ranking figure, not a guarantee.

    interface RouteQuote {
        amount: number;
        fee: number;
        meta?: Record<string, unknown>;
        railId: string;
        total: number;
        send(): Promise<PaymentHandle>;
    }
    Index

    Properties

    Methods

    Properties

    amount: number

    Sats delivered to the recipient.

    fee: number

    Sats charged on top of amount; an estimate on the swap rails.

    meta?: Record<string, unknown>
    railId: string
    total: number

    amount + fee — what leaves the wallet.

    Methods