io.nem.sdk.openapi.okhttp_gson.api

Class ReceiptRoutesApi

java.lang.Object

io.nem.sdk.openapi.okhttp_gson.api.ReceiptRoutesApi

public class ReceiptRoutesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ReceiptRoutesApi()
ReceiptRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
StatementsDTO	getBlockReceipts(java.math.BigInteger height) Get receipts from a block Returns the receipts linked to a block.
okhttp3.Call	getBlockReceiptsAsync(java.math.BigInteger height, ApiCallback<StatementsDTO> _callback) Get receipts from a block (asynchronously) Returns the receipts linked to a block.
okhttp3.Call	getBlockReceiptsCall(java.math.BigInteger height, ApiCallback _callback) Build call for getBlockReceipts
ApiResponse<StatementsDTO>	getBlockReceiptsWithHttpInfo(java.math.BigInteger height) Get receipts from a block Returns the receipts linked to a block.
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.
okhttp3.Call	getMerkleReceiptsAsync(java.math.BigInteger height, java.lang.String hash, ApiCallback<MerkleProofInfoDTO> _callback) Get the merkle path for a given a receipt statement hash and block (asynchronously) Returns the merkle path for a receipt statement or resolution linked to a block.
okhttp3.Call	getMerkleReceiptsCall(java.math.BigInteger height, java.lang.String hash, ApiCallback _callback) Build call for getMerkleReceipts
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.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiptRoutesApi

public ReceiptRoutesApi()

ReceiptRoutesApi

public ReceiptRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getBlockReceiptsCall

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

Build call for getBlockReceipts

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	-

getBlockReceipts

public StatementsDTO getBlockReceipts(java.math.BigInteger height)
                               throws ApiException

Get receipts from a block Returns the receipts linked to a block.

Parameters:

height - Block height. (required)

Returns:

StatementsDTO

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	-

getBlockReceiptsWithHttpInfo

public ApiResponse<StatementsDTO> getBlockReceiptsWithHttpInfo(java.math.BigInteger height)
                                                        throws ApiException

Get receipts from a block Returns the receipts linked to a block.

Parameters:

height - Block height. (required)

Returns:

ApiResponse<StatementsDTO>

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	-

getBlockReceiptsAsync

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

Get receipts from a block (asynchronously) Returns the receipts linked to a block.

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	-

getMerkleReceiptsCall

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

Build call for getMerkleReceipts

Parameters:

height - Block height. (required)

hash - Receipt 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	-

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

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

getMerkleReceiptsAsync

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

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

_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	-