Class Blockchain

Hierarchy

Blockchain

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new Blockchain(client: Client): Blockchain

- Defined in helpers/blockchain.ts:61
Parameters
- client: Client
Returns Blockchain

Properties

Readonly client

client: Client

Methods

getBlockNumberStream

getBlockNumberStream(options?: BlockchainStreamOptions | number): ReadableStream

- Defined in helpers/blockchain.ts:112
Return a stream of block numbers, accepts same parameters as getBlockNumbers.

Parameters
- Optional options: BlockchainStreamOptions | number
Returns ReadableStream

getBlockNumbers

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

- Defined in helpers/blockchain.ts:91
Return a asynchronous block number iterator.

Parameters
- Optional options: BlockchainStreamOptions | number
  
  Feed options, can also be a block number to start from.
Returns AsyncGenerator<number, any, unknown>

getBlockStream

getBlockStream(options?: BlockchainStreamOptions | number): ReadableStream

- Defined in helpers/blockchain.ts:124
Return a stream of blocks, accepts same parameters as getBlockNumbers.

Parameters
- Optional options: BlockchainStreamOptions | number
Returns ReadableStream

getBlocks

getBlocks(options?: BlockchainStreamOptions | number): AsyncGenerator<SignedBlock, any, unknown>

- Defined in helpers/blockchain.ts:117
Return a asynchronous block iterator, accepts same parameters as getBlockNumbers.

Parameters
- Optional options: BlockchainStreamOptions | number
Returns AsyncGenerator<SignedBlock, any, unknown>

getCurrentBlock

getCurrentBlock(mode?: BlockchainMode): Promise<SignedBlock>

- Defined in helpers/blockchain.ts:83
Get latest block.

Parameters
- Optional mode: BlockchainMode
Returns Promise<SignedBlock>

getCurrentBlockHeader

getCurrentBlockHeader(mode?: BlockchainMode): Promise<BlockHeader>

- Defined in helpers/blockchain.ts:76
Get latest block header.

Parameters
- Optional mode: BlockchainMode
Returns Promise<BlockHeader>

getCurrentBlockNum

getCurrentBlockNum(mode?: BlockchainMode): Promise<number>

- Defined in helpers/blockchain.ts:65
Get latest block number.

Parameters
- Default value mode: BlockchainMode = BlockchainMode.Irreversible
Returns Promise<number>

getOperations

getOperations(options?: BlockchainStreamOptions | number): AsyncGenerator<AppliedOperation, any, unknown>

- Defined in helpers/blockchain.ts:129
Return a asynchronous operation iterator, accepts same parameters as getBlockNumbers.

Parameters
- Optional options: BlockchainStreamOptions | number
Returns AsyncGenerator<AppliedOperation, any, unknown>

getOperationsStream

getOperationsStream(options?: BlockchainStreamOptions | number): ReadableStream

- Defined in helpers/blockchain.ts:139
Return a stream of operations, accepts same parameters as getBlockNumbers.

Parameters
- Optional options: BlockchainStreamOptions | number
Returns ReadableStream

Generated using TypeDoc