lightning-bkpr-inspect -- Command to show onchain footprint of a channel
SYNOPSIS
bkpr-inspect account
DESCRIPTION
The bkpr-inspect RPC command lists all known on-chain transactions and associated events for the provided account. Useful for inspecting unilateral closes for a given channel account. Only valid for channel accounts.
- account (string): Channel account to inspect.
RETURN VALUE
On success, an object containing txs is returned. It is an array of objects, where each object contains:
- txid (txid): Transaction id.
- fees_paid_msat (msat): Amount paid in sats for this tx.
- outputs (array of objects):
- account (string): Account this output affected.
- outnum (u32): Index of output.
- output_value_msat (msat): Value of the output.
- currency (string): Human-readable bech32 part for this coin type.
- credit_msat (msat, optional): Amount credited to account.
- debit_msat (msat, optional): Amount debited from account.
- originating_account (string, optional): Account this output originated from.
- output_tag (string, optional): Description of output creation event.
- spend_tag (string, optional): Description of output spend event.
- spending_txid (txid, optional): Transaction this output was spent in.
- payment_id (hex, optional): Lightning payment identifier. For an htlc, this will be the preimage.
- blockheight (u32, optional): Blockheight of transaction.
AUTHOR
Lisa Neigut <[email protected]> is mainly responsible.
SEE ALSO
lightning-listbalances(7), lightning-listfunds(7), lightning-listpeers(7)
RESOURCES
Main web site: https://github.com/ElementsProject/lightning
EXAMPLES
Example 1:
Request:
lightning-cli bkpr-inspect "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab"
{
"id": "example:bkpr-inspect#1",
"method": "bkpr-inspect",
"params": [
"f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab"
]
}
Response:
{
"txs": [
{
"txid": "abb283035e569c190696d42a1208bb38ddc64b6377e88f2d6277c01eab7b0af3",
"fees_paid_msat": 0,
"outputs": [
{
"account": "f30a7bab1ec077622d8fe877634bc6dd38bb08122ad49606199c565e0383b2ab",
"outnum": 0,
"output_tag": "channel_proposed",
"output_value_msat": 996363000,
"credit_msat": 996363000,
"currency": "bcrt"
}
]
}
]
}