Enable QTUM Task: Status
API-v2task::enable_qtum::status
After running the task::enable_qtum::init
method, you can query the status of activation to check its progress. The response will return the following:
- Result of the task (success or error)
- Progress status (what state the task is in)
- Required user action (what user should do before the task can continue)
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
task_id | integer | ✓ | - | The identifying number returned when initiating the initialisation process. |
forget_if_finished | boolean | ✗ | true | If false, will return final response for completed tasks. |
QTUM/QRC20 Activation Status
POST
task::enable_qtum::status{
"userpass": "RPC_UserP@SSW0RD",
"mmrpc": "2.0",
"method": "task::enable_qtum::status",
"params": {
"task_id": 0,
"forget_if_finished": false
}
}
Parameter | Type | Description |
---|---|---|
status | TaskActivationStatusEnum | A short indication of how the enabling is progressing. |
details | object | Depending on the state of enabling progress, this will contain different information as shown in the responses below. |
Once complete, status
will be Ok
, and the details
object will have the following structure:
Parameter | Type | Description |
---|---|---|
current_block | integer | Block height of the coin being activated |
ticker | string | Ticker of the coin being activated. |
wallet_balance | object | A standard WalletBalanceInfo object. Note: the structure may vary based on the get_balances parameter value in the activation request. |
Parameter | Type | Description |
---|---|---|
status | string | A short indication of how the requested process is progressing. |
details.result | object | Depending on the state of process progress, this will contain different information as detailed in the items below. |
.error | string | The ticker of the coin being activated |
.error_path | string | Used for debugging. A reference to the function in code base which returned the error |
.error_trace | string | Used for debugging. A trace of lines of code which led to the returned error |
.error_type | string | An enumerated error identifier to indicate the category of error |
.error_data | string | Additonal context for the error type |
Possible Error Cases:
TaskTimedOut
- Timed out waiting for coin activation, connecting to the device trezor or for user to confirm pubkey)CoinCreationError
- Error during activation. E.g. incorrect or inactive electrum servers.HwError
- This is the most important error type. Unlike other error types,HwError
requires the GUI / User to check the details inerror_data
field to know which action is required. View the HwError error type details for more info.