Prerequisites
Before you begin, ensure you have:- Operating System: Linux or macOS
- Rust: Latest stable version (installed via rustup)
- Git: For cloning the repository
- System Dependencies: Build tools and libraries (see below)
Windows is not officially supported. We recommend using WSL2 (Windows Subsystem for Linux) for Windows users.
Installation Steps
Install Rust toolchain
Install Rust, cargo, and rustfmt using the official installer:The
rust-toolchain.toml file in the repository pins a specific Rust version and ensures cargo commands run with that version. Cargo will automatically install the correct version if it is not already installed.Build the project
Build the validator and CLI tools:The build process may take 10-30 minutes depending on your system.
Verify Installation
Once the test validator is running, verify it’s working correctly:Basic CLI Usage
Check Cluster Status
Create a Wallet
Request Airdrop (Test Validator Only)
Running Tests
Run the test suite to verify everything is working correctly:The full test suite can take significant time to complete. You can run specific test packages if needed.
Connecting to Public Clusters
Connect to Solana’s public development cluster:- Devnet:
devnet.solana.com- Stable public cluster for development, runs 24/7 - Testnet:
testnet.solana.com- Testing cluster for validators - Mainnet Beta:
api.mainnet-beta.solana.com- Production cluster
Next Steps
Installation Guide
Learn how to build optimized release versions for production
Validator Setup
Configure and run a production validator
CLI Tools
Explore all available command-line tools
Architecture
Understand the validator architecture