2017-01-22 23:58:32 +00:00
|
|
|
LIGHTNING-WAITANYINVOICE(7)
|
|
|
|
|
===========================
|
2016-09-06 08:17:41 +01:00
|
|
|
:doctype: manpage
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
2018-04-26 11:22:09 +01:00
|
|
|
lightning-waitanyinvoice - Command for waiting for payments.
|
2016-09-06 08:17:41 +01:00
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2017-12-26 22:58:42 +00:00
|
|
|
*waitanyinvoice* ['lastpay_index']
|
2016-09-06 08:17:41 +01:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
2017-01-22 23:58:32 +00:00
|
|
|
The *waitanyinvoice* RPC command waits until an invoice is paid, then
|
2016-09-06 08:17:41 +01:00
|
|
|
returns a single entry as per *listinvoice*. It will not return for
|
2017-12-26 22:58:42 +00:00
|
|
|
any invoices paid prior to or including the 'lastpay_index'.
|
2016-09-06 08:17:41 +01:00
|
|
|
|
|
|
|
|
This is usually called iteratively: once with no arguments, then
|
2017-12-26 22:58:42 +00:00
|
|
|
repeatedly with the returned 'pay_index' entry. This ensures that no paid
|
2016-09-06 08:17:41 +01:00
|
|
|
invoice is missed.
|
|
|
|
|
|
2017-12-26 22:58:42 +00:00
|
|
|
The 'pay_index' is a monotonically-increasing number assigned to an
|
|
|
|
|
invoice when it gets paid. The first valid 'pay_index' is 1; specifying
|
|
|
|
|
'lastpay_index' of 0 equivalent to not specifying a 'lastpay_index'.
|
|
|
|
|
Negative 'lastpay_index' is invalid.
|
|
|
|
|
|
|
|
|
|
|
2016-09-06 08:17:41 +01:00
|
|
|
RETURN VALUE
|
|
|
|
|
------------
|
2018-01-13 11:15:47 +00:00
|
|
|
On success, an invoice description will be returned as per lightning-listinvoice(7): 'complete' will always be 'true'.
|
2016-09-06 08:17:41 +01:00
|
|
|
|
|
|
|
|
//FIXME:Enumerate errors
|
|
|
|
|
|
|
|
|
|
AUTHOR
|
|
|
|
|
------
|
|
|
|
|
Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.
|
|
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
2018-01-22 09:49:48 +00:00
|
|
|
lightning-waitinvoice(7), lightning-listinvoice(7), lightning-delinvoice(7), lightning-invoice(7).
|
2016-09-06 08:17:41 +01:00
|
|
|
|
|
|
|
|
RESOURCES
|
|
|
|
|
---------
|
|
|
|
|
Main web site: https://github.com/ElementsProject/lightning
|
