core-lightning/doc/lightning-waitblockheight.7.md
Rusty Russell b2148d0eab docs: handle "added": "version" and "deprecated": "version" from schemas.
This means we will document deprecations and additions, rather than just
pretending they've always been that way!

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-11 12:51:18 +10:30

1.1 KiB

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

On success, an object is returned, containing:

  • blockheight (u32): The current block height (>= blockheight parameter)

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