core-lightning/doc/lightning-waitanyinvoice.7.txt
Rusty Russell 2fb2e757ae doc: add lightning-waitinvoice man page.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 10:39:43 +10:30

40 lines
964 B
Plaintext

LIGHTNING-WAITANYINVOICE(7)
===========================
:doctype: manpage
NAME
----
lightning-waitanyinvoice - Protocol for waiting for payments.
SYNOPSIS
--------
*waitanyinvoice* ['lastlabel']
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 'lastlabel'.
This is usually called iteratively: once with no arguments, then
repeatedly with the returned 'label' entry. This ensures that no paid
invoice is missed.
RETURN VALUE
------------
On success, the 'rhash', 'label', and 'msatoshi' will be returned.
//FIXME:Enumerate errors
AUTHOR
------
Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.
SEE ALSO
--------
lighting-waitinvoice(7), lightning-listinvoice(7), lightning-delinvoice(7), lightning-invoice(7).
RESOURCES
---------
Main web site: https://github.com/ElementsProject/lightning