Documentation

Everything you need to install, configure, and run an Axiom node. From first download to mining your first block.

Installation

Download the latest release for your platform and install.

Linux / macOS

tar xzf axiom-v0.5.0-linux-x86_64.tar.gz
cd axiom-v0.5.0
sudo ./install.sh
axiom version

Windows

# Extract axiom-v0.5.0-windows-x86_64.zip
cd axiom-v0.5.0
.\install.bat
axiom version

Build from source

git clone https://github.com/axiom-network/axiom.git
cd axiom
cargo build --release
./target/release/axiom version

Quick Start

Three commands to get up and running.

1

Initialize your node

Creates the data directory and default configuration file.

axiom init
2

Create a wallet

Generates a new wallet with a BIP39 seed phrase and ML-DSA-87 keypair.

axiom wallet create
⚠
Back up your seed phrase

Write down your 24-word seed phrase and store it in a safe location. This is the only way to recover your wallet if you lose access. Never share it with anyone.

3

Start the node

Connects to the network, syncs the blockchain, and begins validating.

axiom start

Wallet Operations

Manage your wallets from the command line.

# Create a new wallet
axiom wallet create

# Import a wallet from seed phrase
axiom wallet import

# Show your wallet address
axiom wallet address

# Check your balance
axiom wallet balance
🔒
Wallet encryption

Private keys are encrypted at rest using Argon2id for key derivation and XChaCha20-Poly1305 for authenticated encryption. Keys never leave your device unencrypted.

Node Configuration

After running axiom init, edit the configuration file for your platform.

# Config file locations
Linux:   ~/.axiom/axiom.conf
macOS:   ~/Library/Application Support/Axiom/axiom.conf
Windows: %APPDATA%\Axiom\axiom.conf
axiom.conf
# Network
listen_port = 9333
max_peers = 50

# RPC
rpc_bind = "127.0.0.1"
rpc_port = 9332

# Mining
mine = false
mining_threads = 0

# Logging
log_level = "info"

Syncing

Check sync progress and understand the syncing process.

axiom status

Axiom uses checkpoint sync to accelerate initial synchronization. The node downloads verified checkpoints from the network first, then syncs remaining blocks from the latest checkpoint to chain tip. This significantly reduces time to full sync compared to downloading every block from genesis.

Mining

Start mining AXM with your CPU.

# Start node with mining enabled
axiom start --mine
# Start a dedicated mining worker
axiom worker start
# View mining rewards in table format
axiom rewards --table

Full mining guide →

Troubleshooting

Node won't start

Check that port 9333 is not already in use by another process. On Linux/macOS, run lsof -i :9333 to identify conflicts. Stop any conflicting process before starting your node.

No peers found

Ensure your firewall allows outbound connections on port 9333. If you are behind a NAT, configure port forwarding for port 9333 to allow incoming peer connections.

Wallet password forgotten

If you have your 24-word seed phrase, you can recover your wallet by importing it. Run axiom wallet import and enter your seed phrase when prompted. A new password will be set during import.

CLI Reference

Complete list of available commands.

Command Description
axiom init Initialize data directory and default configuration
axiom start Start the node and connect to the network
axiom start --mine Start the node with mining enabled
axiom wallet create Generate a new wallet with seed phrase and keypair
axiom wallet import Import a wallet from an existing seed phrase
axiom wallet address Display your wallet address
axiom wallet balance Show current wallet balance
axiom worker start Start a dedicated mining worker process
axiom rewards Display mining reward summary
axiom rewards --table N Show last N mining rewards in table format
axiom status Show node sync status, peer count, and chain tip
axiom version Print version and build information