fix: Add a database to the Deploy Campaign

.circleci/config.yml

@@ -8,6 +8,7 @@ defaults: &defaults
   working_directory: ~/repo
   docker:
     - image: cimg/node:18.15.0
+    - image: mongo:7.0.0-rc5-jammy
 
 jobs:
   test and coverage:

.gitignore

@@ -10,10 +10,9 @@ typechain-types
 cache
 artifacts
 
-# Local DB
-db
-
 # hardhat-tenderly plugin
 deployments
 
 *.env
+docker
+docker*.tgz

docker-compose.yml

@@ -0,0 +1,10 @@
+version: "2"
+services:
+  mongo:
+    image: mongo:7.0.0-rc5-jammy
+    ports:
+      - "27018:27017"
+    volumes:
+      - mongo-data:/data/db
+volumes:
+  mongo-data:

hardhat.config.ts

@@ -1,121 +1,135 @@
-/* eslint-disable @typescript-eslint/no-var-requires, @typescript-eslint/no-unused-vars */
-require("dotenv").config();
-
-import { HardhatUserConfig } from "hardhat/config";
-import * as tenderly from "@tenderly/hardhat-tenderly";
-import "@nomicfoundation/hardhat-toolbox";
-import "@nomiclabs/hardhat-ethers";
-import "@nomicfoundation/hardhat-network-helpers";
-import "@nomicfoundation/hardhat-chai-matchers";
-import "@openzeppelin/hardhat-upgrades";
-import "solidity-coverage";
-import "solidity-docgen";
-import "hardhat-gas-reporter";
-
-// This call is needed to initialize Tenderly with Hardhat,
-// the automatic verifications, though, don't seem to work,
-// needing us to verify explicitly in code, however,
-// for Tenderly to work properly with Hardhat this method
-// needs to be called. The call below is commented out
-// because if we leave it here, solidity-coverage
-// does not work properly locally or in CI, so we
-// keep it commented out and uncomment when using DevNet
-// locally.
-// !!! Uncomment this when using Tenderly DevNet !!!
-// tenderly.setup({ automaticVerifications: false });
-
-const config : HardhatUserConfig = {
-  solidity: {
-    compilers: [
-      {
-        version: "0.8.18",
-        settings: {
-          optimizer: {
-            enabled: true,
-            runs: 200,
-          },
-        },
-      },
-      {
-        version: "0.8.3",
-        settings: {
-          optimizer: {
-            enabled: true,
-            runs: 200,
-          },
-        },
-      },
-    ],
-    overrides: {
-      "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol": {
-        version: "0.8.9",
-        settings: {
-          optimizer: {
-            enabled: true,
-            runs: 200,
-          },
-        },
-      },
-      "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol": {
-        version: "0.8.9",
-        settings: {
-          optimizer: {
-            enabled: true,
-            runs: 200,
-          },
-        },
-      },
-    },
-  },
-  paths: {
-    sources: "./contracts",
-    tests: "./test",
-    cache: "./cache",
-    artifacts: "./artifacts",
-  },
-  typechain: {
-    outDir: "typechain",
-  },
-  mocha: {
-    timeout: 5000000,
-  },
-  gasReporter: {
-    enabled: false,
-  },
-  networks: {
-    mainnet: {
-      url: "https://mainnet.infura.io/v3/97e75e0bbc6a4419a5dd7fe4a518b917",
-      gasPrice: 80000000000,
-    },
-    goerli: {
-      url: "https://goerli.infura.io/v3/77c3d733140f4c12a77699e24cb30c27",
-      timeout: 10000000,
-    },
-    devnet: {
-      // Add current URL that you spawned if not using automated spawning
-      url: `${process.env.DEVNET_RPC_URL}`,
-      chainId: 1,
-    },
-  },
-  etherscan: {
-    apiKey: `${process.env.ETHERSCAN_API_KEY}`,
-  },
-  tenderly: {
-    project: `${process.env.TENDERLY_PROJECT_SLUG}`,
-    username: `${process.env.TENDERLY_ACCOUNT_ID}`,
-  },
-  docgen: {
-    pages: "files",
-    templates: "docs/docgen-templates",
-    outputDir: "docs/contracts",
-    exclude: [
-      "upgrade-test-mocks/",
-      "upgradeMocks/",
-      "token/mocks/",
-      "utils/",
-      "oz-proxies/",
-    ],
-  },
-};
-
-export default config;
+/* eslint-disable @typescript-eslint/no-var-requires, @typescript-eslint/no-unused-vars */
+
+import { mochaGlobalSetup, mochaGlobalTeardown } from "./test/mocha-global";
+
+require("dotenv").config();
+
+import * as tenderly from "@tenderly/hardhat-tenderly";
+import "@nomicfoundation/hardhat-toolbox";
+import "@nomiclabs/hardhat-ethers";
+import "@nomicfoundation/hardhat-network-helpers";
+import "@nomicfoundation/hardhat-chai-matchers";
+import "@openzeppelin/hardhat-upgrades";
+import "solidity-coverage";
+import "solidity-docgen";
+import "hardhat-gas-reporter";
+import { HardhatUserConfig, subtask } from "hardhat/config";
+import { TASK_TEST_RUN_MOCHA_TESTS } from "hardhat/builtin-tasks/task-names";
+
+
+subtask(TASK_TEST_RUN_MOCHA_TESTS)
+  .setAction(async (args, hre, runSuper) => {
+    await mochaGlobalSetup();
+    const testFailures = await runSuper(args);
+    await mochaGlobalTeardown();
+
+    return testFailures;
+  });
+
+// This call is needed to initialize Tenderly with Hardhat,
+// the automatic verifications, though, don't seem to work,
+// needing us to verify explicitly in code, however,
+// for Tenderly to work properly with Hardhat this method
+// needs to be called. The call below is commented out
+// because if we leave it here, solidity-coverage
+// does not work properly locally or in CI, so we
+// keep it commented out and uncomment when using DevNet
+// locally.
+// !!! Uncomment this when using Tenderly DevNet !!!
+// tenderly.setup({ automaticVerifications: false });
+
+const config : HardhatUserConfig = {
+  solidity: {
+    compilers: [
+      {
+        version: "0.8.18",
+        settings: {
+          optimizer: {
+            enabled: true,
+            runs: 200,
+          },
+        },
+      },
+      {
+        version: "0.8.3",
+        settings: {
+          optimizer: {
+            enabled: true,
+            runs: 200,
+          },
+        },
+      },
+    ],
+    overrides: {
+      "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol": {
+        version: "0.8.9",
+        settings: {
+          optimizer: {
+            enabled: true,
+            runs: 200,
+          },
+        },
+      },
+      "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol": {
+        version: "0.8.9",
+        settings: {
+          optimizer: {
+            enabled: true,
+            runs: 200,
+          },
+        },
+      },
+    },
+  },
+  paths: {
+    sources: "./contracts",
+    tests: "./test",
+    cache: "./cache",
+    artifacts: "./artifacts",
+  },
+  typechain: {
+    outDir: "typechain",
+  },
+  mocha: {
+    timeout: 5000000,
+  },
+  gasReporter: {
+    enabled: false,
+  },
+  networks: {
+    mainnet: {
+      url: "https://mainnet.infura.io/v3/97e75e0bbc6a4419a5dd7fe4a518b917",
+      gasPrice: 80000000000,
+    },
+    goerli: {
+      url: "https://goerli.infura.io/v3/77c3d733140f4c12a77699e24cb30c27",
+      timeout: 10000000,
+    },
+    devnet: {
+      // Add current URL that you spawned if not using automated spawning
+      url: `${process.env.DEVNET_RPC_URL}`,
+      chainId: 1,
+    },
+  },
+  etherscan: {
+    apiKey: `${process.env.ETHERSCAN_API_KEY}`,
+  },
+  tenderly: {
+    project: `${process.env.TENDERLY_PROJECT_SLUG}`,
+    username: `${process.env.TENDERLY_ACCOUNT_ID}`,
+  },
+  docgen: {
+    pages: "files",
+    templates: "docs/docgen-templates",
+    outputDir: "docs/contracts",
+    exclude: [
+      "upgrade-test-mocks/",
+      "upgradeMocks/",
+      "token/mocks/",
+      "utils/",
+      "oz-proxies/",
+    ],
+  },
+};
+
+export default config;

package.json

@@ -17,13 +17,20 @@
     "clean": "hardhat clean",
     "build": "yarn run clean && yarn run compile",
     "typechain": "hardhat typechain",
+    "pretest": "yarn mongo:start",
     "test": "hardhat test",
+    "test-local": "yarn test",
+    "posttest": "yarn mongo:stop",
     "semantic-release": "semantic-release --tag-format='v${version}-dev'",
     "coverage": "hardhat coverage",
     "check-coverage": "istanbul check-coverage --statements 90 --branches 87 --functions 89 --lines 90",
     "devnet": "ts-node src/tenderly/devnet/devnet-execute.ts",
     "gas-cost": "ts-node src/utils/gas-costs.ts",
-    "docgen": "hardhat docgen"
+    "docgen": "hardhat docgen",
+    "mongo:start": "docker-compose up -d",
+    "mongo:stop": "docker-compose stop",
+    "mongo:down": "docker-compose down",
+    "mongo:drop": "ts-node src/utils/drop-db.ts"
   },
   "pre-commit": [
     "lint"
@@ -49,15 +56,14 @@
     "@types/mocha": "9.1.0",
     "@types/node": "^18.15.11",
     "@zero-tech/eslint-config-cpt": "0.2.7",
-    "@zero-tech/ztoken": "^2.0.0",
+    "@zero-tech/ztoken": "2.0.0",
     "chai": "4.2.0",
     "eslint": "^8.37.0",
     "ethers": "5.5.1",
     "hardhat": "2.13.0",
     "hardhat-gas-reporter": "1.0.8",
-    "logdown": "3.3.1",
     "semantic-release": "^21.0.1",
-    "solhint": "^3.4.1",
+    "solhint": "4.0.0",
     "solidity-coverage": "^0.8.2",
     "solidity-docgen": "^0.6.0-beta.35",
     "ts-node": "10.9.1",
@@ -67,9 +73,7 @@
   "dependencies": {
     "axios": "^1.4.0",
     "dotenv": "16.0.3",
+    "mongodb": "^6.1.0",
     "winston": "^3.11.0"
-  },
-  "resolutions": {
-    "@solidity-parser/parser": "0.16.0"
   }
 }