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

    Type Alias ExitOptions

    type ExitOptions = {
        feeRate?: number;
        mode?: ExitMode;
        networkName?: NetworkName;
        onchainWallet: OnchainWallet;
        sweepAddress: string;
        vtxos?: Outpoint[];
        wallet: Wallet;
    }
    Index

    Properties

    feeRate? mode? networkName? onchainWallet sweepAddress vtxos? wallet

    Properties

    feeRate?: number

    sat/vB; defaults to the onchain provider estimate, floored at MIN_FEE_RATE.

    mode?: ExitMode

    Fee-funding strategy (default "funded"):

    • "funded": broadcast a splitter at prepare time and pre-sign the fee children — the package executes fully keyless.
    • "graph": transport only the tx graph + sweeps; the executor funds and signs the CPFP bumps at execution time ("send funds to this address and we proceed"). No splitter, no onchainWallet funds used.
    networkName?: NetworkName

    Network label embedded in the package (executor sanity check). Resolved from the wallet's network when omitted — exact for "bitcoin" and "regtest"; the tb-family defaults to "testnet", so pass this explicitly on signet/mutinynet.

    onchainWallet: OnchainWallet

    Fee funding source and change/funding address. Must share the wallet identity.

    sweepAddress: string

    Destination for the exited funds.

    vtxos?: Outpoint[]

    Defaults to all spendable VTXOs.

    wallet: Wallet

    Wallet owning the VTXOs: identity (signing) + indexer + onchain provider.

    Settings

    Member Visibility

    On This Page

    Properties