mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
d8320f015f
core-lightning/doc/lightning-bkpr-inspect.7.md
Rusty Russell eb6b8551d4 tools/fromschema.py: don't try to handle more complex cases. 
We only handle top-level objects with an array of objects:
make sure it is one before we call the routines.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-30 15:15:41 -06:00

1.9 KiB
Raw Blame History

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.

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

niftynei niftynei@gmail.com is mainly responsible.

SEE ALSO

lightning-listbalances(7), lightning-listfunds(7), lightning-listpeers(7).

RESOURCES

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