The Solidity Audit Report Generator is a VS Code extension that automatically generates audit reports based on contest templates, ChatGPT, and // @audit comments
This extension provides the following key functionalities:
- Reads
.solSolidity files in your workspace and scans for comments starting with// @audit-issue. You can add additional information using@tags, such as@recommendation,@references, and any other you like. These will be added to the prompt that will generate the report.
- Combines these comments with audit contest templates and uses ChatGPT to generate a detailed audit report.
- Outputs a XML containing the extracted information from your findings, including additional
@tags from your issue description, a ChatGPT prompt file used to query OpenAI's API, and a markdown file containing the generated report.
- Regenerates a report in case the user wants to change the ChatGPT prompt.
- Generates a report summary
- Generates a finding from predefined issues
Tip: This extension is best paired with Solidity Visual Developer by ConsenSys Diligence.
This extension does not have any specific requirements or dependencies.
This extension contributes the following settings:
solidity-audit-report-generator.apiKey: This setting allows you to enter your OpenAI API key required to query ChatGPT for the report generation.
No known issues at this time.
| Version | Release Notes |
|---|---|
| 0.0.7 | Sort report summary by severity and issue Id |
| 0.0.6 | Add tags feature to generate report from predefined issues |
| 0.0.5 | Include "Audit: Generate Audit Summary" command that creates a summary.md file with a markdown table of findings |
| 0.0.4 | Upgraded VSCode semver to ^1.70.0 per some users not being able to install about 1.80+ being too strict. Included Activation Events |
| 0.0.3 | Improve documentation |
| 0.0.2 | Add extension icon |
| 0.0.1 | Initial release of Solidity Audit Report Generator |