Class Blockchain

constructor

• new Blockchain(client): Blockchain

• Parameters

  • client: Client

  Returns Blockchain

Readonlyclient

getBlockNumbers

• getBlockNumbers(options?): AsyncGenerator<number, any, unknown>

• Return a asynchronous block number iterator.

  Parameters

  • Optionaloptions: number | BlockchainStreamOptions

    Feed options, can also be a block number to start from.

  Returns AsyncGenerator<number, any, unknown>

getBlockNumberStream

• getBlockNumberStream(options?): ReadableStream

• Return a stream of block numbers, accepts same parameters as getBlockNumbers.

  Parameters

  • Optionaloptions: number | BlockchainStreamOptions

  Returns ReadableStream

getBlocks

• getBlocks(options?): AsyncGenerator<SignedBlock, any, unknown>

• Return a asynchronous block iterator, accepts same parameters as getBlockNumbers.

  Parameters

  • Optionaloptions: number | BlockchainStreamOptions

  Returns AsyncGenerator<SignedBlock, any, unknown>

getBlockStream

• getBlockStream(options?): ReadableStream

• Return a stream of blocks, accepts same parameters as getBlockNumbers.

  Parameters

  • Optionaloptions: number | BlockchainStreamOptions

  Returns ReadableStream

getCurrentBlock

• getCurrentBlock(mode?): Promise<SignedBlock>

• Get latest block.

  Parameters

  • Optionalmode: BlockchainMode

  Returns Promise<SignedBlock>

getCurrentBlockHeader

• getCurrentBlockHeader(mode?): Promise<BlockHeader>

• Get latest block header.

  Parameters

  • Optionalmode: BlockchainMode

  Returns Promise<BlockHeader>

getCurrentBlockNum

• getCurrentBlockNum(mode?): Promise<number>

• Get latest block number.

  Parameters

  • mode: BlockchainMode = BlockchainMode.Irreversible

  Returns Promise<number>

getOperations

• getOperations(options?): AsyncGenerator<AppliedOperation, any, unknown>

• Return a asynchronous operation iterator, accepts same parameters as getBlockNumbers.

  Parameters

  • Optionaloptions: number | BlockchainStreamOptions

  Returns AsyncGenerator<AppliedOperation, any, unknown>

getOperationsStream

• getOperationsStream(options?): ReadableStream

• Return a stream of operations, accepts same parameters as getBlockNumbers.

  Parameters

  • Optionaloptions: number | BlockchainStreamOptions

  Returns ReadableStream