core-lightning/doc/lightning-waitblockheight.7.md
ZmnSCPxj 54cc735201 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.
2020-01-21 22:23:21 +01:00

38 lines
987 B
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
------------
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.
AUTHOR
------
ZmnSCPxj <<ZmnSCPxj@protonmail.com>> is mainly responsible.
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>