Getting Started

Welcome to starknode-kit! This guide will help you get up and running with your Ethereum and Starknet nodes in just a few minutes.

Prerequisites

Before you begin, make sure you have:

• Operating System: Linux or macOS (Windows via WSL)
• Go: Version 1.24 or later (if building from source)
• Storage: At least 2TB of free SSD space
• RAM: Minimum 32GB recommended
• Network: Stable internet connection

Installation

The quickest way to install starknode-kit is using the installation script:

/bin/bash -c "$(curl -sSL https://raw.githubusercontent.com/thebuidl-grid/starknode-kit/main/install.sh)"

This script will:

• Download the latest version of starknode-kit
• Install it to /usr/local/bin/
• Create necessary configuration directories

Initial Configuration

After installation, generate your initial configuration file:

starknode-kit config new

This creates a configuration file at ~/.starknode-kit/starknode.yml with default settings.

Add Your First Clients

Ethereum Clients (Execution + Consensus)

To run an Ethereum node, you need both an execution client and a consensus client:

starknode-kit add --consensus_client lighthouse --execution_client geth

Or with Reth and Prysm:

starknode-kit add --consensus_client prysm --execution_client reth

Starknet Client

To add a Starknet client (Juno):

starknode-kit add --starknet_client juno

Configure Network

By default, starknode-kit is configured for mainnet. To change to a test network:

starknode-kit config set network sepolia

Start Your Nodes

Start Ethereum Clients

To start your configured Ethereum execution and consensus clients:

starknode-kit start

Run Individual Clients

To run a specific client:

# Run Juno (Starknet)
starknode-kit run juno

# Run Geth (Ethereum execution)
starknode-kit run geth

# Run Lighthouse (Ethereum consensus)
starknode-kit run lighthouse

Monitor Your Nodes

Launch the real-time monitoring dashboard to see the status of your nodes:

starknode-kit monitor

The monitoring dashboard provides real-time insights:

Check Status

For a quick status check of all running clients:

starknode-kit status