Merge pull request #909 from privacy-scaling-explorations/refactoring…

…/contracts-scripts

refactor(contracts): cleanup unused scripts and organize ts code

cli/ts/commands/deploy.ts

@@ -6,6 +6,7 @@ import {
   deployVerifier,
   deployMaci,
   deployTopupCredit,
+  getDefaultSigner,
 } from "maci-contracts";
 import { logError, logGreen, success, DEFAULT_INITIAL_VOICE_CREDITS, DeployedContracts } from "../utils/";
 
@@ -32,11 +33,14 @@ export const deploy = async (
     logError("Please provide either an initialVoiceCreditProxyAddress or initialVoiceCredits, not both");
   }
 
+  const signer = await getDefaultSigner();
+
   // if we did not deploy it before, then deploy it now
   let initialVoiceCreditProxyContractAddress: string;
   if (!initialVoiceCreditsProxyAddress) {
     const contract = await deployConstantInitialVoiceCreditProxy(
       initialVoiceCredits ? initialVoiceCredits : DEFAULT_INITIAL_VOICE_CREDITS,
+      signer,
       true,
     );
 
@@ -46,15 +50,15 @@ export const deploy = async (
   // check if we have a signupGatekeeper already deployed or passed as arg
   let signupGatekeeperContractAddress = readContractAddress("SignUpGatekeeper");
   if (!signupGatekeeperContractAddress && !signupGatekeeperAddress) {
-    const contract = await deployFreeForAllSignUpGatekeeper(true);
+    const contract = await deployFreeForAllSignUpGatekeeper(signer, true);
     signupGatekeeperContractAddress = await contract.getAddress();
   }
 
   // deploy a verifier contract
-  const verifierContract = await deployVerifier(true);
+  const verifierContract = await deployVerifier(signer, true);
 
   // topup credit
-  const topUpCredit = await deployTopupCredit(true);
+  const topUpCredit = await deployTopupCredit(signer, true);
 
   const [verifierContractAddress, topUpCreditAddress] = await Promise.all([
     verifierContract.getAddress(),
@@ -67,6 +71,7 @@ export const deploy = async (
     initialVoiceCreditProxyContractAddress,
     verifierContractAddress,
     topUpCreditAddress,
+    signer,
     stateTreeDepth,
     true,
   );

cli/ts/commands/deployPoll.ts

@@ -95,6 +95,7 @@ export const deployPoll = async (
     poseidonT4,
     poseidonT5,
     poseidonT6,
+    signer,
     true,
   );
 
@@ -106,6 +107,7 @@ export const deployPoll = async (
     poseidonT4,
     poseidonT5,
     poseidonT6,
+    signer,
     true,
   );
 
@@ -117,6 +119,7 @@ export const deployPoll = async (
     poseidonT4,
     poseidonT5,
     poseidonT6,
+    signer,
     true,
   );
 

cli/ts/commands/deployVkRegistry.ts

@@ -1,4 +1,4 @@
-import { deployVkRegistry } from "maci-contracts";
+import { deployVkRegistry, getDefaultSigner } from "maci-contracts";
 import { existsSync, renameSync } from "fs";
 import { contractAddressesStore, oldContractAddressesStore } from "../utils/constants";
 import { logGreen, success } from "../utils/theme";
@@ -18,7 +18,7 @@ export const deployVkRegistryContract = async (quiet = true): Promise<string> =>
   }
 
   // deploy and store the address
-  const vkRegistry = await deployVkRegistry(true);
+  const vkRegistry = await deployVkRegistry(await getDefaultSigner(), true);
   const vkRegistryAddress = await vkRegistry.getAddress();
   storeContractAddress("VkRegistry", vkRegistryAddress);
 

contracts/package.json

@@ -5,7 +5,7 @@
   "main": "build/ts/index.js",
   "scripts": {
     "watch": "tsc --watch",
-    "hardhat": "./scripts/runHardhat.sh",
+    "hardhat": "hardhat node --hostname 0.0.0.0 --port 8545",
     "compileSol": "./scripts/compileSol.sh $1",
     "moveIntegrationArtifacts": "cp -r artifacts/ ../integrationTests/artifacts",
     "prebuild": "npm run compileSol",
@@ -22,7 +22,9 @@
     "test-signupGatekeeper": "hardhat test ./tests/SignUpGatekeeper.test.ts",
     "test-verifier": "hardhat test ./tests/Verifier.test.ts",
     "test-accQueue": "hardhat test ./tests/AccQueue.test.ts",
-    "test-accQueueBenchmark": "hardhat test ./tests/AccQueueBenchmark.test.ts"
+    "test-accQueueBenchmark": "hardhat test ./tests/AccQueueBenchmark.test.ts",
+    "test-maciOverflow": "hardhat test ./tests/MaciOverflow.test.ts",
+    "test-hasherBenchmarks": "hardhat test ./tests/HasherBenchmarks.test.ts"
   },
   "_moduleAliases": {
     "@maci-contracts": "."

contracts/tests/AccQueueBenchmark.test.ts

@@ -2,15 +2,14 @@ import { expect } from "chai";
 import { AccQueue, NOTHING_UP_MY_SLEEVE } from "maci-crypto";
 
 import { deployPoseidonContracts, linkPoseidonLibraries } from "../ts/deploy";
+import { getDefaultSigner } from "../ts/utils";
 import { AccQueue as AccQueueContract } from "../typechain-types";
 
-require("module-alias/register");
-
 let aqContract: AccQueueContract;
 
 const deploy = async (contractName: string, SUB_DEPTH: number, HASH_LENGTH: number, ZERO: bigint) => {
   const { PoseidonT3Contract, PoseidonT4Contract, PoseidonT5Contract, PoseidonT6Contract } =
-    await deployPoseidonContracts(true);
+    await deployPoseidonContracts(await getDefaultSigner(), true);
   const [poseidonT3ContractAddress, poseidonT4ContractAddress, poseidonT5ContractAddress, poseidonT6ContractAddress] =
     await Promise.all([
       PoseidonT3Contract.getAddress(),
@@ -26,6 +25,7 @@ const deploy = async (contractName: string, SUB_DEPTH: number, HASH_LENGTH: numb
     poseidonT4ContractAddress,
     poseidonT5ContractAddress,
     poseidonT6ContractAddress,
+    await getDefaultSigner(),
     true,
   );
 

contracts/tests/Hasher.test.ts

@@ -3,14 +3,15 @@ import { BigNumberish } from "ethers";
 import { sha256Hash, hashLeftRight, hash3, hash4, hash5, genRandomSalt } from "maci-crypto";
 
 import { deployPoseidonContracts, linkPoseidonLibraries } from "../ts/deploy";
+import { getDefaultSigner } from "../ts/utils";
 import { Hasher } from "../typechain-types";
 
 describe("Hasher", () => {
   let hasherContract: Hasher;
 
   before(async () => {
     const { PoseidonT3Contract, PoseidonT4Contract, PoseidonT5Contract, PoseidonT6Contract } =
-      await deployPoseidonContracts(true);
+      await deployPoseidonContracts(await getDefaultSigner(), true);
     const [poseidonT3ContractAddress, poseidonT4ContractAddress, poseidonT5ContractAddress, poseidonT6ContractAddress] =
       await Promise.all([
         PoseidonT3Contract.getAddress(),
@@ -25,6 +26,7 @@ describe("Hasher", () => {
       poseidonT4ContractAddress,
       poseidonT5ContractAddress,
       poseidonT6ContractAddress,
+      await getDefaultSigner(),
       true,
     );
 

contracts/tests/HasherBenchmarks.test.ts

@@ -3,6 +3,7 @@ import { BigNumberish } from "ethers";
 import { genRandomSalt } from "maci-crypto";
 
 import { deployPoseidonContracts, linkPoseidonLibraries } from "../ts/deploy";
+import { getDefaultSigner } from "../ts/utils";
 import { HasherBenchmarks } from "../typechain-types";
 
 require("module-alias/register");
@@ -11,7 +12,7 @@ describe("Hasher", () => {
   let hasherContract: HasherBenchmarks;
   before(async () => {
     const { PoseidonT3Contract, PoseidonT4Contract, PoseidonT5Contract, PoseidonT6Contract } =
-      await deployPoseidonContracts(true);
+      await deployPoseidonContracts(await getDefaultSigner(), true);
     const [poseidonT3ContractAddress, poseidonT4ContractAddress, poseidonT5ContractAddress, poseidonT6ContractAddress] =
       await Promise.all([
         PoseidonT3Contract.getAddress(),
@@ -26,6 +27,7 @@ describe("Hasher", () => {
       poseidonT4ContractAddress,
       poseidonT5ContractAddress,
       poseidonT6ContractAddress,
+      await getDefaultSigner(),
       true,
     );
 

contracts/tests/MACI.test.ts

@@ -8,8 +8,8 @@ import { VerifyingKey, Keypair, PubKey, Message } from "maci-domainobjs";
 
 import type { IVerifyingKeyStruct } from "../ts/types";
 
-import { parseArtifact, getDefaultSigner } from "../ts/deploy";
-import { deployTestContracts } from "../ts/utils";
+import { parseArtifact } from "../ts/abi";
+import { getDefaultSigner } from "../ts/utils";
 import { AccQueueQuinaryMaci, MACI, VkRegistry, Poll as PollContract } from "../typechain-types";
 
 import {
@@ -22,7 +22,7 @@ import {
   testTallyVk,
   treeDepths,
 } from "./constants";
-import { compareVks, timeTravel } from "./utils";
+import { compareVks, timeTravel, deployTestContracts } from "./utils";
 
 describe("MACI", () => {
   let maciContract: MACI;
@@ -42,7 +42,7 @@ describe("MACI", () => {
   describe("Deployment", () => {
     before(async () => {
       signer = await getDefaultSigner();
-      const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, true);
+      const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, signer, true);
 
       maciContract = r.maciContract;
       stateAqContract = r.stateAqContract;
@@ -108,7 +108,8 @@ describe("MACI", () => {
     it("should not allow to sign up more than the supported amount of users (5 ** stateTreeDepth)", async () => {
       const stateTreeDepthTest = 1;
       const maxUsers = 5 ** stateTreeDepthTest;
-      const maci = (await deployTestContracts(initialVoiceCreditBalance, stateTreeDepthTest, true)).maciContract;
+      const maci = (await deployTestContracts(initialVoiceCreditBalance, stateTreeDepthTest, signer, true))
+        .maciContract;
       const keypair = new Keypair();
       for (let i = 0; i < maxUsers; i += 1) {
         // eslint-disable-next-line no-await-in-loop

contracts/tests/MaciOverflow.test.ts

@@ -3,10 +3,11 @@ import { AbiCoder, BigNumberish } from "ethers";
 import { MaxValues, STATE_TREE_DEPTH, TreeDepths } from "maci-core";
 import { Keypair } from "maci-domainobjs";
 
-import { deployTestContracts } from "../ts/utils";
+import { getDefaultSigner } from "../ts/utils";
 import { MACI } from "../typechain-types";
 
 import { duration, initialVoiceCreditBalance, maxValues, treeDepths } from "./constants";
+import { deployTestContracts } from "./utils";
 
 describe("Overflow testing", () => {
   let maciContract: MACI;
@@ -15,7 +16,7 @@ describe("Overflow testing", () => {
   const users = [new Keypair(), new Keypair(), new Keypair()];
 
   beforeEach(async () => {
-    const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, true);
+    const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, await getDefaultSigner(), true);
     maciContract = r.maciContract;
   });
 

contracts/tests/MessageProcessor.test.ts

@@ -6,7 +6,9 @@ import { MaciState, Poll, STATE_TREE_DEPTH, packProcessMessageSmallVals } from "
 import { NOTHING_UP_MY_SLEEVE } from "maci-crypto";
 import { Keypair, Message, PubKey } from "maci-domainobjs";
 
-import { IVerifyingKeyStruct, deployTestContracts, getDefaultSigner, parseArtifact } from "../ts";
+import { parseArtifact } from "../ts/abi";
+import { IVerifyingKeyStruct } from "../ts/types";
+import { getDefaultSigner } from "../ts/utils";
 import { MACI, MessageProcessor, Poll as PollContract } from "../typechain-types";
 
 import {
@@ -18,7 +20,7 @@ import {
   testTallyVk,
   treeDepths,
 } from "./constants";
-import { timeTravel } from "./utils";
+import { timeTravel, deployTestContracts } from "./utils";
 
 describe("MessageProcessor", () => {
   // contracts
@@ -40,8 +42,9 @@ describe("MessageProcessor", () => {
   const users = [new Keypair(), new Keypair()];
 
   before(async () => {
+    signer = await getDefaultSigner();
     // deploy test contracts
-    const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, true);
+    const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, signer, true);
     maciContract = r.maciContract;
     signer = await getDefaultSigner();
     mpContract = r.mpContract;

contracts/tests/Poll.test.ts

@@ -6,7 +6,8 @@ import { MaciState } from "maci-core";
 import { NOTHING_UP_MY_SLEEVE } from "maci-crypto";
 import { Keypair, Message, PCommand, PubKey } from "maci-domainobjs";
 
-import { deployTestContracts, getDefaultSigner, parseArtifact } from "../ts";
+import { parseArtifact } from "../ts/abi";
+import { getDefaultSigner } from "../ts/utils";
 import { AccQueue, MACI, Poll as PollContract } from "../typechain-types";
 
 import {
@@ -18,7 +19,7 @@ import {
   messageBatchSize,
   treeDepths,
 } from "./constants";
-import { timeTravel } from "./utils";
+import { timeTravel, deployTestContracts } from "./utils";
 
 describe("Poll", () => {
   let maciContract: MACI;
@@ -34,7 +35,7 @@ describe("Poll", () => {
 
   before(async () => {
     signer = await getDefaultSigner();
-    const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, true);
+    const r = await deployTestContracts(initialVoiceCreditBalance, STATE_TREE_DEPTH, signer, true);
     maciContract = r.maciContract;
 
     // deploy on chain poll
@@ -108,7 +109,7 @@ describe("Poll", () => {
       maciState.polls[pollId].publishMessage(message, keypair.pubKey);
     });
 
-    it("shold not publish a message after the voting period", async () => {
+    it("should not publish a message after the voting period", async () => {
       const dd = await pollContract.getDeployTimeAndDuration();
       await timeTravel(signer.provider as unknown as EthereumProvider, Number(dd[0]) + 1);