mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-22 14:42:40 +01:00
Code Issues Projects Releases Wiki Activity
core-lightning/doc/lightning-bkpr-inspect.7.md

56 lines
1.9 KiB
Markdown
Raw Normal View History

bkpr: add docs, change names to 'bkpr-*' Adds schema definitions and manpages for bkpr- commands; also renames the commands to all start with 'bkpr-', so they're easier to identify/ make runes about.
2022-07-19 17:04:39 +09:30
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
------------
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object containing **txs** is returned. It is an array of objects, where each object contains:
Makefile: Revert ba7d4a8f6bab5a3d5e5832d1f9e36749e695320a (make-schema: don't include tools/fromschema.py in SHASUMS) 1. If the tool changes, you need to regenerate since the output may change. 2. This didn't just filter that out, ignored all but the first dependency, which made bisecting the bookkeeper plugin a nightmare: it didn't regenerate the .po file, causing random crashes. If we want this, try $(filter-out tools/fromschema.py) instead. But I don't think we want that. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-06 07:15:04 +09:30
bkpr: add docs, change names to 'bkpr-*' Adds schema definitions and manpages for bkpr- commands; also renames the commands to all start with 'bkpr-', so they're easier to identify/ make runes about.
2022-07-19 17:04:39 +09:30
- **txid** (txid): transaction id
doc: always escape underscores in property names If there's only a single underscore, lowdown ignores it, but if there are multiple (see min_final_cltv_expiry) it decides we're trying to highlight part of the word. Reported-by: @wtogami Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-06 07:15:06 +09:30
- **fees\_paid\_msat** (msat): Amount paid in sats for this tx
bkpr: add docs, change names to 'bkpr-*' Adds schema definitions and manpages for bkpr- commands; also renames the commands to all start with 'bkpr-', so they're easier to identify/ make runes about.
2022-07-19 17:04:39 +09:30
- **outputs** (array of objects):
- **account** (string): Account this output affected
- **outnum** (u32): Index of output
doc: always escape underscores in property names If there's only a single underscore, lowdown ignores it, but if there are multiple (see min_final_cltv_expiry) it decides we're trying to highlight part of the word. Reported-by: @wtogami Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-06 07:15:06 +09:30
- **output\_value\_msat** (msat): Value of the output
bkpr: add docs, change names to 'bkpr-*' Adds schema definitions and manpages for bkpr- commands; also renames the commands to all start with 'bkpr-', so they're easier to identify/ make runes about.
2022-07-19 17:04:39 +09:30
- **currency** (string): human-readable bech32 part for this coin type
doc: always escape underscores in property names If there's only a single underscore, lowdown ignores it, but if there are multiple (see min_final_cltv_expiry) it decides we're trying to highlight part of the word. Reported-by: @wtogami Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-06 07:15:06 +09:30
- **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.
bkpr: add docs, change names to 'bkpr-*' Adds schema definitions and manpages for bkpr- commands; also renames the commands to all start with 'bkpr-', so they're easier to identify/ make runes about.
2022-07-19 17:04:39 +09:30
- **blockheight** (u32, optional): Blockheight of transaction
[comment]: # (GENERATE-FROM-SCHEMA-END)
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>
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 16:54:16 +10:30
[comment]: # ( SHA256STAMP:431ddf80b4cc4ad778a0b7e720dc282671a34f62de9ceedb0f411277bdda91be)
Reference in a new issue Copy permalink