get_btc_multisig_balance
Retrieve the aggregate balance and per-address breakdown for a registered Bitcoin multi-sig wallet by scanning receive and change chains up to a configurable gap limit.
Instructions
Watch-only balance read for a registered multi-sig wallet. Walks both BIP-32 chains (chain=0 receive, chain=1 change) up to a gap-limit window (default 20, BIP-44 standard), queries each derived address via the configured Esplora indexer, returns the aggregate balance plus per-address breakdown for entries with on-chain history. No device touch — addresses are derived locally from the stored cosigner xpubs. Phase 3 supports P2WSH (wsh) wallets only; taproot lands in a follow-up PR.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| walletName | Yes | Name of a registered multi-sig wallet (matches the `name` passed to `register_btc_multisig_wallet`). | |
| gapLimit | No | BIP-44 gap limit — stop walking each chain after N consecutive empty addresses. Default 20 (matches Sparrow / Specter / BIP-44 recommendation). Cap of 100 to bound indexer fan-out. |