Add revert matchers

[fvictorio]

revertedWithPanic

The .revertedWithPanic matcher can be used in two ways:

expect(c.f()).to.be.revertedWithPanic() // reverts with *some* panic
expect(c.f()).to.be.revertedWithPanic(PANIC_CODES.ASSERTION_ERROR)

This is different than revertedWith, which always expects a reason string. I did it that way because adding a reason string to an assertion is quite straightforward, and very useful. On the other hand, adding the proper panic code has more friction, and it seems to me that some users might just want to check that a call panics without checking why.

---

Closes HH-554
Closes HH-579
Closes HH-580
Closes HH-582
Closes HH-583

[linear]

HH-581 .revertedWithPanic

[changeset-bot]

⚠️ No Changeset found

Latest commit: bf50263

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[linear]

HH-554 `.reverted` matcher

HH-579 .revertedWith

HH-580 .revertedWithoutReasonString

[linear]

HH-583 Detect errors that don't come from a reverted transaction, if possible

Something like this will pass now:

await expect(Promise.reject(new Error())).to.be.reverted;

This is important if a transaction fails for some reason unrelated to the actual transaction execution.

One option is to check if there's .data in the Error. But this should be tested both with different ethers.js versions and with geth (and maybe ganache?)

[linear]

HH-582 .revertedWithCustomError

[feuGeneA]

Still not finished reviewing everything, but wanted to ship you the comments I already have.

[feuGeneA]

I love the way you validate the subject in the .reverted matcher, but is there a reason why you don't do that same validation in the other matchers?