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

    Interface WalletBalance

    Balance summary returned by IWallet.getBalance.

    IWallet.getBalance

    const balance = await wallet.getBalance()
    console.log(balance.available, balance.boarding.total)
    interface WalletBalance {
        assets: Asset[];
        available: number;
        boarding: { confirmed: number; total: number; unconfirmed: number };
        pendingRecovery: number;
        preconfirmed: number;
        recoverable: number;
        settled: number;
        total: number;
    }
    Index

    Properties

    assets available boarding pendingRecovery preconfirmed recoverable settled total

    Properties

    assets: Asset[]

    Asset balance entries (assetId & amount)

    available: number

    Spendable offchain balance (settled + preconfirmed).

    boarding: { confirmed: number; total: number; unconfirmed: number }

    Boarding funds

    Type Declaration

    • confirmed: number

      Confirmed funds ready to swap for virtual outputs.

    • total: number

      Combined boarding balance (confirmed + unconfirmed)

    • unconfirmed: number

      Pending funds awaiting confirmation on mainnet

    pendingRecovery: number

    Funds under a now-deprecated signer past its cutoff (EXPIRED) that have not yet been swept by the server. NOT spendable until they recover, so excluded from available/settled/preconfirmed and from coin selection — but still the wallet's funds, so counted in total.

    preconfirmed: number

    Spendable preconfirmed (unfinalized) balance.

    recoverable: number

    Recoverable balance from subdust or expired (swept) virtual outputs.

    settled: number

    Spendable settled (finalized) balance.

    total: number

    Total balance across offchain, recoverable, pending-recovery, and boarding funds.

    Settings

    Member Visibility

    On This Page

    Properties