crytic/slither

Slither-log

Open

#797 opened on Mar 4, 2021

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (886 forks)batch import
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (4,769 stars)
PR merge metrics
 (Avg merge 54d 9h) (2 merged PRs in 30d)

Description

Create a tool for debugging hardhat project that

  • Add console.log at every function/modifier entry point, with the canonical name of the function, and the function parameters
  • Add console.log at every end of the function/modifier, with the canonical name of the function, and the return values

Potential flags

  • --only contract/function
  • --exclude contract/function
  • --force-patch patch the codebase directly (default behavior would probably to create a git patch)

Contributor guide

Research direction
Explore Slither's existing passes and IR to understand how to insert console.log statements at function entry/exit points. Look at how Slither handles Hardhat projects and generates patches. Consider using Slither's intermediate representation to add instrumentation.
Tech stack
python
Domain
toolingbackend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSlitherSolidity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65