@arkade-os/sdk Documentation - v0.5.0-rc.11
    Preparing search index...

    Interface SweepTxNotification

    A sweepTx notification. Only a sweep carries swept outpoints, so only this arm declares them: reading sweptVtxos off another arm is a type error, and a sweep handler never has to narrow the field it came for.

    interface SweepTxNotification {
        checkpointTxs?: Record<string, { tx: string; txid: string }>;
        spendableVtxos: Vtxo[];
        spentVtxos: Vtxo[];
        sweptVtxos: Outpoint[];
        tx: string;
        txid: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    checkpointTxs? spendableVtxos spentVtxos sweptVtxos tx txid

    Properties

    checkpointTxs?: Record<string, { tx: string; txid: string }>

    Optional checkpoint transactions associated with the notification.

    spendableVtxos: Vtxo[]

    Virtual outputs made spendable by the transaction.

    spentVtxos: Vtxo[]

    Virtual outputs spent by the transaction.

    sweptVtxos: Outpoint[]

    Outpoints the transaction swept — outpoints rather than virtual outputs, because a swept output is gone: the server has nothing left to describe beyond where it was. Empty when the sweep touched none of them.

    tx: string

    Raw transaction payload.

    txid: string

    Transaction id.

    Settings

    Member Visibility

    On This Page

    Properties