watchBlockNumber #

Watches and returns incoming block numbers.

Import #

import { watchBlockNumber } from 'viem'

Usage #

Pass through your Public Client, along with a listener.

import { watchBlockNumber } from 'viem'
import { publicClient } from '.'
 
const unwatch = watchBlockNumber( 
  publicClient,
  { onBlockNumber: blockNumber => console.log(blockNumber) }
)
/**
 * > 69420n
 * > 69421n
 * > 69422n
 */

Listener #

(blockNumber: bigint) => void

The block number.

Returns #

UnwatchFn

A function that can be invoked to stop watching for new block numbers.

Parameters #

emitMissed (optional) #

• Type: boolean
• Default: false

Whether or not to emit missed block numbers to the callback.

Missed block numbers may occur in instances where internet connection is lost, or the block time is lesser than the polling interval of the client.

const unwatch = watchBlockNumber(
  client,
  { 
    emitMissed: true, 
    onBlockNumber: blockNumber => console.log(blockNumber),
  }
)

emitOnBegin (optional) #

• Type: boolean
• Default: false

Whether or not to emit the latest block number to the callback when the subscription opens.

const unwatch = watchBlockNumber(
  client,
  { 
    emitOnBegin: true, 
    onBlockNumber: blockNumber => console.log(blockNumber),
  }
)

pollingInterval (optional) #

• Type: number

Polling frequency (in ms). Defaults to Client's pollingInterval config.

const unwatch = watchBlockNumber(
  client,
  { 
    onBlockNumber: blockNumber => console.log(blockNumber),
    pollingInterval: 12_000, 
  }
)