Make type fixes

Author: justinkchen

.circleci/config.yml

@@ -49,7 +49,7 @@ jobs:
           command: yarn chain
           background: true
       - run:
-          name: Buidler Test
+          name: Hardhat Test
           command: yarn test
 
   coverage:

.spec.template.ts

@@ -1,6 +1,6 @@
 import "module-alias/register";
 import { BigNumber } from "ethers/utils";
-import { ethers } from "@nomiclabs/buidler";
+import { ethers } from "hardhat";
 
 import { Address, Account } from "@utils/types";
 import {} from "@utils/constants";

README.md

@@ -8,15 +8,15 @@
 # Set Protocol V2 Contract Repository
 
 ## Contracts
-[Set Protocol](https://setprotocol.com/) is a specification for tokenized asset management strategies on the ethereum blockchain written in the Solidity programming language. We use [Buidler](https://buidler.dev/) as a development environment for compiling, testing, and deploying our contracts.
+[Set Protocol](https://setprotocol.com/) is a specification for tokenized asset management strategies on the ethereum blockchain written in the Solidity programming language. We use [Hardhat](https://hardhat.org/) as a development environment for compiling, testing, and deploying our contracts.
 
 ## Development
 
-To use console.log during Solidity development, do `import @nomiclabs/buidler/console.sol`
+To use console.log during Solidity development, follow the [guides](https://hardhat.org/guides/hardhat-console.html).
 
 ## Available Functionality
 
-### Run Buidler EVM
+### Run Hardhat EVM
 
 `yarn chain`
 

contracts/protocol-viewers/SetTokenViewer.sol

@@ -20,7 +20,6 @@ pragma experimental "ABIEncoderV2";
 
 
 import { ISetToken } from "../interfaces/ISetToken.sol";
-import "@nomiclabs/buidler/console.sol";
 
 
 /**

external/contracts/balancer/BRegistry.sol

@@ -1,7 +1,5 @@
 pragma solidity 0.5.12;
 
-import "@nomiclabs/buidler/console.sol";
-
 import "@openzeppelin/contracts/math/Math.sol";
 import "@openzeppelin/contracts/math/SafeMath.sol";
 import "@openzeppelin/contracts/utils/EnumerableSet.sol";

buidler.config.ts renamed to hardhat.config.ts

@@ -1,30 +1,31 @@
 require("dotenv").config();
 
-import { BuidlerConfig, usePlugin, internalTask } from "@nomiclabs/buidler/config";
-import { TASK_COMPILE_RUN_COMPILER } from "@nomiclabs/buidler/builtin-tasks/task-names";
+import { HardhatUserConfig, internalTask } from "hardhat/config";
+import { TASK_COMPILE_SOLIDITY_COMPILE } from "hardhat/builtin-tasks/task-names";
 import { execSync } from "child_process";
 import { privateKeys } from "./utils/wallets";
 
-usePlugin("@nomiclabs/buidler-waffle");
-usePlugin("buidler-typechain");
-usePlugin("solidity-coverage");
-usePlugin("buidler-deploy");
+import "@nomiclabs/hardhat-waffle";
+import "hardhat-typechain";
+import "solidity-coverage";
+import "hardhat-deploy";
 
-internalTask(TASK_COMPILE_RUN_COMPILER).setAction(setupNativeSolc);
+internalTask(TASK_COMPILE_SOLIDITY_COMPILE).setAction(setupNativeSolc);
 
-const config: BuidlerConfig = {
-  solc: {
+const config: HardhatUserConfig = {
+  solidity: {
     version: "0.6.10",
-    optimizer: { enabled: true, runs: 200 },
+    settings: {
+      optimizer: { enabled: true, runs: 200 },
+    },
   },
   namedAccounts: {
     deployer: 0,
   },
   networks: {
-    buidlerevm: {
+    hardhat: {
       hardfork: "istanbul",
-      accounts: getBuidlerPrivateKeys(),
-      timeout: 100000,
+      accounts: getHardhatPrivateKeys(),
     },
     localhost: {
       url: "http://127.0.0.1:8545",
@@ -53,14 +54,14 @@ const config: BuidlerConfig = {
   },
   typechain: {
     outDir: "typechain",
-    target: "ethers-v4",
+    target: "ethers-v5",
   },
   mocha: {
     timeout: 100000,
   }
 };
 
-function getBuidlerPrivateKeys() {
+function getHardhatPrivateKeys() {
   return privateKeys.map(key => {
     const ONE_MILLION_ETH = "1000000000000000000000000";
     return {
@@ -81,7 +82,7 @@ async function setupNativeSolc({ input }, { config }, runSuper) {
 
   console.log("Output", solcVersionOutput);
 
-  if (!solcVersionOutput.includes(config.solc.version)) {
+  if (!solcVersionOutput.includes(config.solidity.version)) {
     console.log(`Using solcjs`);
     return runSuper();
   }

package.json

@@ -15,27 +15,28 @@
     "tsconfig.json"
   ],
   "scripts": {
-    "build": "yarn compile && yarn copy-external-abi && yarn typechain && yarn fix-typechain && yarn transpile-dist",
-    "chain": "npx buidler node --no-deploy",
+    "build": "yarn compile && yarn patch-hardhat-typechain && yarn typechain && yarn fix-typechain && yarn transpile-dist",
+    "chain": "npx hardhat node --no-deploy",
     "clean": "rm -f coverage.json; rm -rf .coverage_cache; rm -rf .coverage_contracts; rm -rf cache; rm -rf coverage; rm -rf typechain; rm -rf artifacts",
-    "compile": "npx buidler compile",
+    "compile": "npx hardhat compile",
     "copy-external-abi": "cp -r external/abi/**/* artifacts",
-    "coverage": "yarn clean && yarn build && npx buidler coverage --temp artifacts --network coverage",
-    "etherscan:verify": "buidler --network kovan etherscan-verify --solc-input --license 'None'",
+    "coverage": "yarn clean && yarn build && npx hardhat coverage --temp artifacts --network coverage",
+    "etherscan:verify": "hardhat --network kovan etherscan-verify --solc-input --license 'None'",
     "fix-typechain": "node scripts/fix-typechain.js && yarn rename-extensions",
     "flatten": "npx waffle flatten",
     "lint": "yarn run lint-sol && yarn run lint-ts",
     "lint-sol": "solhint 'contracts/**/*.sol'",
     "lint-ts": "tslint -c tslint.json -p tsconfig.json --fix",
+    "patch-hardhat-typechain": "node scripts/patch-hardhat-typechain.js",
     "precommit": "lint-staged",
     "prepare": "yarn build",
     "prepack": "if [[ \"$(basename \"$PWD\")\" == \"set-protocol-v2-contracts\" ]]; then echo \"CANNOT PUBLISH FROM THIS REPO\"; exit 1; fi;",
     "rename-extensions": "for f in typechain/*.d.ts; do mv -- \"$f\" \"${f%.d.ts}.ts\"; done",
-    "test": "npx buidler test --network localhost",
+    "test": "npx hardhat test --network localhost",
     "test:clean": "yarn clean && yarn build && yarn test",
     "transpile": "tsc",
     "transpile-dist": "tsc -p tsconfig.dist.json",
-    "typechain": "npx buidler typechain"
+    "typechain": "npx hardhat typechain"
   },
   "repository": {
     "type": "git",
@@ -45,8 +46,12 @@
   "license": "MIT",
   "homepage": "https://github.com/SetProtocol",
   "devDependencies": {
+    "@ethersproject/bignumber": "^5.0.12",
+    "@ethersproject/providers": "^5.0.17",
+    "@nomiclabs/hardhat-ethers": "^2.0.1",
+    "@nomiclabs/hardhat-waffle": "^2.0.1",
     "@openzeppelin/contracts": "^3.1.0",
-    "@typechain/ethers-v4": "^1.0.0",
+    "@typechain/ethers-v5": "^5.0.0",
     "@typechain/truffle-v4": "^2.0.2",
     "@typechain/truffle-v5": "^2.0.2",
     "@typechain/web3-v1": "^1.0.0",
@@ -55,34 +60,32 @@
     "@types/lodash": "^4.14.86",
     "@types/mocha": "^7.0.2",
     "@types/node": "^14.0.5",
-    "buidler-deploy": "^0.5.14",
     "chai": "^4.2.0",
     "coveralls": "^3.0.1",
     "dotenv": "^8.2.0",
     "ethereum-waffle": "^2.5.1",
-    "ethers": "^4.0.47",
+    "ethers": "^5.0.24",
+    "hardhat": "^2.0.6",
+    "hardhat-deploy": "^0.7.0-beta.39",
+    "hardhat-typechain": "^0.3.4",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.11",
     "lodash": "^4.17.4",
     "solc": "^0.6.10",
     "solhint": "^3.1.0",
-    "solidity-coverage": "^0.7.5",
-    "ts-generator": "0.0.8",
+    "solidity-coverage": "^0.7.13",
+    "ts-generator": "^0.1.1",
     "ts-node": "^8.10.1",
     "tslint": "^5.8.0",
     "tslint-eslint-rules": "^5.3.1",
     "typescript": "^3.9.3",
     "web3": "^1.2.9"
   },
   "dependencies": {
-    "@nomiclabs/buidler": "^1.3.4",
-    "@nomiclabs/buidler-ethers": "^1.3.3",
-    "@nomiclabs/buidler-waffle": "^1.3.3",
-    "buidler-typechain": "0.1.1",
     "fs-extra": "^5.0.0",
     "module-alias": "^2.2.2",
     "replace-in-file": "^6.1.0",
-    "typechain": "^2.0.0"
+    "typechain": "^4.0.1"
   },
   "_moduleAliases": {
     "@utils": "utils",

scripts/fix-typechain.js

@@ -1,6 +1,9 @@
 const replace = require('replace-in-file');
 
-const options = {
+let changedFiles;
+
+// Step 1: Replace all exports of classes to be declarations and to change to regular .ts files
+const options1 = {
   //Glob(s)
   files: [
     './typechain/*.d.ts',
@@ -12,9 +15,135 @@ const options = {
 };
 
 try {
-  let changedFiles = replace.sync(options);
-  console.log('Modified files:', changedFiles.map(f => f.file.toString()).join(', '));
+  changedFiles = replace.sync(options1);
+  console.log('Step 1. Typechain fixing modified files:', changedFiles.map(f => f.file.toString()).join(', '));
 }
 catch (error) {
   console.error('Error occurred:', error);
 }
+
+// Step 2: Replace all ethers.utils.Interface with just Interface
+const options2 = {
+  //Glob(s)
+  files: [
+    './typechain/*.ts',
+  ],
+
+  //Replacement to make (string or regex)
+  from: /ethers\.utils\.Interface/g,
+  to: 'Interface',
+};
+
+try {
+  changedFiles = replace.sync(options2);
+  console.log('Step 2. Typechain fixing modified files:', changedFiles.map(f => f.file.toString()).join(', '));
+}
+catch (error) {
+  console.error('Error occurred:', error);
+}
+
+// Step 3: Fix import of Interface to come from @ethersproject/abi
+const options3 = {
+  //Glob(s)
+  files: [
+    './typechain/*.ts',
+  ],
+
+  //Replacement to make (string or regex)
+  from: /import { FunctionFragment, EventFragment, Result } from \"@ethersproject\/abi\"/g,
+  to: 'import { FunctionFragment, EventFragment, Result, Interface } from "@ethersproject/abi"',
+};
+
+
+try {
+  changedFiles = replace.sync(options3);
+  console.log('Step 3. Typechain fixing modified files:', changedFiles.map(f => f.file.toString()).join(', '));
+}
+catch (error) {
+  console.error('Error occurred:', error);
+}
+
+// Step 4: Fix import of Provider and TransactionRequest to come from @ethersproject/providers
+const options4 = {
+  //Glob(s)
+  files: [
+    './typechain/*.ts',
+  ],
+
+  //Replacement to make (string or regex)
+  from: /import { Provider } from \"@utils\/test\/node_modules\/ethers\/providers\"/g,
+  to: 'import { Provider, TransactionRequest } from "@ethersproject/providers"',
+};
+
+
+try {
+  changedFiles = replace.sync(options4);
+  console.log('Step 4. Typechain fixing modified files:', changedFiles.map(f => f.file.toString()).join(', '));
+}
+catch (error) {
+  console.error('Error occurred:', error);
+}
+
+// Step 5: Fix import of TransactionOverrides
+const options5a = {
+  //Glob(s)
+  files: [
+    './typechain/*.ts',
+  ],
+
+  //Replacement to make (string or regex)
+  from: /import { TransactionOverrides } from \".\"/g,
+  to: 'import { CallOverrides } from "@ethersproject/contracts"',
+};
+const options5b = {
+  //Glob(s)
+  files: [
+    './typechain/*.ts',
+  ],
+
+  //Replacement to make (string or regex)
+  from: /TransactionOverrides/g,
+  to: 'CallOverrides',
+};
+
+
+try {
+  changedFiles = replace.sync(options5a);
+  changedFiles = replace.sync(options5b);
+  console.log('Step 5. Typechain fixing modified files:', changedFiles.map(f => f.file.toString()).join(', '));
+}
+catch (error) {
+  console.error('Error occurred:', error);
+}
+
+// Step 6: Fix import of UnsignedTransaction
+const options6a = {
+  //Glob(s)
+  files: [
+    './typechain/*.ts',
+  ],
+
+  //Replacement to make (string or regex)
+  from: /import { UnsignedTransaction } from \"ethers\/utils\/transaction\"/g,
+  to: '',
+};
+const options6b = {
+  //Glob(s)
+  files: [
+    './typechain/*.ts',
+  ],
+
+  //Replacement to make (string or regex)
+  from: /UnsignedTransaction/g,
+  to: 'TransactionRequest',
+};
+
+
+try {
+  changedFiles = replace.sync(options6a);
+  changedFiles = replace.sync(options6b);
+  console.log('Step 6. Typechain fixing modified files:', changedFiles.map(f => f.file.toString()).join(', '));
+}
+catch (error) {
+  console.error('Error occurred:', error);
+}

scripts/patch-hardhat-typechain.js

@@ -0,0 +1,23 @@
+const replace = require('replace-in-file');
+
+let changedFiles;
+
+// Step 1: Replace all exports of classes to be declarations and to change to regular .ts files
+const options1 = {
+  //Glob(s)
+  files: [
+    './node_modules/hardhat-typechain/dist/src/index.js',
+  ],
+
+  //Replacement to make (string or regex)
+  from: /\$\{config.paths.artifacts\}\/\!\(build-info\)\//g,
+  to: '{${config.paths.artifacts},external}/!(build-info)/',
+};
+
+try {
+  changedFiles = replace.sync(options1);
+  console.log('Patching hardhat-typechain file.');
+}
+catch (error) {
+  console.error('Error occurred:', error);
+}