From f309dc04bab43d67cafaf5e88b8dcb710d0c9666 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Mon, 25 Nov 2019 23:10:15 -0300 Subject: [PATCH] update docs with `payment_preimage`. --- doc/lightning-invoice.7 | 4 ++++ doc/lightning-listinvoices.7 | 21 ++++++++++----------- doc/lightning-listinvoices.7.md | 21 ++++++++++----------- 3 files changed, 24 insertions(+), 22 deletions(-) diff --git a/doc/lightning-invoice.7 b/doc/lightning-invoice.7 index 47a74f6e8ff1..1d77f6ec9501 100644 --- a/doc/lightning-invoice.7 +++ b/doc/lightning-invoice.7 @@ -84,6 +84,7 @@ not\. The following error codes may occur: +.RS .IP \[bu] -1: Catchall nonspecific error\. .IP \[bu] @@ -91,9 +92,11 @@ The following error codes may occur: .IP \[bu] 901: An invoice with the given \fIpreimage\fR already exists\. +.RE One of the following warnings may occur (on success): +.RS .IP \[bu] \fIwarning_offline\fR if no channel with a currently connected peer has 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\. not a dead end) +.RE .SH AUTHOR Rusty Russell \fI is mainly responsible\. diff --git a/doc/lightning-listinvoices.7 b/doc/lightning-listinvoices.7 index e1e96c07d05a..ec1268ffd4b8 100644 --- a/doc/lightning-listinvoices.7 +++ b/doc/lightning-listinvoices.7 @@ -12,17 +12,16 @@ if it exists, or the status of all invoices if given no argument\. .SH RETURN VALUE -On success, an array \fIinvoices\fR of objects is returned\. Each object -contains \fIlabel\fR, \fIpayment_hash\fR, \fIstatus\fR (one of \fIunpaid\fR, \fIpaid\fR or -\fIexpired\fR), and \fIexpiry_time\fR (a UNIX timestamp)\. If the \fImsatoshi\fR -argument to \fBlightning-invoice\fR(7) was not "any", there will be an -\fImsatoshi\fR field as a number, and \fIamount_msat\fR as the same 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 -slightly greater than \fImsatoshi\fR as some overpaying is permitted to -allow clients to obscure payment paths); there will also be an -\fIamount_received_msat\fR field with the same number as -\fImsatoshi_received\fR but ending in \fImsat\fR\. +On success, an array \fIinvoices\fR of objects is returned\. Each object contains +\fIlabel\fR, \fIpayment_hash\fR, \fIstatus\fR (one of \fIunpaid\fR, \fIpaid\fR or \fIexpired\fR), +\fIpayment_preimage\fR (for paid invoices), and \fIexpiry_time\fR (a UNIX +timestamp)\. If the \fImsatoshi\fR argument to \fBlightning-invoice\fR(7) was not "any", +there will be an \fImsatoshi\fR field as a number, and \fIamount_msat\fR as the same +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 slightly +greater than \fImsatoshi\fR as some overpaying is permitted to allow clients to +obscure payment paths); there will also be an \fIamount_received_msat\fR field +with the same number as \fImsatoshi_received\fR but ending in \fImsat\fR\. .SH AUTHOR diff --git a/doc/lightning-listinvoices.7.md b/doc/lightning-listinvoices.7.md index bc083f2d48c8..302748810b8f 100644 --- a/doc/lightning-listinvoices.7.md +++ b/doc/lightning-listinvoices.7.md @@ -15,17 +15,16 @@ if it exists, or the status of all invoices if given no argument. RETURN VALUE ------------ -On success, an array *invoices* of objects is returned. Each object -contains *label*, *payment\_hash*, *status* (one of *unpaid*, *paid* or -*expired*), and *expiry\_time* (a UNIX timestamp). If the *msatoshi* -argument to lightning-invoice(7) was not "any", there will be an -*msatoshi* field as a number, and *amount\_msat* as the same 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 -slightly greater than *msatoshi* as some overpaying is permitted to -allow clients to obscure payment paths); there will also be an -*amount\_received\_msat* field with the same number as -*msatoshi\_received* but ending in *msat*. +On success, an array *invoices* of objects is returned. Each object contains +*label*, *payment\_hash*, *status* (one of *unpaid*, *paid* or *expired*), +*payment\_preimage* (for paid invoices), and *expiry\_time* (a UNIX +timestamp). If the *msatoshi* argument to lightning-invoice(7) was not "any", +there will be an *msatoshi* field as a number, and *amount\_msat* as the same +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 slightly +greater than *msatoshi* as some overpaying is permitted to allow clients to +obscure payment paths); there will also be an *amount\_received\_msat* field +with the same number as *msatoshi\_received* but ending in *msat*. AUTHOR ------