Lemonadeccc/ai_vault

โ˜… 0Forks 0GitHub โ†—Compare

Project website โ†—

README

๐Ÿ— AI Vault Project

A smart DeFi asset management platform built on Scaffold-ETH 2

๐Ÿš€ AI Vault Project Overview

AI Vault is a decentralized finance (DeFi) project built on Scaffold-ETH 2, designed to provide users with intelligent asset management services. The project uses AI agents to manage investment strategies and allocate funds to different DeFi protocols to generate returns.

Core Features

  • ๐Ÿ’ฐ Smart Vault Management: Share-based investment vaults based on ERC-4626 standard
  • ๐Ÿค– AI Agent Control: AI agents automatically manage investment strategies and asset allocation
  • ๐Ÿ”„ Multi-protocol Support: Integrates mainstream DeFi protocols like Aave, Uniswap V2/V3
  • ๐Ÿ’Ž ETH Support: Direct deposit and conversion support for ETH and WETH
  • ๐Ÿ›ก๏ธ Security Assurance: Reentrancy attack protection, access control, and parameter validation
  • ๐Ÿ“Š Real-time Monitoring: Complete test suite and integration tests

Tech Stack

โš™๏ธ Built with NextJS, RainbowKit, Foundry, Wagmi, Viem and Typescript

  • โœ… Contract Hot Reload: Frontend automatically adapts when you edit smart contracts
  • ๐Ÿช Custom Hooks: Collection of React hooks around wagmi
  • ๐Ÿงฑ Components: Collection of common web3 components
  • ๐Ÿ”ฅ Burner Wallet and Local Faucet: Quick testing of applications
  • ๐Ÿ” Wallet Provider Integration: Connect different wallet providers

System Requirements

Before starting, you need to install the following tools:

Quick Start

To get started with Scaffold-ETH 2 and the AI Vault project, follow these steps:

1. Install Dependencies

git clone https://github.com/KamisAyaka/ai_vault.git
cd ai_vault
yarn install

2. Start Local Network

Run in the first terminal:

yarn chain

This command starts a local Ethereum network using Foundry. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in packages/foundry/foundry.toml.

3. Deploy AI Vault Contracts

In the second terminal, deploy the AI Vault system:

# Deploy complete AI Vault system
yarn deploy --file DeployAIVault.s.sol

# Or deploy basic test contracts
yarn deploy

This command deploys the AI Vault smart contracts to the local network. The contracts are located in packages/foundry/contracts and can be modified as needed. The yarn deploy command uses deployment scripts located in packages/foundry/script to deploy contracts to the network.

4. Start Frontend Application

In the third terminal, start your NextJS application:

yarn start

Visit your application: http://localhost:3000. You can use the Debug Contracts page to interact with your smart contracts. You can adjust application configuration in packages/nextjs/scaffold.config.ts.

๐Ÿ“š Learn More

System Architecture and Working Principles

To learn more about the technical details of AI Vault's system architecture, core components, workflow, etc., please check DEVELOPMENT_EN.md

Scaffold-ETH 2 Documentation

Visit Scaffold-ETH 2 Documentation to learn more about development features and best practices.

๐Ÿ“„ License

This project is open source under the MIT license.

๐Ÿ“ž Contact

For questions or suggestions, please contact through:


Note: This project is still under development, please conduct thorough testing before using in production.

Contributors

KamisAyakaLemonadecccHuggin423

Issues