diff --git a/docs/.gitignore b/docs/.gitignore
deleted file mode 100644
index fd3dbb5..0000000
--- a/docs/.gitignore
+++ /dev/null
@@ -1,36 +0,0 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# dependencies
-/node_modules
-/.pnp
-.pnp.js
-.yarn/install-state.gz
-
-# testing
-/coverage
-
-# next.js
-/.next/
-/out/
-
-# production
-/build
-
-# misc
-.DS_Store
-*.pem
-
-# debug
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# local env files
-.env*.local
-
-# vercel
-.vercel
-
-# typescript
-*.tsbuildinfo
-next-env.d.ts
diff --git a/docs/DOCS_GUIDE.md b/docs/DOCS_GUIDE.md
deleted file mode 100644
index 160be49..0000000
--- a/docs/DOCS_GUIDE.md
+++ /dev/null
@@ -1,291 +0,0 @@
-# Starknode-kit Documentation Guide
-
-This guide explains how to run and develop the starknode-kit documentation site.
-
-## Quick Start
-
-### Installation
-
-```bash
-cd docs
-npm install
-```
-
-### Development Server
-
-Run the development server:
-
-```bash
-npm run dev
-```
-
-Open [http://localhost:3000](http://localhost:3000) in your browser to see the documentation.
-
-The page auto-updates as you edit files.
-
-### Production Build
-
-Build for production:
-
-```bash
-npm run build
-npm start
-```
-
-## Documentation Structure
-
-```
-docs/
-├── src/
-│ ├── app/ # Next.js pages (App Router)
-│ │ ├── page.tsx # Homepage
-│ │ ├── layout.tsx # Root layout with sidebar/header
-│ │ ├── globals.css # Global styles
-│ │ ├── getting-started/ # Getting started guide
-│ │ ├── installation/ # Installation guide
-│ │ ├── configuration/ # Configuration docs
-│ │ ├── commands/ # Command reference
-│ │ ├── clients/ # Client documentation
-│ │ ├── validator/ # Validator setup guide
-│ │ ├── requirements/ # Requirements page
-│ │ └── contributing/ # Contributing guide
-│ └── components/ # Reusable components
-│ ├── Sidebar.tsx # Navigation sidebar
-│ ├── Header.tsx # Top header with search
-│ └── CodeBlock.tsx # Code block component
-├── public/ # Static assets
-├── package.json # Dependencies
-└── README.md # Documentation README
-
-```
-
-## Features
-
-### GitBook-Style Layout
-
-- **Fixed Sidebar** - Navigation always visible on the left
-- **Header** - Search and links at the top
-- **Content Area** - Main documentation content
-- **Responsive** - Works on mobile and desktop
-
-### Components
-
-#### Sidebar (`components/Sidebar.tsx`)
-
-- Hierarchical navigation
-- Active page highlighting
-- Collapsible sections
-- Links to all documentation pages
-
-#### Header (`components/Header.tsx`)
-
-- Search bar (placeholder, can be enhanced)
-- GitHub link
-- Telegram link
-- Dark mode support
-
-#### CodeBlock (`components/CodeBlock.tsx`)
-
-- Syntax-highlighted code blocks
-- Copy-to-clipboard button
-- Language support
-- Dark theme optimized
-
-### Styling
-
-- **Tailwind CSS** - Utility-first CSS framework
-- **Dark Mode** - Automatic based on system preference
-- **Custom Scrollbars** - Styled for better UX
-- **Prose** - Typography optimized for documentation
-
-## Adding New Pages
-
-### 1. Create Page File
-
-Create a new `page.tsx` in the appropriate directory:
-
-```bash
-mkdir -p src/app/your-page
-```
-
-```tsx
-// src/app/your-page/page.tsx
-import CodeBlock from '@/components/CodeBlock';
-
-export default function YourPage() {
- return (
-
-
Your Page Title
-
Your content here...
-
-
-
- {/* Your content */}
-
-```
-
-### Add Info Boxes
-
-```tsx
-
-
💡 Tip
-
Your tip here
-
-
Supported Clients
-
-
- starknode-kit supports multiple client implementations for both Ethereum
- and Starknet networks.
-
-
-
Why Multiple Clients?
-
-
- 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.
-
-
-
Ethereum Clients
-
-
- 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.
-
-
-
-
-
Execution Clients
-
Handle transaction execution and state management
-
- • Geth (Go)
- • Reth (Rust)
-
-
-
-
-
Consensus Clients
-
Handle proof-of-stake consensus mechanism
-
- • Lighthouse (Rust)
- • Prysm (Go)
-
-
-
-
-
Starknet Clients
-
-
- Starknet clients allow you to run a Starknet full node, enabling interaction with the Starknet Layer 2 network.
-
-
-
-
-
Starknet Clients
-
Full node implementations for Starknet
-
- • Juno (Go) - Full node client
- • Starknet Validator - Validator client for staking
-
-
-
-
-
Client Combinations
-
-
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
-
-
-
-
-
-
Choosing Clients
-
-
Execution Clients
-
-
Geth
-
- ✅ Most widely used and tested
- ✅ Excellent documentation
- ✅ Large community support
- ✅ Stable and reliable
- ⚠️ Higher resource usage
- ⚠️ Larger disk footprint
-
-
-
Reth
-
- ✅ Excellent performance
- ✅ Lower disk usage
- ✅ Modern codebase (Rust)
- ✅ Fast sync times
- ⚠️ Newer, less battle-tested
- ⚠️ Smaller community
-
-
-
Consensus Clients
-
-
Lighthouse
-
- ✅ Fast and efficient
- ✅ Low resource usage
- ✅ Great documentation
- ✅ Active development
- ✅ Written in Rust
-
-
-
Prysm
-
- ✅ Feature-rich
- ✅ Good performance
- ✅ Strong community
- ✅ Comprehensive tooling
- ✅ Written in Go
-
-
-
Starknet Clients
-
-
Juno
-
- ✅ Official full node client
- ✅ Well-maintained
- ✅ Fast sync
- ✅ Active community
- ✅ Required for Starknet validator
-
-
-
Resource Requirements by Client
-
-
-
-
-
- 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
-
-
- 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.
-
-
Switching Clients
-
-
You can switch clients at any time:
-
-
- Stop your current clients: starknode-kit stop
- Remove old client: starknode-kit remove --execution_client geth
- Add new client: starknode-kit add --execution_client reth
- Start nodes: starknode-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.
-
-
-
-
-
📖 Next Steps
-
- Ready to dive deeper? Check out our validator guide:
-
-
-
-
-
-
Commands Reference
-
-
- Complete reference for all starknode-kit commands. Each command helps
- you manage different aspects of your Ethereum and Starknet nodes.
-
-
-
Command Overview
-
-
-
-
-
- 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
-
-
-
-
-
-
Quick Examples
-
-
Add Clients
-
-
-
Configure Network
-
-
-
- Start Ethereum Clients
-
-
-
-
Monitor Nodes
-
-
-
Check Status
-
-
-
- Run Individual Client
-
-
-
-
- Stop Ethereum Clients
-
-
-
-
Check Version
-
-
-
Getting Help
-
-
- For any command, you can use the --help flag to get
- detailed usage information:
-
-
-
-
-
Shell Completion
-
-
- Generate autocompletion scripts for your shell:
-
-
-
/etc/bash_completion.d/starknode-kit
-
-# Zsh
-starknode-kit completion zsh > "\${fpath[1]}/_starknode-kit"
-
-# Fish
-starknode-kit completion fish > ~/.config/fish/completions/starknode-kit.fish`}
- />
-
-
-
📖 Next Steps
-
- Ready to dive deeper? Check out our comprehensive guides:
-
-
-
-
-
Configuration
-
-
- Learn how to configure starknode-kit for your Ethereum and Starknet
- nodes.
-
-
-
Configuration File
-
-
- starknode-kit stores its configuration in a YAML file located at:
-
-
-
-
-
- Creating a Configuration
-
-
-
- Generate a new configuration file with default settings:
-
-
-
-
-
- Viewing Configuration
-
-
-
View your entire configuration:
-
-
-
-
View specific sections:
-
-
-
-
- Configuration Structure
-
-
-
- The configuration file has the following structure:
-
-
-
-
-
- Modifying Configuration
-
-
-
Change Network
-
-
- Switch between mainnet, sepolia, or custom networks:
-
-
-
-
-
- Configure Execution Client
-
-
-
Set execution client and ports:
-
-
-
-
- Configure Consensus Client
-
-
-
Set consensus client and checkpoint:
-
-
-
-
- Configure Juno (Starknet)
-
-
-
Configure your Juno Starknet client:
-
-
-
-
Network Settings
-
-
starknode-kit supports multiple networks:
-
-
-
- mainnet - Ethereum and Starknet mainnet
-
-
- sepolia - Ethereum Sepolia and Starknet Sepolia
- testnet
-
-
-
-
-
⚠️ Important
-
- Changing the network will affect all clients. Make sure to stop your
- nodes before changing networks.
-
-
-
-
- Port Configuration
-
-
-
Default Ports
-
-
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
-
-
-
-
-
-
- Validator Configuration
-
-
-
- For validator nodes, additional configuration is required. See the
- Validator Setup page for details.
-
-
-
- Environment Variables
-
-
-
- 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
-
-
-
-
- Configuration Best Practices
-
-
-
-
- Backup your config - Keep a backup of your
- configuration file
-
-
- Use environment variables - Store sensitive data in
- environment variables
-
-
- Document changes - Keep notes of any custom
- configurations
-
-
- Test on testnet - Always test configuration changes
- on a testnet first
-
-
-
-
Troubleshooting
-
-
- Configuration not loading
-
-
-
- If your configuration isn't loading, check:
-
-
-
-
- File exists at ~/.starknode-kit/starknode.yml
-
- File has correct YAML syntax
-
- File has correct permissions (readable by your user)
-
-
-
-
Port conflicts
-
-
If you get port conflicts:
-
-
-
- Check if ports are already in use: lsof -i :[port]
-
- Configure different ports in your config
- Stop conflicting services
-
-
-
-
📖 Next Steps
-
- Ready to dive deeper? Check out our comprehensive guides:
-
-
-
-
-
-
Contributing
-
-
- We welcome contributions to starknode-kit! This guide will help you get
- started with contributing to the project.
-
-
-
Ways to Contribute
-
-
There are many ways to contribute to starknode-kit:
-
-
- 🐛 Report bugs - Help us identify and fix issues
- 💡 Suggest features - Share your ideas for improvements
- 📝 Improve documentation - Help others understand and use the tool
- 💻 Write code - Implement new features or fix bugs
- 🧪 Test - Test new releases and provide feedback
- 🌍 Community support - Help other users in issues and discussions
-
-
-
Getting Started
-
-
1. Fork the Repository
-
-
Start by forking the repository on GitHub:
-
-
-
-
2. Clone Your Fork
-
-
-
-
3. Set Up Development Environment
-
-
Make sure you have the required tools:
-
-
- Go 1.24 or later
- Make
- Git
-
-
-
-
-
4. Create a Branch
-
-
Create a branch for your changes:
-
-
-
-
Development Workflow
-
-
Project Structure
-
-
-
-
Making Changes
-
-
- Write your code - Implement your feature or fixFollow Go conventions - Use gofmt and follow Go best practicesAdd tests - Write tests for your changes when applicableUpdate documentation - Update README or add docs as needed
-
-
Testing
-
-
Run tests before submitting:
-
-
-
-
Code Style
-
-
Format your code with gofmt:
-
-
-
-
Submitting Changes
-
-
1. Commit Your Changes
-
-
Write clear, descriptive commit messages:
-
-
-
-
2. Push to Your Fork
-
-
-
-
3. Create a Pull Request
-
-
- Go to the original repository on GitHub
- Click "New Pull Request"
- Select your fork and branch
- Fill out the PR template with:
-
- Description of changes
- Related issues
- Testing performed
- Screenshots (if UI changes)
-
-
- Submit the pull request
-
-
-
Pull Request Guidelines
-
-
To increase the chances of your PR being accepted:
-
-
- ✅ Make focused, single-purpose changes
- ✅ Write clear commit messages
- ✅ Include tests for new features
- ✅ Update documentation as needed
- ✅ Follow existing code style
- ✅ Respond to review feedback promptly
- ❌ Don't include unrelated changes
- ❌ Don't submit untested code
- ❌ Don't break existing functionality
-
-
-
Reporting Bugs
-
-
When reporting bugs, include:
-
-
- Description - Clear description of the bugSteps to reproduce - How to trigger the bugExpected behavior - What should happenActual behavior - What actually happensEnvironment - OS, Go version, starknode-kit versionLogs - Relevant log output or error messages
-
-
-
-
Suggesting Features
-
-
When suggesting features, include:
-
-
- Clear description of the feature
- Use case and motivation
- Proposed implementation (if applicable)
- Potential impact on existing functionality
-
-
-
Code of Conduct
-
-
We are committed to providing a welcoming and inclusive environment. Please:
-
-
- ✅ Be respectful and considerate
- ✅ Welcome newcomers and help them learn
- ✅ Accept constructive criticism gracefully
- ✅ Focus on what's best for the community
- ❌ Don't harass or discriminate
- ❌ Don't be disruptive or disrespectful
-
-
-
Getting Help
-
-
If you need help with contributing:
-
-
-
-
Resources
-
-
-
-
-
🎉 Thank You!
-
- Thank you for considering contributing to starknode-kit! Your contributions help make this tool better for everyone.
-
-
-
-
-
-
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
-
-
-
-
-
📝 Note
-
- For detailed hardware requirements, check out our{" "}
-
-
-
-
Installation
-
-
- The quickest way to install starknode-kit is using the installation
- script:
-
-
-
-
-
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:
-
-
-
-
-
- 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:
-
-
-
-
-
Or with Reth and Prysm:
-
-
-
-
Starknet Client
-
-
To add a Starknet client (Juno):
-
-
-
-
Configure Network
-
-
- By default, starknode-kit is configured for mainnet. To change to a
- test network:
-
-
-
-
-
Start Your Nodes
-
-
- Start Ethereum Clients
-
-
-
- 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.
-
-
-
-
- Run Individual Clients
-
-
-
To run a specific client:
-
-
-
-
Monitor Your Nodes
-
-
- Launch the real-time monitoring dashboard to see the status of your
- nodes:
-
-
-
-
-
The monitoring dashboard provides real-time insights:
-
-
-
-
-
🔄
-
-
Node Sync Status
-
Real-time synchronization progress and health
-
-
-
-
-
-
-
📊
-
-
Current Block Height
-
Latest block number and sync progress
-
-
-
-
-
-
-
🌐
-
-
Network Statistics
-
Peer connections and network performance
-
-
-
-
-
-
-
💻
-
-
System Resources
-
CPU, RAM, and disk usage metrics
-
-
-
-
-
-
Check Status
-
-
- For a quick status check of all running clients:
-
-
-
-
-
-
📖 Next Steps
-
- Ready to dive deeper? Check out our installation guide:
-
-
-
-
-
-
Installation
-
-
- There are multiple ways to install starknode-kit. Choose the method that
- best suits your needs.
-
-
-
- Option 1: Install Script (Recommended)
-
-
-
- The easiest and recommended way to install starknode-kit:
-
-
-
-
-
- Or download the script first and then run it:
-
-
-
-
-
- Option 2: Install using Go
-
-
-
- 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.
-
-
-
- Option 3: Manual Installation from Source
-
-
-
- 1. Clone the Repository
-
-
-
-
-
2. Build and Install
-
-
-
-
Verify Installation
-
-
- After installation, verify that starknode-kit is working correctly:
-
-
-
-
-
You should see output similar to:
-
-
-
-
Initial Setup
-
-
- After successful installation, generate your configuration file:
-
-
-
-
-
- This creates a configuration file at{" "}
- ~/.starknode-kit/starknode.yml.
-
-
-
Uninstallation
-
-
- 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.
-
-
-
-
Troubleshooting
-
-
Command not found
-
-
- 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.
-
-
-
Permission denied
-
-
- If you encounter permission issues during installation, make sure you
- have sudo access or contact your system administrator.
-
-
-
-
📖 Next Steps
-
- Ready to dive deeper? Check out our configuration guide:
-
-
-
-
-
-
- {children}
-
-
-
-
- );
-}
diff --git a/docs/src/app/page.tsx b/docs/src/app/page.tsx
deleted file mode 100644
index ea7a66d..0000000
--- a/docs/src/app/page.tsx
+++ /dev/null
@@ -1,144 +0,0 @@
-import Link from "next/link";
-import CodeBlock from "@/components/CodeBlock";
-
-export default function Home() {
- return (
-
-
Welcome to starknode-kit
-
-
- A powerful command-line tool to help developers and node operators
- easily set up, manage, and maintain Ethereum and Starknet nodes.
-
-
-
-
-
- 🚀 Getting Started
-
-
- Learn how to install and configure starknode-kit for your node
- setup.
-
-
-
-
-
- 📘 Commands
-
-
- Explore all available commands and their usage.
-
-
-
-
-
- ⚙️ Configuration
-
-
- Configure your Ethereum and Starknet clients.
-
-
-
-
-
- 🔐 Validator Setup
-
-
- Set up and manage your Starknet validator node.
-
-
-
-
-
Quick Start
-
-
Install starknode-kit with a single command:
-
-
-
-
Generate your configuration file:
-
-
-
-
Add your first client pair:
-
-
-
-
Key Features
-
-
-
- ✅ Easy Setup - Get your node running in minutes
-
-
- ✅ Multi-Client Support - Works with Geth, Reth,
- Lighthouse, Prysm, and Juno
-
-
- ✅ Real-time Monitoring - Built-in dashboard to
- monitor your nodes
-
-
- ✅ Auto Updates - Keep your clients up to date
- automatically
-
-
- ✅ Validator Management - Simplified Starknet
- validator operations
-
-
- ✅ Network Flexibility - Support for mainnet,
- sepolia, and custom networks
-
-
-
-
Supported Clients
-
-
-
-
-
Consensus Layer
-
- • Lighthouse
- • Prysm
-
-
-
-
Starknet
-
- • Juno
- • Starknet Validator
-
-
-
-
-
-
📖 Next Steps
-
- Ready to dive deeper? Check out our comprehensive guides:
-
-
-
-
-
-
Requirements
-
-
- Hardware and software requirements for running Ethereum and Starknet
- nodes with starknode-kit.
-
-
-
Hardware Requirements
-
-
-
-
Minimum Requirements
-
-
-
-
-
- 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
-
-
-
-
-
-
Recommended Specifications
-
-
- CPU: Intel i5/i7 or AMD Ryzen 5/7 (6+ cores)RAM: 64 GB DDR4Storage: 4 TB NVMe SSD with DRAM cacheNetwork: 1 Gbps fiber connectionBackup Power: UPS with 30+ minutes runtime
-
-
Storage Requirements
-
-
Storage is the most critical component for node operation.
-
-
Storage Size
-
-
-
-
-
- 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
-
-
-
-
-
-
SSD Requirements
-
-
Your SSD must have :
-
-
- ✅ DRAM cache - Essential for performance
- ✅ TLC or better NAND - No QLC (Quad-Level Cell)
- ✅ High endurance rating - 600+ TBW recommended
- ✅ NVMe interface - SATA SSDs are too slow
-
-
-
-
⚠️ 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.
-
-
-
-
Software Requirements
-
-
Operating System
-
-
Supported operating systems:
-
-
- Linux: Ubuntu 20.04+, Debian 11+, or other modern distributionsmacOS: macOS 12 (Monterey) or laterWindows: Windows 10/11 with WSL2 (Ubuntu)
-
-
Linux is highly recommended for production use.
-
-
Required Software
-
-
Go (for building from source)
-
-
Version 1.24 or later required:
-
-
-
-
Install from: https://go.dev/dl/
-
-
Rust (for Starknet clients)
-
-
Recommended for building Juno and other Starknet clients:
-
-
-
-
Make
-
-
Required for building certain clients:
-
-
-
-
Network Requirements
-
-
Bandwidth
-
-
- Download: 100+ MbpsUpload: 25+ MbpsData Cap: Unlimited (or 2+ TB/month)
-
-
Ports
-
-
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)
-
-
-
-
-
-
For Validator Nodes
-
-
Additional requirements for running a validator:
-
-
- Uptime: 99.9%+ availability requiredBackup Power: UPS mandatoryMonitoring: 24/7 monitoring and alertingBackup Internet: Secondary connection recommendedDedicated Hardware: No shared resources
-
-
Tested Hardware Configurations
-
-
Budget Build (~$800)
-
-
- Intel NUC 13 PRO (i5)
- 32 GB DDR4 RAM
- 2 TB NVMe SSD (Samsung 980 PRO)
- Ubuntu 22.04 LTS
-
-
-
Recommended Build (~$1500)
-
-
- Custom build: AMD Ryzen 7 or Intel i7
- 64 GB DDR4 RAM
- 4 TB NVMe SSD (Samsung 990 PRO)
- 1 Gbps fiber connection
- UPS with 30min+ runtime
- Ubuntu 22.04 LTS
-
-
-
Pro Build (~$3000+)
-
-
- High-end workstation or server
- 128 GB ECC RAM
- 8 TB NVMe SSD (enterprise grade)
- Redundant power supplies
- Redundant network connections
- Professional monitoring and alerting
-
-
-
Cloud Providers
-
-
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.
-
-
-
-
Validator Setup
-
-
- 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.
-
-
-
-
Prerequisites
-
-
Before setting up a validator, ensure you have:
-
-
- ✅ A fully synced Juno (Starknet) node
- ✅ A Starknet wallet with sufficient funds for staking
- ✅ Stable internet connection with 99.9%+ uptime
- ✅ Understanding of validator responsibilities
-
-
-
Installation
-
-
The validator client is managed through starknode-kit. First, ensure you have starknode-kit installed and configured.
-
-
Validator Commands
-
-
Check Validator Status
-
-
Check the status of your validator:
-
-
-
-
Get Validator Version
-
-
Check the installed version of the validator client:
-
-
-
-
Set Juno RPC Endpoint
-
-
Configure the Juno RPC endpoint for your validator:
-
-
-
-
Or use a remote Juno node:
-
-
-
-
Configuration
-
-
Validator configuration is stored in your starknode-kit config file. Key settings include:
-
-
-
-
Setting Up Environment Variables
-
-
Store sensitive validator data in environment variables:
-
-
-
-
Add these to your ~/.bashrc or ~/.zshrc to make them persistent.
-
-
Starting Your Validator
-
-
Step 1: Ensure Juno is Running
-
-
Your Juno node must be fully synced and running:
-
-
-
-
Step 2: Verify Configuration
-
-
Check your validator configuration:
-
-
-
-
Step 3: Start the Validator
-
-
Start your validator client:
-
-
-
-
Monitoring Your Validator
-
-
Monitor your validator status:
-
-
-
-
Validator Responsibilities
-
-
- Uptime - Maintain high availability (99.9%+)Security - Keep your keys secure and never share themUpdates - Keep your validator software up to dateMonitoring - Actively monitor your validator performanceBackup - Maintain secure backups of your keys
-
-
Security Best Practices
-
-
- ✅ Use hardware wallets when possible
- ✅ Store keys in environment variables, not in config files
- ✅ Use firewall to restrict access to validator ports
- ✅ Enable SSH key-based authentication
- ✅ Keep your server updated with security patches
- ✅ Monitor for unusual activity
- ✅ Have a disaster recovery plan
- ❌ Never share your private keys
- ❌ Don't run validators on shared hosting
- ❌ Avoid storing keys in version control
-
-
-
Staking and Commission
-
-
Configure your validator's commission rate:
-
-
-
-
This sets a 10% commission on staking rewards. Validators typically charge 5-15% commission.
-
-
Troubleshooting
-
-
Validator Not Connecting to Juno
-
-
Check that:
-
- Juno is running: starknode-kit status
- RPC endpoint is correct in config
- Firewall allows connections to Juno port
-
-
-
Keys Not Loading
-
-
Verify environment variables are set:
-
-
-
-
If empty, add to your shell profile and reload.
-
-
Validator Offline
-
-
If your validator goes offline:
-
- ✅ Check system resources
- ✅ Check network connectivity
- ✅ Review validator logs
- ✅ Restart validator if needed
-
-
-
Performance Metrics
-
-
Monitor these key metrics:
-
-
- Attestation rate - Percentage of successful attestationsBlock proposals - Number of blocks proposedUptime - Validator availability percentageRewards - Staking rewards earned
-
-
Validator Economics
-
-
Understand the economics:
-
-
- Minimum Stake - Required amount to become a validatorRewards - Earned from successful validationCommission - Your fee for running the validatorPenalties - For downtime or malicious behavior
-
-
-
💡 Tip
-
- Start on the testnet (Sepolia) to familiarize yourself with validator operations before running on mainnet.
-
-
-
-
Resources
-
-
-
-
-
📖 Next Steps
-
- Ready to dive deeper? Check out our comprehensive guides:
-
-
-
-
-
-
-
- {copied ? '✓ Copied!' : 'Copy'}
-
-
-
- {code}
-
-
-
-
-
- starknode-kit
-
-
Documentation
-
-
- {navigation.map((item) => (
-
-
- );
-}
-
diff --git a/docs/tailwind.config.ts b/docs/tailwind.config.ts
deleted file mode 100644
index f67c807..0000000
--- a/docs/tailwind.config.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-import type { Config } from "tailwindcss";
-
-const config: Config = {
- content: [
- "./src/pages/**/*.{js,ts,jsx,tsx,mdx}",
- "./src/components/**/*.{js,ts,jsx,tsx,mdx}",
- "./src/app/**/*.{js,ts,jsx,tsx,mdx}",
- ],
- theme: {
- extend: {},
- },
- plugins: [],
-};
-
-export default config;
-
diff --git a/docs/tsconfig.json b/docs/tsconfig.json
deleted file mode 100644
index c133409..0000000
--- a/docs/tsconfig.json
+++ /dev/null
@@ -1,27 +0,0 @@
-{
- "compilerOptions": {
- "target": "ES2017",
- "lib": ["dom", "dom.iterable", "esnext"],
- "allowJs": true,
- "skipLibCheck": true,
- "strict": true,
- "noEmit": true,
- "esModuleInterop": true,
- "module": "esnext",
- "moduleResolution": "bundler",
- "resolveJsonModule": true,
- "isolatedModules": true,
- "jsx": "preserve",
- "incremental": true,
- "plugins": [
- {
- "name": "next"
- }
- ],
- "paths": {
- "@/*": ["./src/*"]
- }
- },
- "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
- "exclude": ["node_modules"]
-}