xyz.groundx.caver_ext_kas.kas.anchor

Class Anchor

java.lang.Object

xyz.groundx.caver_ext_kas.kas.anchor.Anchor

public class Anchor
extends java.lang.Object

Representing an wrapping class tha connects Anchor APi.

Constructor Summary

Constructors

Constructor and Description
Anchor(java.lang.String chainId, ApiClient anchorApiClient) Creates an AnchorAPI instance

Method Summary

Modifier and Type	Method and Description
AnchorTransactionDetail	getAnchoringTransactionByPayloadId(java.lang.String operatorId, java.lang.String payloadId) Get anchoring transaction with the given payload id. GET /v1/operator/{operator_id}/payload/{payload_id}
com.squareup.okhttp.Call	getAnchoringTransactionByPayloadIdAsync(java.lang.String operatorId, java.lang.String payloadId, ApiCallback<AnchorTransactionDetail> callback) Get anchoring transaction with the given payload id asynchronously. GET /v1/operator/{operator_id}/payload/{payload_id}
AnchorTransactionDetail	getAnchoringTransactionByTxHash(java.lang.String operatorId, java.lang.String txHash) Get anchoring transaction with the given transaction hash. GET /v1/operator/{operator_id}/tx/{tx_hash}
com.squareup.okhttp.Call	getAnchoringTransactionByTxHashAsync(java.lang.String operatorId, java.lang.String txHash, ApiCallback<AnchorTransactionDetail> callback) Get anchoring transaction with the given transaction hash asynchronously. GET /v1/operator/{operator_id}/tx/{tx_hash}
AnchorTransactions	getAnchoringTransactionList(java.lang.String operatorId) Gets anchoring transaction list generated by a given operator. GET /v1/operator/{operator_id}/tx
AnchorTransactions	getAnchoringTransactionList(java.lang.String operatorId, AnchorQueryOptions queryParams) Gets anchoring transaction list generated by a given operator. GET /v1/operator/{operator_id}/tx
com.squareup.okhttp.Call	getAnchoringTransactionListAsync(java.lang.String operatorId, AnchorQueryOptions queryParams, ApiCallback<AnchorTransactions> callback) Gets anchoring transaction list generated by a given operator asynchronously. GET /v1/operator/{operator_id}/tx
com.squareup.okhttp.Call	getAnchoringTransactionListAsync(java.lang.String operatorId, ApiCallback<AnchorTransactions> callback) Gets anchoring transaction list generated by a given operator asynchronously. GET /v1/operator/{operator_id}/tx
java.lang.String	getChainId() Getter function for chain id.
DataAnchoringTransactionApi	getDataAnchoringTransactionApi() Getter function for dataAnchoringTransactionApi.
Operator	getOperator(java.lang.String operatorId) Get operator information. GET /v1/operator/{operator_id}
OperatorApi	getOperatorApi() Getter function for operatorApi.
com.squareup.okhttp.Call	getOperatorAsync(java.lang.String operatorId, ApiCallback<Operator> callback) Get operator information asynchronously. GET /v1/operator/{operator_id}
Operators	getOperatorList() Get operator list. GET /v1/operator
Operators	getOperatorList(AnchorQueryOptions queryParams) Get operator list. GET /v1/operator
com.squareup.okhttp.Call	getOperatorListAsync(AnchorQueryOptions queryParams, ApiCallback<Operators> callback) Get operator list asynchronously. GET /v1/operator
com.squareup.okhttp.Call	getOperatorListAsync(ApiCallback<Operators> callback) Get operator list asynchronously. GET /v1/operator
AnchorBlockStatus	sendAnchoringData(java.lang.String operatorId, AnchorBlockPayload payload) Sends ChainDataAnchoring transaction to the Klaytn. POST /v1/anchor
com.squareup.okhttp.Call	sendAnchoringDataAsync(java.lang.String operatorId, AnchorBlockPayload payload, ApiCallback<AnchorBlockStatus> callback) Sends ChainDataAnchoring transaction to the Klaytn asynchronously. POST /v1/anchor
void	setChainId(java.lang.String chainId) Setter function for chain id
void	setDataAnchoringTransactionApi(DataAnchoringTransactionApi dataAnchoringTransactionApi) Setter function for dataAnchoringTransactionApi
void	setOperatorApi(OperatorApi operatorApi) Setter function for operatorApi

Methods inherited from class java.lang.Object

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

Constructor Detail

Anchor

public Anchor(java.lang.String chainId,
              ApiClient anchorApiClient)

Creates an AnchorAPI instance

Parameters:

chainId - A Klaytn network chain id.

anchorApiClient - The Api client for connecting with KAS.

Method Detail

sendAnchoringData

public AnchorBlockStatus sendAnchoringData(java.lang.String operatorId,
                                           AnchorBlockPayload payload)
                                    throws ApiException

Sends ChainDataAnchoring transaction to the Klaytn.
POST /v1/anchor

Parameters:

operatorId - Operator address to send transaction.

payload - Data to be anchored to the Klaytn.

Returns:

AnchorBlockResponse

Throws:

ApiException

sendAnchoringDataAsync

public com.squareup.okhttp.Call sendAnchoringDataAsync(java.lang.String operatorId,
                                                       AnchorBlockPayload payload,
                                                       ApiCallback<AnchorBlockStatus> callback)
                                                throws ApiException

Sends ChainDataAnchoring transaction to the Klaytn asynchronously.
POST /v1/anchor

Parameters:

operatorId - Operator address to send transaction.

payload - Data to be anchored to the Klaytn.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getAnchoringTransactionList

public AnchorTransactions getAnchoringTransactionList(java.lang.String operatorId)
                                               throws ApiException

Gets anchoring transaction list generated by a given operator.
GET /v1/operator/{operator_id}/tx

Parameters:

operatorId - An operator address to query the anchoring transaction list.

Returns:

RetrieveAnchorBlockResponse

Throws:

ApiException

getAnchoringTransactionList

public AnchorTransactions getAnchoringTransactionList(java.lang.String operatorId,
                                                      AnchorQueryOptions queryParams)
                                               throws ApiException

Gets anchoring transaction list generated by a given operator.
GET /v1/operator/{operator_id}/tx

Parameters:

operatorId - An operator address to query the anchoring transaction list.

queryParams - An query options object.

Returns:

RetrieveAnchorBlockResponse

Throws:

ApiException

getAnchoringTransactionListAsync

public com.squareup.okhttp.Call getAnchoringTransactionListAsync(java.lang.String operatorId,
                                                                 ApiCallback<AnchorTransactions> callback)
                                                          throws ApiException

Gets anchoring transaction list generated by a given operator asynchronously.
GET /v1/operator/{operator_id}/tx

Parameters:

operatorId - An operator address to query the anchoring transaction list.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getAnchoringTransactionListAsync

public com.squareup.okhttp.Call getAnchoringTransactionListAsync(java.lang.String operatorId,
                                                                 AnchorQueryOptions queryParams,
                                                                 ApiCallback<AnchorTransactions> callback)
                                                          throws ApiException

Gets anchoring transaction list generated by a given operator asynchronously.
GET /v1/operator/{operator_id}/tx

Parameters:

operatorId - An operator address to query the anchoring transaction list.

queryParams - A query options object.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getAnchoringTransactionByTxHash

public AnchorTransactionDetail getAnchoringTransactionByTxHash(java.lang.String operatorId,
                                                               java.lang.String txHash)
                                                        throws ApiException

Get anchoring transaction with the given transaction hash.
GET /v1/operator/{operator_id}/tx/{tx_hash}

Parameters:

operatorId - An operator address to query the anchoring transaction.

txHash - A transaction hash used for getting anchoring transaction.

Returns:

AnchorTransactionDetail

Throws:

ApiException

getAnchoringTransactionByTxHashAsync

public com.squareup.okhttp.Call getAnchoringTransactionByTxHashAsync(java.lang.String operatorId,
                                                                     java.lang.String txHash,
                                                                     ApiCallback<AnchorTransactionDetail> callback)
                                                              throws ApiException

Get anchoring transaction with the given transaction hash asynchronously.
GET /v1/operator/{operator_id}/tx/{tx_hash}

Parameters:

operatorId - An operator address to query the anchoring transaction.

txHash - A transaction hash used for getting anchoring transaction.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getAnchoringTransactionByPayloadId

public AnchorTransactionDetail getAnchoringTransactionByPayloadId(java.lang.String operatorId,
                                                                  java.lang.String payloadId)
                                                           throws ApiException

Get anchoring transaction with the given payload id.
GET /v1/operator/{operator_id}/payload/{payload_id}

Parameters:

operatorId - An operator address to query the anchoring transaction.

payloadId - A payload id used for getting anchoring transaction.

Returns:

AnchorTransactionDetail

Throws:

ApiException

getAnchoringTransactionByPayloadIdAsync

public com.squareup.okhttp.Call getAnchoringTransactionByPayloadIdAsync(java.lang.String operatorId,
                                                                        java.lang.String payloadId,
                                                                        ApiCallback<AnchorTransactionDetail> callback)
                                                                 throws ApiException

Get anchoring transaction with the given payload id asynchronously.
GET /v1/operator/{operator_id}/payload/{payload_id}

Parameters:

operatorId - An operator address to query the anchoring transaction.

payloadId - A payload id used for getting anchoring transaction.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getOperatorList

public Operators getOperatorList()
                          throws ApiException

Get operator list.
GET /v1/operator

Returns:

RetrieveOperatorsResponse

Throws:

ApiException

getOperatorList

public Operators getOperatorList(AnchorQueryOptions queryParams)
                          throws ApiException

Get operator list.
GET /v1/operator

Parameters:

queryParams - A query options object.

Returns:

RetrieveOperatorsResponse

Throws:

ApiException

getOperatorListAsync

public com.squareup.okhttp.Call getOperatorListAsync(ApiCallback<Operators> callback)
                                              throws ApiException

Get operator list asynchronously.
GET /v1/operator

Parameters:

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getOperatorListAsync

public com.squareup.okhttp.Call getOperatorListAsync(AnchorQueryOptions queryParams,
                                                     ApiCallback<Operators> callback)
                                              throws ApiException

Get operator list asynchronously.
GET /v1/operator

Parameters:

queryParams - A query options object.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getOperator

public Operator getOperator(java.lang.String operatorId)
                     throws ApiException

Get operator information.
GET /v1/operator/{operator_id}

Parameters:

operatorId - An operator address.

Returns:

GetOperatorResponse

Throws:

ApiException

getOperatorAsync

public com.squareup.okhttp.Call getOperatorAsync(java.lang.String operatorId,
                                                 ApiCallback<Operator> callback)
                                          throws ApiException

Get operator information asynchronously.
GET /v1/operator/{operator_id}

Parameters:

operatorId - An operator address.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getDataAnchoringTransactionApi

public DataAnchoringTransactionApi getDataAnchoringTransactionApi()

Getter function for dataAnchoringTransactionApi.

Returns:

DataAnchoringTransactionApi

getOperatorApi

public OperatorApi getOperatorApi()

Getter function for operatorApi.

Returns:

OperatorApi

getChainId

public java.lang.String getChainId()

Getter function for chain id.

Returns:

String

setDataAnchoringTransactionApi

public void setDataAnchoringTransactionApi(DataAnchoringTransactionApi dataAnchoringTransactionApi)

Setter function for dataAnchoringTransactionApi

Parameters:

dataAnchoringTransactionApi - An rest-client related Anchor API.

setOperatorApi

public void setOperatorApi(OperatorApi operatorApi)

Setter function for operatorApi

Parameters:

operatorApi - An rest-client related Operator API.

setChainId

public void setChainId(java.lang.String chainId)

Setter function for chain id

Parameters:

chainId - The klaytn network chain id.