crytic/slither

Parse natspec comments for functions, events, errors, state variables

Open

#1,916 opened on May 15, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (4,769 stars) (886 forks)batch import
enhancementgood first issue

Description

Describe the desired feature

Want to build a detector to detect if natspec comments are missing.

Contributor guide

Tech stack
python
Domain
securitydocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Solidity basicsFamiliarity with Slither's detector frameworkPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Research existing detectors in Slither to understand the detector structure. Look into how natspec comments are stored in the AST (e.g., in the Solidity compiler output or Slither's internal representation). Implement a new detector that checks for missing natspec on functions, events, errors, and state variables. No linked PRs or comments are available.