Smart Contracts Repository for Quantillon Protocol - Euro-pegged stablecoin ecosystem with dual-pool architecture
This repository contains the complete smart contract implementation for the Quantillon Protocol. All development files are organized in the quantillon-protocol directory.
smart-contracts/
βββ quantillon-protocol/ # Main project directory
β βββ src/ # Smart contract source code
β β βββ core/ # Core protocol contracts
β β βββ interfaces/ # Contract interfaces
β β βββ libraries/ # Utility libraries
β β βββ oracle/ # Oracle integration
β βββ test/ # Comprehensive test suite
β βββ scripts/ # Build and deployment scripts
β βββ docs/ # Generated documentation
β βββ lib/ # External dependencies
β βββ foundry.toml # Foundry configuration
β βββ README.md # Detailed project documentation
βββ README.md # This file
π quantillon-protocol/ - Complete smart contract implementation
- π Source Code - All smart contracts and libraries
- π§ͺ Tests - Comprehensive test suite
- π Documentation - Generated documentation
- π§ Scripts - Build and deployment scripts
Quantillon Protocol is a comprehensive DeFi ecosystem built around QEURO, a Euro-pegged stablecoin. The protocol features a dual-pool architecture that separates user deposits from hedging operations, enabling efficient yield generation while maintaining stability.
- QEUROToken: Euro-pegged stablecoin with configurable supply cap and rate limiting
- QTIToken: Governance token with vote-escrow mechanics and voting power multipliers
- QuantillonVault: Main vault for overcollateralized QEURO minting
- UserPool: User deposit and staking management with yield distribution
- HedgerPool: EUR/USD hedging operations with margin management
- stQEUROToken: Yield-bearing wrapper token with automatic yield accrual
- Dual-pool architecture separating user deposits from hedging operations
- Role-based access control for all critical operations
- Emergency pause mechanisms for crisis situations
- Upgradeable architecture via UUPS pattern
- Oracle integration for EUR/USD price feeds
- Yield generation through multiple mechanisms
- Foundry (latest version)
- Git
# Clone the repository
git clone https://github.com/quantillon/smart-contracts.git
cd smart-contracts
# Navigate to the main project
cd quantillon-protocol
# Install dependencies and build
forge install
forge build
# Run tests
forge testcd quantillon-protocol
forge doc --build
forge doc --serve- QEUROToken - Euro-pegged stablecoin
- QTIToken - Governance token
- QuantillonVault - Main vault
- UserPool - User deposits
- HedgerPool - Hedging operations
- stQEUROToken - Yield-bearing wrapper
| Contract | Purpose | Location |
|---|---|---|
| QEUROToken | Euro-pegged stablecoin | quantillon-protocol/src/core/QEUROToken.sol |
| QTIToken | Governance token | quantillon-protocol/src/core/QTIToken.sol |
| QuantillonVault | Main vault | quantillon-protocol/src/core/QuantillonVault.sol |
| UserPool | User deposits | quantillon-protocol/src/core/UserPool.sol |
| HedgerPool | Hedging operations | quantillon-protocol/src/core/HedgerPool.sol |
| stQEUROToken | Yield-bearing wrapper | quantillon-protocol/src/core/stQEUROToken.sol |
cd quantillon-protocol
# Run all tests
forge test
# Run with verbose output
forge test -vvv
# Generate coverage
forge coveragecd quantillon-protocol
# Format code
forge fmt
# Build contracts
forge build
# Deploy to local network
forge script script/deploy/DeployProtocol.s.sol --rpc-url http://localhost:8545 --broadcastThe protocol includes comprehensive development and analysis tools:
# Code Quality & Analysis
make gas-analysis # Comprehensive gas optimization analysis
make analyze-warnings # Analyze and categorize build warnings
make validate-natspec # Validate NatSpec documentation coverage
make slither # Security vulnerability analysis
# Documentation & Testing
make docs # Generate HTML documentation
make test # Run comprehensive test suite
make coverage # Generate test coverage report
# Complete Development Pipeline
make all # Run all checks (build, test, coverage, docs, analysis)Key Features:
- Gas Analysis: Contract size optimization, function visibility analysis, storage layout optimization
- Warning Analysis: Categorizes build warnings by type with actionable recommendations
- NatSpec Validation: Ensures 100% documentation coverage for security audits
- Security Analysis: Comprehensive vulnerability detection with Slither
- Documentation: Auto-generated HTML documentation from NatSpec comments
- Security Contact:
team@quantillon.money - Security Features: Role-based access control, reentrancy protection, emergency pause mechanisms
- Security Analysis: Integrated Slither analysis with
make slither - Warning Analysis: Comprehensive build warning analysis with
make analyze-warnings
For detailed security information, see the main project README.
We welcome contributions! Please see our Contributing Guidelines for details.
- Fork the repository
- Create a feature branch
- Make your changes in the
quantillon-protocoldirectory - Add tests and update documentation
- Submit a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
- Website: quantillon.money
- Documentation: docs.quantillon.money
- X (Twitter): @QuantillonLabs
- Discord: discord.gg/uk8T9GqdE5
- Telegram: @QuantillonLabs
For comprehensive documentation, setup instructions, and development guides, please see:
π quantillon-protocol/README.md
Built with β€οΈ by the Quantillon Labs team
