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

69 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-listsendpays -- Low-level command for querying sendpay status
=======================================================================
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
SYNOPSIS
--------
**listsendpays** \[*bolt11*\] \[*payment\_hash*\]
DESCRIPTION
-----------
The **listsendpays** RPC command gets the status of all *sendpay*
commands (which is also used by the *pay* command), or with *bolt11* or
*payment\_hash* limits results to that specific payment. You cannot
specify both.
Note that in future there may be more than one concurrent *sendpay*
command per *pay*, so this command should be used with caution.
RETURN VALUE
------------
On success, an array of objects is returned. Each object contains:
*id*
unique internal value assigned at creation
*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.
*created\_at*
the UNIX timestamp showing when this payment was initiated.
*status*
one of *complete*, *failed* or *pending*.
*payment\_preimage*
(if *status* is *complete*) proves payment was received.
*label*
optional *label*, if provided to *sendpay*.
*bolt11*
the *bolt11* argument given to *pay* (may be missing for pre-0.7
payments).
AUTHOR
------
Christian Decker <<decker.christian@gmail.com>> is mainly
responsible.
SEE ALSO
--------
lightning-listpays(7), lightning-sendpay(7), lightning-listinvoice(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