node README

The project's README from github.com/base/node. As one markdown file: README.md.

[!CAUTION]

This repository is archived

Use releases from base/base for all new installations and upgrades. Development and releases have moved to base/base; this repository is no longer maintained.

Base

Base Node

Base is a secure, low-cost, developer-friendly Ethereum L2 built on Optimism's OP Stack. This repository contains a Docker build for running a Base node with base-reth-node and base-consensus.

Website base.org Docs Discord Twitter Base Farcaster Base

Quick Start

  1. Ensure you have an Ethereum L1 full node RPC and beacon endpoint available.

  2. Choose your network:

    • For mainnet: use .env.mainnet
    • For testnet: use .env.sepolia
  3. Configure your L1 endpoints in the appropriate .env file:

    BASE_NODE_L1_ETH_RPC=<your-preferred-l1-rpc>
    BASE_NODE_L1_BEACON=<your-preferred-l1-beacon>
    
  4. Start the node:

    # For mainnet (default):
    docker compose up --build
    
    # For testnet:
    NETWORK_ENV=.env.sepolia docker compose up --build
    

Supported Clients

Requirements

Minimum Requirements

Production Hardware Specifications

The following are the hardware specifications we use in production:

Configuration

Required Settings

Network Settings

Optional Features

For full configuration options, see .env.mainnet or .env.sepolia.

Testing Flashblocks RPC Methods

When running in Flashblocks mode, you can query a pending block using the Flashblocks RPC:

curl -X POST \
  --data '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["pending", false],"id":1}' \
  http://localhost:8545

Snapshots

Snapshots are available to help you sync your node more quickly. See docs.base.org for links and more details on how to restore from a snapshot.

Supported Networks

Network Status
Mainnet ✅
Testnet ✅

Troubleshooting

For support please join our Discord and post in 🛠|node-operators. You can alternatively open a new GitHub issue.

Disclaimer

THE NODE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. We make no guarantees about asset protection or security. Usage is subject to applicable laws and regulations.

For more information, visit docs.base.org.

node (base/node)

Searching Database…

68.3K ·GitHub
archived
What is this?A Docker build for running a Base node. Base is a secure, low-cost, developer-friendly Ethereum L2 built on Optimism's OP Stack, with base-reth-node as the execution client and base-consensus as the consensus client.
What does getting a node running involve?Have an Ethereum L1 full node RPC and beacon endpoint ready, pick .env.mainnet or .env.sepolia for your network, set the L1 endpoints in that file, and start the node.
What kind of machine do I need for this?At minimum a modern multicore CPU, 32GB of RAM (64GB recommended), an NVMe SSD, and Docker with Docker Compose installed on the host.
Is this repo still where I should get the node software?No — development and releases moved to base/base. This repository is archived and no longer maintained, so use base/base releases for new installations and upgrades.
Does it have to run on a Linux server?It is a Docker build, so it runs anywhere Docker and Docker Compose do; the production reference hardware is AWS instances with local NVMe drives.
Any catch in the license or liability?GitHub lists MIT, but the node software ships with a strong disclaimer: it is provided as is, with no guarantees about asset protection or security.
Is there a faster way to sync than from genesis?Yes — snapshots are available to help you sync the node more quickly; docs.base.org has the links and instructions for restoring from one.
How much disk space should I plan for?Enough for two copies of the current chain size plus the snapshot size plus a 20% buffer for growth; the production archive node reference uses RAID 0 across all local NVMe drives on an AWS i7i.12xlarge.
What does the Flashblocks option do?Setting RETHFBWEBSOCKETURL switches the execution client into Flashblocks mode, which adds a Flashblocks RPC for querying pending blocks; without it the node runs in vanilla mode.
Creator
base
Size
3 MB
Stars
68.3K
Age
3y
Commits · 90 Days