fix(cheatcodes): clarify vm.expectRevert error message

[nathanhleung]

Motivation

One of my tests which called vm.expectRevert() was failing with FAIL. Reason: call did not revert as expected, even though it was still reverting (with the expected reason) when I removed the call to vm.expectRevert(); for a while, I couldn't figure out why.

It took me a bit of time before realizing that the docs specify that vm.expectRevert() must be placed immediately before the call that is expected to revert. Part of my confusion was that I had another test that had a call to vm.expectRevert() followed by vm.prank(), and calls to other cheatcodes are ignored (so because that test was working, I thought I could just put vm.expectRevert() at the top of the test).

https://book.getfoundry.sh/cheatcodes/expect-revert

Solution

I updated the error message in the vm.expectRevert() cheatcode implementation to specify that failures are because the next call did not revert as expected. This wording also more closely matches the emphasis in the Foundry book docs.

[mattsse]

this seems more useful, wdyt @klkvr

[nathanhleung]

bump @klkvr

[klkvr]

makes sense, this would make errors less confusing