@maci-protocol/circuits 0.0.0-ci.a1bedc5 → 0.0.0-ci.a51dc13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/LICENSE +1 -2
  2. package/build/ts/{genZkeys.d.ts → generateZkeys.d.ts} +1 -1
  3. package/build/ts/generateZkeys.d.ts.map +1 -0
  4. package/build/ts/{genZkeys.js → generateZkeys.js} +1 -1
  5. package/build/ts/generateZkeys.js.map +1 -0
  6. package/build/ts/types.d.ts +5 -5
  7. package/build/ts/types.d.ts.map +1 -1
  8. package/build/tsconfig.build.tsbuildinfo +1 -1
  9. package/circom/circuits.json +20 -4
  10. package/circom/coordinator/full/MessageProcessor.circom +253 -0
  11. package/circom/coordinator/full/SingleMessageProcessor.circom +204 -0
  12. package/circom/coordinator/non-qv/processMessages.circom +102 -104
  13. package/circom/coordinator/non-qv/tallyVotes.circom +47 -44
  14. package/circom/coordinator/qv/processMessages.circom +103 -102
  15. package/circom/coordinator/qv/tallyVotes.circom +61 -61
  16. package/circom/utils/CalculateTotal.circom +6 -6
  17. package/circom/utils/PrivateToPublicKey.circom +3 -3
  18. package/circom/utils/full/MessageValidator.circom +91 -0
  19. package/circom/utils/full/StateLeafAndBallotTransformer.circom +122 -0
  20. package/circom/utils/non-qv/{messageValidator.circom → MessageValidator.circom} +15 -13
  21. package/circom/utils/non-qv/{stateLeafAndBallotTransformer.circom → StateLeafAndBallotTransformer.circom} +34 -34
  22. package/circom/utils/qv/{messageValidator.circom → MessageValidator.circom} +15 -13
  23. package/circom/utils/qv/{stateLeafAndBallotTransformer.circom → StateLeafAndBallotTransformer.circom} +34 -34
  24. package/circom/utils/trees/LeafExists.circom +2 -2
  25. package/circom/utils/trees/{MerkleGeneratePathIndices.circom → MerklePathIndicesGenerator.circom} +1 -1
  26. package/circom/utils/trees/MerkleTreeInclusionProof.circom +4 -4
  27. package/circom/utils/trees/QuinaryCheckRoot.circom +54 -0
  28. package/circom/utils/trees/QuinaryGeneratePathIndices.circom +44 -0
  29. package/circom/utils/trees/QuinaryLeafExists.circom +30 -0
  30. package/circom/utils/trees/QuinarySelector.circom +42 -0
  31. package/circom/utils/trees/QuinaryTreeInclusionProof.circom +55 -0
  32. package/circom/utils/trees/Splicer.circom +76 -0
  33. package/circom/voter/PollJoined.circom +2 -2
  34. package/package.json +11 -9
  35. package/build/ts/genZkeys.d.ts.map +0 -1
  36. package/build/ts/genZkeys.js.map +0 -1
  37. package/circom/utils/trees/incrementalQuinaryTree.circom +0 -287
@@ -3,7 +3,7 @@ pragma circom 2.0.0;
3
3
  // circomlib import
4
4
  include "./mux1.circom";
5
5
  // local import
6
- include "./messageValidator.circom";
6
+ include "./MessageValidator.circom";
7
7
 
8
8
  /**
9
9
  * Processes a command by verifying its validity and updates the state leaf and ballot accordingly.
@@ -13,18 +13,18 @@ include "./messageValidator.circom";
13
13
  */
14
14
  template StateLeafAndBallotTransformerNonQv() {
15
15
  // Length of the packed command.
16
- var PACKED_CMD_LENGTH = 4;
16
+ var PACKED_COMMAND_LENGTH = 4;
17
17
 
18
18
  // Number of user sign-ups in the state tree.
19
- signal input numSignUps;
19
+ signal input totalSignups;
20
20
  // Number of valid vote options for the poll.
21
21
  signal input voteOptions;
22
22
 
23
23
  // The following signals represents a state leaf (signed up user).
24
24
  // Public key.
25
- signal input slPubKey[2];
25
+ signal input stateLeafPublicKey[2];
26
26
  // Current voice credit balance.
27
- signal input slVoiceCreditBalance;
27
+ signal input stateLeafVoiceCreditBalance;
28
28
 
29
29
  // The following signals represents a ballot.
30
30
  // Nonce.
@@ -34,29 +34,29 @@ template StateLeafAndBallotTransformerNonQv() {
34
34
 
35
35
  // The following signals represents a command.
36
36
  // State index of the user.
37
- signal input cmdStateIndex;
37
+ signal input commandStateIndex;
38
38
  // Public key of the user.
39
- signal input cmdNewPubKey[2];
39
+ signal input commandPublicKey[2];
40
40
  // Vote option index.
41
- signal input cmdVoteOptionIndex;
41
+ signal input commandVoteOptionIndex;
42
42
  // Vote weight.
43
- signal input cmdNewVoteWeight;
43
+ signal input commandNewVoteWeight;
44
44
  // Nonce.
45
- signal input cmdNonce;
45
+ signal input commandNonce;
46
46
  // Poll identifier.
47
- signal input cmdPollId;
47
+ signal input commandPollId;
48
48
  // Salt.
49
- signal input cmdSalt;
50
- // ECDSA signature of the command (R part).
51
- signal input cmdSigR8[2];
52
- // ECDSA signature of the command (S part).
53
- signal input cmdSigS;
49
+ signal input commandSalt;
50
+ // EdDSA signature of the command (R part).
51
+ signal input commandSignaturePoint[2];
52
+ // EdDSA signature of the command (S part).
53
+ signal input commandSignatureScalar;
54
54
  // Packed command.
55
55
  // nb. we are assuming that the packedCommand is always valid.
56
- signal input packedCommand[PACKED_CMD_LENGTH];
56
+ signal input packedCommand[PACKED_COMMAND_LENGTH];
57
57
 
58
58
  // New state leaf (if the command is valid).
59
- signal output newSlPubKey[2];
59
+ signal output newStateLeafPublicKey[2];
60
60
  // New ballot (if the command is valid).
61
61
  signal output newBallotNonce;
62
62
 
@@ -68,38 +68,38 @@ template StateLeafAndBallotTransformerNonQv() {
68
68
  signal output isVoteOptionIndexValid;
69
69
 
70
70
  // Check if the command / message is valid.
71
- var (computedMessageValidator, computedIsStateLeafIndexValid, computedIsVoteOptionIndexValid) = MessageValidatorNonQv()(
72
- cmdStateIndex,
73
- numSignUps,
74
- cmdVoteOptionIndex,
71
+ var (computedIsValid, computedIsStateLeafIndexValid, computedIsVoteOptionIndexValid) = MessageValidatorNonQv()(
72
+ commandStateIndex,
73
+ totalSignups,
74
+ commandVoteOptionIndex,
75
75
  voteOptions,
76
76
  ballotNonce,
77
- cmdNonce,
77
+ commandNonce,
78
78
  packedCommand,
79
- slPubKey,
80
- cmdSigR8,
81
- cmdSigS,
82
- slVoiceCreditBalance,
79
+ stateLeafPublicKey,
80
+ commandSignaturePoint,
81
+ commandSignatureScalar,
82
+ stateLeafVoiceCreditBalance,
83
83
  ballotCurrentVotesForOption,
84
- cmdNewVoteWeight
84
+ commandNewVoteWeight
85
85
  );
86
86
 
87
87
  // If the message is valid then we swap out the public key.
88
88
  // This means using a Mux1() for publicKey[0] and another one
89
89
  // for publicKey[1].
90
- var computedNewSlPubKey0Mux = Mux1()([slPubKey[0], cmdNewPubKey[0]], computedMessageValidator);
91
- var computedNewSlPubKey1Mux = Mux1()([slPubKey[1], cmdNewPubKey[1]], computedMessageValidator);
90
+ var computedNewstateLeafPublicKey0Mux = Mux1()([stateLeafPublicKey[0], commandPublicKey[0]], computedIsValid);
91
+ var computedNewstateLeafPublicKey1Mux = Mux1()([stateLeafPublicKey[1], commandPublicKey[1]], computedIsValid);
92
92
 
93
- newSlPubKey[0] <== computedNewSlPubKey0Mux;
94
- newSlPubKey[1] <== computedNewSlPubKey1Mux;
93
+ newStateLeafPublicKey[0] <== computedNewstateLeafPublicKey0Mux;
94
+ newStateLeafPublicKey[1] <== computedNewstateLeafPublicKey1Mux;
95
95
 
96
96
  // If the message is valid, then we swap out the ballot nonce
97
97
  // using a Mux1().
98
- var computedNewBallotNonceMux = Mux1()([ballotNonce, cmdNonce], computedMessageValidator);
98
+ var computedNewBallotNonceMux = Mux1()([ballotNonce, commandNonce], computedIsValid);
99
99
 
100
100
  newBallotNonce <== computedNewBallotNonceMux;
101
101
 
102
- isValid <== computedMessageValidator;
102
+ isValid <== computedIsValid;
103
103
  isStateLeafIndexValid <== computedIsStateLeafIndexValid;
104
104
  isVoteOptionIndexValid <== computedIsVoteOptionIndexValid;
105
105
  }
@@ -11,12 +11,14 @@ include "../VerifySignature.circom";
11
11
  */
12
12
  template MessageValidator() {
13
13
  // Length of the packed command.
14
- var PACKED_CMD_LENGTH = 4;
14
+ var PACKED_COMMAND_LENGTH = 4;
15
+ // Number of checks to be performed.
16
+ var TOTAL_CHECKS = 6;
15
17
 
16
18
  // State index of the user.
17
19
  signal input stateTreeIndex;
18
20
  // Number of user sign-ups in the state tree.
19
- signal input numSignUps;
21
+ signal input totalSignups;
20
22
  // Vote option index.
21
23
  signal input voteOptionIndex;
22
24
  // Number of valid vote options for the poll.
@@ -24,15 +26,15 @@ template MessageValidator() {
24
26
  // Ballot nonce.
25
27
  signal input originalNonce;
26
28
  // Command nonce.
27
- signal input nonce;
29
+ signal input commandNonce;
28
30
  // Packed command.
29
- signal input cmd[PACKED_CMD_LENGTH];
31
+ signal input command[PACKED_COMMAND_LENGTH];
30
32
  // Public key of the state leaf (user).
31
33
  signal input publicKey[2];
32
- // ECDSA signature of the command (R part).
33
- signal input sigR8[2];
34
- // ECDSA signature of the command (S part).
35
- signal input sigS;
34
+ // EdDSA signature of the command (R part).
35
+ signal input signaturePoint[2];
36
+ // EdDSA signature of the command (S part).
37
+ signal input signatureScalar;
36
38
  // State leaf current voice credit balance.
37
39
  signal input currentVoiceCreditBalance;
38
40
  // Current number of votes for specific option.
@@ -48,19 +50,19 @@ template MessageValidator() {
48
50
  signal output isVoteOptionIndexValid;
49
51
 
50
52
  // Check (1) - The state leaf index must be valid.
51
- // The check ensure that the stateTreeIndex < numSignUps as first validation.
53
+ // The check ensure that the stateTreeIndex < totalSignups as first validation.
52
54
  // Must be < because the stateTreeIndex is 0-based. Zero is for blank state leaf
53
55
  // while 1 is for the first actual user.
54
- var computedIsStateLeafIndexValid = SafeLessThan(252)([stateTreeIndex, numSignUps]);
56
+ var computedIsStateLeafIndexValid = SafeLessThan(252)([stateTreeIndex, totalSignups]);
55
57
 
56
58
  // Check (2) - The vote option index must be less than the number of valid vote options (0 indexed).
57
59
  var computedIsVoteOptionIndexValid = SafeLessThan(252)([voteOptionIndex, voteOptions]);
58
60
 
59
61
  // Check (3) - The nonce must be correct.
60
- var computedIsNonceValid = IsEqual()([originalNonce + 1, nonce]);
62
+ var computedIsNonceValid = IsEqual()([originalNonce + 1, commandNonce]);
61
63
 
62
64
  // Check (4) - The signature must be correct.
63
- var computedIsSignatureValid = VerifySignature()(publicKey, sigR8, sigS, cmd);
65
+ var computedIsSignatureValid = VerifySignature()(publicKey, signaturePoint, signatureScalar, command);
64
66
 
65
67
  // Check (5) - There must be sufficient voice credits.
66
68
  // The check ensure that the voteWeight is < sqrt(field size)
@@ -79,7 +81,7 @@ template MessageValidator() {
79
81
  // When all six checks are correct, then isValid = 1.
80
82
  var computedIsUpdateValid = IsEqual()(
81
83
  [
82
- 6,
84
+ TOTAL_CHECKS,
83
85
  computedIsSignatureValid +
84
86
  computedAreVoiceCreditsSufficient +
85
87
  computedIsVoteWeightValid +
@@ -3,7 +3,7 @@ pragma circom 2.0.0;
3
3
  // circomlib import
4
4
  include "./mux1.circom";
5
5
  // local import
6
- include "./messageValidator.circom";
6
+ include "./MessageValidator.circom";
7
7
 
8
8
  /**
9
9
  * Processes a command by verifying its validity and updates the state leaf and ballot accordingly.
@@ -13,18 +13,18 @@ include "./messageValidator.circom";
13
13
  */
14
14
  template StateLeafAndBallotTransformer() {
15
15
  // Length of the packed command.
16
- var PACKED_CMD_LENGTH = 4;
16
+ var PACKED_COMMAND_LENGTH = 4;
17
17
 
18
18
  // Number of user sign-ups in the state tree.
19
- signal input numSignUps;
19
+ signal input totalSignups;
20
20
  // Number of valid vote options for the poll.
21
21
  signal input voteOptions;
22
22
 
23
23
  // The following signals represents a state leaf (signed up user).
24
24
  // Public key.
25
- signal input slPubKey[2];
25
+ signal input stateLeafPublicKey[2];
26
26
  // Current voice credit balance.
27
- signal input slVoiceCreditBalance;
27
+ signal input stateLeafVoiceCreditBalance;
28
28
 
29
29
  // The following signals represents a ballot.
30
30
  // Nonce.
@@ -34,29 +34,29 @@ template StateLeafAndBallotTransformer() {
34
34
 
35
35
  // The following signals represents a command.
36
36
  // State index of the user.
37
- signal input cmdStateIndex;
37
+ signal input commandStateIndex;
38
38
  // Public key of the user.
39
- signal input cmdNewPubKey[2];
39
+ signal input commandPublicKey[2];
40
40
  // Vote option index.
41
- signal input cmdVoteOptionIndex;
41
+ signal input commandVoteOptionIndex;
42
42
  // Vote weight.
43
- signal input cmdNewVoteWeight;
43
+ signal input commandNewVoteWeight;
44
44
  // Nonce.
45
- signal input cmdNonce;
45
+ signal input commandNonce;
46
46
  // Poll identifier.
47
- signal input cmdPollId;
47
+ signal input commandPollId;
48
48
  // Salt.
49
- signal input cmdSalt;
50
- // ECDSA signature of the command (R part).
51
- signal input cmdSigR8[2];
52
- // ECDSA signature of the command (S part).
53
- signal input cmdSigS;
49
+ signal input commandSalt;
50
+ // EdDSA signature of the command (R part).
51
+ signal input commandSignaturePoint[2];
52
+ // EdDSA signature of the command (S part).
53
+ signal input commandSignatureScalar;
54
54
  // Packed command.
55
55
  // nb. we are assuming that the packedCommand is always valid.
56
- signal input packedCommand[PACKED_CMD_LENGTH];
56
+ signal input packedCommand[PACKED_COMMAND_LENGTH];
57
57
 
58
58
  // New state leaf (if the command is valid).
59
- signal output newSlPubKey[2];
59
+ signal output newStateLeafPublicKey[2];
60
60
  // New ballot (if the command is valid).
61
61
  signal output newBallotNonce;
62
62
 
@@ -68,38 +68,38 @@ template StateLeafAndBallotTransformer() {
68
68
  signal output isVoteOptionIndexValid;
69
69
 
70
70
  // Check if the command / message is valid.
71
- var (computedMessageValidator, computedIsStateLeafIndexValid, computedIsVoteOptionIndexValid) = MessageValidator()(
72
- cmdStateIndex,
73
- numSignUps,
74
- cmdVoteOptionIndex,
71
+ var (computedIsValid, computedIsStateLeafIndexValid, computedIsVoteOptionIndexValid) = MessageValidator()(
72
+ commandStateIndex,
73
+ totalSignups,
74
+ commandVoteOptionIndex,
75
75
  voteOptions,
76
76
  ballotNonce,
77
- cmdNonce,
77
+ commandNonce,
78
78
  packedCommand,
79
- slPubKey,
80
- cmdSigR8,
81
- cmdSigS,
82
- slVoiceCreditBalance,
79
+ stateLeafPublicKey,
80
+ commandSignaturePoint,
81
+ commandSignatureScalar,
82
+ stateLeafVoiceCreditBalance,
83
83
  ballotCurrentVotesForOption,
84
- cmdNewVoteWeight
84
+ commandNewVoteWeight
85
85
  );
86
86
 
87
87
  // If the message is valid then we swap out the public key.
88
88
  // This means using a Mux1() for publicKey[0] and another one
89
89
  // for publicKey[1].
90
- var computedNewSlPubKey0Mux = Mux1()([slPubKey[0], cmdNewPubKey[0]], computedMessageValidator);
91
- var computedNewSlPubKey1Mux = Mux1()([slPubKey[1], cmdNewPubKey[1]], computedMessageValidator);
90
+ var computedNewstateLeafPublicKey0Mux = Mux1()([stateLeafPublicKey[0], commandPublicKey[0]], computedIsValid);
91
+ var computedNewstateLeafPublicKey1Mux = Mux1()([stateLeafPublicKey[1], commandPublicKey[1]], computedIsValid);
92
92
 
93
- newSlPubKey[0] <== computedNewSlPubKey0Mux;
94
- newSlPubKey[1] <== computedNewSlPubKey1Mux;
93
+ newStateLeafPublicKey[0] <== computedNewstateLeafPublicKey0Mux;
94
+ newStateLeafPublicKey[1] <== computedNewstateLeafPublicKey1Mux;
95
95
 
96
96
  // If the message is valid, then we swap out the ballot nonce
97
97
  // using a Mux1().
98
- var computedNewBallotNonceMux = Mux1()([ballotNonce, cmdNonce], computedMessageValidator);
98
+ var computedNewBallotNonceMux = Mux1()([ballotNonce, commandNonce], computedIsValid);
99
99
 
100
100
  newBallotNonce <== computedNewBallotNonceMux;
101
101
 
102
- isValid <== computedMessageValidator;
102
+ isValid <== computedIsValid;
103
103
  isStateLeafIndexValid <== computedIsStateLeafIndexValid;
104
104
  isVoteOptionIndexValid <== computedIsVoteOptionIndexValid;
105
105
  }
@@ -13,13 +13,13 @@ template LeafExists(levels) {
13
13
  // The elements along the path needed for the inclusion proof.
14
14
  signal input path_elements[levels][1];
15
15
  // The indices indicating the path taken through the tree for the leaf.
16
- signal input path_index[levels];
16
+ signal input path_indices[levels];
17
17
  // The root of the Merkle tree, against which the inclusion is verified.
18
18
  signal input root;
19
19
 
20
20
  var computedMerkleRoot = MerkleTreeInclusionProof(levels)(
21
21
  leaf,
22
- path_index,
22
+ path_indices,
23
23
  path_elements
24
24
  );
25
25
 
@@ -10,7 +10,7 @@ include "../CalculateTotal.circom";
10
10
  * Given a node index within an IMT and the total tree levels, it outputs the path indices leading to that node.
11
11
  * The template handles the modulo and division operations to break down the tree index into its constituent path indices.
12
12
  */
13
- template MerkleGeneratePathIndices(levels) {
13
+ template MerklePathIndicesGenerator(levels) {
14
14
  // The base used for the modulo and division operations, set to 2 for binary trees.
15
15
  var BASE = 2;
16
16
 
@@ -12,7 +12,7 @@ template MerkleTreeInclusionProof(n_levels) {
12
12
  // The leaf node from which the Merkle root is calculated.
13
13
  signal input leaf;
14
14
  // Indices indicating left or right child for each level of the tree.
15
- signal input path_index[n_levels];
15
+ signal input path_indices[n_levels];
16
16
  // Sibling node values required to compute the hash at each level.
17
17
  signal input path_elements[n_levels][1];
18
18
 
@@ -25,8 +25,8 @@ template MerkleTreeInclusionProof(n_levels) {
25
25
  levelHashes[0] <== leaf;
26
26
 
27
27
  for (var i = 0; i < n_levels; i++) {
28
- // Validate path_index to be either 0 or 1, ensuring no other values.
29
- path_index[i] * (1 - path_index[i]) === 0;
28
+ // Validate path_indices to be either 0 or 1, ensuring no other values.
29
+ path_indices[i] * (1 - path_indices[i]) === 0;
30
30
 
31
31
  // Configure the multiplexer based on the path index for the current level.
32
32
  var multiplexer[2][2] = [
@@ -36,7 +36,7 @@ template MerkleTreeInclusionProof(n_levels) {
36
36
 
37
37
  var multiplexerResult[2] = MultiMux1(2)(
38
38
  multiplexer,
39
- path_index[i]
39
+ path_indices[i]
40
40
  );
41
41
 
42
42
  var computedLevelHash = PoseidonHasher(2)([multiplexerResult[0], multiplexerResult[1]]);
@@ -0,0 +1,54 @@
1
+ pragma circom 2.0.0;
2
+
3
+ // local imports
4
+ include "../PoseidonHasher.circom";
5
+
6
+ /**
7
+ * Computes the root of a quintary Merkle tree given a list of leaves.
8
+ * This template constructs a Merkle tree with each node having 5 children (quintary)
9
+ * and computes the root by hashing with Poseidon the leaves and intermediate nodes in the given order.
10
+ * The computation is performed by first hashing groups of 5 leaves to form the bottom layer of nodes,
11
+ * then recursively hashing groups of these nodes to form the next layer, and so on, until the root is computed.
12
+ */
13
+ template QuinaryCheckRoot(levels) {
14
+ var LEAVES_PER_NODE = 5;
15
+ var totalLeaves = LEAVES_PER_NODE ** levels;
16
+ var numLeafHashers = LEAVES_PER_NODE ** (levels - 1);
17
+
18
+ signal input leaves[totalLeaves];
19
+ signal output root;
20
+
21
+ // Determine the total number of hashers.
22
+ var numHashers = 0;
23
+ for (var i = 0; i < levels; i++) {
24
+ numHashers += LEAVES_PER_NODE ** i;
25
+ }
26
+
27
+ var computedHashers[numHashers];
28
+
29
+ // Initialize hashers for the leaves.
30
+ for (var i = 0; i < numLeafHashers; i++) {
31
+ computedHashers[i] = PoseidonHasher(5)([
32
+ leaves[i * LEAVES_PER_NODE + 0],
33
+ leaves[i * LEAVES_PER_NODE + 1],
34
+ leaves[i * LEAVES_PER_NODE + 2],
35
+ leaves[i * LEAVES_PER_NODE + 3],
36
+ leaves[i * LEAVES_PER_NODE + 4]
37
+ ]);
38
+ }
39
+
40
+ // Initialize hashers for intermediate nodes and compute the root.
41
+ var k = 0;
42
+ for (var i = numLeafHashers; i < numHashers; i++) {
43
+ computedHashers[i] = PoseidonHasher(5)([
44
+ computedHashers[k * LEAVES_PER_NODE + 0],
45
+ computedHashers[k * LEAVES_PER_NODE + 1],
46
+ computedHashers[k * LEAVES_PER_NODE + 2],
47
+ computedHashers[k * LEAVES_PER_NODE + 3],
48
+ computedHashers[k * LEAVES_PER_NODE + 4]
49
+ ]);
50
+ k++;
51
+ }
52
+
53
+ root <== computedHashers[numHashers - 1];
54
+ }
@@ -0,0 +1,44 @@
1
+ pragma circom 2.0.0;
2
+
3
+ // zk-kit import
4
+ include "./safe-comparators.circom";
5
+ // local imports
6
+ include "../CalculateTotal.circom";
7
+
8
+ /**
9
+ * Calculates the path indices required for Merkle proof verifications (e.g., QuinaryTreeInclusionProof, QuinaryLeafExists).
10
+ * Given a node index within an IQT and the total tree levels, it outputs the path indices leading to that node.
11
+ * The template handles the modulo and division operations to break down the tree index into its constituent path indices.
12
+ * e.g., if the index is 30 and the number of levels is 4, the output should be [0, 1, 1, 0].
13
+ */
14
+ template QuinaryGeneratePathIndices(levels) {
15
+ // The number of leaves per node (tree arity)
16
+ var LEAVES_PER_NODE = 5;
17
+
18
+ // The index within the tree
19
+ signal input index;
20
+ // The generated path indices leading to the node of the provided index
21
+ signal output out[levels];
22
+
23
+ var indexModulus = index;
24
+ var computedResults[levels];
25
+
26
+ for (var i = 0; i < levels; i++) {
27
+ // circom's best practices suggests to avoid using <-- unless you
28
+ // are aware of what's going on. This is the only way to do modulo operation.
29
+ out[i] <-- indexModulus % LEAVES_PER_NODE;
30
+ indexModulus = indexModulus \ LEAVES_PER_NODE;
31
+
32
+ // Check that each output element is less than the base.
33
+ var computedIsOutputElementLessThanBase = SafeLessThan(3)([out[i], LEAVES_PER_NODE]);
34
+ computedIsOutputElementLessThanBase === 1;
35
+
36
+ // Re-compute the total sum.
37
+ computedResults[i] = out[i] * (LEAVES_PER_NODE ** i);
38
+ }
39
+
40
+ // Check that the total sum matches the index.
41
+ var computedCalculateTotal = CalculateTotal(levels)(computedResults);
42
+
43
+ computedCalculateTotal === index;
44
+ }
@@ -0,0 +1,30 @@
1
+ pragma circom 2.0.0;
2
+
3
+ // local imports
4
+ include "./QuinaryTreeInclusionProof.circom";
5
+
6
+ /**
7
+ * Verifies if a given leaf exists within an IQT.
8
+ * Takes a leaf, its path to the root (specified by indices and path elements),
9
+ * and the root itself, to verify the leaf's inclusion within the tree.
10
+ */
11
+ template QuinaryLeafExists(levels){
12
+ // The number of leaves per node (tree arity)
13
+ var LEAVES_PER_NODE = 5;
14
+ // Number of leaves per path level (excluding the leaf itself)
15
+ var LEAVES_PER_PATH_LEVEL = LEAVES_PER_NODE - 1;
16
+
17
+ // The leaf to check for inclusion
18
+ signal input leaf;
19
+ // The path indices at each level of the tree
20
+ signal input path_indices[levels];
21
+ // The sibling nodes at each level of the tree
22
+ signal input path_elements[levels][LEAVES_PER_PATH_LEVEL];
23
+ // The computed root of the tree
24
+ signal input root;
25
+
26
+ // Verify the Merkle path.
27
+ var computedRoot = QuinaryTreeInclusionProof(levels)(leaf, path_indices, path_elements);
28
+
29
+ root === computedRoot;
30
+ }
@@ -0,0 +1,42 @@
1
+ pragma circom 2.0.0;
2
+
3
+ // zk-kit import
4
+ include "./safe-comparators.circom";
5
+ // local imports
6
+ include "../CalculateTotal.circom";
7
+
8
+ /**
9
+ * Selects an item from a list based on the given index.
10
+ * It verifies the index is within the valid range and then iterates over the inputs to find the match.
11
+ * For each item, it checks if its position equals the given index and if so, multiplies the item
12
+ * by the result of the equality check, effectively selecting it.
13
+ * The sum of these results yields the selected item, ensuring only the item at the specified index be the output.
14
+ *
15
+ * nb. The number of items must be less than 8, and the index must be less than the number of items.
16
+ */
17
+ template QuinarySelector(choices) {
18
+ // The input elements to select from.
19
+ signal input in[choices];
20
+ // The index of the element to select
21
+ signal input index;
22
+ // The selected total sum of the elements.
23
+ signal output out;
24
+
25
+ // Ensure that index < choices.
26
+ var computedIndex = SafeLessThan(3)([index, choices]);
27
+ computedIndex === 1;
28
+
29
+ // Initialize an array to hold the results of equality checks.
30
+ var computedResults[choices];
31
+
32
+ // For each item, check whether its index equals the input index.
33
+ // The result is multiplied by the corresponding input value.
34
+ for (var i = 0; i < choices; i++) {
35
+ var computedIsIndexEqual = IsEqual()([i, index]);
36
+
37
+ computedResults[i] = computedIsIndexEqual * in[i];
38
+ }
39
+
40
+ // Calculate the total sum of the results array.
41
+ out <== CalculateTotal(choices)(computedResults);
42
+ }
@@ -0,0 +1,55 @@
1
+ pragma circom 2.0.0;
2
+
3
+ // local imports
4
+ include "../PoseidonHasher.circom";
5
+ include "./Splicer.circom";
6
+
7
+ /**
8
+ * Computes the root of an IQT given a leaf, its path, and sibling nodes at each level of the tree.
9
+ * It iteratively incorporates the leaf or the hash from the previous level with sibling nodes using
10
+ * the Splicer to place the leaf or hash at the correct position based on path_indices.
11
+ * Then, it hashes these values together with PoseidonHasher to move up the tree.
12
+ * This process repeats for each level (levels) of the tree, culminating in the computation of the tree's root.
13
+ */
14
+ template QuinaryTreeInclusionProof(levels) {
15
+ // The number of leaves per node (tree arity)
16
+ var LEAVES_PER_NODE = 5;
17
+ // Number of leaves per path level (excluding the leaf itself)
18
+ var LEAVES_PER_PATH_LEVEL = LEAVES_PER_NODE - 1;
19
+
20
+ // The leaf to check for inclusion
21
+ signal input leaf;
22
+ // The path indices at each level of the tree
23
+ signal input path_indices[levels];
24
+ // The sibling nodes at each level of the tree
25
+ signal input path_elements[levels][LEAVES_PER_PATH_LEVEL];
26
+ // The computed root of the tree
27
+ signal output root;
28
+
29
+ var currentLeaf = leaf;
30
+
31
+ // Iteratively hash each level of path_elements with the leaf or previous hash
32
+ for (var i = 0; i < levels; i++) {
33
+ var elements[LEAVES_PER_PATH_LEVEL];
34
+
35
+ for (var j = 0; j < LEAVES_PER_PATH_LEVEL; j++) {
36
+ elements[j] = path_elements[i][j];
37
+ }
38
+
39
+ var computedSplicedLeaf[LEAVES_PER_NODE] = Splicer(LEAVES_PER_PATH_LEVEL)(
40
+ elements,
41
+ currentLeaf,
42
+ path_indices[i]
43
+ );
44
+
45
+ currentLeaf = PoseidonHasher(5)([
46
+ computedSplicedLeaf[0],
47
+ computedSplicedLeaf[1],
48
+ computedSplicedLeaf[2],
49
+ computedSplicedLeaf[3],
50
+ computedSplicedLeaf[4]
51
+ ]);
52
+ }
53
+
54
+ root <== currentLeaf;
55
+ }