meta(cheatcodes): tracking issue for cheatcode improvements

[mds1]

Component

Forge

Describe the feature you would like

This issue tracks general cheatcode improvements. Items are roughly ordered by my opinion of priority, both at the header-level and the bullet-level. I say "roughly ordered" because some items are much bigger scope than others so having a strict ordering doesn't make much sense.

Refactors, Higher Priority

• Negations for all vm.exect* cheats: feat(cheatcodes): add negative assertions for expectEmit and expectRevert using count syntax #509 — potential alternative UX is mockCall count #4513
• feat(cheatcodes): show detailed reverts regardless of verbosity level defined #928
• Disallow some cheatcodes for precompiles #1159
• Fix expectRevert issues:
  • Forge doesn't work with multiple "vm.expectRevert" when testing free functions #3723
  • Test function early returns after vm.expectRevert #3437
  • bug(forge): vm.expectRevert without external call makes assertEq pass #4832
• snapshot/revert soundess issues: Test reverts with Assertion failed. when reverting to a fork snapshot, without any assertion #3792, bug: snapshot/revertTo causes tests to pass unexpectedly #3055 (comment)

Medium Priority

• All expect* cheats should only apply to the next call: bug: expectEmit and expectCall don't only check the next call #1745
• forge test/forge script: throw when ffi fails #2932
• feat: vm.confirmContinue cheat code #2399
• feat(cheatcodes): ability to capture and store state diffs #2846
• feat(cheatcode): add vm.waitForTransaction for getting tx and receipt info in scripts #3589
• Add rpc cheatcode: integrate cast rpc as cheatcode #3362
• Add a vm.mockCallRevert cheatcode #2740
• vm.skipTest(bool) cheat: Function Modifier or an Opcode to mark a test as skipped conditionally #1123
• feat(cheatcodes): add vm.delegatePrank to execute a delegatecall in the context of the pranked address #824 (comment)
• feat (cheatcode) TOML support #4808
• Ability to detect different "environments" in scripts/tests #2900
• feat(forge): cheatcode for getting the current prank #4875
• feat(forge): exclude certain contracts from being eavesdropped on by vm.expectRevert #4762
• vm.canRevert(): allow tests to revert in expected cases #4090
• feat(cheatcodes): add vm.storeTransient and vm.loadTransient #8165

Lower Priority

• Add vm.assertContains with overloads (String, etc..) #4859
• Cheatcode: EIP712 canonical hashing #4818
• feat(forge): Cheatcode to receive public key of private key #4790
• vm.cool cheatcode #1340
• Support JUMPs instead of just CALLs for cheats that currently operate on CALLs (ref bug: mockCall not working as expected #432, expectRevert cheat code doesn't work for internal calls #864, vm.prank design comment #1454), such as prank, mockCall, expect*
• Ability to write to packed slots and writing vars that take up multiple slots, like strings: Cannot find the storage slot for a public string variable #3869
• feat(cheatcodes): support partial matching of custom errors in reverts #3725
• feat: vm.mineSalt cheat code #2359
• feat(forge): Solidity cheat to find and replace text in bytes and string variables #4789
• More specific error messages for "EvmError" #4012
• feat(cheatcodes): support additional cheatcodes to aid in symbolic testing #4072

Additional context

No response

[PaulRBerg]

Can we bump the priority of #4762 up to "Medium"?

1. It's a subtle cause for failing tests, which can result in long-winded debugging sessions.
2. For complex code bases with many test contracts, it is frustrating to have to ensure that certain dummy contracts are never considered for reverts. The refactors required to skirt around this limitation can be non-trivial.