Run a node in the Superchain

How to run a node in the Superchain

This guide provides an overview of how to run an OP Stack rollup node in the Superchain. It walks you through how to build, configure, run, and monitor your node on one of the OP Chains in the Superchain. To skip ahead to building and running a node, you can explore the node operator tutorials.

Build your node

Before building your node, you will learn fundamental aspects of OP Stack rollup nodes.

Learn Fundamentals of OP Stack Nodes

These are the two fundamental components of an OP Stack rollup node:

  • Node Architecture: OP Stack rollup nodes use the rollup node and execution client and can also support legacy geth for pre-bedrock historical execution requests. For more details, see the Node Architecture guide.
  • Network Upgrades: Network upgrades for OP Stack rollup nodes are generally activated by timestamps. Failing to upgrade your node before the timestamp causes a chain divergence, requiring you to resync your node to reconcile the chain. Follow the established Node Upgrade Process to avoid chain divergence.

If you are building an archive node on OP Mainnet, then you'll need a node snapshot. This is not required for nodes using snap sync.

Build Your OP Stack Node

Now, you are ready to build your OP Stack rollup node. You have two options for this:

  • Option 1: Follow the Running a Node with Docker tutorial, which gets your OP Stack rollup node up and running without having to build it from source.
  • Option 2: Follow the Building a Node from Source tutorial, if you need to use a specific architecture or want to inspect the source code of your OP Stack rollup node.

Configure your node

OP Stack rollup nodes can be configured for individual needs. The following steps will get you started with a working base configuration for OP Stack rollup nodes, along with recommended flags.

Setup Your Working Base Configs

Enable Snap Sync

  • Enable snap sync for your node to significantly improve the experience and speed of syncing an OP Stack node. This is an optional feature but highly recommended for node providers.

Additional configuration options exist for op-geth and op-node, respectively.

Run your node

Now, you will run your node and set your node debugging log level for more granular feedback.

Run Your Node From Source

You will now run your node from source for your Superchain network. Here are your options.

⚠️

The tutorial Building a Node from Source is a pre-requisite to running your node from source and must be completed first.

Update Node Log Level

As part of running your rollup node, you may want to adjust the log level for more or less granular feedback when debugging.

Monitor your node

It is important to regularly monitor your node, and you can optionally configure prometheus and grafana dashboard to make this process easier for you.

Enable the Metrics Port

  • Enable the metrics port for your node by passing the --metrics.enabled flag to op-node.
  • Optionally, you can customize the metrics port and address via the --metrics.port and --metrics.addr flags, respectively.

Setup Prometheus & Grafana

⚠️

The following steps are intended for go-ethereum, so it must be tweaked to work for rollup nodes running within the Superchain.

Follow node updates

  • It's important to keep your node software up to date. Software updates can also include important bug fixes and patches that can help keep your node stable.
  • Refer to the Software Releases page for a detailed look at the latest releases of various rollup node and execution client implementations.
  • Notifications are also posted to the Optimism Upgrade Announcement Channels on Discord (opens in a new tab) and Telegram (opens in a new tab).

Node operator tutorials

💡

Got an idea for a new tutorial? We'd love to hear it. Head over to GitHub to suggest a new tutorial (opens in a new tab).

Tutorial NameDescriptionDifficulty Level
Running a Node With DockerLearn how to run a node with Docker.🟢 Easy
Building a Node From SourceLearn how to compile node components from source code.🟢 Easy
Running an OP Mainnet Node from SourceLearn how to run an OP Mainnet node from source code.🟡 Medium
Running an OP Sepolia Node from SourceLearn how to run an OP Sepolia node from source code.🟡 Medium

Next steps