Merge pull request #314 from ethereum-ts/kk/respect-ethers-reserved-k…

…eywords
dethcrypto · Dec 5, 2020 · d5548a2 · d5548a2
2 parents da71427 + db5baa5
commit d5548a2
Show file tree

Hide file tree

Showing 13 changed files with 86 additions and 3 deletions.
diff --git a/.changeset/smart-ants-begin.md b/.changeset/smart-ants-begin.md
@@ -0,0 +1,6 @@
+---
+'@typechain/ethers-v4': patch
+'@typechain/ethers-v5': patch
+---
+
+Do not generate typings in contract type itself for reserved keywords that would collide with ethers internals
diff --git a/contracts/Name-Mangling.sol b/contracts/Name-Mangling.sol
@@ -1,4 +1,3 @@
-
 pragma solidity ^0.6.4;
 pragma experimental ABIEncoderV2;
 
@@ -7,4 +6,9 @@ contract NAME12mangling {
   function works() public view returns (bool) {
     return true;
   }
+
+  // test name collision
+  function provider() public view returns (bool) {
+    return true;
+  }
 }
diff --git a/packages/target-ethers-v4-test/types/NameMangling.d.ts b/packages/target-ethers-v4-test/types/NameMangling.d.ts
@@ -13,6 +13,8 @@ import {
 
 interface NameManglingInterface extends Interface {
   functions: {
+    provider: TypedFunctionDescription<{ encode([]: []): string }>;
+
     works: TypedFunctionDescription<{ encode([]: []): string }>;
   };
 
@@ -36,6 +38,10 @@ export class NameMangling extends Contract {
   interface: NameManglingInterface;
 
   functions: {
+    provider(overrides?: TransactionOverrides): Promise<boolean>;
+
+    "provider()"(overrides?: TransactionOverrides): Promise<boolean>;
+
     works(overrides?: TransactionOverrides): Promise<boolean>;
 
     "works()"(overrides?: TransactionOverrides): Promise<boolean>;
@@ -48,6 +54,10 @@ export class NameMangling extends Contract {
   filters: {};
 
   estimate: {
+    provider(overrides?: TransactionOverrides): Promise<BigNumber>;
+
+    "provider()"(overrides?: TransactionOverrides): Promise<BigNumber>;
+
     works(overrides?: TransactionOverrides): Promise<BigNumber>;
 
     "works()"(overrides?: TransactionOverrides): Promise<BigNumber>;

diff --git a/packages/target-ethers-v4-test/types/factories/NameMangling__factory.ts b/packages/target-ethers-v4-test/types/factories/NameMangling__factory.ts
@@ -17,6 +17,19 @@ export class NameMangling__factory {
 }
 
 const _abi = [
+  {
+    inputs: [],
+    name: "provider",
+    outputs: [
+      {
+        internalType: "bool",
+        name: "",
+        type: "bool",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
   {
     inputs: [],
     name: "works",

diff --git a/packages/target-ethers-v4/src/codegen/index.ts b/packages/target-ethers-v4/src/codegen/index.ts
@@ -10,6 +10,7 @@ import {
 import { generateInputType, generateInputTypes } from './types'
 import { codegenFunctions } from './functions'
 import { FACTORY_POSTFIX } from '../common'
+import { reservedKeywords } from './reserved-keywords'
 
 export function codegenContractTypings(contract: Contract) {
   const template = `
@@ -51,7 +52,10 @@ export function codegenContractTypings(contract: Contract) {
       ${values(contract.functions).map(codegenFunctions.bind(null, {})).join('\n')}
     };
 
-    ${values(contract.functions).map(codegenFunctions.bind(null, {})).join('\n')}
+    ${values(contract.functions)
+      .filter((f) => !reservedKeywords.has(f[0].name))
+      .map(codegenFunctions.bind(null, {}))
+      .join('\n')}
 
     filters: {
       ${values(contract.events)

diff --git a/packages/target-ethers-v4/src/codegen/reserved-keywords.ts b/packages/target-ethers-v4/src/codegen/reserved-keywords.ts
@@ -0,0 +1 @@
+export const reservedKeywords = new Set(['signer', 'provider', 'deployTransaction', 'deployed', 'fallback', 'connect'])
diff --git a/packages/target-ethers-v5-test/types/NameMangling.d.ts b/packages/target-ethers-v5-test/types/NameMangling.d.ts
@@ -21,11 +21,14 @@ import { FunctionFragment, EventFragment, Result } from "@ethersproject/abi";
 
 interface NameManglingInterface extends ethers.utils.Interface {
   functions: {
+    "provider()": FunctionFragment;
     "works()": FunctionFragment;
   };
 
+  encodeFunctionData(functionFragment: "provider", values?: undefined): string;
   encodeFunctionData(functionFragment: "works", values?: undefined): string;
 
+  decodeFunctionResult(functionFragment: "provider", data: BytesLike): Result;
   decodeFunctionResult(functionFragment: "works", data: BytesLike): Result;
 
   events: {};
@@ -45,6 +48,10 @@ export class NameMangling extends Contract {
   interface: NameManglingInterface;
 
   functions: {
+    provider(overrides?: CallOverrides): Promise<[boolean]>;
+
+    "provider()"(overrides?: CallOverrides): Promise<[boolean]>;
+
     works(overrides?: CallOverrides): Promise<[boolean]>;
 
     "works()"(overrides?: CallOverrides): Promise<[boolean]>;
@@ -55,6 +62,10 @@ export class NameMangling extends Contract {
   "works()"(overrides?: CallOverrides): Promise<boolean>;
 
   callStatic: {
+    provider(overrides?: CallOverrides): Promise<boolean>;
+
+    "provider()"(overrides?: CallOverrides): Promise<boolean>;
+
     works(overrides?: CallOverrides): Promise<boolean>;
 
     "works()"(overrides?: CallOverrides): Promise<boolean>;
@@ -63,12 +74,20 @@ export class NameMangling extends Contract {
   filters: {};
 
   estimateGas: {
+    provider(overrides?: CallOverrides): Promise<BigNumber>;
+
+    "provider()"(overrides?: CallOverrides): Promise<BigNumber>;
+
     works(overrides?: CallOverrides): Promise<BigNumber>;
 
     "works()"(overrides?: CallOverrides): Promise<BigNumber>;
   };
 
   populateTransaction: {
+    provider(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+
+    "provider()"(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+
     works(overrides?: CallOverrides): Promise<PopulatedTransaction>;
 
     "works()"(overrides?: CallOverrides): Promise<PopulatedTransaction>;

diff --git a/packages/target-ethers-v5-test/types/factories/NameMangling__factory.ts b/packages/target-ethers-v5-test/types/factories/NameMangling__factory.ts
@@ -17,6 +17,19 @@ export class NameMangling__factory {
 }
 
 const _abi = [
+  {
+    inputs: [],
+    name: "provider",
+    outputs: [
+      {
+        internalType: "bool",
+        name: "",
+        type: "bool",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
   {
     inputs: [],
     name: "works",

diff --git a/packages/target-ethers-v5/src/codegen/index.ts b/packages/target-ethers-v5/src/codegen/index.ts
@@ -10,6 +10,7 @@ import {
 import { generateInputType, generateInputTypes } from './types'
 import { codegenFunctions } from './functions'
 import { FACTORY_POSTFIX } from '../common'
+import { reservedKeywords } from './reserved-keywords'
 
 export function codegenContractTypings(contract: Contract) {
   const contractImports: string[] = ['Contract', 'ContractTransaction']
@@ -77,7 +78,10 @@ export function codegenContractTypings(contract: Contract) {
         .join('\n')}
     };
 
-    ${values(contract.functions).map(codegenFunctions.bind(null, {})).join('\n')}
+    ${values(contract.functions)
+      .filter((f) => !reservedKeywords.has(f[0].name))
+      .map(codegenFunctions.bind(null, {}))
+      .join('\n')}
 
     callStatic: {
       ${values(contract.functions)

diff --git a/packages/target-ethers-v5/src/codegen/reserved-keywords.ts b/packages/target-ethers-v5/src/codegen/reserved-keywords.ts
@@ -0,0 +1 @@
+export const reservedKeywords = new Set(['signer', 'provider', 'deployTransaction', 'deployed', 'fallback', 'connect'])
diff --git a/packages/target-truffle-v4-test/types/truffle-contracts/NAME12mangling.d.ts b/packages/target-truffle-v4-test/types/truffle-contracts/NAME12mangling.d.ts
@@ -13,4 +13,6 @@ type AllEvents = never;
 
 export interface NAME12manglingInstance extends Truffle.ContractInstance {
   works(txDetails?: Truffle.TransactionDetails): Promise<boolean>;
+
+  provider(txDetails?: Truffle.TransactionDetails): Promise<boolean>;
 }
diff --git a/packages/target-truffle-v5-test/types/truffle-contracts/NAME12mangling.d.ts b/packages/target-truffle-v5-test/types/truffle-contracts/NAME12mangling.d.ts
@@ -15,8 +15,12 @@ type AllEvents = never;
 export interface NAME12manglingInstance extends Truffle.ContractInstance {
   works(txDetails?: Truffle.TransactionDetails): Promise<boolean>;
 
+  provider(txDetails?: Truffle.TransactionDetails): Promise<boolean>;
+
   methods: {
     works(txDetails?: Truffle.TransactionDetails): Promise<boolean>;
+
+    provider(txDetails?: Truffle.TransactionDetails): Promise<boolean>;
   };
 
   getPastEvents(event: string): Promise<EventData[]>;

diff --git a/packages/target-web3-v1-test/types/Name-Mangling.d.ts b/packages/target-web3-v1-test/types/Name-Mangling.d.ts
@@ -29,6 +29,8 @@ export interface NameMangling extends BaseContract {
   ): NameMangling;
   clone(): NameMangling;
   methods: {
+    provider(): NonPayableTransactionObject<boolean>;
+
     works(): NonPayableTransactionObject<boolean>;
   };
   events: {
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export const reservedKeywords = new Set(['signer', 'provider', 'deployTransaction', 'deployed', 'fallback', 'connect'])