feat(merkleroot-gatekeeper): added deploy scripts and config (#1822)

Co-authored-by: Crisgarner <@crisgarner>
privacy-scaling-explorations · Sep 12, 2024 · 0a55bbc · 0a55bbc
1 parent f730dd7
commit 0a55bbc
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 1 deletion.
diff --git a/packages/contracts/deploy-config-example.json b/packages/contracts/deploy-config-example.json
@@ -7,6 +7,10 @@
     "FreeForAllGatekeeper": {
       "deploy": false
     },
+    "MerkleProofGatekeeper": {
+      "deploy": false,
+      "root": "0x2461fcc4c0965cb7f482dd28f1ca8057b7a62a35e8b7a86bb3ad6523f4bb21c0"
+    },
     "EASGatekeeper": {
       "deploy": true,
       "easAddress": "0xC2679fBD37d54388Ce493F1DB75320D236e1815e",
@@ -69,6 +73,10 @@
     "FreeForAllGatekeeper": {
       "deploy": false
     },
+    "MerkleProofGatekeeper": {
+      "deploy": false,
+      "root": "0x2461fcc4c0965cb7f482dd28f1ca8057b7a62a35e8b7a86bb3ad6523f4bb21c0"
+    },
     "EASGatekeeper": {
       "deploy": false,
       "easAddress": "0xaEF4103A04090071165F78D45D83A0C0782c2B2a",
@@ -130,6 +138,10 @@
     "FreeForAllGatekeeper": {
       "deploy": false
     },
+    "MerkleProofGatekeeper": {
+      "deploy": false,
+      "root": "0x2461fcc4c0965cb7f482dd28f1ca8057b7a62a35e8b7a86bb3ad6523f4bb21c0"
+    },
     "EASGatekeeper": {
       "deploy": true,
       "easAddress": "0x4200000000000000000000000000000000000021",
@@ -192,6 +204,10 @@
     "FreeForAllGatekeeper": {
       "deploy": true
     },
+    "MerkleProofGatekeeper": {
+      "deploy": false,
+      "root": "0x2461fcc4c0965cb7f482dd28f1ca8057b7a62a35e8b7a86bb3ad6523f4bb21c0"
+    },
     "EASGatekeeper": {
       "deploy": false,
       "easAddress": "0xC2679fBD37d54388Ce493F1DB75320D236e1815e",
@@ -254,6 +270,10 @@
     "FreeForAllGatekeeper": {
       "deploy": true
     },
+    "MerkleProofGatekeeper": {
+      "deploy": false,
+      "root": "0x2461fcc4c0965cb7f482dd28f1ca8057b7a62a35e8b7a86bb3ad6523f4bb21c0"
+    },
     "EASGatekeeper": {
       "deploy": false,
       "easAddress": "0xC2679fBD37d54388Ce493F1DB75320D236e1815e",
@@ -316,6 +336,10 @@
     "FreeForAllGatekeeper": {
       "deploy": true
     },
+    "MerkleProofGatekeeper": {
+      "deploy": false,
+      "root": "0x2461fcc4c0965cb7f482dd28f1ca8057b7a62a35e8b7a86bb3ad6523f4bb21c0"
+    },
     "EASGatekeeper": {
       "deploy": false,
       "easAddress": "0x4200000000000000000000000000000000000021",
@@ -378,6 +402,10 @@
     "FreeForAllGatekeeper": {
       "deploy": true
     },
+    "MerkleProofGatekeeper": {
+      "deploy": false,
+      "root": "0x2461fcc4c0965cb7f482dd28f1ca8057b7a62a35e8b7a86bb3ad6523f4bb21c0"
+    },
     "HatsGatekeeper": {
       "deploy": false,
       "criterionHats": ["26960358043289970096177553829315270011263390106506980876069447401472"],
@@ -445,6 +473,10 @@
     "FreeForAllGatekeeper": {
       "deploy": true
     },
+    "MerkleProofGatekeeper": {
+      "deploy": false,
+      "root": "0x2461fcc4c0965cb7f482dd28f1ca8057b7a62a35e8b7a86bb3ad6523f4bb21c0"
+    },
     "HatsGatekeeper": {
       "deploy": false,
       "criterionHats": ["26960358043289970096177553829315270011263390106506980876069447401472"],
@@ -512,6 +544,10 @@
     "FreeForAllGatekeeper": {
       "deploy": true
     },
+    "MerkleProofGatekeeper": {
+      "deploy": false,
+      "root": "0x2461fcc4c0965cb7f482dd28f1ca8057b7a62a35e8b7a86bb3ad6523f4bb21c0"
+    },
     "HatsGatekeeper": {
       "deploy": false,
       "criterionHats": ["26960358043289970096177553829315270011263390106506980876069447401472"],
@@ -579,6 +615,10 @@
     "FreeForAllGatekeeper": {
       "deploy": true
     },
+    "MerkleProofGatekeeper": {
+      "deploy": false,
+      "root": "0x2461fcc4c0965cb7f482dd28f1ca8057b7a62a35e8b7a86bb3ad6523f4bb21c0"
+    },
     "HatsGatekeeper": {
       "deploy": false,
       "criterionHats": ["26960358043289970096177553829315270011263390106506980876069447401472"],
@@ -646,6 +686,10 @@
     "FreeForAllGatekeeper": {
       "deploy": true
     },
+    "MerkleProofGatekeeper": {
+      "deploy": false,
+      "root": "0x2461fcc4c0965cb7f482dd28f1ca8057b7a62a35e8b7a86bb3ad6523f4bb21c0"
+    },
     "HatsGatekeeper": {
       "deploy": false,
       "criterionHats": ["26960358043289970096177553829315270011263390106506980876069447401472"],

diff --git a/packages/contracts/tasks/deploy/maci/02-gatekeepers.ts b/packages/contracts/tasks/deploy/maci/02-gatekeepers.ts
@@ -22,19 +22,22 @@ deployment.deployTask(EDeploySteps.Gatekeepers, "Deploy gatekeepers").then((task
     const gitcoinGatekeeperContractAddress = storage.getAddress(EContracts.GitcoinPassportGatekeeper, hre.network.name);
     const zupassGatekeeperContractAddress = storage.getAddress(EContracts.ZupassGatekeeper, hre.network.name);
     const semaphoreGatekeeperContractAddress = storage.getAddress(EContracts.SemaphoreGatekeeper, hre.network.name);
+    const merkleProofGatekeeperContractAddress = storage.getAddress(EContracts.MerkleProofGatekeeper, hre.network.name);
     const deployFreeForAllGatekeeper = deployment.getDeployConfigField(EContracts.FreeForAllGatekeeper, "deploy");
     const deployEASGatekeeper = deployment.getDeployConfigField(EContracts.EASGatekeeper, "deploy");
     const deployGitcoinGatekeeper = deployment.getDeployConfigField(EContracts.GitcoinPassportGatekeeper, "deploy");
     const deployZupassGatekeeper = deployment.getDeployConfigField(EContracts.ZupassGatekeeper, "deploy");
     const deploySemaphoreGatekeeper = deployment.getDeployConfigField(EContracts.SemaphoreGatekeeper, "deploy");
     const deployHatsSingleGatekeeper = deployment.getDeployConfigField(EContracts.HatsGatekeeper, "deploy");
+    const deployMerkleGateekeper = deployment.getDeployConfigField(EContracts.MerkleProofGatekeeper, "deploy");
 
     const skipDeployFreeForAllGatekeeper = deployFreeForAllGatekeeper !== true;
     const skipDeployEASGatekeeper = deployEASGatekeeper !== true;
     const skipDeployGitcoinGatekeeper = deployGitcoinGatekeeper !== true;
     const skipDeployZupassGatekeeper = deployZupassGatekeeper !== true;
     const skipDeploySemaphoreGatekeeper = deploySemaphoreGatekeeper !== true;
     const skipDeployHatsGatekeeper = deployHatsSingleGatekeeper !== true;
+    const skipDeployMerkleProofGatekeeper = deployMerkleGateekeper !== true;
 
     const canSkipDeploy =
       incremental &&
@@ -44,12 +47,14 @@ deployment.deployTask(EDeploySteps.Gatekeepers, "Deploy gatekeepers").then((task
       (zupassGatekeeperContractAddress || skipDeployZupassGatekeeper) &&
       (semaphoreGatekeeperContractAddress || skipDeploySemaphoreGatekeeper) &&
       (hatsGatekeeperContractAddress || skipDeployHatsGatekeeper) &&
+      (merkleProofGatekeeperContractAddress || skipDeployMerkleProofGatekeeper) &&
       (!skipDeployFreeForAllGatekeeper ||
         !skipDeployEASGatekeeper ||
         !skipDeployGitcoinGatekeeper ||
         !skipDeployZupassGatekeeper ||
         !skipDeploySemaphoreGatekeeper ||
-        !skipDeployHatsGatekeeper);
+        !skipDeployHatsGatekeeper ||
+        !skipDeployMerkleProofGatekeeper);
 
     if (canSkipDeploy) {
       // eslint-disable-next-line no-console
@@ -228,5 +233,23 @@ deployment.deployTask(EDeploySteps.Gatekeepers, "Deploy gatekeepers").then((task
         network: hre.network.name,
       });
     }
+
+    if (!skipDeployMerkleProofGatekeeper) {
+      const root = deployment.getDeployConfigField<string>(EContracts.MerkleProofGatekeeper, "root", true);
+
+      const MerkleProofGatekeeperContract = await deployment.deployContract(
+        {
+          name: EContracts.MerkleProofGatekeeper,
+          signer: deployer,
+        },
+        root,
+      );
+      await storage.register({
+        id: EContracts.MerkleProofGatekeeper,
+        contract: MerkleProofGatekeeperContract,
+        args: [root],
+        network: hre.network.name,
+      });
+    }
   }),
 );
diff --git a/packages/contracts/tasks/helpers/types.ts b/packages/contracts/tasks/helpers/types.ts
@@ -547,6 +547,7 @@ export enum EGatekeepers {
   HatsMultiple = "HatsGatekeeperMultiple",
   Zupass = "ZupassGatekeeper",
   Semaphore = "SemaphoreGatekeeper",
+  MerkleProof = "MerkleProofGatekeeper",
 }
 
 /**
@@ -570,6 +571,7 @@ export enum EContracts {
   ZupassGatekeeper = "ZupassGatekeeper",
   ZupassGroth16Verifier = "ZupassGroth16Verifier",
   SemaphoreGatekeeper = "SemaphoreGatekeeper",
+  MerkleProofGatekeeper = "MerkleProofGatekeeper",
   Verifier = "Verifier",
   MACI = "MACI",
   StateAq = "StateAq",