The purpose of the qubic-nodes service is to continuously check node reliability and provide, upon request, a list of reliable nodes.

go build

The service can be configured either by CLI parameters or environment variables. The current configuration will be printed at startup.

Run ./go-qubic-nodes --help to print the authoritative list of options.

QUBIC_NODES_QUBIC_PEER_LIST: "5.39.222.64;82.197.173.130;82.197.173.129"   # --qubic-peer-list

The service ships with a default peer list, but there is no guarantee that those bootstrap peers will be available, and the list is not maintained. There are several sources of public peers, for example you can find them here. If discovery is disabled, this list is the set of nodes the service uses.

A docker-compose.yml file is provided in this repository. You can run it as-is using docker compose up -d.

It may be necessary to configure an up-to-date list of peers if the service fails to start.

Override any defaults you need, either as environment variables:

export QUBIC_NODES_QUBIC_PEER_LIST="5.39.222.64;82.197.173.130;82.197.173.129"
./go-qubic-nodes

or as CLI arguments:

./go-qubic-nodes --qubic-peer-list="5.39.222.64;82.197.173.130;82.197.173.129"

Returns the current view of the network. Responds with 503 and a plain text body while no reliable nodes are known (for example during startup).

curl http://127.0.0.1:8080/status

{
  "max_tick":13692658,
  "last_update":1714654658,
  "number_of_configured_nodes":10,
  "reliable_nodes":[
    {
      "address":"5.39.222.64",
      "port":"21841",
      "peers":[
        "194.45.36.121",
        "109.230.239.139",
        "66.23.193.243",
        "5.39.217.105"
      ],
      "last_tick":13692657,
      "last_update":1714654657
    },
    {
      "address":"82.197.173.130",
      "port":"21841",
      "peers":[
        "194.45.36.144",
        "66.248.204.30",
        "66.23.193.218",
        "109.230.239.74"
      ],
      "last_tick":13692658,
      "last_update":1714654658
    }
  ],
  "most_reliable_node":{
    "address":"82.197.173.129",
    "port":"21841",
    "peers":[
      "185.130.224.45",
      "95.156.231.27",
      "82.197.173.130",
      "5.39.216.39"
    ],
    "last_tick":13692658,
    "last_update":1714654658
  }
}

curl http://127.0.0.1:8080/max-tick

{
  "max_tick":13692662
}

Returns only the reliable nodes that are at or above the requested tick.

curl -X POST http://127.0.0.1:8080/reliable-nodes -d '{"minimum_tick":13692650}'

{
  "requested_minimum_tick":13692650,
  "reliable_nodes":[
    {
      "Address":"82.197.173.129",
      "Port":"21841",
      "Peers":[
        "185.130.224.45",
        "95.156.231.27",
        "82.197.173.130",
        "5.39.216.39"
      ],
      "LastTick":13692658,
      "LastUpdate":1714654658,
      "LastUpdateSuccess":true
    }
  ]
}

The node fields of this endpoint are intentionally upper-cased: that is the established wire format and renaming them would break existing clients.

Prometheus metrics, exported under the namespace configured by QUBIC_NODES_METRICS_NAMESPACE.

curl http://127.0.0.1:8080/metrics