Await .eventually test matchers

[ernestognw]

Mirror of OpenZeppelin/openzeppelin-community-contracts#54

PR Checklist

• Tests
• Documentation
• Changeset entry (run npx changeset add)

[changeset-bot]

⚠️ No Changeset found

Latest commit: 32750ec

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

[arr00]

If we have to await anyways, what's the point in using eventually? Is it preferred for the await to be at the very start of the statement instead of inside the expect?

[ernestognw]

If we have to await anyways, what's the point in using eventually? Is it preferred for the await to be at the very start of the statement instead of inside the expect?

I'd personally prefer it. Basically we have 2 options:

expect(await something()).to.equal(...)
await expect(something).to.eventually.equal(...)

One thing we could say is that we might prefer consistency. I agree, but that's for another PR imo