bkpr-listbalances -- Command for listing current channel + wallet balances

SYNOPSIS

bkpr-listbalances

DESCRIPTION

The bkpr-listbalances RPC command is a list of all current and historical account balances. An account is either the on-chain wallet or a channel balance. Any funds sent to an external account will not be accounted for here.

Note that any channel that was recorded will be listed. Closed channel balances will be 0msat.

RETURN VALUE

On success, an object containing accounts is returned. It is an array of objects, where each object contains:

account (string): The account name. If the account is a channel, the channel_id.
balances (array of objects):
- balance_msat (msat): Current account balance.
- coin_type (string): Coin type, same as HRP for bech32.

If peer_id is present:

peer_id (pubkey): Node id for the peer this account is with.
we_opened (boolean): Did we initiate this account open (open the channel).
account_closed (boolean):
account_resolved (boolean): Has this channel been closed and all outputs resolved?
resolved_at_block (u32, optional): Blockheight account resolved on chain.

AUTHOR

Lisa Neigut <[email protected]> is mainly responsible.

RESOURCES

Main web site: https://github.com/ElementsProject/lightning

EXAMPLES

Example 1:

Request:

lightning-cli bkpr-listbalances

{
  "id": "example:bkpr-listbalances#1",
  "method": "bkpr-listbalances",
  "params": {}
}

Response:

{
  "accounts": [
    {
      "account": "wallet",
      "balances": [
        {
          "balance_msat": 202050000000,
          "coin_type": "bcrt"
        }
      ]
    },
    {
      "account": "channelid0230000230000230000230000230000230000230000230000230000",
      "peer_id": "nodeid020202020202020202020202020202020202020202020202020202020202",
      "we_opened": false,
      "account_closed": true,
      "account_resolved": true,
      "resolved_at_block": 121,
      "balances": [
        {
          "balance_msat": 0,
          "coin_type": "bcrt"
        }
      ]
    },
    {
      "account": "channelid0340000340000340000340000340000340000340000340000340000",
      "peer_id": "nodeid040404040404040404040404040404040404040404040404040404040404",
      "we_opened": true,
      "account_closed": true,
      "account_resolved": false,
      "balances": [
        {
          "balance_msat": 0,
          "coin_type": "bcrt"
        }
      ]
    },
    {
      "account": "channelid0230200230200230200230200230200230200230200230200230200",
      "peer_id": "nodeid020202020202020202020202020202020202020202020202020202020202",
      "we_opened": false,
      "account_closed": false,
      "account_resolved": false,
      "balances": [
        {
          "balance_msat": 0,
          "coin_type": "bcrt"
        }
      ]
    },
    {
      "account": "channelid0340200340200340200340200340200340200340200340200340200",
      "peer_id": "nodeid040404040404040404040404040404040404040404040404040404040404",
      "we_opened": true,
      "account_closed": false,
      "account_resolved": false,
      "balances": [
        {
          "balance_msat": 1000000000,
          "coin_type": "bcrt"
        }
      ]
    }
  ]
}