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

Class BlockRoutesApiImpl

java.lang.Object

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

All Implemented Interfaces:

BlockRoutesApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2020-09-25T14:18:23.319Z[UTC]")
public class BlockRoutesApiImpl
extends java.lang.Object
implements BlockRoutesApi

Constructor Summary

Constructors

Constructor and Description
BlockRoutesApiImpl()
BlockRoutesApiImpl(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
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.
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.
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.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockRoutesApiImpl

public BlockRoutesApiImpl()

BlockRoutesApiImpl

public BlockRoutesApiImpl(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

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.

Specified by:

getBlockByHeight in interface BlockRoutesApi

Parameters:

height - Block height. (required)

resultHandler - Asynchronous result handler

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.

Specified by:

getMerkleReceipts in interface BlockRoutesApi

Parameters:

height - Block height. (required)

hash - Receipt hash. (required)

resultHandler - Asynchronous result handler

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.

Specified by:

getMerkleTransaction in interface BlockRoutesApi

Parameters:

height - Block height. (required)

hash - Transaction hash. (required)

resultHandler - Asynchronous result handler

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.

Specified by:

searchBlocks in interface BlockRoutesApi

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