io.nem.symbol.sdk.openapi.jersey2.api

Class BlockRoutesApi

java.lang.Object

io.nem.symbol.sdk.openapi.jersey2.api.BlockRoutesApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2020-08-14T13:43:37.324Z[UTC]")
public class BlockRoutesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BlockRoutesApi()
BlockRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
BlockInfoDTO	getBlockByHeight(java.math.BigInteger height) Get block information Gets a block from the chain that has the given height.
ApiResponse<BlockInfoDTO>	getBlockByHeightWithHttpInfo(java.math.BigInteger height) Get block information Gets a block from the chain that has the given height.
MerkleProofInfoDTO	getMerkleReceipts(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.
ApiResponse<MerkleProofInfoDTO>	getMerkleReceiptsWithHttpInfo(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.
MerkleProofInfoDTO	getMerkleTransaction(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.
ApiResponse<MerkleProofInfoDTO>	getMerkleTransactionWithHttpInfo(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.
BlockPage	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) Search blocks Gets an array of bocks.
ApiResponse<BlockPage>	searchBlocksWithHttpInfo(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	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockRoutesApi

public BlockRoutesApi()

BlockRoutesApi

public BlockRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getBlockByHeight

public BlockInfoDTO getBlockByHeight(java.math.BigInteger height)
                              throws ApiException

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

Parameters:

height - Block height. (required)

Returns:

BlockInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getBlockByHeightWithHttpInfo

public ApiResponse<BlockInfoDTO> getBlockByHeightWithHttpInfo(java.math.BigInteger height)
                                                       throws ApiException

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

Parameters:

height - Block height. (required)

Returns:

ApiResponse<BlockInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMerkleReceipts

public MerkleProofInfoDTO getMerkleReceipts(java.math.BigInteger height,
                                            java.lang.String hash)
                                     throws ApiException

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:

MerkleProofInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMerkleReceiptsWithHttpInfo

public ApiResponse<MerkleProofInfoDTO> getMerkleReceiptsWithHttpInfo(java.math.BigInteger height,
                                                                     java.lang.String hash)
                                                              throws ApiException

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:

ApiResponse<MerkleProofInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMerkleTransaction

public MerkleProofInfoDTO getMerkleTransaction(java.math.BigInteger height,
                                               java.lang.String hash)
                                        throws ApiException

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:

MerkleProofInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMerkleTransactionWithHttpInfo

public ApiResponse<MerkleProofInfoDTO> getMerkleTransactionWithHttpInfo(java.math.BigInteger height,
                                                                        java.lang.String hash)
                                                                 throws ApiException

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:

ApiResponse<MerkleProofInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

searchBlocks

public BlockPage 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)
                       throws ApiException

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:

BlockPage

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchBlocksWithHttpInfo

public ApiResponse<BlockPage> searchBlocksWithHttpInfo(java.lang.String signerPublicKey,
                                                       java.lang.String beneficiaryAddress,
                                                       java.lang.Integer pageSize,
                                                       java.lang.Integer pageNumber,
                                                       java.lang.String offset,
                                                       Order order,
                                                       BlockOrderByEnum orderBy)
                                                throws ApiException

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:

ApiResponse<BlockPage>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-