refactor(core): refactor the process message functions and general cl…

…eanup

Remove unnecessary code, fix types, remove unused variables or duplicate ones, refactor the process
messages functions to ensure they can be tested individually, add custom error messages for message
processing debugging, ensure code is well commented and explained

circuits/ts/__tests__/ProcessMessages.test.ts

@@ -61,8 +61,6 @@ describe("ProcessMessage circuit", function () {
       );
 
       pollId = maciState.deployPoll(
-        duration,
-        // BigInt(2 + duration),
         BigInt(Math.floor(Date.now() / 1000) + duration),
         maxValues,
         treeDepths,
@@ -153,7 +151,12 @@ describe("ProcessMessage circuit", function () {
       expect(newStateRoot.toString()).not.to.be.eq(currentStateRoot.toString());
       expect(newBallotRoot.toString()).not.to.be.eq(currentBallotRoot.toString());
 
-      const packedVals = packProcessMessageSmallVals(BigInt(maxValues.maxVoteOptions), BigInt(poll.numSignUps), 0, 2);
+      const packedVals = packProcessMessageSmallVals(
+        BigInt(maxValues.maxVoteOptions),
+        BigInt(poll.maciStateRef.numSignUps),
+        0,
+        2,
+      );
 
       // Test the ProcessMessagesInputHasher circuit
       const hasherCircuitInputs = stringifyBigInts({
@@ -196,7 +199,6 @@ describe("ProcessMessage circuit", function () {
       );
 
       pollId = maciState.deployPoll(
-        duration,
         BigInt(2 + duration), //BigInt(Math.floor(Date.now() / 1000) + duration),
         maxValues,
         treeDepths,
@@ -291,7 +293,6 @@ describe("ProcessMessage circuit", function () {
       );
 
       pollId = maciState.deployPoll(
-        duration,
         BigInt(2 + duration), //BigInt(Math.floor(Date.now() / 1000) + duration),
         maxValues,
         treeDepths,
@@ -387,7 +388,6 @@ describe("ProcessMessage circuit", function () {
 
         // Sign up and publish
         const pollId = maciState.deployPoll(
-          duration,
           BigInt(Math.floor(Date.now() / 1000) + duration),
           maxValues,
           treeDepths,

circuits/ts/__tests__/TallyVotes.test.ts

@@ -56,7 +56,6 @@ describe("TallyVotes circuit", function () {
       );
 
       pollId = maciState.deployPoll(
-        duration,
         BigInt(Math.floor(Date.now() / 1000) + duration),
         maxValues,
         treeDepths,
@@ -137,7 +136,6 @@ describe("TallyVotes circuit", function () {
       }
 
       const pollId = maciState.deployPoll(
-        duration,
         BigInt(Math.floor(Date.now() / 1000) + duration),
         maxValues,
         treeDepths,

circuits/ts/types/snarkjs.d.ts

@@ -1,6 +1,6 @@
 declare module "snarkjs" {
   export type NumericString = `${number}` | string;
-  export type PublicSignals = Record<string, string | bigint | bigint[] | string[]>;
+  export type PublicSignals = Record<string, string | bigint | bigint[] | string[] | bigint[][] | bigint[][][]>;
   export type BigNumberish = number | string | bigint;
 
   export interface ISnarkJSVerificationKey {

contracts/tests/MACI.test.ts

@@ -217,7 +217,6 @@ describe("MACI", () => {
       pollId = event.args._pollId;
 
       const p = maciState.deployPoll(
-        duration,
         BigInt(deployTime + duration),
         maxValues,
         treeDepths,

contracts/tests/MessageProcessor.test.ts

@@ -71,14 +71,7 @@ describe("MessageProcessor", () => {
     const deployTime = block!.timestamp;
 
     // deploy local poll
-    const p = maciState.deployPoll(
-      duration,
-      BigInt(deployTime + duration),
-      maxValues,
-      treeDepths,
-      messageBatchSize,
-      coordinator,
-    );
+    const p = maciState.deployPoll(BigInt(deployTime + duration), maxValues, treeDepths, messageBatchSize, coordinator);
     expect(p.toString()).to.eq(pollId.toString());
 
     // publish the NOTHING_UP_MY_SLEEVE message

contracts/tests/Poll.test.ts

@@ -59,14 +59,7 @@ describe("Poll", () => {
     pollContract = new BaseContract(pollContractAddress, pollAbi, signer) as PollContract;
 
     // deploy local poll
-    const p = maciState.deployPoll(
-      duration,
-      BigInt(deployTime + duration),
-      maxValues,
-      treeDepths,
-      messageBatchSize,
-      coordinator,
-    );
+    const p = maciState.deployPoll(BigInt(deployTime + duration), maxValues, treeDepths, messageBatchSize, coordinator);
     expect(p.toString()).to.eq(pollId.toString());
     // publish the NOTHING_UP_MY_SLEEVE message
     const messageData = [NOTHING_UP_MY_SLEEVE, BigInt(0)];

contracts/tests/Tally.test.ts

@@ -71,14 +71,7 @@ describe("TallyVotes", () => {
     pollContract = new BaseContract(pollContractAddress, pollAbi, signer) as PollContract;
 
     // deploy local poll
-    const p = maciState.deployPoll(
-      duration,
-      BigInt(deployTime + duration),
-      maxValues,
-      treeDepths,
-      messageBatchSize,
-      coordinator,
-    );
+    const p = maciState.deployPoll(BigInt(deployTime + duration), maxValues, treeDepths, messageBatchSize, coordinator);
     expect(p.toString()).to.eq(pollId.toString());
     // publish the NOTHING_UP_MY_SLEEVE message
     const messageData = [NOTHING_UP_MY_SLEEVE, BigInt(0)];

contracts/ts/genMaciState.ts

@@ -295,7 +295,6 @@ export const genMaciStateFromContract = async (
 
       case action.type === "DeployPoll" && action.data.pollId?.toString() === pollId.toString(): {
         maciState.deployPoll(
-          duration,
           BigInt(deployTime + duration),
           maxValues,
           treeDepths,
@@ -338,8 +337,7 @@ export const genMaciStateFromContract = async (
 
   const poll = maciState.polls[pollId];
   assert(Number(numSignUpsAndMessages[1]) === poll.messages.length);
-
-  poll.numSignUps = Number(numSignUpsAndMessages[0]);
+  assert(Number(numSignUpsAndMessages[0]) === maciState.numSignUps);
 
   // we need to ensure that the stateRoot is correct
   assert(maciState.stateTree.root.toString() === (await maciContract.getStateAqRoot()).toString());

core/ts/MaciState.ts

@@ -9,15 +9,19 @@ import { IJsonMaciState, IJsonPoll, IMaciState, MaxValues, TreeDepths } from "./
  * A representation of the MACI contract.
  */
 export class MaciState implements IMaciState {
+  // a MaciState can hold multiple polls
   public polls: Poll[] = [];
 
+  // in this quinary tree we hold all signups (hash of a state leaf)
   public stateTree: IncrementalQuinTree;
+  // the leaves of the state tree
   public stateLeaves: StateLeaf[] = [];
+  // how deep the state tree is
+  public stateTreeDepth: number;
 
   public numSignUps = 0;
 
-  public stateTreeDepth: number;
-
+  // to keep track if a poll is currently being processed
   public pollBeingProcessed: boolean;
   public currentPollBeingProcessed: number;
 
@@ -29,6 +33,7 @@ export class MaciState implements IMaciState {
     this.stateTreeDepth = stateTreeDepth;
     this.stateTree = new IncrementalQuinTree(this.stateTreeDepth, blankStateLeafHash, STATE_TREE_ARITY, hash5);
 
+    // we put a blank state leaf to prevent a DoS attack
     this.stateLeaves.push(blankStateLeaf);
     this.stateTree.insert(blankStateLeafHash);
   }
@@ -51,7 +56,6 @@ export class MaciState implements IMaciState {
 
   /**
    * Deploy a new poll with the given parameters.
-   * @param duration - The duration of the poll in seconds.
    * @param pollEndTimestamp - The Unix timestamp at which the poll ends.
    * @param maxValues - The maximum number of values for each vote option.
    * @param treeDepths - The depths of the tree.
@@ -60,16 +64,13 @@ export class MaciState implements IMaciState {
    * @returns The index of the newly deployed poll.
    */
   public deployPoll(
-    duration: number,
     pollEndTimestamp: bigint,
     maxValues: MaxValues,
     treeDepths: TreeDepths,
     messageBatchSize: number,
     coordinatorKeypair: Keypair,
   ): number {
-    // TODO: fix the order of the arguments
     const poll: Poll = new Poll(
-      duration,
       pollEndTimestamp,
       coordinatorKeypair,
       treeDepths,
@@ -80,7 +81,6 @@ export class MaciState implements IMaciState {
       },
       maxValues,
       this,
-      this.stateTreeDepth,
     );
 
     this.polls.push(poll);