core-lightning/doc/lightning-waitblockheight.7.md
niftynei ba7d4a8f6b make-schema: don't include tools/fromschema.py in SHASUMS
We were including the entire list of prerequisites when generating a
shastamp, which for schemas includes the `tools/fromschema.py` doc.

This meant all of our shasums were updating anytime this tool file
changed.

Instead, we just include the first prerequisite.

See: https://www.gnu.org/software/make/manual/html_node/Automatic-Variables.html#Automatic-Variables
2022-07-14 12:24:48 -05:00

42 lines
1.1 KiB
Markdown

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
------------
[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:c0440c779f4274b2e2bf4c9e5889a3ef9855c9e9a698d5a50dd8d80eb35c0683)