Util and Dashboard API

To enable Util and (or) Dashboard RPC API on the node, add "util" and (or) "dashboard" namespace in "PublicModules" in node_config.json

util_getPoWNonce

Calculate PoW nonce according to difficulty. See here for more information.

• Parameters:
  • difficulty: bigint string PoW difficulty
  • hash: hash 32 byte $Blake2b(address + previousHash)$ hash

For example, if address is "vite_ab24ef68b84e642c0ddca06beec81c9acb1977bbd7da27a87a", previousHash is "0000000000000000000000000000000000000000000000000000000000000000", then the hash is "8689fc3e7d0bcad0a1213fd90ab53437ce745408750f7303a16c75bad28da8c3"

• Returns:

  • base64: nonce

• Example:

dashboard_processInfo

Get go-vite information

• Parameters:

  • id: string Optional request id

• Returns:

  • reqId: string Request id
  • build_version: string Go-vite version
  • commit_version: string Go-vite commit id
  • nodeName: string Node name
  • rewardAddress: string If the node has registered for full node reward program, this field is the address to receive rewards, otherwise returns an empty string.
  • pid: int Go-vite process id

• Example:

dashboard_runtimeInfo

Get go-vite runtime information

• Parameters:

  • id: string Optional request id

• Returns:

  • reqId: string Request id
  • peersNum: int Number of connected peers
  • snapshotPendingNum: uint64 string Number of snapshot blocks in mempool
  • accountPendingNum: bigint string Number of account blocks in mempool
  • latestSnapshot: hashHeightTime
    • Hash: string Current snapshot block hash
    • Height: uint64 Current snapshot block height
    • Time: int64 Current snapshot block timestamp. In milliseconds.
  • updateTime: int64 Node's time. In milliseconds.
  • delayTime: Array<int> Block Propagate Latency. See net_nodeInfo for details
  • producer: address Block creation address if the node is SBP. Optional
  • signData: hex 64 byte signature of the current snapshot block hash signed by node's PeerKey

• Example:

dashboard_osInfo

Get node's operating system information

• Parameters:

  • id: string Optional request id

• Returns:

  • reqId: string Request id
  • os: string Node's operating system
  • platform: string Operating system platform
  • platformFamily: string Operating system family
  • platformVersion: string Operating system version
  • kernelVersion: string Operating system kernel version
  • memTotal: uint64 Total memory. In bytes
  • memFree: uint64 Free memory. In bytes
  • cpuNum: int Number of CPU cores
  • gorountine: int Number of Go routines

• Example:

dashboard_netId

Get network id

• Parameters: none

• Returns:

  • string Vite Network id. 1 is the mainnet.

• Example: