Lux Docs

Lux Netrunner

Network testing and simulation tool

Spin up multi-node Lux networks for testing, benchmarking, and CI/CD integration. Netrunner manages the full lifecycle of local blockchain networks with support for custom topologies, failure injection, and performance measurement.

Features

FeatureDescription
Network SimMulti-node networks with custom topology
BenchmarksTPS measurement and latency profiling
ConsensusVerify consensus under load and partitions
SnapshotsSave and restore network state
CI/CDGitHub Actions and Jenkins integration
Multi-EngineLux, Geth, Optimism support

Architecture

Netrunner runs as a gRPC server that manages node processes:

CLI / Go Client
    -> gRPC Server (port 8080)
        -> Network Manager
            -> Node Process 1 (luxd, port 9630)
            -> Node Process 2 (luxd, port 9632)
            -> Node Process 3 (luxd, port 9634)
            -> Node Process 4 (luxd, port 9636)
            -> Node Process 5 (luxd, port 9638)

Quick Start

# Install
curl -sSfL https://raw.githubusercontent.com/luxfi/netrunner/main/scripts/install.sh | sh -s

# Start the RPC server
netrunner server --port=":8080" --grpc-gateway-port=":8081"

# Start a 5-node network
netrunner control start --number-of-nodes=5 \
  --node-path=/path/to/luxd

# Check health
netrunner control health

# Save snapshot
netrunner control save-snapshot my-snapshot

# Stop
netrunner control stop

On this page