🏗️ Scaffold-EVVM 🧉

The complete development environment for EVVM ecosystem.

📚 Documentation | 🌐 Website

Built using NextJS, Foundry/Hardhat, Wagmi, Viem, and TypeScript.

• ✅ Auto-Setup - Contracts automatically cloned and configured on first run
• 🔧 Dual Framework - Choose Foundry or Hardhat for smart contract development
• 📦 Contract Source - Testnet-Contracts
• 🧙 Interactive CLI Wizard - Guided setup for framework, contracts, and configuration
• ⛓️ Local Development - Deploy to Anvil or Hardhat Network for rapid iteration
• 💰 Auto-Funding - Automatically funds wallets from test accounts
• 🔐 Meta-Transactions - EIP-191 gasless signatures submitted by executors
• 🎨 Signature Constructor Frontend - 23+ signature constructors for all EVVM operations

⚠️ Note: This version supports local deployment only. Testnet deployment will be available in a future release.

---

Requirements

Before you begin, you need to install the following tools:

• Node.js (v18+)
• npm (comes with Node.js)
• Git
• Foundry (for Foundry framework)

---

🚀 Quickstart

1. Clone and install:

git clone https://github.com/EVVM-org/scaffold-evvm.git
cd scaffold-evvm
npm install

2. Start everything with a single command:

npm run wizard

This command will:

• ✅ Check all prerequisites
• 🔧 Guide you through framework selection (Foundry/Hardhat)
• 📦 Select contract source (Testnet)
• ⚙️ Configure EVVM (admin addresses, token metadata)
• 🔨 Compile contracts
• ⛓️ Start local chain (Anvil or Hardhat Network)
• 🚀 Deploy all 6 EVVM contracts
• 🌐 Launch frontend at http://localhost:3000

💡 Tip: Keep the terminal open to maintain the local chain running.

---

🛠️ Alternative: Two-Terminal Workflow

For more control during development:

Terminal 1 - Deploy contracts:

npm run cli deploy

Terminal 2 - Start frontend:

npm run frontend

---

🔧 Troubleshooting

If you encounter issues:

npm run cli flush   # Clear all caches and stop servers
npm run wizard  # Fresh start

Common issues solved by flush:

• Nonce errors ("Nonce too high/low")
• Port 8545 already in use
• Transaction reverted / deployment failed

---

📦 Core Contracts

Scaffold-EVVM deploys 6 core EVVM contracts:

Contract	Description
Evvm	Core contract managing payments and tokens via EIP-191 signatures
Staking	Era-based reward system for MATE token holders
Estimator	Staking rewards calculation engine
NameService	Username registration and identity management
Treasury	Cross-chain asset management
P2PSwap	Peer-to-peer token exchange

---

🔐 Local Network

Both Anvil and Hardhat Network use:

• Port: 8545
• Chain ID: 31337
• Test Account: 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
• Private Key: 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

⚠️ Warning: These are publicly known test keys. Never use on networks with real value.

---

📁 Project Structure

scaffold-evvm/
├── cli/                    # Interactive CLI wizard
├── packages/
│   ├── foundry/            # Foundry package
│   │   ├── testnet-contracts/    # Production EVVM contracts (auto-cloned)
│   │   └── contracts/            # Your custom services
│   ├── hardhat/            # Hardhat package
│   └── nextjs/             # Frontend application
├── input/                  # EVVM configuration (generated)
└── deployments/            # Deployment summaries (generated)

---

📚 Documentation

• EVVM Documentation - Complete EVVM protocol documentation
• EVVM Website - Learn more about EVVM ecosystem
• Signature Structures - EIP-191 signature formats
• Foundry Book - Foundry documentation
• Hardhat Docs - Hardhat documentation

---

🤝 Contributing

Contributions are welcome!

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes following the commit message convention
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

---

📄 License

EVVM Noncommercial License v1.0 - see LICENSE for details.

For commercial use, contact: g@evvm.org

---

Made with 🧉 for the EVVM ecosystem
Inspired by 🏗️ Scaffold-ETH