• Stars
    star
    66,414
  • Rank 111 (Top 0.01 %)
  • Language
    Shell
  • License
    MIT License
  • Created over 1 year ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Everything required to run your own Base node

Base

Base node

Base is a secure, low-cost, developer-friendly Ethereum L2 built to bring the next billion users onchain. It's built on Optimismโ€™s open-source OP Stack.

This repository contains the relevant Docker builds to run your own node on the Base network.

GitHub contributors GitHub commit activity GitHub Stars GitHub repo size GitHub

Website base.org Blog Docs Twitter BuildOnBase

GitHub pull requests by-label GitHub Issues

Hardware requirements

We recommend you have this configuration to run a node:

  • at least 16 GB RAM
  • an SSD drive with at least 100 GB free

Troubleshooting

If you encounter problems with your node, please open a GitHub issue or reach out on our Discord:

  • Once you've joined, in the Discord app go to server menu > Linked Roles > connect GitHub and connect your GitHub account so you can gain access to our developer channels
  • Report your issue in #๐Ÿ›Ÿ|node-support

Supported networks

Ethereum Network Status
Goerli testnet โœ…
Mainnet ๐Ÿšง

Usage

  1. Ensure you have an Ethereum L1 full node RPC available (not Base), and set OP_NODE_L1_ETH_RPC (in the .env.* file if using docker-compose). If running your own L1 node, it needs to be synced before Base will be able to fully sync.
  2. Run:
docker compose up --build
  1. You should now be able to curl your Base node:
curl -d '{"id":0,"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["latest",false]}' \
  -H "Content-Type: application/json" http://localhost:8545

Note: Some L1 nodes (e.g. Erigon) do not support fetching storage proofs. You can work around this by specifying --l1.trustrpc when starting op-node (add it in op-node-entrypoint and rebuild the docker image with docker compose build.) Do not do this unless you fully trust the L1 node provider.

You can map a local data directory for op-geth by adding a volume mapping to the docker-compose.yaml:

services:
  geth: # this is Optimism's geth client
    ...
    volumes:
      - $HOME/data/base:/data

Syncing

Sync speed depends on your L1 node, as the majority of the chain is derived from data submitted to the L1. You can check your syncing status using the optimism_syncStatus RPC on the op-node container. Example:

command -v jq  &> /dev/null || { echo "jq is not installed" 1>&2 ; }
echo Latest synced block behind by: \
$((($( date +%s )-\
$( curl -s -d '{"id":0,"jsonrpc":"2.0","method":"optimism_syncStatus"}' -H "Content-Type: application/json" http://localhost:7545 |
   jq -r .result.unsafe_l2.timestamp))/60)) minutes