[hardhat-chai-matchers] Add condition in balanceChange

[SevenSwen]

Accurate comparison of balances is not suitable for all user cases. I propose to extend the value of the balanceChange parameter by adding a custom function support.

• Set balanceChange as lamba function

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
hardhat	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 6, 2023 11:10am
hardhat-storybook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 6, 2023 11:10am

[changeset-bot]

🦋 Changeset detected

Latest commit: cf29c78

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@nomicfoundation/hardhat-chai-matchers	Patch

Not sure what this means? Click here to learn what changesets are.

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

[fvictorio]

Hi @SevenSwen, thanks for this. I believe that if we add this, we should also add it to the changeTokenBalances, changeEtherBalance and changeEtherBalances too. Otherwise the API would feel inconsistent. Do you want to do that?

Also, we have a similar feature for event/custom error arguments, and we use the term "predicate" to refer to these functions, so we should do that here too for consistency.

[SevenSwen]

Hi @fvictorio I have done :) If something else needs to be changed / added to the PR, please let me know.

[k06a]

Let's make function with array of changes instead of array of functions, it will be much more powerful.

[SevenSwen]

Okey, I have finished with this case. Unfortunately negated construction doesn't make sense with new predicate, so I had to ban it.

[fvictorio]

Hey, sorry for not reviewing this yet, we've been busy with the Shanghai hardfork and with supporting the new version of ethers. I'll try to make some time this week to look into this. Feel free to ping me if I don't 😅

[SevenSwen]

Hi @fvictorio, you asked to be reminded of this issue. These changes are still relevant to us :)

[fvictorio]

Hey @SevenSwen, thanks for the ping and sorry for not reviewing this sooner.

The code looks pretty good, I only refactored some things and added tests, but I also made a change to how changeEtherBalances and changeTokenBalances work when receiving a predicate. In your implementation, this was just a function that was called, and you could run some assertions inside. But I think it's better to be consistent and to also use a function that returns a boolean.

If that change is fine by you, I'll merge this PR so that we can include it in our next release.

[SevenSwen]

Thanks for your edits @fvictorio! This implementation suits us just fine. We will wait for the release with this PR

[SevenSwen]

up :)

[schaable]

@SevenSwen @k06a I'm closing this in favor of #5219, which is essentially the same but rebased and with some minor wording fixes.