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
51e2433087
core-lightning/doc/lightning-bkpr-listincome.7.md

61 lines
2.5 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 09:34:39 +02:00
lightning-bkpr-listincome -- Command for listing all income impacting events
=======================================================================
SYNOPSIS
--------
**bkpr-listincome** \[*consolidate_fees*\] \[*start_time*\] \[*end_time*\]
DESCRIPTION
-----------
The **bkpr-listincome** RPC command is a list of all income impacting events that the bookkeeper plugin has recorded for this node.
If **consolidate_fees** is true, we emit a single, consolidated event for
any onchain-fees for a txid and account. Otherwise, events for every update to
the onchain fee calculation for this account and txid will be printed. Defaults to true. Note that this means that the events emitted are non-stable,
i.e. calling **listincome** twice may result in different onchain fee events
being emitted, depending on how much information we've logged for that
transaction.
The **start_time** is a UNIX timestamp (in seconds) that filters events after the provided timestamp. Defaults to zero.
The **end_time** is a UNIX timestamp (in seconds) that filters events up to and at the provided timestamp. Defaults to max-int.
RETURN VALUE
------------
[comment]: # (GENERATE-FROM-SCHEMA-START)
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-05 23:45:06 +02:00
On success, an object containing **income\_events** 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-05 23:45:04 +02:00
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 09:34:39 +02:00
- **account** (string): The account name. If the account is a channel, the channel_id
- **tag** (string): Type of income event
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-05 23:45:06 +02:00
- **credit\_msat** (msat): Amount earned (income)
- **debit\_msat** (msat): Amount spent (expenses)
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 09:34:39 +02:00
- **currency** (string): human-readable bech32 part for this coin type
- **timestamp** (u32): Timestamp this event was recorded by the node. For consolidated events such as onchain_fees, the most recent timestamp
bkpr: save invoice description data to the database and display it It'll be really nice to be able to read description data about an invoice, if we've got it!
2022-07-19 09:34:40 +02:00
- **description** (string, optional): More information about this event. If a `invoice` type, typically the bolt11/bolt12 description
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 09:34:39 +02:00
- **outpoint** (string, optional): The txid:outnum for this event, if applicable
- **txid** (txid, optional): The txid of the transaction that created this event, if applicable
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-05 23:45:06 +02:00
- **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 09:34:39 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
------
niftynei <niftynei@gmail.com> is mainly responsible.
SEE ALSO
--------
lightning-bkpr-listaccountevents(7), lightning-listfunds(7),
lightning-bkpr-listbalances(7).
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
doc: escape output types (esp `short_channel_id`). We can also remove the listpeers closer hack, which was removed from the schema already. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-08 03:08:00 +02:00
[comment]: # ( SHA256STAMP:24a4784f87f26283e8849e525d51b376d3e69ae20c0941cfd745a7d07af8032a)
Reference in New Issue Copy Permalink