Using safe-singleton-factory for module deployment (#477)

This PR adds the use of `safe-singleton-factory` for deploying the `modules`. Note: - `allowances` already used the `safe-singleton-factory` for deployment. - `passkey` version was not updated, as it was not deployed to any network AFAIK. - Lock file was updated due to the addition of `safe-singleton-factory` in the root level. (Should we just install it individually for all 4 modules?)
safe-global · Aug 13, 2024 · b3c5e66 · b3c5e66
1 parent 13d4a94
commit b3c5e66
Show file tree

Hide file tree

Showing 14 changed files with 392 additions and 296 deletions.
diff --git a/modules/4337/CHANGELOG.md b/modules/4337/CHANGELOG.md
@@ -2,6 +2,14 @@
 
 This changelog only contains changes starting from version 0.2.0
 
+# Version: Unreleased
+
+## Changes
+
+### General
+
+- Using the [`safe-singleton-factory`](https://github.com/safe-global/safe-singleton-factory) to deploy contracts.
+
 # Version 0.3.0
 
 ## Compiler settings
@@ -21,14 +29,6 @@ The official deployments support the EntryPoint v0.7.0 with the canonical deploy
 
 ## Changes
 
-### Security Fixes
-
-None
-
-### Compatibility Fixes
-
-None
-
 ### General
 
 - Use the new `PackedUserOperation` struct from EntryPoint v0.7.0 ([#225](https://github.com/safe-global/safe-modules/issues/225))

diff --git a/modules/4337/certora/conf/Safe4337Module.conf b/modules/4337/certora/conf/Safe4337Module.conf
@@ -18,6 +18,6 @@
     "verify": "Safe4337Module:certora/specs/Safe4337Module.spec",
     "packages": [
         "@account-abstraction=../../node_modules/.pnpm/@account-abstraction+contracts@0.7.0/node_modules/@account-abstraction",
-        "@safe-global=../../node_modules/.pnpm/@safe-global+safe-contracts@1.4.1-build.0_ethers@6.13.1_bufferutil@4.0.8_utf-8-validate@6.0.4_/node_modules/@safe-global"
+        "@safe-global=../../node_modules/.pnpm/@safe-global+safe-contracts@1.4.1-build.0_ethers@6.13.1_bufferutil@4.0.8_utf-8-validate@5.0.10_/node_modules/@safe-global"
     ]
 }
diff --git a/modules/4337/certora/conf/SignatureLengthCheck.conf b/modules/4337/certora/conf/SignatureLengthCheck.conf
@@ -11,6 +11,6 @@
     "verify": "Safe4337ModuleHarness:certora/specs/SignatureLengthCheck.spec",
     "packages": [
         "@account-abstraction=../../node_modules/.pnpm/@account-abstraction+contracts@0.7.0/node_modules/@account-abstraction",
-        "@safe-global=../../node_modules/.pnpm/@safe-global+safe-contracts@1.4.1-build.0_ethers@6.13.1_bufferutil@4.0.8_utf-8-validate@6.0.4_/node_modules/@safe-global"
+        "@safe-global=../../node_modules/.pnpm/@safe-global+safe-contracts@1.4.1-build.0_ethers@6.13.1_bufferutil@4.0.8_utf-8-validate@5.0.10_/node_modules/@safe-global"
     ]
 }
diff --git a/modules/4337/certora/conf/TransactionExecutionMethods.conf b/modules/4337/certora/conf/TransactionExecutionMethods.conf
@@ -18,6 +18,6 @@
     "verify": "Safe4337Module:certora/specs/TransactionExecutionMethods.spec",
     "packages": [
         "@account-abstraction=../../node_modules/.pnpm/@account-abstraction+contracts@0.7.0/node_modules/@account-abstraction",
-        "@safe-global=../../node_modules/.pnpm/@safe-global+safe-contracts@1.4.1-build.0_ethers@6.13.1_bufferutil@4.0.8_utf-8-validate@6.0.4_/node_modules/@safe-global"
+        "@safe-global=../../node_modules/.pnpm/@safe-global+safe-contracts@1.4.1-build.0_ethers@6.13.1_bufferutil@4.0.8_utf-8-validate@5.0.10_/node_modules/@safe-global"
     ]
 }
diff --git a/modules/4337/certora/conf/ValidationDataLastBitOne.conf b/modules/4337/certora/conf/ValidationDataLastBitOne.conf
@@ -18,6 +18,6 @@
     "verify": "Safe4337Module:certora/specs/ValidationDataLastBitOne.spec",
     "packages": [
         "@account-abstraction=../../node_modules/.pnpm/@account-abstraction+contracts@0.7.0/node_modules/@account-abstraction",
-        "@safe-global=../../node_modules/.pnpm/@safe-global+safe-contracts@1.4.1-build.0_ethers@6.13.1_bufferutil@4.0.8_utf-8-validate@6.0.4_/node_modules/@safe-global"
+        "@safe-global=../../node_modules/.pnpm/@safe-global+safe-contracts@1.4.1-build.0_ethers@6.13.1_bufferutil@4.0.8_utf-8-validate@5.0.10_/node_modules/@safe-global"
     ]
 }
diff --git a/modules/4337/hardhat.config.ts b/modules/4337/hardhat.config.ts
@@ -4,6 +4,11 @@ import 'hardhat-deploy'
 import dotenv from 'dotenv'
 import type { HardhatUserConfig, HttpNetworkUserConfig } from 'hardhat/types'
 import yargs from 'yargs/yargs'
+import { getSingletonFactoryInfo } from '@safe-global/safe-singleton-factory'
+import { DeterministicDeploymentInfo } from 'hardhat-deploy/dist/types'
+import './src/tasks/localVerify'
+import './src/tasks/deployContracts'
+import './src/tasks/codesize'
 
 const argv = yargs(process.argv.slice(2))
   .options({ network: { type: 'string', default: 'hardhat' } })
@@ -30,10 +35,6 @@ if (['mainnet', 'sepolia', 'polygon', 'amoy'].includes(argv.network) && INFURA_K
   throw new Error(`Could not find Infura key in env, unable to connect to network ${argv.network}`)
 }
 
-import './src/tasks/localVerify'
-import './src/tasks/deployContracts'
-import './src/tasks/codesize'
-
 const solidityVersion = SOLIDITY_VERSION || '0.8.23'
 const soliditySettings = SOLIDITY_SETTINGS
   ? JSON.parse(SOLIDITY_SETTINGS)
@@ -45,6 +46,26 @@ const soliditySettings = SOLIDITY_SETTINGS
       },
     }
 
+const deterministicDeployment = (network: string): DeterministicDeploymentInfo => {
+  const info = getSingletonFactoryInfo(parseInt(network))
+  if (!info) {
+    throw new Error(`
+        Safe factory not found for network ${network}. You can request a new deployment at https://github.com/safe-global/safe-singleton-factory.
+        For more information, see https://github.com/safe-global/safe-smart-account#replay-protection-eip-155
+      `)
+  }
+
+  const gasLimit = BigInt(info.gasLimit)
+  const gasPrice = BigInt(info.gasPrice)
+
+  return {
+    factory: info.address,
+    deployer: info.signerAddress,
+    funding: String(gasLimit * gasPrice),
+    signedTx: info.transaction,
+  }
+}
+
 const customNetwork = NODE_URL
   ? {
       custom: {
@@ -98,6 +119,7 @@ const userConfig: HardhatUserConfig = {
     },
     ...customNetwork,
   },
+  deterministicDeployment,
   namedAccounts: {
     deployer: 0,
   },

diff --git a/modules/allowances/hardhat.config.ts b/modules/allowances/hardhat.config.ts
@@ -1,8 +1,6 @@
 import '@nomicfoundation/hardhat-toolbox'
 import 'hardhat-deploy'
-
 import './tasks/deploy_verify'
-
 import dotenv from 'dotenv'
 import { HardhatUserConfig, HttpNetworkUserConfig } from 'hardhat/types'
 import { DeterministicDeploymentInfo } from 'hardhat-deploy/dist/types'

diff --git a/modules/allowances/package.json b/modules/allowances/package.json
@@ -28,7 +28,6 @@
     "@nomicfoundation/hardhat-toolbox": "^5.0.0",
     "@openzeppelin/contracts": "^5.0.2",
     "@safe-global/safe-deployments": "^1.37.0",
-    "@safe-global/safe-singleton-factory": "^1.0.25",
     "@typechain/ethers-v6": "^0.5.1",
     "@typechain/hardhat": "^9.1.0",
     "@types/mocha": "^10.0.7",

diff --git a/modules/passkey/CHANGELOG.md b/modules/passkey/CHANGELOG.md
@@ -11,10 +11,13 @@ EVM target: Paris
 
 ## Expected addresses
 
-- `SafeWebAuthnSignerFactory` at `TBD`
-- `SafeWebAuthnSharedSigner` at `TBD`
-- `DaimoP256Verifier` at `0xc2b78104907F722DABAc4C69f826a522B2754De4`
-- `FCLP256Verifier` at `TBD`
+- `SafeWebAuthnSignerFactory` at `0x1d31F259eE307358a26dFb23EB365939E8641195`
+- `SafeWebAuthnSharedSigner` at `0x94a4F6affBd8975951142c3999aEAB7ecee555c2`
+- `FCLP256Verifier` at `0xA86e0054C51E4894D88762a017ECc5E5235f5DBA`
+
+### Official Deployment Address from 3rd party
+
+- `DaimoP256Verifier` at `0xc2b78104907F722DABAc4C69f826a522B2754De4` ([Source](https://p256.eth.limo/))
 
 ## Changes
 
@@ -24,6 +27,7 @@ EVM target: Paris
 
 ### General
 
+- Using the [`safe-singleton-factory`](https://github.com/safe-global/safe-singleton-factory) to deploy contracts.
 - Use compiler version 0.8.26 and use IR optimizer for all contracts (except `FCLP256Verifier` as it introduces perfomance regressions). This simultaneously decreases code size and runtime gas costs.
 - Index the `signer` field for `Created` event in the `SafeWebAuthnSignerFactory` contract.
 - Use more consistent compiler version pragmas throughout the contracts.

diff --git a/modules/passkey/hardhat.config.ts b/modules/passkey/hardhat.config.ts
@@ -7,6 +7,8 @@ import { HttpNetworkUserConfig } from 'hardhat/types'
 import './src/tasks/codesize'
 import './src/tasks/deployContracts'
 import './src/tasks/localVerify'
+import { getSingletonFactoryInfo } from '@safe-global/safe-singleton-factory'
+import { DeterministicDeploymentInfo } from 'hardhat-deploy/dist/types'
 
 dotenv.config()
 const { CUSTOM_NODE_URL, MNEMONIC, ETHERSCAN_API_KEY, PK } = process.env
@@ -43,6 +45,26 @@ const compilerSettings = {
   },
 }
 
+const deterministicDeployment = (network: string): DeterministicDeploymentInfo => {
+  const info = getSingletonFactoryInfo(parseInt(network))
+  if (!info) {
+    throw new Error(`
+      Safe factory not found for network ${network}. You can request a new deployment at https://github.com/safe-global/safe-singleton-factory.
+      For more information, see https://github.com/safe-global/safe-smart-account#replay-protection-eip-155
+    `)
+  }
+
+  const gasLimit = BigInt(info.gasLimit)
+  const gasPrice = BigInt(info.gasPrice)
+
+  return {
+    factory: info.address,
+    deployer: info.signerAddress,
+    funding: String(gasLimit * gasPrice),
+    signedTx: info.transaction,
+  }
+}
+
 const config: HardhatUserConfig = {
   paths: {
     artifacts: 'build/artifacts',
@@ -65,6 +87,7 @@ const config: HardhatUserConfig = {
     },
     ...customNetwork,
   },
+  deterministicDeployment,
   solidity: {
     compilers: [compilerSettings],
     overrides: {

diff --git a/modules/recovery/CHANGELOG.md b/modules/recovery/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+# Version: Unreleased
+
+## Changes
+
+### General
+
+- Using the [`safe-singleton-factory`](https://github.com/safe-global/safe-singleton-factory) to deploy contracts.
+
 # Version 0.1.0
 
 ## Compiler settings

diff --git a/modules/recovery/hardhat.config.ts b/modules/recovery/hardhat.config.ts
@@ -4,6 +4,8 @@ import 'hardhat-deploy'
 import dotenv from 'dotenv'
 import type { HardhatUserConfig, HttpNetworkUserConfig } from 'hardhat/types'
 import yargs from 'yargs/yargs'
+import { getSingletonFactoryInfo } from "@safe-global/safe-singleton-factory";
+import { DeterministicDeploymentInfo } from "hardhat-deploy/dist/types";
 
 import './src/tasks/deployContracts'
 import './src/tasks/localVerify'
@@ -42,6 +44,26 @@ const customNetwork = CUSTOM_NODE_URL
     }
   : {}
 
+const deterministicDeployment = (network: string): DeterministicDeploymentInfo => {
+    const info = getSingletonFactoryInfo(parseInt(network));
+    if (!info) {
+        throw new Error(`
+        Safe factory not found for network ${network}. You can request a new deployment at https://github.com/safe-global/safe-singleton-factory.
+        For more information, see https://github.com/safe-global/safe-smart-account#replay-protection-eip-155
+      `);
+    }
+
+    const gasLimit = BigInt(info.gasLimit)
+    const gasPrice = BigInt(info.gasPrice)
+
+    return {
+        factory: info.address,
+        deployer: info.signerAddress,
+        funding: String(gasLimit * gasPrice),
+        signedTx: info.transaction,
+    };
+};
+
 const userConfig: HardhatUserConfig = {
   paths: {
     artifacts: 'build/artifacts',
@@ -71,6 +93,7 @@ const userConfig: HardhatUserConfig = {
     },
     ...customNetwork,
   },
+  deterministicDeployment,
   namedAccounts: {
     deployer: 0,
   },

diff --git a/package.json b/package.json
@@ -34,6 +34,7 @@
     "pnpm": "^9"
   },
   "devDependencies": {
+    "@safe-global/safe-singleton-factory": "^1.0.31",
     "@typescript-eslint/eslint-plugin": "^7.12.0",
     "@typescript-eslint/parser": "^7.12.0",
     "eslint": "^8.57.0",