feat(typescript): add lint husky typechain

.env.sample

@@ -1,3 +1,5 @@
 INFURA_KEY=
 ALCHEMY_KEY=
-PRIVATE_KEY=
+PRIVATE_KEY=
+COINMARKETCAP_API_KEY=
+ETHERSCAN_API_KEY=

.github/workflows/PR-CI.yml

@@ -0,0 +1,56 @@
+name: meTokens CI
+
+on:
+  pull_request:
+    branches:
+      - main
+      - dev
+  push:
+    branches:
+      - main
+      - dev
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ github.token }}
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14.x
+
+      - uses: actions/cache@v2
+        with:
+          path: "**/node_modules"
+          key: nodeModules-${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
+
+      - name: Install packages
+        run: yarn --frozen-lockfile
+        env:
+          CI: true
+
+      - name: lint
+        run: yarn lint
+        env:
+          CI: true
+
+      - name: Compile
+        run: yarn compile
+        env:
+          CI: true
+
+      - name: Test Deployment
+        run: yarn deploy-local
+        env:
+          CI: true
+
+      - name: Test
+        run: yarn test
+        env:
+          CI: true

.gitignore

@@ -1,4 +1,3 @@
-package-lock.json
 node_modules
 
 abi/

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint-staged

.nvmrc

@@ -0,0 +1 @@
+14.16.0

.prettierignore

@@ -0,0 +1,6 @@
+coverage
+node_modules
+build
+cache
+artifacts
+deployments

.prettierrc

@@ -0,0 +1,15 @@
+{
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "printWidth": 80,
+        "tabWidth": 4,
+        "useTabs": false,
+        "singleQuote": false,
+        "bracketSpacing": false,
+        "explicitTypes": "always"
+      }
+    }
+  ]
+}

.solcover.js

@@ -0,0 +1,4 @@
+module.exports = {
+  testCommand: " mocha --exit --recursive test",
+  skipFiles: ["interfaces", "mocks"],
+};

.solhintignore

@@ -0,0 +1,3 @@
+contracts/interfaces
+contracts/libs/Details.sol 
+node_modules 

.solhintrc.js

@@ -0,0 +1,46 @@
+module.exports = {
+  extends: "solhint:recommended",
+  plugins: ["prettier"],
+  rules: {
+    "prettier/prettier": "error",
+    "code-complexity": ["error", 10],
+    "function-max-lines": ["error", 100],
+    "max-line-length": ["error", 100],
+    "max-states-count": ["error", 20],
+    "no-empty-blocks": "error",
+    "no-unused-vars": "error",
+    "payable-fallback": "off",
+    "reason-string": ["off", { maxLength: 32 }],
+    "constructor-syntax": "off",
+    "comprehensive-interface": "off",
+    quotes: ["error", "double"],
+    "const-name-snakecase": "error",
+    "contract-name-camelcase": "error",
+    "event-name-camelcase": "error",
+    "func-name-mixedcase": "error",
+    "func-param-name-mixedcase": "error",
+    "modifier-name-mixedcase": "error",
+    "private-vars-leading-underscore": ["error", { strict: false }],
+    "var-name-mixedcase": "error",
+    "imports-on-top": "error",
+    ordering: "error",
+    "visibility-modifier-order": "error",
+    "avoid-call-value": "off",
+    "avoid-low-level-calls": "off",
+    "avoid-sha3": "error",
+    "avoid-suicide": "error",
+    "avoid-throw": "error",
+    "avoid-tx-origin": "off",
+    "check-send-result": "error",
+    "compiler-version": ["error", ">=0.6.0"],
+    "mark-callable-contracts": "off",
+    "func-visibility": ["error", { ignoreConstructors: true }],
+    "multiple-sends": "error",
+    "no-complex-fallback": "error",
+    "no-inline-assembly": "off",
+    "not-rely-on-block-hash": "error",
+    reentrancy: "error",
+    "state-visibility": "error",
+    "not-rely-on-time": "off",
+  },
+};