♻️ Upgrade to ethers v6 (#167)

Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>

.eslintignore

@@ -1,7 +1,7 @@
 node_modules
+cache
+cache_hardhat-zk
 artifacts
 artifacts-zk
-cache
-cache-zk
-coverage
 typechain-types
+coverage

.eslintrc.js

@@ -2,6 +2,9 @@
 module.exports = {
   root: true,
   parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 12,
+  },
   plugins: ["@typescript-eslint"],
   extends: [
     "eslint:recommended",

.github/workflows/checks.yml

@@ -20,24 +20,35 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Cache node modules
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: latest
+          run_install: false
+
+      - name: Get pnpm cache directory path
+        id: pnpm-cache-dir-path
+        run: echo "dir=$(pnpm store path --silent)" >> $GITHUB_OUTPUT
+
+      - name: Restore pnpm cache
         uses: actions/cache@v3
+        id: pnpm-cache
         with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          path: ${{ steps.pnpm-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
           restore-keys: |
-            ${{ runner.os }}-node-
+            ${{ runner.os }}-pnpm-store-
 
       - name: Use Node.js ${{ matrix.node_version }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node_version }}
 
-      - name: Install npm project with a clean slate
-        run: npm ci --prefer-offline
+      - name: Install pnpm project with a clean slate
+        run: pnpm install --prefer-offline --frozen-lockfile
 
       - name: Prettier and lint
-        run: npm run lint:check
+        run: pnpm lint:check
 
   codespell:
     runs-on: ${{ matrix.os }}
@@ -54,7 +65,7 @@ jobs:
         uses: codespell-project/actions-codespell@v2.0
         with:
           check_filenames: true
-          skip: ./.git,package-lock.json
+          skip: ./.git,pnpm-lock.yaml
 
   validate-links:
     runs-on: ${{ matrix.os }}

.github/workflows/test-contracts.yml

@@ -9,6 +9,9 @@ concurrency:
 jobs:
   tests:
     runs-on: ${{ matrix.os }}
+    permissions:
+      contents: read
+      security-events: write
     strategy:
       matrix:
         os:
@@ -20,27 +23,45 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Cache node modules
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: latest
+          run_install: false
+
+      - name: Get pnpm cache directory path
+        id: pnpm-cache-dir-path
+        run: echo "dir=$(pnpm store path --silent)" >> $GITHUB_OUTPUT
+
+      - name: Restore pnpm cache
         uses: actions/cache@v3
+        id: pnpm-cache
         with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          path: ${{ steps.pnpm-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
           restore-keys: |
-            ${{ runner.os }}-node-
+            ${{ runner.os }}-pnpm-store-
 
       - name: Use Node.js ${{ matrix.node_version }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node_version }}
 
-      - name: Install npm project with a clean slate
-        run: npm ci --prefer-offline
+      - name: Install pnpm project with a clean slate
+        run: pnpm install --prefer-offline --frozen-lockfile
 
       - name: Hardhat tests
-        run: npm run test
+        run: pnpm test
 
       - name: Slither static analyser
         uses: crytic/slither-action@v0.3.0
-        continue-on-error: true
+        id: slither
         with:
           node-version: ${{ matrix.node_version }}
+          fail-on: config
+          sarif: results.sarif
+
+      - name: Upload SARIF file
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: ${{ steps.slither.outputs.sarif }}

.gitignore

@@ -23,9 +23,12 @@ node_modules
 .env.local
 
 # Log files
+logs
+*.log
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+.pnpm-debug.log*
 
 # Yarn integrity file
 .yarn-integrity
@@ -45,6 +48,7 @@ yarn-error.log*
 
 # Hardhat files
 cache
+cache_hardhat
 artifacts
 .deps
 
@@ -56,7 +60,7 @@ coverage
 coverage.json
 
 # zkSync files
-cache-zk
+cache_hardhat-zk
 artifacts-zk
 
 # Miscellaneous files

.prettierignore

@@ -1,7 +1,7 @@
 node_modules
+cache
+cache_hardhat-zk
 artifacts
 artifacts-zk
-cache
-cache-zk
-coverage
 typechain-types
+coverage

.solhintignore

@@ -1,8 +1,7 @@
 node_modules
+cache
+cache_hardhat-zk
 artifacts
 artifacts-zk
-cache
-cache-zk
-coverage
 typechain-types
-flattened
+coverage

README.md

@@ -14,15 +14,15 @@ Helper smart contract to make easier and safer usage of the [`CREATE2`](https://
 Since [Hardhat](https://hardhat.org) implements great features for Solidity debugging like Solidity stack traces, `console.log`, and explicit error messages when transactions fail, we leverage [Hardhat](https://hardhat.org) for testing:
 
 ```console
-npm run test
+pnpm run test
 ```
 
 ### Test Coverage
 
 This project repository implements a test coverage [plugin](https://github.com/sc-forks/solidity-coverage). Simply run:
 
 ```console
-npm run coverage
+pnpm run coverage
 ```
 
 The written tests available in the file [`Create2Deployer.test.ts`](./test/Create2Deployer.test.ts) achieve a test coverage of 100%:

SECURITY.md

@@ -0,0 +1,52 @@
+# 🛡️ Security Policy
+
+## 📬 Reporting a Vulnerability
+
+Please report any security issues you find to [pascal.caversaccio@hotmail.ch](mailto:pascal.caversaccio@hotmail.ch). My public PGP key is:
+
+```sh
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Comment: Type:	3,072-bit RSA
+Comment: Fingerprint:	063E966C93AB4356492FE0327C3B4B4B7725111F
+
+
+mQGNBGBUv08BDADTYA0GjLhbKbCezlVAubakXh0jcIbkqZPF1wueSbSgDjlS6+d8
+67V6ft4hNXJhpNxqr07LrcbUEDdB7WK8EUA9qsLtVRznR/B8y2HwrFs7jbYAUzl6
+lZ6UgzXl2QCeKI3B3foa7aGDeBkm1um3zXlR4+b8d4krO8pZTJepC5T+UF3C81Kb
+lV+6s+bSsHPtLHwBh+tJtSFF7hQoU1lhVW0hKVGUUwGfoFuYjWh47fLtiEvvtM2e
+EUZ/0v9nMTKg+tuk4nrR7J+ARdDxaqDWLNTwzGvuTAgkjw6I+zrzFmgsAbdFLFKE
+e4+wzE/fb3BAWVRDruhNJmSLqTpkLYyoLkf5GAf9X1gAdeCbiwBgeRnF4m8gLUul
+m7mixTW45TOAm9upCZaYWhYQpHosix5NLaBAGMCaTgzJS4Ij8BGh6Td+vv2RYIW+
+j8tfg6uwGXYsclk609bXk6Z2S+DZalNtbSffwCKXqAU4jO194JYL471tB+OvkF6g
+KciJZOs+OB0fZc8AEQEAAbQ4UGFzY2FsIE1hcmNvIENhdmVyc2FjY2lvIDxwYXNj
+YWwuY2F2ZXJzYWNjaW9AaG90bWFpbC5jaD6JAc4EEwEIADgCGwMFCwkIBwIGFQoJ
+CAsCBBYCAwECHgECF4AWIQQGPpZsk6tDVkkv4DJ8O0tLdyURHwUCYvqMQAAKCRB8
+O0tLdyURH85gC/oCX3nn+TK/t/tkiOzVnPlCECbrayQlIEgenE7s+oHP6XouhtWJ
+UOq7vyssZ+QPqMVNXsXzQrzlf52KVUTHtaSysus4l5lMX1Uuj+Mzy/vAEnPi2+Qo
+XZE3xHv+H/kFnqnM6U4MB9OCvOC5fz/cx28141w7dbFTqquBJPIb0DUSTtWpIcqV
+zr0sHx59+BMyB3gNiaT6KXmcBCrLlszySuEtw9MMfrfBYuNUXQv2efl3ZjVaN5Ah
+LErIZwlJG1OJ+l5WPbPEceh5k7BIqksNBB6T5kkgNbsju22Bc8t2NkxKRHzUmwMz
+p1Z30kNNtLmkv3M+ZQZYyKtMGhFf9cll6x/Z8NATEo/rfzbUdlmmodl0Zt07Yla4
+jJ23oRSzgzsqiwyN3PA+iOtkNeR/UfrWFKss5RY+B5QTH/GSHvd5yKB7AWjTo2mM
+oo1uydwlboN6EfiK10+4sveVG/DdQIVkiu2wAYsS3UL7V0q5Yava0wQmhqNeyWcM
+8xRq/K0pbJk8rwy5AY0EYFS/TwEMALgHOcvmfAc12vcYA+RjtLZPoqIBzPsyvEJi
+ryq45AdpSDKa+xLWXIyGCKdlaEZ0Ts9rGtXhW4Sg/YWZhBPbOftu5fsp8d9NWKTD
+Pbomob7UeAj9jxS8GCArkG0L6IagH4LopbKtOmh5JjavCjIWe3rRNe1hA1jVa2ES
+QSPfotHPm8728eO1lyOdGgukThvS3El5cUcwY0isAFKq6Z8JL2gawtR1J4ceQQGu
+b9PFUeSrWe05nQlgXTyZUyN6RPBTKAQwO0zEAcYhLMEizzfuiTOKQTUw5pDwFgEw
+nQ2tI+SYui+GTBlmd0XzBlPlgQMSCvSLZG4Vg8nK0hJdqxHadtKmnew9+vrcj4bP
+UG0qFesg9hbdj6UzKHUZL0Y76jNrgKwXFGmQJP0L+y+XqJGIX39ugOcccjntH7Ct
+xU1/Eqmcv3K0CXXAYu3OirVF51X72ynTTI5xcxHgSBGSPjPS57cNmqm6YslZ9NCE
+4RDw9wtjzWmnUGQDK0nxY0X/t3pt9QARAQABiQG8BBgBCAAmFiEEBj6WbJOrQ1ZJ
+L+AyfDtLS3clER8FAmBUv08CGwwFCQPCK+EACgkQfDtLS3clER9WqQv9Ez1n8Nk6
+9PQjM7Blcu5l7MH1ZYX+w9WM2U2HlrbuCebikQLBb2PalO0WXfwHAUcv74onMBYY
+D8ImgBuRMBOBFTzL7JKYCwpaCvnZQI7MMQe/llYRZvtpGy1uK6cHHcunlQl4+AlP
+miItRSLobrZlUU6WrDrHQNmPsdlXtZYc1htA/YyzpCEhkjAj8HzrubZ87OH2Mmkc
+TuXRR4NF04BXcBDp/LzFOPCSLB5Z6PwNFRFb4sZa2pbWZkLVP5HjkyJfopxueapp
+R5g0SE+9sJTz+cjyxu8bzYufoAQ1wH7SMa0lrH+x0mFASjEP9KoZKk6+v8Vj2viT
+sq0oF8aqSLh4eRADXkERzL99UAVIolME2rkugC6B+5hyxkY6bQTAiqAdAY5w8M+b
+fbgPyGx7AySNu0+RgAtfDfqG6Mz3SotgdgOU21M+mUHnfbDSlDlIGU8sZczrXxS2
+aMfM1uqzowVfLswMuFVdq37A/fTmnkacc8o2ZSIEPHtfflDxHw4emaxr
+=Hf4k
+-----END PGP PUBLIC KEY BLOCK-----
+```

contracts/mocks/ERC20Mock.sol

@@ -1,18 +1,18 @@
 // SPDX-License-Identifier: MIT
-// Source: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/mocks/ERC20Mock.sol
+// Source: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/mocks/token/ERC20Mock.sol
 pragma solidity ^0.8.9;
 
 import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 
 // Mock class using ERC20
 contract ERC20Mock is ERC20 {
     constructor(
-        string memory name,
-        string memory symbol,
-        address initialAccount,
-        uint256 initialBalance
-    ) payable ERC20(name, symbol) {
-        _mint(initialAccount, initialBalance);
+        string memory name_,
+        string memory symbol_,
+        address initialAccount_,
+        uint256 initialBalance_
+    ) payable ERC20(name_, symbol_) {
+        _mint(initialAccount_, initialBalance_);
     }
 
     function mint(address account, uint256 amount) public {

deploy/deploy-zksync.ts

@@ -1,6 +1,6 @@
 // Note that the deployment scripts must be placed in the `deploy` folder for `hardhat deploy-zksync`
 import { HardhatRuntimeEnvironment } from "hardhat/types";
-import { Wallet } from "zksync-web3";
+import { Wallet } from "zksync-ethers";
 import { Deployer } from "@matterlabs/hardhat-zksync-deploy";
 
 const PRIVATE_KEY: string = process.env.PRIVATE_KEY_ZKS || "";
@@ -16,8 +16,8 @@ export default async function main(hre: HardhatRuntimeEnvironment) {
   const artifact = await deployer.loadArtifact("Create2Deployer");
   const create2Deployer = await deployer.deploy(artifact);
 
-  await create2Deployer.deployed();
-  const create2DeployerAddress = create2Deployer.address;
+  await create2Deployer.waitForDeployment();
+  const create2DeployerAddress = await create2Deployer.getAddress();
 
   console.log("Create2Deployer deployed to:", create2DeployerAddress);
 

hardhat.config.ts

@@ -1,13 +1,15 @@
 import * as dotenv from "dotenv";
 
 import { HardhatUserConfig, task } from "hardhat/config";
-import "@nomiclabs/hardhat-truffle5";
+import "@nomicfoundation/hardhat-ethers";
 import "@nomicfoundation/hardhat-verify";
 import "@nomicfoundation/hardhat-chai-matchers";
 import "@typechain/hardhat";
+
 import "@matterlabs/hardhat-zksync-solc";
 import "@matterlabs/hardhat-zksync-deploy";
 import "@matterlabs/hardhat-zksync-verify";
+import "@matterlabs/hardhat-zksync-ethers";
 import "hardhat-gas-reporter";
 import "solidity-coverage";
 import "hardhat-abi-exporter";
@@ -22,6 +24,22 @@ task("accounts", "Prints the list of accounts", async (_, hre) => {
   }
 });
 
+task(
+  "balances",
+  "Prints the list of accounts and their balances",
+  async (_, hre) => {
+    const accounts = await hre.ethers.getSigners();
+
+    for (const account of accounts) {
+      console.log(
+        account.address +
+          " " +
+          (await hre.ethers.provider.getBalance(account.address)),
+      );
+    }
+  },
+);
+
 const config: HardhatUserConfig = {
   solidity: {
     // Only use Solidity default versions `>=0.8.20` for EVM networks that support the opcode `PUSH0`
@@ -30,7 +48,7 @@ const config: HardhatUserConfig = {
     settings: {
       optimizer: {
         enabled: true,
-        runs: 999999,
+        runs: 999_999,
       },
     },
   },
@@ -345,15 +363,15 @@ const config: HardhatUserConfig = {
     zkSyncTestnet: {
       chainId: 300,
       url: process.env.ZKSYNC_TESTNET_URL || "",
-      ethNetwork: process.env.ETH_SEPOLIA_TESTNET_URL || "",
+      ethNetwork: "sepolia",
       zksync: true,
       verifyURL:
         "https://explorer.sepolia.era.zksync.dev/contract_verification",
     },
     zkSyncMain: {
       chainId: 324,
       url: process.env.ZKSYNC_MAINNET_URL || "",
-      ethNetwork: process.env.ETH_MAINNET_URL || "",
+      ethNetwork: "mainnet",
       zksync: true,
       verifyURL:
         "https://zksync2-mainnet-explorer.zksync.io/contract_verification",
@@ -468,6 +486,10 @@ const config: HardhatUserConfig = {
     spacing: 2,
     pretty: true,
   },
+  sourcify: {
+    // Enable Sourcify verification by default
+    enabled: true,
+  },
   etherscan: {
     apiKey: {
       // For Ethereum testnets & mainnet