Skip to content
Get packs

Ink Node

Docker Compose setup for running an Ink blockchain node, with healthcheck and monitoring included.inkonchain/node

GitHub Download v2.0.0
Stars
36.4k
Forks
649
Licence
MIT
Language
Shell
Last update
21 days ago
Type
Dev tool

What it is

This repository contains a Docker Compose configuration for running a node on the Ink network, an Optimism-based blockchain. It starts an execution client (op-reth), a rollup node (op-node), a healthcheck service, and Prometheus and Grafana dashboards. It is forked from another project and supports Ink Sepolia (testnet) and Ink Mainnet.

  • Run a full Ink Sepolia node restored from a snapshot
  • Check node sync progress with the provided curl commands and healthcheck metrics
  • View node metrics in the preloaded Grafana dashboard
  • Run an archive node that keeps full history, if you have the disk space

Great for

  • Operators who want to run their own Ink Sepolia testnet node for testing
  • Developers who need a local Ink node for RPC access and experiments
  • Teams comfortable with Docker and L1 RPC endpoints who want to run Ink Mainnet infrastructure

Not ideal for

  • People with no Docker experience, since setup requires Docker Compose, env editing and terminal commands
  • Anyone with only a free public Ethereum RPC endpoint, because the README says those are not enough for the L1 connection
  • Users with limited hardware or disk, since mainnet recommends 16GB+ RAM and a 2 TB SSD
Step-by-step guide: how to use Ink NodeInstall, first run, examples, tips and FAQs

How to get it

  1. 1

    Run with Docker

    You'll need: Docker Engine and Docker Compose v2 on Linux, or Docker Desktop on macOS and Windows · Working L1 execution RPC and L1 beacon API endpoints for the matching Ethereum network · Enough free disk space for the chosen node type

    Clone the repository

    git clone https://github.com/inkonchain/node

    Copy the env template

    cp .env.example .env

    Start the stack

    docker compose up -d --build
  2. 2

    Run it

    • Edit .env with NETWORK_NAME, NODE_TYPE, your L1 RPC and beacon endpoints, and the healthcheck reference RPC
    • Start the stack with docker compose up -d --build and wait for the snapshot restore to finish
    • Check service status with docker compose ps and logs with docker compose logs --tail 50 bedrock-init op-reth op-node
    • Run the optimism_syncStatus curl command to confirm the rollup node is moving forward
    • Open Grafana at http://localhost:3000 to view the Simple Node Dashboard
  3. 3

    Get the most out of it

    • Use the optimism_syncStatus and healthcheck metrics commands to track catch-up after a snapshot restore
    • Set NODE_TYPE=archive if you need full historical state, after confirming disk space
    • Use the progress.sh script with Foundry's cast installed on the host to estimate remaining sync time
    • Review the Grafana dashboard, which reads op-reth metrics from Prometheus

Downloads

Source code (.zip)main branch · straight from GitHubRelease v2.0.0Release notes and sourceOfficial website & docsdocs.inkonchain.com

Strengths

  • Packages the execution client, rollup node, healthcheck and monitoring into one Compose setup
  • Documents startup signals, smoke tests and a clear migration path from the older op-geth stack
  • MIT licensed and readily reproducible with the included commands

Trade-offs

  • Requires significant hardware and a long initial snapshot download, which the README says is hundreds of GB
  • Depends on high-rate-limit L1 RPC and beacon endpoints that you must supply yourself
  • The README is truncated, so some details may be missing from this summary

Stats synced from GitHub. The assessment above was drafted with AI from the project's README on 2026-10-29 and may miss recent changes — check the README before relying on a command. MIT licence: free to use, modify and distribute, including commercially, as long as you keep the copyright notice.