Skip to content

Commit 424800f

Browse files
rustyrussellcdecker
authored andcommitted
doc: note where experimental-offers is required or affects commands.
Signed-off-by: Rusty Russell <[email protected]>
1 parent c4fe2e7 commit 424800f

18 files changed

+51
-21
lines changed

doc/lightning-createinvoice.7

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

doc/lightning-createinvoice.7.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ The **createinvoice** RPC command signs and saves an invoice into the
1313
database.
1414

1515
The *invstring* parameter is of bolt11 form, but without the final
16-
signature appended. Minimal sanity checks are done.
16+
signature appended. Minimal sanity checks are done. (Note: if
17+
**experimental-offers** is enabled, *invstring* can actually be an
18+
unsigned bolt12 invoice).
1719

1820
The *label* must be a unique string or number (which is treated as a
1921
string, so "01" is different from "1"); it is never revealed to other

doc/lightning-decode.7

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

doc/lightning-decode.7.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ lightning-decode -- Command for decoding an invoice string (low-level)
44
SYNOPSIS
55
--------
66

7-
*EXPERIMENTAL_FEATURES only*
7+
**(WARNING: experimental-offers only)**
88

99
**decode** *string*
1010

doc/lightning-fetchinvoice.7

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

doc/lightning-fetchinvoice.7.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ lightning-fetchinvoice -- Command for fetch an invoice for an offer
44
SYNOPSIS
55
--------
66

7-
*EXPERIMENTAL_FEATURES only*
7+
**(WARNING: experimental-offers only)**
88

99
**fetchinvoice** *offer* \[*msatoshi*\] \[*quantity*\] \[*recurrence_counter*\] \[*recurrence_start*\] \[*recurrence_label*\] \[*timeout*\]
1010

doc/lightning-listpays.7

Lines changed: 6 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

doc/lightning-listpays.7.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ On success, an array of objects is returned. Each object contains:
2020
*bolt11*
2121
the *bolt11* invoice if provided to `pay`.
2222

23+
*bolt12*
24+
if **experimental-offers** is enabled, and `pay` was a given a bolt12
25+
invoice, this field will appear instead of *bolt11*.
26+
2327
*payment_hash*
2428
the *payment_hash* of the payment.
2529

doc/lightning-listsendpays.7

Lines changed: 6 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

doc/lightning-listsendpays.7.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ optional *label*, if provided to *sendpay*.
5050
the *bolt11* argument given to *pay* (may be missing for pre-0.7
5151
payments).
5252

53+
*bolt12*
54+
if **experimental-offers** is enabled, and `pay` was a given a bolt12
55+
invoice, this field will appear instead of *bolt11*.
56+
5357
AUTHOR
5458
------
5559

0 commit comments

Comments
 (0)