vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/lightning-listpays.7.md

71 lines
1.5 KiB
Markdown
Raw Normal View History

docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
2019-08-31 13:30:56 +01:00
lightning-listpays -- Command for querying payment status
=========================================================
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
SYNOPSIS
--------
listpays: fixed bolt11 null with keysend and update doc command listpays: make doc-all missed Changelog-Added: JSON-RPC: `listpays` can be used to query payments using the `payment_hash` Changelog-Added: JSON-RPC: `listpays` now includes the `payment_hash`
2020-07-29 09:48:47 +01:00
**listpays** \[bolt11\] \[payment_hash\]
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
DESCRIPTION
-----------
The **listpay** RPC command gets the status of all *pay* commands, or a
listpays: fixed bolt11 null with keysend and update doc command listpays: make doc-all missed Changelog-Added: JSON-RPC: `listpays` can be used to query payments using the `payment_hash` Changelog-Added: JSON-RPC: `listpays` now includes the `payment_hash`
2020-07-29 09:48:47 +01:00
single one if either *bolt11* or *payment_hash* was specified.
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
RETURN VALUE
------------
On success, an array of objects is returned. Each object contains:
*bolt11*
listpays: fixed bolt11 null with keysend and update doc command listpays: make doc-all missed Changelog-Added: JSON-RPC: `listpays` can be used to query payments using the `payment_hash` Changelog-Added: JSON-RPC: `listpays` now includes the `payment_hash`
2020-07-29 09:48:47 +01:00
the *bolt11* invoice if provided to `pay`.
doc: note where experimental-offers is required or affects commands. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-14 03:36:59 +00:00
*bolt12*
if **experimental-offers** is enabled, and `pay` was a given a bolt12
invoice, this field will appear instead of *bolt11*.
listpays: fixed bolt11 null with keysend and update doc command listpays: make doc-all missed Changelog-Added: JSON-RPC: `listpays` can be used to query payments using the `payment_hash` Changelog-Added: JSON-RPC: `listpays` now includes the `payment_hash`
2020-07-29 09:48:47 +01:00
*payment_hash*
the *payment_hash* of the payment.
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
*status*
one of *complete*, *failed* or *pending*.
*payment\_preimage*
listpays: fixed bolt11 null with keysend and update doc command listpays: make doc-all missed Changelog-Added: JSON-RPC: `listpays` can be used to query payments using the `payment_hash` Changelog-Added: JSON-RPC: `listpays` now includes the `payment_hash`
2020-07-29 09:48:47 +01:00
if *status* is *complete*.
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
*label*
listpays: fixed bolt11 null with keysend and update doc command listpays: make doc-all missed Changelog-Added: JSON-RPC: `listpays` can be used to query payments using the `payment_hash` Changelog-Added: JSON-RPC: `listpays` now includes the `payment_hash`
2020-07-29 09:48:47 +01:00
optional *label*, if provided to *pay* or *sendonion*.
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
*amount\_sent\_msat*
total amount sent, in "NNNmsat" format.
For old payments (pre-0.7) we didn’t save the *bolt11* string, so in its
place are three other fields:
*payment\_hash*
the hash of the *payment\_preimage* which will prove payment.
*destination*
the final destination of the payment.
*amount\_msat*
the amount the destination received, in "NNNmsat" format.
These three can all be extracted from *bolt11*, hence are obsolete.
AUTHOR
------
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
SEE ALSO
--------
lightning-pay(7), lightning-paystatus(7), lightning-listsendpays(7).
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
doc: force refresh of all manpages. The idea is that you regenerate the man pages in the same commit you alter them: that's how we know whether to try regenerating them or not (git doesn't store timestamps, so it can't really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-25 02:33:16 +01:00