@maci-protocol/circuits 0.0.0-ci.85bba2d → 0.0.0-ci.86ec64f

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maci-protocol/circuits",
-  "version": "0.0.0-ci.85bba2d",
+  "version": "0.0.0-ci.86ec64f",
   "private": false,
   "description": "zk-SNARK circuits for MACI",
   "main": "build/ts/index.js",
@@ -31,42 +31,44 @@
     "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: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",
+    "test:messageProcessor": "pnpm run mocha-test ts/__tests__/MessageProcessor.test.ts",
+    "test:voteTally": "pnpm run mocha-test ts/__tests__/VoteTally.test.ts",
     "test:ceremonyParams": "pnpm run mocha-test ts/__tests__/CeremonyParams.test.ts",
     "test:incrementalQuinaryTree": "pnpm run mocha-test ts/__tests__/IncrementalQuinaryTree.test.ts",
     "test:pollJoining": "pnpm run mocha-test ts/__tests__/PollJoining.test.ts",
     "test:pollJoined": "pnpm run mocha-test ts/__tests__/PollJoined.test.ts"
   },
   "dependencies": {
-    "@maci-protocol/core": "0.0.0-ci.85bba2d",
-    "@maci-protocol/crypto": "0.0.0-ci.85bba2d",
-    "@maci-protocol/domainobjs": "0.0.0-ci.85bba2d",
-    "@maci-protocol/sdk": "0.0.0-ci.85bba2d",
+    "@maci-protocol/core": "0.0.0-ci.86ec64f",
+    "@maci-protocol/crypto": "0.0.0-ci.86ec64f",
+    "@maci-protocol/domainobjs": "0.0.0-ci.86ec64f",
+    "@maci-protocol/sdk": "0.0.0-ci.86ec64f",
     "@zk-kit/circuits": "^0.4.0",
-    "circomkit": "^0.3.2",
+    "circomkit": "^0.3.4",
     "circomlib": "^2.0.5"
   },
   "devDependencies": {
     "@types/chai": "^4.3.11",
     "@types/chai-as-promised": "^7.1.8",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^22.14.1",
+    "@types/node": "^24.2.0",
     "@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",
+    "fast-check": "^4.2.0",
+    "glob": "^11.0.3",
+    "mocha": "^11.7.1",
     "ts-mocha": "^11.1.0",
     "ts-node": "^10.9.1",
     "typescript": "^5.8.3"
   },
-  "gitHead": "929b02ec5a5ec745a0e2b592b4d8e867bad7ac1a"
+  "gitHead": "c60edfc68d77f84d132590938967d6ed651a591a"
 }

package/circom/coordinator/qv/tallyVotes.circom

@@ -1,279 +0,0 @@
-pragma circom 2.0.0;
-
-// circomlib import
-include "./comparators.circom";
-// zk-kit import
-include "./unpack-element.circom";
-// local imports
-include "../../utils/trees/CheckRoot.circom";
-include "../../utils/trees/MerklePathIndicesGenerator.circom";
-include "../../utils/trees/LeafExists.circom";
-include "../../utils/trees/incrementalQuinaryTree.circom";
-include "../../utils/CalculateTotal.circom";
-include "../../utils/PoseidonHasher.circom";
-
-/**
- * Processes batches of votes and verifies their validity in a Merkle tree structure.
- * This template supports Quadratic Voting (QV).
- */
-template TallyVotes(
-    stateTreeDepth,
-    intStateTreeDepth,
-    voteOptionTreeDepth
-) {
-    // Ensure there's at least one level in the vote option tree.
-    assert(voteOptionTreeDepth > 0);
-    // Ensure the intermediate state tree has at least one level.
-    assert(intStateTreeDepth > 0);
-    // The intermediate state tree must be smaller than the full state tree.
-    assert(intStateTreeDepth < stateTreeDepth); 
-
-    // Number of children per node in the tree, defining the tree's branching factor.
-    var TREE_ARITY = 5;
-    var BALLOT_TREE_ARITY = 2;
-
-    // The number of ballots processed at once, determined by the depth of the intermediate state tree.
-    var batchSize = BALLOT_TREE_ARITY ** intStateTreeDepth;
-    // Number of voting options available, determined by the depth of the vote option tree.
-    var totalVoteOptions = TREE_ARITY ** voteOptionTreeDepth;
-
-    // Number of elements in each ballot.
-    var BALLOT_LENGTH = 2;
-    // Index for the nonce in the ballot array.
-    var BALLOT_NONCE_INDEX = 0;
-    // Index for the voting option root in the ballot array.
-    var BALLOT_VOTE_OPTION_ROOT_INDEX = 1;
-    // Difference in tree depths, used in path calculations.
-    var STATE_INT_TREE_DEPTH_DIFFERENCE = stateTreeDepth - intStateTreeDepth;
-
-    // Root of the state Merkle tree, representing the overall state before voting.
-    signal input stateRoot;
-    // Root of the ballot Merkle tree, representing the submitted ballots.
-    signal input ballotRoot;
-    // Salt used in commitment to secure the ballot data.
-    signal input sbSalt;
-    // Commitment to the state and ballots.
-    signal input sbCommitment;
-    // Commitment to the current tally before this batch.
-    signal input currentTallyCommitment;
-    // Commitment to the new tally after processing this batch.
-    signal input newTallyCommitment;
-    // Start index of given batch
-    signal input index;
-    // Number of users that signup
-    signal input totalSignups;
-    // Ballots and their corresponding path elements for verification in the tree.
-    signal input ballots[batchSize][BALLOT_LENGTH];
-    signal input ballotPathElements[STATE_INT_TREE_DEPTH_DIFFERENCE][BALLOT_TREE_ARITY - 1];
-    signal input votes[batchSize][totalVoteOptions];
-    // Current results for each vote option.
-    signal input currentResults[totalVoteOptions];
-    // Salt for the root of the current results.
-    signal input currentResultsRootSalt;
-    // Total voice credits spent so far.
-    signal input currentSpentVoiceCreditSubtotal;
-    // Salt for the total spent voice credits.
-    signal input currentSpentVoiceCreditSubtotalSalt;
-    // Spent voice credits per vote option.
-    signal input currentPerVOSpentVoiceCredits[totalVoteOptions];
-    // Salt for the root of spent credits per option.
-    signal input currentPerVOSpentVoiceCreditsRootSalt;
-    // Salt for the root of the new results.
-    signal input newResultsRootSalt;
-    // Salt for the new spent credits per vote option root.
-    signal input newPerVOSpentVoiceCreditsRootSalt;
-    // Salt for the new total spent voice credits root. 
-    signal input newSpentVoiceCreditSubtotalSalt;
-
-    // Verify sbCommitment.
-    var computedSbCommitment = PoseidonHasher(3)([stateRoot, ballotRoot, sbSalt]);
-    computedSbCommitment === sbCommitment;
-
-    // Validates that the index is within the valid range of sign-ups.
-    var totalSignupsValid = LessEqThan(50)([index, totalSignups]);
-    totalSignupsValid === 1;
-
-    // Hashes each ballot for subroot generation, and checks the existence of the leaf in the Merkle tree.    
-    var computedBallotHashers[batchSize];
-    
-    for (var i = 0; i < batchSize; i++) {
-        computedBallotHashers[i] = PoseidonHasher(2)([ballots[i][BALLOT_NONCE_INDEX], ballots[i][BALLOT_VOTE_OPTION_ROOT_INDEX]]);
-    }
-
-    var computedBallotSubroot = CheckRoot(intStateTreeDepth)(computedBallotHashers);
-    var computedBallotPathIndices[STATE_INT_TREE_DEPTH_DIFFERENCE] = MerklePathIndicesGenerator(STATE_INT_TREE_DEPTH_DIFFERENCE)(index / batchSize);
-
-    // Verifies each ballot's existence within the ballot tree.
-    LeafExists(STATE_INT_TREE_DEPTH_DIFFERENCE)(
-        computedBallotSubroot,
-        ballotPathElements,
-        computedBallotPathIndices,
-        ballotRoot
-    );
-
-    // Processes vote options, verifying each against its declared root.
-    var computedVoteTree[batchSize];
-    for (var i = 0; i < batchSize; i++) {
-        computedVoteTree[i] = QuinCheckRoot(voteOptionTreeDepth)(votes[i]);
-        computedVoteTree[i] === ballots[i][BALLOT_VOTE_OPTION_ROOT_INDEX];
-    }
-
-    // Calculates new results and spent voice credits based on the current and incoming votes.
-    var computedIsFirstBatch = IsZero()(index);
-    var computedIsZero = IsZero()(computedIsFirstBatch);
-
-    // Tally the new results.
-    var computedCalculateTotalResult[totalVoteOptions];
-    for (var i = 0; i < totalVoteOptions; i++) {
-        var numsRC[batchSize + 1];
-        numsRC[batchSize] = currentResults[i] * computedIsZero;
-        for (var j = 0; j < batchSize; j++) {
-            numsRC[j] = votes[j][i];
-        }
-
-        computedCalculateTotalResult[i] = CalculateTotal(batchSize + 1)(numsRC);
-    }
-
-    // Tally the new spent voice credit total.
-    var numsSVC[batchSize * totalVoteOptions + 1];
-    numsSVC[batchSize * totalVoteOptions] = currentSpentVoiceCreditSubtotal * computedIsZero;
-    for (var i = 0; i < batchSize; i++) {
-        for (var j = 0; j < totalVoteOptions; j++) {
-            numsSVC[i * totalVoteOptions + j] = votes[i][j] * votes[i][j];
-        }
-    }
-
-    var computedNewSpentVoiceCreditSubtotal = CalculateTotal(batchSize * totalVoteOptions + 1)(numsSVC);
-
-    // Tally the spent voice credits per vote option.
-    var computedNewPerVOSpentVoiceCredits[totalVoteOptions];
-
-    for (var i = 0; i < totalVoteOptions; i++) {
-        var computedNumsSVC[batchSize + 1];
-        computedNumsSVC[batchSize] = currentPerVOSpentVoiceCredits[i] * computedIsZero;
-        for (var j = 0; j < batchSize; j++) {
-            computedNumsSVC[j] = votes[j][i] * votes[j][i];
-        }
-
-        computedNewPerVOSpentVoiceCredits[i] = CalculateTotal(batchSize + 1)(computedNumsSVC);
-    }
-    
-    // Verifies the updated results and spent credits, ensuring consistency and correctness of tally updates.
-    ResultCommitmentVerifier(voteOptionTreeDepth)(
-        computedIsFirstBatch,
-        currentTallyCommitment,
-        newTallyCommitment,
-        currentResults,
-        currentResultsRootSalt,
-        computedCalculateTotalResult,
-        newResultsRootSalt,
-        currentSpentVoiceCreditSubtotal,
-        currentSpentVoiceCreditSubtotalSalt,
-        computedNewSpentVoiceCreditSubtotal,
-        newSpentVoiceCreditSubtotalSalt,
-        currentPerVOSpentVoiceCredits,
-        currentPerVOSpentVoiceCreditsRootSalt,
-        computedNewPerVOSpentVoiceCredits,
-        newPerVOSpentVoiceCreditsRootSalt        
-    );
-}
-
-/** 
- * Performs verifications and computations related to current voting results. 
- * Also, computes and outputs a commitment to the new results.
- * This template supports the Quadratic Voting (QV).
- */
-template ResultCommitmentVerifier(voteOptionTreeDepth) {
-    // Number of children per node in the tree, defining the tree's branching factor.
-    var TREE_ARITY = 5;
-    // Number of voting options available, determined by the depth of the vote option tree.
-    var totalVoteOptions = TREE_ARITY ** voteOptionTreeDepth;
-
-    // Equal to 1 if this is the first batch, otherwise 0.
-    signal input isFirstBatch;
-    // Commitment to the current tally before this batch.
-    signal input currentTallyCommitment;
-    // Commitment to the new tally after processing this batch.
-    signal input newTallyCommitment;
-
-    // Current results for each vote option.
-    signal input currentResults[totalVoteOptions];
-    // Salt for the root of the current results.
-    signal input currentResultsRootSalt;
-
-    // New results for each vote option.
-    signal input newResults[totalVoteOptions];
-    // Salt for the root of the new results.
-    signal input newResultsRootSalt;
-
-    // Total voice credits spent so far.
-    signal input currentSpentVoiceCreditSubtotal;
-    // Salt for the total spent voice credits.
-    signal input currentSpentVoiceCreditSubtotalSalt;
-
-    // Total new voice credits spent.
-    signal input newSpentVoiceCreditSubtotal;
-    // Salt for the new total spent voice credits.
-    signal input newSpentVoiceCreditSubtotalSalt;
-
-    // Spent voice credits per vote option.
-    signal input currentPerVOSpentVoiceCredits[totalVoteOptions];
-    // Salt for the root of spent credits per option.
-    signal input currentPerVOSpentVoiceCreditsRootSalt;
-
-    // New spent voice credits per vote option.
-    signal input newPerVOSpentVoiceCredits[totalVoteOptions];
-    // Salt for the root of new spent credits per option.
-    signal input newPerVOSpentVoiceCreditsRootSalt;
-
-    // Compute the commitment to the current results.
-    var computedCurrentResultsRoot = QuinCheckRoot(voteOptionTreeDepth)(currentResults);
-
-    // Verify currentResultsCommitmentHash.
-    var computedCurrentResultsCommitment = PoseidonHasher(2)([computedCurrentResultsRoot, currentResultsRootSalt]);
-
-    // Compute the commitment to the current spent voice credits.
-    var computedCurrentSpentVoiceCreditsCommitment = PoseidonHasher(2)([currentSpentVoiceCreditSubtotal, currentSpentVoiceCreditSubtotalSalt]);
-
-    // Compute the root of the spent voice credits per vote option.
-    var computedCurrentPerVOSpentVoiceCreditsRoot = QuinCheckRoot(voteOptionTreeDepth)(currentPerVOSpentVoiceCredits);
-    var computedCurrentPerVOSpentVoiceCreditsCommitment = PoseidonHasher(2)([computedCurrentPerVOSpentVoiceCreditsRoot, currentPerVOSpentVoiceCreditsRootSalt]);
-
-    // Commit to the current tally.
-    var computedCurrentTallyCommitment = PoseidonHasher(3)([
-        computedCurrentResultsCommitment, 
-        computedCurrentSpentVoiceCreditsCommitment, 
-        computedCurrentPerVOSpentVoiceCreditsCommitment
-    ]);
-
-    // Check if the current tally commitment is correct only if this is not the first batch.
-    // computedIsZero.out is 1 if this is not the first batch.
-    // computedIsZero.out is 0 if this is the first batch.
-    var computedIsZero = IsZero()(isFirstBatch);
-
-    // isFirstCommitment is 0 if this is the first batch, currentTallyCommitment should be 0 if this is the first batch.
-    // isFirstCommitment is 1 if this is not the first batch, currentTallyCommitment should not be 0 if this is the first batch.
-    signal isFirstCommitment;
-    isFirstCommitment <== computedIsZero * computedCurrentTallyCommitment;
-    isFirstCommitment === currentTallyCommitment;
-
-    // Compute the root of the new results.
-    var computedNewResultsRoot = QuinCheckRoot(voteOptionTreeDepth)(newResults);
-    var computedNewResultsCommitment = PoseidonHasher(2)([computedNewResultsRoot, newResultsRootSalt]);
-
-    // Compute the commitment to the new spent voice credits value.
-    var computedNewSpentVoiceCreditsCommitment = PoseidonHasher(2)([newSpentVoiceCreditSubtotal, newSpentVoiceCreditSubtotalSalt]);
-
-    // Compute the root of the spent voice credits per vote option.
-    var computedNewPerVOSpentVoiceCreditsRoot = QuinCheckRoot(voteOptionTreeDepth)(newPerVOSpentVoiceCredits);
-    var computedNewPerVOSpentVoiceCreditsCommitment = PoseidonHasher(2)([computedNewPerVOSpentVoiceCreditsRoot, newPerVOSpentVoiceCreditsRootSalt]);
-
-    // Commit to the new tally.
-    var computedNewTallyCommitment = PoseidonHasher(3)([
-        computedNewResultsCommitment,
-        computedNewSpentVoiceCreditsCommitment,
-        computedNewPerVOSpentVoiceCreditsCommitment
-    ]);
-    
-    computedNewTallyCommitment === newTallyCommitment;
-}

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 "../PoseidonHasher.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]; 
-}