mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-01-19 05:44:12 +01:00
Code Issues Projects Releases Wiki Activity

docs/fetchinvoice: document payer_note

Browse Source 
Signed-off-by: William Casarin <jb55@jb55.com>
This commit is contained in:
William Casarin 2021-09-03 12:09:11 -07:00 committed by Christian Decker
parent f6709a7a90
commit 105a88dde4
2 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/lightning-fetchinvoice.7
View File

@ -6,7 +6,7 @@ lightning-fetchinvoice - Command for fetch an invoice for an offer
\fB(WARNING: experimental-offers only)\fR
\fBfetchinvoice\fR \fIoffer\fR [\fImsatoshi\fR] [\fIquantity\fR] [\fIrecurrence_counter\fR] [\fIrecurrence_start\fR] [\fIrecurrence_label\fR] [\fItimeout\fR]
\fBfetchinvoice\fR \fIoffer\fR [\fImsatoshi\fR] [\fIquantity\fR] [\fIrecurrence_counter\fR] [\fIrecurrence_start\fR] [\fIrecurrence_label\fR] [\fItimeout\fR] [\fIpayer_note\fR]
.SH DESCRIPTION
@ -50,10 +50,14 @@ calls for the same recurrence, as it is used to link them together\.
\fItimeout\fR is an optional timeout; if we don't get a reply before this
we fail (default, 60 seconds)\.
\fIpayer_note\fR is an optional payer note to include in the fetched invoice\.
.SH RETURN VALUE
On success, an object is returned, containing:
.RS
.IP \[bu]
\fBinvoice\fR (string): The BOLT12 invoice we fetched
@ -94,6 +98,7 @@ On success, an object is returned, containing:
The following error codes may occur:
.RS
.IP \[bu]
-1: Catchall nonspecific error\.
@ -119,4 +124,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:8343ee7fe4d8413760a47a9d2657c4557734fa67af5bfec582daf780828ca675
\" SHA256STAMP:278c8d05aa5412cd3dd58c2903d23b670e0666f2ac923d914f438d9808bd9ac8

4
doc/lightning-fetchinvoice.7.md
View File

@ -6,7 +6,7 @@ SYNOPSIS
**(WARNING: experimental-offers only)**
**fetchinvoice** *offer* \[*msatoshi*\] \[*quantity*\] \[*recurrence_counter*\] \[*recurrence_start*\] \[*recurrence_label*\] \[*timeout*\]
**fetchinvoice** *offer* \[*msatoshi*\] \[*quantity*\] \[*recurrence_counter*\] \[*recurrence_start*\] \[*recurrence_label*\] \[*timeout*\] \[*payer_note*\]
DESCRIPTION
-----------
@ -43,6 +43,8 @@ calls for the same recurrence, as it is used to link them together.
*timeout* is an optional timeout; if we don't get a reply before this
we fail (default, 60 seconds).
*payer_note* is an optional payer note to include in the fetched invoice.
RETURN VALUE
------------