Run a testnet node

This guide demonstrates how to run an RPC node (non-validator node) on the Saigon testnet using Docker.

Prerequisites

Install Docker Engine and the Docker Compose plugin:

Steps

Set up directories:

mkdir -p ~/ronin/docker
cd ~/ronin

Create a directory for chain data:

mkdir -p chaindata/data/ronin

In the docker directory, create a docker-compose.yml file with the following configuration:

version: "3"
services:
  node:
    image: ${NODE_IMAGE}
    stop_grace_period: 5m
    stop_signal: SIGINT
    hostname: node
    container_name: node
    ports:
      - 127.0.0.1:8545:8545
      - 127.0.0.1:8546:8546
      - 30303:30303
      - 30303:30303/udp
      - 6060:6060
    volumes:
      - ~/ronin/chaindata:/ronin
    environment:
      - SYNC_MODE=full
      - PASSWORD=${PASSWORD}
      - NETWORK_ID=${NETWORK_ID}
      - RONIN_PARAMS=${RONIN_PARAMS}
      - VERBOSITY=${VERBOSITY}
      - MINE=${MINE}
      - GASPRICE=${GASPRICE}
      - GENESIS_PATH=${GENESIS_PATH}
      - ETHSTATS_ENDPOINT=${INSTANCE_NAME}:${CHAIN_STATS_WS_SECRET}@${CHAIN_STATS_WS_SERVER}:443

This compose file defines the node service that pulls a Ronin node image from the GitHub Container Registry.

In the docker directory, create an .env file and add the following content, replacing the <...> placeholder values with your information:

# The name of your node that you want displayed on https://ronin-stats.roninchain.com/
INSTANCE_NAME=<INSTANCE_NAME>

# The latest version of the node's image as listed in https://docs.roninchain.com/validators/setup/upgrade-validator
NODE_IMAGE=<NODE_IMAGE>

# The password used to encrypt the node's private key file
PASSWORD=<PASSWORD>

MINE=false

NETWORK_ID=2021
GASPRICE=20000000000
VERBOSITY=3

CHAIN_STATS_WS_SECRET=xQj2MZPaN72
CHAIN_STATS_WS_SERVER=ronin-stats-ws.roninchain.com

CONFIG_PATH=config.testnet.json
GENESIS_PATH=testnet.json
DEPLOYMENT=test

RONIN_PARAMS=--http.api eth,net,web3 --txpool.pricelimit 20000000000 --txpool.nolocals --discovery.dns enrtree://AJCNIAXQIPO55NW3QE2NUBBDMPYZDOQUCAEUS65NHQFMUUFES5KOW@saigon.nodes.roninchain.com

(Optional) Download the snapshot from the ronin-snapshot repo:

cd ~/ronin/chaindata/data/ronin/
wget -q -O - <snapshot URL from the README file in the repo> | tar -I zstd -xvf -

Start the node:
```
cd ~/ronin/docker && docker-compose up -d
```
This command pulls a Ronin node image and starts the service you defined.
Review the log:
```
docker logs node -f --tail 100
```
After a few minutes, check the status of your node on the Ronin Analytics page, the Testnet section. If it's green, the node is connected and up to date with the network.

Enabling Path-Based State Storage (PBSS)

To enable the experimental Path-Based State Storage mode, make these changes:

Remove existing chaindata

rm -rf ~/ronin/chaindata/data/ronin/*`

Important: You must remove all existing chaindata before using PBSS mode as it's not compatible with the traditional storage format.

Update the .env File Add --state.scheme path to your RONIN_PARAMS:

RONIN_PARAMS=--http.api eth,net,web3,consortium --miner.gaslimit 30000000 --miner.gasreserve 10000000 --cache 4096 --discovery.dns enrtree://AIGOFYDZH6BGVVALVJLRPHSOYJ434MPFVVQFXJDXHW5ZYORPTGKUI@nodes.roninchain.com --state.scheme path

Update the docker-compose.yml File Add the STATE_SCHEME environment variable:

environment:
  # Other environment variables...
  - STATE_SCHEME=path

Start/Restart the node for applying the change:

cd ~/ronin/docker && docker-compose up -d

Note: PBSS mode is experimental and requires a full sync from genesis as snapshots are not yet supported for this mode.

Prerequisites​

Steps​

Enabling Path-Based State Storage (PBSS)​

Prerequisites

Steps

Enabling Path-Based State Storage (PBSS)