Lux Standard Library

The official Solidity smart contracts library for the Lux Network ecosystem. Production-ready contracts for tokens, DeFi protocols, cross-chain bridges, post-quantum cryptography, and more.

Installation

npm / pnpm / yarn

npm install @luxfi/contracts
# or
pnpm add @luxfi/contracts
# or
yarn add @luxfi/contracts

Foundry

forge install luxfi/standard

Add to remappings.txt:

@luxfi/contracts/=lib/standard/contracts/

Quick Start

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;

import "@luxfi/contracts/tokens/LRC20.sol";

contract MyToken is LRC20 {
    constructor() LRC20("My Token", "MTK") {
        _mint(msg.sender, 1_000_000 * 10**18);
    }
}

Contract Categories

Tokens

Standard token implementations with Lux-native naming:

Contract	Description	Import
LRC20	ERC20 base implementation	`@luxfi/contracts/tokens/LRC20.sol`
LRC20B	Bridgeable ERC20 (mint/burn by bridge)	`@luxfi/contracts/tokens/LRC20B.sol`
LRC721B	Bridgeable ERC721	`@luxfi/contracts/tokens/LRC721B.sol`
LRC1155B	Bridgeable ERC1155	`@luxfi/contracts/tokens/LRC1155B.sol`
LUX	Native platform token	`@luxfi/contracts/tokens/LUX.sol`
LUSD	Lux Dollar stablecoin	`@luxfi/contracts/tokens/LUSD.sol`
AI	AI compute mining token	`@luxfi/contracts/tokens/AI.sol`
WLUX	Wrapped LUX	`@luxfi/contracts/tokens/WLUX.sol`

Extensions:

LRC20Capped - Maximum supply cap
LRC20Burnable - Burn functionality
LRC20Pausable - Emergency pause
LRC20Permit - Gasless approvals (EIP-2612)

Liquid Protocol

Unified yield vault and liquid staking with xLUX:

Contract	Description	Import
LiquidLUX	Master yield vault - receives ALL protocol fees	`@luxfi/contracts/liquid/LiquidLUX.sol`
LiquidToken	Base ERC20 with flash loan support (ERC-3156)	`@luxfi/contracts/liquid/LiquidToken.sol`
LiquidVault	Cross-chain teleport vault	`@luxfi/contracts/liquid/teleport/LiquidVault.sol`
LETH	Lux ETH (bridged)	`@luxfi/contracts/liquid/tokens/LETH.sol`
LBTC	Lux BTC (bridged)	`@luxfi/contracts/liquid/tokens/LBTC.sol`
LUSD	Lux USD stablecoin	`@luxfi/contracts/liquid/tokens/LUSD.sol`

import "@luxfi/contracts/liquid/LiquidLUX.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";

LiquidLUX liquidLux = LiquidLUX(LIQUID_LUX_ADDRESS);
IERC20 wlux = IERC20(WLUX_ADDRESS);

// Deposit WLUX, receive xLUX shares
wlux.approve(address(liquidLux), amount);
uint256 shares = liquidLux.deposit(amount, msg.sender);

// Withdraw - burns xLUX, returns WLUX
uint256 assets = liquidLux.withdraw(shares, msg.sender, msg.sender);

Available L Tokens:* LETH, LBTC, LUSD, LUSDC, LUSDT, LDAI, LSOL, LTON, LBNB, LPOL, LAVAX, LADA

Bridge & Cross-Chain

Cross-chain asset transfers via Warp messaging:

Contract	Description	Import
Bridge	Core bridge with Warp verification	`@luxfi/contracts/bridge/Bridge.sol`
Teleport	Token teleportation interface	`@luxfi/contracts/bridge/Teleport.sol`
LRC20B	Bridgeable token base	`@luxfi/contracts/bridge/LRC20B.sol`

import "@luxfi/contracts/bridge/Teleport.sol";

// Teleport tokens to another chain
teleport.send(destChainId, recipient, token, amount);

Perps (Perpetual Trading)

Leveraged perpetual futures with up to 50x leverage:

Contract	Description
Vault	Central liquidity pool
Router	Position management
LLP	Liquidity provider token
PositionRouter	Keeper-executed orders

import "@luxfi/contracts/perps/core/Router.sol";

// Open leveraged long position
router.increasePosition(
    collateralToken,
    indexToken,
    collateralAmount,
    sizeDelta,
    true // isLong
);

AMM (Automated Market Maker)

Automated market maker with V2 and V3 pools:

Contract	Description
AMMV2Factory	V2 pair factory
AMMV2Pair	V2 liquidity pair
AMMV2Router	V2 swap router
AMMV3Factory	V3 concentrated liquidity factory
AMMV3Pool	V3 concentrated liquidity pool

Markets (Lending)

Morpho-style lending markets:

Contract	Description
Markets	Core lending market
Allocator	Capital allocation
Router	Lending router

LSSVM (NFT AMM)

NFT automated market maker with bonding curves:

Contract	Description
LSSVMPairFactory	Pair factory
LSSVMPair	NFT/token pair
LSSVMRouter	Swap router
LinearCurve	Linear bonding curve
ExponentialCurve	Exponential bonding curve

Governance

On-chain governance with vote-escrowed tokens:

Contract	Description
DAO	Complete DAO implementation
Governor	OpenZeppelin Governor
Timelock	Timelock controller
vLUX	Vote-escrowed LUX
GaugeController	Gauge weight voting

import "@luxfi/contracts/governance/DAO.sol";

// Create proposal
dao.propose(targets, values, calldatas, description);
// Vote
dao.castVote(proposalId, support);

Safe (Multi-Signature Wallets)

Multi-sig wallets with post-quantum signer support:

Contract	Description
Safe	Core multi-sig wallet
SafeFactory	Safe deployment factory
SafeFROSTSigner	FROST threshold signer
SafeMLDSASigner	ML-DSA (Dilithium) signer
SafeRingtailSigner	Ringtail lattice signer
SafeLSSSigner	LSS-MPC signer
SafeCGGMP21Signer	CGGMP21 ECDSA threshold
QuantumSafe	Full quantum-resistant safe

import "@luxfi/contracts/safe/Safe.sol";
import "@luxfi/contracts/safe/SafeFROSTSigner.sol";

// Create safe with FROST threshold signing
Safe safe = safeFactory.createSafe(owners, threshold);
safe.enableModule(address(frostSigner));

Post-Quantum Cryptography

Quantum-resistant signature schemes via EVM precompiles:

Precompile	Description
IFROST	Schnorr threshold signatures
IMLDSA	ML-DSA (FIPS 204 / Dilithium)
IMLKEM	ML-KEM key encapsulation
ISLHDSA	SLH-DSA (SPHINCS+)
IRingtailThreshold	Lattice-based threshold
ICGGMP21	ECDSA threshold (MPC)
IBLS	BLS signatures
IWarp	Cross-chain Warp messaging
IQuasar	Quantum consensus

import "@luxfi/contracts/crypto/precompiles/IMLDSA.sol";

// Verify post-quantum signature
bool valid = IMLDSA.verify(publicKey, message, signature);

Lamport Signatures:

import "@luxfi/contracts/crypto/lamport/LamportBase.sol";

// One-time quantum-safe signatures

Identity (DID)

Decentralized identity management:

Contract	Description
DIDRegistry	DID document storage
DIDResolver	DID resolution
PremiumDIDRegistry	Premium DID features

AI & Compute

AI token mining and compute marketplace:

Contract	Description
AIToken	AI mining token
AIMining	Mining rewards
ComputeMarket	GPU compute marketplace

Staking

Contract	Description
sLUX	Staked LUX token

Treasury

Contract	Description
FeeSplitter	Protocol fee distribution to LiquidLUX
ValidatorVault	Validator rewards vault

Account Abstraction

Contract	Description
Account	ERC-4337 account
EOA	Externally owned account
EOAFactory	Account factory
EOAPaymaster	Gas sponsorship

Omnichain

Contract	Description
OmnichainLP	Cross-chain liquidity
OmnichainLPRouter	Routing layer

NFT

Contract	Description
GenesisNFTs	Genesis collection
Market	NFT marketplace

Development

This project supports both Foundry (recommended) and Hardhat for development.

Prerequisites

Foundry (recommended)
Node.js 18+ and pnpm/npm
Git

Setup

# Clone repository
git clone https://github.com/luxfi/standard.git
cd standard

# Install Foundry dependencies
forge install

# Install Node.js dependencies (for Hardhat)
pnpm install

Building

# Foundry (recommended)
forge build

# Hardhat
pnpm build:hardhat

Testing

# Foundry (recommended) - 709 tests
forge test

# With verbosity
forge test -vvv

# With gas reporting
forge test --gas-report

# Coverage
forge coverage

# Hardhat
pnpm test:hardhat

TypeScript Support

Generate TypeChain types for Hardhat/ethers:

pnpm typechain

Deployment

Foundry (recommended)

Deploy scripts are in script/:

# Local deployment (start anvil first)
anvil --chain-id 96369 &
forge script script/DeployFullStack.s.sol --rpc-url localhost --broadcast

# Lux Mainnet
forge script script/DeployFullStack.s.sol --rpc-url lux --broadcast --verify

# Lux Testnet
forge script script/DeployFullStack.s.sol --rpc-url lux_testnet --broadcast --verify

Available deploy scripts:

DeployFullStack.s.sol - Complete DeFi stack (12 phases)
DeployAI.s.sol - AI mining token

Hardhat

# Start local node
pnpm node

# Deploy via Hardhat
pnpm deploy:hardhat localhost

Network Configuration

Configure .env for deployments:

PRIVATE_KEY=your_private_key
INFURA_API_KEY=your_infura_key
ETHERSCAN_API_KEY=your_etherscan_key
LUXSCAN_API_KEY=your_luxscan_key

Available networks: lux, lux_testnet, zoo, zoo_testnet, hanzo, mainnet, sepolia

Documentation

Full documentation available at standard.lux.network

Security

All contracts follow Solidity best practices
Built on OpenZeppelin libraries where applicable
Post-quantum cryptography for future-proofing
Comprehensive test coverage (709 tests)

Audits

Audit reports are available in the audits/ directory.

Contributing

Fork the repository
Create feature branch (git checkout -b feature/amazing-feature)
Commit changes (git commit -m 'Add amazing feature')
Push to branch (git push origin feature/amazing-feature)
Open a Pull Request

License

BSD-3-Clause License - see LICENSE

Name		Name	Last commit message	Last commit date
Latest commit History 129 Commits
.github/workflows		.github/workflows
.vscode		.vscode
archive_deprecated_tests		archive_deprecated_tests
contracts		contracts
deployments		deployments
docs		docs
lib		lib
script		script
scripts		scripts
solidity/dex		solidity/dex
test		test
.env.example		.env.example
.gitignore		.gitignore
.gitmodules		.gitmodules
CHANGELOG.md		CHANGELOG.md
DEPLOYMENTS.md		DEPLOYMENTS.md
LICENSE		LICENSE
LLM.md		LLM.md
LSSVM_TEST_SUMMARY.md		LSSVM_TEST_SUMMARY.md
Makefile		Makefile
NFT_CODE_REVIEW.md		NFT_CODE_REVIEW.md
README.md		README.md
VERSION		VERSION
foundry.lock		foundry.lock
foundry.toml		foundry.toml
hardhat.config.ts		hardhat.config.ts
hardhat.network.ts		hardhat.network.ts
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
remappings.txt		remappings.txt
tsconfig.json		tsconfig.json

License

luxfi/standard

Folders and files

Latest commit

History

Repository files navigation

Lux Standard Library

Installation

npm / pnpm / yarn

Foundry

Quick Start

Contract Categories

Tokens

Liquid Protocol

Bridge & Cross-Chain

Perps (Perpetual Trading)

AMM (Automated Market Maker)

Markets (Lending)

LSSVM (NFT AMM)

Governance

Safe (Multi-Signature Wallets)

Post-Quantum Cryptography

Identity (DID)

AI & Compute

Staking

Treasury

Account Abstraction

Omnichain

NFT

Development

Prerequisites

Setup

Building

Testing

TypeScript Support

Deployment

Foundry (recommended)

Hardhat

Network Configuration

Documentation

Security

Audits

Contributing

License

Links

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 4

Uh oh!

Languages

Packages