mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity
b36e9fe473
core-lightning/doc/lightning-waitblockheight.7.md
Christian Decker 0d1b45dfcc json-rpc: Give waitblockheight an error code for timeouts 
We need to differentiate timeouts from other results, so make it recognizable.
2021-01-08 09:19:24 +01:00

1010 B
Raw Blame History

lightning-waitblockheight -- Command for waiting for blocks on the blockchain

SYNOPSIS

waitblockheight blockheight [timeout]

DESCRIPTION

The waitblockheight RPC command waits until the blockchain has reached the specified blockheight. It will only wait up to timeout seconds (default 60).

If the blockheight is a present or past block height, then this command returns immediately.

RETURN VALUE

Once the specified block height has been achieved by the blockchain, an object with the single field blockheight is returned, which is the block height at the time the command returns.

If timeout seconds is reached without the specified blockheight being reached, this command will fail with a code of 2000.

AUTHOR

ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible.

RESOURCES

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