Edit: Update README.md

Author: Neros0

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CentoAI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,79 +1,145 @@
 # CentoAI: AI-Powered DeFi Portfolio Manager
 
-![CentoAI Logo](https://via.placeholder.com/150) <!-- Replace with logo -->
+![CentoAI Logo](https://via.placeholder.com/150) <!-- Replace with your logo -->
 
-CentoAI is an AI-powered DeFi portfolio manager that optimizes yield farming by dynamically reallocating funds across top DeFi protocols. Built using **Coinbase AgentKit**, **Warden Protocol**, and **Lit Protocol**, CentoAI automates strategy execution securely on **Base** for maximum yield efficiency.
+**CentoAI** is an AI-powered DeFi portfolio manager that optimizes yield farming and flash loan arbitrage across top DeFi protocols like **Aave**, **Compound**, and **Uniswap V3**. Built using **Coinbase AgentKit**, **Warden Protocol**, and deployed on **Base**, CentoAI automates fund management and strategy execution to maximize user returns.
 
 ---
 
 ## 🚀 Features
 
-- **AI-Driven Yield Optimization**: Dynamically reallocates funds to the highest-yielding opportunities across DeFi protocols like Aave, Compound, and Uniswap.
-- **On-Chain Automation**: Uses **Warden Protocol** to automate fund movements based on real-time APY data.
-- **Secure Execution**: Leverages **Lit Protocol** for secure transaction signing and non-custodial key management.
+- **AI-Driven Yield Optimization**: Dynamically reallocates funds to the highest-yielding opportunities across DeFi protocols.
+- **Flash Loan Arbitrage**: Executes arbitrage strategies using **Balancer V2** flash loans for risk-free profits.
+- **Multi-Protocol Integration**: Supports **Aave**, **Compound**, **Uniswap V3**, and **Balancer V2**.
+- **On-Chain Automation**: Uses **Coinbase AgentKit** to automate fund movements and strategy execution.
+- **User-Friendly Vaults**: Each user gets a personalized vault to deposit funds and set strategies.
 - **Base Deployment**: Deployed on **Base** for low-cost, high-speed transactions.
-- **User-Friendly Interface**: Built with **OnchainKit** for seamless wallet integration and portfolio management.
 
 ---
 
 ## 🛠️ Tech Stack
 
 - **Core Framework**: [Coinbase AgentKit](https://developer.coinbase.com/agentkit)
 - **Automation**: [Warden Protocol](https://wardenprotocol.org)
-- **Security**: [Lit Protocol](https://litprotocol.com)
-- **Blockchain**: [Base](https://base.org)
-- **Frontend**: React + OnchainKit
+- **Blockchain**: [Base](https://base.org), [Arbitrum](https://arbitrum.io)
+- **Frontend**: Next.js + OnchainKit
 - **Backend**: Node.js
+- **Smart Contracts**: Solidity (Foundry for testing and deployment)
 
 ---
 
-## 📊 How It Works
+## 🏗️ Architecture Overview
 
-1. **Data Aggregation**:  
-   - Fetch real-time APY data from DeFi protocols (e.g., Aave, Compound, Uniswap).  
-   - Use **Warden Protocol** to monitor and analyze yield opportunities.
+CentoAI is built on a modular architecture, with the following key components:
 
-2. **AI Decision Engine**:  
-   - Analyze yield opportunities using machine learning models.  
-   - Determine optimal fund reallocation based on risk-adjusted returns.
+### 1. **Smart Contracts**
+   - **LiquidityManager.sol**: Manages liquidity across **Aave**, **Compound**, and **Uniswap V3**.
+   - **Arbitrage.sol**: Executes flash loan arbitrage strategies using **Balancer V2**.
+   - **Vault.sol**: Manages user balances and strategy execution.
+   - **VaultFactory.sol**: Deploys personalized vaults for users.
 
-3. **Secure Execution**:  
-   - **Lit Protocol** enforces policies (e.g., "only execute if APY > X%").  
-   - **Coinbase AgentKit** handles on-chain actions (e.g., deposits, withdrawals, swaps).
+### 2. **Frontend**
+   - Built with **Next.js** and **OnchainKit** for seamless wallet integration and portfolio visualization.
+   - Provides a user-friendly dashboard for monitoring portfolio performance and strategy execution.
 
-4. **User Interface**:  
-   - A dashboard displays portfolio performance, strategy configurations, and transaction history.  
-   - Built with **React** and **OnchainKit** for seamless wallet integration.
+### 3. **Backend**
+   - **Node.js** backend for handling off-chain computations and API integrations.
+   - Fetches real-time APY data from DeFi protocols and provides it to the AI agent.
+
+### 4. **AI Agent**
+   - Analyzes yield opportunities and arbitrage strategies using machine learning models.
+   - Executes strategies securely using **Coinbase AgentKit** and **Warden Protocol**.
 
 ---
 
-## 🏆 Sponsor Tracks
+## 🔧 Workflows
 
-CentoAI is designed to compete in the following **ETHGlobal Agentic Ethereum** tracks:
+### 1. **User Onboarding**
+   - Users connect their wallets to the CentoAI platform.
+   - A personalized vault is deployed for the user using **VaultFactory.sol**.
+   - Users deposit ERC20 tokens (e.g., USDC, ETH) into their vault.
 
-### 🟩 Core Tracks
-1. **Coinbase Developer Platform**  
-   - Most Innovative Use of AgentKit  
-   - Best Combination of AgentKit + OnchainKit  
-   - Viral Consumer App Award  
-   - AgentKit Pool Prize  
+### 2. **AI-Driven Strategy Execution**
+   - The AI agent fetches real-time APY data from **Aave**, **Compound**, and **Uniswap V3**.
+   - It analyzes yield opportunities and identifies arbitrage opportunities using **Balancer V2** flash loans.
+   - The AI agent executes strategies such as:
+     - **Yield Farming**: Moves funds between protocols to maximize APY.
+     - **Flash Loan Arbitrage**: Executes risk-free arbitrage between DEXes.
 
-2. **Base**  
-   - Build an AI-Powered App on Base  
+### 3. **Portfolio Management**
+   - Users can monitor their portfolio performance, strategy execution, and transaction history through the dashboard.
+   - The dashboard provides insights into:
+     - Current APY across protocols.
+     - Profit/loss from arbitrage strategies.
+     - Historical performance of the portfolio.
 
-3. **Lit Protocol**  
-   - Best DeFAI Agent  
-   - Most Creative Integration  
-   - Pool Prize  
+---
 
-4. **Warden Protocol**  
-   - Best Use of Warden Protocol for On-Chain Automation  
+## 🧩 Smart Contracts
+
+### 1. **LiquidityManager.sol**
+   - Manages liquidity across **Aave**, **Compound**, and **Uniswap V3**.
+   - Key Functions:
+     - `supplyLiquidityOnAave`: Supplies liquidity to Aave.
+     - `withdrawLiquidityFromCompound`: Withdraws liquidity from Compound.
+     - `swapOnUniswap`: Executes token swaps on Uniswap V3.
+
+### 2. **Arbitrage.sol**
+   - Executes flash loan arbitrage strategies using **Balancer V2**.
+   - Key Functions:
+     - `executeTrade`: Initiates a flash loan and executes arbitrage.
+     - `receiveFlashLoan`: Callback function for flash loan execution.
+
+### 3. **Vault.sol**
+   - Manages user balances and strategy execution.
+   - Key Functions:
+     - `depositERC20`: Deposits ERC20 tokens into the vault.
+     - `withdrawERC20`: Withdraws ERC20 tokens from the vault.
+     - `lendTokens`: Lends tokens to **Aave** or **Compound**.
+
+### 4. **VaultFactory.sol**
+   - Deploys personalized vaults for users.
+   - Key Functions:
+     - `createVault`: Deploys a new vault for a user.
+     - `getVaultAddress`: Retrieves the vault address for a user.
 
 ---
 
-## 🚨 Disclaimer
+## 🛠️ Integration Details
+
+### 1. **Coinbase AgentKit**
+   - Used for secure, programmatic wallet interactions.
+   - Enables the AI agent to execute on-chain actions (e.g., deposits, withdrawals, swaps).
+
+### 2. **Warden Protocol**
+   - Used for automating on-chain actions and enforcing strategy rules.
+   - Ensures that strategies are executed only when predefined conditions are met.
+
+### 3. **Base and Arbitrum**
+   - CentoAI is deployed on **Base** and **Arbitrum** for low-cost, high-speed transactions.
+   - Supports yield farming and arbitrage strategies on both networks.
+
+---
 
-CentoAI is a proof-of-concept project built for the ETHGlobal Agentic Ethereum hackathon. It is not audited and should not be used in production. Use at your own risk.
+## 🏆 Sponsor Tracks
+
+CentoAI is designed to compete in the following **ETHGlobal Agentic Ethereum** tracks:
+
+### **Coinbase Developer Platform**
+- **Most Innovative Use of AgentKit**: CentoAI uses AgentKit to automate complex DeFi strategies, abstracting away the complexity for users.
+- **Best Combination of AgentKit + OnchainKit**: The frontend integrates **OnchainKit** for seamless wallet interactions and portfolio visualization.
+- **Viral Consumer App Award**: CentoAI’s user-friendly interface and AI-driven strategies make it accessible to both DeFi experts and beginners.
+- **AgentKit Pool Prize**: CentoAI is build with AgentKit in a meaningful way for users to interact with the DeFi ecosystem.
+
+### **Base**
+- **Build an AI-Powered App on Base**: CentoAI is deployed on **Base**, leveraging its low-cost, high-speed infrastructure for seamless DeFi operations.
+
+### **Warden Protocol**
+- **Agents with Best DeFi Skills**: CentoAI uses **Warden Protocol** to automate on-chain actions and enforce strategy rules (e.g., "only execute if APY > X%").
+- **Intelligent Integrations**: CentoAI integrates **Warden Protocol** with an AI-driven decision engine to create a unique toolkit for DeFi portfolio management. The AI agent uses **Warden Protocol** to deploy smart contracts, exposing strategy execution functions (e.g., `executeYieldFarming`, `executeArbitrage`) as callable tools.
+
+### **Arbitrum**
+- **Most Innovative AI Agent Applications**: CentoAI combines yield farming and flash loan arbitrage to push the boundaries of DeFi automation.
 
 ---
 
@@ -118,16 +184,16 @@ contracts/
     ```
 
 4. Deploy the contract to the Base Sepolia Testnet:
-    ```bash
-    forge script script/DeployArbitrage.s.sol:DeployArbitrage <BASE_SEPOLIA_RPC_URL> --private-key <PRIVATE_KEY> --broadcast --verify --verifier blockscout --verifier-url https://base-sepolia.blockscout.com/api/
-    ```
    ```bash
-    forge script script/DeployLiquidityManager.sol:DeployLiquidityManager <BASE_SEPOLIA_RPC_URL> --private-key <PRIVATE_KEY> --broadcast --verify --verifier blockscout --verifier-url https://base-sepolia.blockscout.com/api/
+    forge script script/DeployVaultFactory.sol:DeployVaultFactory <BASE_SEPOLIA_RPC_URL> --private-key <PRIVATE_KEY> --broadcast --verify --verifier blockscout --verifier-url https://base-sepolia.blockscout.com/api/
     ```
+
+   Deploy the contract to the Arbitrum Sepolia Testnet:
    ```bash
-    forge script script/DeployLiquidityManager.sol:DeployLiquidityManager <BASE_SEPOLIA_RPC_URL> --private-key <PRIVATE_KEY> --broadcast --verify --verifier blockscout --verifier-url https://base-sepolia.blockscout.com/api/
+    forge script script/DeployVaultFactory.sol:DeployVaultFactory <ARBITRUM_SEPOLIA_RPC_URL> --private-key <PRIVATE_KEY> --broadcast --verify --verifier blockscout --verifier-url https://arbitrum-sepolia.blockscout.com/api/
     ```
 
+
 ## Testing
 Foundry is used for testing the Arbitrage contract. To run the tests:
 
@@ -138,13 +204,40 @@ Foundry is used for testing the Arbitrage contract. To run the tests:
     forge test
     ```
 
+---
+
+## 🚨 Disclaimer
+
+CentoAI is a proof-of-concept project built for the **ETHGlobal Agentic Ethereum** hackathon. It is not audited and should not be used in production. Use at your own risk.
+
+---
+
 ## 🤝 Contributing
+
 Contributions are welcome! Please open an issue or submit a pull request.
 
+---
+
 ## 📄 License
-This project is licensed under the MIT License. See LICENSE for details.
+
+This project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.
+
+---
 
 ## 🙏 Acknowledgments
-ETHGlobal for hosting the Agentic Ethereum hackathon.
 
-Coinbase, Base, Lit Protocol, and Warden Protocol for their support and tooling.
+- **ETHGlobal** for hosting the **Agentic Ethereum** hackathon.
+- **Coinbase**, **Base**, **Warden Protocol**, and **Arbitrum** for their support and tooling.
+
+---
+
+## 📸 Visuals (Placeholder)
+
+### **Dashboard Overview**
+![Dashboard](https://via.placeholder.com/800x400) <!-- Replace with actual dashboard screenshot -->
+
+### **Vault Management**
+![Vault](https://via.placeholder.com/800x400) <!-- Replace with actual vault screenshot -->
+
+### **Strategy Execution**
+![Strategy](https://via.placeholder.com/800x400) <!-- Replace with actual strategy execution screenshot -->