Check Balances

const balance = await wallet.getBalance()

// Total wallet balance
console.log('Total:', balance.total)

// Boarding UTXOs waiting to be onboarded
console.log('Boarding Total:', balance.boarding.total)

// Available balance - spendable in offchain Arkade transactions
console.log('Available:', balance.available)

// Offchain balance split by settlement state
console.log('Settled:', balance.settled)
console.log('Preconfirmed:', balance.preconfirmed)

// Funds that may require recovery
console.log('Recoverable:', balance.recoverable)

{
  // Offchain balances (VTXOs)
  preconfirmed: 0;      // Cosigned by the Arkade operator and sender
  settled: 20000;       // Bitcoin-anchored via batch swap
  available: 20000;     // settled + preconfirmed (spendable in transactions)
  recoverable: 5000;    // Expired VTXOs and subdust. (see VTXO Management)
  total: 25000;         // available + recoverable

  // Pending onchain deposits. (boarding UTXOs - see Ramps for onboarding)
  boarding: {
    unconfirmed: 0,     // Unconfirmed onchain UTXOs
    confirmed: 0,       // Confirmed onchain UTXOs
    total: 0            // confirmed + unconfirmed
  };

  // Asset balances (see Asset Balances)
  assets: [];
  availableAssets: [];
}

const { assets, availableAssets } = await wallet.getBalance()

console.log(assets)
// [
//   { assetId: 'abc123...', amount: 1000n },
//   { assetId: 'def456...', amount: 500n },
// ]

const amount = assets.find((a) => a.assetId === assetId)?.amount ?? 0n

// Get virtual UTXOs (offchain)
const vtxos = await wallet.getVtxos()
console.log('Number of VTXOs:', vtxos.length)

// Log important information about each VTXO
vtxos.forEach((vtxo, index) => {
  console.log(`VTXO #${index + 1}:`);
  console.log(`  ID: ${vtxo.txid}:${vtxo.vout}`);
  console.log(`  Amount: ${vtxo.value} sats`);
  console.log(`  Preconfirmed: ${vtxo.isPreconfirmed}`);
  console.log(`  Swept: ${vtxo.isSwept}`);
  console.log(`  Spent: ${vtxo.isSpent}`);
  console.log(`  Settled by: ${vtxo.settledBy ?? "—"}`);
  console.log(`  Expires at: ${vtxo.expiresAt ?? vtxo.expiresAtHeight ?? "—"}`);
});

type ExtendedVirtualCoin = {
  txid: string;
  vout: number;
  value: number;
  status: {
    confirmed: boolean;
    // optional block hash, height, etc...
  };
  isPreconfirmed: boolean;
  isSwept: boolean;
  isSpent: boolean;
  isUnrolled: boolean;
  settledBy?: string;
  commitmentTxIds?: string[];
  expiresAt?: number;
  expiresAtHeight?: number;
  createdAt: Date;
  assets?: Asset[]; // see Assets > Core Concepts
  // misc taproot fields, extra witness, etc...
}

// Get boarding UTXOs
const boardingUtxos = await wallet.getBoardingUtxos()
console.log('Number of boarding UTXOs:', boardingUtxos.length)

// Log important information about each boarding UTXO
boardingUtxos.forEach((utxo, index) => {
  console.log(`Boarding UTXO #${index + 1}:`);
  console.log(`  TXID: ${utxo.txid}`);
  console.log(`  Output Index: ${utxo.vout}`);
  console.log(`  Amount: ${utxo.value} sats`);
  console.log(`  Status: ${utxo.status.confirmed ? 'Confirmed' : 'Unconfirmed'}`);
});

type ExtendedCoin = {
  txid: string;
  vout: number;
  value: number;
  status: {
    confirmed: boolean;
    // optional block hash, height, etc...
  };
  // misc taproot fields, extra witness, etc...
}