demobdev / smartaudit Goto Github PK

AuditAI

AuditAI is an innovative tool designed to leverage the power of AI to audit smart contracts. This project uses the OpenAI API to generate detailed audit reports.

1. 🤖 Introduction
2. 🔋 Features
3. ⚙️ Architecture
4. 🤸 Setup and Deployment
5. 🚀 Usage
6. 🤝 Contributing
7. 📜 License

AuditAI provides an easy and efficient way to audit your smart contracts using AI. It interacts with the OpenAI API to analyze and generate detailed reports on the provided smart contract code.

• AI-Powered Auditing: Leverages OpenAI to generate comprehensive audit reports.
• Command Line Tool: Provides a CLI for easy integration into development workflows.
• User-Friendly Interface: Offers an easy-to-use frontend for auditing smart contracts.

1. Command Line Tool: auditai
2. Frontend: React-based user interface
3. API Integration: OpenAI API

• Node.js and npm installed

1. Clone the Repository

git clone https://github.com/yourusername/AuditAI.git
cd AuditAI

2. Install Dependencies

npm install

3. Setup Environment Variables

Create a .env file in the root directory with the following content:

OPENAI_API_KEY=your_openai_api_key

4. Build the Project

npm run build

5. Install the CLI Globally

npm install -g .

1. Analyze a Smart Contract

auditai check <path-to-your-contract-file>

1. Start the Frontend

npm run dev

2. Connect Wallet: Connect your MetaMask wallet to the appropriate network.
3. Submit Contract Code: Paste your smart contract code into the provided textarea and click "Analyze".
4. View Results: After analysis, view the detailed audit report and metrics in the modal that appears.

Contributions are welcome! Please fork the repository and submit a pull request for any improvements or bug fixes.

This project is licensed under the MIT License. See the LICENSE file for details.

This version should display correctly in your README. Adjust any specific details such as image links, repository links, and API keys to match your project.