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

73 lines
1.6 KiB
Groff
Raw Normal View History

doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.TH "LIGHTNING-LISTSENDPAYS" "7" "" "" "lightning-listsendpays"
.SH NAME
lightning-listsendpays - Low-level command for querying sendpay status
.SH SYNOPSIS
listsendpays: updated version of listpayments. New name is less confusing, and most people should be transitioning to listpays rather than this anyway. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-02-23 05:00:04 +00:00
\fBlistsendpays\fR [\fIbolt11\fR] [\fIpayment_hash\fR]
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH DESCRIPTION
The \fBlistsendpays\fR RPC command gets the status of all \fIsendpay\fR
commands (which is also used by the \fIpay\fR command), or with \fIbolt11\fR or
\fIpayment_hash\fR limits results to that specific payment\. You cannot
specify both\.
Note that in future there may be more than one concurrent \fIsendpay\fR
command per \fIpay\fR, so this command should be used with caution\.
.SH RETURN VALUE
On success, an array of objects is returned\. Each object contains:
\fIid\fR
doc: update listpayments man page to match current semantics. It didn't show the optional parameters, and the output fields were obsolete. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-02-23 05:00:04 +00:00
unique internal value assigned at creation
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
\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\.
\fIcreated_at\fR
the UNIX timestamp showing when this payment was initiated\.
\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 \fIsendpay\fR\.
\fIbolt11\fR
the \fIbolt11\fR argument given to \fIpay\fR (may be missing for pre-0\.7
payments)\.
.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
Christian Decker \fI<decker.christian@gmail.com\fR> is mainly
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
responsible\.
.SH SEE ALSO
\fBlightning-listpays\fR(7), \fBlightning-sendpay\fR(7), \fBlightning-listinvoice\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