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-09-25T14:18:23.319Z[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.math.BigInteger 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.
BlockRoutesApi	getDelegate()
void	getMerkleReceipts(java.math.BigInteger height, java.lang.String hash, io.vertx.core.Handler<io.vertx.core.AsyncResult<MerkleProofInfoDTO>> resultHandler) Get the merkle path for a given a receipt statement hash and block Returns the merkle path for a receipt statement or resolution linked to a block.
void	getMerkleTransaction(java.math.BigInteger 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.math.BigInteger height) Get block information Gets a block from the chain that has the given height.
rx.Single<MerkleProofInfoDTO>	rxGetMerkleReceipts(java.math.BigInteger height, java.lang.String hash) Get the merkle path for a given a receipt statement hash and block Returns the merkle path for a receipt statement or resolution linked to a block.
rx.Single<MerkleProofInfoDTO>	rxGetMerkleTransaction(java.math.BigInteger 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.
rx.Single<BlockPage>	rxSearchBlocks(java.lang.String signerPublicKey, java.lang.String beneficiaryAddress, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order, BlockOrderByEnum orderBy) Search blocks Gets an array of bocks.
void	searchBlocks(java.lang.String signerPublicKey, java.lang.String beneficiaryAddress, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order, BlockOrderByEnum orderBy, io.vertx.core.Handler<io.vertx.core.AsyncResult<BlockPage>> resultHandler) Search blocks Gets an array of bocks.

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.math.BigInteger 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.math.BigInteger 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)

getMerkleReceipts

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

Get the merkle path for a given a receipt statement hash and block Returns the merkle path for a receipt statement or resolution linked to 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.receiptsHash) to verify if the statement was linked with the block.

Parameters:

height - Block height. (required)

hash - Receipt hash. (required)

resultHandler - Asynchronous result handler

rxGetMerkleReceipts

public rx.Single<MerkleProofInfoDTO> rxGetMerkleReceipts(java.math.BigInteger height,
                                                         java.lang.String hash)

Get the merkle path for a given a receipt statement hash and block Returns the merkle path for a receipt statement or resolution linked to 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.receiptsHash) to verify if the statement was linked with the block.

Parameters:

height - Block height. (required)

hash - Receipt hash. (required)

Returns:

Asynchronous result handler (RxJava Single)

getMerkleTransaction

public void getMerkleTransaction(java.math.BigInteger 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.math.BigInteger 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)

searchBlocks

public void searchBlocks(java.lang.String signerPublicKey,
                         java.lang.String beneficiaryAddress,
                         java.lang.Integer pageSize,
                         java.lang.Integer pageNumber,
                         java.lang.String offset,
                         Order order,
                         BlockOrderByEnum orderBy,
                         io.vertx.core.Handler<io.vertx.core.AsyncResult<BlockPage>> resultHandler)

Search blocks Gets an array of bocks.

Parameters:

signerPublicKey - Filter by public key of the account signing the entity. (optional)

beneficiaryAddress - Filter by beneficiary address. (optional)

pageSize - Select the number of entries to return. (optional, default to 10)

pageNumber - Filter by page number. (optional, default to 1)

offset - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

orderBy - Sort responses by the property set. (optional)

resultHandler - Asynchronous result handler

rxSearchBlocks

public rx.Single<BlockPage> rxSearchBlocks(java.lang.String signerPublicKey,
                                           java.lang.String beneficiaryAddress,
                                           java.lang.Integer pageSize,
                                           java.lang.Integer pageNumber,
                                           java.lang.String offset,
                                           Order order,
                                           BlockOrderByEnum orderBy)

Search blocks Gets an array of bocks.

Parameters:

signerPublicKey - Filter by public key of the account signing the entity. (optional)

beneficiaryAddress - Filter by beneficiary address. (optional)

pageSize - Select the number of entries to return. (optional, default to 10)

pageNumber - Filter by page number. (optional, default to 1)

offset - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

orderBy - Sort responses by the property set. (optional)

Returns:

Asynchronous result handler (RxJava Single)

newInstance

public static BlockRoutesApi newInstance(BlockRoutesApi arg)