Browse Source

update docs with `payment_preimage`.

Changelog-Added: JSON-RPC: `listinvoices` now displays the payment preimage if the invoice was paid.
travis-debug
fiatjaf 5 years ago
committed by Rusty Russell
parent
commit
99ff86f6fe
  1. 4
      doc/lightning-invoice.7
  2. 21
      doc/lightning-listinvoices.7
  3. 21
      doc/lightning-listinvoices.7.md

4
doc/lightning-invoice.7

@ -84,6 +84,7 @@ not\.
The following error codes may occur: The following error codes may occur:
.RS
.IP \[bu] .IP \[bu]
-1: Catchall nonspecific error\. -1: Catchall nonspecific error\.
.IP \[bu] .IP \[bu]
@ -91,9 +92,11 @@ The following error codes may occur:
.IP \[bu] .IP \[bu]
901: An invoice with the given \fIpreimage\fR already exists\. 901: An invoice with the given \fIpreimage\fR already exists\.
.RE
One of the following warnings may occur (on success): One of the following warnings may occur (on success):
.RS
.IP \[bu] .IP \[bu]
\fIwarning_offline\fR if no channel with a currently connected peer has \fIwarning_offline\fR if no channel with a currently connected peer has
the incoming capacity to pay this invoice the incoming capacity to pay this invoice
@ -102,6 +105,7 @@ One of the following warnings may occur (on success):
incoming capacity and has a peer that is publicly connected (i\.e\. incoming capacity and has a peer that is publicly connected (i\.e\.
not a dead end) not a dead end)
.RE
.SH AUTHOR .SH AUTHOR
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\. Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.

21
doc/lightning-listinvoices.7

@ -12,17 +12,16 @@ if it exists, or the status of all invoices if given no argument\.
.SH RETURN VALUE .SH RETURN VALUE
On success, an array \fIinvoices\fR of objects is returned\. Each object On success, an array \fIinvoices\fR of objects is returned\. Each object contains
contains \fIlabel\fR, \fIpayment_hash\fR, \fIstatus\fR (one of \fIunpaid\fR, \fIpaid\fR or \fIlabel\fR, \fIpayment_hash\fR, \fIstatus\fR (one of \fIunpaid\fR, \fIpaid\fR or \fIexpired\fR),
\fIexpired\fR), and \fIexpiry_time\fR (a UNIX timestamp)\. If the \fImsatoshi\fR \fIpayment_preimage\fR (for paid invoices), and \fIexpiry_time\fR (a UNIX
argument to \fBlightning-invoice\fR(7) was not "any", there will be an timestamp)\. If the \fImsatoshi\fR argument to \fBlightning-invoice\fR(7) was not "any",
\fImsatoshi\fR field as a number, and \fIamount_msat\fR as the same number there will be an \fImsatoshi\fR field as a number, and \fIamount_msat\fR as the same
ending in \fImsat\fR\. If the invoice \fIstatus\fR is \fIpaid\fR, there will be a number ending in \fImsat\fR\. If the invoice \fIstatus\fR is \fIpaid\fR, there will be a
\fIpay_index\fR field and an \fImsatoshi_received\fR field (which may be \fIpay_index\fR field and an \fImsatoshi_received\fR field (which may be slightly
slightly greater than \fImsatoshi\fR as some overpaying is permitted to greater than \fImsatoshi\fR as some overpaying is permitted to allow clients to
allow clients to obscure payment paths); there will also be an obscure payment paths); there will also be an \fIamount_received_msat\fR field
\fIamount_received_msat\fR field with the same number as with the same number as \fImsatoshi_received\fR but ending in \fImsat\fR\.
\fImsatoshi_received\fR but ending in \fImsat\fR\.
.SH AUTHOR .SH AUTHOR

21
doc/lightning-listinvoices.7.md

@ -15,17 +15,16 @@ if it exists, or the status of all invoices if given no argument.
RETURN VALUE RETURN VALUE
------------ ------------
On success, an array *invoices* of objects is returned. Each object On success, an array *invoices* of objects is returned. Each object contains
contains *label*, *payment\_hash*, *status* (one of *unpaid*, *paid* or *label*, *payment\_hash*, *status* (one of *unpaid*, *paid* or *expired*),
*expired*), and *expiry\_time* (a UNIX timestamp). If the *msatoshi* *payment\_preimage* (for paid invoices), and *expiry\_time* (a UNIX
argument to lightning-invoice(7) was not "any", there will be an timestamp). If the *msatoshi* argument to lightning-invoice(7) was not "any",
*msatoshi* field as a number, and *amount\_msat* as the same number there will be an *msatoshi* field as a number, and *amount\_msat* as the same
ending in *msat*. If the invoice *status* is *paid*, there will be a number ending in *msat*. If the invoice *status* is *paid*, there will be a
*pay\_index* field and an *msatoshi\_received* field (which may be *pay\_index* field and an *msatoshi\_received* field (which may be slightly
slightly greater than *msatoshi* as some overpaying is permitted to greater than *msatoshi* as some overpaying is permitted to allow clients to
allow clients to obscure payment paths); there will also be an obscure payment paths); there will also be an *amount\_received\_msat* field
*amount\_received\_msat* field with the same number as with the same number as *msatoshi\_received* but ending in *msat*.
*msatoshi\_received* but ending in *msat*.
AUTHOR AUTHOR
------ ------

Loading…
Cancel
Save