Use ethersjs v6 AddressLike type in hardhat-chai-matchers

[RenanSouza2]

Describe the feature

ethersjs v6 implements a AddressLike type that improoves the UX by allowing to pass an signer or contract object where an address is expected

hardhat-chai-matchers still expects a string for an address so I suggest using the same treatment,

I thought this was implemented in the ethers.io project so I fist opened this issue: ethers-io/ethers.js#4191

Search terms

No response

[fvictorio]

Hi @RenanSouza2, which matchers do you think should support AddressLike values? Some examples would be great.

We accept contracts right now, but maybe this is about expanding those types to allow more general Addressable things.

[RenanSouza2]

In this repository I wrote some examples: https://github.com/RenanSouza2/chai-matchers-example/blob/main/test/Lock.ts

the examples I would like are in comparing returned addresses from contracts to signers

and in the 'withArgs' of events matchers and revertedWithCustomError

[frangio]

We accept contracts right now

Where is this implemented? I can't find it in the code.

[fvictorio]

@RenanSouza2 thanks for the examples. I agree that having those in the .withArgs would be super nice. For the equality matchers is sadly not possible in the general case, because getAddress is async. We could maybe do it with .target but that doesn't work in some cases.

@frangio for example, you can do this:

await expect(foo.inc()).to.changeEtherBalance(foo, 0)

or this:

await expect(foo.inc()).to.changeEtherBalance(await foo.getAddress(), 0)

That's implemented here.

[RenanSouza2]

@RenanSouza2 thanks for the examples. I agree that having those in the .withArgs would be super nice. For the equality matchers is sadly not possible in the general case, because getAddress is async. We could maybe do it with .target but that doesn't work in some cases.

Makes sense, and besides '.target'there could also work with the '.address'of the 'SignerWithAddress' type.

If there is anything I can do to help here, let me know

[Amxx]

#4449 should fix that issue. Open to feedback !