On this page

latest contributor to this doc

Last Edit:

@smk762

Enable Z Coin Task: Status

API-v2task::enable_z_coin::status

Z coins need to build sync a local block cache and wallet database before they can be used. Using task_id as an input, this method will return the current status of the activation process.

ParameterTypeRequiredDefaultDescription
task_idinteger-The identifying number returned when initiating the initialisation process.
forget_if_finishedbooleantrueIf false, will return final response for completed tasks.

ParameterTypeDescription
statusstringA short indication of how the enabling is progressing.
detailsobjectDepending on the state of enabling progress, this will contain different information as shown in the responses below.

Possible status values while activation is in progress:

  • ActivatingCoin: The first step of activation. It does not require any action from the user.
  • RequestingWalletBalance: The first step of activation, while initial balances info is being requested. It does not require any action from the user.
  • Finishing: Activation process completed
  • WaitingForTrezorToConnect: Waiting for the user to plugin a Trezor device
  • FollowHwDeviceInstructions: Waiting for the user to follow the instructions on the device

Once complete, status will be Ok, and the details object will have the following structure:

ParameterTypeDescription
current_blockintegerBlock height of the coin being activated
tickerstringTicker of the coin being activated.
wallet_balanceobjectA standard WalletBalanceInfo object. Note: the structure may vary based on the get_balances parameter value in the activation request.

task::enable_z_coin::status

POST
task::enable_z_coin::status
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "task::enable_z_coin::status",
  "mmrpc": "2.0",
  "params": {
    "task_id": 0,
    "forget_if_finished": false
  }
}