fix linting and prettier configs

Author: jfschwarz

.eslintrc.js

@@ -15,20 +15,7 @@ module.exports = {
     "plugin:import/typescript",
     "plugin:@typescript-eslint/recommended",
     "plugin:prettier/recommended",
-    "prettier/@typescript-eslint",
+    "prettier",
   ],
-  ignorePatterns: ["build/", "node_modules/", "!.prettierrc.js"],
-  rules: {
-    "import/order": [
-      "error",
-      {
-        "newlines-between": "always",
-        alphabetize: {
-          order: "asc",
-        },
-      },
-    ],
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/no-empty-function": "off",
-  },
-};
+  ignorePatterns: ["build/", "node_modules/", "coverage/", ".openzeppelin"],
+}

.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "tabWidth": 2,
+  "semi": false,
+  "trailingComma": "es5"
+}

.solcover.js

@@ -1,13 +1,7 @@
 module.exports = {
-  skipFiles: [
-    "test/Mock.sol",
-    "test/TestAvatar.sol",
-    "test/TestContract.sol",
-    "test/TestFactory.sol",
-    "test/MultiSend.sol",
-  ],
+  skipFiles: ["test/TestToken.sol"],
   mocha: {
     grep: "@skip-on-coverage", // Find everything with this tag
     invert: true, // Run the grep's inverse set.
   },
-};
+}

README.md

@@ -77,7 +77,3 @@ All contracts are WITHOUT ANY WARRANTY; without even the implied warranty of MER
 ### License
 
 Created under the [LGPL-3.0+ license](LICENSE).
-
-```
-
-```

contracts/test/TestToken.sol

@@ -6,7 +6,7 @@ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 contract TestToken is ERC20 {
   address public owner;
 
-  uint8 tokenDecimals;
+  uint8 internal tokenDecimals;
 
   constructor(uint8 _decimals) ERC20("Test", "T") {
     owner = msg.sender;

hardhat.config.ts

@@ -1,58 +1,57 @@
-import "@typechain/hardhat";
-import "@nomiclabs/hardhat-ethers";
-import "@nomiclabs/hardhat-waffle";
-import "@nomiclabs/hardhat-etherscan";
-import "@openzeppelin/hardhat-upgrades";
-import "solidity-coverage";
-import "hardhat-deploy";
-import "hardhat-gas-reporter";
-import dotenv from "dotenv";
-import yargs from "yargs";
-import { HttpNetworkUserConfig } from "hardhat/types";
+import "@typechain/hardhat"
+import "@nomiclabs/hardhat-ethers"
+import "@nomiclabs/hardhat-waffle"
+import "@nomiclabs/hardhat-etherscan"
+import "@openzeppelin/hardhat-upgrades"
+import "solidity-coverage"
+import "hardhat-deploy"
+import "hardhat-gas-reporter"
+import dotenv from "dotenv"
+import { HttpNetworkUserConfig } from "hardhat/types"
+import yargs from "yargs"
 
 const argv = yargs
   .option("network", {
     type: "string",
     default: "hardhat",
   })
   .help(false)
-  .version(false).argv as { network: string };
+  .version(false).argv as { network: string }
 
 // Load environment variables.
-dotenv.config();
-const { INFURA_KEY, MNEMONIC, ETHERSCAN_API_KEY, PK } = process.env;
+dotenv.config()
+const { INFURA_KEY, MNEMONIC, ETHERSCAN_API_KEY, PK } = process.env
 
-import "./src/tasks/initialDeploy";
-import "./src/tasks/upgrade";
-import "./src/tasks/verify";
+import "./src/tasks/initialDeploy"
+import "./src/tasks/upgrade"
+import "./src/tasks/verify"
 
 const DEFAULT_MNEMONIC =
-  "candy maple cake sugar pudding cream honey rich smooth crumble sweet treat";
+  "candy maple cake sugar pudding cream honey rich smooth crumble sweet treat"
 
-const sharedNetworkConfig: HttpNetworkUserConfig = {};
+const sharedNetworkConfig: HttpNetworkUserConfig = {}
 if (PK) {
-  sharedNetworkConfig.accounts = [PK];
+  sharedNetworkConfig.accounts = [PK]
 } else {
   sharedNetworkConfig.accounts = {
     mnemonic: MNEMONIC || DEFAULT_MNEMONIC,
-  };
+  }
 }
 
 if (["rinkeby", "mainnet"].includes(argv.network) && INFURA_KEY === undefined) {
   throw new Error(
     `Could not find Infura key in env, unable to connect to network ${argv.network}`
-  );
+  )
 }
 
 export default {
   paths: {
     artifacts: "build/artifacts",
     cache: "build/cache",
-    deploy: "src/deploy",
     sources: "contracts",
   },
   solidity: {
-    compilers: [{ version: "0.8.6" }, { version: "0.6.12" }],
+    compilers: [{ version: "0.8.6" }],
     settings: {
       optimizer: {
         enabled: true,
@@ -86,12 +85,4 @@ export default {
   etherscan: {
     apiKey: ETHERSCAN_API_KEY,
   },
-  gasReporter: {
-    // @ts-ignore-next-line
-    proxyResolver(transaction) {
-      throw transaction;
-      // @ts-ignore-next-line
-      console.log(this.data);
-    },
-  },
-};
+}

package.json

@@ -17,6 +17,7 @@
     "lint:sol": "solhint 'contracts/**/*.sol'",
     "lint:ts": "eslint --max-warnings 0 .",
     "fmt:sol": "prettier 'contracts/**/*.sol' -w",
+    "fmt:ts": "prettier '(src|test)/**/*.ts' -w",
     "prepack": "yarn build",
     "prepare": "husky install"
   },

src/tasks/initialDeploy.ts

@@ -1,15 +1,6 @@
-import "hardhat-deploy";
-import "@nomiclabs/hardhat-ethers";
-import { task, types } from "hardhat/config";
-
-interface TokenLockArgs {
-  owner: string;
-  token: string;
-  depositDeadline: number;
-  lockDuration: number;
-  name: string;
-  symbol: string;
-}
+import "hardhat-deploy"
+import "@nomiclabs/hardhat-ethers"
+import { task, types } from "hardhat/config"
 
 task("initialDeploy", "Deploys a fresh TokenLock contract")
   .addParam("owner", "Address of the owner", undefined, types.string)
@@ -39,28 +30,28 @@ task("initialDeploy", "Deploys a fresh TokenLock contract")
     types.string
   )
   .setAction(async (taskArgs, hre) => {
-    const [caller] = await hre.ethers.getSigners();
-    console.log("Using the account:", caller.address);
-    const TokenLock = await hre.ethers.getContractFactory("TokenLock");
+    const [caller] = await hre.ethers.getSigners()
+    console.log("Using the account:", caller.address)
+    const TokenLock = await hre.ethers.getContractFactory("TokenLock")
     const tokenLock = await hre.upgrades.deployProxy(TokenLock, [
       taskArgs.owner,
       taskArgs.token,
       taskArgs.depositDeadline,
       taskArgs.lockDuration,
       taskArgs.name,
       taskArgs.symbol,
-    ]);
+    ])
 
-    console.log("TokenLock proxy deployed to:", tokenLock.address);
-    console.log("Waiting for deploy transaction to be mined...");
+    console.log("TokenLock proxy deployed to:", tokenLock.address)
+    console.log("Waiting for deploy transaction to be mined...")
 
-    await tokenLock.deployed();
+    await tokenLock.deployed()
     const implementationAddress =
-      await hre.upgrades.erc1967.getImplementationAddress(tokenLock.address);
+      await hre.upgrades.erc1967.getImplementationAddress(tokenLock.address)
     console.log(
       "Using the logic implementation contract deployed at:",
       implementationAddress
-    );
-  });
+    )
+  })
 
-export {};
+export {}

src/tasks/upgrade.ts

@@ -1,7 +1,7 @@
-import "hardhat-deploy";
-import "@nomiclabs/hardhat-ethers";
+import "hardhat-deploy"
+import "@nomiclabs/hardhat-ethers"
 
-import { task, types } from "hardhat/config";
+import { task, types } from "hardhat/config"
 
 task("upgrade", "Upgrades the logic of an existing TokenLock contract")
   .addParam(
@@ -11,21 +11,18 @@ task("upgrade", "Upgrades the logic of an existing TokenLock contract")
     types.string
   )
   .setAction(async (taskArgs, hre) => {
-    const [caller] = await hre.ethers.getSigners();
-    console.log("Using the account:", caller.address);
-    const TokenLock = await hre.ethers.getContractFactory("TokenLock");
-    const tokenLock = await hre.upgrades.upgradeProxy(
-      taskArgs.proxy,
-      TokenLock
-    );
+    const [caller] = await hre.ethers.getSigners()
+    console.log("Using the account:", caller.address)
+    const TokenLock = await hre.ethers.getContractFactory("TokenLock")
+    const tokenLock = await hre.upgrades.upgradeProxy(taskArgs.proxy, TokenLock)
 
     console.log(
       `Latest version of the implementation deployed to: ${tokenLock.address}`
-    );
+    )
 
     console.log(
       `Proxy at ${taskArgs.proxy} upgraded to use implementation at ${tokenLock.address}`
-    );
-  });
+    )
+  })
 
-export {};
+export {}

src/tasks/verify.ts

@@ -1,4 +1,4 @@
-import { task, types } from "hardhat/config";
+import { task, types } from "hardhat/config"
 
 task("verifyEtherscan", "Verifies the contract on etherscan")
   .addParam(
@@ -11,5 +11,5 @@ task("verifyEtherscan", "Verifies the contract on etherscan")
     await hardhatRuntime.run("verify", {
       address: taskArgs.contract,
       constructorArgsParams: [],
-    });
-  });
+    })
+  })