Merge pull request #2 from zkemail/generic-validator-module

Add generic validator recovery module and update zk email contracts to use it

.github/workflows/test.yml

@@ -11,11 +11,11 @@ env:
 
 jobs:
   build:
-    uses: "./.github/workflows/forge-build.yml"
+    uses: "rhinestonewtf/reusable-workflows/.github/workflows/forge-build.yaml@main"
 
   test:
     needs: ["build"]
-    uses: "./.github/workflows/forge-test.yml"
+    uses: "rhinestonewtf/reusable-workflows/.github/workflows/forge-test.yaml@main"
     with:
       foundry-fuzz-runs: 5000
       foundry-profile: "test"

README.md

@@ -85,7 +85,6 @@ It is strongly recommended that configureRecovery is called during the installat
 
 ```ts
 function configureRecovery(
-    address recoveryModule,
     address[] memory guardians,
     uint256[] memory weights,
     uint256 threshold,

foundry.toml

@@ -22,10 +22,10 @@ ignored_warnings_from = [
 ]
 
 [rpc_endpoints]
-baseSepolia = "${BASE_SEPOLIA_RPC_URL}"
+sepolia = "${BASE_SEPOLIA_RPC_URL}"
 
 [etherscan]
-baseSepolia = { key = "${BASE_SCAN_API_KEY}" }
+sepolia = { key = "${BASE_SCAN_API_KEY}" }
 
 [fmt]
 bracket_spacing = true

script/Deploy.s.sol

@@ -2,19 +2,27 @@
 pragma solidity ^0.8.25;
 
 import { Script } from "forge-std/Script.sol";
-import { ZkEmailRecovery } from "src/ZkEmailRecovery.sol";
+import { EmailRecoverySubjectHandler } from "src/handlers/EmailRecoverySubjectHandler.sol";
+import { EmailRecoveryManager } from "src/EmailRecoveryManager.sol";
+import { EmailRecoveryModule } from "src/modules/EmailRecoveryModule.sol";
 
 contract DeployScript is Script {
     function run() public {
         bytes32 salt = bytes32(uint256(0));
 
         address verifier = 0xEdC642bbaD91E21cCE6cd436Fdc6F040FD0fF998;
-        address ecdsaOwnedDkimRegistry = 0xC83256CCf7B94d310e49edA05077899ca036eb78;
+        address dkimRegistry = 0xC83256CCf7B94d310e49edA05077899ca036eb78;
         address emailAuthImpl = 0x1C76Aa365c17B40c7E944DcCdE4dC6e6D2A7b748;
 
         vm.startBroadcast(vm.envUint("PRIVATE_KEY"));
 
-        new ZkEmailRecovery{ salt: salt }(verifier, ecdsaOwnedDkimRegistry, emailAuthImpl);
+        EmailRecoverySubjectHandler emailRecoveryHandler = new EmailRecoverySubjectHandler();
+
+        EmailRecoveryManager emailRecoveryManager = new EmailRecoveryManager{ salt: salt }(
+            verifier, dkimRegistry, emailAuthImpl, address(emailRecoveryHandler)
+        );
+
+        new EmailRecoveryModule(address(emailRecoveryManager));
 
         vm.stopBroadcast();
     }

script/DeploySafeRecovery.s.sol

@@ -2,22 +2,27 @@
 pragma solidity ^0.8.25;
 
 import { Script } from "forge-std/Script.sol";
-import { SafeZkEmailRecovery } from "src/SafeZkEmailRecovery.sol";
-import { SafeRecoveryModule } from "src/modules/SafeRecoveryModule.sol";
+import { SafeRecoverySubjectHandler } from "src/handlers/SafeRecoverySubjectHandler.sol";
+import { EmailRecoveryManager } from "src/EmailRecoveryManager.sol";
+import { EmailRecoveryModule } from "src/modules/EmailRecoveryModule.sol";
 
 contract DeploySafeRecoveryScript is Script {
     function run() public {
         bytes32 salt = bytes32(uint256(0));
 
         address verifier = 0xEdC642bbaD91E21cCE6cd436Fdc6F040FD0fF998;
-        address ecdsaOwnedDkimRegistry = 0xC83256CCf7B94d310e49edA05077899ca036eb78;
+        address dkimRegistry = 0xC83256CCf7B94d310e49edA05077899ca036eb78;
         address emailAuthImpl = 0x1C76Aa365c17B40c7E944DcCdE4dC6e6D2A7b748;
 
         vm.startBroadcast(vm.envUint("PRIVATE_KEY"));
 
-        SafeZkEmailRecovery safeZkEmailRecovery =
-            new SafeZkEmailRecovery{ salt: salt }(verifier, ecdsaOwnedDkimRegistry, emailAuthImpl);
-        new SafeRecoveryModule(address(safeZkEmailRecovery));
+        SafeRecoverySubjectHandler emailRecoveryHandler = new SafeRecoverySubjectHandler();
+
+        EmailRecoveryManager emailRecoveryManager = new EmailRecoveryManager(
+            verifier, dkimRegistry, emailAuthImpl, address(emailRecoveryHandler)
+        );
+
+        new EmailRecoveryModule(address(emailRecoveryManager));
 
         vm.stopBroadcast();
     }

src/EmailRecoveryFactory.sol

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.25;
+
+import { EmailRecoveryManager } from "./EmailRecoveryManager.sol";
+import { EmailRecoveryModule } from "./modules/EmailRecoveryModule.sol";
+import { EmailRecoverySubjectHandler } from "./handlers/EmailRecoverySubjectHandler.sol";
+
+contract EmailRecoveryFactory {
+    function deployModuleAndManager(
+        address verifier,
+        address dkimRegistry,
+        address emailAuthImpl,
+        address emailRecoveryHandler
+    )
+        external
+        returns (address, address)
+    {
+        EmailRecoveryManager emailRecoveryManager =
+            new EmailRecoveryManager(verifier, dkimRegistry, emailAuthImpl, emailRecoveryHandler);
+        address manager = address(emailRecoveryManager);
+
+        EmailRecoveryModule emailRecoveryModule = new EmailRecoveryModule(manager);
+        address module = address(emailRecoveryModule);
+
+        emailRecoveryManager.initialize(module);
+
+        return (manager, module);
+    }
+}