Skip to main content
Follow this guide to set up your own 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

​
Overview

World Chain mainnet and testnet run on the OP Stack as part of the Superchain. We provide a simple Docker Compose configuration for running World Chain nodes, simple-worldchain-node. If you’re interested in building a node from source, see the documentation from Optimism.

​
Using simple-worldchain-node

simple-worldchain-node supports World Chain Mainnet and Sepolia, and archive, full, and minimal node types, running the world-chain client (a customized extension of op-reth).

​
Installation

First, download simple-worldchain-node and create your .env file.
Ensure you have installed Docker and Docker Compose by following this guide.

​
Configuration

Open your .env file in an editor of your choice. The following values must be configured before starting your node.
​
worldchain-mainnet | worldchain-sepolia
required
Used to select which network the node connects to, either worldchain-mainnet or worldchain-sepolia.
​
archive | full | minimal
required
Determines which type of node to run: archive (more storage, all history), full (less storage, only recent history), or minimal (smallest storage footprint).
​
URL
required
An L1 (Ethereum) RPC endpoint. We recommend using Alchemy or QuickNode, but any Ethereum RPC provider or archive node will work.
​
URL
required
An L1 Beacon Archive RPC endpoint. Note that this is not the same as a standard RPC endpoint, as this is used to retrieve Blobs from the Ethereum Beacon Chain. We recommend using QuickNode.
​
string
required
Selects which RPC provider is set in L1_RPC_ENDPOINT. This allows for more efficient syncing given different RPC capabilities. Choose from alchemy, quicknode, erigon, or basic for other RPC providers.
​
boolean
Enables Flashblocks support for faster block propagation. Defaults to true.
​
boolean
Downloads a snapshot to speed up initial sync when the data directory is empty. Defaults to true; set to false to sync from genesis instead (not recommended).
For details on additional settings, see the simple-worldchain-node README.

​
Running your node

To start your node in the background, run the following command from the simple-worldchain-node folder:
To view logs for your node, run the following command:
To shut down your node:

​
Monitoring your node

A Grafana dashboard is included to monitor your node. Access it by visiting http://localhost:3000 — anonymous access is enabled by default, so no login is required.

​
Upgrading your Node

When new versions of world-chain or op-node are released, we will update the simple-worldchain-node repository to use these new versions. You can then update your node to use these versions with the following commands: