vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/lightning-waitanyinvoice.7

62 lines
1.8 KiB
Groff
Raw Normal View History

doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.TH "LIGHTNING-WAITANYINVOICE" "7" "" "" "lightning-waitanyinvoice"
.SH NAME
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
2019-08-31 13:30:56 +01:00
lightning-waitanyinvoice - Command for waiting for payments
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH SYNOPSIS
lightningd/invoice.c: Add `timeout` parameter to `waitanyinvoice`. Fixes: #3192 Changelog-Added: `waitanyinvoice` now supports a `timeout` parameter, which when set will cause the command to fail when the timeout is reached; can set this to 0 to fail immediately if no new invoice has been paid yet.
2020-01-28 01:30:00 +00:00
\fBwaitanyinvoice\fR [\fIlastpay_index\fR] [\fItimeout\fR]
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.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\.
lightningd/invoice.c: Add `timeout` parameter to `waitanyinvoice`. Fixes: #3192 Changelog-Added: `waitanyinvoice` now supports a `timeout` parameter, which when set will cause the command to fail when the timeout is reached; can set this to 0 to fail immediately if no new invoice has been paid yet.
2020-01-28 01:30:00 +00:00
If \fItimeout\fR is specified, wait at most that number of seconds, which
must be an integer\.
If the specified \fItimeout\fR is reached, this command will return with an
error\.
You can specify this to 0 so that \fBwaitanyinvoice\fR will return
immediately with an error if no pending invoice is available yet\.
If unspecified, this command will wait indefinitely\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH RETURN VALUE
On success, an invoice description will be returned as per
\fBlightning-listinvoice\fR(7): \fIcomplete\fR will always be \fItrue\fR\.
lightningd/invoice.c: Add `timeout` parameter to `waitanyinvoice`. Fixes: #3192 Changelog-Added: `waitanyinvoice` now supports a `timeout` parameter, which when set will cause the command to fail when the timeout is reached; can set this to 0 to fail immediately if no new invoice has been paid yet.
2020-01-28 01:30:00 +00:00
Possible errors are:
.RS
.IP \[bu]
904\.
The \fItimeout\fR was reached without an invoice being paid\.
.RE
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH AUTHOR
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
2019-08-31 13:30:56 +01:00
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH SEE ALSO
\fBlightning-waitinvoice\fR(7), \fBlightning-listinvoice\fR(7),
\fBlightning-delinvoice\fR(7), \fBlightning-invoice\fR(7)\.
.SH RESOURCES
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
2019-08-31 13:30:56 +01:00
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
doc, wiregen: use SHA256 stamps instead of git versions. This should be more robust in future: we SHA256 all of the deps. For wiregen we prefix with EXPERIMENTAL_FEATURES, since it can effect them. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-31 02:13:23 +01:00
\" SHA256STAMP:a49771fb6295f38674ecec146881cdc5c8490ad9629310942162519fa166776f