@maci-protocol/circuits 0.0.0-ci.4c6d4e8 → 0.0.0-ci.52ce07e

package/circom/voter/PollJoined.circom

@@ -0,0 +1,43 @@
+pragma circom 2.0.0;
+
+// local imports
+include "../utils/PoseidonHasher.circom";
+include "../utils/PrivateToPublicKey.circom";
+include "../utils/trees/BinaryMerkleRoot.circom";
+
+// 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 privateKey;
+    // 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 derivedPublicKey[2] = PrivateToPublicKey()(privateKey);
+
+    var stateLeaf = PoseidonHasher(3)([derivedPublicKey[0], derivedPublicKey[1], voiceCreditsBalance]);
+
+    // Inclusion proof  
+    var calculatedRoot = BinaryMerkleRoot(stateTreeDepth)(
+        stateLeaf,
+        actualStateTreeDepth,
+        pathIndices,
+        pathElements
+    );
+
+    calculatedRoot === stateRoot;
+}

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.4c6d4e8",
+  "version": "0.0.0-ci.52ce07e",
   "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.4c6d4e8",
-    "@maci-protocol/crypto": "0.0.0-ci.4c6d4e8",
-    "@maci-protocol/domainobjs": "0.0.0-ci.4c6d4e8",
-    "@maci-protocol/sdk": "0.0.0-ci.4c6d4e8",
+    "@maci-protocol/core": "0.0.0-ci.52ce07e",
+    "@maci-protocol/crypto": "0.0.0-ci.52ce07e",
+    "@maci-protocol/domainobjs": "0.0.0-ci.52ce07e",
+    "@maci-protocol/sdk": "0.0.0-ci.52ce07e",
     "@zk-kit/circuits": "^0.4.0",
     "circomkit": "^0.3.2",
     "circomlib": "^2.0.5"
@@ -55,17 +58,17 @@
     "@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.17",
     "@types/snarkjs": "^0.7.9",
     "@zk-kit/baby-jubjub": "^1.0.3",
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.2",
     "fast-check": "^4.1.1",
-    "glob": "^11.0.1",
-    "mocha": "^11.1.0",
+    "glob": "^11.0.2",
+    "mocha": "^11.2.2",
     "ts-mocha": "^11.1.0",
     "ts-node": "^10.9.1",
     "typescript": "^5.8.3"
   },
-  "gitHead": "314f41986d667b5968be17c3884459dddc7fd547"
+  "gitHead": "7bc383d813b0574ea9f0898cd32babac830cdc2b"
 }

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/utils/trees/incrementalQuinaryTree.circom

@@ -1,287 +0,0 @@
-pragma circom 2.0.0;
-
-// circomlib imports
-include "./bitify.circom";
-include "./mux1.circom";
-// zk-kit import
-include "./safe-comparators.circom";
-// local imports
-include "../calculateTotal.circom";
-include "../hashers.circom";
-
-// Incremental Quintary Merkle Tree (IQT) verification circuits.
-// Since each node contains 5 leaves, we are using PoseidonT6 for hashing them.
-// 
-// nb. circom has some particularities which limit the code patterns we can use:
-//  - You can only assign a value to a signal once.
-//  - A component's input signal must only be wired to another component's output signal.
-//  - Variables can store linear combinations, and can also be used for loops,
-//    declaring sizes of things, and anything that is not related to inputs of a circuit.
-//  - The compiler fails whenever you try to mix invalid elements.
-//  - You can't use a signal as a list index.
-
-/**
- * Selects an item from a list based on the given index.
- * It verifies the index is within the valid range and then iterates over the inputs to find the match.
- * For each item, it checks if its position equals the given index and if so, multiplies the item 
- * by the result of the equality check, effectively selecting it.
- * The sum of these results yields the selected item, ensuring only the item at the specified index be the output.
- *
- * nb. The number of items must be less than 8, and the index must be less than the number of items.
- */
-template QuinSelector(choices) {
-    signal input in[choices];
-    signal input index;
-    signal output out;
-    
-    // Ensure that index < choices.
-    var computedLtIndex = SafeLessThan(3)([index, choices]);
-    computedLtIndex === 1;
-
-    // Initialize an array to hold the results of equality checks.
-    var computedResults[choices];
-
-    // For each item, check whether its index equals the input index.
-    // The result is multiplied by the corresponding input value.
-    for (var i = 0; i < choices; i++) {
-        var computedIsIndexEqual = IsEqual()([i, index]);
-
-        computedResults[i] = computedIsIndexEqual * in[i];
-    }
-
-    // Calculate the total sum of the results array.
-    out <== CalculateTotal(choices)(computedResults);
-}
-
-/**
- * The output array contains the input items, with the leaf inserted at the
- * specified index. For example, if input = [0, 20, 30, 40], index = 3, and
- * leaf = 10, the output will be [0, 20, 30, 10, 40].
- */
-template Splicer(numItems) {
-    // The number of output items (because only one item is inserted).
-    var NUM_OUTPUT_ITEMS = numItems + 1;
-
-    signal input in[numItems];
-    signal input leaf;
-    signal input index;
-    signal output out[NUM_OUTPUT_ITEMS];
-    
-    // There is a loop where the goal is to assign values to the output signal.
-    // 
-    //  | output[0] | output[1] | output[2] | ...
-    // 
-    // We can either assign the leaf, or an item from the `items` signal, to the output, using Mux1().
-    // The Mux1's selector is 0 or 1 depending on whether the index is equal to the loop counter.
-    // 
-    //  i --> [IsEqual] <-- index
-    //             |
-    //             v
-    //  leaf --> [Mux1] <-- <item from in>
-    //             |
-    //             v
-    //          output[m]
-    // 
-    // To obtain the value from <item from in>, we need to compute an item
-    // index (let it be `s`).
-    // 1. if index = 2 and i = 0, then s = 0
-    // 2. if index = 2 and i = 1, then s = 1
-    // 3. if index = 2 and i = 2, then s = 2
-    // 4. if index = 2 and i = 3, then s = 2
-    // 5. if index = 2 and i = 4, then s = 3
-    // We then wire `s`, as well as each item in `in` to a QuinSelector.
-    // The output signal from the QuinSelector is <item from in> and gets
-    // wired to Mux1 (as above).
-
-    var inputs[NUM_OUTPUT_ITEMS];
-
-    for (var i = 0; i < numItems; i++) {
-        inputs[i] = in[i];
-    }
-    inputs[NUM_OUTPUT_ITEMS - 1] = 0;
-
-    for (var i = 0; i < NUM_OUTPUT_ITEMS; i++) {
-        // Determines if current index is greater than the insertion index.
-        var computedIsIndexAfterInsertPoint = SafeGreaterThan(3)([i, index]);
-
-        // Calculates correct index for original items, adjusting for leaf insertion.
-        var computedAdjustedIndex = i - computedIsIndexAfterInsertPoint;
-
-        // Selects item from the original array or the leaf for insertion.
-        var computedQuinSelected = QuinSelector(NUM_OUTPUT_ITEMS)(inputs, computedAdjustedIndex);
-        var computedIsIndexEqual = IsEqual()([index, i]);
-        var mux = Mux1()([computedQuinSelected, leaf], computedIsIndexEqual);
-
-        out[i] <== mux;
-    }
-}
-
-/**
- * Computes the root of an IQT given a leaf, its path, and sibling nodes at each level of the tree. 
- * It iteratively incorporates the leaf or the hash from the previous level with sibling nodes using 
- * the Splicer to place the leaf or hash at the correct position based on path_index. 
- * Then, it hashes these values together with PoseidonHasher to move up the tree. 
- * This process repeats for each level (levels) of the tree, culminating in the computation of the tree's root.
- */
-template QuinTreeInclusionProof(levels) {
-    var LEAVES_PER_NODE = 5;
-    var LEAVES_PER_PATH_LEVEL = LEAVES_PER_NODE - 1;
-
-    signal input leaf;
-    signal input path_index[levels];
-    signal input path_elements[levels][LEAVES_PER_PATH_LEVEL];
-    signal output root;
-
-    var currentLeaf = leaf;
-
-    // Iteratively hash each level of path_elements with the leaf or previous hash
-    for (var i = 0; i < levels; i++) {
-        var elements[LEAVES_PER_PATH_LEVEL];
-
-        for (var j = 0; j < LEAVES_PER_PATH_LEVEL; j++) {
-            elements[j] = path_elements[i][j];
-        }
-
-        var computedSplicedLeaf[LEAVES_PER_NODE] = Splicer(LEAVES_PER_PATH_LEVEL)(
-            elements, 
-            currentLeaf, 
-            path_index[i]
-        );
-
-        currentLeaf = PoseidonHasher(5)([
-            computedSplicedLeaf[0],
-            computedSplicedLeaf[1],
-            computedSplicedLeaf[2],
-            computedSplicedLeaf[3],
-            computedSplicedLeaf[4]
-        ]);
-    }
-
-    root <== currentLeaf;
-}
-
-/**
- * Verifies if a given leaf exists within an IQT.
- * Takes a leaf, its path to the root (specified by indices and path elements),
- * and the root itself, to verify the leaf's inclusion within the tree.
- */
-template QuinLeafExists(levels){
-    var LEAVES_PER_NODE = 5;
-    var LEAVES_PER_PATH_LEVEL = LEAVES_PER_NODE - 1;
-
-    signal input leaf;
-    signal input path_index[levels];
-    signal input path_elements[levels][LEAVES_PER_PATH_LEVEL];
-    signal input root;
-
-    // Verify the Merkle path.
-    var computedRoot = QuinTreeInclusionProof(levels)(leaf, path_index, path_elements);
-
-    root === computedRoot;
-}
-
-/**
- * Checks if a list of leaves exists within an IQT, leveraging the PoseidonT6
- * circuit for hashing. This can be used to verify the presence of multiple leaves.
- */
-template QuinBatchLeavesExists(levels, batchLevels) {
-    var LEAVES_PER_NODE = 5;
-    var LEAVES_PER_PATH_LEVEL = LEAVES_PER_NODE - 1;
-    var LEAVES_PER_BATCH = LEAVES_PER_NODE ** batchLevels;
-
-    signal input root;
-    signal input leaves[LEAVES_PER_BATCH];
-    signal input path_index[levels - batchLevels];
-    signal input path_elements[levels - batchLevels][LEAVES_PER_PATH_LEVEL];
-
-    // Compute the subroot (= leaf).
-    var computedQuinSubroot = QuinCheckRoot(batchLevels)(leaves);
-
-    // Check if the Merkle path is valid
-    QuinLeafExists(levels - batchLevels)(computedQuinSubroot, path_index, path_elements, root);
-}
-
-/**
- * Calculates the path indices required for Merkle proof verifications (e.g., QuinTreeInclusionProof, QuinLeafExists). 
- * Given a node index within an IQT and the total tree levels, it outputs the path indices leading to that node.
- * The template handles the modulo and division operations to break down the tree index into its constituent path indices.
- * e.g., if the index is 30 and the number of levels is 4, the output should be [0, 1, 1, 0].
- */
-template QuinGeneratePathIndices(levels) {
-    var BASE = 5;
-
-    signal input in; 
-    signal output out[levels];
-
-    var m = in;
-    var computedResults[levels];
-
-    for (var i = 0; i < levels; i++) {
-        // circom's best practices suggests to avoid using <-- unless you
-        // are aware of what's going on. This is the only way to do modulo operation.
-        out[i] <-- m % BASE;
-        m = m \ BASE;
-
-        // Check that each output element is less than the base.
-        var computedIsOutputElementLessThanBase = SafeLessThan(3)([out[i], BASE]);
-        computedIsOutputElementLessThanBase === 1;
-
-        // Re-compute the total sum.
-        computedResults[i] = out[i] * (BASE ** i);
-    }
-    
-    // Check that the total sum matches the index.
-    var computedCalculateTotal = CalculateTotal(levels)(computedResults);
-
-    computedCalculateTotal === in;
-}
-
-/**
- * Computes the root of a quintary Merkle tree given a list of leaves.
- * This template constructs a Merkle tree with each node having 5 children (quintary)
- * and computes the root by hashing with Poseidon the leaves and intermediate nodes in the given order.
- * The computation is performed by first hashing groups of 5 leaves to form the bottom layer of nodes,
- * then recursively hashing groups of these nodes to form the next layer, and so on, until the root is computed.
- */
-template QuinCheckRoot(levels) {
-    var LEAVES_PER_NODE = 5;
-    var totalLeaves = LEAVES_PER_NODE ** levels;
-    var numLeafHashers = LEAVES_PER_NODE ** (levels - 1); 
-
-    signal input leaves[totalLeaves];
-    signal output root;
-
-    // Determine the total number of hashers.
-    var numHashers = 0;
-    for (var i = 0; i < levels; i++) {
-        numHashers += LEAVES_PER_NODE ** i;
-    }
-
-    var computedHashers[numHashers]; 
-
-    // Initialize hashers for the leaves.
-    for (var i = 0; i < numLeafHashers; i++) {
-        computedHashers[i] = PoseidonHasher(5)([
-            leaves[i * LEAVES_PER_NODE + 0],
-            leaves[i * LEAVES_PER_NODE + 1],
-            leaves[i * LEAVES_PER_NODE + 2],
-            leaves[i * LEAVES_PER_NODE + 3],
-            leaves[i * LEAVES_PER_NODE + 4]
-        ]);
-    }
-
-    // Initialize hashers for intermediate nodes and compute the root.
-    var k = 0;
-    for (var i = numLeafHashers; i < numHashers; i++) {
-        computedHashers[i] = PoseidonHasher(5)([
-            computedHashers[k * LEAVES_PER_NODE + 0],
-            computedHashers[k * LEAVES_PER_NODE + 1],
-            computedHashers[k * LEAVES_PER_NODE + 2],
-            computedHashers[k * LEAVES_PER_NODE + 3],
-            computedHashers[k * LEAVES_PER_NODE + 4]
-        ]);
-        k++;
-    }
-
-    root <== computedHashers[numHashers - 1]; 
-}