Unifying function to get Safe implementation (#808)

Fixes #802 This PR unifies `getSafeWithOwners(...)` and `getSafeWithSingleton(...)` by editing the `getSafeTemplate(...)` to use an inside function which also takes the `singleton` as a parameter.
dodger213 · Aug 8, 2024 · 209c106 · 209c106
1 parent d87d8f2
commit 209c106
Show file tree

Hide file tree

Showing 27 changed files with 104 additions and 115 deletions.
diff --git a/benchmark/utils/setup.ts b/benchmark/utils/setup.ts
@@ -1,7 +1,7 @@
 import { expect } from "chai";
 import hre, { deployments, ethers } from "hardhat";
 import { BigNumberish } from "ethers";
-import { getTokenCallbackHandler, getSafeWithOwners } from "../../test/utils/setup";
+import { getTokenCallbackHandler, getSafe } from "../../test/utils/setup";
 import {
     logGas,
     executeTx,
@@ -24,7 +24,7 @@ const generateTarget = async (owners: number, threshold: number, guardAddress: s
     const fallbackHandler = await getTokenCallbackHandler();
     const fallbackHandlerAddress = await fallbackHandler.getAddress();
     const signers = (await ethers.getSigners()).slice(0, owners);
-    const safe = await getSafeWithOwners({
+    const safe = await getSafe({
         owners: signers.map((owner) => owner.address),
         threshold,
         fallbackHandler: fallbackHandlerAddress,

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, getSafeWithOwners, getCompatFallbackHandler } from "../utils/setup";
+import { deployContract, getSimulateTxAccessor, getSafe, getCompatFallbackHandler } from "../utils/setup";
 import { buildContractCall } from "../../src/utils/execution";
 
 describe("SimulateTxAccessor", () => {
@@ -20,7 +20,7 @@ describe("SimulateTxAccessor", () => {
         const interactor = await deployContract(user1, source);
         const handler = await getCompatFallbackHandler();
         const handlerAddress = await handler.getAddress();
-        const safe = await getSafeWithOwners({ owners: [user1.address], threshold: 1, fallbackHandler: handlerAddress });
+        const safe = await getSafe({ owners: [user1.address], threshold: 1, fallbackHandler: handlerAddress });
         const safeAddress = await safe.getAddress();
         const simulator = await getCompatFallbackHandler(safeAddress);
         return {

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, { deployments, ethers } from "hardhat";
-import { deployContract, getSafeWithOwners } from "../utils/setup";
+import { deployContract, getSafe } from "../utils/setup";
 import {
     safeApproveHash,
     buildSignatureBytes,
@@ -42,7 +42,7 @@ describe("Safe", () => {
             }`;
         const reverter = await deployContract(user1, reverterSource);
         return {
-            safe: await getSafeWithOwners({ owners: [user1.address] }),
+            safe: await getSafe({ owners: [user1.address] }),
             reverter,
             storageSetter,
             nativeTokenReceiver,

diff --git a/test/core/Safe.GuardManager.spec.ts b/test/core/Safe.GuardManager.spec.ts
@@ -1,7 +1,7 @@
 import { expect } from "chai";
 import hre, { deployments, ethers } from "hardhat";
 import { AddressZero } from "@ethersproject/constants";
-import { getMock, getSafeWithOwners } from "../utils/setup";
+import { getMock, getSafe } from "../utils/setup";
 import {
     buildContractCall,
     buildSafeTransaction,
@@ -26,7 +26,7 @@ describe("GuardManager", () => {
         const guardContract = await hre.ethers.getContractAt("ITransactionGuard", AddressZero);
         const guardEip165Calldata = guardContract.interface.encodeFunctionData("supportsInterface", ["0xe6d7a83a"]);
         await validGuardMock.givenCalldataReturnBool(guardEip165Calldata, true);
-        const safe = await getSafeWithOwners({ owners: [user2.address] });
+        const safe = await getSafe({ owners: [user2.address] });
         await executeContractCallWithSigners(safe, safe, "setGuard", [validGuardMockAddress], [user2]);
 
         return {
@@ -42,7 +42,7 @@ describe("GuardManager", () => {
             const {
                 signers: [user1, user2],
             } = await setupWithTemplate();
-            const safe = await getSafeWithOwners({ owners: [user1.address] });
+            const safe = await getSafe({ owners: [user1.address] });
 
             await expect(executeContractCallWithSigners(safe, safe, "setGuard", [user2.address], [user1])).to.be.revertedWith("GS013");
         });
@@ -53,7 +53,7 @@ describe("GuardManager", () => {
                 signers: [user1],
             } = await setupWithTemplate();
             const validGuardMockAddress = await validGuardMock.getAddress();
-            const safe = await getSafeWithOwners({ owners: [user1.address] });
+            const safe = await getSafe({ owners: [user1.address] });
 
             await expect(executeContractCallWithSigners(safe, safe, "setGuard", [validGuardMockAddress], [user1]))
                 .to.emit(safe, "ChangedGuard")
@@ -72,7 +72,7 @@ describe("GuardManager", () => {
 
             const invocationCountBefore = await validGuardMock.invocationCount();
             const validGuardMockAddress = await validGuardMock.getAddress();
-            const safe = await getSafeWithOwners({ owners: [user1.address] });
+            const safe = await getSafe({ owners: [user1.address] });
 
             await executeContractCallWithSigners(safe, safe, "setGuard", [validGuardMockAddress], [user1]);
 

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, { deployments, ethers } from "hardhat";
-import { deployContract, getSafeWithOwners } from "../utils/setup";
+import { deployContract, getSafe } from "../utils/setup";
 
 describe("Safe", () => {
     const setupTests = deployments.createFixture(async ({ deployments }) => {
@@ -21,7 +21,7 @@ describe("Safe", () => {
         const signers = await ethers.getSigners();
         const [user1] = signers;
         return {
-            safe: await getSafeWithOwners({ owners: [user1.address] }),
+            safe: await getSafe({ owners: [user1.address] }),
             caller: await deployContract(user1, source),
             signers,
         };

diff --git a/test/core/Safe.ModuleManager.spec.ts b/test/core/Safe.ModuleManager.spec.ts
@@ -1,7 +1,7 @@
 import { expect } from "chai";
 import hre, { deployments, ethers } from "hardhat";
 import { AddressZero } from "@ethersproject/constants";
-import { getSafeWithOwners, getMock } from "../utils/setup";
+import { getSafe, getMock } from "../utils/setup";
 import { executeContractCallWithSigners } from "../../src/utils/execution";
 import { AddressOne } from "../../src/utils/constants";
 
@@ -13,7 +13,7 @@ describe("ModuleManager", () => {
         const signers = await ethers.getSigners();
         const [user1] = signers;
 
-        const safe = await getSafeWithOwners({ owners: [user1.address] });
+        const safe = await getSafe({ owners: [user1.address] });
 
         const validModuleGuardMock = await getMock();
         const moduleGuardContract = await hre.ethers.getContractAt("IModuleGuard", AddressZero);
@@ -577,7 +577,7 @@ describe("ModuleManager", () => {
             const {
                 signers: [user1, user2],
             } = await setupTests();
-            const safe = await getSafeWithOwners({ owners: [user1.address] });
+            const safe = await getSafe({ owners: [user1.address] });
 
             await expect(executeContractCallWithSigners(safe, safe, "setModuleGuard", [user2.address], [user1])).to.be.revertedWith(
                 "GS013",
@@ -590,7 +590,7 @@ describe("ModuleManager", () => {
                 signers: [user1],
             } = await setupTests();
             const validGuardMockAddress = await validModuleGuardMock.getAddress();
-            const safe = await getSafeWithOwners({ owners: [user1.address] });
+            const safe = await getSafe({ owners: [user1.address] });
 
             await expect(executeContractCallWithSigners(safe, safe, "setModuleGuard", [validGuardMockAddress], [user1]))
                 .to.emit(safe, "ChangedModuleGuard")
@@ -609,7 +609,7 @@ describe("ModuleManager", () => {
 
             const invocationCountBefore = await validModuleGuardMock.invocationCount();
             const validModuleGuardMockAddress = await validModuleGuardMock.getAddress();
-            const safe = await getSafeWithOwners({ owners: [user1.address] });
+            const safe = await getSafe({ owners: [user1.address] });
 
             await executeContractCallWithSigners(safe, safe, "setModuleGuard", [validModuleGuardMockAddress], [user1]);
 

diff --git a/test/core/Safe.OwnerManager.spec.ts b/test/core/Safe.OwnerManager.spec.ts
@@ -1,7 +1,7 @@
 import { expect } from "chai";
 import { deployments, ethers } from "hardhat";
 import { AddressZero } from "@ethersproject/constants";
-import { getSafeWithOwners } from "../utils/setup";
+import { getSafe } from "../utils/setup";
 import { executeContractCallWithSigners } from "../../src/utils/execution";
 import { AddressOne } from "../../src/utils/constants";
 
@@ -11,7 +11,7 @@ describe("OwnerManager", () => {
         const signers = await ethers.getSigners();
         const [user1] = signers;
         return {
-            safe: await getSafeWithOwners({ owners: [user1.address] }),
+            safe: await getSafe({ owners: [user1.address] }),
             signers,
         };
     });