Simple World Chain Node

Anyone running a World Chain node is encouraged to join this Telegram channel for notifications of required software updates or other relevant information: World Chain Node Updates Telegram Channel

A simple docker compose script for launching full / archive node for World Chain.

Forked from simple-optimism-node.

Recommended Hardware

World Chain Mainnet

• 16GB+ RAM
• >16TB SSD (NVME Required)
• 100mb/s+ Download

World Chain Sepolia

• 16GB+ RAM
• >1TB SSD (NVME Highly Recommended)
• 100mb/s+ Download

Installation and Configuration

Tested on Ubuntu 24.04.

Install docker and docker compose

Note: If you're not logged in as root, you'll need to log out and log in again after installation to complete the docker installation.

Note: This command install docker and docker compose for Ubuntu. For windows and mac desktop or laptop, please use Docker Desktop. For other OS, please find instruction in Google.

### Update and upgrade packages
sudo apt-get update
sudo apt-get upgrade -y

### Docker and docker compose prerequisites
sudo apt-get install -y curl
sudo apt-get install -y gnupg
sudo apt-get install -y ca-certificates
sudo apt-get install -y lsb-release

### Download the docker gpg file to Ubuntu
sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg

### Add Docker and docker compose support to the Ubuntu's packages list
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

sudo apt-get update
 
### Install docker and docker compose on Ubuntu
sudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin

sudo usermod -aG docker $(whoami)
 
### Verify the Docker and docker compose install on Ubuntu
sudo docker run hello-world

(For non-root user) After logged out and logged back in, test if docker is working by running.

docker ps

It should returns an empty container list without having any error. Otherwise, restart your machine if there are errors.

Clone the Repository

git clone https://github.com/worldcoin-foundation/simple-worldchain-node.git
cd simple-worldchain-node

Copy .env.example to .env

Make a copy of .env.example named .env.

cp .env.example .env

Open .env with your editor of choice.

Mandatory configurations

• NETWORK_NAME - Choose which World Chain network you want to operate on:
  • worldchain-mainnet - World Chain Mainnet
  • worldchain-sepolia - World Chain Sepolia
• COMPOSE_PROFILES - Choose which Execution Client you want to run:
  • geth - op-geth, the default option.
  • reth - op-reth, an alternate Execution Client focused on speed. Only usable as an Archive node, but uses less storage than geth.
• GETH_NODE_TYPE - Choose the type of node you want to run (only applicable to geth):
  • full (Full node) - A Full node contains a few recent blocks without historical states.
  • archive (Archive node) - An Archive node stores the complete history of the blockchain, including historical states.
• L1_RPC_ENDPOINT - Specify the endpoint for the RPC of Layer 1 (e.g., Ethereum mainnet). For instance, you can use the free plan of Alchemy for the Ethereum mainnet.
• L1_BEACON_RPC_ENDPOINT - Specify the beacon endpoint of Layer 1. You can use QuickNode for the beacon endpoint. For example: https://xxx-xxx-xxx.quiknode.pro/db55a3908ba7e4e5756319ffd71ec270b09a7dce
• L1_RPC_TYPE - Specify the service provider for the RPC endpoint you've chosen in the previous step. The available options are:
  • alchemy - Alchemy
  • quicknode - Quicknode (ETH only)
  • erigon - Erigon
  • basic - Other providers

Optional configurations

• GETH_SYNCMODE - Specify sync mode for the execution client
  • Unspecified - Use default snap sync for full node and full sync for archive node
  • snap - Snap Sync (Default)
  • full - Full Sync (For archive node, not recommended for full node)
• GETH_STATE_SCHEME - Specify storage scheme for op-geth
  • path - Path-based Storage Scheme (Default)
    • PBSS is now supported for op-geth archive nodes as of v1.101602.0. The eth_getProof RPC method is not supported when using PBSS.
  • hash - Hash-based storage (For archive node, not recommended for full node)
    • Hash-based storage is only recommended when support for the eth_getProof RPC method is required.

GETH_STATE_SCHEME must be set upon first start of your node. Changing this value later will have no effect. Migration from hash- to path-based storage (or vice versa) is not possible, the node must be re-synced from scratch.

• PORT__[...] - Use custom port for specified components.

Operating the Node

Start

docker compose up -d

Will start the node in a detatched shell (-d), meaning the node will continue to run in the background.

View logs

docker compose logs -f --tail 10

To view logs of all containers.

docker compose logs <CONTAINER_NAME> -f --tail 10

To view logs for a specific container. Most commonly used <CONTAINER_NAME> are:

• op-geth (or op-reth)
• op-node

Stop

docker compose down

Will shut down the node without wiping any volumes. You can safely run this command and then restart the node again.

Restart

docker compose restart

Will restart the node safely with minimal downtime but without upgrading the node.

Upgrade

Pull the latest updates from GitHub, and Docker Hub and rebuild the container.

git pull
docker compose pull
docker compose up -d

Will upgrade your node with minimal downtime.

Wipe [DANGER]

docker compose down -v

Will shut down the node and WIPE ALL DATA. Proceed with caution!

Monitoring

Estimate remaining sync time

Run progress.sh to estimate remaining sync time and speed.

./progress.sh

This will show the sync speed in blocks per minute and the time until sync is completed.

Chain ID: 480
Please wait
Blocks per minute: ...
Hours until sync completed: ...

Grafana dashboard

Grafana is exposed at http://localhost:3000 and comes with two pre-loaded dashboards, one each for op-geth and op-reth. The OP-Geth Dashboard includes basic node information and will tell you if your node ever falls out of sync with the reference L2 node or if a state root fault is detected. The OP-Reth Dashboard includes in-depth information about the performance and sync state of op-reth.

The following links will take you directly to your dashboard of choice.

• OP-Geth Dashboard
• OP-Reth Dashboard

Use the following login details to access the dashboard:

• Username: admin
• Password: worldchain

Troubleshooting

Walking back L1Block with curr=0x0000...:0 next=0x0000...:0

If you experience "walking back L1Block with curr=0x0000...:0 next=0x0000...:0" for a long time after the Ecotone upgrade, consider these fixes:

1. Wait for a few minutes. This issue usually resolves itself after some time.
2. Restart docker compose: docker compose down and docker compose up -d --build
3. If it's still not working, try setting GETH_SYNCMODE=full in .env and restart docker compose