Adding code formatter and static code analyzer

- Added linters for TS/JS
- Added prettier for JSON/YAML
- Added sol linters
- Added pre commit hooks

Author: dimpar

.gitignore

@@ -49,4 +49,5 @@ yarn-error.log
 
 # Hardhat
 cache/
-export.json
+export.json
+solidity/random-beacon/typechain

.pre-commit-config.yaml

@@ -17,12 +17,18 @@ repos:
       files: '\.sol$'
       language: script
       description: "Checks solidity code according to the package's linter configuration"
-    - id: lint-js
-      name: 'lint solidity js'
-      entry: /usr/bin/env bash -c "cd solidity-v1 && npm run lint:js"
-      files: 'solidity-v1\/.*\.js$'
+    - id: lint-eslint
+      name: 'lint solidity ts/js'
+      entry: /usr/bin/env bash -c "cd solidity/random-beacon && npm run lint:eslint"
+      files: 'solidity/random-beacon\/.*'
       language: script
-      description: "Checks JS code according to the package's linter configuration"
+      description: "Checks TS/JS code according to the package's linter configuration"
+    - id: lint-config
+      name: 'lint solidity json/yaml'
+      entry: /usr/bin/env bash -c "cd solidity/random-beacon && npm run lint:config"
+      files: 'solidity/random-beacon\/.*'
+      language: script
+      description: "Checks JSON/YAML code according to the package's linter configuration"
     - id: format-dashboard
       name: 'format dashboard'
       entry: /usr/bin/env bash -c "cd solidity-v1/dashboard && npm run format"

solidity/random-beacon/.eslintignore

@@ -0,0 +1 @@
+node_modules

solidity/random-beacon/.eslintrc

@@ -0,0 +1,15 @@
+{
+  "root": true,
+  "extends": ["@thesis-co"],
+  "parserOptions": {
+    "ecmaVersion": 2017,
+    "sourceType": "module"
+  },
+  "env": {
+    "es6": true,
+    "mocha": true
+  },
+  "rules": {
+    "new-cap": "off"
+  }
+}

solidity/random-beacon/.prettierignore

@@ -0,0 +1,6 @@
+artifacts/
+build/
+cache/
+deployments/
+export.json
+typechain/

solidity/random-beacon/.solhint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "keep",
+  "plugins": [],
+  "rules": {
+    "func-visibility": ["error", { "ignoreConstructors": true }]
+  }
+}

solidity/random-beacon/.solhintignore

@@ -0,0 +1 @@
+node_modules/

solidity/random-beacon/.tsconfig-eslint.json

@@ -0,0 +1 @@
+./node_modules/@thesis-co/eslint-config/.tsconfig-eslint.json

solidity/random-beacon/contracts/test/TestToken.sol

@@ -7,6 +7,8 @@ import "@tenderly/hardhat-tenderly"
 import "@nomiclabs/hardhat-waffle"
 import "hardhat-gas-reporter"
 import "hardhat-contract-sizer"
+import "@typechain/hardhat"
+import "@nomiclabs/hardhat-ethers"
 
 const config: HardhatUserConfig = {
   solidity: {
@@ -33,7 +35,7 @@ const config: HardhatUserConfig = {
         url: process.env.FORKING_URL || "",
         // latest block is taken if FORKING_BLOCK env is not provided
         blockNumber: process.env.FORKING_BLOCK
-          ? parseInt(process.env.FORKING_BLOCK)
+          ? parseInt(process.env.FORKING_BLOCK, 10)
           : undefined,
       },
       tags: ["local"],

solidity/random-beacon/deploy/00_deploy_test_token.ts

@@ -5,32 +5,50 @@
   "scripts": {
     "build": "hardhat compile",
     "test": "hardhat test",
-    "deploy": "hardhat deploy --export export.json"
+    "deploy": "hardhat deploy --export export.json",
+    "format": "npm run lint",
+    "format:fix": "npm run lint:fix",
+    "lint": "npm run lint:eslint && npm run lint:sol && npm run lint:config",
+    "lint:fix": "npm run lint:fix:eslint && npm run lint:fix:sol && npm run lint:config:fix",
+    "lint:eslint": "eslint .",
+    "lint:fix:eslint": "eslint . --fix",
+    "lint:sol": "solhint 'contracts/**/*.sol'",
+    "lint:fix:sol": "solhint 'contracts/**/*.sol' --fix",
+    "lint:config": "prettier -c '**/*.@(json|yaml)'",
+    "lint:config:fix": "prettier -w '**/*.@(json|yaml)'"
   },
   "dependencies": {
     "@openzeppelin/contracts": "^4.3.2",
-    "@thesis/solidity-contracts": "github:thesis/solidity-contracts#4985bcf"
-  },
-  "devDependencies": {
+    "@thesis/solidity-contracts": "github:thesis/solidity-contracts#4985bcf",
+    "hardhat": "^2.6.4",
+    "hardhat-deploy": "^0.9.1",
     "@keep-network/hardhat-helpers": "https://github.com/keep-network/hardhat-helpers#ed35ab7",
     "@keep-network/hardhat-local-networks-config": "^0.1.0-pre.0",
     "@nomiclabs/hardhat-ethers": "^2.0.2",
     "@nomiclabs/hardhat-waffle": "^2.0.1",
     "@tenderly/hardhat-tenderly": "^1.0.12",
+    "@typechain/hardhat": "^2.3.0",
+    "hardhat-gas-reporter": "^1.0.4",
+    "hardhat-contract-sizer": "^2.1.1"
+  },
+  "devDependencies": {
     "@types/chai": "^4.2.22",
     "@types/mocha": "^9.0.0",
     "@types/node": "^16.9.6",
     "chai": "^4.3.4",
-    "eslint": "^7.30.0",
-    "eslint-config-keep": "github:keep-network/eslint-config-keep#0c27ade",
+    "eslint": "^7.2.0",
+    "eslint-plugin-import": "^2.18.2",
     "ethereum-waffle": "^3.4.0",
     "ethers": "^5.4.7",
-    "hardhat": "^2.6.4",
-    "hardhat-contract-sizer": "^2.1.1",
-    "hardhat-deploy": "^0.9.1",
-    "hardhat-gas-reporter": "^1.0.4",
+    "@thesis-co/eslint-config": "github:thesis/eslint-config",
+    "@typechain/ethers-v5": "^7.1.2",
+    "solhint": "^3.3.6",
+    "solhint-config-keep": "github:keep-network/solhint-config-keep",
     "ts-node": "^10.2.1",
-    "typescript": "^4.4.3"
+    "typechain": "^5.1.2",
+    "typescript": "^4.4.3",
+    "prettier": "^2.4.1",
+    "prettier-plugin-solidity": "^1.0.0-beta.18"
   },
   "engines": {
     "node": ">= 14.0.0"

solidity/random-beacon/hardhat.config.ts

@@ -3,5 +3,5 @@
     "./hardhat.config.ts",
     "node_modules/@keep-network/hardhat-local-networks-config/src/type-extensions.d.ts"
   ],
-  "include": ["./deploy", "./test"]
+  "include": ["./deploy", "./test", "./typechain"]
 }