3e841b358e
Changelog-Fixed: Ensure documentation renders correctly when adding/updating new RPCs by detecting non-MDX-compatible pages.
215 lines
6.2 KiB
JSON
215 lines
6.2 KiB
JSON
{
|
|
"$schema": "../rpc-schema-draft.json",
|
|
"type": "object",
|
|
"rpc": "bkpr-listbalances",
|
|
"title": "Command for listing current channel + wallet balances",
|
|
"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."
|
|
],
|
|
"request": {
|
|
"required": [],
|
|
"additionalProperties": false,
|
|
"properties": {}
|
|
},
|
|
"response": {
|
|
"required": [
|
|
"accounts"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"accounts": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": true,
|
|
"required": [
|
|
"account",
|
|
"balances"
|
|
],
|
|
"properties": {
|
|
"account": {
|
|
"type": "string",
|
|
"description": [
|
|
"The account name. If the account is a channel, the channel_id."
|
|
]
|
|
},
|
|
"balances": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"balance_msat",
|
|
"coin_type"
|
|
],
|
|
"properties": {
|
|
"balance_msat": {
|
|
"type": "msat",
|
|
"description": [
|
|
"Current account balance."
|
|
]
|
|
},
|
|
"coin_type": {
|
|
"type": "string",
|
|
"description": [
|
|
"Coin type, same as HRP for bech32."
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"if": {
|
|
"required": [
|
|
"peer_id"
|
|
]
|
|
},
|
|
"then": {
|
|
"required": [
|
|
"account",
|
|
"balances",
|
|
"peer_id",
|
|
"we_opened",
|
|
"account_closed",
|
|
"account_resolved"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"account": {},
|
|
"balances": {},
|
|
"peer_id": {
|
|
"type": "pubkey",
|
|
"description": [
|
|
"Node id for the peer this account is with."
|
|
]
|
|
},
|
|
"we_opened": {
|
|
"type": "boolean",
|
|
"description": [
|
|
"Did we initiate this account open (open the channel)."
|
|
]
|
|
},
|
|
"account_closed": {
|
|
"type": "boolean",
|
|
"description": [
|
|
"",
|
|
""
|
|
]
|
|
},
|
|
"account_resolved": {
|
|
"type": "boolean",
|
|
"description": [
|
|
"Has this channel been closed and all outputs resolved?"
|
|
]
|
|
},
|
|
"resolved_at_block": {
|
|
"type": "u32",
|
|
"description": [
|
|
"Blockheight account resolved on chain."
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"else": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"account": {},
|
|
"balances": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"author": [
|
|
"Lisa Neigut [niftynei@gmail.com](mailto:niftynei@gmail.com) is mainly responsible."
|
|
],
|
|
"see_also": [
|
|
"lightning-bkpr-listincome(7)",
|
|
"lightning-listfunds(7)",
|
|
"lightning-bkpr-listaccountevents(7)",
|
|
"lightning-bkpr-channelsapy(7)",
|
|
"lightning-listpeers(7)"
|
|
],
|
|
"resources": [
|
|
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
|
|
],
|
|
"examples": [
|
|
{
|
|
"request": {
|
|
"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"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|