An object containing the actvation parameters below.
.priv_key_policy
string
Defaults to ContextPrivkey. Set as Trezor to activate in Trezor mode.
.min_addresses_number
integer
How many additional addreesses to generate at a minimum.
.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 AtomicDEX-API.
.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.
.mode
object
An object containing RPC type and data parameters as below.
..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.
...servers
list
A list of electrum server URLs
....url
object
The url and port of a coins electrum server
....ws_url
object
Optional. Used to define electrum server url/port for websocket connections.
....protocol
object
Defines electrum server protocol as TCP or SSL. Defaults to TCP
....disable_cert_verification
boolean
Optional. For SSL electrum connections, this will allow expired certificates.
Returns External when CHAIN=0 in the m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID derivation path. Returns Internal when CHAIN=1 in the m/44'/COIN'/ACCOUNT_ID'/CHAIN/ADDRESS_ID derivation path. External is used for addresses that are meant to be visible outside of the wallet (e.g. for receiving payments). Internal is used for addresses which are not meant to be visible outside of the wallet and is used for return transaction change.
....balance
object
Contains the spendable and unspendable balance for this address
.....spendable
string(numeric)
Spendable balance for this address
.....unspendable
string(numeric)
Unspendable balance for this address (e.g. from unconfirmed incoming transactions)
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 in error_data field to know which action is required. View the HwError error type details for more info.
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 for this method
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.
An object containing the actvation parameters below.
.priv_key_policy
string
Defaults to ContextPrivkey. Set as Trezor to activate in Trezor mode.
.min_addresses_number
integer
How many additional addreesses to generate at a minimum.
.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 AtomicDEX-API.
.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.
.mode
object
An object containing RPC type and data parameters as below.
..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.
...servers
list
A list of electrum server URLs
....url
object
The url and port of a coins electrum server
....ws_url
object
Optional. Used to define electrum server url/port for websocket connections.
....protocol
object
Defines electrum server protocol as TCP or SSL. Defaults to TCP
....disable_cert_verification
boolean
Optional. For SSL electrum connections, this will allow expired certificates.
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 for this method
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.
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}