Architecture
This comprehensive documentation covers all important smart contracts in the Citadel Finance protocol, a synthetic stablecoin protocol built on the Jarvis Protocol foundation.
🏗️ Architecture Overview
Citadel Finance enables the creation of synthetic EUR from USD stablecoins through a dual-actor liquidity pool system:
- Minters: Deposit USD stablecoins, receive synthetic EUR
- Liquidity Providers: Provide liquidity backing synthetic positions, earn fees and yield
📋 Contract Registry
| Contract | Role | Deployments |
|---|---|---|
| Finder | Service registry and locator | testnet |
| Manager | Access control and governance | testnet |
| MultiLpLiquidityPool | Core liquidity pool logic | testnet |
| ChainlinkPriceFeed | Chainlink oracle implementation | testnet |
| CollateralWhitelist | Approved collaterals | testnet |
| CompoundModule | Compound lending integration | testnet |
| VaultFactory | Vault creation and management | testnet |
| VaultRegistry | Vault registration and tracking | testnet |
| Vault Implementation | Vault logic contract | testnet |
🔄 Documentation Structure
Each contract has its own detailed documentation page covering:
- Purpose & Overview: What the contract does and why it exists
- Key Functions: Detailed function signatures and descriptions
- Access Control: Role-based permissions and security model
- Storage Structure: State variables and data organization
- Events: Emitted events and their purposes
- Integration Points: How it interacts with other contracts
- Usage Examples: Common interaction patterns
- Security Considerations: Important security aspects
🚀 Quick Navigation
Core Protocol
- Finder - Service registry
- Manager - Access control
- MultiLpLiquidityPool - Main pool logic
Oracle System
- ChainlinkPriceFeed - Chainlink integration
Access Control & Whitelisting
- CollateralWhitelist - Approved collaterals
Lending Integration
- CompoundModule - Compound integration
Vault System
- Vault System - Leverage vault implementation
Built on the Jarvis Protocol foundation, Citadel Finance represents a robust synthetic asset platform with advanced DeFi integrations.