# Integration Documentation Index

This directory contains documentation for integrating CompliantUSDT and CompliantUSDC with reserve backing mechanisms and DODO PMM liquidity pools.

## Documentation Files

### Core Documentation

1. **[Complete Integration Guide](./COMPLETE_INTEGRATION_GUIDE.md)**
   - Comprehensive end-to-end implementation guide
   - Architecture overview
   - Phase-by-phase implementation plan
   - Security considerations
   - Monitoring and maintenance

2. **[Reserve Backing Mechanism](./RESERVE_BACKING_MECHANISM.md)**
   - Detailed documentation for StablecoinReserveVault
   - 1:1 backing mechanism
   - Deposit and redemption operations
   - Security and access control

3. **[DODO PMM Integration](./DODO_PMM_INTEGRATION.md)**
   - DODO Proactive Market Maker integration
   - Pool creation and management
   - Liquidity provision
   - Swap operations

4. **[Quick Start Guide](./QUICK_START.md)**
   - Quick reference commands
   - Fast deployment steps
   - Key operations

## Implementation Overview

### Reserve Backing Mechanism

Provides 1:1 backing for compliant tokens with official USDT/USDC:
- Locks official tokens on Ethereum Mainnet
- Mints compliant tokens 1:1
- Enables redemption for official tokens

### DODO PMM Integration

Creates liquidity pools for exchangeability:
- cUSDT ↔ USDT pools
- cUSDC ↔ USDC pools
- Price stability via PMM algorithm
- Efficient liquidity management

## Architecture

```
Ethereum Mainnet (Official Tokens)
  ↓ Lock
StablecoinReserveVault
  ↓ Mint 1:1
Chain 138 (Compliant Tokens)
  ↓
DODO PMM Pools
  ↓ Swap
Exchangeability with Official Tokens
```

## Quick Links

- **Contracts**: `../contracts/reserve/`, `../contracts/dex/`
- **Scripts**: `../../script/reserve/`, `../../script/dex/`
- **Setup Scripts**: `../../scripts/setup-reserve-vault.sh`, `../../scripts/setup-dodo-pools.sh`

## Getting Started

1. Read [Quick Start Guide](./QUICK_START.md) for quick reference
2. Review [Complete Integration Guide](./COMPLETE_INTEGRATION_GUIDE.md) for detailed steps
3. Follow implementation phases
4. Refer to specific documentation as needed

## Support

For detailed information, see:
- Reserve backing: [RESERVE_BACKING_MECHANISM.md](./RESERVE_BACKING_MECHANISM.md)
- DODO integration: [DODO_PMM_INTEGRATION.md](./DODO_PMM_INTEGRATION.md)
- Complete guide: [COMPLETE_INTEGRATION_GUIDE.md](./COMPLETE_INTEGRATION_GUIDE.md)

