new DataAnchoringTransactionApi()
- Version:
- 1.0
DataAnchoringTransaction service.
Methods
anchorBlock(opts, callback)
Create an anchoring transaction Use for anchoring blockchain data. It creates and manages anchoring transactions by the operator set on the KAS console. For successful anchoring through operator or user's feepayer, a balance of 10 times more than the fee needed is required.
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
Object | Optional parameters |
callback |
DataAnchoringTransactionApi~anchorBlockCallback | The callback function, accepting three arguments: error, data, response data is of type: AnchorBlockStatus |
getAnchorBlockByPayloadID(callback)
Retrieve anchoring transactions with payload Specify a Payload ID and an operator ID to retrieve a list of transactions created by the operator. When creating a transaction, you may check the payload added to the transaction.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
DataAnchoringTransactionApi~getAnchorBlockByPayloadIDCallback | The callback function, accepting three arguments: error, data, response data is of type: AnchorTransactionDetail |
getAnchorBlockByTx(callback)
Retrieve anchoring transactions with transaction hash value Specify a transaction hash value and an operator ID to retrieve a list of transactions created by the operator. When creating a transaction, you may check the payload added to the transaction.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
DataAnchoringTransactionApi~getAnchorBlockByTxCallback | The callback function, accepting three arguments: error, data, response data is of type: AnchorTransactionDetail |
retrieveAnchorBlock(opts, callback)
Retrieve a list of transactions by the operator Specify an operator ID to retrieve a list of transactions created by the operator.<p></p> ## Size<p></p> * The query parameter `size` is optional (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default value (`size=100`) when `size=0`<br> * Uses the maximum value (`size=1000`) when given a value higher than the maximum value<br>
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
Object | Optional parameters |
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. |