getBalance() returns the wallet’s balance broken down by output state. All amounts are in satoshis.
Understanding Your Balance
Showavailable as the wallet’s main balance. It counts only the virtual
outputs that send can spend now.
Older code can read
gated, intentLocked, and pendingRecovery. These
deprecated aliases hold the same values as contractLocked,
pendingSettlement, and deprecatedSignerLocked, so new code should use those
names.
To show your funds minus what is tied up, subtract from
settled + preconfirmed, never from total. total also counts
recoverable, deprecatedSignerLocked, unrolled, and boarding.total. Those are
still your funds, so subtracting from total drops them from the figure.
Learn more about virtual output states.
Asset Balances
getBalance() also returns the Arkade Assets your wallet holds. Asset amounts are bigint values in base units:
assets- every asset your wallet holdsavailableAssets- the assets you can spend right now
decimals field from the asset metadata.
Listing Outputs
getVtxos() returns every virtual output the wallet tracks, including the
ones counted in contractLocked, pendingSettlement, deprecatedSignerLocked, and recoverable.
To choose outputs to spend, use getSpendableVtxos({ withRecoverable: false }).
It leaves all of those out:
txid and vout, a value in sats, status
flags (isPreconfirmed, isSwept, isSpent, isUnrolled), and its expiry
(expiresAt, or expiresAtHeight on regtest).
getBoardingUtxos() returns the onchain outputs at your boarding address that
haven’t boarded yet: