getBlockHeight

How to Use It

// yarn add @tatumio/tatum

import { TatumSDK, Solana, Network } from '@tatumio/tatum'

const tatum = await TatumSDK.init<Solana>({ network: Network.SOLANA })

const res = await tatum.rpc.getBlockHeight()

await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs

Overview

The getBlockHeight method returns the current block height of the node. Block height refers to the number of blocks preceding the current one in the blockchain.

This method is beneficial for understanding the current status of the blockchain, as it provides the most recent block number processed by the node. It can be used for monitoring the progress of the blockchain, troubleshooting node synchronisation issues, and determining the confirmation status of a transaction by comparing its block number with the current block height.

Parameters

options (object, optional): This object can contain the following fields:

  • commitment(string, optional): Specifies the level of commitment to apply when fetching data.

    • Values: finalized confirmed processed

  • minContextSlot (number, optional): This field can be used to specify the minimum slot that the request can be evaluated at.

Return Object

The method returns a single number, representing the current block height.

JSON-RPC Request Example

{
  "jsonrpc":"2.0",
  "id":1,
  "method":"getBlockHeight"
}

JSON-RPC Response Example

{
  "jsonrpc": "2.0",
  "result": 1233,
  "id": 1
}

Last updated

ยฉ Tatum Technology, LLC