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

68 lines
1.4 KiB
Groff
Raw Normal View History

doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.TH "LIGHTNING-LISTPAYS" "7" "" "" "lightning-listpays"
.SH NAME
lightning-listpays - Command for querying payment status
.SH SYNOPSIS
listpays: new command to summarize pay commands. This is to future-proof against multi-part-payments: the low-level commands will start returning multiple results once we have that, so prepare transition plan now. Closes: #2372 Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-02-23 05:00:04 +00:00
\fBlistpays\fR [bolt11]
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH DESCRIPTION
The \fBlistpay\fR RPC command gets the status of all \fIpay\fR commands, or a
single one if \fIbolt11\fR is specified\.
.SH RETURN VALUE
On success, an array of objects is returned\. Each object contains:
\fIbolt11\fR
the \fIbolt11\fR argument given to \fIpay\fR (see below for exceptions)\.
\fIstatus\fR
one of \fIcomplete\fR, \fIfailed\fR or \fIpending\fR\.
\fIpayment_preimage\fR
(if \fIstatus\fR is \fIcomplete\fR) proves payment was received\.
\fIlabel\fR
optional \fIlabel\fR, if provided to \fIpay\fR\.
\fIamount_sent_msat\fR
total amount sent, in "NNNmsat" format\.
For old payments (pre-0\.7) we didn’t save the \fIbolt11\fR string, so in its
place are three other fields:
\fIpayment_hash\fR
the hash of the \fIpayment_preimage\fR which will prove payment\.
\fIdestination\fR
the final destination of the payment\.
\fIamount_msat\fR
the amount the destination received, in "NNNmsat" format\.
These three can all be extracted from \fIbolt11\fR, hence are obsolete\.
.SH AUTHOR
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
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH SEE ALSO
\fBlightning-pay\fR(7), \fBlightning-paystatus\fR(7), \fBlightning-listsendpays\fR(7)\.
.SH RESOURCES
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
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00