Custom generated factories should work without any args (#527)

krzkaczor · hasparus · web-flow · commit a0b3c4b7b8e6 · 2021-10-27T15:12:10.000+02:00
Co-authored-by: hasparus &lt;hasparus@gmail.com&gt;
diff --git a/.changeset/bright-kings-yell.md b/.changeset/bright-kings-yell.md
@@ -0,0 +1,5 @@
+---
+'@typechain/ethers-v5': patch
+---
+
+Custom generated factories do not require signers now
diff --git a/packages/hardhat-test/package.json b/packages/hardhat-test/package.json
@@ -11,7 +11,7 @@
     "typecheck": "tsc --noEmit --incremental false --composite false && tsc --noEmit --incremental false --composite false -p tsconfig.types.json",
     "clean": "hardhat clean && rm -f tsconfig.build.tsbuildinfo && rm -rf build",
     "generate-types": "hardhat clean && hardhat compile",
-    "test": "yarn generate-types",
+    "test": "yarn generate-types && mocha --config ../../.mocharc.js",
     "test:fix": "yarn lint:fix && yarn format:fix && yarn test && yarn typecheck"
   },
   "devDependencies": {
diff --git a/packages/hardhat-test/test/hardhat.test.ts b/packages/hardhat-test/test/hardhat.test.ts
@@ -1,3 +1,4 @@
+import { Interface } from '@ethersproject/abi'
 import { ethers } from 'hardhat'
 import { AssertTrue, IsExact } from 'test-utils'
 
@@ -9,4 +10,14 @@ describe('TypeChain x Hardhat', () => {
 
     type _ = AssertTrue<IsExact<typeof counterFactory, Counter__factory>>
   })
+
+  it('should construct factories in different ways', async () => {
+    const [deployer] = await ethers.getSigners()
+    const artifact = require('../artifacts/contracts/Counter.sol/Counter.json') as { abi: Interface; bytecode: string }
+
+    const counterFactory1 = new Counter__factory()
+    const counterFactory2 = new Counter__factory(deployer)
+    const counterFactory3 = new Counter__factory(artifact.abi, artifact.bytecode)
+    const counterFactory4 = new Counter__factory(artifact.abi, artifact.bytecode, deployer)
+  })
 })
diff --git a/packages/hardhat-test/typechain-types/factories/Counter__factory.ts b/packages/hardhat-test/typechain-types/factories/Counter__factory.ts
@@ -64,14 +64,20 @@ const _abi = [
 const _bytecode =
   "0x60806040526000805534801561001457600080fd5b50610429806100246000396000f3fe608060405234801561001057600080fd5b50600436106100415760003560e01c80630bd8599e146100465780635fcbd5b614610064578063a87d942c14610082575b600080fd5b61004e6100a0565b6040518082815260200191505060405180910390f35b61006c6101ad565b6040518082815260200191505060405180910390f35b61008a6102ba565b6040518082815260200191505060405180910390f35b60006100e36040518060400160405280601081526020017f636f756e7455703a20636f756e74203d000000000000000000000000000000008152506000546102c3565b600060016000540190506000548111610164576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260108152602001807f55696e74323536206f766572666c6f770000000000000000000000000000000081525060200191505060405180910390fd5b806000819055507fa501f5a8ef1a812bff54fb3642cfaec066c351af1716c48a7bdd05e0bb631e676000546040518082815260200191505060405180910390a160005491505090565b60006101f06040518060400160405280601281526020017f636f756e74446f776e3a20636f756e74203d00000000000000000000000000008152506000546102c3565b600060016000540390506000548110610271576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260118152602001807f55696e7432353620756e646572666c6f7700000000000000000000000000000081525060200191505060405180910390fd5b806000819055507fa501f5a8ef1a812bff54fb3642cfaec066c351af1716c48a7bdd05e0bb631e676000546040518082815260200191505060405180910390a160005491505090565b60008054905090565b6103c682826040516024018080602001838152602001828103825284818151815260200191508051906020019080838360005b838110156103115780820151818401526020810190506102f6565b50505050905090810190601f16801561033e5780820380516001836020036101000a031916815260200191505b5093505050506040516020818303038152906040527f9710a9d0000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff83818316178352505050506103ca565b5050565b60008151905060006a636f6e736f6c652e6c6f679050602083016000808483855afa505050505056fea264697066735822122044ffda708d2db26c3ff33b8b5422dc65fa053b4cec7346d89071a9bd011940b564736f6c63430006080033";
 
+type CounterConstructorParams =
+  | [signer?: Signer]
+  | ConstructorParameters<typeof ContractFactory>;
+
+const isSuperArgs = (
+  xs: CounterConstructorParams
+): xs is ConstructorParameters<typeof ContractFactory> => xs.length > 1;
+
 export class Counter__factory extends ContractFactory {
-  constructor(
-    ...args: [signer: Signer] | ConstructorParameters<typeof ContractFactory>
-  ) {
-    if (args.length === 1) {
-      super(_abi, _bytecode, args[0]);
-    } else {
+  constructor(...args: CounterConstructorParams) {
+    if (isSuperArgs(args)) {
       super(...args);
+    } else {
+      super(_abi, _bytecode, args[0]);
     }
   }
 
diff --git a/packages/hardhat/test/fixture-projects/hardhat-project/typechain-types/factories/ERC20__factory.ts b/packages/hardhat/test/fixture-projects/hardhat-project/typechain-types/factories/ERC20__factory.ts
@@ -298,14 +298,20 @@ const _abi = [
 const _bytecode =
   "0x60806040523480156200001157600080fd5b5060405162000cae38038062000cae833981810160405260408110156200003757600080fd5b81019080805160405193929190846401000000008211156200005857600080fd5b9083019060208201858111156200006e57600080fd5b82516401000000008111828201881017156200008957600080fd5b82525081516020918201929091019080838360005b83811015620000b85781810151838201526020016200009e565b50505050905090810190601f168015620000e65780820380516001836020036101000a031916815260200191505b50604052602001805160405193929190846401000000008211156200010a57600080fd5b9083019060208201858111156200012057600080fd5b82516401000000008111828201881017156200013b57600080fd5b82525081516020918201929091019080838360005b838110156200016a57818101518382015260200162000150565b50505050905090810190601f168015620001985780820380516001836020036101000a031916815260200191505b5060405250508251620001b491506003906020850190620001e0565b508051620001ca906004906020840190620001e0565b50506005805460ff19166012179055506200028c565b828054600181600116156101000203166002900490600052602060002090601f01602090048101928262000218576000855562000263565b82601f106200023357805160ff191683800117855562000263565b8280016001018555821562000263579182015b828111156200026357825182559160200191906001019062000246565b506200027192915062000275565b5090565b5b8082111562000271576000815560010162000276565b610a12806200029c6000396000f3fe608060405234801561001057600080fd5b50600436106100c95760003560e01c80633950935111610081578063a457c2d71161005b578063a457c2d714610253578063a9059cbb1461027f578063dd62ed3e146102ab576100c9565b806339509351146101f957806370a082311461022557806395d89b411461024b576100c9565b806318160ddd116100b257806318160ddd1461018b57806323b872dd146101a5578063313ce567146101db576100c9565b806306fdde03146100ce578063095ea7b31461014b575b600080fd5b6100d66102d9565b6040805160208082528351818301528351919283929083019185019080838360005b838110156101105781810151838201526020016100f8565b50505050905090810190601f16801561013d5780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b6101776004803603604081101561016157600080fd5b506001600160a01b03813516906020013561036f565b604080519115158252519081900360200190f35b61019361038c565b60408051918252519081900360200190f35b610177600480360360608110156101bb57600080fd5b506001600160a01b03813581169160208101359091169060400135610392565b6101e3610419565b6040805160ff9092168252519081900360200190f35b6101776004803603604081101561020f57600080fd5b506001600160a01b038135169060200135610422565b6101936004803603602081101561023b57600080fd5b50356001600160a01b0316610470565b6100d661048b565b6101776004803603604081101561026957600080fd5b506001600160a01b0381351690602001356104ec565b6101776004803603604081101561029557600080fd5b506001600160a01b038135169060200135610554565b610193600480360360408110156102c157600080fd5b506001600160a01b0381358116916020013516610568565b60038054604080516020601f60026000196101006001881615020190951694909404938401819004810282018101909252828152606093909290918301828280156103655780601f1061033a57610100808354040283529160200191610365565b820191906000526020600020905b81548152906001019060200180831161034857829003601f168201915b5050505050905090565b600061038361037c610593565b8484610597565b50600192915050565b60025490565b600061039f848484610683565b61040f846103ab610593565b61040a85604051806060016040528060288152602001610947602891396001600160a01b038a166000908152600160205260408120906103e9610593565b6001600160a01b0316815260208101919091526040016000205491906107de565b610597565b5060019392505050565b60055460ff1690565b600061038361042f610593565b8461040a8560016000610440610593565b6001600160a01b03908116825260208083019390935260409182016000908120918c168152925290205490610875565b6001600160a01b031660009081526020819052604090205490565b60048054604080516020601f60026000196101006001881615020190951694909404938401819004810282018101909252828152606093909290918301828280156103655780601f1061033a57610100808354040283529160200191610365565b60006103836104f9610593565b8461040a856040518060600160405280602581526020016109b86025913960016000610523610593565b6001600160a01b03908116825260208083019390935260409182016000908120918d168152925290205491906107de565b6000610383610561610593565b8484610683565b6001600160a01b03918216600090815260016020908152604080832093909416825291909152205490565b3390565b6001600160a01b0383166105dc5760405162461bcd60e51b81526004018080602001828103825260248152602001806109946024913960400191505060405180910390fd5b6001600160a01b0382166106215760405162461bcd60e51b81526004018080602001828103825260228152602001806108ff6022913960400191505060405180910390fd5b6001600160a01b03808416600081815260016020908152604080832094871680845294825291829020859055815185815291517f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b9259281900390910190a3505050565b6001600160a01b0383166106c85760405162461bcd60e51b815260040180806020018281038252602581526020018061096f6025913960400191505060405180910390fd5b6001600160a01b03821661070d5760405162461bcd60e51b81526004018080602001828103825260238152602001806108dc6023913960400191505060405180910390fd5b6107188383836108d6565b61075581604051806060016040528060268152602001610921602691396001600160a01b03861660009081526020819052604090205491906107de565b6001600160a01b0380851660009081526020819052604080822093909355908416815220546107849082610875565b6001600160a01b038084166000818152602081815260409182902094909455805185815290519193928716927fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef92918290030190a3505050565b6000818484111561086d5760405162461bcd60e51b81526004018080602001828103825283818151815260200191508051906020019080838360005b8381101561083257818101518382015260200161081a565b50505050905090810190601f16801561085f5780820380516001836020036101000a031916815260200191505b509250505060405180910390fd5b505050900390565b6000828201838110156108cf576040805162461bcd60e51b815260206004820152601b60248201527f536166654d6174683a206164646974696f6e206f766572666c6f770000000000604482015290519081900360640190fd5b9392505050565b50505056fe45524332303a207472616e7366657220746f20746865207a65726f206164647265737345524332303a20617070726f766520746f20746865207a65726f206164647265737345524332303a207472616e7366657220616d6f756e7420657863656564732062616c616e636545524332303a207472616e7366657220616d6f756e74206578636565647320616c6c6f77616e636545524332303a207472616e736665722066726f6d20746865207a65726f206164647265737345524332303a20617070726f76652066726f6d20746865207a65726f206164647265737345524332303a2064656372656173656420616c6c6f77616e63652062656c6f77207a65726fa2646970667358221220de6adce7ed90f4a1e98fc98980665a1b15add220fef6a2bf9a8ae78bd8ea194064736f6c63430007060033";
 
+type ERC20ConstructorParams =
+  | [signer?: Signer]
+  | ConstructorParameters<typeof ContractFactory>;
+
+const isSuperArgs = (
+  xs: ERC20ConstructorParams
+): xs is ConstructorParameters<typeof ContractFactory> => xs.length > 1;
+
 export class ERC20__factory extends ContractFactory {
-  constructor(
-    ...args: [signer: Signer] | ConstructorParameters<typeof ContractFactory>
-  ) {
-    if (args.length === 1) {
-      super(_abi, _bytecode, args[0]);
-    } else {
+  constructor(...args: ERC20ConstructorParams) {
+    if (isSuperArgs(args)) {
       super(...args);
+    } else {
+      super(_abi, _bytecode, args[0]);
     }
   }
 
diff --git a/packages/hardhat/test/fixture-projects/hardhat-project/typechain-types/factories/EdgeCases__factory.ts b/packages/hardhat/test/fixture-projects/hardhat-project/typechain-types/factories/EdgeCases__factory.ts
@@ -36,14 +36,20 @@ const _abi = [
 const _bytecode =
   "0x608060405234801561001057600080fd5b506040516101fa3803806101fa833981810160405281019061003291906100a2565b50506101ad565b600082601f83011261004a57600080fd5b815161005d61005882610127565b6100f6565b9150808252602083016020830185838301111561007957600080fd5b610084838284610161565b50505092915050565b60008151905061009c81610196565b92915050565b600080604083850312156100b557600080fd5b60006100c38582860161008d565b925050602083015167ffffffffffffffff8111156100e057600080fd5b6100ec85828601610039565b9150509250929050565b6000604051905081810181811067ffffffffffffffff8211171561011d5761011c610194565b5b8060405250919050565b600067ffffffffffffffff82111561014257610141610194565b5b601f19601f8301169050602081019050919050565b6000819050919050565b60005b8381101561017f578082015181840152602081019050610164565b8381111561018e576000848401525b50505050565bfe5b61019f81610157565b81146101aa57600080fd5b50565b603f806101bb6000396000f3fe6080604052600080fdfea26469706673582212200ccd02b2235c9677aa904c1ddf3d6665b0fe8043aeac41f435eb43be8e02433f64736f6c63430007030033";
 
+type EdgeCasesConstructorParams =
+  | [signer?: Signer]
+  | ConstructorParameters<typeof ContractFactory>;
+
+const isSuperArgs = (
+  xs: EdgeCasesConstructorParams
+): xs is ConstructorParameters<typeof ContractFactory> => xs.length > 1;
+
 export class EdgeCases__factory extends ContractFactory {
-  constructor(
-    ...args: [signer: Signer] | ConstructorParameters<typeof ContractFactory>
-  ) {
-    if (args.length === 1) {
-      super(_abi, _bytecode, args[0]);
-    } else {
+  constructor(...args: EdgeCasesConstructorParams) {
+    if (isSuperArgs(args)) {
       super(...args);
+    } else {
+      super(_abi, _bytecode, args[0]);
     }
   }
 
diff --git a/packages/hardhat/test/fixture-projects/hardhat-project/typechain-types/factories/SafeMath__factory.ts b/packages/hardhat/test/fixture-projects/hardhat-project/typechain-types/factories/SafeMath__factory.ts
@@ -108,14 +108,20 @@ const _abi = [
 const _bytecode =
   "0x610210610026600b82828239805160001a60731461001957fe5b30600052607381538281f3fe73000000000000000000000000000000000000000030146080604052600436106100565760003560e01c8063771602f71461005b578063a391c15b146100a7578063b67d77c5146100f3578063c8a4ac9c1461013f575b600080fd5b6100916004803603604081101561007157600080fd5b81019080803590602001909291908035906020019092919050505061018b565b6040518082815260200191505060405180910390f35b6100dd600480360360408110156100bd57600080fd5b81019080803590602001909291908035906020019092919050505061019d565b6040518082815260200191505060405180910390f35b6101296004803603604081101561010957600080fd5b8101908080359060200190929190803590602001909291905050506101b6565b6040518082815260200191505060405180910390f35b6101756004803603604081101561015557600080fd5b8101908080359060200190929190803590602001909291905050506101c8565b6040518082815260200191505060405180910390f35b60008082840190508091505092915050565b6000808284816101a957fe5b0490508091505092915050565b60008082840390508091505092915050565b6000808284029050809150509291505056fea26469706673582212203c34f01efc94c8b101efa6073eac7b7664a0edb302f1f7cd4364fc6bef8a919164736f6c63430007030033";
 
+type SafeMathConstructorParams =
+  | [signer?: Signer]
+  | ConstructorParameters<typeof ContractFactory>;
+
+const isSuperArgs = (
+  xs: SafeMathConstructorParams
+): xs is ConstructorParameters<typeof ContractFactory> => xs.length > 1;
+
 export class SafeMath__factory extends ContractFactory {
-  constructor(
-    ...args: [signer: Signer] | ConstructorParameters<typeof ContractFactory>
-  ) {
-    if (args.length === 1) {
-      super(_abi, _bytecode, args[0]);
-    } else {
+  constructor(...args: SafeMathConstructorParams) {
+    if (isSuperArgs(args)) {
       super(...args);
+    } else {
+      super(_abi, _bytecode, args[0]);
     }
   }
 
diff --git a/packages/hardhat/test/fixture-projects/hardhat-project/typechain-types/factories/TestContract1__factory.ts b/packages/hardhat/test/fixture-projects/hardhat-project/typechain-types/factories/TestContract1__factory.ts
@@ -30,14 +30,20 @@ const _abi = [
 const _bytecode =
   "0x60806040526040518060400160405280600b81526020017f706c616365686f6c6465720000000000000000000000000000000000000000008152506001908051906020019061004f92919061009d565b5034801561005c57600080fd5b506040516101873803806101878339818101604052602081101561007f57600080fd5b8101908080519060200190929190505050806000819055505061013a565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106100de57805160ff191683800117855561010c565b8280016001018555821561010c579182015b8281111561010b5782518255916020019190600101906100f0565b5b509050610119919061011d565b5090565b5b8082111561013657600081600090555060010161011e565b5090565b603f806101486000396000f3fe6080604052600080fdfea26469706673582212208274cbc0682bfe2bc644f008ad113b08d9bf64a4e18e321bb8bd76acde65d11b64736f6c63430007030033";
 
+type TestContract1ConstructorParams =
+  | [signer?: Signer]
+  | ConstructorParameters<typeof ContractFactory>;
+
+const isSuperArgs = (
+  xs: TestContract1ConstructorParams
+): xs is ConstructorParameters<typeof ContractFactory> => xs.length > 1;
+
 export class TestContract1__factory extends ContractFactory {
-  constructor(
-    ...args: [signer: Signer] | ConstructorParameters<typeof ContractFactory>
-  ) {
-    if (args.length === 1) {
-      super(_abi, _bytecode, args[0]);
-    } else {
+  constructor(...args: TestContract1ConstructorParams) {
+    if (isSuperArgs(args)) {
       super(...args);
+    } else {
+      super(_abi, _bytecode, args[0]);
     }
   }
 
diff --git a/packages/target-ethers-v5/src/codegen/index.ts b/packages/target-ethers-v5/src/codegen/index.ts
@@ -218,15 +218,13 @@ function codegenCommonContractFactory(contract: Contract, abi: any): { header: s
 function generateFactoryConstructor(contract: Contract, bytecode: BytecodeWithLinkReferences): string {
   if (!bytecode.linkReferences) {
     return `
-    constructor(
-      ...args: [signer: Signer] | ConstructorParameters<typeof ContractFactory>
-    ) {
-      if (args.length === 1) {
-        super(_abi, _bytecode, args[0]);
-      } else {
-        super(...args);
+      constructor(...args: ${contract.name}ConstructorParams) {
+        if (isSuperArgs(args)) {
+          super(...args);
+        } else {
+          super(_abi, _bytecode, args[0]);
+        }
       }
-    }
     `
   }
 
@@ -271,12 +269,13 @@ function generateFactoryConstructor(contract: Contract, bytecode: BytecodeWithLi
 }
 
 function generateFactoryConstructorParamsAlias(contract: Contract, bytecode: BytecodeWithLinkReferences): string {
+  const name = `${contract.name}ConstructorParams`
+
   if (bytecode.linkReferences) {
-    const name = `${contract.name}ConstructorParams`
-    return `\
+    return `
       type ${name} =
         | [linkLibraryAddresses: ${contract.name}LibraryAddresses, signer?: Signer]
-        | ConstructorParameters<typeof ContractFactory>
+        | ConstructorParameters<typeof ContractFactory>;
 
       const isSuperArgs = (
         xs: ${name}
@@ -285,9 +284,14 @@ function generateFactoryConstructorParamsAlias(contract: Contract, bytecode: Byt
           || (Array.isArray as (arg: any) => arg is readonly any[])(xs[0])
           || '_isInterface' in xs[0]
       }`
-  }
+  } else {
+    return `
+      type ${name} = [signer?: Signer] | ConstructorParameters<typeof ContractFactory>;
 
-  return ''
+      const isSuperArgs = (xs: ${name}): xs is ConstructorParameters<typeof ContractFactory> =>
+        xs.length > 1
+    `
+  }
 }
 
 function generateLibraryAddressesInterface(contract: Contract, bytecode: BytecodeWithLinkReferences): string {

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@typechain/ethers-v5': patch
 +---
++
 +Custom generated factories do not require signers now