SuiPilot Project Documentation

This directory contains the comprehensive project plan and documentation for the ElizaOS x Sui DeFi Co-Pilot project.

Documentation Structure

📐 Architecture

High-level system design, component interactions, and architectural decisions.

🔌 Protocols

Detailed integration specifications for Sui DeFi protocols (DEX, Lending).

📜 Contracts

Move smart contract specifications, design patterns, and implementation details.

🤖 Agent

ElizaOS agent components, intent parsing, and orchestration logic.

🛠️ Implementation

Development phases, milestones, and implementation guides.

🧪 Testing

Testing strategy, test plans, and quality assurance procedures.

🚀 Deployment

Deployment guides, environment setup, and operational procedures.

🛡️ Risk & Safety

Risk models, safety guardrails, and trust mechanisms.

📋 API

API specifications and interface contracts.

📚 References

Framework documentation and API references for all technologies used in the project.

📋 Use Cases

Detailed use cases for all user interactions and workflows in the system.

Quick Navigation

• Getting Started: Start with Architecture Overview
• Development: See Implementation Roadmap
• Protocol Integration: Check Protocol Integration Guide
• Move Contracts: Review Contract Specifications
• Framework References: Check References for API docs
• Use Cases: See Use Cases for detailed workflows

Project Overview

ElizaOS x Sui DeFi Co-Pilot is an AI agent that orchestrates both existing Sui DeFi protocols and custom Move primitives through natural language, acting as a safe, composable Sui DeFi co-pilot.

For the complete project vision, see Project Idea.