mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 18:11:28 +01:00
c3254e6639
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.
68 lines
1.4 KiB
Groff
68 lines
1.4 KiB
Groff
.TH "LIGHTNING-LISTPAYS" "7" "" "" "lightning-listpays"
|
||
.SH NAME
|
||
lightning-listpays - Command for querying payment status
|
||
.SH SYNOPSIS
|
||
|
||
\fBlistpays\fR [bolt11]
|
||
|
||
.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
|
||
|
||
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
|
||
|
||
.SH SEE ALSO
|
||
|
||
\fBlightning-pay\fR(7), \fBlightning-paystatus\fR(7), \fBlightning-listsendpays\fR(7)\.
|
||
|
||
.SH RESOURCES
|
||
|
||
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
||
|