feat: always run the upgrade validation script before upgrading

Author: jaybuidl

contracts/deploy/upgrade-all.ts

@@ -20,14 +20,17 @@ const deployUpgradeAll: DeployFunction = async (hre: HardhatRuntimeEnvironment)
 
   const upgrade = async (contractName: string, initializer: string, args: any[]) => {
     try {
+      print.highlight(`🔍 Validating upgrade of ${bold(contractName)}`);
+      await hre.run("compare-storage", { contract: contractName });
+      print.newline();
       print.highlight(`💣 Upgrading ${bold(contractName)}`);
       const { confirm } = await prompt.ask({
         type: "confirm",
         name: "confirm",
         message: "Are you sure you want to proceed?",
       });
       if (!confirm) {
-        console.log("Operation cancelled by user.");
+        print.info("Operation cancelled by user.");
         return;
       }
       print.info(`Upgrading ${contractName}...`);

contracts/deploy/upgrade-dispute-kit-v0.8.0.ts

@@ -3,6 +3,9 @@ import { DeployFunction } from "hardhat-deploy/types";
 import { deployUpgradable } from "./utils/deployUpgradable";
 import { HomeChains, isSkipped } from "./utils";
 import { getContractNamesFromNetwork } from "../scripts/utils/contracts";
+import { print, prompt } from "gluegun";
+
+const { bold } = print.colors;
 
 const deployUpgradeDisputeKit: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { deployments, getNamedAccounts, getChainId } = hre;
@@ -14,7 +17,20 @@ const deployUpgradeDisputeKit: DeployFunction = async (hre: HardhatRuntimeEnviro
 
   try {
     const { disputeKitClassic: contractName } = await getContractNamesFromNetwork(hre);
-    console.log(`upgrading ${contractName}...`);
+    print.highlight(`🔍 Validating upgrade of ${bold(contractName)}`);
+    await hre.run("compare-storage", { contract: contractName });
+    print.newline();
+    print.highlight(`💣 Upgrading ${bold(contractName)}`);
+    const { confirm } = await prompt.ask({
+      type: "confirm",
+      name: "confirm",
+      message: "Are you sure you want to proceed?",
+    });
+    if (!confirm) {
+      print.info("Operation cancelled by user.");
+      return;
+    }
+    print.info(`Upgrading ${contractName}...`);
     await deployUpgradable(deployments, contractName, {
       contract: contractName,
       initializer: "initialize2",

contracts/deploy/upgrade-kleros-core-v0.8.0.ts

@@ -3,6 +3,9 @@ import { DeployFunction } from "hardhat-deploy/types";
 import { deployUpgradable } from "./utils/deployUpgradable";
 import { HomeChains, isSkipped } from "./utils";
 import { getContractNamesFromNetwork } from "../scripts/utils/contracts";
+import { print, prompt } from "gluegun";
+
+const { bold } = print.colors;
 
 const deployUpgradeKlerosCore: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { deployments, getNamedAccounts, getChainId } = hre;
@@ -14,7 +17,20 @@ const deployUpgradeKlerosCore: DeployFunction = async (hre: HardhatRuntimeEnviro
 
   try {
     const { core: contractName } = await getContractNamesFromNetwork(hre);
-    console.log(`upgrading ${contractName}...`);
+    print.highlight(`🔍 Validating upgrade of ${bold(contractName)}`);
+    await hre.run("compare-storage", { contract: contractName });
+    print.newline();
+    print.highlight(`💣 Upgrading ${bold(contractName)}`);
+    const { confirm } = await prompt.ask({
+      type: "confirm",
+      name: "confirm",
+      message: "Are you sure you want to proceed?",
+    });
+    if (!confirm) {
+      print.info("Operation cancelled by user.");
+      return;
+    }
+    print.info(`Upgrading ${contractName}...`);
     await deployUpgradable(deployments, contractName, {
       contract: contractName,
       initializer: "initialize3",

contracts/deploy/upgrade-sortition-module-v0.8.0.ts

@@ -3,6 +3,9 @@ import { DeployFunction } from "hardhat-deploy/types";
 import { deployUpgradable } from "./utils/deployUpgradable";
 import { HomeChains, isSkipped } from "./utils";
 import { getContractNamesFromNetwork } from "../scripts/utils/contracts";
+import { print, prompt } from "gluegun";
+
+const { bold } = print.colors;
 
 const deployUpgradeSortitionModule: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { deployments, getNamedAccounts, getChainId } = hre;
@@ -14,7 +17,20 @@ const deployUpgradeSortitionModule: DeployFunction = async (hre: HardhatRuntimeE
 
   try {
     const { sortition: contractName } = await getContractNamesFromNetwork(hre);
-    console.log(`upgrading ${contractName}...`);
+    print.highlight(`🔍 Validating upgrade of ${bold(contractName)}`);
+    await hre.run("compare-storage", { contract: contractName });
+    print.newline();
+    print.highlight(`💣 Upgrading ${bold(contractName)}`);
+    const { confirm } = await prompt.ask({
+      type: "confirm",
+      name: "confirm",
+      message: "Are you sure you want to proceed?",
+    });
+    if (!confirm) {
+      print.info("Operation cancelled by user.");
+      return;
+    }
+    print.info(`Upgrading ${contractName}...`);
     await deployUpgradable(deployments, contractName, {
       contract: contractName,
       initializer: "initialize3",

contracts/package.json

@@ -28,6 +28,7 @@
     "deploy": "hardhat deploy",
     "deploy-local": "hardhat deploy --tags Arbitration,HomeArbitrable --network localhost",
     "validate-upgrades": "openzeppelin-upgrades-core validate --exclude 'src/proxy/mock/**/*.sol' --exclude 'src/test/**/*.sol' artifacts/build-info",
+    "validate-upgrades-against-deployed": "hardhat compare-storage",
     "simulate": "hardhat simulate:all",
     "simulate-local": "hardhat simulate:all --network localhost",
     "viem:generate-devnet": "NODE_NO_WARNINGS=1 wagmi generate -c wagmi.config.devnet.ts",
@@ -77,7 +78,7 @@
     "@nomicfoundation/hardhat-chai-matchers": "^2.0.8",
     "@nomicfoundation/hardhat-ethers": "^3.0.8",
     "@nomiclabs/hardhat-solhint": "^4.0.1",
-    "@openzeppelin/upgrades-core": "^1.41.0",
+    "@openzeppelin/upgrades-core": "^1.42.2",
     "@typechain/ethers-v6": "^0.5.1",
     "@typechain/hardhat": "^9.1.0",
     "@types/chai": "^4.3.20",

contracts/scripts/compareStorageLayout.ts

@@ -55,9 +55,6 @@ task("compare-storage", "Compare storage layout between deployed and modified co
 
       const report = getStorageUpgradeReport(originalLayout, updatedLayout, validationOptions);
 
-      print.info(`\n${bold("Storage Layout Analysis:")}`);
-      print.info("=".repeat(100));
-
       if (report.ok) {
         print.success("✓ No storage layout incompatibilities found");
         return;

yarn.lock

@@ -5559,7 +5559,7 @@ __metadata:
     "@nomicfoundation/hardhat-ethers": "npm:^3.0.8"
     "@nomiclabs/hardhat-solhint": "npm:^4.0.1"
     "@openzeppelin/contracts": "npm:^5.2.0"
-    "@openzeppelin/upgrades-core": "npm:^1.41.0"
+    "@openzeppelin/upgrades-core": "npm:^1.42.2"
     "@typechain/ethers-v6": "npm:^0.5.1"
     "@typechain/hardhat": "npm:^9.1.0"
     "@types/chai": "npm:^4.3.20"
@@ -7402,7 +7402,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@openzeppelin/upgrades-core@npm:^1.24.1, @openzeppelin/upgrades-core@npm:^1.41.0":
+"@openzeppelin/upgrades-core@npm:^1.24.1":
   version: 1.41.0
   resolution: "@openzeppelin/upgrades-core@npm:1.41.0"
   dependencies:
@@ -7422,6 +7422,26 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@openzeppelin/upgrades-core@npm:^1.42.2":
+  version: 1.42.2
+  resolution: "@openzeppelin/upgrades-core@npm:1.42.2"
+  dependencies:
+    "@nomicfoundation/slang": "npm:^0.18.3"
+    cbor: "npm:^10.0.0"
+    chalk: "npm:^4.1.0"
+    compare-versions: "npm:^6.0.0"
+    debug: "npm:^4.1.1"
+    ethereumjs-util: "npm:^7.0.3"
+    minimatch: "npm:^9.0.5"
+    minimist: "npm:^1.2.7"
+    proper-lockfile: "npm:^4.1.1"
+    solidity-ast: "npm:^0.4.51"
+  bin:
+    openzeppelin-upgrades-core: dist/cli/cli.js
+  checksum: 10/7000c7cf6822eab2b8a927acc1f09b769004667644e389ae582cd4f87f74433cdd3bc80477f95990d40bb60c15b85e61e5ad4cd47e0e7e70c4e5cbef6cbad10c
+  languageName: node
+  linkType: hard
+
 "@parcel/watcher-android-arm64@npm:2.3.0":
   version: 2.3.0
   resolution: "@parcel/watcher-android-arm64@npm:2.3.0"
@@ -13376,6 +13396,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"cbor@npm:^10.0.0":
+  version: 10.0.3
+  resolution: "cbor@npm:10.0.3"
+  dependencies:
+    nofilter: "npm:^3.0.2"
+  checksum: 10/ff33c3404c3acc8afc448163a7b32eea39f4f99d641ac496352a6830256617a0b1d49b2862746b6b150e8931b6f6da10572d78c28af3a64b6836881c33c5d942
+  languageName: node
+  linkType: hard
+
 "cbor@npm:^9.0.0":
   version: 9.0.2
   resolution: "cbor@npm:9.0.2"
@@ -25091,7 +25120,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"nofilter@npm:^3.1.0":
+"nofilter@npm:^3.0.2, nofilter@npm:^3.1.0":
   version: 3.1.0
   resolution: "nofilter@npm:3.1.0"
   checksum: 10/f63d87231dfda4b783db17d75b15aac948f78e65f4f1043096ef441147f6667ff74cd4b3f57ada5dbe240be282d3e9838558ac863a66cb04ef25fff7b2b4be4e