Class BlocksModule

constructor

• new BlocksModule(httpClient, options?): BlocksModule

• Initializes a new instance of the Thor class.

  Parameters

  • httpClient: HttpClient

    The Thor instance used to interact with the VeChain blockchain API.
  • Optionaloptions: BlocksModuleOptions

    (Optional) Other optional parameters for polling and error handling.

  Returns BlocksModule

ReadonlyhttpClient

OptionalonBlockError

destroy

• destroy(): void

• Destroys the instance by stopping the event poll.

  Returns void

getAllAddressesIntoABlock

• getAllAddressesIntoABlock(block): string[]

• Retrieves all addresses involved in a given block. This includes beneficiary, signer, clauses, gas payer, origin, contract addresses, event addresses, and transfer recipients and senders.

  Parameters

  • block: ExpandedBlockDetail

    The block object to extract addresses from.

  Returns string[]

  • An array of addresses involved in the block, included empty addresses, duplicate elements are removed.

getBestBlockBaseFeePerGas

• getBestBlockBaseFeePerGas(): Promise<string>

• Retrieves the base fee per gas of the best block.

  Returns Promise<string>

  A promise that resolves to the base fee per gas of the best block.

getBestBlockCompressed

• getBestBlockCompressed(): Promise<CompressedBlockDetail>

• Retrieves details of the latest block.

  Returns Promise<CompressedBlockDetail>

  A promise that resolves to an object containing the compressed block details.

getBestBlockExpanded

• getBestBlockExpanded(): Promise<ExpandedBlockDetail>

• Retrieves details of the latest block.

  Returns Promise<ExpandedBlockDetail>

  A promise that resolves to an object containing the expanded block details.

getBestBlockRef

• getBestBlockRef(): Promise<string>

• Asynchronously retrieves a reference to the best block in the blockchain.

  This method first calls getBestBlockCompressed() to obtain the current best block. If no block is found (i.e., if getBestBlockCompressed() returns null), the method returns null indicating that there's no block to reference. Otherwise, it extracts and returns the first 18 characters of the block's ID, providing the ref to the best block.

  Returns Promise<string>

  A promise that resolves to either a string representing the first 18 characters of the best block's ID, or null if no best block is found.

  @Example: const blockRef = await getBestBlockRef(); if (blockRef) { console.log(Reference to the best block: ${blockRef}); } else { console.log("No best block found."); }

getBlockCompressed

• getBlockCompressed(revision): Promise<CompressedBlockDetail>

• Retrieves details of a compressed specific block identified by its revision (block number or ID).

  Parameters

  • revision: string | number

    The block number or ID to query details for.

  Returns Promise<CompressedBlockDetail>

  A promise that resolves to an object containing the details of the compressed block.

  Throws

getBlockExpanded

• getBlockExpanded(revision): Promise<ExpandedBlockDetail>

• Retrieves details of an expanded specific block identified by its revision (block number or ID).

  Parameters

  • revision: string | number

    The block number or ID to query details for.

  Returns Promise<ExpandedBlockDetail>

  A promise that resolves to an object containing the details of the expanded block.

  Throws

getFinalBlockCompressed

• getFinalBlockCompressed(): Promise<CompressedBlockDetail>

• Retrieves the finalized block.

  Returns Promise<CompressedBlockDetail>

  A promise that resolves to an object containing the finalized block.

getFinalBlockExpanded

• getFinalBlockExpanded(): Promise<ExpandedBlockDetail>

• Retrieves details of the finalized block.

  Returns Promise<ExpandedBlockDetail>

  A promise that resolves to an object containing the finalized block details.

getGenesisBlock

• getGenesisBlock(): Promise<CompressedBlockDetail>

• Retrieves details of the genesis block.

  Returns Promise<CompressedBlockDetail>

  A promise that resolves to an object containing the block details of the genesis block.

getHeadBlock

• getHeadBlock(): CompressedBlockDetail

• Returns the head block (best block).

  Returns CompressedBlockDetail

  The head block (best block).

waitForBlockCompressed

• waitForBlockCompressed(blockNumber, options?): Promise<CompressedBlockDetail>

• Synchronously waits for a specific block revision using polling.

  Parameters

  • blockNumber: number

    The block number to wait for.
  • Optionaloptions: WaitForBlockOptions

    (Optional) Allows to specify timeout and interval in milliseconds

  Returns Promise<CompressedBlockDetail>

  A promise that resolves to an object containing the compressed block.

waitForBlockExpanded

• waitForBlockExpanded(blockNumber, options?): Promise<ExpandedBlockDetail>

• Synchronously waits for a specific expanded block revision using polling.

  Parameters

  • blockNumber: number

    The block number to wait for.
  • Optionaloptions: WaitForBlockOptions

    (Optional) Allows to specify timeout and interval in milliseconds

  Returns Promise<ExpandedBlockDetail>

  A promise that resolves to an object containing the expanded block details.