> ## Documentation Index
> Fetch the complete documentation index at: https://tfh-docs-audit-world-chain-content-fixes.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# How to Set Up a World Chain Node

Follow this guide to set up your own World Chain node.

<Note>
  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](https://t.me/world_chain_updates)
</Note>

## 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](https://github.com/worldcoin-foundation/simple-worldchain-node). If you're interested in building a node from source, see the [documentation from Optimism](https://docs.optimism.io/operators/node-operators/tutorials/node-from-source).

## 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](https://github.com/paradigmxyz/reth)).

### Installation

First, download [`simple-worldchain-node`](https://github.com/worldcoin-foundation/simple-worldchain-node) and create your `.env` file.

<CodeGroup>
  ```bash Download simple-worldchain-node theme={"system"}
  git clone https://github.com/worldcoin-foundation/simple-worldchain-node.git
  cd simple-worldchain-node
  cp .env.example .env
  ```
</CodeGroup>

Ensure you have installed Docker and Docker Compose by following [this guide](https://docs.docker.com/compose/install/#scenario-three-install-the-docker-compose-standalone).

### Configuration

Open your `.env` file in an editor of your choice. The following values must be configured before starting your node.

<ParamField body="NETWORK_NAME" type="worldchain-mainnet | worldchain-sepolia" required>
  Used to select which network the node connects to, either `worldchain-mainnet` or `worldchain-sepolia`.
</ParamField>

<ParamField body="NODE_TYPE" type="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).
</ParamField>

<ParamField body="L1_RPC_ENDPOINT" type="URL" required>
  An L1 (Ethereum) RPC endpoint. We recommend using [Alchemy](https://www.alchemy.com/) or [QuickNode](https://www.quicknode.com), but any Ethereum RPC provider or archive node will work.
</ParamField>

<ParamField body="L1_BEACON_RPC_ENDPOINT" type="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](https://www.quicknode.com/).
</ParamField>

<ParamField body="L1_RPC_TYPE" type="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.
</ParamField>

<ParamField body="FLASHBLOCKS_ENABLED" type="boolean">
  Enables Flashblocks support for faster block propagation. Defaults to `true`.
</ParamField>

<ParamField body="DOWNLOAD_SNAPSHOT" type="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).
</ParamField>

For details on additional settings, see the `simple-worldchain-node` [README](https://github.com/worldcoin-foundation/simple-worldchain-node?tab=readme-ov-file#optional-configurations).

### Running your node

To start your node in the background, run the following command from the `simple-worldchain-node` folder:

```bash theme={"system"}
docker compose up -d --build
```

To view logs for your node, run the following command:

```bash theme={"system"}
docker compose logs -f --tail 10
```

To shut down your node:

```bash theme={"system"}
docker compose down
```

### Monitoring your node

A Grafana dashboard is included to monitor your node. Access it by visiting [http://localhost:3000](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:

```bash theme={"system"}
git pull
docker compose pull
docker compose up -d --build
```
