foundry-rs/forge-std

feat(StdInvariant): add standard Handler contract for invariant testing

Open

#301 opened on Feb 14, 2023

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Solidity (499 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (1,041 stars)
PR merge metrics
 (Avg merge 12m) (3 merged PRs in 30d)

Description

Let's flesh out a standard handler contract that people can build off of. References:

// src/Handler.sol
contract Handler is CommonBase, StdCheats, StdUtils {
  // TODO Helpers for managing actors/addresses
  // TODO Helpers for call summary data
  // TODO What else?
}

cc @lucas-manuel @horsefacts @gakonst

Contributor guide

Research direction
Study the provided references to understand the standard pattern for invariant testing handlers. Then, implement the Handler contract with the TODO helpers for managing actors/addresses, call summary data, and any other useful utilities.
Tech stack
None
Domain
testing
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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.
Clear
Prerequisites
SolidityFoundry
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75