- {children}
-
- Your content here...
- -💡 Tip
-Your tip here
-- starknode-kit supports multiple client implementations for both Ethereum - and Starknet networks. -
- -- Running diverse client implementations is crucial for network health and - resilience. Client diversity prevents single points of failure and - reduces the impact of bugs in any one implementation. -
- -- To run an Ethereum node, you need both an{" "} - execution client and a consensus client - . They work together to validate and process Ethereum blocks post-merge. -
- -Handle transaction execution and state management
-Handle proof-of-stake consensus mechanism
-- Starknet clients allow you to run a Starknet full node, enabling interaction with the Starknet Layer 2 network. -
- -Full node implementations for Starknet
-Popular client combinations for Ethereum nodes:
- -| Execution | -Consensus | -Characteristics | -
|---|---|---|
| Geth | -Lighthouse | -Most popular, well-tested | -
| Reth | -Lighthouse | -High performance, modern | -
| Geth | -Prysm | -Stable, feature-rich | -
| Reth | -Prysm | -Performance-focused | -
| Client | -RAM | -Disk | -CPU | -
|---|---|---|---|
| Geth | -16+ GB | -~1.2 TB | -4+ cores | -
| Reth | -16+ GB | -~900 GB | -4+ cores | -
| Lighthouse | -8+ GB | -~200 GB | -2+ cores | -
| Prysm | -8+ GB | -~250 GB | -2+ cores | -
| Juno | -8+ GB | -~300 GB | -2+ cores | -
💡 Recommendation
-- For most users, we recommend Reth + Lighthouse for Ethereum (best performance) - and Juno for Starknet. -
-- Client diversity is critical for network health. If a single client has a bug and it's used by the majority of nodes, - it could cause network issues or even finality problems. -
- -Current client distribution matters! Consider using minority clients to help decentralize the network.
- -You can switch clients at any time:
- -starknode-kit stopstarknode-kit remove --execution_client gethstarknode-kit add --execution_client rethstarknode-kit start⚠️ Note
-- Switching clients may require re-syncing from scratch, which can take several days. - Plan accordingly and ensure you have sufficient disk space. -
-- Ready to dive deeper? Check out our validator guide: -
-- Complete reference for all starknode-kit commands. Each command helps - you manage different aspects of your Ethereum and Starknet nodes. -
- -| Command | -Description | -
|---|---|
| add | -Add an Ethereum or Starknet client to the config | -
| completion | -Generate the autocompletion script for the specified shell | -
| config | -Create, show, and update your Starknet node configuration | -
| monitor | -Launch real-time monitoring dashboard | -
| remove | -Remove a specified resource | -
| run | -Run a specific local infrastructure service | -
| start | -Run the configured Ethereum clients | -
| status | -Display status of running clients | -
| stop | -Stop the configured Ethereum clients | -
| update | -Check for and install client updates | -
| validator | -Manage the Starknet validator client | -
| version | -Show version of starknode-kit or a specific client | -
- For any command, you can use the --help flag to get
- detailed usage information:
-
- Generate autocompletion scripts for your shell: -
- -- Ready to dive deeper? Check out our comprehensive guides: -
-- Learn how to configure starknode-kit for your Ethereum and Starknet - nodes. -
- -- starknode-kit stores its configuration in a YAML file located at: -
- -- Generate a new configuration file with default settings: -
- -View your entire configuration:
- -View specific sections:
- -- The configuration file has the following structure: -
- -- Switch between mainnet, sepolia, or custom networks: -
- -Set execution client and ports:
- -Set consensus client and checkpoint:
- -Configure your Juno Starknet client:
- -starknode-kit supports multiple networks:
- -⚠️ Important
-- Changing the network will affect all clients. Make sure to stop your - nodes before changing networks. -
-Default ports for each client:
- -| Client | -Ports | -Purpose | -
|---|---|---|
| Geth | -8545, 8546, 30303 | -HTTP RPC, WS RPC, P2P | -
| Reth | -8545, 8546, 30303 | -HTTP RPC, WS RPC, P2P | -
| Lighthouse | -5052, 9000 | -HTTP API, P2P | -
| Prysm | -4000, 13000 | -HTTP API, P2P | -
| Juno | -6060 | -RPC | -
- For validator nodes, additional configuration is required. See the - Validator Setup page for details. -
- -- Some sensitive data can be stored as environment variables: -
- -STARKNET_WALLET - Wallet address
- STARKNET_PRIVATE_KEY - Private key
- STARKNET_PUBLIC_KEY - Public key
- STARKNET_CLASS_HASH - Class hash
- STARKNET_SALT - Salt value
- - If your configuration isn't loading, check: -
- -~/.starknode-kit/starknode.yml
- If you get port conflicts:
- -lsof -i :[port]
- - Ready to dive deeper? Check out our comprehensive guides: -
-- We welcome contributions to starknode-kit! This guide will help you get - started with contributing to the project. -
- -There are many ways to contribute to starknode-kit:
- -Start by forking the repository on GitHub:
- -Make sure you have the required tools:
- -Create a branch for your changes:
- -gofmt and follow Go best practicesRun tests before submitting:
- -Format your code with gofmt:
Write clear, descriptive commit messages:
- -To increase the chances of your PR being accepted:
- -When reporting bugs, include:
- -When suggesting features, include:
- -We are committed to providing a welcoming and inclusive environment. Please:
- -If you need help with contributing:
- -🎉 Thank You!
-- Thank you for considering contributing to starknode-kit! Your contributions help make this tool better for everyone. -
-- Welcome to starknode-kit! This guide will help you get up and running - with your Ethereum and Starknet nodes in just a few minutes. -
- -Before you begin, make sure you have:
- -📝 Note
-- For detailed hardware requirements, check out our{" "} - - Requirements page - - . -
-- The quickest way to install starknode-kit is using the installation - script: -
- -This script will:
-/usr/local/bin/
- - After installation, generate your initial configuration file: -
- -
- This creates a configuration file at{" "}
- ~/.starknode-kit/starknode.yml with default settings.
-
- To run an Ethereum node, you need both an execution client and a - consensus client: -
- -Or with Reth and Prysm:
- -To add a Starknet client (Juno):
- -- By default, starknode-kit is configured for mainnet. To change to a - test network: -
- -- To start your configured Ethereum execution and consensus clients: -
- -⚠️ Important
-
- The start command only launches Ethereum clients
- (execution + consensus). It does not start Starknet clients.
-
To run a specific client:
- -- Launch the real-time monitoring dashboard to see the status of your - nodes: -
- -The monitoring dashboard provides real-time insights:
- -Real-time synchronization progress and health
-Latest block number and sync progress
-Peer connections and network performance
-CPU, RAM, and disk usage metrics
-- For a quick status check of all running clients: -
- -- Ready to dive deeper? Check out our installation guide: -
-- There are multiple ways to install starknode-kit. Choose the method that - best suits your needs. -
- -- The easiest and recommended way to install starknode-kit: -
- -- Or download the script first and then run it: -
- -- If you have Go installed (version 1.24 or later), you can install - starknode-kit directly: -
- -
- This installs the latest version from the main branch.
-
- After installation, verify that starknode-kit is working correctly: -
- -You should see output similar to:
- -- After successful installation, generate your configuration file: -
- -
- This creates a configuration file at{" "}
- ~/.starknode-kit/starknode.yml.
-
- To uninstall starknode-kit, remove the binary and configuration - directory: -
- -⚠️ Note
-
- This will not remove any client data (e.g., blockchain data). The data
- is stored in the locations specified in your{" "}
- ~/.starknode-kit/starknode.yml file.
-
- If you get a "command not found" error, make sure{" "}
- /usr/local/bin is in your PATH:
-
- Add this to your ~/.bashrc or ~/.zshrc to make
- it permanent.
-
- If you encounter permission issues during installation, make sure you - have sudo access or contact your system administrator. -
- -- Ready to dive deeper? Check out our configuration guide: -
-- A powerful command-line tool to help developers and node operators - easily set up, manage, and maintain Ethereum and Starknet nodes. -
- -- Learn how to install and configure starknode-kit for your node - setup. -
- - - -- Explore all available commands and their usage. -
- - - -- Configure your Ethereum and Starknet clients. -
- - - -- Set up and manage your Starknet validator node. -
- -Install starknode-kit with a single command:
- -Generate your configuration file:
- -Add your first client pair:
- -- Ready to dive deeper? Check out our comprehensive guides: -
-- Hardware and software requirements for running Ethereum and Starknet - nodes with starknode-kit. -
- -📚 Reference
-- For a detailed breakdown of node hardware requirements, see the Rocket Pool Hardware Guide. -
-| Component | -Requirement | -Notes | -
|---|---|---|
| CPU | -4+ cores | -Intel i3/i5 or AMD equivalent. Avoid Celeron. | -
| RAM | -32 GB | -Minimum 16GB, 32GB recommended for comfort | -
| Storage | -2+ TB NVMe SSD | -Must have DRAM cache, no QLC NAND | -
| Network | -100+ Mbps | -Stable connection, unlimited data preferred | -
| Power | -24/7 uptime | -UPS recommended for validators | -
Storage is the most critical component for node operation.
- -| Client | -Current Size | -Growth Rate | -
|---|---|---|
| Ethereum (Geth) | -~1.2 TB | -~150 GB/year | -
| Ethereum (Reth) | -~900 GB | -~120 GB/year | -
| Lighthouse | -~200 GB | -~50 GB/year | -
| Prysm | -~250 GB | -~60 GB/year | -
| Juno (Starknet) | -~300 GB | -~100 GB/year | -
Your SSD must have:
- -⚠️ Warning
-- Using a QLC SSD or SSD without DRAM cache will result in poor performance and potential node failures. - See the tested SSD list for recommendations. -
-Supported operating systems:
- -Linux is highly recommended for production use.
- -Version 1.24 or later required:
- -Install from: https://go.dev/dl/
- -Recommended for building Juno and other Starknet clients:
- -Required for building certain clients:
- -Ensure these ports are accessible:
- -| Port | -Protocol | -Purpose | -
|---|---|---|
| 30303 | -TCP/UDP | -Ethereum execution P2P | -
| 9000 | -TCP/UDP | -Lighthouse consensus P2P | -
| 13000 | -TCP | -Prysm consensus P2P | -
| 6060 | -TCP | -Juno RPC (localhost only) | -
Additional requirements for running a validator:
- -If running in the cloud, recommended specifications:
- -| Provider | -Instance Type | -Est. Cost/Month | -
|---|---|---|
| AWS | -m5.2xlarge + 4TB gp3 | -~$500-700 | -
| Google Cloud | -n2-standard-8 + 4TB SSD | -~$600-800 | -
| Azure | -Standard_D8s_v3 + 4TB Premium SSD | -~$550-750 | -
💡 Cost Consideration
-- Running on dedicated hardware is often more cost-effective long-term than cloud hosting, especially for validators. -
-- Set up and manage your Starknet validator node using starknode-kit. -
- -⚠️ Important
-- Running a validator requires significant responsibility. Make sure you - understand the requirements and risks before proceeding. -
-Before setting up a validator, ensure you have:
- -The validator client is managed through starknode-kit. First, ensure you have starknode-kit installed and configured.
- -Check the status of your validator:
- -Check the installed version of the validator client:
- -Configure the Juno RPC endpoint for your validator:
- -Or use a remote Juno node:
- -Validator configuration is stored in your starknode-kit config file. Key settings include:
- -Store sensitive validator data in environment variables:
- -Add these to your ~/.bashrc or ~/.zshrc to make them persistent.
Your Juno node must be fully synced and running:
- -Check your validator configuration:
- -Start your validator client:
- -Monitor your validator status:
- -Configure your validator's commission rate:
- -This sets a 10% commission on staking rewards. Validators typically charge 5-15% commission.
- -Check that:
-starknode-kit statusVerify environment variables are set:
- -If empty, add to your shell profile and reload.
- -If your validator goes offline:
-Monitor these key metrics:
- -Understand the economics:
- -💡 Tip
-- Start on the testnet (Sepolia) to familiarize yourself with validator operations before running on mainnet. -
-- Ready to dive deeper? Check out our comprehensive guides: -
---{code}
-