Skip to content

tintinweb/vscode-chonky

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🍣 Chonky - A Superhuman LLM Auditing Agent for Solidity

Chonky is a VS Code extension that transforms GitHub Copilot into a specialized smart contract security auditing agent.

Chonky Logo

Your AI-Powered Smart Contract Auditing Assistant

Version License

Sponsor


VS Code Marketplace:

TLDR;

  • Agent Augmented Auditing
  • Automated Scoping
  • Automated In-Depth Security Analysis
  • Agentic Tooling for Deep Smart Contract Insights
  • Extending Agent capabilities with General Purpose LLM Tooling
  • Your Smart Contract Auditing Side-Kick!

Extends GitHub/Copilot Model Capabilities

πŸš€ Quick Start Guide

image

πŸ’¬ Use Chonky's Tools in Copilots Agentic Mode

Open Copilot Chat β†’ switch to Agent mode β†’ Ask the agent

// list availabler tools
List chonky available llm tools

πŸ’¬ Chat with Chonky

Use Agent mode for day-to-day use. The agent will decide when to invoke any of Chonky's tools. Use the @chonky chat participant for specialized operations.

πŸ“Š Scope Solidity Projects

Generate comprehensive project scoping reports

πŸ€– Agent Automated Audits

Run comprehensive automated security analysis

**@chonky** #autoaudit Full security scan

🎯 Custom Chat Modes

Specialized chat modes for different audit phases

πŸ” Discover Tools

Explore all available features for your tier

πŸ“œ Agentic Auditor Prompt Template

Pre-prompt your action with our agentic security auditor template.

⚑ Early Access / Sponsors / Professional

β™₯️ Sign In for Early Access Features (Sponsors)

Sponsor and get Early Access to experimental future features 😊. Ping me if you run into any problems πŸ€—.

⚑⚑ Custom Agentic Workflows

Ready-to-go Scoping/Auditing workflows, easy to extend and customize.

**@chonky** ...

⚑⚑ Access to a comprehensive list of Security Primers

Get access to our curated list of Solidity security primers to augment and automate your security auditing.

**@chonky** ...

πŸ†• What's New in v0.6.6

✨ Highlights

  • πŸ”§ Improved .chonky Directory Discovery
  • πŸ“ Flexible File Placement Support

πŸš€ Improvements

  • β–Έ Fixed discovery of files in .chonky root directory (e.g., .chonky/xxx.workflow.md)
  • β–Έ Simplified validation logic for better file placement flexibility
  • β–Έ Enhanced workspace resource detection

πŸ†• What's New in v0.6.5

✨ Highlights

  • πŸ“ Auto-Discovery of .chonky Workspace Folders
  • 🎯 Repository Filtering with repositoryId
  • πŸ” Pattern-Based Resource Discovery
  • πŸ“Š Enhanced Discovery Output

🌟 New Features

  • β–Έ Automatic workspace .chonky folder detection for project-specific security resources
  • β–Έ Repository filtering for targeted primer/workflow discovery
  • β–Έ Flexible file extension matching (*.primer.md, .workflow.md, tools/.yml)
  • β–Έ Repository information display in discovery results

πŸš€ Improvements

  • β–Έ Better project-specific security resource management
  • β–Έ Enhanced filtering capabilities for large repositories
  • β–Έ More intuitive workspace-based resource organization

πŸ†• What's New in v0.6.5

✨ Highlights

  • 🎨 Enhanced Visual Code Annotation System
  • 🎯 Accurate Line Targeting with Code Validation
  • πŸ›‘οΈ Advanced Security-Focused Decorations
  • ✨ Custom Styling with Full Validation

πŸ†• What's New in v0.6.0

✨ Highlights

  • πŸš€ Advanced Security Analysis Features
  • πŸ›‘οΈ Enhanced AI-Powered Vulnerability Detection
  • ⚑ Improved Tier-Based Feature Access

🌟 New Features

  • β–Έ Security primer discovery and loading system
  • β–Έ Workflow repository with pre-built analysis templates
  • β–Έ Tool configuration repository access
  • β–Έ Interactive Solidity REPL (Chisel) integration
  • β–Έ Comprehensive differential analysis orchestrator
  • β–Έ AI-powered function similarity detection
  • β–Έ Advanced vulnerability database search
  • β–Έ MetaMask Snap security analysis
  • β–Έ Multi-language scoping (Go, Rust, Solidity)
  • β–Έ Etherscan and Sourcify integration
  • β–Έ Semgrep static analysis integration

πŸš€ Improvements

  • β–Έ Faster contract analysis
  • β–Έ Improved tooltip experience
  • β–Έ Enhanced sponsorship integration

πŸ› οΈ Feature Catalog

πŸ†“ Base Features (21 tools)

Available to everyone

Feature Description
πŸ”Ή Chonky Chat Participant AI-powered @chonky chat participant for intelligent assistance
πŸ”Ή Solidity Metrics & Scoping Comprehensive project analysis and scoping reports
πŸ”Ή Contract Structure Analysis Deep dive into contract architecture and patterns
πŸ”Ή Inheritance Tree Analysis Visualize and analyze inheritance relationships
πŸ”Ή Contract Flattening Flatten complex contract hierarchies
πŸ”Ή Access Control Analysis Identify permission patterns and vulnerabilities
πŸ”Ή Storage Layout Analysis Optimize storage packing and layout
πŸ”Ή Deployable Contract Discovery Find contracts ready for deployment
πŸ”Ή Import Dependency Analysis Map external dependencies and risks
πŸ”Ή External Calls Analysis Map and analyze all external interactions
πŸ”Ή ERC Compliance Checker Verify token standard implementations
πŸ”Ή Semgrep Security Analysis Advanced static analysis with custom rules
πŸ”Ή Surya Visualization Suite Generate graphs and visual contract analysis
πŸ”Ή Solhint Code Quality Automated code quality and style checks
πŸ”Ή JSON Processing Tools Advanced JSON parsing and analysis
πŸ”Ή DateTime Utilities Timestamp and date manipulation tools
πŸ”Ή Memory Store Persistent data storage across sessions
πŸ”Ή Available Tools Discovery Explore all available Chonky capabilities
πŸ”Ή Workspace File Search Intelligent file discovery and search
πŸ”Ή Workspace Integration Auto-discovery of .chonky folders with pattern-based resource matching
πŸ”Ή Editor Decorator Tool Advanced visual code annotation with accurate line targeting and custom styling
πŸ”Ή Diagnostic View Manager Read and create VS Code diagnostics with code snippet validation

⚑ Early Access Features (12 tools)

Available earlier to sponsors

πŸ’‘ Support development to get early access - Become a Sponsor

Feature Description
πŸ”Έ Custom Chat Modes Specialized chat modes for auditing workflows and scoping
πŸ”Έ Solidity REPL (Chisel) Interactive Solidity execution environment
πŸ”Έ Reentrancy Detection Comprehensive reentrancy vulnerability analysis
πŸ”Έ Oracle Risk Analysis Identify oracle manipulation vulnerabilities
πŸ”Έ Event Pattern Analysis Verify event emission completeness
πŸ”Έ Function Similarity Detector AI-powered function pattern matching
πŸ”Έ Inconsistency Reporter Find security pattern discrepancies
πŸ”Έ Differential Analysis Orchestrator Comprehensive security pattern comparison
πŸ”Έ Smart Contract Invariants Verify contract invariant properties
πŸ”Έ Function Analysis Engine Deep function behavior and pattern analysis
πŸ”Έ Contract Call Graph Generator Advanced interaction flow visualization
πŸ”Έ Function Path Tracer Execution path analysis with wildcard selectors

⚑ Professional Features (12 tools)

For security teams and researchers

πŸš€ Professional tools for advanced security research - Upgrade to Professional

Feature Description
⚑ Security Primer Discovery Discover and search security analysis primers
⚑ Security Primer Loading Load comprehensive security primers for AI analysis
⚑ Workflow Repository Access Access pre-built security analysis workflows
⚑ Tool Repository Access Access security tool configurations and templates
⚑ Vulnerability Database Search Query Solodit for known vulnerabilities
⚑ Diligence Vulnerability Database Access ConsenSys Diligence research database
⚑ Go Codebase Scoping Security analysis for Go blockchain projects
⚑ Rust Codebase Scoping Security analysis for Rust blockchain projects
⚑ MetaMask Snap Analysis Comprehensive MetaMask Snap security review
⚑ Etherscan Integration On-chain contract verification and analysis
⚑ Sourcify Integration Source code verification and metadata analysis
⚑ Public Codebase Search Search GitHub for similar contract patterns

πŸ“– Documentation

Getting Started

  1. Install the Extension: Search for "Chonky" in VS Code Extensions
  2. Start Chatting: Use @chonky in any chat window (ask Mode)
  3. Discover Tools: Switch to Copilot Agentic Mode, ask about Chonky's available tools in natural language
  4. Scope Your Project: In Agentic or Scoping Mode, ask to scope the project

Chat Modes

Chonky supports specialized chat modes for different agentic workflows:

  • Scoping - Project scoping and analysis
  • Audit - Security auditing workflows

Tool Categories

  • πŸ”’ Security Analysis: Access control, reentrancy, external calls, oracle analysis
  • πŸ—οΈ Contract Structure: Structure analysis, imports, inheritance, flattening
  • πŸ“Š Code Quality: Events, ERC compliance, functions, invariants
  • 🌐 External Services: Etherscan, Sourcify, vulnerability databases
  • πŸ› οΈ Utilities: Surya graphs, Solhint, scoping, memory store

🎯 Use Cases

Security Auditors

  • Comprehensive vulnerability detection
  • Automated pattern analysis
  • AI-assisted code review
  • Integration with external databases

Development Teams

  • Project scoping and metrics
  • Code quality assurance
  • ERC standard compliance
  • Continuous security monitoring

Security Researchers

  • Advanced vulnerability research
  • Pattern similarity detection
  • Multi-language analysis
  • Custom primer development

πŸ”§ Installation

VS Code Marketplace

  1. Open VS Code
  2. Go to Extensions (Ctrl+Shift+X)
  3. Search for "Chonky"
  4. Click Install

Manual Installation

  1. Download the latest .vsix file from releases
  2. Open VS Code
  3. Run Extensions: Install from VSIX...
  4. Select the downloaded file

🀝 Contributing

We welcome contributions! Here's how you can help:

  1. Report Bugs: Open an issue with detailed information
  2. Feature Requests: Suggest new features or improvements
  3. Documentation: Help improve our docs
  4. Sponsorship: Support development through GitHub Sponsors

Development Setup

git clone https://github.com/tintinweb/vscode-chonky.git
cd chonky
npm install
npm run compile

πŸ’ Support Development

Chonky is developed and maintained by passionate security researchers. Your support helps us:

  • πŸ”¬ Research new vulnerabilities
  • πŸ› οΈ Develop advanced tools
  • πŸ“š Create educational content
  • 🌍 Keep tools free for everyone

Sponsor

Sponsorship Tiers

  • πŸ”Ή Base: Core features for everyone
  • πŸ”Έ Early Access (see Sponsor page): Early access to new features
  • ⚑ Professional (contact me): Advanced research tools

πŸ“„ License & Credits

Created by tintinweb - Security researcher and smart contract auditor with 7+ years in Blockchain security.


πŸ“ž Support & Community


Made with β™₯️ by the security community

🏠 Home β€’ πŸ“– Docs β€’ πŸ’ Sponsor

About

🍣 Chonky - A Superhuman LLM Auditing Agent for Solidity

Topics

Resources

License

Stars

Watchers

Forks

Contributors