mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +01:00
66885163c9
'rhash' is the old terminology, but 'payment_preimage' and 'payment_hash' were decided on for the BOLTs, so we should fix that here. We still use rhash internally, but that's much easier to fix. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
51 lines
1.3 KiB
Plaintext
51 lines
1.3 KiB
Plaintext
LIGHTNING-INVOICE(7)
|
|
====================
|
|
:doctype: manpage
|
|
|
|
NAME
|
|
----
|
|
lightning-invoice - Protocol for accepting payments.
|
|
|
|
SYNOPSIS
|
|
--------
|
|
*invoice* 'msatoshi' 'label'
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
The *invoice* RPC command creates the expectation of a payment of a
|
|
given amount of milli-satoshi: it returns a unique token which another
|
|
lightning daemon can use to pay this invoice.
|
|
|
|
The 'msatoshi' can be the string "any", which creates an invoice
|
|
that can be paid with any amount.
|
|
|
|
The 'label' must be unique; it is never revealed to other nodes on
|
|
the lightning network, but it can be used to query the status of this
|
|
invoice.
|
|
|
|
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.
|
|
On failure, an error is returned and no invoice is created. If the
|
|
lightning process fails before responding, the caller should use
|
|
lightning-listinvoice(7) to query whether this invoice was created or not.
|
|
|
|
//FIXME:Enumerate errors
|
|
|
|
AUTHOR
|
|
------
|
|
Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.
|
|
|
|
SEE ALSO
|
|
--------
|
|
lightning-listinvoice(7), lightning-delinvoice(7),
|
|
lightning-getroute(7), lightning-sendpay(7).
|
|
|
|
RESOURCES
|
|
---------
|
|
Main web site: https://github.com/ElementsProject/lightning
|