Quick Start Guide
Relevant source files
The following files were used as context for generating this wiki page:
The X3 Atomic Star project is a Substrate-based blockchain designed for native cross-VM execution across X3Native, X3Evm, and X3Svm domains. This guide provides the essential procedures for setting up a development environment, launching nodes, and navigating the operational documentation required for both local development and mainnet readiness.
The scope of this guide covers initial prerequisite installation, node binary construction, and execution of various network configurations ranging from single dev nodes to 3-validator local testnets. For operators preparing for production, it incorporates references to the Phase 13f launch documentation suite and the Repomix-based audit system.
Sources: README.md:1-10, PHASE_13F_MASTER_INDEX.md:10-25
Environment Setup
Before running the X3 chain, the development environment must be configured with specific Rust toolchains and system dependencies.
Prerequisites
| Component | Requirement | Purpose |
|---|---|---|
| Rust | Latest stable (via rustup) | Primary programming language |
| Protobuf | protobuf-compiler | Required by Substrate for serialization |
| Clang/LLVM | clang, llvm | C/C++ compiler toolchain for Substrate |
| WASM Target | wasm32-unknown-unknown | Necessary for building the on-chain runtime |
Sources: README.md:13-25
Installation Commands
# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source "$HOME/.cargo/env"
# Install system dependencies (Ubuntu/Debian)
sudo apt-get update
sudo apt-get install -y protobuf-compiler clang llvm
# Add WASM target
rustup target add wasm32-unknown-unknown
Sources: README.md:15-25
Building and Running Nodes
The project utilizes a modular build system where the node binary acts as the primary entry point for the blockchain.
Compilation
The node binary must be built in release mode to ensure optimal performance and to satisfy mainnet readiness checks.
cargo build --release -p x3-chain-node
Sources: README.md:30-34, MAINNET_LAUNCH_CHECKLIST.md:15-18
Execution Modes
X3 supports different execution modes depending on the development or testing requirements.
- Development Node: Runs a single node with a temporary database and pre-funded "Alice" account.
- Mock RPC (Dev Only): A fake RPC server used strictly for frontend UI development. It produces fake blocks without consensus.
- Local Testnet: A 3-validator network that simulates a real decentralized environment.
Sources: README.md:38-50, README.md:78-87
Operational Readiness
For production and mainnet environments, the project follows a rigorous audit and launch procedure known as Phase 13f.
The Launch Gate System
The launch-gates system provides an evidence-based audit framework using Repomix to verify repository integrity before launch.
Sources: launch-gates/README.md:15-40
Operational Documentation Suite
Operators should refer to specific documents in the Phase 13f suite for different operational scenarios.
| Scenario | Document | Primary Focus |
|---|---|---|
| Schedule & Timeline | PHASE_13F_MAINNET_LAUNCH_RUNBOOK.md | Hour-by-hour execution (T-48h to T+7d) |
| System Failure | MAINNET_INCIDENT_RESPONSE.md | 8 incident playbooks (Crashes, Bridge pauses) |
| RPC Failover | RPC_FAILOVER_PROCEDURES.md | Multi-provider failure handling |
| Hardware Issues | GPU_VALIDATOR_TROUBLESHOOTING.md | CUDA errors and thermal throttling |
Sources: PHASE_13F_MASTER_INDEX.md:18-70
Testing Framework
The project enforces high reliability through a comprehensive test suite targeting core logic like the Cross-VM router and the supply ledger.
# Test Cross-VM router proofs (6-route matrix, invariants)
cargo test -p pallet-x3-cross-vm-router
# Test supply ledger (enforces canonical_supply >= represented_total)
cargo test -p pallet-x3-supply-ledger
Sources: README.md:63-74, MAINNET_LAUNCH_CHECKLIST.md:38-55
Conclusion
By following this guide, developers can establish a functional development environment for the X3 Atomic Star chain. Success is measured by the ability to build the release binary, pass all pallet-level invariant tests, and satisfy the readiness criteria defined in the launch gate system. For production deployments, strict adherence to the Phase 13f documentation suite is mandatory to ensure network stability and security.
Sources: README.md:100-110, PHASE_13F_MASTER_INDEX.md:140-150