DataAnchoringTransactionApi

new DataAnchoringTransactionApi()

Version:

DataAnchoringTransaction service.

Methods

anchorBlock(xChainId, opts, callback)

AnchorBlock It is used to anchor blockchain data. A preconfigured operator is used to create and manage anchoring transactions.

Parameters:

Name Type Description

xChainId

String

Klaytn chain network ID (1001 or 8217)

opts

Object

Optional parameters

Properties

Name	Type	Description
`body`	AnchorBlockRequest

callback

DataAnchoringTransactionApi~anchorBlockCallback

The callback function, accepting three arguments: error, data, response data is of type: AnchorBlockStatus

getAnchorBlockByPayloadID(xChainId, operatorId, payloadId, callback)

GetAnchorBlockByPayloadID Specify a payload ID and operator ID to search for a list of transactions that were created by the operator. When creating a transaction, you may check the payload that is added to a transaction.

Parameters:

Name	Type	Description
`xChainId`	String	Klaytn chain network ID (1001 or 8217)
`operatorId`	String	Operator account address
`payloadId`	String	Payload ID
`callback`	DataAnchoringTransactionApi~getAnchorBlockByPayloadIDCallback	The callback function, accepting three arguments: error, data, response data is of type: AnchorTransactionDetail

getAnchorBlockByTx(xChainId, operatorId, transactionHash, callback)

GetAnchorBlockByTx Specify a transaction hash value and operator ID to search for a list of transactions that were created by the operator. When creating a transaction, you may check the payload that is added to a transaction.

Parameters:

Name	Type	Description
`xChainId`	String	Klaytn chain network ID (1001 or 8217)
`operatorId`	String	Operator account address
`transactionHash`	String	Transaction hash
`callback`	DataAnchoringTransactionApi~getAnchorBlockByTxCallback	The callback function, accepting three arguments: error, data, response data is of type: AnchorTransactionDetail

retrieveAnchorBlock(xChainId, operatorId, opts, callback)

RetrieveAnchorBlock Specify an operator ID to search for a list of transactions that were created by the operator.

## Size

* The size query parameter is optional (minimum = 1, maximum = 1000, default = 100).
* Submitting negative values result in errors.
* Submitting zero results in a query with size=100, which is the default value.
* Submitting values greater than 1000 result in queries with size=1000, which is the maximum value.

Parameters:

Name Type Description

xChainId

String

Klaytn chain network ID (1001 or 8217)

operatorId

String

Operator account address

opts

Object

Optional parameters

Properties

Name	Type	Description
`size`	Number	Maximum size of account to search (default to 100)
`cursor`	String	Information on last searched cursor
`fromTimestamp`	Number	Timestamp of the start time to be searched (in seconds)
`toTimestamp`	Number	Timestamp of the end time to be searched (in seconds)

callback

DataAnchoringTransactionApi~retrieveAnchorBlockCallback

The callback function, accepting three arguments: error, data, response data is of type: AnchorTransactions

Type Definitions

anchorBlockCallback(error, data, response)

Callback function to receive the result of the anchorBlock operation.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	AnchorBlockStatus	The data returned by the service call.
`response`	String	The complete HTTP response.

getAnchorBlockByPayloadIDCallback(error, data, response)

Callback function to receive the result of the getAnchorBlockByPayloadID operation.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	AnchorTransactionDetail	The data returned by the service call.
`response`	String	The complete HTTP response.

getAnchorBlockByTxCallback(error, data, response)

Callback function to receive the result of the getAnchorBlockByTx operation.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	AnchorTransactionDetail	The data returned by the service call.
`response`	String	The complete HTTP response.

retrieveAnchorBlockCallback(error, data, response)

Callback function to receive the result of the retrieveAnchorBlock operation.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	AnchorTransactions	The data returned by the service call.
`response`	String	The complete HTTP response.