Merge pull request #1774 from privacy-scaling-explorations/chore/refa…

…ctor-contracts

refactor(contracts): use custom factories for maci test deploys

packages/contracts/tests/EASGatekeeper.test.ts

@@ -57,7 +57,12 @@ describe("EAS Gatekeeper", () => {
     let maciContract: MACI;
 
     before(async () => {
-      const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, signer, true, easGatekeeper);
+      const r = await deployTestContracts({
+        initialVoiceCreditBalance,
+        stateTreeDepth: STATE_TREE_DEPTH,
+        signer,
+        gatekeeper: easGatekeeper,
+      });
 
       maciContract = r.maciContract;
     });

packages/contracts/tests/GitcoinPassportGatekeeper.test.ts

@@ -30,7 +30,12 @@ describe("GitcoinPassport Gatekeeper", () => {
     decoderAddress = await mockDecoder.getAddress();
     gitcoinGatekeeper = await deployContract("GitcoinPassportGatekeeper", signer, true, decoderAddress, passingScore);
 
-    const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, signer, true, gitcoinGatekeeper);
+    const r = await deployTestContracts({
+      initialVoiceCreditBalance,
+      stateTreeDepth: STATE_TREE_DEPTH,
+      signer,
+      gatekeeper: gitcoinGatekeeper,
+    });
     maciContract = r.maciContract;
   });
 

packages/contracts/tests/HatsGatekeeper.test.ts

@@ -47,13 +47,12 @@ describe("HatsProtocol Gatekeeper", () => {
 
   describe("hatsGatekeeperSingle", () => {
     before(async () => {
-      const r = await deployTestContracts(
+      const r = await deployTestContracts({
         initialVoiceCreditBalance,
-        STATE_TREE_DEPTH,
+        stateTreeDepth: STATE_TREE_DEPTH,
         signer,
-        true,
-        hatsGatekeeperSingle,
-      );
+        gatekeeper: hatsGatekeeperSingle,
+      });
 
       maciContract = r.maciContract;
     });
@@ -137,13 +136,12 @@ describe("HatsProtocol Gatekeeper", () => {
 
   describe("HatsGatekeeperMultiple", () => {
     before(async () => {
-      const r = await deployTestContracts(
+      const r = await deployTestContracts({
         initialVoiceCreditBalance,
-        STATE_TREE_DEPTH,
+        stateTreeDepth: STATE_TREE_DEPTH,
         signer,
-        true,
-        hatsGatekeeperMultiple,
-      );
+        gatekeeper: hatsGatekeeperMultiple,
+      });
 
       maciContract = r.maciContract;
     });

packages/contracts/tests/MACI.test.ts

@@ -31,7 +31,11 @@ describe("MACI", function test() {
   describe("Deployment", () => {
     before(async () => {
       signer = await getDefaultSigner();
-      const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, signer, true);
+      const r = await deployTestContracts({
+        initialVoiceCreditBalance,
+        stateTreeDepth: STATE_TREE_DEPTH,
+        signer,
+      });
 
       maciContract = r.maciContract;
       vkRegistryContract = r.vkRegistryContract;
@@ -45,12 +49,11 @@ describe("MACI", function test() {
 
     it("should be possible to deploy Maci contracts with different state tree depth values", async () => {
       const checkStateTreeDepth = async (stateTreeDepthTest: number): Promise<void> => {
-        const { maciContract: testMaci } = await deployTestContracts(
+        const { maciContract: testMaci } = await deployTestContracts({
           initialVoiceCreditBalance,
-          stateTreeDepthTest,
+          stateTreeDepth: stateTreeDepthTest,
           signer,
-          true,
-        );
+        });
         expect(await testMaci.stateTreeDepth()).to.eq(stateTreeDepthTest);
       };
 
@@ -152,8 +155,13 @@ describe("MACI", function test() {
     it("should not allow to sign up more than the supported amount of users (2 ** stateTreeDepth)", async () => {
       const stateTreeDepthTest = 1;
       const maxUsers = 2 ** stateTreeDepthTest;
-      const maci = (await deployTestContracts(initialVoiceCreditBalance, stateTreeDepthTest, signer, true))
-        .maciContract;
+      const maci = (
+        await deployTestContracts({
+          initialVoiceCreditBalance,
+          stateTreeDepth: stateTreeDepthTest,
+          signer,
+        })
+      ).maciContract;
       const keypair = new Keypair();
       // start from one as we already have one signup (blank state leaf)
       for (let i = 1; i < maxUsers; i += 1) {
@@ -178,12 +186,11 @@ describe("MACI", function test() {
     it("should signup 2 ** 10 users", async () => {
       const stateTreeDepthTest = 10;
       const maxUsers = 2 ** stateTreeDepthTest;
-      const { maciContract: maci } = await deployTestContracts(
+      const { maciContract: maci } = await deployTestContracts({
         initialVoiceCreditBalance,
-        stateTreeDepthTest,
+        stateTreeDepth: stateTreeDepthTest,
         signer,
-        true,
-      );
+      });
 
       const keypair = new Keypair();
       // start from one as we already have one signup (blank state leaf)

packages/contracts/tests/MessageProcessor.test.ts

@@ -51,7 +51,11 @@ describe("MessageProcessor", () => {
   before(async () => {
     signer = await getDefaultSigner();
     // deploy test contracts
-    const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, signer, true);
+    const r = await deployTestContracts({
+      initialVoiceCreditBalance,
+      stateTreeDepth: STATE_TREE_DEPTH,
+      signer,
+    });
     maciContract = r.maciContract;
     signer = await getDefaultSigner();
     verifierContract = r.mockVerifierContract as Verifier;

packages/contracts/tests/Poll.test.ts

@@ -45,7 +45,11 @@ describe("Poll", () => {
   describe("deployment", () => {
     before(async () => {
       signer = await getDefaultSigner();
-      const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, signer, true);
+      const r = await deployTestContracts({
+        initialVoiceCreditBalance,
+        stateTreeDepth: STATE_TREE_DEPTH,
+        signer,
+      });
       maciContract = r.maciContract;
       verifierContract = r.mockVerifierContract as Verifier;
       vkRegistryContract = r.vkRegistryContract;
@@ -119,7 +123,11 @@ describe("Poll", () => {
     });
 
     it("should fail when passing an invalid coordinator public key", async () => {
-      const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, signer, true);
+      const r = await deployTestContracts({
+        initialVoiceCreditBalance,
+        stateTreeDepth: STATE_TREE_DEPTH,
+        signer,
+      });
       const testMaciContract = r.maciContract;
 
       // deploy on chain poll

packages/contracts/tests/SemaphoreGatekeeper.test.ts

@@ -78,13 +78,12 @@ describe("Semaphore Gatekeeper", () => {
     let maciContract: MACI;
 
     before(async () => {
-      const r = await deployTestContracts(
+      const r = await deployTestContracts({
         initialVoiceCreditBalance,
-        STATE_TREE_DEPTH,
+        stateTreeDepth: STATE_TREE_DEPTH,
         signer,
-        true,
-        semaphoreGatekeeper,
-      );
+        gatekeeper: semaphoreGatekeeper,
+      });
 
       maciContract = r.maciContract;
     });

packages/contracts/tests/SignUpGatekeeper.test.ts

@@ -41,13 +41,12 @@ describe("SignUpGatekeeper", () => {
       signUpToken = await deploySignupToken(signer, true);
       signUpTokenGatekeeperContract = await deploySignupTokenGatekeeper(await signUpToken.getAddress(), signer, true);
 
-      const r = await deployTestContracts(
+      const r = await deployTestContracts({
         initialVoiceCreditBalance,
-        STATE_TREE_DEPTH,
+        stateTreeDepth: STATE_TREE_DEPTH,
         signer,
-        true,
-        signUpTokenGatekeeperContract,
-      );
+        gatekeeper: signUpTokenGatekeeperContract,
+      });
 
       maciContract = r.maciContract;
     });

packages/contracts/tests/Tally.test.ts

@@ -57,7 +57,7 @@ describe("TallyVotes", () => {
 
     signer = await getDefaultSigner();
 
-    const r = await deployTestContracts(100, STATE_TREE_DEPTH, signer, true);
+    const r = await deployTestContracts({ initialVoiceCreditBalance: 100, stateTreeDepth: STATE_TREE_DEPTH, signer });
     maciContract = r.maciContract;
     verifierContract = r.mockVerifierContract as Verifier;
     vkRegistryContract = r.vkRegistryContract;
@@ -196,7 +196,7 @@ describe("TallyVotes", () => {
 
       const intStateTreeDepth = 2;
 
-      const r = await deployTestContracts(100, STATE_TREE_DEPTH, signer, true);
+      const r = await deployTestContracts({ initialVoiceCreditBalance: 100, stateTreeDepth: STATE_TREE_DEPTH, signer });
       maciContract = r.maciContract;
       verifierContract = r.mockVerifierContract as Verifier;
       vkRegistryContract = r.vkRegistryContract;
@@ -324,7 +324,7 @@ describe("TallyVotes", () => {
 
       const intStateTreeDepth = 2;
 
-      const r = await deployTestContracts(100, STATE_TREE_DEPTH, signer, true);
+      const r = await deployTestContracts({ initialVoiceCreditBalance: 100, stateTreeDepth: STATE_TREE_DEPTH, signer });
       maciContract = r.maciContract;
       verifierContract = r.mockVerifierContract as Verifier;
       vkRegistryContract = r.vkRegistryContract;

packages/contracts/tests/TallyNonQv.test.ts

@@ -46,7 +46,7 @@ describe("TallyVotesNonQv", () => {
 
     signer = await getDefaultSigner();
 
-    const r = await deployTestContracts(100, STATE_TREE_DEPTH, signer, true);
+    const r = await deployTestContracts({ initialVoiceCreditBalance: 100, stateTreeDepth: STATE_TREE_DEPTH, signer });
     maciContract = r.maciContract;
     verifierContract = r.mockVerifierContract as Verifier;
     vkRegistryContract = r.vkRegistryContract;

packages/contracts/tests/ZupassGatekeeper.test.ts

@@ -56,7 +56,12 @@ describe("Zupass Gatekeeper", () => {
     let maciContract: MACI;
 
     before(async () => {
-      const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, signer, true, zupassGatekeeper);
+      const r = await deployTestContracts({
+        initialVoiceCreditBalance,
+        stateTreeDepth: STATE_TREE_DEPTH,
+        signer,
+        gatekeeper: zupassGatekeeper,
+      });
 
       maciContract = r.maciContract;
     });

packages/contracts/tests/utils.ts

@@ -1,9 +1,10 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import { expect } from "chai";
-import { BaseContract, Signer } from "ethers";
+import { BaseContract } from "ethers";
 import { IncrementalQuinTree, AccQueue, calcDepthFromNumLeaves, hash2, hash5 } from "maci-crypto";
 import { IVkContractParams, VerifyingKey } from "maci-domainobjs";
 
+import type { IDeployedTestContracts, IDeployedTestContractsArgs } from "../ts/types";
 import type { EthereumProvider } from "hardhat/types";
 
 import { linkPoseidonLibraries } from "../tasks/helpers/abi";
@@ -17,14 +18,12 @@ import {
   deployVkRegistry,
   createContractFactory,
 } from "../ts/deploy";
-import { IDeployedTestContracts } from "../ts/types";
 import {
   AccQueueBinary0__factory as AccQueueBinary0Factory,
   AccQueueBinaryMaci__factory as AccQueueBinaryMaciFactory,
   AccQueue as AccQueueContract,
   AccQueueQuinary0__factory as AccQueueQuinary0Factory,
   AccQueueQuinaryMaci__factory as AccQueueQuinaryMaciFactory,
-  FreeForAllGatekeeper,
 } from "../typechain-types";
 
 export const insertSubTreeGasLimit = { gasLimit: 300000 };
@@ -498,13 +497,14 @@ export const testMergeAgain = async (aq: AccQueue, aqContract: AccQueueContract,
  * @param gatekeeper - the gatekeeper contract to use
  * @returns the deployed contracts
  */
-export const deployTestContracts = async (
-  initialVoiceCreditBalance: number,
-  stateTreeDepth: number,
-  signer?: Signer,
+export const deployTestContracts = async ({
+  initialVoiceCreditBalance,
+  stateTreeDepth,
+  signer,
   quiet = true,
-  gatekeeper: FreeForAllGatekeeper | undefined = undefined,
-): Promise<IDeployedTestContracts> => {
+  factories,
+  gatekeeper,
+}: IDeployedTestContractsArgs): Promise<IDeployedTestContracts> => {
   const mockVerifierContract = await deployMockVerifier(signer, true);
 
   let gatekeeperContract = gatekeeper;
@@ -530,6 +530,7 @@ export const deployTestContracts = async (
     initialVoiceCreditBalanceAddress: constantInitialVoiceCreditProxyContractAddress,
     signer,
     stateTreeDepth,
+    factories,
     quiet,
   });
 

packages/contracts/ts/deploy.ts

@@ -296,31 +296,28 @@ export const deployMaci = async ({
     poseidonT6,
   }));
 
-  const contractsToLink = factories || [
-    MACIFactory,
-    PollFactoryFactory,
-    MessageProcessorFactoryFactory,
-    TallyFactoryFactory,
-  ];
+  const contractsToLink = [MACIFactory, PollFactoryFactory, MessageProcessorFactoryFactory, TallyFactoryFactory];
 
   // Link Poseidon contracts to MACI
-  const linkedContractFactories = await Promise.all(
-    contractsToLink.map(async (factory) =>
-      createContractFactory(
-        factory.abi,
-        factory.linkBytecode({
-          "contracts/crypto/PoseidonT3.sol:PoseidonT3": poseidonAddrs.poseidonT3,
-          "contracts/crypto/PoseidonT4.sol:PoseidonT4": poseidonAddrs.poseidonT4,
-          "contracts/crypto/PoseidonT5.sol:PoseidonT5": poseidonAddrs.poseidonT5,
-          "contracts/crypto/PoseidonT6.sol:PoseidonT6": poseidonAddrs.poseidonT6,
-        }),
-        signer,
+  const linkedContractFactories =
+    factories ||
+    (await Promise.all(
+      contractsToLink.map(async (factory) =>
+        createContractFactory(
+          factory.abi,
+          factory.linkBytecode({
+            "contracts/crypto/PoseidonT3.sol:PoseidonT3": poseidonAddrs.poseidonT3,
+            "contracts/crypto/PoseidonT4.sol:PoseidonT4": poseidonAddrs.poseidonT4,
+            "contracts/crypto/PoseidonT5.sol:PoseidonT5": poseidonAddrs.poseidonT5,
+            "contracts/crypto/PoseidonT6.sol:PoseidonT6": poseidonAddrs.poseidonT6,
+          }),
+          signer,
+        ),
       ),
-    ),
-  );
+    ));
 
   const [maciContractFactory, pollFactoryContractFactory, messageProcessorFactory, tallyFactory] =
-    await Promise.all(linkedContractFactories);
+    linkedContractFactories;
 
   const pollFactoryContract = await deployContractWithLinkedLibraries<PollFactory>(pollFactoryContractFactory);
 

packages/contracts/ts/index.ts

@@ -30,6 +30,7 @@ export {
   type TallyData,
 } from "../tasks/helpers/types";
 export { linkPoseidonLibraries } from "../tasks/helpers/abi";
+export { buildPoseidonT3, buildPoseidonT4, buildPoseidonT5, buildPoseidonT6 } from "./buildPoseidon";
 
 export type { IVerifyingKeyStruct, SnarkProof, Groth16Proof, Proof } from "./types";
 export * from "../typechain-types";