Solidity Smart Contract Auditor

This repository contains a Solidity smart contract auditing script that utilizes various tools such as Slither, cspell, Mythril, and OpenAI's GPT-4 to perform comprehensive analysis and identify vulnerabilities.

Features

• Solidity Version Management: Automatically detects and uses the appropriate Solidity compiler version.
• Code Flattening: Flattens Solidity contracts for analysis.
• Static Analysis: Uses Slither to analyze smart contract security.
• Spelling Check: Uses cspell to check coding spelling errors.
• AI-Powered Analysis: Integrates OpenAI's GPT-4 to provide additional insights and combine results from other tools.

TODO

• Add other scanning tools

Prerequisites

Ensure you have the following installed on your system:

• Python 3.x
• pip
• npm

Installation

macOS

Run the installation script for macOS:

```sh
chmod +x install_tools_macos.sh
./install_tools_macos.sh
```

Ubuntu

Run the installation script for Ubuntu:

```sh
chmod +x install_tools_ubuntu.sh
./install_tools_ubuntu.sh
```

Configuration

Update the OPENAI_API_KEY value in main.py with your OpenAI API key:

# Set up your OpenAI API keyOPENAI_API_KEY="your_openai_api_key_here"openai.api_key=OPENAI_API_KEY

Usage

python3 Solai.py path/to/your/contract.sol

Result Interpretation

Viewing the Results

1. Output File: The results of the audit will be saved in a JSON file named final_audit_results.json in the current directory.
2. Example Structure:

[
{
"Issue name": "Reentrancy Vulnerability",
"Severity level": "High",
"Impact of the vulnerability": "Allows attacker to drain funds",
"The vulnerable code snippet": "...",
"Mitigation solution": "Use checks-effects-interactions pattern"
},
...
]