Skip to content

Commit b8de0ab

Browse files
authored
Update README.md
1 parent a9eda19 commit b8de0ab

1 file changed

Lines changed: 2 additions & 10 deletions

File tree

README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
11
# Setup Helpers
2-
- [ActorManager](#actormanager)
3-
- [AssetManager](#assetmanager)
4-
- [Utils](#utils)
5-
- [Panic](#panic)
6-
- [MockERC20](#mockerc20)
7-
82
These contracts were created with the intention of speeding up the setup process for an invariant testing suite.
93

104
For an example implementation of these contracts in use see the [create-chimera-app](https://github.com/Recon-Fuzz/create-chimera-app-2) repo.
@@ -14,10 +8,10 @@ The `ActorManager` contract serves as the source of truth for actors that are be
148

159
The primary functions of interest when setting up a suite are:
1610
- `_addActor` - allows adding a new address as an actor that can be tracked
17-
- `_switchActor` - allows the fuzzer to change the actor returned by `_getActor`
18-
- this should be exposed in a target function that can be called by the fuzzer to test random combinations of actors calling state changing target functions
11+
- `_switchActor` - this should be exposed in a target function that can be called by the fuzzer to randomly switch between actors
1912

2013
To use the actors stored in the ActorManager, add the `asActor` modifier on all of your target function handlers which pranks as the currently set actor.
14+
2115
For privileged functions you can use the `asAdmin` modifier which calls the target functions as the tester contract (`address(this)`). The tester contract is typically set as the default admin address by convention.
2216

2317
## [AssetManager](https://github.com/Recon-Fuzz/setup-helpers/blob/main/src/AssetManager.sol)
@@ -39,5 +33,3 @@ A library that provides named variables corresponding to compiler panic messages
3933

4034
## [MockERC20](https://github.com/Recon-Fuzz/setup-helpers/blob/main/src/MockERC20.sol)
4135
A minimal `MockERC20` contract that lets you mock any standard ERC20 tokens that will be interacting with the system without requiring external dependencies.
42-
43-

0 commit comments

Comments
 (0)