Skip to content

getting-started.md

Latest commit

 

History

History
181 lines (126 loc) · 4.08 KB

getting-started.md

File metadata and controls

181 lines (126 loc) · 4.08 KB

Getting Started

Prerequisites

  • Rust toolchain (1.70+)
  • C compiler and linker (for native dependencies)
  • Git access for Reth dependencies

Linux (Ubuntu/Debian):

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

# Install build tools (gcc, make, linker)
apt update && apt install -y build-essential

macOS: Xcode Command Line Tools (xcode-select --install) provides the compiler.

Installation

Pre-built binaries

Download from the latest release:

# Download, extract, and make executable
tar xzf shinode-linux-x86_64.tar.gz
chmod +x shinode-linux-x86_64
./shinode-linux-x86_64

Install from source

cargo install --git https://github.com/vicnaum/shinode.git --path node

Clone and build

git clone https://github.com/vicnaum/shinode.git
cd shinode

# Development build
cargo build

# Production build (recommended)
cargo build --release

First Run

Start syncing from Uniswap V2 deployment (block 10,000,000):

cargo run --release

The node will:

  1. Show a DOS-style splash screen while connecting to Ethereum mainnet peers
  2. Display a fullscreen TUI dashboard with real-time sync progress
  3. Begin backfilling blocks from 10,000,000 to head
  4. Start the RPC server on 127.0.0.1:8545 once synced
  5. Switch to follow mode once caught up

Press q to quit gracefully. The node persists checkpoints and resumes on restart.

Headless / CI environments

If you don't want the fullscreen TUI (e.g., running in a script or pipe):

cargo run --release --manifest-path node/Cargo.toml -- --no-tui

This falls back to legacy indicatif progress bars on stderr.

Basic Usage

Custom start block

cargo run --release -- --start-block 15000000

The default start block is 10,000,000 (Uniswap V2 Factory deployment). Here are deployment blocks for popular protocols you might want to index from:

Protocol Contract Block Date (UTC)
Uniswap V2 Factory 10,000,835 2020-05-04
Aave V2 LendingPool 11,362,579 2020-12-03
Uniswap V3 Factory 12,369,621 2021-05-04
Aave V3 Pool 16,291,127 2022-12-29
Uniswap V4 PoolManager 21,688,329 2025-01-23

Sync a specific range

cargo run --release -- \
  --start-block 18000000 --end-block 18100000

Custom data directory

cargo run --release --manifest-path node/Cargo.toml -- \
  --data-dir /path/to/data

Custom RPC port

cargo run --release --manifest-path node/Cargo.toml -- \
  --rpc-bind 0.0.0.0:9545

Verify RPC

Once synced, test the RPC:

# Check chain ID
curl -s -X POST -H "Content-Type: application/json" \
  --data '{"jsonrpc":"2.0","id":1,"method":"eth_chainId","params":[]}' \
  http://127.0.0.1:8545

# Check synced block number
curl -s -X POST -H "Content-Type: application/json" \
  --data '{"jsonrpc":"2.0","id":1,"method":"eth_blockNumber","params":[]}' \
  http://127.0.0.1:8545

TUI Dashboard

The default UI is a fullscreen terminal dashboard showing:

  • Sync phase and progress
  • Blocks coverage map (braille visualization)
  • Speed chart with current/average/peak
  • Network, queue, storage, and DB panels
  • Real-time log viewer

Press q to quit. The dashboard requires a terminal with UTF-8 support.

Debugging

Increase verbosity

# Info level
cargo run --release --manifest-path node/Cargo.toml -- -v

# Debug level
cargo run --release --manifest-path node/Cargo.toml -- -vv

# Trace level
cargo run --release --manifest-path node/Cargo.toml -- -vvv

Debug dump via signal

Send SIGUSR1 to print sync + peer-health status:

kill -USR1 $(pgrep shinode)

Check storage stats

cargo run --release --manifest-path node/Cargo.toml -- \
  db stats --data-dir data

Next Steps