Setting up a new cheqd node

Context

This document describes how to use install and configure a new instance of cheqd-node from pre-built packages and adding it to an existing network (such as the cheqd testnet) as an observer or validator.

Pre-requisites

Hardware requirements

Minimum specifications

  • 1GB RAM
  • 25GB of disk space
  • 1.4 GHz CPU
  • 2GB RAM
  • 100GB SSD
  • x64 2.0 GHz 2v CPU

Operating system

Our packaged releases are currently compiled and tested for Ubuntu 20.04 LTS, which is the recommended operating system for installation using Debian package or binaries.
For other operating systems, we recommend using pre-built Docker image releases for cheqd-node.
We plan on supporting other operating systems in the future, based on demand for specific platforms by the community.

Storage volumes

We recommend using a storage path that can be kept persistent and restored/remounted (if necessary) for the configuration, data, and log directories associated with a node. This allows a node to be restored along with configuration files such as node keys and for the node's copy of the ledger to be restored without triggering a full chain sync.
The default directory location for cheqd-node installations is $HOME/.cheqdnode, which computes to /home/cheqd/.cheqdnode when using the Debian package installer. Custom paths can be defined if desired.

Ports

To function properly, cheqd-node requires two types of ports to be configured. Depending on the setup, you may also need to configure firewall rules to allow the correct ingress/egress traffic.
Node operators should ensure there are no existing services running on these ports before proceeding with installation.

P2P port

The P2P port is used for peer-to-peer communication between nodes.
  • By default, the P2P port is set to 26656.
  • Inbound and outbound TCP connections must be allowed from any IPv4 address range.
  • The default P2P port can be changed in $HOME/.cheqdnode/config/config.toml.

RPC port

The RPC port is intended to be used by client applications to interact with the node.
During node configuration for cheqd testnet, the RPC port is needed to transfer the initial balance of cheq tokens required for staking.
Beyond this stage, it is up to a node operator whether they want this port to be exposed to the public internet.
The RPC endpoints for a node provide REST, JSONRPC over HTTP, and JSONRPC over WebSockets. These API endpoints can provide useful information for node operators, such as healthchecks, network information, validator information etc.
  • By default, the RPC port is set to 26657
  • Inbound and outbound TCP connections should be allowed from destinations desired by the node operator. The default is to allow this from any IPv4 address range.
  • TLS for the RPC port can also be setup separately. Currently, TLS setup is not automatically carried out in the install process described below.
  • The default RPC port can be changed in $HOME/.cheqdnode/config/config.toml.

Sentry nodes (optional)

Tendermint allows more complex setups in production, where the ingress/egress to a validator node is proxied behind a "sentry" node.
While this setup is not compulsory, node operators with higher stakes or a need to have more robust network security may consider setting up a sentry-validator node architecture.

Installing and configuring a cheqd node

Follow the guide for your preferred installation method:
Configure your node as a validator after successful installation.

Further information

Last modified 15d ago