task::enable_sia::status
After running the task::enable_sia::init method, query the status of activation
to check its progress. The response returns:
- 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* = required | Type | Description |
|---|---|---|
| task_id* | integer | Task identifier returned by enable_sia/init. |
| forget_if_finished | boolean | Optional. If true, the task is removed from memory if finished. |
task::enable_sia::status
POST
task::enable_sia::status{
"id": 2,
"method": "enable_sia::status",
"mmrpc": "2.0",
"params": {
"forget_if_finished": true,
"task_id": 12345
},
"userpass": "RPC_UserP@SSW0RD"
}
| Parameter* = required | Type | Description |
|---|---|---|
| details* | object | Details object depends on status: Ok (ActivationResult), Error (InitStandaloneCoinError), InProgress (SiaCoinInProgressStatus), UserActionRequired (SiaCoinAwaitingStatus). |
| status* | string | Current status of activation. |
Possible status values while activation is in progress:
- ActivatingCoin: The first step of activation. No user action required.
- RequestingWalletBalance: Initial balances info is being requested. No user action required.
- Finishing: Activation process completed.
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 | Wallet balance object (Iguana for Sia) |
Response (Success)
SUCCESS
{
"id": 2,
"mmrpc": "2.0",
"result": {
"details": {
"current_block": 123456,
"ticker": "SIA",
"wallet_balance": {
"address": "addr:1599ea80d9af168c...17030fb3",
"balance": {
"spendable": "10",
"unspendable": "0"
},
"wallet_type": "Iguana"
}
},
"status": "Ok"
}
}