mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-01-04 04:54:47 +01:00
b9ac032329
The idea is that you regenerate the man pages in the same commit you alter them: that's how we know whether to try regenerating them or not (git doesn't store timestamps, so it can't really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
60 lines
1.7 KiB
Markdown
60 lines
1.7 KiB
Markdown
lightning-waitanyinvoice -- Command for waiting for payments
|
|
============================================================
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
**waitanyinvoice** \[*lastpay\_index*\] \[*timeout*\]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
The **waitanyinvoice** RPC command waits until an invoice is paid, then
|
|
returns a single entry as per **listinvoice**. It will not return for
|
|
any invoices paid prior to or including the *lastpay\_index*.
|
|
|
|
This is usually called iteratively: once with no arguments, then
|
|
repeatedly with the returned *pay\_index* entry. This ensures that no
|
|
paid invoice is missed.
|
|
|
|
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.
|
|
|
|
If *timeout* is specified, wait at most that number of seconds, which
|
|
must be an integer.
|
|
If the specified *timeout* is reached, this command will return with an
|
|
error.
|
|
You can specify this to 0 so that **waitanyinvoice** will return
|
|
immediately with an error if no pending invoice is available yet.
|
|
If unspecified, this command will wait indefinitely.
|
|
|
|
RETURN VALUE
|
|
------------
|
|
|
|
On success, an invoice description will be returned as per
|
|
lightning-listinvoice(7): *complete* will always be *true*.
|
|
|
|
Possible errors are:
|
|
|
|
* 904.
|
|
The *timeout* was reached without an invoice being paid.
|
|
|
|
AUTHOR
|
|
------
|
|
|
|
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
lightning-waitinvoice(7), lightning-listinvoice(7),
|
|
lightning-delinvoice(7), lightning-invoice(7).
|
|
|
|
RESOURCES
|
|
---------
|
|
|
|
Main web site: <https://github.com/ElementsProject/lightning>
|
|
|