WIP: ethers-6 migration

JoinColony · Aug 2, 2023 · fa5bda1 · fa5bda1
1 parent 6b8a4bd
commit fa5bda1
Show file tree

Hide file tree

Showing 36 changed files with 943 additions and 800 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -17,11 +17,10 @@
         "no-redeclare": "off",
         "no-shadow": "off",
         "no-unused-vars": "off",
+        "no-undef": "off",
         "no-use-before-define": "off",
         "@typescript-eslint/no-unused-vars": "error",
-        "@typescript-eslint/no-shadow": [
-            "error"
-        ],
+        "@typescript-eslint/no-shadow": "error",
         "import/prefer-default-export": "off",
         "import/no-unresolved": "off",
         "import/extensions": [

diff --git a/package.json b/package.json
@@ -27,6 +27,7 @@
   },
   "homepage": "https://docs.colony.io/develop",
   "devDependencies": {
+    "@changesets/cli": "^2.26.1",
     "@colony/eslint-config-colony": "^9.2.0",
     "@typescript-eslint/eslint-plugin": "^5.59.1",
     "@typescript-eslint/parser": "^5.59.1",
@@ -43,7 +44,5 @@
     "rimraf": "^5.0.0",
     "typescript": "^5.0.4"
   },
-  "dependencies": {
-    "@changesets/cli": "^2.26.1"
-  }
+  "dependencies": {}
 }
diff --git a/packages/contractor/package.json b/packages/contractor/package.json
@@ -32,7 +32,7 @@
   "dependencies": {
     "@colony/abis": "^1.0.1",
     "@typechain/ethers-v5": "^11.1.0",
-    "@typechain/ethers-v6": "^0.4.2",
+    "@typechain/ethers-v6": "link:../../../TypeChain/packages/target-ethers-v6",
     "@types/mkdirp": "^1.0.2",
     "@types/yargs": "^17.0.24",
     "mkdirp": "^1.0.4",

diff --git a/packages/contractor/src/contractor.ts b/packages/contractor/src/contractor.ts
@@ -67,7 +67,7 @@ const EVENTS_CONTRACTS = [
 const CWD = process.cwd();
 
 const TYPECHAIN_CONFIG_FLAGS = {
-  alwaysGenerateOverloads: true,
+  alwaysGenerateOverloads: false,
   discriminateTypes: false,
   node16Modules: true,
   environment: undefined,

diff --git a/packages/core/.eslintrc b/packages/core/.eslintrc
@@ -9,7 +9,8 @@
                     ".+__factory"
                 ]
             }
-        ]
+        ],
+        "no-bitwise": "off"
     },
     "overrides": [
         {

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -30,9 +30,9 @@
   },
   "scripts": {
     "build": "npm run clean && npm run compile-cjs && npm run compile-esm && npm run compile-types && npm run create-pkg-json",
-    "build-contracts": "contractor core -o ./src/contracts",
+    "build-contracts": "contractor core -p ethers-v6 -o ./src/contracts",
     "clean": "rimraf ./dist",
-    "compile-cjs": "tsc -p tsconfig.build.json --module commonjs --target es2015 --outDir dist/cjs",
+    "compile-cjs": "tsc -p tsconfig.build.json --module commonjs --target es2020 --outDir dist/cjs",
     "compile-esm": "tsc -p tsconfig.build.json --module esnext --target es2022 --outDir dist/esm",
     "compile-types": "tsc -p tsconfig.build.json --target esnext --declaration --emitDeclarationOnly --outDir dist/types",
     "create-pkg-json": "../../scripts/create-pkg-json.sh",
@@ -52,13 +52,10 @@
   "homepage": "https://docs.colony.io/develop",
   "devDependencies": {
     "@colony/contractor": "1.1.0-next.2",
-    "@ethersproject/abi": "^5.7.0",
-    "@ethersproject/abstract-provider": "^5.7.0",
-    "@ethersproject/providers": "^5.7.2",
-    "ethers": "^5.7.2"
+    "ethers": "^6.6.7"
   },
   "peerDependencies": {
-    "ethers": "^5.1.3"
+    "ethers": "^6"
   },
   "dependencies": {
     "cross-fetch": "^3.1.5"

diff --git a/packages/core/src/contracts/MotionTarget.ts b/packages/core/src/contracts/MotionTarget.ts
@@ -3,135 +3,88 @@
 /* eslint-disable */
 import type {
   BaseContract,
-  BigNumber,
   BytesLike,
-  CallOverrides,
-  PopulatedTransaction,
-  Signer,
-  utils,
+  FunctionFragment,
+  Result,
+  Interface,
+  ContractRunner,
+  ContractMethod,
+  Listener,
 } from "ethers";
-import type { FunctionFragment, Result } from "@ethersproject/abi";
-import type { Listener, Provider } from "@ethersproject/providers";
 import type {
-  TypedEventFilter,
-  TypedEvent,
+  TypedContractEvent,
+  TypedDeferredTopicFilter,
+  TypedEventLog,
   TypedListener,
-  OnEvent,
+  TypedContractMethod,
 } from "./common.js";
 
-export interface MotionTargetInterface extends utils.Interface {
-  functions: {
-    "getCapabilityRoles(bytes4)": FunctionFragment;
-  };
-
-  getFunction(
-    nameOrSignatureOrTopic: "getCapabilityRoles" | "getCapabilityRoles(bytes4)"
-  ): FunctionFragment;
+export interface MotionTargetInterface extends Interface {
+  getFunction(nameOrSignature: "getCapabilityRoles"): FunctionFragment;
 
   encodeFunctionData(
     functionFragment: "getCapabilityRoles",
     values: [BytesLike]
   ): string;
-  encodeFunctionData(
-    functionFragment: "getCapabilityRoles(bytes4)",
-    values: [BytesLike]
-  ): string;
 
   decodeFunctionResult(
     functionFragment: "getCapabilityRoles",
     data: BytesLike
   ): Result;
-  decodeFunctionResult(
-    functionFragment: "getCapabilityRoles(bytes4)",
-    data: BytesLike
-  ): Result;
-
-  events: {};
 }
 
 export interface MotionTarget extends BaseContract {
-  connect(signerOrProvider: Signer | Provider | string): this;
-  attach(addressOrName: string): this;
-  deployed(): Promise<this>;
+  connect(runner?: ContractRunner | null): MotionTarget;
+  waitForDeployment(): Promise<this>;
 
   interface: MotionTargetInterface;
 
-  queryFilter<TEvent extends TypedEvent>(
-    event: TypedEventFilter<TEvent>,
+  queryFilter<TCEvent extends TypedContractEvent>(
+    event: TCEvent,
     fromBlockOrBlockhash?: string | number | undefined,
     toBlock?: string | number | undefined
-  ): Promise<Array<TEvent>>;
-
-  listeners<TEvent extends TypedEvent>(
-    eventFilter?: TypedEventFilter<TEvent>
-  ): Array<TypedListener<TEvent>>;
-  listeners(eventName?: string): Array<Listener>;
-  removeAllListeners<TEvent extends TypedEvent>(
-    eventFilter: TypedEventFilter<TEvent>
-  ): this;
-  removeAllListeners(eventName?: string): this;
-  off: OnEvent<this>;
-  on: OnEvent<this>;
-  once: OnEvent<this>;
-  removeListener: OnEvent<this>;
-
-  functions: {
-    getCapabilityRoles(
-      _sig: BytesLike,
-      overrides?: CallOverrides
-    ): Promise<[string] & { roles: string }>;
-
-    "getCapabilityRoles(bytes4)"(
-      _sig: BytesLike,
-      overrides?: CallOverrides
-    ): Promise<[string] & { roles: string }>;
-  };
-
-  getCapabilityRoles(
-    _sig: BytesLike,
-    overrides?: CallOverrides
-  ): Promise<string>;
-
-  "getCapabilityRoles(bytes4)"(
-    _sig: BytesLike,
-    overrides?: CallOverrides
-  ): Promise<string>;
-
-  callStatic: {
-    getCapabilityRoles(
-      _sig: BytesLike,
-      overrides?: CallOverrides
-    ): Promise<string>;
+  ): Promise<Array<TypedEventLog<TCEvent>>>;
+  queryFilter<TCEvent extends TypedContractEvent>(
+    filter: TypedDeferredTopicFilter<TCEvent>,
+    fromBlockOrBlockhash?: string | number | undefined,
+    toBlock?: string | number | undefined
+  ): Promise<Array<TypedEventLog<TCEvent>>>;
+
+  on<TCEvent extends TypedContractEvent>(
+    event: TCEvent,
+    listener: TypedListener<TCEvent>
+  ): Promise<this>;
+  on<TCEvent extends TypedContractEvent>(
+    filter: TypedDeferredTopicFilter<TCEvent>,
+    listener: TypedListener<TCEvent>
+  ): Promise<this>;
+
+  once<TCEvent extends TypedContractEvent>(
+    event: TCEvent,
+    listener: TypedListener<TCEvent>
+  ): Promise<this>;
+  once<TCEvent extends TypedContractEvent>(
+    filter: TypedDeferredTopicFilter<TCEvent>,
+    listener: TypedListener<TCEvent>
+  ): Promise<this>;
+
+  listeners<TCEvent extends TypedContractEvent>(
+    event: TCEvent
+  ): Promise<Array<TypedListener<TCEvent>>>;
+  listeners(eventName?: string): Promise<Array<Listener>>;
+  removeAllListeners<TCEvent extends TypedContractEvent>(
+    event?: TCEvent
+  ): Promise<this>;
+
+  getCapabilityRoles: TypedContractMethod<[_sig: BytesLike], [string], "view">;
+
+  getFunction<T extends ContractMethod = ContractMethod>(
+    key: string | FunctionFragment
+  ): T;
 
-    "getCapabilityRoles(bytes4)"(
-      _sig: BytesLike,
-      overrides?: CallOverrides
-    ): Promise<string>;
-  };
+  getFunction(
+    nameOrSignature: "getCapabilityRoles"
+  ): TypedContractMethod<[_sig: BytesLike], [string], "view">;
 
   filters: {};
-
-  estimateGas: {
-    getCapabilityRoles(
-      _sig: BytesLike,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
-    "getCapabilityRoles(bytes4)"(
-      _sig: BytesLike,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-  };
-
-  populateTransaction: {
-    getCapabilityRoles(
-      _sig: BytesLike,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    "getCapabilityRoles(bytes4)"(
-      _sig: BytesLike,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-  };
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,7 +9,8 @@ @@
                         ".+__factory"
                     ]
                 }
-            ]
+            ],
+            "no-bitwise": "off"
         },
         "overrides": [
             {
@@ Expand Down @@