Update SafeMigration tests for zkSync (#833)

This PR: - Partially solves #767 (test updates for `SafeToL2Upgrade` are still pending) - It is based on version 1.5.0 because 1.4.1 cannot be compiled at the moment because we used `.send` in there, and hardhat zksync compiler plugin needs to be updated to support suppressing errors. I will cherry-pick it later. - I updated the `deployContract` function name and return type to be more self-explanatory - The main changes were around adding zksync compatible bytecode and also using the ContractFactory from the "zksync-ethers" package because in ZkSync you need to interact with a system contract to deploy contracts and not just send a transaction with the bytecode and `to` address omitted. One bug found: matter-labs/hardhat-zksync#1420
safe-global · Sep 19, 2024 · 70673bb · 70673bb
1 parent 7ccf6e0
commit 70673bb
Show file tree

Hide file tree

Showing 19 changed files with 306 additions and 266 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -60,14 +60,14 @@
     "devDependencies": {
         "@eslint/js": "^9.9.1",
         "@matterlabs/hardhat-zksync-deploy": "^1.5.0",
-        "@matterlabs/hardhat-zksync-ethers": "^1.2.0-beta.3",
+        "@matterlabs/hardhat-zksync-ethers": "^1.2.1",
         "@matterlabs/hardhat-zksync-node": "^1.1.1",
         "@matterlabs/hardhat-zksync-solc": "^1.2.4",
         "@matterlabs/hardhat-zksync-verify": "^1.6.0",
         "@nomicfoundation/hardhat-toolbox": "^5.0.0",
         "@openzeppelin/contracts": "^3.4.0",
         "@safe-global/mock-contract": "^4.1.0",
-        "@safe-global/safe-singleton-factory": "^1.0.32",
+        "@safe-global/safe-singleton-factory": "^1.0.33",
         "@types/chai": "^4.3.19",
         "@types/mocha": "^10.0.7",
         "@types/node": "^20.11.30",
@@ -92,6 +92,6 @@
         "typescript": "^5.5.4",
         "typescript-eslint": "^8.4.0",
         "yargs": "^17.7.2",
-        "zksync-ethers": "6.11.2"
+        "zksync-ethers": "6.12.1"
     }
 }
diff --git a/test/accessors/SimulateTxAccessor.spec.ts b/test/accessors/SimulateTxAccessor.spec.ts
@@ -1,6 +1,6 @@
 import { expect } from "chai";
 import hre, { deployments, ethers } from "hardhat";
-import { deployContract, getSimulateTxAccessor, getSafe, getCompatFallbackHandler } from "../utils/setup";
+import { deployContractFromSource, getSimulateTxAccessor, getSafe, getCompatFallbackHandler } from "../utils/setup";
 import { buildContractCall } from "../../src/utils/execution";
 
 describe("SimulateTxAccessor", () => {
@@ -17,7 +17,7 @@ describe("SimulateTxAccessor", () => {
                 return target.balance;
             }
         }`;
-        const interactor = await deployContract(user1, source);
+        const interactor = await deployContractFromSource(user1, source);
         const handler = await getCompatFallbackHandler();
         const handlerAddress = await handler.getAddress();
         const safe = await getSafe({ owners: [user1.address], threshold: 1, fallbackHandler: handlerAddress });

diff --git a/test/core/Safe.Execution.spec.ts b/test/core/Safe.Execution.spec.ts
@@ -1,6 +1,6 @@
 import { expect } from "chai";
 import hre from "hardhat";
-import { deployContract, getSafe } from "../utils/setup";
+import { deployContractFromSource, getSafe } from "../utils/setup";
 import {
     safeApproveHash,
     buildSignatureBytes,
@@ -30,7 +30,7 @@ describe("Safe", () => {
                     /* solhint-enable no-inline-assembly */
                 }
             }`;
-        const storageSetter = await deployContract(user1, setterSource);
+        const storageSetter = await deployContractFromSource(user1, setterSource);
         const TestNativeTokenReceiver = await hre.ethers.getContractFactory("TestNativeTokenReceiver");
         const nativeTokenReceiver = await TestNativeTokenReceiver.deploy();
 
@@ -40,7 +40,7 @@ describe("Safe", () => {
                     require(false, "Shit happens");
                 }
             }`;
-        const reverter = await deployContract(user1, reverterSource);
+        const reverter = await deployContractFromSource(user1, reverterSource);
         return {
             safe: await getSafe({ owners: [user1.address] }),
             reverter,
@@ -305,7 +305,7 @@ describe("Safe", () => {
                     this.nested(8, count);
                 }
             }`;
-            const gasUser = await deployContract(user1, gasUserSource);
+            const gasUser = await deployContractFromSource(user1, gasUserSource);
             const to = await gasUser.getAddress();
             const data = gasUser.interface.encodeFunctionData("useGas", [80]);
             const safeTxGas = 10000;

diff --git a/test/core/Safe.FallbackManager.spec.ts b/test/core/Safe.FallbackManager.spec.ts
@@ -1,7 +1,7 @@
 import { expect } from "chai";
 import hre, { deployments, ethers } from "hardhat";
 import { AddressZero } from "@ethersproject/constants";
-import { defaultTokenCallbackHandlerDeployment, deployContract, getSafeTemplate, getTokenCallbackHandler } from "../utils/setup";
+import { defaultTokenCallbackHandlerDeployment, deployContractFromSource, getSafeTemplate, getTokenCallbackHandler } from "../utils/setup";
 import { executeContractCallWithSigners } from "../../src/utils/execution";
 
 describe("FallbackManager", () => {
@@ -19,7 +19,7 @@ describe("FallbackManager", () => {
         }`;
         const signers = await ethers.getSigners();
         const [user1] = signers;
-        const mirror = await deployContract(user1, source);
+        const mirror = await deployContractFromSource(user1, source);
         return {
             safe: await getSafeTemplate(),
             mirror,

diff --git a/test/core/Safe.Incoming.spec.ts b/test/core/Safe.Incoming.spec.ts
@@ -1,6 +1,6 @@
 import { expect } from "chai";
 import hre, { ethers } from "hardhat";
-import { deployContract, getSafe } from "../utils/setup";
+import { deployContractFromSource, getSafe } from "../utils/setup";
 
 describe("Safe", () => {
     const setupTests = hre.deployments.createFixture(async ({ deployments }) => {
@@ -25,8 +25,8 @@ describe("Safe", () => {
         const [user1] = signers;
         return {
             safe: await getSafe({ owners: [user1.address] }),
-            gasCappedTransferContract: hre.network.zksync ? null : await deployContract(user1, gasCappedTransferSource),
-            callContract: await deployContract(user1, callSource),
+            gasCappedTransferContract: hre.network.zksync ? null : await deployContractFromSource(user1, gasCappedTransferSource),
+            callContract: await deployContractFromSource(user1, callSource),
             signers,
         };
     });

diff --git a/test/core/Safe.Setup.spec.ts b/test/core/Safe.Setup.spec.ts
@@ -2,7 +2,7 @@ import { expect } from "chai";
 import hre, { ethers } from "hardhat";
 import { AddressZero } from "@ethersproject/constants";
 
-import { deployContract, getMock, getSafeSingleton, getSafeTemplate } from "../utils/setup";
+import { deployContractFromSource, getMock, getSafeSingleton, getSafeTemplate } from "../utils/setup";
 import { calculateSafeDomainSeparator } from "../../src/utils/execution";
 import { AddressOne } from "../../src/utils/constants";
 import { chainId, encodeTransfer } from "../utils/encoding";
@@ -231,7 +231,7 @@ describe("Safe", () => {
                     /* solhint-enable no-inline-assembly */
                 }
             }`;
-            const testIntializer = await deployContract(user1, source);
+            const testIntializer = await deployContractFromSource(user1, source);
             const testIntializerAddress = await testIntializer.getAddress();
             const initData = testIntializer.interface.encodeFunctionData("init", ["0x42baddad"]);
             await expect(
@@ -272,7 +272,7 @@ describe("Safe", () => {
                     require(false, "Computer says nah");
                 }
             }`;
-            const testIntializer = await deployContract(user1, source);
+            const testIntializer = await deployContractFromSource(user1, source);
             const testIntializerAddress = await testIntializer.getAddress();
             const initData = testIntializer.interface.encodeFunctionData("init", ["0x42baddad"]);
             await expect(

diff --git a/test/factory/ProxyFactory.spec.ts b/test/factory/ProxyFactory.spec.ts
@@ -1,7 +1,7 @@
 import { expect } from "chai";
 import hre, { ethers } from "hardhat";
 import { Contract } from "ethers";
-import { deployContract, getFactory, getMock, getSafe, getSafeProxyRuntimeCode } from "../utils/setup";
+import { deployContractFromSource, getFactory, getMock, getSafe, getSafeProxyRuntimeCode } from "../utils/setup";
 import { AddressZero } from "@ethersproject/constants";
 import { calculateChainSpecificProxyAddress, calculateProxyAddress, calculateProxyAddressWithCallback } from "../../src/utils/proxies";
 import { chainId } from "./../utils/encoding";
@@ -35,7 +35,7 @@ describe("ProxyFactory", () => {
         await deployments.fixture();
         const signers = await hre.ethers.getSigners();
         const [user1] = signers;
-        const singleton = await deployContract(user1, SINGLETON_SOURCE);
+        const singleton = await deployContractFromSource(user1, SINGLETON_SOURCE);
         return {
             safe: await getSafe({ owners: [user1.address] }),
             factory: await getFactory(),

diff --git a/test/integration/Safe.0xExploit.spec.ts b/test/integration/Safe.0xExploit.spec.ts
@@ -2,7 +2,7 @@ import { expect } from "chai";
 import hre, { deployments, ethers } from "hardhat";
 import { AddressZero } from "@ethersproject/constants";
 import { defaultAbiCoder } from "@ethersproject/abi";
-import { getSafe, deployContract, getCompatFallbackHandler } from "../utils/setup";
+import { getSafe, deployContractFromSource, getCompatFallbackHandler } from "../utils/setup";
 import { buildSignatureBytes, executeContractCallWithSigners, signHash } from "../../src/utils/execution";
 
 describe("Safe", () => {
@@ -111,7 +111,7 @@ describe("Safe", () => {
                     changeState = value;
                 }
             }`;
-            const testValidator = await deployContract(user1, source);
+            const testValidator = await deployContractFromSource(user1, source);
             const testValidatorAddress = await testValidator.getAddress();
             await testValidator.shouldChangeState(true);
 

diff --git a/test/json/fallbackHandlerDeployment.json b/test/json/fallbackHandlerDeployment.json
diff --git a/test/json/safeDeployment.json b/test/json/safeDeployment.json
diff --git a/test/libraries/Migration.spec.ts → test/libraries/Migration.120.spec.ts b/test/libraries/Migration.spec.ts → test/libraries/Migration.120.spec.ts
diff --git a/test/libraries/MultiSend.spec.ts b/test/libraries/MultiSend.spec.ts
@@ -1,6 +1,6 @@
 import { expect } from "chai";
 import hre, { ethers } from "hardhat";
-import { deployContract, getMock, getMultiSend, getSafe, getDelegateCaller } from "../utils/setup";
+import { deployContractFromSource, getMock, getMultiSend, getSafe, getDelegateCaller } from "../utils/setup";
 import {
     buildContractCall,
     buildSafeTransaction,
@@ -28,7 +28,7 @@ describe("MultiSend", () => {
             }`;
         const signers = await hre.ethers.getSigners();
         const [user1] = signers;
-        const storageSetter = await deployContract(user1, setterSource);
+        const storageSetter = await deployContractFromSource(user1, setterSource);
         return {
             safe: await getSafe({ owners: [user1.address] }),
             multiSend: await getMultiSend(),
@@ -58,7 +58,7 @@ describe("MultiSend", () => {
                     selfdestruct(payable(msg.sender));
                 }
             }`;
-            const killLib = await deployContract(user1, source);
+            const killLib = await deployContractFromSource(user1, source);
 
             const nestedTransactionData = encodeMultiSend([await buildContractCall(killLib, "killme", [], 0)]);
 

diff --git a/test/libraries/MultiSendCallOnly.spec.ts b/test/libraries/MultiSendCallOnly.spec.ts
@@ -1,6 +1,6 @@
 import { expect } from "chai";
 import hre, { ethers } from "hardhat";
-import { deployContract, getMock, getMultiSendCallOnly, getSafe, getDelegateCaller } from "../utils/setup";
+import { deployContractFromSource, getMock, getMultiSendCallOnly, getSafe, getDelegateCaller } from "../utils/setup";
 import {
     buildContractCall,
     buildSafeTransaction,
@@ -28,7 +28,7 @@ describe("MultiSendCallOnly", () => {
             }`;
         const signers = await hre.ethers.getSigners();
         const [user1] = signers;
-        const storageSetter = await deployContract(user1, setterSource);
+        const storageSetter = await deployContractFromSource(user1, setterSource);
         return {
             safe: await getSafe({ owners: [user1.address] }),
             multiSend: await getMultiSendCallOnly(),