Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
LIGHTNING-WAITANYINVOICE(7)lightning-waitanyinvoiceLIGHTNING-WAITANYINVOICE(7)

NAME
       lightning-waitanyinvoice	- Command for waiting for payments

SYNOPSIS
       waitanyinvoice [lastpay_index] [timeout]

DESCRIPTION
       The waitanyinvoice RPC command waits until an invoice is	paid, then re-
       turns a single entry as per listinvoice.	It will	not return for any in-
       voices paid prior to or including the lastpay_index.

       This  is	 usually  called iteratively: once with	no arguments, then re-
       peatedly	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 in-
       voice when it gets paid.	The first valid	 pay_index  is	1;  specifying
       lastpay_index of	0 equivalent to	not specifying a lastpay_index.	 Nega-
       tive 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  waitany-
       invoice	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:

	      o	     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-delin-
       voice(7), lightning-invoice(7).

RESOURCES
       Main web	site: https://github.com/ElementsProject/lightning

						   LIGHTNING-WAITANYINVOICE(7)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | AUTHOR | SEE ALSO | RESOURCES

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=lightning-waitanyinvoice&sektion=7&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help