Browse Source

doc: note where experimental-offers is required or affects commands.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
ppa
Rusty Russell 4 years ago
committed by Christian Decker
parent
commit
424800fba6
  1. 6
      doc/lightning-createinvoice.7
  2. 4
      doc/lightning-createinvoice.7.md
  3. 4
      doc/lightning-decode.7
  4. 2
      doc/lightning-decode.7.md
  5. 4
      doc/lightning-fetchinvoice.7
  6. 2
      doc/lightning-fetchinvoice.7.md
  7. 7
      doc/lightning-listpays.7
  8. 4
      doc/lightning-listpays.7.md
  9. 7
      doc/lightning-listsendpays.7
  10. 4
      doc/lightning-listsendpays.7.md
  11. 4
      doc/lightning-offer.7
  12. 2
      doc/lightning-offer.7.md
  13. 4
      doc/lightning-offerout.7
  14. 3
      doc/lightning-offerout.7.md
  15. 6
      doc/lightning-pay.7
  16. 3
      doc/lightning-pay.7.md
  17. 4
      doc/lightning-sendinvoice.7
  18. 2
      doc/lightning-sendinvoice.7.md

6
doc/lightning-createinvoice.7

@ -12,7 +12,9 @@ database\.
The \fIinvstring\fR parameter is of bolt11 form, but without the final
signature appended\. Minimal sanity checks are done\.
signature appended\. Minimal sanity checks are done\. (Note: if
\fBexperimental-offers\fR is enabled, \fIinvstring\fR can actually be an
unsigned bolt12 invoice)\.
The \fIlabel\fR must be a unique string or number (which is treated as a
@ -57,4 +59,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:e9abfb1d376a1a5103cb4da2ce7d9d79d0ad6e23683ab1d68423ea4ea4a99f2f
\" SHA256STAMP:155724c3e3130ed7f96d50a37dff99711dfcb4056c57d7eeb488fdb2b7925839

4
doc/lightning-createinvoice.7.md

@ -13,7 +13,9 @@ The **createinvoice** RPC command signs and saves an invoice into the
database.
The *invstring* parameter is of bolt11 form, but without the final
signature appended. Minimal sanity checks are done.
signature appended. Minimal sanity checks are done. (Note: if
**experimental-offers** is enabled, *invstring* can actually be an
unsigned bolt12 invoice).
The *label* must be a unique string or number (which is treated as a
string, so "01" is different from "1"); it is never revealed to other

4
doc/lightning-decode.7

@ -3,7 +3,7 @@
lightning-decode - Command for decoding an invoice string (low-level)
.SH SYNOPSIS
\fIEXPERIMENTAL_FEATURES only\fR
\fB(WARNING: experimental-offers only)\fR
\fBdecode\fR \fIstring\fR
@ -169,4 +169,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:6920ea3b5e3fe8c193ce149b813496370fbc249649911595ea857f5cfb7d6e89
\" SHA256STAMP:4a01fe92de9520e78656495ff9093184cdf4836283af7102ee6b50ab0c826132

2
doc/lightning-decode.7.md

@ -4,7 +4,7 @@ lightning-decode -- Command for decoding an invoice string (low-level)
SYNOPSIS
--------
*EXPERIMENTAL_FEATURES only*
**(WARNING: experimental-offers only)**
**decode** *string*

4
doc/lightning-fetchinvoice.7

@ -3,7 +3,7 @@
lightning-fetchinvoice - Command for fetch an invoice for an offer
.SH SYNOPSIS
\fIEXPERIMENTAL_FEATURES only\fR
\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]
@ -126,4 +126,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:d891c6471a81b3b73109b19d1bc6a393bc60b5df804d6b14d330e2d8dca47f4e
\" SHA256STAMP:a96df8e4f480c093c83268688d683db82575341ecb4176ab586eae9baf69d9c1

2
doc/lightning-fetchinvoice.7.md

@ -4,7 +4,7 @@ lightning-fetchinvoice -- Command for fetch an invoice for an offer
SYNOPSIS
--------
*EXPERIMENTAL_FEATURES only*
**(WARNING: experimental-offers only)**
**fetchinvoice** *offer* \[*msatoshi*\] \[*quantity*\] \[*recurrence_counter*\] \[*recurrence_start*\] \[*recurrence_label*\] \[*timeout*\]

7
doc/lightning-listpays.7

@ -19,6 +19,11 @@ On success, an array of objects is returned\. Each object contains:
the \fIbolt11\fR invoice if provided to \fBpay\fR\.
\fIbolt12\fR
if \fBexperimental-offers\fR is enabled, and \fBpay\fR was a given a bolt12
invoice, this field will appear instead of \fIbolt11\fR\.
\fIpayment_hash\fR
the \fIpayment_hash\fR of the payment\.
@ -69,4 +74,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:539b2a0dccaeda10b0e663217ee80f41561a79ee90b7c6eff2aed388096d7ecb
\" SHA256STAMP:5a0e016e18f52ce18484d064c3e659aca2687eeafca4b4365e3037faa1fba53f

4
doc/lightning-listpays.7.md

@ -20,6 +20,10 @@ On success, an array of objects is returned. Each object contains:
*bolt11*
the *bolt11* invoice if provided to `pay`.
*bolt12*
if **experimental-offers** is enabled, and `pay` was a given a bolt12
invoice, this field will appear instead of *bolt11*.
*payment_hash*
the *payment_hash* of the payment.

7
doc/lightning-listsendpays.7

@ -57,6 +57,11 @@ optional \fIlabel\fR, if provided to \fIsendpay\fR\.
the \fIbolt11\fR argument given to \fIpay\fR (may be missing for pre-0\.7
payments)\.
\fIbolt12\fR
if \fBexperimental-offers\fR is enabled, and \fBpay\fR was a given a bolt12
invoice, this field will appear instead of \fIbolt11\fR\.
.SH AUTHOR
Christian Decker \fI<decker.christian@gmail.com\fR> is mainly
@ -70,4 +75,4 @@ responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:3dc248bbb94b46a5e940a19730ff12bf01a5eb15653f5565a1f94391ce34c497
\" SHA256STAMP:693da7a03235656092cc349b6b77335f71c3a1427d88f1cc8007ea7dd64a8e18

4
doc/lightning-listsendpays.7.md

@ -50,6 +50,10 @@ optional *label*, if provided to *sendpay*.
the *bolt11* argument given to *pay* (may be missing for pre-0.7
payments).
*bolt12*
if **experimental-offers** is enabled, and `pay` was a given a bolt12
invoice, this field will appear instead of *bolt11*.
AUTHOR
------

4
doc/lightning-offer.7

@ -3,7 +3,7 @@
lightning-offer - Command for accepting payments
.SH SYNOPSIS
\fIEXPERIMENTAL_FEATURES only\fR
\fB(WARNING: experimental-offers only)\fR
\fBoffer\fR \fIamount\fR \fIdescription\fR [\fIvendor\fR] [\fIlabel\fR] [\fIquantity_min\fR] [\fIquantity_max\fR] [\fIabsolute_expiry\fR] [\fIrecurrence\fR] [\fIrecurrence_base\fR] [\fIrecurrence_paywindow\fR] [\fIrecurrence_limit\fR] [\fIsingle_use\fR]
@ -149,4 +149,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:60534030c8c7ebc34b521a5bb5d76bd1d59e99ac80d16f5b0a9a3ac3bd164b48
\" SHA256STAMP:02cc4efba11ccd75e34161583ab1b45c99e90aa7d4c122d9773d9acd775578fb

2
doc/lightning-offer.7.md

@ -4,7 +4,7 @@ lightning-offer -- Command for accepting payments
SYNOPSIS
--------
*EXPERIMENTAL_FEATURES only*
**(WARNING: experimental-offers only)**
**offer** *amount* *description* \[*vendor*\] \[*label*\] \[*quantity_min*\] \[*quantity_max*\] \[*absolute_expiry*\] \[*recurrence*\] \[*recurrence_base*\] \[*recurrence_paywindow*\] \[*recurrence_limit*\] \[*single_use*\]

4
doc/lightning-offerout.7

@ -3,7 +3,7 @@
lightning-offerout - Command for offering payments
.SH SYNOPSIS
\fIEXPERIMENTAL_FEATURES only\fR
\fB(WARNING: experimental-offers only)\fR
\fBofferout\fR \fIamount\fR \fIdescription\fR [\fIvendor\fR] [\fIlabel\fR] [\fIabsolute_expiry\fR] [\fIrefund_for\fR]
@ -110,4 +110,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:092f0d776162906eb1045b31caccc7e5eb9fdfa7ba233570f867310ea441ebe5
\" SHA256STAMP:f8055a0a7ee1ba79b1358e190e9e10e0825a1c3b2af5f85f133fe693fa8b1ea4

3
doc/lightning-offerout.7.md

@ -4,7 +4,8 @@ lightning-offerout -- Command for offering payments
SYNOPSIS
--------
*EXPERIMENTAL_FEATURES only*
**(WARNING: experimental-offers only)**
**offerout** *amount* *description* \[*vendor*\] \[*label*\] \[*absolute_expiry*\] \[*refund_for*\]

6
doc/lightning-pay.7

@ -17,6 +17,10 @@ decimal point number with suffix \fIsat\fR, or an 1 to 11 decimal point
number suffixed by \fIbtc\fR\.
(Note: if \fBexperimental-offers\fR is enabled, \fIbolt11\fR can actually be
a bolt12 invoice, such as one received from \fBlightningd-fetchinvoice\fR(7))\.
The \fIlabel\fR field is used to attach a label to payments, and is returned
in \fBlightning-listpays\fR(7) and \fBlightning-listsendpays\fR(7)\. The \fIriskfactor\fR
is described in detail in \fBlightning-getroute\fR(7), and defaults to 10\. The
@ -154,4 +158,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:5173cc560fec005800223eff786a5d36dd677524b50995ce21b2777fb6345084
\" SHA256STAMP:c33dee8ebd5fd5b764f81ceb777a59c5b0c1162f6fc1ae1fba8b38f5215e2e13

3
doc/lightning-pay.7.md

@ -18,6 +18,9 @@ whole number, or a whole number with suffix *msat* or *sat*, or a three
decimal point number with suffix *sat*, or an 1 to 11 decimal point
number suffixed by *btc*.
(Note: if **experimental-offers** is enabled, *bolt11* can actually be
a bolt12 invoice, such as one received from lightningd-fetchinvoice(7)).
The *label* field is used to attach a label to payments, and is returned
in lightning-listpays(7) and lightning-listsendpays(7). The *riskfactor*
is described in detail in lightning-getroute(7), and defaults to 10. The

4
doc/lightning-sendinvoice.7

@ -3,7 +3,7 @@
lightning-sendinvoice - Command for send an invoice for an offer
.SH SYNOPSIS
\fIEXPERIMENTAL_FEATURES only\fR
\fB(WARNING: experimental-offers only)\fR
\fBsendinvoice\fR \fIoffer\fR [\fIlabel\fR] [\fImsatoshi\fR] [\fItimeout\fR] [\fIquantity\fR]
@ -67,4 +67,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:cfb235f88de77288c3a757f9d7252591cb61adb773d7a88062464011a6586753
\" SHA256STAMP:25da409961f77393d1af898e5ddf7757c4ed14c1a4eea58264c969924259ab1e

2
doc/lightning-sendinvoice.7.md

@ -4,7 +4,7 @@ lightning-sendinvoice -- Command for send an invoice for an offer
SYNOPSIS
--------
*EXPERIMENTAL_FEATURES only*
**(WARNING: experimental-offers only)**
**sendinvoice** *offer* \[*label*\] \[*msatoshi*\] \[*timeout*\] \[*quantity*\]

Loading…
Cancel
Save