feat: add per-sector audit checklists generator - #1
Merged
Merged
Conversation
Add gen_sector_checklists.js: a re-run-safe Node generator that
aggregates the vuln/trigger/impact/fix taxonomy across findings per
sector and emits ranked, data-driven audit checklists to checklists/.
- 34 sector checklists + index, ranked by finding frequency
- each checklist links representative findings for study
- files named {sector}-checklist.md to avoid an Obsidian basename
collision with classifications/sector/{sector}/{sector}.md
- document in README and crawler README
forefy
approved these changes
Jun 23, 2026
forefy
left a comment
Contributor
There was a problem hiding this comment.
Validated locally:
node --checkpasses (syntax clean)- Fresh run produces byte-identical output to committed files (diff clean)
- Idempotency confirmed on second run
- All 154 finding wikilinks resolve to real files in
findings/ - 2,383 findings processed, 34 checklists written (2 sectors skipped with <5 findings) — matches PR claims
Minor issues noted in review (empty wallet/prediction checklists, non-sorted readdirSync, bump() spread) — none are blockers for merge.
Contributor
Author
|
Hey @forefy, thanks for the review and approval! Really appreciate the feedback and the opportunity to contribute. Looking forward to contributing more in the future and helping strengthen the ecosystem. Security mindset is key 🔑 to building a safer DeFi environment. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
feat: add per-sector audit checklists generator
Summary
Adds
vault-admin/crawler/gen_sector_checklists.js, a re-run-safe Node generator(same conventions as the existing crawler — plain
fs/regex, no new deps) that turnsthe existing finding taxonomy into per-sector audit checklists.
For every sector it aggregates the
vuln/ trigger/ impact/ fixtags across all findingsin that sector, ranks each axis by frequency, and writes
checklists/{sector}-checklist.md,plus a
Sector Checklists.mdindex.Each checklist contains:
Goal: give a junior auditor (or someone bridging from web2 security) a data-driven prior —
open the checklist for a protocol's sector before reading the code.
Stats
Notes
{sector}-checklist.mdto avoid an Obsidian basename collision withclassifications/sector/{sector}/{sector}.mdREADME.mdandvault-admin/crawler/README.mdTest plan
node vault-admin/crawler/gen_sector_checklists.jsruns clean → "Wrote 34 sector checklists"node --checkpasseschecklists/Sector Checklists.mdin Obsidian, confirm wikilinks resolve