feat: implement contract diff check tool (#587) (#589)

Co-authored-by: Lucas Bertrand <[email protected]>

Author: s2imonovic

.github/workflows/generated-files.yaml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - develop
     paths:
       - "**"
   pull_request:

.github/workflows/lint.yaml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - develop
     paths:
       - '**'
   pull_request:

.github/workflows/semgrep.yml

@@ -5,6 +5,7 @@ on:
   push:
     branches:
       - main
+      - develop
   schedule:
     # random HH:MM to avoid a load spike on GitHub Actions at 00:00
     - cron: '56 22 * * *'

.github/workflows/slither.yaml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - develop
     paths:
       - '**'
   pull_request:

.github/workflows/test.yaml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - develop
     paths:
       - '**'
   pull_request:

hardhat.config.ts

@@ -44,9 +44,9 @@ task("upgradeProposal", "Create Safe upgrade proposals for GatewayEVM")
     }
   });
 
-task("protocolChecksum", "Run EVM protocol checksum verification")
-  .addFlag("testnet", "Run checksum for testnet networks")
-  .addFlag("mainnet", "Run checksum for mainnet networks")
+task("protocolChecksum", "Run EVM protocol checkers verification")
+  .addFlag("testnet", "Run checkers for testnet networks")
+  .addFlag("mainnet", "Run checkers for mainnet networks")
   .setAction(async (taskArgs, hre) => {
     try {
       const isMainnet = taskArgs.mainnet;
@@ -55,12 +55,36 @@ task("protocolChecksum", "Run EVM protocol checksum verification")
 
       process.env.NETWORK_TYPE = networkType;
 
-      const checksumScript = await import("./scripts/checksum/protocolChecksum");
+      const checksumScript = await import("./scripts/checkers/protocolChecksum");
       await checksumScript.main();
     } catch (error) {
-      console.error("❌ Error running protocol checksum script:", error);
+      console.error("❌ Error running protocol checkers script:", error);
       process.exit(1);
     }
   });
 
+task("contractDiff", "Fetch and flatten smart contracts for diff analysis")
+    .addParam("oldAddress", "Address of the old implementation contract")
+    .addParam("newAddress", "Address of the new implementation contract")
+    .setAction(async (taskArgs, hre) => {
+      try {
+        console.log("🔍 Contract Diff Tool");
+        console.log("=".repeat(60));
+        console.log(`Network: ${hre.network.name}`);
+        console.log(`Old Implementation: ${taskArgs.oldAddress}`);
+        console.log(`New Implementation: ${taskArgs.newAddress}`);
+        console.log("=".repeat(60));
+
+        const contractDiffTool = await import("./scripts/contractDiff/contractDiffTool");
+        await contractDiffTool.fetchAndFlattenContract(
+            taskArgs.oldAddress,
+            taskArgs.newAddress,
+            hre.network.name
+        )
+      } catch (error) {
+        console.error("❌ Error running contract diff tool:", error);
+        process.exit(1);
+      }
+    });
+
 export default config;

scripts/checksum/protocolChecksum.ts scripts/checkers/protocolChecksum.tsscripts/checksum/protocolChecksum.ts renamed to scripts/checkers/protocolChecksum.ts

@@ -350,4 +350,4 @@ async function checksumNetworks() {
 
 export async function main() {
   await checksumNetworks();
-}
+}