Skip to content

Commit b601286

Browse files
committed
update readme
1 parent c728fd3 commit b601286

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ contract ERC4626StdTest is ERC4626Test {
7575
_delta_ = 0;
7676
_vaultMayBeEmpty = false;
7777
_unlimitedAmount = false;
78+
_skipRoundTripShares = false;
7879
}
7980
}
8081
```
@@ -85,6 +86,7 @@ Specifically, set the state variables as follows:
8586
- `_delta_`: the maximum approximation error size to be passed to [`assertApproxEqAbs()`]. It must be given as an absolute value (not a percentage) in the smallest unit (e.g., Wei or Satoshi). Note that all the tests are expected to pass with `__delta__ == 0` as long as your vault follows the [preferred rounding direction] as specified in the standard. If your vault doesn't follow the preferred rounding direction, you can set `__delta__` to a reasonable size of rounding errors where the adversarial profit of exploiting such rounding errors stays sufficiently small compared to the gas cost. (You can read our [post] for more about the adversarial profit.)
8687
- `_vaultMayBeEmpty`: when set to false, fuzz inputs that empties the vault are ignored.
8788
- `_unlimitedAmount`: when set to false, fuzz inputs are restricted to the currently available amount from the caller. Limiting the amount can speed up fuzzing, but may miss some edge cases.
89+
- `_skipRoundTripShares`: when set to true, shares inequality assertions in round trip property tests are skipped. This is useful for testing vaults where shares comparison may not yield expected results due to implementation-specific behavior (see issue #13 for examples).
8890

8991
[`assertApproxEqAbs()`]: <https://book.getfoundry.sh/reference/forge-std/assertApproxEqAbs>
9092

0 commit comments

Comments
 (0)