ESBOCS. JSON-RPC Requests

List of commands for interacting with ESBOCS Consensus:

• MIN_VALIDATORS_COUNT SET - sets minimum quantity of validators
• MIN_VALIDATORS_COUNT SHOW - shows minimum quantity of validators
• CHECK_SIGNS_STRUCTURE - enables or disables checks for blocks signs structure validity
• CHECK_SIGNS_STRUCTURE SHOW - shows status of checks for blocks signs structure validity
• EMERGENCY VALIDATORS ADD - adds or removes validator
• EMERGENCY VALIDATORS SHOW - shows list of validators allowed to work in emergency mode

JSON-RPC Request - ESBOCS MIN_VALIDATORS_COUNT SET

Sets minimum quantity of validators for ESBOCS Consensus work in the network

CLI Example

Command syntax:

esbocs min_validators_count set 
-net <net_name> 
[-chain <chain_name>] 
-cert <poa_cert_name> 
-val_count <value>

Options:

-net - name of the Cellframe Network. The list of networks can be found in the <Config_dir> \ etc \ network folder or received by The Cellframe-Node-CLI using command - net list
-chain - the name of Chain. The list of chains can be found in the directory <Config_dir> \ etc \ network \ <network_name> or by the Cellframe-Node-CLI using command - net list chains (optional)
-cert - name of the root node certificate 
-val_count - quantity of validators required for consensus work

Example:

Command:

cellframe-node-cli esbocs min_validators_count set 
-net riemann 
-cert riemann.root.pvt.0 
-val_count 4

Response:

        status: Minimum validators count has been set
 
        decree hash: 0x5750A74AFC72C77C920ADEFFFC780C49F5708446A3C3A68ADBC5EA672991808D

JSON-RPC Example

Command:

curl --unix-socket /opt/cellframe-node/var/run/node_cli 
-X POST http://localhost/connect 
-d '{"method":"esbocs", "params":["esbocs;min_validators_count;set;-net;riemann;-cert;riemann.root.pvt.0;-val_count;4"], "id":"1"}'

Response:

{
  "type": 2,
  "result": [
    {
      "status": "Minimum validators count has been set",
      "decree hash": "0xBA611E933C17CB35147DE87F20AF1316F4FA6560BB6BB229C36A1FCD8B6452B6"
    }
  ],
  "errors": null,
  "id": 1
}

Link to original

JSON-RPC Request - ESBOCS MIN_VALIDATORS_COUNT SHOW

Shows minimum quantity of validators for ESBOCS Consensus work in the network

CLI Example

Command syntax:

esbocs min_validators_count show 
-net <net_name> 
[-chain <chain_name>]

Options:

-net - name of the Cellframe Network. The list of networks can be found in the <Config_dir> \ etc \ network folder or received by The Cellframe-Node-CLI using command - net list
-chain - the name of Chain. The list of chains can be found in the directory <Config_dir> \ etc \ network \ <network_name> or by the Cellframe-Node-CLI using command - net list chains (optional)

Example:

Command:

cellframe-node-cli esbocs min_validators_count show 
-net riemann 
-chain main

Response:

 Minimum validators count: 2

JSON-RPC Example

Command:

curl --unix-socket /opt/cellframe-node/var/run/node_cli 
-X POST http://localhost/connect 
-d '{"method":"esbocs", "params":["esbocs;min_validators_count;show;-net;riemann;-chain;main"], "id":"1"}'

Response:

{
  "type": 2,
  "result": [
    {
      "Minimum validators count": 2
    }
  ],
  "errors": null,
  "id": 1
}

Link to original

JSON-RPC Request - ESBOCS CHECK_SIGNS_STRUCTURE

Enables or disables checks for blocks signs structure validity

CLI Example

Command syntax:

esbocs check_signs_structure {enable|disable} 
-net <net_name> 
[-chain <chain_name>] 
-cert <poa_cert_name>

Options:

-net - name of the Cellframe Network. The list of networks can be found in the <Config_dir> \ etc \ network folder or received by The Cellframe-Node-CLI using command - net list
-chain - the name of Chain. The list of chains can be found in the directory <Config_dir> \ etc \ network \ <network_name> or by the Cellframe-Node-CLI using command - net list chains (optional)
-cert - name of the root node certificate 

Example:

Command:

cellframe-node-cli esbocs check_signs_structure enable 
-net riemann 
-chain main 
-cert riemann.root.pvt.0

Response:

        Checking signs structure has been: enabled
 
        Decree hash: 0x6D0459526B50FA5E7EC0B0F0E4E95BDB6496F9B826A05747DFF77F32D1F92D67

JSON-RPC Example

Command:

curl --unix-socket /opt/cellframe-node/var/run/node_cli 
-X POST http://localhost/connect 
-d '{"method":"esbocs", "params":["esbocs;check_signs_structure;enable;-net;riemann;-chain;main;-cert;riemann.root.pvt.0"], "id":"1"}'

Response:

{
  "type": 2,
  "result": [
    {
      "Checking signs structure has been": "enabled",
      "Decree hash": "0x07787EE238D182EC7FC4BDD642AC74B41BBAF564A73702FD37C12D753BB4776F"
    }
  ],
  "errors": null,
  "id": 1
}

Link to original

JSON-RPC Request - ESBOCS CHECK_SIGNS_STRUCTURE SHOW

Shows status of checks for blocks signs structure validity

CLI Example

Command syntax:

esbocs check_signs_structure show 
-net <net_name> 
[-chain <chain_name>]

Options:

-net - name of the Cellframe Network. The list of networks can be found in the <Config_dir> \ etc \ network folder or received by The Cellframe-Node-CLI using command - net list
-chain - the name of Chain. The list of chains can be found in the directory <Config_dir> \ etc \ network \ <network_name> or by the Cellframe-Node-CLI using command - net list chains (optional)

Example:

Command:

cellframe-node-cli esbocs check_signs_structure show 
-net riemann 
-chain main

Response:

     Checking signs structure is: disabled

JSON-RPC Example

Command:

curl --unix-socket /opt/cellframe-node/var/run/node_cli 
-X POST http://localhost/connect 
-d '{"method":"esbocs", "params":["esbocs;check_signs_structure;show;-net;riemann;-chain;main"], "id":"1"}'

Response:

{
  "type": 2,
  "result": [
    {
      "Checking signs structure is": "disabled"
    }
  ],
  "errors": null,
  "id": 1
}

Link to original

JSON-RPC Request - ESBOCS EMERGENCY VALIDATORS ADD

Adds or removes validator by its signature public key hash to list of validators allowed to work in emergency mode

CLI Example

Command syntax:

esbocs emergency_validators {add|remove} 
-net <net_name> 
[-chain <chain_name>] 
-cert <poa_cert_name> 
-pkey_hash <validator_pkey_hash>

Options:

-net - name of the Cellframe Network. The list of networks can be found in the <Config_dir> \ etc \ network folder or received by The Cellframe-Node-CLI using command - net list
-chain - the name of Chain. The list of chains can be found in the directory <Config_dir> \ etc \ network \ <network_name> or by the Cellframe-Node-CLI using command - net list chains (optional)
-cert - name of the root node certificate 
-pkey_hash - public key hash of the validator

Example:

Command:

cellframe-node-cli esbocs emergency_validators add 
-net riemann 
-chain main 
-cert riemann.root.pvt.0 
-pkey_hash 0x327DF692D5918F7A62BC478B04E10892084DDCA801EAF35710BD40C9DCEBF95D

Response:

Emergency validator: 0x327DF692D5918F7A62BC478B04E10892084DDCA801EAF35710BD40C9DCEBF95D
 
        status: added
 
        Decree hash: 0x26265CE750F525C2F4455FDCAC4E7E467A12CF0E01832DAF0568168B662295E3

JSON-RPC Example

Command:

curl --unix-socket /opt/cellframe-node/var/run/node_cli 
-X POST http://localhost/connect 
-d '{"method":"esbocs", "params":["esbocs;emergency_validators;add;-net;riemann;-chain;main;-cert;riemann.root.pvt.0;-pkey_hash;0x327DF692D5918F7A62BC478B04E10892084DDCA801EAF35710BD40C9DCEBF95D"], "id":"1"}'

Response:

{
  "type": 2,
  "result": [
    {
      "Emergency validator": "0x327DF692D5918F7A62BC478B04E10892084DDCA801EAF35710BD40C9DCEBF95D",
      "status": "added",
      "Decree hash": "0xC94C83BBA517053BAA8D0A82753EC5263B5B66D97B1C0FED358B383F2AFF78AB"
    }
  ],
  "errors": null,
  "id": 1
}

Link to original

JSON-RPC Request - ESBOCS EMERGENCY VALIDATORS SHOW

Shows list of validators public key hashes allowed to work in emergency mode

CLI Example

Command syntax:

esbocs emergency_validators show 
-net <net_name> 
[-chain <chain_name>]

Options:

-net - name of the Cellframe Network. The list of networks can be found in the <Config_dir> \ etc \ network folder or received by The Cellframe-Node-CLI using command - net list
-chain - the name of Chain. The list of chains can be found in the directory <Config_dir> \ etc \ network \ <network_name> or by the Cellframe-Node-CLI using command - net list chains (optional)

Example:

Command:

cellframe-node-cli esbocs emergency_validators show 
-net riemann 
-chain main

Response:

        Current emergency validators list:
 
                #: 1
 
                addr hash: 0xD719E3DE39D92998B7CFE7092AA16B53B619B6B093DA9D36B676402CE7AF24DE
 
                #: 2
 
                addr hash: 0x2376A46753161112DD67C81F3EC2DB93A9ED38C2342104FC77301AC65E31EE7C
 
                #: 3
 
                addr hash: 0x7AF94D9A0B3A97D92AD6A66EE6C20C450931946C5DFF695750CB7FF25CAEB1E5

JSON-RPC Example

Command:

curl --unix-socket /opt/cellframe-node/var/run/node_cli 
-X POST http://localhost/connect 
-d '{"method":"esbocs", "params":["esbocs;emergency_validators;show;-net;riemann;-chain;main"], "id":"1"}'

Response:

{
  "type": 2,
  "result": [
    {
      "Current emergency validators list": [
        {
          "#": 1,
          "addr hash": "0xD719E3DE39D92998B7CFE7092AA16B53B619B6B093DA9D36B676402CE7AF24DE"
        },
        {
          "#": 2,
          "addr hash": "0x2376A46753161112DD67C81F3EC2DB93A9ED38C2342104FC77301AC65E31EE7C"
        },
        {
          "#": 3,
 
          "addr hash": "0x7AF94D9A0B3A97D92AD6A66EE6C20C450931946C5DFF695750CB7FF25CAEB1E5"
 
        }
      ]
    }
  ],
  "errors": null,
  "id": 1
}

Link to original