hera.api

Interface BlockOperation

All Known Implementing Classes:

BlockTemplate

@ApiAudience.Public
 @ApiStability.Unstable
public interface BlockOperation

Provide block related operations. It provides followings:

• lookup block metadata (or metadatas)
• lookup block
• streaming block metadata / block

Method Summary

Modifier and Type	Method and Description
Block	getBlock(BlockHash blockHash) Get block by hash.
Block	getBlock(long height) Get block by height.
BlockMetadata	getBlockMetadata(BlockHash blockHash) Get block meta data by hash.
BlockMetadata	getBlockMetadata(long height) Get block meta data by height.
java.util.List<BlockMetadata>	listBlockMetadatas(BlockHash blockHash, int size) Get list of block meta data of size backward starting from block for provided hash.
java.util.List<BlockMetadata>	listBlockMetadatas(long height, int size) Get list of block meta data of size backward starting from block for provided height.
Subscription<Block>	subscribeNewBlock(StreamObserver<Block> observer) Subscribe block stream which is triggered everytime new block is generated.
Subscription<BlockMetadata>	subscribeNewBlockMetadata(StreamObserver<BlockMetadata> observer) Subscribe block metadata stream which is triggered everytime new block is generated.

Method Detail

getBlockMetadata

BlockMetadata getBlockMetadata(BlockHash blockHash)

Get block meta data by hash.

Parameters:

blockHash - block hash

Returns:

block meta data

getBlockMetadata

BlockMetadata getBlockMetadata(long height)

Get block meta data by height.

Parameters:

height - block's height

Returns:

block meta data

listBlockMetadatas

java.util.List<BlockMetadata> listBlockMetadatas(BlockHash blockHash,
                                                 int size)

Get list of block meta data of size backward starting from block for provided hash.

Parameters:

blockHash - block hash

size - block list size whose upper bound is 1000

Returns:

list of block meta data

listBlockMetadatas

java.util.List<BlockMetadata> listBlockMetadatas(long height,
                                                 int size)

Get list of block meta data of size backward starting from block for provided height.

Parameters:

height - block's height

size - block list size whose upper bound is 1000

Returns:

list of block meta data

getBlock

Block getBlock(BlockHash blockHash)

Get block by hash.

Parameters:

blockHash - block hash

Returns:

block

getBlock

Block getBlock(long height)

Get block by height.

Parameters:

height - block's height

Returns:

block

subscribeNewBlockMetadata

Subscription<BlockMetadata> subscribeNewBlockMetadata(StreamObserver<BlockMetadata> observer)

Subscribe block metadata stream which is triggered everytime new block is generated.

Parameters:

observer - a stream observer which is invoked on new block metadata

Returns:

a block subscription

subscribeNewBlock

Subscription<Block> subscribeNewBlock(StreamObserver<Block> observer)

Subscribe block stream which is triggered everytime new block is generated.

Parameters:

observer - a stream observer which is invoked on new block

Returns:

a block subscription