Multiple struct inputs with same name (#576)

Co-authored-by: hasparus <hasparus@gmail.com>
Co-authored-by: Krzysztof Kaczor <krzkaczor@gmail.com>

Author: 3 people

Diff for: .changeset/pretty-waves-leave.md

@@ -0,0 +1,6 @@
+---
+'@typechain/ethers-v5': major
+'typechain': major
+---
+
+Structs will be namespaced using contract name when available

Diff for: contracts/v0.6.4/DataTypesInput.sol

@@ -70,4 +70,23 @@ contract DataTypesInput {
   function input_struct2_tuple(Struct2[3] memory input) public pure returns (Struct2[3] memory) {
     return input;
   }
+
+  function input_multiple_structs_with_same_name(StructsLib1.Info memory info1) public pure returns (StructsLib2.Info memory info2) {
+    info2.a = address(info1.a);
+    info2.b = address(info1.b);
+  }
 }
+
+library StructsLib1 {
+  struct Info {
+    uint160 a;
+    uint160 b;
+  }
+}
+
+library StructsLib2 {
+  struct Info {
+    address a;
+    address b;
+  }
+}

Diff for: package.json

@@ -37,7 +37,7 @@
     "@types/mocha": "^8.2.1",
     "@typescript-eslint/eslint-plugin": "4.15.1",
     "@typescript-eslint/parser": "4.15.1",
-    "earljs": "^0.1.10",
+    "earljs": "^0.1.12",
     "eslint": "^7.29.0",
     "eslint-config-typestrict": "^1.0.2",
     "eslint-plugin-import": "^2.23.4",

Diff for: packages/hardhat-test/typechain-types/Demo.ts

@@ -6,19 +6,21 @@ import { BaseContract, BigNumber, BigNumberish, Signer, utils } from "ethers";
 import { Listener, Provider } from "@ethersproject/providers";
 import { TypedEventFilter, TypedEvent, TypedListener, OnEvent } from "./common";
 
-export type Struct1Struct = { a: BigNumberish; b: BigNumberish };
+export declare namespace Demo {
+  export type Struct1Struct = { a: BigNumberish; b: BigNumberish };
 
-export type Struct1StructOutput = [BigNumber, BigNumber] & {
-  a: BigNumber;
-  b: BigNumber;
-};
+  export type Struct1StructOutput = [BigNumber, BigNumber] & {
+    a: BigNumber;
+    b: BigNumber;
+  };
 
-export type Struct2Struct = { a: BigNumberish; b: BigNumberish };
+  export type Struct2Struct = { a: BigNumberish; b: BigNumberish };
 
-export type Struct2StructOutput = [BigNumber, BigNumber] & {
-  a: BigNumber;
-  b: BigNumber;
-};
+  export type Struct2StructOutput = [BigNumber, BigNumber] & {
+    a: BigNumber;
+    b: BigNumber;
+  };
+}
 
 export interface DemoInterface extends utils.Interface {
   contractName: "Demo";

Diff for: packages/hardhat-test/typechain-types/factories/Demo__factory.ts

@@ -3,12 +3,7 @@
 /* eslint-disable */
 import { Signer, utils, Contract, ContractFactory, Overrides } from "ethers";
 import { Provider, TransactionRequest } from "@ethersproject/providers";
-import type {
-  Demo,
-  DemoInterface,
-  Struct1Struct,
-  Struct2Struct,
-} from "../Demo";
+import type { Demo, DemoInterface } from "../Demo";
 
 const _abi = [
   {
@@ -75,15 +70,15 @@ export class Demo__factory extends ContractFactory {
   }
 
   deploy(
-    input1: Struct1Struct,
-    input2: Struct2Struct[],
+    input1: Demo.Struct1Struct,
+    input2: Demo.Struct2Struct[],
     overrides?: Overrides & { from?: string | Promise<string> }
   ): Promise<Demo> {
     return super.deploy(input1, input2, overrides || {}) as Promise<Demo>;
   }
   getDeployTransaction(
-    input1: Struct1Struct,
-    input2: Struct2Struct[],
+    input1: Demo.Struct1Struct,
+    input2: Demo.Struct2Struct[],
     overrides?: Overrides & { from?: string | Promise<string> }
   ): TransactionRequest {
     return super.getDeployTransaction(input1, input2, overrides || {});

Diff for: packages/target-ethers-v4-test/types/DataTypesInput.d.ts

@@ -38,6 +38,10 @@ interface DataTypesInputInterface extends Interface {
       encode([input1]: [BigNumberish]): string;
     }>;
 
+    input_multiple_structs_with_same_name: TypedFunctionDescription<{
+      encode([info1]: [{ a: BigNumberish; b: BigNumberish }]): string;
+    }>;
+
     input_stat_array: TypedFunctionDescription<{
       encode([input1]: [BigNumberish[]]): string;
     }>;
@@ -190,6 +194,16 @@ export class DataTypesInput extends Contract {
       overrides?: UnsignedTransaction
     ): Promise<number>;
 
+    input_multiple_structs_with_same_name(
+      info1: { a: BigNumberish; b: BigNumberish },
+      overrides?: UnsignedTransaction
+    ): Promise<[string, string] & { a: string; b: string }>;
+
+    "input_multiple_structs_with_same_name((uint160,uint160))"(
+      info1: { a: BigNumberish; b: BigNumberish },
+      overrides?: UnsignedTransaction
+    ): Promise<[string, string] & { a: string; b: string }>;
+
     input_stat_array(
       input1: BigNumberish[],
       overrides?: UnsignedTransaction
@@ -461,6 +475,16 @@ export class DataTypesInput extends Contract {
     overrides?: UnsignedTransaction
   ): Promise<number>;
 
+  input_multiple_structs_with_same_name(
+    info1: { a: BigNumberish; b: BigNumberish },
+    overrides?: UnsignedTransaction
+  ): Promise<[string, string] & { a: string; b: string }>;
+
+  "input_multiple_structs_with_same_name((uint160,uint160))"(
+    info1: { a: BigNumberish; b: BigNumberish },
+    overrides?: UnsignedTransaction
+  ): Promise<[string, string] & { a: string; b: string }>;
+
   input_stat_array(
     input1: BigNumberish[],
     overrides?: UnsignedTransaction
@@ -734,6 +758,16 @@ export class DataTypesInput extends Contract {
       overrides?: UnsignedTransaction
     ): Promise<BigNumber>;
 
+    input_multiple_structs_with_same_name(
+      info1: { a: BigNumberish; b: BigNumberish },
+      overrides?: UnsignedTransaction
+    ): Promise<BigNumber>;
+
+    "input_multiple_structs_with_same_name((uint160,uint160))"(
+      info1: { a: BigNumberish; b: BigNumberish },
+      overrides?: UnsignedTransaction
+    ): Promise<BigNumber>;
+
     input_stat_array(
       input1: BigNumberish[],
       overrides?: UnsignedTransaction

Diff for: packages/target-ethers-v4-test/types/factories/DataTypesInput__factory.ts

@@ -150,6 +150,49 @@ const _abi = [
     stateMutability: "pure",
     type: "function",
   },
+  {
+    inputs: [
+      {
+        components: [
+          {
+            internalType: "uint160",
+            name: "a",
+            type: "uint160",
+          },
+          {
+            internalType: "uint160",
+            name: "b",
+            type: "uint160",
+          },
+        ],
+        internalType: "struct StructsLib1.Info",
+        name: "info1",
+        type: "tuple",
+      },
+    ],
+    name: "input_multiple_structs_with_same_name",
+    outputs: [
+      {
+        components: [
+          {
+            internalType: "address",
+            name: "a",
+            type: "address",
+          },
+          {
+            internalType: "address",
+            name: "b",
+            type: "address",
+          },
+        ],
+        internalType: "struct StructsLib2.Info",
+        name: "info2",
+        type: "tuple",
+      },
+    ],
+    stateMutability: "pure",
+    type: "function",
+  },
   {
     inputs: [
       {

Diff for: packages/target-ethers-v5-test/test/DataTypesInput.test.ts

@@ -4,17 +4,16 @@ import { Awaited } from 'earljs/dist/mocks/types'
 import { BigNumber, BigNumberish, ethers } from 'ethers'
 import { AssertTrue, IsExact, q18, typedAssert } from 'test-utils'
 
-import {
-  DataTypesInput,
-  Struct1Struct,
-  Struct1StructOutput,
-  Struct2Struct,
-  Struct2StructOutput,
-  Struct3Struct,
-  Struct3StructOutput,
-} from '../types/DataTypesInput'
+import { DataTypesInput } from '../types/DataTypesInput'
 import { createNewBlockchain, deployContract } from './common'
 
+type Struct1Struct = DataTypesInput.Struct1Struct
+type Struct1StructOutput = DataTypesInput.Struct1StructOutput
+type Struct2Struct = DataTypesInput.Struct2Struct
+type Struct2StructOutput = DataTypesInput.Struct2StructOutput
+type Struct3Struct = DataTypesInput.Struct3Struct
+type Struct3StructOutput = DataTypesInput.Struct3StructOutput
+
 describe('DataTypesInput', () => {
   let contract!: DataTypesInput
   let ganache: any
@@ -257,6 +256,28 @@ describe('DataTypesInput', () => {
     })
   })
 
+  it('structs with same name in different contract/library: input test', async () => {
+    type ViewFunctionInputType = Parameters<typeof contract.input_multiple_structs_with_same_name>
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    type _t1 = AssertTrue<
+      IsExact<
+        ViewFunctionInputType,
+        [info1: { a: BigNumberish; b: BigNumberish }, overrides?: ethers.CallOverrides | undefined]
+      >
+    >
+
+    type ViewFunctionOutputType = Awaited<ReturnType<typeof contract.input_multiple_structs_with_same_name>>
+    type _t2 = AssertTrue<
+      IsExact<
+        ViewFunctionOutputType,
+        [string, string] & {
+          a: string
+          b: string
+        }
+      >
+    >
+  })
+
   // we skip this test as ts only about types
   it.skip('prevents from using not existing methods', () => {
     // @ts-expect-error

Diff for: packages/target-ethers-v5-test/test/Issue552Reproduction.test.ts

@@ -1,21 +1,28 @@
 import { AssertTrue, IsExact } from 'test-utils'
 
-import * as types from '../types/Issue552Reproduction'
+import { Issue552Observer, Issue552Reproduction } from '../types/Issue552Reproduction'
 import { createNewBlockchain, deployContract } from './common'
 
 describe('Issue552Reproduction', () => {
   it('does not emit overly long tuples', () => {
     type _ = [
-      AssertTrue<IsExact<types.ObservationParamsStruct['observations'], types.ObservationStruct[]>>,
-      AssertTrue<IsExact<types.ObservationParamsStructOutput['observations'], types.ObservationStructOutput[]>>,
+      AssertTrue<
+        IsExact<Issue552Reproduction.ObservationParamsStruct['observations'], Issue552Observer.ObservationStruct[]>
+      >,
+      AssertTrue<
+        IsExact<
+          Issue552Reproduction.ObservationParamsStructOutput['observations'],
+          Issue552Observer.ObservationStructOutput[]
+        >
+      >,
     ]
   })
 
   it('accepts array of numbers', async () => {
     const { signer, ganache } = await createNewBlockchain()
 
     try {
-      const contract = await deployContract<types.Issue552Reproduction>(signer, 'Issue552_Reproduction')
+      const contract = await deployContract<Issue552Reproduction>(signer, 'Issue552_Reproduction')
 
       await contract.input([1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
     } finally {