Lux Docs

Explorer Quick Start

Get the explorer running locally in minutes

Prerequisites

  • Go 1.26+ (for backend development)
  • Node.js 22+ and pnpm 10+ (for frontend development)
  • A running luxd node with JSON-RPC access

Single Binary (Fastest)

git clone https://github.com/luxfi/explorer.git
cd explorer
go run ./cmd/explorer --rpc=http://localhost:9650/ext/bc/C/rpc

Open http://localhost:4000. The embedded frontend and SQLite storage start automatically.

Frontend Only

If you have a running backend API:

git clone https://github.com/luxfi/explore.git
cd explore
pnpm install
cp .env.example .env.local

# Edit .env.local with your API endpoint
# NEXT_PUBLIC_API_HOST=http://localhost:4000

pnpm dev

Open http://localhost:3000.

Docker

docker run -it \
  -e RPC_ENDPOINT=http://host.docker.internal:9650/ext/bc/C/rpc \
  -p 4000:4000 \
  ghcr.io/luxfi/explorer:latest

Verify Indexing

# Check health
curl http://localhost:4000/health

# Check latest blocks
curl http://localhost:4000/v1/explorer/blocks

# Check stats
curl http://localhost:4000/v1/explorer/stats

Multi-Chain (All Lux Chains)

go run ./cmd/explorer --config=chains.yaml

See the Configuration page for chains.yaml format.

On this page