You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

43 lines
1.3 KiB

.TH "LIGHTNING-WAITANYINVOICE" "7" "" "" "lightning-waitanyinvoice"
.SH NAME
lightning-waitanyinvoice - Command for waiting for payments
.SH SYNOPSIS
\fBwaitanyinvoice\fR [\fIlastpay_index\fR]
.SH DESCRIPTION
The \fBwaitanyinvoice\fR RPC command waits until an invoice is paid, then
returns a single entry as per \fBlistinvoice\fR\. It will not return for
any invoices paid prior to or including the \fIlastpay_index\fR\.
This is usually called iteratively: once with no arguments, then
repeatedly with the returned \fIpay_index\fR entry\. This ensures that no
paid invoice is missed\.
The \fIpay_index\fR is a monotonically-increasing number assigned to an
invoice when it gets paid\. The first valid \fIpay_index\fR is 1; specifying
\fIlastpay_index\fR of 0 equivalent to not specifying a \fIlastpay_index\fR\.
Negative \fIlastpay_index\fR is invalid\.
.SH RETURN VALUE
On success, an invoice description will be returned as per
\fBlightning-listinvoice\fR(7): \fIcomplete\fR will always be \fItrue\fR\.
.SH AUTHOR
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
.SH SEE ALSO
\fBlightning-waitinvoice\fR(7), \fBlightning-listinvoice\fR(7),
\fBlightning-delinvoice\fR(7), \fBlightning-invoice\fR(7)\.
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR