[typechain] fix tuple array signature (#525)

Author: zemse

.changeset/hot-camels-listen.md

@@ -0,0 +1,5 @@
+---
+'typechain': major
+---
+
+Fix tuple array signature

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

@@ -264,7 +264,7 @@ export class DataTypesInput extends Contract {
       })[]
     >;
 
-    "input_struct2_array(tuple[])"(
+    "input_struct2_array((uint256,(uint256,uint256))[])"(
       input1: {
         input1: BigNumberish;
         input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
@@ -477,7 +477,7 @@ export class DataTypesInput extends Contract {
     })[]
   >;
 
-  "input_struct2_array(tuple[])"(
+  "input_struct2_array((uint256,(uint256,uint256))[])"(
     input1: {
       input1: BigNumberish;
       input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
@@ -655,7 +655,7 @@ export class DataTypesInput extends Contract {
       overrides?: UnsignedTransaction
     ): Promise<BigNumber>;
 
-    "input_struct2_array(tuple[])"(
+    "input_struct2_array((uint256,(uint256,uint256))[])"(
       input1: {
         input1: BigNumberish;
         input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };

packages/target-ethers-v5-test/types/DataTypesInput.ts

@@ -53,7 +53,7 @@ export interface DataTypesInputInterface extends ethers.utils.Interface {
     "input_string(string)": FunctionFragment;
     "input_struct((uint256,uint256))": FunctionFragment;
     "input_struct2((uint256,(uint256,uint256)))": FunctionFragment;
-    "input_struct2_array(tuple[])": FunctionFragment;
+    "input_struct2_array((uint256,(uint256,uint256))[])": FunctionFragment;
     "input_tuple(uint256,uint256)": FunctionFragment;
     "input_uint256(uint256)": FunctionFragment;
     "input_uint8(uint8)": FunctionFragment;

packages/typechain/src/utils/signatures.ts

@@ -1,5 +1,5 @@
 import { AbiParameter, EventDeclaration, FunctionDeclaration } from '../parser/abiParser'
-import { TupleType } from '../parser/parseEvmType'
+import { ArrayType, TupleType } from '../parser/parseEvmType'
 
 export function getFullSignatureAsSymbolForEvent(event: EventDeclaration): string {
   return `${event.name}_${event.inputs.map((e) => e.type.originalType).join('_')}`
@@ -15,8 +15,13 @@ export function getIndexedSignatureForEvent(event: EventDeclaration): string {
 }
 
 export function getArgumentForSignature(argument: AbiParameter): string {
-  if (argument.type.originalType !== 'tuple') return argument.type.originalType
-  return `(${(argument.type as TupleType).components.map((i) => getArgumentForSignature(i)).join(',')})`
+  if (argument.type.originalType === 'tuple') {
+    return `(${(argument.type as TupleType).components.map((i) => getArgumentForSignature(i)).join(',')})`
+  } else if (argument.type.originalType === 'tuple[]') {
+    return getArgumentForSignature({ name: '', type: (argument.type as ArrayType).itemType }) + '[]'
+  } else {
+    return argument.type.originalType
+  }
 }
 
 export function getSignatureForFn(fn: FunctionDeclaration): string {

packages/typechain/test/utils/signatures.test.ts

@@ -92,4 +92,45 @@ describe('utils >  signatures > getSignatureForFn', () => {
     const signature = getSignatureForFn(fn)
     expect(signature).toEqual('add((uint256,(boolean,address[])))')
   })
+
+  it('tuple[]', () => {
+    const struct: EvmSymbol[] = [
+      { name: 'number', type: { type: 'uinteger', originalType: 'uint256', bits: 256 } },
+      {
+        name: 'inner',
+        type: {
+          type: 'tuple',
+          originalType: 'tuple',
+          components: [
+            { name: 'bool', type: { type: 'boolean', originalType: 'boolean' } },
+            {
+              name: 'addresses',
+              type: {
+                type: 'array',
+                originalType: 'address[]',
+                itemType: { type: 'address', originalType: 'address' },
+              },
+            },
+          ],
+        },
+      },
+    ]
+    const fn: FunctionDeclaration = {
+      name: 'add',
+      inputs: [
+        {
+          name: 'arg1',
+          type: {
+            type: 'array',
+            originalType: 'tuple[]',
+            itemType: { type: 'tuple', components: struct, originalType: 'tuple' },
+          },
+        },
+      ],
+      outputs: [],
+      stateMutability: 'pure',
+    }
+    const signature = getSignatureForFn(fn)
+    expect(signature).toEqual('add((uint256,(boolean,address[]))[])')
+  })
 })