Skip to main content

Overview

BlockNumber is a branded bigint type representing a block’s height in the blockchain. Block numbers start at 0 (genesis) and increment by 1 for each new block.

Type Definition

Creating BlockNumbers

from

Create from number or bigint.
Validation: Must be non-negative.

Converting BlockNumbers

toBigInt

Convert to bigint (zero-cost).

toNumber

Convert to number (unsafe for large values).
toNumber may lose precision for block numbers exceeding Number.MAX_SAFE_INTEGER (2^53-1). Use toBigInt for safety.

Comparing BlockNumbers

equals

Check equality.

Common Use Cases

Latest Block Tracking

Block Range Queries

Errors

InvalidBlockNumberError: Invalid value (negative, wrong type).

See Also