Improve project infrastructure

Author: Exef

.env.example

@@ -0,0 +1,18 @@
+# network specific node uri : `"ETH_NODE_URI_" + networkName.toUpperCase()`
+ETH_NODE_URI_MAINNET=https://eth-mainnet.alchemyapi.io/v2/<apiKey>
+ETH_NODE_URI=https://{{networkName}}.infura.io/v3/<apiKey>
+
+
+# coinmarketcap api key for gas report
+COINMARKETCAP_API_KEY=
+TENDERLY_USERNAME=
+ETHERSCAN_KEY=
+
+
+# LOCAL
+ETH_NODE_URI_LOCALHOST=http://localhost:9545
+MNEMONIC_LOCALHOST=test test test test test test test test test test test junk
+
+# LOCAL OPTIMISM
+ETH_NODE_URI_OPTIMISTIC_LOCALHOST=http://localhost:8545
+MNEMONIC_OPTIMISTIC_LOCALHOST=test test test test test test test test test test test junk

.eslintignore

@@ -0,0 +1,13 @@
+export/
+deployments/
+artifacts/
+cache/
+coverage/
+node_modules/
+package.json
+typechain/
+dapp_test/test.sol
+_lib/
+.dappp
+*.json
+.yalc

.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
+    sourceType: 'module', // Allows for the use of imports
+  },
+  env: {
+    commonjs: true,
+  },
+  plugins: ['@typescript-eslint'],
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
+  rules: {
+    'no-empty': 'off',
+    'no-empty-function': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+  },
+};

.github/workflows/cd.yml

@@ -19,4 +19,4 @@ jobs:
           node-version: ${{ matrix.node-version }}
 
       - run: npm install
-      - run: npm run test
+      - run: npm run gas

.gitignore

@@ -1,8 +1,27 @@
-node_modules
-
 #Hardhat files
-cache
-artifacts
+cache/
+artifacts/
+dist/
 
 # local deployments
-local.deployments.json
+local.deployments.json
+
+coverage*
+typechain/
+
+.vscode/*
+!.vscode/settings.json.default
+!.vscode/launch.json.default
+!.vscode/extensions.json.default
+
+node_modules/
+.env
+
+.yalc
+yalc.lock
+yarn-error.log
+package-lock.json
+
+contractsInfo.json
+deployments/hardhat
+deployments/localhost

.mocharc.js

@@ -0,0 +1,16 @@
+'use strict';
+process.env.TS_NODE_FILES = true;
+module.exports = {
+  'allow-uncaught': true,
+  diff: true,
+  extension: ['ts'],
+  recursive: true,
+  reporter: 'spec',
+  require: ['ts-node/register', 'hardhat/register'], // ['ts-node/register/transpile-only'], (for yarn link <plugin>)
+  slow: 300,
+  spec: 'test/**/*.test.ts',
+  timeout: 20000,
+  ui: 'bdd',
+  watch: false,
+  'watch-files': ['src/**/*.sol', 'test/**/*.ts'],
+};

.npmignore

@@ -0,0 +1,4 @@
+hardhat.config.ts
+scripts
+utils
+test

.prettierignore

@@ -0,0 +1,11 @@
+export/
+deployments/
+artifacts/
+cache/
+coverage/
+node_modules/
+typechain/
+dapp_test/test.sol
+_lib/
+*.json
+.yalc

.prettierrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+  singleQuote: true,
+  bracketSpacing: false,
+  printWidth: 120,
+  overrides: [
+    {
+      files: '*.sol',
+      options: {
+        printWidth: 120,
+        tabWidth: 4,
+        singleQuote: false,
+        explicitTypes: 'always',
+      },
+    },
+  ],
+  plugins: [require.resolve('prettier-plugin-solidity')],
+};

.solhint.json

@@ -1,3 +1,38 @@
 {
-  "extends": "solhint:default"
+  "extends": "solhint:recommended",
+  "plugins": [
+    "prettier"
+  ],
+  "rules": {
+    "prettier/prettier": [
+      "error",
+      {
+        "endOfLine": "auto"
+      }
+    ],
+    "code-complexity": [
+      "error",
+      7
+    ],
+    "compiler-version": [
+      "error",
+      "^0.8.9"
+    ],
+    "const-name-snakecase": "off",
+    "func-name-mixedcase": "off",
+    "constructor-syntax": "error",
+    "func-visibility": [
+      "error",
+      {
+        "ignoreConstructors": true
+      }
+    ],
+    "not-rely-on-time": "off",
+    "reason-string": [
+      "warn",
+      {
+        "maxLength": 64
+      }
+    ]
+  }
 }