mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-01-04 04:54:47 +01:00
Code Issues Projects Releases Wiki Activity
8819278a88
core-lightning/doc/lightning-waitblockheight.7

40 lines
1.0 KiB
Groff
Raw Normal View History

lightningd/peer_control.c: Implement waitblockheight. This is needed to fully implement handling of blockheight disagreements between us and payee. If payee believes the blockheight is higher than ours, then `pay` should wait for our node to achieve that blockheight. Changelog-Add: Implement `waitblockheight` to wait for a specific blockheight.
2019-12-26 11:19:09 +01:00
.TH "LIGHTNING-WAITBLOCKHEIGHT" "7" "" "" "lightning-waitblockheight"
.SH NAME
doc: regenerate and update. My node tried to rebuild one of them because it was lagging (I noticed because mrkd was not installed). Turns out a few were lagging, and lightning-dev-sendcustommsg.7 was totally empty! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-06-25 07:10:41 +02:00
lightning-waitblockheight - Command for waiting for blocks on the blockchain
lightningd/peer_control.c: Implement waitblockheight. This is needed to fully implement handling of blockheight disagreements between us and payee. If payee believes the blockheight is higher than ours, then `pay` should wait for our node to achieve that blockheight. Changelog-Add: Implement `waitblockheight` to wait for a specific blockheight.
2019-12-26 11:19:09 +01:00
.SH SYNOPSIS
\fBwaitblockheight\fR \fIblockheight\fR [\fItimeout\fR]
.SH DESCRIPTION
The \fBwaitblockheight\fR RPC command waits until the blockchain
doc: regenerate and update. My node tried to rebuild one of them because it was lagging (I noticed because mrkd was not installed). Turns out a few were lagging, and lightning-dev-sendcustommsg.7 was totally empty! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-06-25 07:10:41 +02:00
has reached the specified \fIblockheight\fR\.
It will only wait up to \fItimeout\fR seconds (default 60)\.
lightningd/peer_control.c: Implement waitblockheight. This is needed to fully implement handling of blockheight disagreements between us and payee. If payee believes the blockheight is higher than ours, then `pay` should wait for our node to achieve that blockheight. Changelog-Add: Implement `waitblockheight` to wait for a specific blockheight.
2019-12-26 11:19:09 +01:00
If the \fIblockheight\fR is a present or past block height, then this
doc: regenerate and update. My node tried to rebuild one of them because it was lagging (I noticed because mrkd was not installed). Turns out a few were lagging, and lightning-dev-sendcustommsg.7 was totally empty! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-06-25 07:10:41 +02:00
command returns immediately\.
lightningd/peer_control.c: Implement waitblockheight. This is needed to fully implement handling of blockheight disagreements between us and payee. If payee believes the blockheight is higher than ours, then `pay` should wait for our node to achieve that blockheight. Changelog-Add: Implement `waitblockheight` to wait for a specific blockheight.
2019-12-26 11:19:09 +01:00
.SH RETURN VALUE
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 03:10:17 +02:00
On success, an object is returned, containing:
doc: regenerate and update. My node tried to rebuild one of them because it was lagging (I noticed because mrkd was not installed). Turns out a few were lagging, and lightning-dev-sendcustommsg.7 was totally empty! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-06-25 07:10:41 +02:00
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 03:10:17 +02:00
.RS
.IP \[bu]
\fBblockheight\fR (u32): The current block height (>= \fIblockheight\fR parameter)
.RE
lightningd/peer_control.c: Implement waitblockheight. This is needed to fully implement handling of blockheight disagreements between us and payee. If payee believes the blockheight is higher than ours, then `pay` should wait for our node to achieve that blockheight. Changelog-Add: Implement `waitblockheight` to wait for a specific blockheight.
2019-12-26 11:19:09 +01:00
If \fItimeout\fR seconds is reached without the specified blockheight
json-rpc: Give `waitblockheight` an error code for timeouts We need to differentiate timeouts from other results, so make it recognizable.
2021-01-06 16:22:34 +01:00
being reached, this command will fail with a code of \fB2000\fR\.
lightningd/peer_control.c: Implement waitblockheight. This is needed to fully implement handling of blockheight disagreements between us and payee. If payee believes the blockheight is higher than ours, then `pay` should wait for our node to achieve that blockheight. Changelog-Add: Implement `waitblockheight` to wait for a specific blockheight.
2019-12-26 11:19:09 +01:00
.SH AUTHOR
doc: regenerate and update. My node tried to rebuild one of them because it was lagging (I noticed because mrkd was not installed). Turns out a few were lagging, and lightning-dev-sendcustommsg.7 was totally empty! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-06-25 07:10:41 +02:00
ZmnSCPxj \fI<ZmnSCPxj@protonmail.com\fR> is mainly responsible\.
lightningd/peer_control.c: Implement waitblockheight. This is needed to fully implement handling of blockheight disagreements between us and payee. If payee believes the blockheight is higher than ours, then `pay` should wait for our node to achieve that blockheight. Changelog-Add: Implement `waitblockheight` to wait for a specific blockheight.
2019-12-26 11:19:09 +01:00
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 03:10:17 +02:00
\" SHA256STAMP:38dc35b2a28f0ee342af0fdaba6b4f1f27fb1df973426804d30da0572eb3913d
Reference in New Issue Copy Permalink