feat(contracts): add deployment code for SemaphoreGatekeeper (#1588)

privacy-scaling-explorations · Jun 21, 2024 · 149df59 · 149df59
1 parent 8ab3d7d
commit 149df59
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 1 deletion.
diff --git a/contracts/contracts/gatekeepers/SemaphoreGatekeeper.sol b/contracts/contracts/gatekeepers/SemaphoreGatekeeper.sol
@@ -65,6 +65,8 @@ contract SemaphoreGatekeeper is SignUpGatekeeper, Ownable(msg.sender) {
     if (proof.scope != groupId) revert InvalidGroup();
 
     // register the nullifier so it cannot be called again with the same one
+    // note that given the nullifier will be hash(secret, groupId), the same
+    // identity cannot then be registered twice for this group
     registeredIdentities[proof.nullifier] = true;
 
     // check if the proof validates

diff --git a/contracts/deploy-config-example.json b/contracts/deploy-config-example.json
@@ -25,6 +25,11 @@
       "eventId": "69c0caaa-c65d-5345-a20c-867774f18c67",
       "zupassVerifier": "0x2272cdb3596617886d0F48524DA486044E0376d6"
     },
+    "SemaphoreGatekeeper": {
+      "deploy": false,
+      "semaphoreContract": "0x0A09FB3f63c13F1C54F2fA41AFB1e7a98cffc774",
+      "groupId": 0
+    },
     "MACI": {
       "stateTreeDepth": 10,
       "gatekeeper": "EASGatekeeper"
@@ -76,6 +81,11 @@
       "signer2": "7654374482676219729919246464135900991450848628968334062174564799457623790084",
       "eventId": "d2ce5bb2-99a3-5a61-b7e6-1cd46d2ee00d"
     },
+    "SemaphoreGatekeeper": {
+      "deploy": false,
+      "semaphoreContract": "0x0000000000000000000000000000000000000000",
+      "groupId": 0
+    },
     "MACI": {
       "stateTreeDepth": 10,
       "gatekeeper": "ZupassGatekeeper"
@@ -133,6 +143,11 @@
       "eventId": "69c0caaa-c65d-5345-a20c-867774f18c67",
       "zupassVerifier": "0x2272cdb3596617886d0F48524DA486044E0376d6"
     },
+    "SemaphoreGatekeeper": {
+      "deploy": false,
+      "semaphoreContract": "0x0000000000000000000000000000000000000000",
+      "groupId": 0
+    },
     "MACI": {
       "stateTreeDepth": 6,
       "gatekeeper": "EASGatekeeper"

diff --git a/contracts/tasks/deploy/maci/02-gatekeepers.ts b/contracts/tasks/deploy/maci/02-gatekeepers.ts
@@ -19,26 +19,31 @@ deployment.deployTask("full:deploy-gatekeepers", "Deploy gatekeepers").then((tas
     const easGatekeeperContractAddress = storage.getAddress(EContracts.EASGatekeeper, hre.network.name);
     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 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 skipDeployFreeForAllGatekeeper = deployFreeForAllGatekeeper !== true;
     const skipDeployEASGatekeeper = deployEASGatekeeper !== true;
     const skipDeployGitcoinGatekeeper = deployGitcoinGatekeeper !== true;
     const skipDeployZupassGatekeeper = deployZupassGatekeeper !== true;
+    const skipDeploySemaphoreGatekeeper = deploySemaphoreGatekeeper !== true;
 
     const canSkipDeploy =
       incremental &&
       (freeForAllGatekeeperContractAddress || skipDeployFreeForAllGatekeeper) &&
       (easGatekeeperContractAddress || skipDeployEASGatekeeper) &&
       (gitcoinGatekeeperContractAddress || skipDeployGitcoinGatekeeper) &&
       (zupassGatekeeperContractAddress || skipDeployZupassGatekeeper) &&
+      (semaphoreGatekeeperContractAddress || skipDeploySemaphoreGatekeeper) &&
       (!skipDeployFreeForAllGatekeeper ||
         !skipDeployEASGatekeeper ||
         !skipDeployGitcoinGatekeeper ||
-        !skipDeployZupassGatekeeper);
+        !skipDeployZupassGatekeeper ||
+        !skipDeploySemaphoreGatekeeper);
 
     if (canSkipDeploy) {
       return;
@@ -151,5 +156,30 @@ deployment.deployTask("full:deploy-gatekeepers", "Deploy gatekeepers").then((tas
         network: hre.network.name,
       });
     }
+
+    if (!skipDeploySemaphoreGatekeeper) {
+      const semaphoreContractAddress = deployment.getDeployConfigField<string>(
+        EContracts.SemaphoreGatekeeper,
+        "semaphoreContract",
+        true,
+      );
+      const groupId = deployment.getDeployConfigField<number>(EContracts.SemaphoreGatekeeper, "groupId", true);
+
+      const semaphoreGatekeeperContract = await deployment.deployContract(
+        {
+          name: EContracts.SemaphoreGatekeeper,
+          signer: deployer,
+        },
+        semaphoreContractAddress,
+        groupId,
+      );
+
+      await storage.register({
+        id: EContracts.SemaphoreGatekeeper,
+        contract: semaphoreGatekeeperContract,
+        args: [semaphoreContractAddress, groupId.toString()],
+        network: hre.network.name,
+      });
+    }
   }),
 );
diff --git a/contracts/tasks/helpers/types.ts b/contracts/tasks/helpers/types.ts
@@ -492,6 +492,7 @@ export enum EContracts {
   GitcoinPassportGatekeeper = "GitcoinPassportGatekeeper",
   ZupassGatekeeper = "ZupassGatekeeper",
   ZupassGroth16Verifier = "ZupassGroth16Verifier",
+  SemaphoreGatekeeper = "SemaphoreGatekeeper",
   Verifier = "Verifier",
   MACI = "MACI",
   StateAq = "StateAq",

diff --git a/...ed_docs/version-v2.0_alpha/developers-references/smart-contracts/Gatekeepers.md b/...ed_docs/version-v2.0_alpha/developers-references/smart-contracts/Gatekeepers.md
@@ -17,6 +17,7 @@ The MACI repository comes with several out-of-the-box options:
 - `HatsGatekeeper` - This allows gatekeeping signups to only users who have a specific [Hat](https://www.hatsprotocol.xyz/).
 - `GitcoinPassportGatekeeper` - This allows gatekeeping signups to only users who have a specific [Gitcoin Passport](https://passport.gitcoin.co/) score.
 - `ZupassGatekeeper` - This allows gatekeeping signups only to users who have a valid [Zupass PCD ticket](https://github.com/proofcarryingdata/zupass).
+- `SemaphoreGatekeeper` - This allows gatekeeping signups only to users who can prove they are part of a [Semaphore](https://semaphore.pse.dev/) group.
 
 You can find all of our latest gatekeeper contracts here:
 https://github.com/privacy-scaling-explorations/maci/tree/dev/contracts/contracts/gatekeepers

diff --git a/website/versioned_docs/version-v2.0_alpha/quick-start/deployment.md b/website/versioned_docs/version-v2.0_alpha/quick-start/deployment.md
@@ -81,6 +81,11 @@ It's necessary to define which gatekeeper you are going to use before deploying,
       "eventId": "69c0caaa-c65d-5345-a20c-867774f18c67",
       "zupassVerifier": "0x2272cdb3596617886d0F48524DA486044E0376d6"
     },
+    "SemaphoreGatekeeper": {
+      "deploy": false,
+      "semaphoreContract": "0x0000000000000000000000000000000000000000",
+      "groupId": 0
+    },
     "MACI": {
       "stateTreeDepth": 10,
       "gatekeeper": "EASGatekeeper"