Running a RPC node

Clover Foundation provides the RPC services for the public. Sometimes it's necessary to run a self hosted Clover RPC service if the public services can't satisfy your needs.

With a self hosted Clover RPC service you could gain below benefits:

  • Faster access speed - a Self-hosted RPC node could provide better performance

  • Better security - transactions could be sent to to the self-hosted RPC server instead of the public service.

  • Better Availability

Clover is a fully decentralized network, any people can setup a Clover node by following this tutorial!

πŸ€ Types Of Clover RPC Nodes

Generally speaking, there are two kind of RPC nodes:

  • Archive node An archive node keeps all the past blocks data. And client can't query data in any of the past blocks.

  • Full node A full is node is pruned. which means it keeps only a few of the past blocks data(256 by default, which could be adjusted using the --pruning command line arguments.

An archive nodes consumes much more disk spaces it stores more data than a full node. You need to take the decision based on your business model and requirements. E.g. block explorer and historical analysis tools normally requires an archive node to query the full historical data. Wallets on the other hand normally only requires a full node to be able to query the current state(e.g. the balance of an account) and submit transactions to the Clover Network.

β€‹πŸ›  Hardware requirements

  • CPU - Recent released high end cpu, e.g. Intel 10700/Amd 5800X.

  • Memory - 32GB for Testnet, 64GB for Sakura and Mainnet.

  • Storage - 300GB SSD, Storage usage could increase by time, you might need to increase the capacity as the chain data grows..

  • OS: Linux, Debian/Ubuntu LTS distributions are recommended.

Prepare Environment

We'll use docker and docker-compose to run the validator in this guide. You need to install docker and docker-compose firstly. Please follow the installation guide in the docs.

We're using docker to simplify the setup process. You can use the tools which you're familiar with.

β€‹πŸ›° Firewall Setup

Below ports need to be exposed:

  • 30333 - The p2p port of the chain

  • 9933 - The http endpoint of the RPC service

  • 9944 - The websocket endpoint of the RPC service.

You may not expose 9933/9944 ports directly. Instead a reverse proxy server could be setup in front and proxy requests to the rpc backend.


β€‹πŸ“ Create Directories

Create the config and data directories using below command:

sudo mkdir -p /opt/data/
sudo mkdir -p /opt/compose/
# secure the data access
sudo chmod 0700 /opt/data
sudo chmod 0700 /opt/compose

β€‹βš™ Setup Clover Rpc Node

Currently we only have Clover Testnet(iris) and Clover Mainnet(ivy) launched.

Rpc Configuration for Clover Mainnet will be updated later.

β€‹πŸ“ Create the Compose configure file

Create /opt/compose/docker-compose.yaml and set the content as below:

version: "3.8"
image: "cloverio/clover-iris:0.1.15"
restart: always
- /opt/clover/bin/clover
- --chain
- /opt/specs/clover-preview-iris.json
- --base-path
- /opt/chaindata
- --pruning
- archive
- --name
- πŸ€clover-rpc-node
- --port
- "30333"
- --ws-port
- "9944"
- --rpc-port
- "9933"
- --rpc-cors=all
- --ws-max-connections
- "2000"
- --ws-external
- --rpc-external
- "30333:30333"
- "9933:9933"
- "9944:9944"
- /opt/data/clover:/opt/chaindata

You can edit the docker-compose.yaml and include your customizations by updating below arguments:

  • image: the docker image used to launch the node, for Clover Testnet, use cloverio/clover-iris:0.1.15. For a full list of clover networks please check out the Clover Network List page.

  • --name: The node name of your validator, the name could be found in the telemetry node list

  • --pruning: we're using the archive mode for the pruning argument, which means it will keep all the historical block data. You can provide numeric parameters for it, to let it just keep the provided number of blocks data.

  • --ws-extenral/--rpc-external: it enable the outer access for the RPC service.

β€‹πŸš€ Bring up the RPC node

Use below command to bring up the validator node:

cd /opt/compose # goto the compose file directory
docker-compose up # bring up the rpc node in the foreground
## check whether the node starts up normally
## Ctrl-C stop the node
docker-compose up -d # start the rpc node in the daemon mode.

You need to check the node logs using docker-compose logs command. Wait until the node is synced and the block numbers syncs with the latest number on the chain.

β€‹πŸ“‘ Post Setup

You may want to setup a reverse proxy server or load balancer for the RPC service. There're some known tools for you to start with, please checkout:

  • ​Nginx - High Performance Load Balancer, Web Server, & Reverse Proxy

  • ​Caddy - Powerful, enterprise-ready, open source web server with automatic HTTPS written in Go