io.nem.symbol.sdk.openapi.vertx.api.rxjava

Class BlockRoutesApi

java.lang.Object

io.nem.symbol.sdk.openapi.vertx.api.rxjava.BlockRoutesApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2020-03-09T21:11:31.580Z[UTC]")
public class BlockRoutesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BlockRoutesApi(BlockRoutesApi delegate)

Method Summary

Modifier and Type	Method and Description
void	getBlockByHeight(java.lang.String height, io.vertx.core.Handler<io.vertx.core.AsyncResult<BlockInfoDTO>> resultHandler) Get block information Gets a block from the chain that has the given height.
void	getBlocksByHeightWithLimit(java.lang.String height, java.lang.Integer limit, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<BlockInfoDTO>>> resultHandler) Get blocks information Gets up to limit number of blocks after given block height.
void	getBlockTransactions(java.lang.String height, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<TransactionInfoDTO>>> resultHandler) Get transactions from a block Returns an array of transactions included in a block for a given block height.
BlockRoutesApi	getDelegate()
void	getMerkleTransaction(java.lang.String height, java.lang.String hash, io.vertx.core.Handler<io.vertx.core.AsyncResult<MerkleProofInfoDTO>> resultHandler) Get the merkle path for a given a transaction and block Returns the merkle path for a transaction included in a block.
static BlockRoutesApi	newInstance(BlockRoutesApi arg)
rx.Single<BlockInfoDTO>	rxGetBlockByHeight(java.lang.String height) Get block information Gets a block from the chain that has the given height.
rx.Single<java.util.List<BlockInfoDTO>>	rxGetBlocksByHeightWithLimit(java.lang.String height, java.lang.Integer limit) Get blocks information Gets up to limit number of blocks after given block height.
rx.Single<java.util.List<TransactionInfoDTO>>	rxGetBlockTransactions(java.lang.String height, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering) Get transactions from a block Returns an array of transactions included in a block for a given block height.
rx.Single<MerkleProofInfoDTO>	rxGetMerkleTransaction(java.lang.String height, java.lang.String hash) Get the merkle path for a given a transaction and block Returns the merkle path for a transaction included in a block.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlockRoutesApi

public BlockRoutesApi(BlockRoutesApi delegate)

Method Detail

getDelegate

public BlockRoutesApi getDelegate()

getBlockByHeight

public void getBlockByHeight(java.lang.String height,
                             io.vertx.core.Handler<io.vertx.core.AsyncResult<BlockInfoDTO>> resultHandler)

Get block information Gets a block from the chain that has the given height.

Parameters:

height - Block height. (required)

resultHandler - Asynchronous result handler

rxGetBlockByHeight

public rx.Single<BlockInfoDTO> rxGetBlockByHeight(java.lang.String height)

Get block information Gets a block from the chain that has the given height.

Parameters:

height - Block height. (required)

Returns:

Asynchronous result handler (RxJava Single)

getBlockTransactions

public void getBlockTransactions(java.lang.String height,
                                 java.lang.Integer pageSize,
                                 java.lang.String id,
                                 java.lang.String ordering,
                                 io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<TransactionInfoDTO>>> resultHandler)

Get transactions from a block Returns an array of transactions included in a block for a given block height.

Parameters:

height - Block height. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Transaction identifier up to which transactions are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

resultHandler - Asynchronous result handler

rxGetBlockTransactions

public rx.Single<java.util.List<TransactionInfoDTO>> rxGetBlockTransactions(java.lang.String height,
                                                                            java.lang.Integer pageSize,
                                                                            java.lang.String id,
                                                                            java.lang.String ordering)

Get transactions from a block Returns an array of transactions included in a block for a given block height.

Parameters:

height - Block height. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Transaction identifier up to which transactions are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

Returns:

Asynchronous result handler (RxJava Single)

getBlocksByHeightWithLimit

public void getBlocksByHeightWithLimit(java.lang.String height,
                                       java.lang.Integer limit,
                                       io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<BlockInfoDTO>>> resultHandler)

Get blocks information Gets up to limit number of blocks after given block height.

Parameters:

height - Block height. (required)

limit - Number of elements to be returned. The limit should be greater than or equal to \"db.pageSizeMin\" and not higher than \"db.pageSizeMax\". The settings are adjustable via the configuration file (rest/resources/rest.json) per REST instance. (required)

resultHandler - Asynchronous result handler

rxGetBlocksByHeightWithLimit

public rx.Single<java.util.List<BlockInfoDTO>> rxGetBlocksByHeightWithLimit(java.lang.String height,
                                                                            java.lang.Integer limit)

Get blocks information Gets up to limit number of blocks after given block height.

Parameters:

height - Block height. (required)

limit - Number of elements to be returned. The limit should be greater than or equal to \"db.pageSizeMin\" and not higher than \"db.pageSizeMax\". The settings are adjustable via the configuration file (rest/resources/rest.json) per REST instance. (required)

Returns:

Asynchronous result handler (RxJava Single)

getMerkleTransaction

public void getMerkleTransaction(java.lang.String height,
                                 java.lang.String hash,
                                 io.vertx.core.Handler<io.vertx.core.AsyncResult<MerkleProofInfoDTO>> resultHandler)

Get the merkle path for a given a transaction and block Returns the merkle path for a transaction included in a block. The merkle path is the minimum number of nodes needed to calculate the merkle root. Steps to calculate the merkle root: 1. proofHash = hash (leaf). 2. Concatenate proofHash with the first unprocessed item from the merklePath list as follows: * a) If item.position == left -> proofHash = sha_256(item.hash + proofHash). * b) If item.position == right -> proofHash = sha_256(proofHash+ item.hash). 3. Repeat 2. for every item in the merklePath list. 4. Compare if the calculated proofHash equals the one recorded in the block header (block.transactionsHash) to verify if the transaction was included in the block.

Parameters:

height - Block height. (required)

hash - Transaction hash. (required)

resultHandler - Asynchronous result handler

rxGetMerkleTransaction

public rx.Single<MerkleProofInfoDTO> rxGetMerkleTransaction(java.lang.String height,
                                                            java.lang.String hash)

Get the merkle path for a given a transaction and block Returns the merkle path for a transaction included in a block. The merkle path is the minimum number of nodes needed to calculate the merkle root. Steps to calculate the merkle root: 1. proofHash = hash (leaf). 2. Concatenate proofHash with the first unprocessed item from the merklePath list as follows: * a) If item.position == left -> proofHash = sha_256(item.hash + proofHash). * b) If item.position == right -> proofHash = sha_256(proofHash+ item.hash). 3. Repeat 2. for every item in the merklePath list. 4. Compare if the calculated proofHash equals the one recorded in the block header (block.transactionsHash) to verify if the transaction was included in the block.

Parameters:

height - Block height. (required)

hash - Transaction hash. (required)

Returns:

Asynchronous result handler (RxJava Single)

newInstance

public static BlockRoutesApi newInstance(BlockRoutesApi arg)