{"id":26281925,"url":"https://github.com/aviggiano/solidity-audit-report-generator","last_synced_at":"2025-10-25T20:41:35.724Z","repository":{"id":184666303,"uuid":"672281170","full_name":"aviggiano/solidity-audit-report-generator","owner":"aviggiano","description":"Solidity Audit Report Generator","archived":false,"fork":false,"pushed_at":"2023-09-06T16:12:20.000Z","size":5552,"stargazers_count":85,"open_issues_count":1,"forks_count":9,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-31T07:41:32.507Z","etag":null,"topics":["audit","report","solidity","solidity-audit","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=aviggiano.solidity-audit-report-generator","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aviggiano.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-07-29T14:34:42.000Z","updated_at":"2025-02-01T16:41:44.000Z","dependencies_parsed_at":"2023-07-29T15:44:34.780Z","dependency_job_id":null,"html_url":"https://github.com/aviggiano/solidity-audit-report-generator","commit_stats":null,"previous_names":["aviggiano/solidity-audit-report-generator"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aviggiano%2Fsolidity-audit-report-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aviggiano%2Fsolidity-audit-report-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aviggiano%2Fsolidity-audit-report-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aviggiano%2Fsolidity-audit-report-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aviggiano","download_url":"https://codeload.github.com/aviggiano/solidity-audit-report-generator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252833999,"owners_count":21811291,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["audit","report","solidity","solidity-audit","vscode-extension"],"created_at":"2025-03-14T16:17:35.148Z","updated_at":"2025-10-25T20:41:35.649Z","avatar_url":"https://github.com/aviggiano.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# solidity-audit-report-generator\n\nThe Solidity Audit Report Generator is a VS Code extension that automatically generates audit reports based on contest templates, ChatGPT, and `// @audit` comments\n\n## Features\n\nThis extension provides the following key functionalities:\n\n1. Reads `.sol` Solidity 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.\n\n![Example @audit comment](images/example.png)\n\n2. Combines these comments with audit contest templates and uses ChatGPT to generate a detailed audit report.\n\n![Markdown file with report](images/markdown.png)\n\n3. 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.\n\n![XML file with vulnerability information](images/xml.png)\n![ChatGPT prompt file](images/prompt.png)\n\n4. Regenerates a report in case the user wants to change the ChatGPT prompt.\n\n![ChatGPT updated prompt file](images/regenerate.png)\n![Markdown file report updated](images/french.png)\n\n\n5. Generates a report summary\n\n![Report summary](images/summary.png)\n\n6. Generates a finding from predefined issues\n\n![Tags usage](images/tags.png)\n\n\u003e Tip: This extension is best paired with [Solidity Visual Developer](https://marketplace.visualstudio.com/items?itemName=tintinweb.solidity-visual-auditor) by ConsenSys Diligence.\n\n## Requirements\n\nThis extension does not have any specific requirements or dependencies.\n\n## Extension Settings\n\nThis extension contributes the following settings:\n\n* `solidity-audit-report-generator.apiKey`: This setting allows you to enter your OpenAI API key required to query ChatGPT for the report generation.\n\n## Known Issues\n\nNo known issues at this time.\n\n## Release Notes\n\n| Version | Release Notes |\n| --- | --- |\n| 0.0.7 | Sort report summary by severity and issue Id |\n| 0.0.6 | Add tags feature to generate report from predefined issues |\n| 0.0.5 | Include \"Audit: Generate Audit Summary\" command that creates a summary.md file with a markdown table of findings |\n| 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 |\n| 0.0.3 | Improve documentation |\n| 0.0.2 | Add extension icon |\n| 0.0.1 | Initial release of Solidity Audit Report Generator |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faviggiano%2Fsolidity-audit-report-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faviggiano%2Fsolidity-audit-report-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faviggiano%2Fsolidity-audit-report-generator/lists"}