@maci-protocol/circuits 0.0.0-ci.a577366 → 0.0.0-ci.a584b1a

package/circom/voter/PollJoining.circom

@@ -0,0 +1,54 @@
+pragma circom 2.0.0;
+
+// local imports
+include "../utils/PoseidonHasher.circom";
+include "../utils/PrivateToPublicKey.circom";
+include "../utils/trees/BinaryMerkleRoot.circom";
+
+// Poll Joining Circuit
+// Allows a user to prove knowledge of a private key that is signed up to 
+// a MACI contract.
+template PollJoining(stateTreeDepth) {
+    // Constants defining the tree structure
+    var STATE_TREE_ARITY = 2;
+
+    // User's private key
+    signal input privateKey;
+    // Poll's public key
+    signal input pollPublicKey[2];
+    // Siblings
+    signal input siblings[stateTreeDepth][STATE_TREE_ARITY - 1];
+    // Indices
+    signal input indices[stateTreeDepth];
+    // User's hashed private key
+    signal input nullifier;
+    // MACI State tree root which proves the user is signed up
+    signal input stateRoot;
+    // The actual tree depth (might be <= stateTreeDepth) used in BinaryMerkleRoot
+    signal input actualStateTreeDepth;
+    // The poll id
+    signal input pollId;
+
+    // Compute the nullifier (hash of private key and poll id)
+    var computedNullifier = PoseidonHasher(2)([privateKey, pollId]);
+    nullifier === computedNullifier;
+
+    // User private to public key
+    var derivedPublicKey[2] = PrivateToPublicKey()(privateKey);
+    // Hash the public key
+    var publicKeyHash = PoseidonHasher(2)([derivedPublicKey[0], derivedPublicKey[1]]);
+
+    // Ensure the poll public key is the same as the maci one (public input)
+    derivedPublicKey[0] === pollPublicKey[0];
+    derivedPublicKey[1] === pollPublicKey[1];
+
+    // Inclusion proof  
+    var calculatedRoot = BinaryMerkleRoot(stateTreeDepth)(
+        publicKeyHash,
+        actualStateTreeDepth,
+        indices,
+        siblings
+    );
+
+    calculatedRoot === stateRoot;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maci-protocol/circuits",
-  "version": "0.0.0-ci.a577366",
+  "version": "0.0.0-ci.a584b1a",
   "private": false,
   "description": "zk-SNARK circuits for MACI",
   "main": "build/ts/index.js",
@@ -18,7 +18,7 @@
   "scripts": {
     "build-test-circuits-c": "ts-node ./ts/compile.ts --cWitness",
     "build-test-circuits-wasm": "ts-node ./ts/compile.ts",
-    "gen-zkeys": "ts-node ./ts/genZkeys.ts",
+    "generate-zkeys": "ts-node ./ts/generateZkeys.ts",
     "info": "NODE_OPTIONS=--max-old-space-size=4096 ts-node ./ts/info.ts",
     "watch": "tsc --watch",
     "build": "tsc -p tsconfig.build.json",
@@ -28,12 +28,15 @@
     "mocha-test": "NODE_OPTIONS=--max-old-space-size=4096 ts-mocha --exit -g '^(?!.*\\[fuzz\\]).*$'",
     "test": "pnpm run mocha-test ts/__tests__/*.test.ts",
     "test:fuzz": "NODE_OPTIONS=--max-old-space-size=4096 ts-mocha --exit -g '\\[fuzz\\]' ./ts/__tests__/*.test.ts",
-    "test:hasher": "pnpm run mocha-test ts/__tests__/Hasher.test.ts",
+    "test:poseidonHasher": "pnpm run mocha-test ts/__tests__/PoseidonHasher.test.ts",
+    "test:messageHasher": "pnpm run mocha-test ts/__tests__/MessageHasher.test.ts",
     "test:slAndBallotTransformer": "pnpm run mocha-test ts/__tests__/StateLeafAndBallotTransformer.test.ts",
+    "test:slAndBallotTransformerFull": "pnpm run mocha-test ts/__tests__/StateLeafAndBallotTransformerFull.test.ts",
     "test:messageToCommand": "pnpm run mocha-test ts/__tests__/MessageToCommand.test.ts",
     "test:messageValidator": "pnpm run mocha-test ts/__tests__/MessageValidator.test.ts",
+    "test:messageValidatorFull": "pnpm run mocha-test ts/__tests__/MessageValidatorFull.test.ts",
     "test:verifySignature": "pnpm run mocha-test ts/__tests__/VerifySignature.test.ts",
-    "test:privToPubKey": "pnpm run mocha-test ts/__tests__/PrivToPubKey.test.ts",
+    "test:privateToPublicKey": "pnpm run mocha-test ts/__tests__/PrivateToPublicKey.test.ts",
     "test:calculateTotal": "pnpm run mocha-test ts/__tests__/CalculateTotal.test.ts",
     "test:processMessages": "pnpm run mocha-test ts/__tests__/ProcessMessages.test.ts",
     "test:tallyVotes": "pnpm run mocha-test ts/__tests__/TallyVotes.test.ts",
@@ -43,10 +46,10 @@
     "test:pollJoined": "pnpm run mocha-test ts/__tests__/PollJoined.test.ts"
   },
   "dependencies": {
-    "@maci-protocol/core": "0.0.0-ci.a577366",
-    "@maci-protocol/crypto": "0.0.0-ci.a577366",
-    "@maci-protocol/domainobjs": "0.0.0-ci.a577366",
-    "@maci-protocol/sdk": "0.0.0-ci.a577366",
+    "@maci-protocol/core": "0.0.0-ci.a584b1a",
+    "@maci-protocol/crypto": "0.0.0-ci.a584b1a",
+    "@maci-protocol/domainobjs": "0.0.0-ci.a584b1a",
+    "@maci-protocol/sdk": "0.0.0-ci.a584b1a",
     "@zk-kit/circuits": "^0.4.0",
     "circomkit": "^0.3.2",
     "circomlib": "^2.0.5"
@@ -55,7 +58,7 @@
     "@types/chai": "^4.3.11",
     "@types/chai-as-promised": "^7.1.8",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^22.14.0",
+    "@types/node": "^22.15.8",
     "@types/snarkjs": "^0.7.9",
     "@zk-kit/baby-jubjub": "^1.0.3",
     "chai": "^4.3.10",
@@ -67,5 +70,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.8.3"
   },
-  "gitHead": "1cfa661921cd66314655e5ee707159dba59b5838"
+  "gitHead": "8fb445ad44f36ec1dbb62d097ac601f39d198d26"
 }

package/build/ts/genZkeys.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"genZkeys.d.ts","sourceRoot":"","sources":["../../ts/genZkeys.ts"],"names":[],"mappings":"AAQA;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GAAU,aAAa,MAAM,KAAG,OAAO,CAAC,IAAI,CA2CrE,CAAC"}

package/build/ts/genZkeys.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"genZkeys.js","sourceRoot":"","sources":["../../ts/genZkeys.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAkD;AAClD,yCAAgF;AAEhF,4CAAoB;AACpB,gDAAwB;AAIxB;;;;;;GAMG;AACI,MAAM,aAAa,GAAG,KAAK,EAAE,UAAmB,EAAiB,EAAE;IACxE,8BAA8B;IAC9B,MAAM,cAAc,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC;IACvE,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAoB,CAAC;IAC3G,MAAM,kBAAkB,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;IACpF,MAAM,qBAAqB,GAAG,IAAI,CAAC,KAAK,CACtC,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC,CACZ,CAAC;IAC9C,MAAM,eAAe,GAA4B,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;QAC9G,IAAI;QACJ,GAAG,MAAM;KACV,CAAC,CAAC,CAAC;IAEJ,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAClE,8BAA8B;IAC9B,IAAI,OAAO,EAAE,CAAC;QACZ,eAAe,CAAC,QAAQ,GAAG,OAAO,CAAC;QACnC,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;IACpC,CAAC;IAED,MAAM,iBAAiB,GAAG,IAAI,qBAAS,CAAC;QACtC,GAAG,eAAe;QAClB,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IAEH,oDAAoD;IACpD,4DAA4D;IAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACnD,MAAM,OAAO,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;QAEnC,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,uBAAuB,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC;QAEtD,4CAA4C;QAC5C,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,iBAAiB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtE,kBAAkB;QAClB,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,SAAS,CAAC,CAAC;QAChG,4CAA4C;QAC5C,MAAM,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED,sCAAsC;IACtC,MAAM,IAAA,kBAAY,GAAE,CAAC;AACvB,CAAC,CAAC;AA3CW,QAAA,aAAa,iBA2CxB;AAEF,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;IAC5B,CAAC,KAAK,IAAI,EAAE;QACV,MAAM,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC1D,IAAI,eAAe,KAAK,CAAC,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAA,qBAAa,GAAE,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;YACzE,MAAM,IAAA,qBAAa,EAAC,YAAY,CAAC,CAAC;QACpC,CAAC;IACH,CAAC,CAAC,EAAE,CAAC;AACP,CAAC"}

package/circom/utils/hashers.circom

@@ -1,78 +0,0 @@
-pragma circom 2.0.0;
-
-// zk-kit imports
-include "./poseidon-cipher.circom";
-
-/**
- * Computes the Poseidon hash for an array of n inputs, including a default initial state 
- * of zero not counted in n. First, extends the inputs by prepending a zero, creating an array [0, inputs]. 
- * Then, the Poseidon hash of the extended inputs is calculated, with the first element of the 
- * result assigned as the output. 
- */
-template PoseidonHasher(n) {
-    signal input inputs[n];
-    signal output out;
-
-    // [0, inputs].
-    var computedExtendedInputs[n + 1];
-    computedExtendedInputs[0] = 0;
-
-    for (var i = 0; i < n; i++) {
-        computedExtendedInputs[i + 1] = inputs[i];
-    }
-
-    // Compute the Poseidon hash of the extended inputs.
-    var computedPoseidonPerm[n + 1]; 
-    computedPoseidonPerm = PoseidonPerm(n + 1)(computedExtendedInputs);
-
-    out <== computedPoseidonPerm[0];
-}
-
-/**
- * Hashes a MACI message and the public key used for message encryption. 
- * This template processes 10 message inputs and a 2-element public key
- * combining them using the Poseidon hash function. The hashing process involves two stages: 
- * 1. hashing message parts in groups of five and,
- * 2. hashing the grouped results alongside the first message input and 
- * the encryption public key to produce a final hash output. 
- */
-template MessageHasher() {
-    // The MACI message is composed of 10 parts.
-    signal input in[10];
-    // the public key used to encrypt the message.
-    signal input encPubKey[2];
-    // we output an hash.
-    signal output hash;
-
-    // Hasher4(
-    //     Hasher5_1(in[1], in[2], in[3], in[4], in[5]),
-    //     Hasher5_2(in[6], in[7], in[8], in[9], in[10])
-    //     in[11],
-    //     in[12]
-    // )
-
-    var computedHasher5_1;
-    computedHasher5_1 = PoseidonHasher(5)([
-        in[0],
-        in[1],
-        in[2],
-        in[3],
-        in[4]
-    ]);
-
-    var computedHasher5_2;
-    computedHasher5_2 = PoseidonHasher(5)([
-        in[5],        
-        in[6],
-        in[7],
-        in[8],
-        in[9]
-    ]);
-
-    hash <== PoseidonHasher(4)([
-        computedHasher5_1,
-        computedHasher5_2,
-        encPubKey[0],
-        encPubKey[1]        
-    ]);
-}

package/circom/utils/messageToCommand.circom

@@ -1,78 +0,0 @@
-pragma circom 2.0.0;
-
-// circomlib import
-include "./bitify.circom";
-// zk-kit imports
-include "./ecdh.circom";
-include "./unpack-element.circom";
-include "./poseidon-cipher.circom";
-// local imports
-include "./hashers.circom";
-
-/**
- * Converts a MACI message to a command by decrypting it.
- * Processes encrypted MACI messages into structured MACI commands 
- * by decrypting using a shared key derived from ECDH. After decryption, 
- * unpacks and assigns decrypted values to specific command components. 
- */
-template MessageToCommand() {
-    var MSG_LENGTH = 7;
-    var PACKED_CMD_LENGTH = 4;
-    var UNPACKED_CMD_LENGTH = 8;
-    var UNPACK_ELEM_LENGTH = 5;
-    var DECRYPTED_LENGTH = 9;
-    var MESSAGE_PARTS = 10;
-
-    // The message is an array of 10 parts.
-    signal input message[MESSAGE_PARTS];
-    signal input encPrivKey;
-    signal input encPubKey[2];
-
-    // Command parts.
-    signal output stateIndex;
-    signal output newPubKey[2];
-    signal output voteOptionIndex;
-    signal output newVoteWeight;
-    signal output nonce;
-    signal output pollId;
-    signal output salt;
-    signal output sigR8[2];
-    signal output sigS;
-    // Packed command. 
-    signal output packedCommandOut[PACKED_CMD_LENGTH];
-
-    // Generate the shared key for decrypting the message.
-    var computedEcdh[2] = Ecdh()(encPrivKey, encPubKey);
-
-    // Decrypt the message using Poseidon decryption.
-    var computedDecryptor[DECRYPTED_LENGTH] = PoseidonDecryptWithoutCheck(MSG_LENGTH)(
-        message,
-        0, 
-        computedEcdh
-    );
-
-    // Save the decrypted message into a packed command signal.
-    signal packedCommand[PACKED_CMD_LENGTH];
-    for (var i = 0; i < PACKED_CMD_LENGTH; i++) {
-        packedCommand[i] <== computedDecryptor[i];
-    }
-
-    var computedUnpackElement[UNPACK_ELEM_LENGTH] = UnpackElement(UNPACK_ELEM_LENGTH)(packedCommand[0]);
-
-    // Everything below were packed into the first element.
-    stateIndex <== computedUnpackElement[4];
-    voteOptionIndex <== computedUnpackElement[3];
-    newVoteWeight <== computedUnpackElement[2];
-    nonce <== computedUnpackElement[1];
-    pollId <== computedUnpackElement[0];
-
-    newPubKey[0] <== packedCommand[1];
-    newPubKey[1] <== packedCommand[2];
-    salt <== packedCommand[3];
-
-    sigR8[0] <== computedDecryptor[4];
-    sigR8[1] <== computedDecryptor[5];
-    sigS <== computedDecryptor[6];
-
-    packedCommandOut <== packedCommand;
-}

package/circom/voter/poll.circom

@@ -1,92 +0,0 @@
-pragma circom 2.0.0;
-
-// local imports
-include "../utils/hashers.circom";
-include "../utils/privToPubKey.circom";
-include "../utils/trees/BinaryMerkleRoot.circom";
-
-// Poll Joining Circuit
-// Allows a user to prove knowledge of a private key that is signed up to 
-// a MACI contract.
-template PollJoining(stateTreeDepth) {
-    // Constants defining the tree structure
-    var STATE_TREE_ARITY = 2;
-
-    // User's private key
-    signal input privKey;
-    // Poll's public key
-    signal input pollPubKey[2];
-    // Siblings
-    signal input siblings[stateTreeDepth][STATE_TREE_ARITY - 1];
-    // Indices
-    signal input indices[stateTreeDepth];
-    // User's hashed private key
-    signal input nullifier;
-    // MACI State tree root which proves the user is signed up
-    signal input stateRoot;
-    // The actual tree depth (might be <= stateTreeDepth) used in BinaryMerkleRoot
-    signal input actualStateTreeDepth;
-    // The poll id
-    signal input pollId;
-
-    // Compute the nullifier (hash of private key and poll id)
-    var computedNullifier = PoseidonHasher(2)([privKey, pollId]);
-    nullifier === computedNullifier;
-
-    // User private to public key
-    var derivedPubKey[2] = PrivToPubKey()(privKey);
-    // Hash the public key
-    var pubKeyHash = PoseidonHasher(2)([derivedPubKey[0], derivedPubKey[1]]);
-
-    // Ensure the poll public key is the same as the maci one (public input)
-    derivedPubKey[0] === pollPubKey[0];
-    derivedPubKey[1] === pollPubKey[1];
-
-    // Inclusion proof  
-    var calculatedRoot = BinaryMerkleRoot(stateTreeDepth)(
-        pubKeyHash,
-        actualStateTreeDepth,
-        indices,
-        siblings
-    );
-
-    calculatedRoot === stateRoot;
-}
-
-// Poll Joined Circuit
-// Allows a user to prove that they have joined a MACI poll.
-// This is to be used with the MACI offchain implementation to allow 
-// users to authenticate to the relayer service (to reduce spamming).
-template PollJoined(stateTreeDepth) {
-    // Constants defining the tree structure
-    var STATE_TREE_ARITY = 2;
-
-    // User's private key
-    signal input privKey;
-    // User's voice credits balance
-    signal input voiceCreditsBalance;
-    // Path elements
-    signal input pathElements[stateTreeDepth][STATE_TREE_ARITY - 1];
-    // Path indices
-    signal input pathIndices[stateTreeDepth];
-    // Poll State tree root which proves the user is joined
-    signal input stateRoot;
-    // The actual tree depth (might be <= stateTreeDepth) Used in BinaryMerkleRoot
-    signal input actualStateTreeDepth;
-
-     // User private to public key
-    var derivedPubKey[2] = PrivToPubKey()(privKey);
-
-    var stateLeaf = PoseidonHasher(3)([derivedPubKey[0], derivedPubKey[1], voiceCreditsBalance]);
-
-    // Inclusion proof  
-    var stateLeafQip = BinaryMerkleRoot(stateTreeDepth)(
-        stateLeaf,
-        actualStateTreeDepth,
-        pathIndices,
-        pathElements
-    );
-
-    stateLeafQip === stateRoot;
-}
-