### Hierarchy

- Blockchain

## Index

### Constructors

- constructor

### Properties

- client

### Methods

- getBlockNumberStream
- getBlockNumbers
- getBlockStream
- getBlocks
- getCurrentBlock
- getCurrentBlockHeader
- getCurrentBlockNum
- getOperations
- getOperationsStream

## Constructors

### constructor

- new Blockchain(client: Client): Blockchain

- - Defined in helpers/blockchain.ts:66

  #### Parameters

  - ##### client: Client

  #### Returns Blockchain

## Properties

### client

client: Client

- Defined in helpers/blockchain.ts:67

## Methods

### getBlockNumberStream

- getBlockNumberStream(options?: BlockchainStreamOptions | number): ReadableStream

- - Defined in helpers/blockchain.ts:133

  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, void, unknown>

- - Defined in helpers/blockchain.ts:102

  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, void, unknown>

### getBlockStream

- getBlockStream(options?: BlockchainStreamOptions | number): ReadableStream

- - Defined in helpers/blockchain.ts:149

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

  #### Parameters

  - ##### Optional options: BlockchainStreamOptions | number

  #### Returns ReadableStream

### getBlocks

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

- - Defined in helpers/blockchain.ts:140

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

  #### Parameters

  - ##### Optional options: BlockchainStreamOptions | number

  #### Returns AsyncGenerator<SignedBlock, void, unknown>

### getCurrentBlock

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

- - Defined in helpers/blockchain.ts:94

  Get latest block.

  #### Parameters

  - ##### Optional mode: BlockchainMode

  #### Returns Promise<SignedBlock>

### getCurrentBlockHeader

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

- - Defined in helpers/blockchain.ts:85

  Get latest block header.

  #### Parameters

  - ##### Optional mode: BlockchainMode

  #### Returns Promise<BlockHeader>

### getCurrentBlockNum

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

- - Defined in helpers/blockchain.ts:72

  Get latest block number.

  #### Parameters

  - ##### Default value mode: BlockchainMode = BlockchainMode.Irreversible

  #### Returns Promise<number>

### getOperations

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

- - Defined in helpers/blockchain.ts:156

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

  #### Parameters

  - ##### Optional options: BlockchainStreamOptions | number

  #### Returns AsyncGenerator<AppliedOperation, void, unknown>

### getOperationsStream

- getOperationsStream(options?: BlockchainStreamOptions | number): ReadableStream

- - Defined in helpers/blockchain.ts:168

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

  #### Parameters

  - ##### Optional options: BlockchainStreamOptions | number

  #### Returns ReadableStream

Generated using TypeDoc