This README was consolidated

The project README has been consolidated into the canonical documentation under docs/.

Kept documents (source of truth):

• docs/protocol-flow.md — protocol flow, deployment and integration (canonical)
• docs/axofi-idea.md — conceptual design and spec
• docs/axofi-yield-mechanics.md — yield mechanics and RWA context
• PRESENTATION_GUIDE.md — demo script and talking points

If you are looking for quickstart, testing, or deployment instructions, open docs/protocol-flow.md.

• axofi-idea.md - Original concept and mechanism design
• axofi-yield-mechanics.md - Yield splitting math

---

🛠️ Tech Stack

Smart Contracts:

• Solidity 0.8.30
• Foundry (testing/deployment)
• OpenZeppelin Contracts v5
• Chainlink Automation v2.3

Frontend:

• Next.js 16 (App Router)
• React 19
• Wagmi 3.x / Viem 2.x
• TailwindCSS 4

Backend:

• TypeScript 5.7
• Viem (Ethereum client)
• Node.js 22

---

🔒 Security

Audited Features

• ✅ Permit-capable deposit path (EIP-2612, token-dependent)
• ✅ Reentrancy protection (OpenZeppelin guards)
• ✅ Integer overflow checks (Solidity 0.8+)
• ✅ Access control (OnlyVault modifiers)

Known Limitations

• ⚠️ No secondary market for PT/YT (roadmap item)
• ⚠️ Keeper is a convenience service (finalization can be automated; user claiming is still user-driven)
• ⚠️ RFQ makers can provide poor quotes (frontend checks minPtOut)

Bug Bounty

Found a vulnerability? Contact: [your-email] or open a private security advisory.

---

🗺️ Roadmap

Phase 1: Core Protocol ✅

• Vault + auction mechanics
• PT/YT token splitting
• RFQ system with EIP-712 quotes
• 45 passing tests

Phase 2: UX Improvements ✅

• EIP-2612 permit support
• Simplified mode selection
• Epoch finalization keeper backend (no auto-claiming)
• Zap contracts for batching

Phase 3: Production Launch 🚧

• Mainnet deployment on Mantle
• Chainlink keeper integration
• Frontend analytics dashboard
• RFQ maker incentive program

Phase 4: Ecosystem 🔮

• Secondary market (AMM for PT/YT)
• Cross-chain support (Arbitrum, Optimism)
• Governance token (veAXO)
• Yield strategy vault aggregator

---

🤝 Contributing

We welcome contributions! Open an issue or PR with a clear description and the relevant tests.

# Fork repo
git clone https://github.com/yourusername/axofi
cd axofi

# Create feature branch
git checkout -b feature/amazing-feature

# Make changes and test
cd contracts && forge test

# Commit and push
git commit -m "Add amazing feature"
git push origin feature/amazing-feature

# Open pull request

---

📄 License

This project is licensed under the MIT License - see LICENSE file.

---

🙏 Acknowledgments

• Pendle Finance - Inspiration for PT/YT mechanics
• Mantle Network - mUSD yield source
• OpenZeppelin - Security primitives
• Foundry - Best Solidity tooling

---

📞 Contact

• Website: axofi.xyz (coming soon)
• Twitter: @AxoFi (coming soon)
• Discord: Join our community (coming soon)
• Email: team@axofi.xyz

---

Built during Mantle Hackathon 2024 🏆