Full review

.env.example

@@ -0,0 +1,6 @@
+# Your Etherscan API key for contract source code verification.
+ETHERSCAN_API_KEY=ABC123ABC123ABC123ABC123ABC123ABC1
+# Your infura.io project ID for deploying to Ethereum networks.
+INFURA_ID=73157d26f55d413eb06614f4ead1de461
+# The private key of your address for deploying contracts on public networks.
+PRIVATE_KEY=0xabc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1

.eslintignore

@@ -0,0 +1,5 @@
+node_modules
+artifacts
+cache
+coverage
+*.js

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  env: {
+    browser: false,
+    es2021: true,
+    mocha: true,
+    node: true
+  },
+  plugins: ["@typescript-eslint"],
+  extends: ["airbnb-base", "prettier", "plugin:node/recommended"],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 12
+  },
+  rules: {
+    "func-names": "off",
+    "no-console": "off",
+    "import/no-extraneous-dependencies": ["error", { devDependencies: true }],
+    "node/no-unpublished-import": "off",
+    "node/no-unsupported-features/es-syntax": ["error", { ignores: ["modules"] }],
+    "no-shadow": "off",
+    "@typescript-eslint/no-shadow": "error",
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": "error"
+  }
+};

.github/workflows/contract-test.yml

@@ -0,0 +1,65 @@
+name: Code checks
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup NodeJS
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+          cache: "npm"
+
+      - name: Cache node modules
+        uses: actions/cache@v3
+        id: cache
+        with:
+          path: "**/node_modules"
+          key: npm-v1-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: npm-v1-
+
+      - name: Install dependencies
+        run: npm ci
+        if: steps.cache.outputs.cache-hit != 'true'
+
+      - name: Lint contracts
+        run: npm run lint-contracts
+
+      - name: Lint scripts
+        run: npm run lint-ts
+
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup NodeJS
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+          cache: "npm"
+
+      - name: Cache node modules
+        uses: actions/cache@v3
+        id: cache
+        with:
+          path: "**/node_modules"
+          key: npm-v1-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: npm-v1-
+
+      - name: Install dependencies
+        run: npm ci
+        if: steps.cache.outputs.cache-hit != 'true'
+
+      - name: Run tests
+        run: npm test

.gitignore

@@ -0,0 +1,9 @@
+node_modules
+.env
+coverage
+coverage.json
+typechain
+
+#Hardhat files
+cache
+artifacts