Task: QTUM Activation

API-v2task::enable_qtum::init

task::enable_qtum::init

Use this method for task managed activation of QTUM coins and tokens. Refer to the task managed activation overview for activation of other coin types.

Arguments

Parameter* = required	Type	Description
....url*	`object`	The url and port of a coins electrum server
...servers*	`list`	A list of electrum server URLs (https://github.com/KomodoPlatform/coins/tree/master/electrums)
..rpc*	`string`	UTXO RPC mode. Options: `{ "rpc":"Native" }` if running a native blockchain node, or `"rpc":"Electrum"` to use electrum RPCs. If using electrum, a list of electrum servers is required under `rpc_data.servers`
..rpc_data*	`object`	An object containing electrum server information.
.gap_limit*	`integer`	The max number of empty addresses in a row. If transactions were sent to an address outside the `gap_limit`, they will not be identified when scanning.
.min_addresses_number*	`integer`	How many additional addreesses to generate at a minimum.
.mode*	`object`	An object containing RPC type and data parameters as below.
.scan_policy*	`string`	Whether or not to scan for new addresses. Select from `do_not_scan`, `scan_if_new_wallet` or `scan`. Note that `scan` will result in multple requests to the Komodo DeFi Framework.
activation_params*	`object`	An object containing the actvation parameters below.
ticker*	`string`	The ticker of the coin you want to enable.
....disable_cert_verification	`boolean`	Optional. For `SSL` electrum connections, this will allow expired certificates.
....protocol	`object` default: `TCP`	Optional. Defines electrum server protocol as `TCP` or `SSL`.
....ws_url	`object`	Optional. Used to define electrum server url/port for websocket connections.
.priv_key_policy	`object` default: `{"type": "ContextPrivKey"}`	Optional. A standard PrivKeyPolicy object.

Response

Parameter* = required	Type	Description
task_id*	`integer`	An identifying number which is used to query task status.

📌 Examples

Command

task::enable_qtum::init

POST

task::enable_qtum::init

{
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "task::enable_qtum::init",
  "params": {
    "ticker": "QTUM",
    "activation_params": {
      "mode": {
        "rpc": "Electrum",
        "rpc_data": {
          "servers": [
            {
              "url": "qtum.electrum1.cipig.net:30050",
              "protocol": "WSS"
            },
            {
              "url": "qtum.electrum3.cipig.net:10050",
              "protocol": "TCP"
            },
            {
              "url": "qtum.electrum3.cipig.net:30050",
              "protocol": "WSS"
            }
          ]
        }
      },
      "scan_policy": "scan_if_new_wallet",
      "priv_key_policy": "ContextPrivKey",
      "min_addresses_number": 3,
      "gap_limit": 20
    }
  }
}

Response

{
  "mmrpc": "2.0",
  "result": {
    "task_id": 1
  },
  "id": null
}

API-v2task::enable_qtum::status

task::enable_qtum::status

After running the task::enable_qtum::init method, we 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)

Arguments

Parameter* = required	Type	Description
task_id*	`integer`	The identifying number returned when initiating the initialisation process.
forget_if_finished	`boolean` default: `true`	Optional. If `false`, will return final response for completed tasks.

Request

task::enable_qtum::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
  }
}

The response formats for this method are the same as the task managed activation responses.

API-v2task::enable_qtum::user_action

task::enable_qtum::user_action

If the task::enable_qtum::status returns UserActionRequired, we need to use the task::enable_qtum::user_action method to enter our PIN

Arguments

Parameter* = required	Type	Description
task_id*	`integer`	The identifying number returned when initiating the initialisation process.
user_action*	`object`	Object containing the params below
user_action.action_type*	`string`	Will be `TrezorPin` or `TrezorPassphrase`.
user_action.passphrase*	`string`	Your Trezor passphrase. This is the passphrase you use to unlock a hidden wallet on your Trezor device. Can be empty if you are using a non-hidden wallet.
user_action.pin*	`string (number)`	When the Trezor device is displaying a grid of numbers for PIN entry, this param will contain your Trezor pin, as mapped through your keyboard numpad. See the image below for more information.

Response

Parameter* = required	Type	Description
result*	`string`	The outcome of the request.

📌 Examples

Command

task::enable_qtum::user_action

POST

task::enable_qtum::user_action

{
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "task::enable_qtum::user_action",
  "params": {
    "task_id": 0,
    "user_action": {
      "action_type": "TrezorPin",
      "pin": "862743"
    }
  }
}

Response (success)

{
  "mmrpc": "2.0",
  "result": "success",
  "id": null
}

Error Cases

CoinCreationError: Returned when a coin is not supported.

{
  "mmrpc": "2.0",
  "result": {
    "status": "Error",
    "details": {
      "error": "Error on platform coin QTUM creation: Coin doesn't support Trezor hardware wallet. Please consider adding the 'trezor_coin' field to the coins config",
      "error_path": "lib.init_qtum_activation.utxo_coin_builder",
      "error_trace": "lib:103] init_qtum_activation:71] utxo_coin_builder:234]",
      "error_type": "CoinCreationError",
      "error_data": {
        "ticker": "QTUM",
        "error": "Coin doesn't support Trezor hardware wallet. Please consider adding the 'trezor_coin' field to the coins config"
      }
    }
  },
  "id": null
}

API-v2task::enable_qtum::cancel

task::enable_qtum::cancel

If you want to cancel the enabling process before it has completed, you can use this method.

Arguments

Parameter* = required	Type	Description
task_id*	`integer`	The identifying number returned when initiating the enabling process.

Response

Parameter* = required	Type	Description
error*	`string`	An error message to explain what went wrong.
error_data*	`string`	The input task ID which resulted in the error.
error_path*	`string`	An indicator of the class or function which reurned the error.
error_trace*	`string`	An indicator of where in the source code the error was thrown.
error_type*	`string`	An enumerated value for the returned error.
result*	`string`	Indicates task cancellation was succesful.

📌 Examples

Command

task::enable_qtum::cancel

POST

task::enable_qtum::cancel

{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "task::enable_qtum::cancel",
  "mmrpc": "2.0",
  "params": {
    "task_id": 3
  }
}

Response (success)

{
  "mmrpc": "2.0",
  "result": "success",
  "id": null
}

On this page

Task: QTUM Activation

task::enable_qtum::init

task::enable_qtum::status

task::enable_qtum::user_action

task::enable_qtum::cancel