io.nem.sdk.openapi.okhttp_gson.api

Class BlockRoutesApi

java.lang.Object

io.nem.sdk.openapi.okhttp_gson.api.BlockRoutesApi

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.
okhttp3.Call	getBlockByHeightAsync(java.math.BigInteger height, ApiCallback<BlockInfoDTO> _callback) Get block information (asynchronously) Gets a block from the chain that has the given height.
okhttp3.Call	getBlockByHeightCall(java.math.BigInteger height, ApiCallback _callback) Build call for getBlockByHeight
ApiResponse<BlockInfoDTO>	getBlockByHeightWithHttpInfo(java.math.BigInteger height) Get block information Gets a block from the chain that has the given height.
java.util.List<BlockInfoDTO>	getBlocksByHeightWithLimit(java.math.BigInteger height, java.lang.Integer limit) Get blocks information Gets up to limit number of blocks after given block height.
okhttp3.Call	getBlocksByHeightWithLimitAsync(java.math.BigInteger height, java.lang.Integer limit, ApiCallback<java.util.List<BlockInfoDTO>> _callback) Get blocks information (asynchronously) Gets up to limit number of blocks after given block height.
okhttp3.Call	getBlocksByHeightWithLimitCall(java.math.BigInteger height, java.lang.Integer limit, ApiCallback _callback) Build call for getBlocksByHeightWithLimit
ApiResponse<java.util.List<BlockInfoDTO>>	getBlocksByHeightWithLimitWithHttpInfo(java.math.BigInteger height, java.lang.Integer limit) Get blocks information Gets up to limit number of blocks after given block height.
java.util.List<TransactionInfoDTO>	getBlockTransactions(java.math.BigInteger 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.
okhttp3.Call	getBlockTransactionsAsync(java.math.BigInteger height, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering, ApiCallback<java.util.List<TransactionInfoDTO>> _callback) Get transactions from a block (asynchronously) Returns an array of transactions included in a block for a given block height.
okhttp3.Call	getBlockTransactionsCall(java.math.BigInteger height, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering, ApiCallback _callback) Build call for getBlockTransactions
ApiResponse<java.util.List<TransactionInfoDTO>>	getBlockTransactionsWithHttpInfo(java.math.BigInteger 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.
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.
okhttp3.Call	getMerkleTransactionAsync(java.math.BigInteger height, java.lang.String hash, ApiCallback<MerkleProofInfoDTO> _callback) Get the merkle path for a given a transaction and block (asynchronously) Returns the merkle path for a transaction included in a block.
okhttp3.Call	getMerkleTransactionCall(java.math.BigInteger height, java.lang.String hash, ApiCallback _callback) Build call for getMerkleTransaction
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.
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)

getBlockByHeightCall

public okhttp3.Call getBlockByHeightCall(java.math.BigInteger height,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for getBlockByHeight

Parameters:

height - Block height. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

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

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 fail to call the API, e.g. server error or cannot deserialize the response body

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 fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

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

getBlockByHeightAsync

public okhttp3.Call getBlockByHeightAsync(java.math.BigInteger height,
                                          ApiCallback<BlockInfoDTO> _callback)
                                   throws ApiException

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

Parameters:

height - Block height. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

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

getBlockTransactionsCall

public okhttp3.Call getBlockTransactionsCall(java.math.BigInteger height,
                                             java.lang.Integer pageSize,
                                             java.lang.String id,
                                             java.lang.String ordering,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for getBlockTransactions

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")

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

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

getBlockTransactions

public java.util.List<TransactionInfoDTO> getBlockTransactions(java.math.BigInteger height,
                                                               java.lang.Integer pageSize,
                                                               java.lang.String id,
                                                               java.lang.String ordering)
                                                        throws ApiException

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:

List<TransactionInfoDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

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

getBlockTransactionsWithHttpInfo

public ApiResponse<java.util.List<TransactionInfoDTO>> getBlockTransactionsWithHttpInfo(java.math.BigInteger height,
                                                                                        java.lang.Integer pageSize,
                                                                                        java.lang.String id,
                                                                                        java.lang.String ordering)
                                                                                 throws ApiException

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:

ApiResponse<List<TransactionInfoDTO>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

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

getBlockTransactionsAsync

public okhttp3.Call getBlockTransactionsAsync(java.math.BigInteger height,
                                              java.lang.Integer pageSize,
                                              java.lang.String id,
                                              java.lang.String ordering,
                                              ApiCallback<java.util.List<TransactionInfoDTO>> _callback)
                                       throws ApiException

Get transactions from a block (asynchronously) 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")

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

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

getBlocksByHeightWithLimitCall

public okhttp3.Call getBlocksByHeightWithLimitCall(java.math.BigInteger height,
                                                   java.lang.Integer limit,
                                                   ApiCallback _callback)
                                            throws ApiException

Build call for getBlocksByHeightWithLimit

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 a configuration file (rest/resources/rest.json) per REST instance. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getBlocksByHeightWithLimit

public java.util.List<BlockInfoDTO> getBlocksByHeightWithLimit(java.math.BigInteger height,
                                                               java.lang.Integer limit)
                                                        throws ApiException

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 a configuration file (rest/resources/rest.json) per REST instance. (required)

Returns:

List<BlockInfoDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getBlocksByHeightWithLimitWithHttpInfo

public ApiResponse<java.util.List<BlockInfoDTO>> getBlocksByHeightWithLimitWithHttpInfo(java.math.BigInteger height,
                                                                                        java.lang.Integer limit)
                                                                                 throws ApiException

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 a configuration file (rest/resources/rest.json) per REST instance. (required)

Returns:

ApiResponse<List<BlockInfoDTO>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getBlocksByHeightWithLimitAsync

public okhttp3.Call getBlocksByHeightWithLimitAsync(java.math.BigInteger height,
                                                    java.lang.Integer limit,
                                                    ApiCallback<java.util.List<BlockInfoDTO>> _callback)
                                             throws ApiException

Get blocks information (asynchronously) 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 a configuration file (rest/resources/rest.json) per REST instance. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getMerkleTransactionCall

public okhttp3.Call getMerkleTransactionCall(java.math.BigInteger height,
                                             java.lang.String hash,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for getMerkleTransaction

Parameters:

height - Block height. (required)

hash - Transaction hash. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

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 fail to call the API, e.g. server error or cannot deserialize the response body

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 fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

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

getMerkleTransactionAsync

public okhttp3.Call getMerkleTransactionAsync(java.math.BigInteger height,
                                              java.lang.String hash,
                                              ApiCallback<MerkleProofInfoDTO> _callback)
                                       throws ApiException

Get the merkle path for a given a transaction and block (asynchronously) 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)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

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