Class Blockchain

Hierarchy

Blockchain

Index

Constructors

Methods

getBlockNumberStream getBlockNumbers getBlockStream getBlocks getCurrentBlock getCurrentBlockHeader getCurrentBlockNum getOperations getOperationsStream

Constructors

constructor

new Blockchain(client: Client): Blockchain
Parameters
- client: Client
Returns Blockchain
- Defined in helpers/blockchain.ts:67

Methods

getBlockNumberStream

getBlockNumberStream(options?: number | BlockchainStreamOptions): ReadableStream
Return a stream of block numbers, accepts same parameters as getBlockNumbers.
Parameters
- Optional options: number | BlockchainStreamOptions
Returns ReadableStream
- Defined in helpers/blockchain.ts:129

getBlockNumbers

getBlockNumbers(options?: number | BlockchainStreamOptions): AsyncGenerator<number, void, unknown>
Return a asynchronous block number iterator.
Parameters
- Optional options: number | BlockchainStreamOptions
  
  Feed options, can also be a block number to start from.
Returns AsyncGenerator<number, void, unknown>
- Defined in helpers/blockchain.ts:100

getBlockStream

getBlockStream(options?: number | BlockchainStreamOptions): ReadableStream
Return a stream of blocks, accepts same parameters as getBlockNumbers.
Parameters
- Optional options: number | BlockchainStreamOptions
Returns ReadableStream
- Defined in helpers/blockchain.ts:145

getBlocks

getBlocks(options?: number | BlockchainStreamOptions): AsyncGenerator<SignedBlock, void, unknown>
Return a asynchronous block iterator, accepts same parameters as getBlockNumbers.
Parameters
- Optional options: number | BlockchainStreamOptions
Returns AsyncGenerator<SignedBlock, void, unknown>
- Defined in helpers/blockchain.ts:136

getCurrentBlock

getCurrentBlock(mode?: BlockchainMode): Promise<SignedBlock>
Get latest block.
Parameters
- Optional mode: BlockchainMode
Returns Promise<SignedBlock>
- Defined in helpers/blockchain.ts:92

getCurrentBlockHeader

getCurrentBlockHeader(mode?: BlockchainMode): Promise<BlockHeader>
Get latest block header.
Parameters
- Optional mode: BlockchainMode
Returns Promise<BlockHeader>
- Defined in helpers/blockchain.ts:85

getCurrentBlockNum

getCurrentBlockNum(mode?: BlockchainMode): Promise<number>
Get latest block number.
Parameters
- mode: BlockchainMode = BlockchainMode.Irreversible
Returns Promise<number>
- Defined in helpers/blockchain.ts:72

getOperations

getOperations(options?: number | BlockchainStreamOptions): AsyncGenerator<AppliedOperation, void, unknown>
Return a asynchronous operation iterator, accepts same parameters as getBlockNumbers.
Parameters
- Optional options: number | BlockchainStreamOptions
Returns AsyncGenerator<AppliedOperation, void, unknown>
- Defined in helpers/blockchain.ts:152

getOperationsStream

getOperationsStream(options?: number | BlockchainStreamOptions): ReadableStream
Return a stream of operations, accepts same parameters as getBlockNumbers.
Parameters
- Optional options: number | BlockchainStreamOptions
Returns ReadableStream
- Defined in helpers/blockchain.ts:164

Generated using TypeDoc