Lux Docs

Overview

Lux SDK is the official Go SDK for building and managing Lux networks. It provides a unified interface for network lifecycle management, blockchain creation and deployment (L1/L2/L3), multi-chain wallet operations, validator management, smart contract interaction, and cross-chain messaging via Warp. The SDK wraps CLI, netrunner, and direct node APIs into a single coherent library.

Quick Reference

Item	Value
Module	`github.com/luxfi/sdk`
Go	1.26.1
Entry point	`sdk.go` (`LuxSDK` struct)
Main API	`sdk.New(cfg)` returns `*LuxSDK`

Core luxfi Dependencies

Dependency	Version	Purpose
`github.com/luxfi/consensus`	v1.22.63	Snow consensus engine
`github.com/luxfi/evm`	v0.8.35	C-Chain EVM
`github.com/luxfi/node`	v1.23.4	Lux node implementation
`github.com/luxfi/netrunner`	v1.15.11	Network testing orchestrator
`github.com/luxfi/genesis`	v1.6.1	Genesis configuration
`github.com/luxfi/warp`	v1.18.5	Cross-chain Warp messaging
`github.com/luxfi/ledger`	v1.1.6	Hardware wallet support
`github.com/luxfi/lpm`	v1.9.4	Lux Plugin Manager
`github.com/luxfi/crypto`	v1.17.40	Cryptographic primitives
`github.com/luxfi/geth`	v1.16.75	Go-Ethereum fork (EVM)
`github.com/luxfi/ids`	v1.2.9	ID types (ID, ShortID, NodeID)
`github.com/luxfi/protocol`	v0.0.3	P-Chain protocol types
`github.com/luxfi/rpc`	v1.0.0	JSON-RPC client
`github.com/luxfi/utxo`	v0.2.4	UTXO management
`github.com/luxfi/vm`	v1.0.33	Virtual machine interfaces
`github.com/luxfi/validators`	v1.0.0	Validator types
`github.com/luxfi/constants`	v1.4.4	Network constants
`github.com/luxfi/database`	v1.17.40	Storage layer
`github.com/luxfi/codec`	v1.1.4	Serialization codec
`github.com/luxfi/formatting`	v1.0.1	Encoding utilities
`github.com/luxfi/keychain`	v1.0.2	Key management
`github.com/luxfi/address`	v1.0.1	Bech32 address formatting
`github.com/luxfi/api`	v1.0.1	API types
`github.com/luxfi/bft`	v0.1.5	BFT consensus
`github.com/luxfi/go-bip32`	v1.0.2	BIP-32 HD keys
`github.com/luxfi/go-bip39`	v1.1.2	BIP-39 mnemonics
`github.com/luxfi/runtime`	v1.0.1	VM runtime
`github.com/luxfi/upgrade`	v1.0.0	Upgrade management
`github.com/luxfi/tls`	v1.0.3	TLS certificate utilities
`github.com/luxfi/net`	v0.0.2	Network utilities
`github.com/luxfi/math`	v1.2.3	Math utilities
`github.com/luxfi/utils`	v1.1.4	General utilities
`github.com/luxfi/p2p`	v1.19.2-zap	P2P networking

Package Map

Top-Level SDK

Package	Import	Purpose
`sdk`	`github.com/luxfi/sdk`	`LuxSDK` struct -- entry point with `New(cfg)`, `Networks()`, `Blockchains()`, `LaunchNetwork()`, `CreateAndDeployBlockchain()`
`config`	`.../sdk/config`	`Config` struct with `Default()` factory
`constants`	`.../sdk/constants`	SDK-level constants

Network Management

Package	Import	Purpose
`network`	`.../sdk/network`	`NetworkManager` -- create/start/stop networks. Types: `NetworkType` (mainnet/testnet/local/custom), `NetworkStatus`, `NodeType` (validator/api/full/light), `NetworkParams`
`network` (legacy)	`.../sdk/network`	`LegacyNetwork` with predefined `MainnetNetwork` (api.lux.network), `TestnetNetwork` (api-test.lux.network), `LocalNetwork` (127.0.0.1:9630)
`netrunner`	`.../sdk/netrunner`	Wraps `github.com/luxfi/netrunner` for test network orchestration
`connect`	`.../sdk/connect`	Node connection utilities

Blockchain Creation

Package	Import	Purpose
`blockchain`	`.../sdk/blockchain`	`Builder` -- `CreateBlockchain()`, `Deploy()`. Types: `BlockchainType` (L1/L2/L3), `VMType` (evm/wasm/custom/tokenvm/morpheusvm), `Blockchain`, `Net`, `GenesisAccount`, `GenesisValidator`
`chainconfig`	`.../sdk/chainconfig`	Chain config and genesis generation/parsing
`configspec`	`.../sdk/configspec`	Configuration specification utilities
`fees`	`.../sdk/fees`	Fee configuration

Chain Clients

Package	Import	Purpose
`platformvm`	`.../sdk/platformvm`	P-Chain client: `GetHeight()`, `GetBalance()`, `GetUTXOs()`, `GetCurrentValidators()`, `GetNet()`, `GetNets()`, `GetStakingAssetID()`, `GetL1Validator()`
`exchangevm`	`.../sdk/exchangevm`	X-Chain client: `Client`, `WalletClient`, `StaticClient` -- UTXO transfers, asset creation
`evm`	`.../sdk/evm`	C-Chain EVM utilities
`health`	`.../sdk/health`	Node health client with `Health(ctx)`
`admin`	`.../sdk/admin`	Admin API client
`info`	`.../sdk/info`	Node info client
`indexer`	`.../sdk/indexer`	Transaction indexer client

Wallet & Key Management

Package	Import	Purpose
`wallet`	`.../sdk/wallet`	`Wallet` struct -- multi-chain wallet with `ImportKey()`, BLS key support for validator ops, UTXO tracking
`wallet/primary`	`.../sdk/wallet/primary`	Primary network wallet operations
`wallet/chain`	`.../sdk/wallet/chain`	Per-chain wallet backends
`wallet/crypto`	`.../sdk/wallet/crypto`	Wallet cryptographic operations
`wallet/keychain`	`.../sdk/wallet/keychain`	Wallet keychain management
`key`	`.../sdk/key`	`Key` struct (ed25519/bls/secp256k1), `Keychain` with `Add()`, `Sign()`, `Get()`, `Addresses()`
`keychain`	`.../sdk/keychain`	Extended keychain utilities
`ledger`	`.../sdk/ledger`	Ledger hardware wallet integration
`crypto`	`.../sdk/crypto`	Ed25519 key operations
`multisig`	`.../sdk/multisig`	Multi-signature transaction support

Validator Management

Package	Import	Purpose
`validator`	`.../sdk/validator`	Validator configuration and context
`validatormanager`	`.../sdk/validatormanager`	L1 validator lifecycle: PoA and PoS manager contracts, registration, removal, weight updates, uptime tracking. Embeds deployed contract bytecodes (ValidatorMessages, PoAValidatorManager, PoSValidatorManager, TransparentUpgradeableProxy)
`validatormanager/txs`	`.../sdk/validatormanager/txs`	Validator manager transaction types
`validatormanager/warp`	`.../sdk/validatormanager/warp`	Warp message handling for validator ops

Smart Contracts

Package	Import	Purpose
`contract`	`.../sdk/contract`	Smart contract interaction: `Deploy()`, `Chain()`, ABI parsing, receipt status handling, allocation management. Uses `github.com/luxfi/evm/accounts/abi/bind`
`contract/contracts`	`.../sdk/contract/contracts`	Precompiled contract interfaces
`contracts/bin`	`.../sdk/contracts/bin`	Compiled contract binaries

Cross-Chain

Package	Import	Purpose
`warp`	`.../sdk/warp`	Warp cross-chain messaging utilities

Infrastructure

Package	Import	Purpose
`lpm`	`.../sdk/lpm`	Lux Plugin Manager -- VM plugin installation
`models`	`.../sdk/models`	Data models: `Network`, `Sidecar`, `L2`, `Host`, `ClustersConfig`, `BootstrapValidator`, `NodeConfig`, `VM`, `Cloud`, `Docker`
`publicarchive`	`.../sdk/publicarchive`	Public archive downloader for chain data
`profiles`	`.../sdk/profiles`	Node configuration profiles
`trace`	`.../sdk/trace`	OpenTelemetry tracing
`utils`	`.../sdk/utils`	General utilities
`utils/fs`	`.../sdk/utils/fs`	Filesystem utilities
`ux`	`.../sdk/ux`	User experience helpers (output formatting)
`prompts`	`.../sdk/prompts`	Interactive prompt utilities
`flags`	`.../sdk/flags`	CLI flag mutex support
`assets`	`.../sdk/assets`	Embedded asset files
`chain`	`.../sdk/chain`	Chain type definitions

Chain Support

Chain	Type	SDK Package	Operations
P-Chain	Platform	`platformvm`	Staking, validators, L1/net creation, UTXOs, balance
X-Chain	Exchange	`exchangevm`	UTXO transfers, asset creation/minting
C-Chain	Contract	`evm`	EVM transactions, contract deployment
Q-Chain	Quantum	(via node API)	PQ-specific operations
M-Chain	MPC	(via node API)	Multi-party custody

Network Endpoints

Network	ID	Endpoint
Mainnet	`constants.MainnetID`	`https://api.lux.network`
Testnet	`constants.TestnetID`	`https://api-test.lux.network`
Local	`constants.LocalID`	`http://127.0.0.1:9630`
Devnet	custom	custom

API Examples

Initialize SDK


cfg := config.Default()
s, err := sdk.New(cfg)
// s.Networks()    -> *network.NetworkManager
// s.Blockchains() -> *blockchain.Builder

Launch Network

net, err := s.LaunchNetwork(ctx, "local", 5)

Create & Deploy Blockchain

bc, err := s.CreateAndDeployBlockchain(ctx, &sdk.BlockchainParams{
    Name:    "my-chain",
    Type:    blockchain.TypeL1,
    VMType:  blockchain.VMTypeEVM,
    ChainID: big.NewInt(43114),
    Network: net,
})

P-Chain Client


client := platformvm.NewClientWithNetworkID("http://localhost:9630", 1)
height, err := client.GetHeight(ctx)
validators, err := client.GetCurrentValidators(ctx, chainID, nil)
balance, err := client.GetBalance(ctx, addrs)

Wallet Operations


w := wallet.New(networkID, chainID)
addr, err := w.ImportKey(privateKey)

Key Management


kc := key.NewKeychain()
err := kc.Add(privateKey)
sig, err := kc.Sign(message, address)

Smart Contract Deployment


// Contract interaction uses luxfi/evm/accounts/abi/bind
// and luxfi/geth types for EVM compatibility

Validator Manager (L1)


// Deploys embedded PoA/PoS validator manager contracts
// Handles registration, removal, weight updates via Warp

VM Types

VM	Constant	Description
EVM	`VMTypeEVM`	Ethereum Virtual Machine (via luxfi/evm)
WASM	`VMTypeWASM`	WebAssembly VM
Custom	`VMTypeCustom`	User-provided VM
TokenVM	`VMTypeTokenVM`	HyperSDK token VM
MorpheusVM	`VMTypeMorpheusVM`	HyperSDK general VM

lux/lux-node.md -- Node that SDK connects to
lux/lux-cli.md -- CLI tool (SDK wraps CLI)
lux/lux-netrunner.md -- Network testing (SDK wraps netrunner)
lux/lux-crypto.md -- Cryptographic primitives used by SDK
lux/lux-evm.md -- EVM implementation

Lux SDK

On this page