useBlockNumber

Fetches the latest block number from the configured network and can optionally poll for updates at a specified interval.

Import

import { useBlockNumber } from "@midl-xyz/midl-js-react";

Example

function Page() {
  const { blockNumber } = useBlockNumber();

  return (
    <div>
      <h2>Block Number</h2>
      <p>{blockNumber}</p>
    </div>
  );
}

Parameters

Name	Type	Description
params	UseBlockNumberParams	The parameters for the request
params.watch	boolean	If true, the block number will be polled at the specified interval.
params.pollingInterval	number	The interval in milliseconds at which to poll the block number. Default is 30_000
params.query	QueryOptions	The query options to pass to the underlying useQuery hook.

Returns

Name	Type	Description
blockNumber	number	The latest block number
...rest		Additional query state