[Block] klay_syncing

Returns an object with data about the sync status or false.

JSONRPC: klay_syncing

Request

application/json

Body

method stringrequired

Default value: klay_syncing

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 Object|Boolean, an object with sync status data or false when not syncing

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

oneOf

SyncingObject

startingBlock hexrequired

The block at which the import started (will only be reset, after the sync reached his head).

currentBlock hexrequired

The current block, same as klay_blockNumber.

highestBlock hexrequired

The estimated highest block.

pulledStates hexrequired

The number of state entries processed until now. If the sync mode is not "fast", zero is returned.

knownStates hexrequired

The number of known state entries that still need to be pulled. If the sync mode is not "fast", zero is returned.

MOD2

boolean

Example (from schema)

{
  "jsonrpc": "2.0",
  "id": 0,
  "error": {
    "code": -32700,
    "message": "Parse error",
    "data": "string"
  },
  "result": {
    "currentBlock": "0x3e31e",
    "highestBlock": "0x827eef",
    "knownStates": "0x0",
    "pulledStates": "0x0",
    "startingBlock": "0x0"
  }
}

Loading...