admin_stateMigrationStatus

The stateMigrationStatus is an administrative method that returns the status information of the state migration. This method takes no parameters and returns the status of the currently running state migration.

JSONRPC: admin_stateMigrationStatus

Request

application/json

Body

method stringrequired

Default value: admin_stateMigrationStatus

Method name

id int64required

Default value: 1

Request ID, Random or Auto incrementation

jsonrpc stringrequired

Default value: 2.0

JSON-RPC Version (2.0)

params array

Responses

200

Returns the status information of the state migration

application/json

Schema

Schema

jsonrpc stringrequired

Default value: 2.0

id int64required

error

object

code int64required

A Number that indicates the error type that occurred. This MUST be an integer.

| code | message | description | |-----|-----|-------| | -32700 | Parse error | invalid JSON was received by the server. An error occurred on the server while parsing the JSON text. | |-32602 | Invalid params | Invalid method parameter(s). |

message string

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

data string

A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

result

object

Returns the status information of the state migration

committed integerrequired

committed is the number of trie nodes that have been copied by the state migration.

err stringnullablerequired

null if the state migration finished well, or an error if not.

isMigration booleanrequired

true if the state migration is running, or false if not.

migrationBlockNumber uint64required

a blockNumber which the state migration started at. (0 if the state migration is not running.)

pending integerrequired

pending represents the number of trie nodes that have not been processed by the state migration.

progress float64required

progress is the progress of the state migration calculated in percent.

read integerrequired

read represents the number of trie nodes that have been read by the state migration.

Example (from schema)

{
  "jsonrpc": "2.0",
  "id": 0,
  "error": {
    "code": -32700,
    "message": "Parse error",
    "data": "string"
  },
  "result": {
    "committed": 1585169,
    "err": "null",
    "isMigration": true,
    "migrationBlockNumber": 32527233,
    "pending": 27677,
    "progress": 0.3662109375,
    "read": 1587473
  }
}

Loading...