Broken syntax for generated types

I am migrating a truffle project to hardhat/typechain/trufflev5 and apparently typechain is generating types with a broken typescript syntax - the contracts should be compiled correctly as I am able to do that both in a truffle and openzeppelin environment

SyntaxError: '{' expected. (25:37)
  23 |   
  24 |
> 25 |   export interface Committed_address[] {
     |                                     ^
  26 |     name: "Committed"
  27 |     args: {
  28 |     whitelist : (string)[], 

[derekarends]

@krzkaczor Using the sample provided by Riccardo it looks like when there are event overloads and those events have array args the code outputs invalid naming. This doesn’t happen with ethers-v5 because it looks like for ethers we do not try to write both event interfaces in the overloading contract.

From sample:

contract WhitelistedWithGovernance is Whitelisted {
    event Committed(address[] whitelist);
}

contract WhitelistedWithGovernanceAndChangableTimelock is WhitelistedWithGovernance {
    event Committed(uint256 timelock);
}

These contracts for truffle-v5 and for web3-v1 create WhitelistedWithGovernance.d.ts fine but when it attempts to create WhitelistedWithGovernanceAndChangableTimelock.d.ts file containing overloaded interfaces it errors:

export interface Committed_uint256 { ...

export interface Committed_address[] { ...

I wasn’t sure if both interfaces were to be expected or if we should have both interfaces in the types file and it will need to be renamed to something like Committed_address_array.

I am willing to create a PR for this just wasn’t sure what is expected.

[krzkaczor]

@derekarends thanks for investigating this!

I think that we should generate names with explicit names like: Committed_address_array, when conflicting events are detected. We already do something like this for function signatures. And there is even a flag to always generate such overrides: --always-generate-overloads. I think you can use the same flag to control this behavior.