stylus-analyzer 0.1.0

AI-powered bug detection tool for Stylus/Rust contracts

Stylus Analyzer

An AI-powered bug detection tool for Stylus/Rust contracts, similar to Slither for Solidity.

Features

• AI-powered analysis of Stylus/Rust contracts using GPT-3 Mini
• Detect potential vulnerabilities and bugs in your contracts
• Support for analyzing entire projects or individual files
• Consider contextual information from README files (optional)
• Save analysis results to files for later review

Installation

From PyPI (not available yet)

pip install stylus-analyzer

From Source

git clone https://github.com/yourusername/stylus-analyzer.git
cd stylus-analyzer
pip install -e .

Configuration

1. Create a .env file in your project directory based on the .env.example:

cp .env.example .env

2. Edit the .env file and add your OpenAI API key:

OPENAI_API_KEY=your_openai_api_key_here

Usage

Analyze a Project

To analyze all Rust contracts in a Stylus project:

stylus-analyzer analyze /path/to/your/project

Analyze a Single File

To analyze a specific Rust contract file:

stylus-analyzer analyze-file /path/to/your/contract.rs

Optional Arguments

• --output or -o: Save analysis results to a file
• --model or -m: Specify the OpenAI model to use (default: gpt-3-mini)
• --verbose or -v: Enable verbose output
• --readme or -r: Specify a README file for additional context (for analyze-file command)

Examples

# Analyze current directory project and save results
stylus-analyzer analyze . --output analysis_results.json

# Analyze a specific file with verbose output
stylus-analyzer analyze-file contracts/MyContract.rs --verbose

# Analyze a specific file with README context
stylus-analyzer analyze-file contracts/MyContract.rs --readme README.md

Future Extensions

This tool is designed to be extended with additional features in the future:

• Static analysis capabilities
• Custom rule definitions
• Integration with development workflows
• Support for other smart contract languages

License

MIT