aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-22 08:34:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: document restrictions on invoice RPC.

Browse Source 
In particular: label must be a string, and description cannot use any
the JSON unicode escapes, which should be unnecessary with UTF-8
anyway.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell
2018-03-26 10:38:47 +10:30
parent dfce8b5efd
commit 880c19eb4e
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/lightning-invoice.7.txt
View File

@@ -19,13 +19,14 @@ lightning daemon can use to pay this invoice.
The 'msatoshi' can be the string "any", which creates an invoice The 'msatoshi' can be the string "any", which creates an invoice
that can be paid with any amount. that can be paid with any amount.
The 'label' must be unique; it is never revealed to other nodes on The 'label' must be a unique string; it is never revealed to other nodes on
the lightning network, but it can be used to query the status of this the lightning network, but it can be used to query the status of this
invoice. invoice.
The 'description' is a short description of purpose of payment, The 'description' is a short description of purpose of payment,
e.g. '1 cup of coffee'. This value is encoded into the BOLT11 invoice e.g. '1 cup of coffee'. This value is encoded into the BOLT11 invoice
and is viewable by any node you send this invoice to. and is viewable by any node you send this invoice to. It must be
UTF-8, and cannot use '\u' JSON escape codes.
The 'expiry' is optionally the number of seconds the invoice is valid for. The 'expiry' is optionally the number of seconds the invoice is valid for.
If no value is provided the default of 3600 (1 Hour) is used. If no value is provided the default of 3600 (1 Hour) is used.