Lux Faucet - AI Assistant Knowledge Base
Serves as a single source of truth for AI assistants working on a testnet faucet project with Node.js, React, and Solidity.
What this file does
Serves as a single source of truth for AI assistants working on a testnet faucet project with Node.js, React, and Solidity.
When to use it
- You want AI assistants to have consistent project context
- You need a central knowledge base that propagates to multiple AI systems
- You are onboarding new AI assistants to an existing codebase
- You want to define rules for how AI assistants should update project documentation
Assumes this stack
Lux Faucet - AI Assistant Knowledge Base
Last Updated: 2025-11-05 Project: Lux Testnet Faucet Stack: Node.js, TypeScript, React → Next.js, Solidity, Foundry
Project Overview
Modern faucet for distributing test tokens on Lux testnets. Supports multiple EVM chains with rate limiting, captcha verification, and configurable drip amounts.
Essential Commands
Development
pnpm dev # Start backend with tsx watch (port 8000)
pnpm dev:ui # Start frontend (port 3000)
pnpm build # Build everything
pnpm generate # Generate new wallet key
Contracts
cd contracts
forge build # Compile
forge test # Run tests
forge test --gas-report # Gas usage
Architecture
- Backend: Express + TypeScript (
/server.ts) - Frontend: React (CRA) → migrating to Next.js 15
- Smart Contracts: Solidity + Foundry (
/contracts/) - Package Manager: pnpm (workspace)
- Dev Tools: tsx (not nodemon ✅)
Key Technologies
Current
- Node.js 17+, Express, TypeScript
- React 18, web3.js v1, ethers v5
- Solidity 0.8.28, Foundry
- pnpm workspace
Planned
- Next.js 15, viem v2, wagmi v2
- TailwindCSS + shadcn/ui
Development Workflow
- Generate wallet:
pnpm generate - Update
.envwith keys and ReCaptcha secret - Start backend:
pnpm dev - Start frontend:
pnpm dev:ui - Deploy contracts:
cd contracts && forge script ...
Context for All AI Assistants
This file (LLM.md) is symlinked as:
.AGENTS.mdCLAUDE.mdQWEN.mdGEMINI.md
All files reference the same knowledge base. Updates here propagate to all AI systems.
Rules for AI Assistants
- ALWAYS update LLM.md with significant discoveries
- NEVER commit symlinked files (.AGENTS.md, CLAUDE.md, etc.) - they're in .gitignore
- NEVER create random summary files - update THIS file
Note: This file serves as the single source of truth for all AI assistants working on this project.
What's inside
7 sections: overview, commands, architecture, technologies, workflow, symlink setup, AI rules
Change this for your project
- Replace
Lux Faucetwith your project name - Replace
luxfi/faucetwith your repository path - Replace
Lux Testnet Faucetwith your project description - Replace symlink targets like
.AGENTS.md,CLAUDE.md,QWEN.md,GEMINI.mdwith your AI assistant file names
Where it goes
Save in docs/ or the repository root. Gives agents and new contributors a map of the codebase.
Related Documents
PCB Design Sources for Industry-Scale Testing
Lists GitHub repos and communities where you can download real PCB designs for testing optimization at scale.
Design Document: BharatSeva AI
Describes a 10-agent AWS system that helps India's informal workers access government schemes via voice-first, serverless architecture.
OpenClaw Enterprise Transformation Plan
Transforms a single-user AI agent into a dual-mode platform supporting both viral open-source and Fortune 500 enterprise deployments through phased security, IAM, audit, multi-tenancy, and Kubernetes features.
Qwen Image and Edit: Open-sourcing and Local GGUF Generations with Lightning
Documents the Qwen-Image and Qwen-Image-Edit models, covering architecture, training, benchmarks, ComfyUI setup, and prompting techniques for local GGUF deployment.