Class BlockAPI

constructor

• new BlockAPI(client: Client): BlockAPI

  Parameters

  • client: Client

  Returns BlockAPI

Readonlyclient

call

• call(method: string, params?: any): Promise<any>

  Convenience for calling block_api.

  Parameters

  • method: string
  • Optionalparams: any

  Returns Promise<any>

getBlock

• getBlock(blockNum: number): Promise<BlockApiSignedBlock | null>

  Return block blockNum, or null if the node has no such block.

  Parameters

  • blockNum: number

  Returns Promise<BlockApiSignedBlock | null>

getBlockHeader

• getBlockHeader(blockNum: number): Promise<BlockApiBlockHeader | null>

  Return the header of block blockNum, or null if the node has no such block.

  Parameters

  • blockNum: number

  Returns Promise<BlockApiBlockHeader | null>

getBlockRange

• getBlockRange(
      startingBlockNum: number,
      count: number,
  ): Promise<BlockApiSignedBlock[]>

  Return up to count consecutive blocks starting at startingBlockNum. Nodes reject a count above 1000, and return no blocks past their head block.

  Parameters

  • startingBlockNum: number
  • count: number

  Returns Promise<BlockApiSignedBlock[]>