Configure Hardhat project for running extension on a forked Mainnet

In this commit we create a Hardhat project that allows for running Taho
extension on a forked Mainnet. As part of this we're configuring a `hardhat`
network in the Hardhat config file. The fork will begin on a block specified in
the `blockNumber` parameter. The `url` parameter should hold an url to a
JSON-RPC node that's based on your personal Infura/Alchemy API key (e.g.
`https://mainnet.infura.io/v3/<key>`). The suggested value for `chainId` is
`1337`.
The steps to run the network are described in the README file.
Any actions performed on the `hardhat` network will only be applied locally,
they will not affect the real Mainnet network.

.gitignore

@@ -10,3 +10,4 @@ app/extension-scripts/api/playground/
 .vscode
 playwright-report
 test-results/
+ci/cache/

.prettierignore

@@ -2,3 +2,4 @@ dist
 # Ignore weblate json translation formatting
 ui/_locales/**/*.json
 !.github
+ci/cache

.tsconfig-eslint.json

@@ -7,5 +7,11 @@
     "**/*.tsx",
     ".github/**/*.js"
   ],
-  "exclude": ["node_modules", "dist", "**/validate/*.js", "**/local-chain/**"]
+  "exclude": [
+    "node_modules",
+    "dist",
+    "**/validate/*.js",
+    "**/local-chain/**",
+    "ci/cache"
+  ]
 }

ci/README.md

@@ -0,0 +1,37 @@
+# Running Taho extension on a forked Mainnet
+
+## Configuration / running
+
+To run the extension on a forked Mainnet:
+
+1. Configure required environment variables (either by setting them in `../.env`
+   or directly in the console):  
+   `USE_MAINNET_FORK=true` (needed for building the package)  
+   `MAINNET_FORK_CHAIN_ID=1337` (needed for running Hardhat, `1337` is the
+   suggested and a default value)  
+   `CHAIN_API_URL=<Insert_your_API_URL_here>` (needed for running Hardhat, may
+   be e.g. Alchemy or Infura API URL)
+   `FORKING_BLOCK=<Insert_forking_block_here>` (needed for running Hardhat, if
+   not specified, current block will be used)
+
+2. Run the following commands from root:  
+   `yarn install`  
+   `yarn start` (or `yarn build`)  
+   `cd ci`  
+   `npx hardhat node --network hardhat`
+
+3. Unpack `./dist/chrome` to Chrome Extensions.
+
+## What wallet features work / don't work on the `hardhat` network
+
+When run on `1337`:
+
+:heavy_plus_sign: we can use specific block as a start.  
+:heavy_plus_sign: we can send txs and do swaps (balances updated)  
+:heavy_plus_sign: we can browse NFTs  
+:heavy_minus_sign: the activities are not loading
+:heavy_minus_sign: wallet shows strange assets  
+:heavy_minus_sign: if no cache exists, loading assets takes long, account
+avatars may look strange
+
+State of the network is lost after Hardhat reset.

ci/hardhat.config.ts

@@ -0,0 +1,23 @@
+import { HardhatUserConfig } from "hardhat/config"
+import "dotenv-defaults/config"
+
+/* eslint-disable @typescript-eslint/no-var-requires */
+require(`dotenv-defaults`).config({
+  path: "../.env",
+  defaults: "../.env.defaults",
+})
+
+const config: HardhatUserConfig = {
+  networks: {
+    hardhat: {
+      forking: {
+        enabled: true,
+        url: process.env.CHAIN_API_URL || "",
+        blockNumber: parseInt(process.env.FORKING_BLOCK ?? "", 10),
+      },
+      chainId: parseInt(process.env.MAINNET_FORK_CHAIN_ID ?? "1337", 10),
+    },
+  },
+}
+
+export default config

ci/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@tallyho/ci",
+  "version": "0.0.1",
+  "description": "Taho, the community owned and operated Web3 wallet: window provider is responsible for creating the in-page object for communication.",
+  "repository": "[email protected]:thesis/tally-extension.git",
+  "author": "Michalina Cienciala",
+  "license": "GPL-3.0",
+  "keywords": [
+    "ethereum",
+    "bitcoin",
+    "cryptocurrency",
+    "wallet",
+    "web3",
+    "dapp"
+  ],
+  "devDependencies": {
+    "dotenv-defaults": "^5.0.2",
+    "hardhat": "^2.14.0"
+  }
+}

package.json

@@ -56,7 +56,8 @@
     "background",
     "provider-bridge",
     "provider-bridge-shared",
-    "window-provider"
+    "window-provider",
+    "ci"
   ],
   "dependencies": {
     "@ethersproject/providers": "5.5.3",
@@ -109,6 +110,7 @@
     "eslint-plugin-react": "^7.24.0",
     "eslint-plugin-react-hooks": "^4.2.0",
     "fork-ts-checker-webpack-plugin": "^6.3.2",
+    "hardhat": "^2.14.0",
     "install": "^0.13.0",
     "jest": "^27.2.2",
     "npm": "^7.5.6",