aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2026-02-21 05:54:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

listpays: fixed bolt11 null with keysend and update doc command

Browse Source 
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`
This commit is contained in:
Vincent
2020-07-29 10:48:47 +02:00
committed by Christian Decker
parent 723b7223b7
commit 700897f06e
4 changed files with 51 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/lightning-listpays.7 generated
View File

@@ -3,12 +3,12 @@
lightning-listpays - Command for querying payment status
.SH SYNOPSIS
\fBlistpays\fR [bolt11]
\fBlistpays\fR [bolt11] [payment_hash]
.SH DESCRIPTION
The \fBlistpay\fR RPC command gets the status of all \fIpay\fR commands, or a
single one if \fIbolt11\fR is specified\.
single one if either \fIbolt11\fR or \fIpayment_hash\fR was specified\.
.SH RETURN VALUE
@@ -16,7 +16,11 @@ 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)\.
the \fIbolt11\fR invoice if provided to \fBpay\fR\.
\fIpayment_hash\fR
the \fIpayment_hash\fR of the payment\.
\fIstatus\fR
@@ -24,11 +28,11 @@ one of \fIcomplete\fR, \fIfailed\fR or \fIpending\fR\.
\fIpayment_preimage\fR
(if \fIstatus\fR is \fIcomplete\fR) proves payment was received\.
if \fIstatus\fR is \fIcomplete\fR\.
\fIlabel\fR
optional \fIlabel\fR, if provided to \fIpay\fR\.
optional \fIlabel\fR, if provided to \fIpay\fR or \fIsendonion\fR\.
\fIamount_sent_msat\fR

13
doc/lightning-listpays.7.md
View File

@@ -4,13 +4,13 @@ lightning-listpays -- Command for querying payment status
SYNOPSIS
--------
**listpays** \[bolt11\]
**listpays** \[bolt11\] \[payment_hash\]
DESCRIPTION
-----------
The **listpay** RPC command gets the status of all *pay* commands, or a
single one if *bolt11* is specified.
single one if either *bolt11* or *payment_hash* was specified.
RETURN VALUE
------------
@@ -18,16 +18,19 @@ RETURN VALUE
On success, an array of objects is returned. Each object contains:
*bolt11*
the *bolt11* argument given to *pay* (see below for exceptions).
the *bolt11* invoice if provided to `pay`.
*payment_hash*
the *payment_hash* of the payment.
*status*
one of *complete*, *failed* or *pending*.
*payment\_preimage*
(if *status* is *complete*) proves payment was received.
if *status* is *complete*.
*label*
optional *label*, if provided to *pay*.
optional *label*, if provided to *pay* or *sendonion*.
*amount\_sent\_msat*
total amount sent, in "NNNmsat" format.