core-lightning/doc/lightning-waitblockheight.7.md

42 lines
1.1 KiB
Markdown
Raw Normal View History

lightning-waitblockheight -- Command for waiting for blocks on the blockchain
=============================================================================
SYNOPSIS
--------
2022-01-26 18:18:49 +01:00
**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
------------
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **blockheight** (u32): The current block height (>= *blockheight* parameter)
[comment]: # (GENERATE-FROM-SCHEMA-END)
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>
[comment]: # ( SHA256STAMP:98f9993935e2820e8e407d1743764346ca6fa1b72228cc82827617a2ed3f3c80)