Skip to content

Commit

Permalink
update docs with payment_preimage.
Browse files Browse the repository at this point in the history
  • Loading branch information
fiatjaf committed Nov 26, 2019
1 parent a39f107 commit 2db31f3
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 14 deletions.
9 changes: 7 additions & 2 deletions doc/lightning-invoice.7

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions doc/lightning-invoice.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,9 @@ RETURN VALUE
------------

On success, a hash is returned as *payment\_hash* to be given to the
payer, and the *expiry\_time* as a UNIX timestamp. It also returns a
BOLT11 invoice as *bolt11* to be given to the payer.
payer, the *payment\_preimage* used and the *expiry\_time* as a UNIX
timestamp. It also returns a BOLT11 invoice as *bolt11* to be given
to the payer.

On failure, an error is returned and no invoice is created. If the
lightning process fails before responding, the caller should use
Expand Down
10 changes: 5 additions & 5 deletions doc/lightning-listinvoices.7

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions doc/lightning-listinvoices.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ 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
*expired*), *payment\_preimage*, 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
Expand Down

0 comments on commit 2db31f3

Please sign in to comment.