AI-powered smart contract development platform
From natural language to production-ready, audited contracts in minutes
HyperAgent Dashboard - Generate, audit, and deploy smart contracts
| Software | Version | Notes |
|---|---|---|
| Python | 3.10+ | Required for backend |
| Node.js | 18.18+ | Required for frontend (Next.js 16) |
| npm | 9.0+ | Comes with Node.js |
| Git | 2.30+ | Version control |
| PostgreSQL | 15+ | Database (or use Supabase) |
| Redis | 7.0+ | Caching (optional, can use Redis Cloud) |
| Docker | 24.0+ | Optional, for containerized deployment |
| Docker Compose | 2.20+ | Optional, comes with Docker Desktop |
| Service | Purpose | Get Key |
|---|---|---|
| Google Gemini | AI contract generation | Get API Key |
| Thirdweb | x402 payments & wallet | Get Client ID |
| OpenAI (optional) | Alternative AI provider | Get API Key |
- Test AVAX - For Avalanche Fuji testnet (Faucet)
- Test USDC - For x402 payments on testnets (Facuet)
- Wallet - MetaMask, Core(Recommended), or any Web3 wallet
# Check versions
python --version # Should be 3.10+
node --version # Should be 18.18+
npm --version # Should be 9.0+
git --version # Should be 2.30+
docker --version # Should be 24.0+ (optional)| Resource | Minimum | Recommended | Optimal |
|---|---|---|---|
| RAM | 8 GB | 16 GB | 32 GB |
| CPU | 2 cores | 4 cores | 6+ cores |
| Storage | 30 GB free | 50 GB free | 100 GB free (SSD) |
💡 Tip: Use cloud services (Supabase, Redis Cloud) to reduce local requirements. See GUIDE/SIMPLIFIED_SETUP.md for cloud-based setup.
| Component | Size | Notes |
|---|---|---|
| Docker Images | ~5-8 GB | Can be cleaned periodically |
| Docker Volumes | ~5-15 GB | Grows with usage |
| Python venv | ~1 GB | One-time setup |
| Frontend node_modules | ~500 MB | One-time setup |
- Fresh Install: ~10-12 GB
- After 1 Month: ~15-18 GB
- After 3 Months: ~22-28 GB
💾 Storage Optimization Tips
- Use Supabase instead of local PostgreSQL (saves ~5-15 GB)
- Clean Docker regularly:
docker system prune(saves ~2-5 GB) - Limit Prometheus retention (saves ~1-2 GB)
- Rotate logs (saves ~500 MB - 1 GB)
- Total potential savings: ~8-23 GB
| Build Type | Time | Notes |
|---|---|---|
| First build | ~25-45 min | Full setup |
| Rebuild (cached) | ~5-15 min | Layer caching enabled |
| Frontend only | ~3-5 min | npm run build |
| Backend only | ~20-35 min | Python deps + Solidity |
Multi-stage builds and layer caching optimize rebuild times. Most time is spent installing Python dependencies and Solidity compilers.
# Clone repository
git clone https://github.com/JustineDevs/HyperAgent.git
cd Hyperkit_agent
# Create virtual environment
python -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt
# Set up environment
cp .env.example .env
# Edit .env with your API keys
# Initialize database
alembic upgrade head
# or make if you prefer straight forward requires Make installed
make up
# Run development server | If you prefer not used Docker
uvicorn hyperagent.api.main:app --reload
# Start all services (frontend, backend, DB, Redis)
docker-compose up -d
# View logs
docker-compose logs -f
# Stop services
docker-compose downcd frontend
npm install
npm run dev
# Open http://localhost:3000- 📖 Full Documentation - Complete guides and API reference
- 🚀 Getting Started Guide - Detailed setup and first contract
- 🏗️ Architecture Guide - System design and patterns
- 💳 x402 Payment Guide - Pay-per-use setup
- ⚡ Hyperion PEF Guide - Parallel batch deployment
- 🔧 API Reference - Complete API documentation
- 🤖 AI-Powered Generation - Natural language → Solidity contracts
- 🛡️ Automated Auditing - Security analysis with Slither, Mythril, Echidna
- 🚀 Multi-Chain Deployment - Hyperion, Mantle, Avalanche
- 💳 x402 Payments - Pay-per-use on Avalanche networks
- ⚡ Parallel Deployment - 10-50x faster with Hyperion PEF
- 🎯 MetisVM Optimized - Floating-point and AI inference support
We welcome contributions! See CONTRIBUTING.md for guidelines.
MIT License - see LICENSE for details.
- Website: hyperionkit.xyz
- GitHub: github.com/Hyperionkit/HyperAgent
- Organization: github.com/HyperionKit/Hyperkit
- Linktree: linktr.ee/Hyperionkit
Built with ❤️ by the HyperAgent team