typechain ethers-v5 inclusion of hardhat-ethers

In the newest version of typechain, typechain ethers-5 target include types for the plugin hardhat-ethers

This pose problem for plugin that are alternative to hardhat-ethers like hardhat-deploy-ethers which have different function signature, but use the same hre.ethers object

An option to at least disable hardhat-ethers type generation would be good. AFter all the ethers v5 target should focus on ethers itself.

An alternative would be to create a specific hardhat ethers target

[haydenyoung]

As an outsider, I understand the issue results from the hardhat getContract* types being hardcoded; the hardcoded types are actually in typechain/ethers-v5, dist/congen/hardhat to be precise.

Because hardhat-deploy-ethers exposes new methods (in particular getContract()) and because typechain/ethers-v5 is hardcoding the ethers types, the getContract types are not available and, hence, typechain has no idea what getContract is returning (because the type definition never gets created).

Currently, the hardhat-deploy-ethers plugin deletes hardhat.d.ts which results in all of the getContract* functions having no type definitions.

Is there a way to create the types “on-the-fly” somehow, in order to take advantage of the extended getContract() function? Happy to help if I know I’m interpreting the problem correctly and can be given some guidance in how to potentially solve this issue.

[luisnaranjo733]

As an outsider, I understand the issue results from the hardhat getContract* types being hardcoded; the hardcoded types are actually in typechain/ethers-v5, dist/congen/hardhat to be precise.

Because hardhat-deploy-ethers exposes new methods (in particular getContract()) and because typechain/ethers-v5 is hardcoding the ethers types, the getContract types are not available and, hence, typechain has no idea what getContract is returning (because the type definition never gets created).

Currently, the hardhat-deploy-ethers plugin deletes hardhat.d.ts which results in all of the getContract* functions having no type definitions.

Is there a way to create the types “on-the-fly” somehow, in order to take advantage of the extended getContract() function? Happy to help if I know I’m interpreting the problem correctly and can be given some guidance in how to potentially solve this issue.

So in theory I think it’s possible for hardhat-deploy to ship with Typescript module definition likes (*.d.ts) that could “brute force” overwrite the types but that’s pretty messy

I think it would be better if typechain could offer a way to de-couple itself from the hardhat ethers plugin to support forked plugins (mainly hardhat-deploy). The need for this is growing as other template projects (such as scaffold-eth) now depend internally on hardhat-deploy (which is honestly just a better version that the built in HH plugin).

Unrelated question - are there plans for hardhat-deploy to get unforked with the official HH plugin at some point? Would make the need for fixing this in typechain a lot more clear and present.

One final random note - I’m working around this typechain issue in my hardhat-deploy project by explicitly setting the generic type per the suggestion here. It’s a minor nuisance, but it’s a bummer because Typechain is so cool and it’s so close to just working for hardhat-deploy projects too

https://github.com/wighawag/hardhat-deploy-ethers/issues/23#issuecomment-1101040259