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

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 (38) hide show
  1. package/README.md +2 -2
  2. package/build/ts/types.d.ts +7 -7
  3. package/build/ts/types.d.ts.map +1 -1
  4. package/build/tsconfig.build.tsbuildinfo +1 -1
  5. package/circom/circuits.json +28 -12
  6. package/circom/coordinator/full/MessageProcessor.circom +253 -0
  7. package/circom/coordinator/full/SingleMessageProcessor.circom +203 -0
  8. package/circom/coordinator/non-qv/{processMessages.circom → MessageProcessor.circom} +12 -206
  9. package/circom/coordinator/non-qv/SingleMessageProcessor.circom +199 -0
  10. package/circom/coordinator/non-qv/{tallyVotes.circom → VoteTally.circom} +22 -99
  11. package/circom/coordinator/qv/{processMessages.circom → MessageProcessor.circom} +13 -214
  12. package/circom/coordinator/qv/SingleMessageProcessor.circom +207 -0
  13. package/circom/coordinator/qv/VoteTally.circom +179 -0
  14. package/circom/coordinator/qv/VoteTallyWithIndividualCounts.circom +226 -0
  15. package/circom/utils/CalculateTotal.circom +6 -6
  16. package/circom/utils/PrivateToPublicKey.circom +3 -3
  17. package/circom/utils/full/MessageValidator.circom +91 -0
  18. package/circom/utils/full/StateLeafAndBallotTransformer.circom +122 -0
  19. package/circom/utils/non-qv/MessageValidator.circom +4 -4
  20. package/circom/utils/non-qv/ResultCommitmentVerifier.circom +84 -0
  21. package/circom/utils/non-qv/StateLeafAndBallotTransformer.circom +7 -7
  22. package/circom/utils/qv/MessageValidator.circom +4 -4
  23. package/circom/utils/qv/ResultCommitmentVerifier.circom +107 -0
  24. package/circom/utils/qv/StateLeafAndBallotTransformer.circom +7 -7
  25. package/circom/utils/trees/BinaryMerkleRoot.circom +6 -3
  26. package/circom/utils/trees/LeafExists.circom +2 -2
  27. package/circom/utils/trees/MerkleTreeInclusionProof.circom +4 -4
  28. package/circom/utils/trees/QuinaryCheckRoot.circom +54 -0
  29. package/circom/utils/trees/{MerklePathIndicesGenerator.circom → QuinaryGeneratePathIndices.circom} +18 -18
  30. package/circom/utils/trees/QuinaryLeafExists.circom +30 -0
  31. package/circom/utils/trees/QuinarySelector.circom +42 -0
  32. package/circom/utils/trees/QuinaryTreeInclusionProof.circom +55 -0
  33. package/circom/utils/trees/Splicer.circom +76 -0
  34. package/circom/voter/PollJoined.circom +5 -5
  35. package/circom/voter/PollJoining.circom +3 -3
  36. package/package.json +15 -13
  37. package/circom/coordinator/qv/tallyVotes.circom +0 -279
  38. package/circom/utils/trees/incrementalQuinaryTree.circom +0 -287
@@ -0,0 +1,226 @@
1
+ pragma circom 2.0.0;
2
+
3
+ // circomlib import
4
+ include "./comparators.circom";
5
+ // zk-kit import
6
+ include "./unpack-element.circom";
7
+ // local imports
8
+ include "../../utils/trees/CheckRoot.circom";
9
+ include "../../utils/trees/LeafExists.circom";
10
+ include "../../utils/trees/QuinaryCheckRoot.circom";
11
+ include "../../utils/qv/ResultCommitmentVerifier.circom";
12
+ include "../../utils/CalculateTotal.circom";
13
+ include "../../utils/PoseidonHasher.circom";
14
+
15
+ /**
16
+ * Processes batches of votes and verifies their validity in a Merkle tree structure.
17
+ * This template supports Quadratic Voting (QV) with individual vote counting.
18
+ * Note: this circuit is not using right now, this is a part of individual vote counts functionality.
19
+ * Not finished yet, don't use it in production. It is kept here for future use.
20
+ */
21
+ template VoteTallyWithIndividualCountsQv(
22
+ stateTreeDepth,
23
+ tallyProcessingStateTreeDepth,
24
+ voteOptionTreeDepth
25
+ ) {
26
+ // Ensure there's at least one level in the vote option tree.
27
+ assert(voteOptionTreeDepth > 0);
28
+ // Ensure the intermediate state tree has at least one level.
29
+ assert(tallyProcessingStateTreeDepth > 0);
30
+ // The intermediate state tree must be smaller than the full state tree.
31
+ assert(tallyProcessingStateTreeDepth < stateTreeDepth);
32
+
33
+ // Number of children per node in the tree, defining the tree's branching factor.
34
+ var TREE_ARITY = 5;
35
+ var BALLOT_TREE_ARITY = 2;
36
+ var VOTE_COUNTS_TREE_ARITY = 2;
37
+
38
+ // The number of ballots processed at once, determined by the depth of the intermediate state tree.
39
+ var ballotBatchSize = BALLOT_TREE_ARITY ** tallyProcessingStateTreeDepth;
40
+ var voteCountsBatchSize = VOTE_COUNTS_TREE_ARITY ** tallyProcessingStateTreeDepth;
41
+ // Number of voting options available, determined by the depth of the vote option tree.
42
+ var totalVoteOptions = TREE_ARITY ** voteOptionTreeDepth;
43
+
44
+ // Number of elements in each ballot.
45
+ var BALLOT_LENGTH = 2;
46
+ // Index for the nonce in the ballot array.
47
+ var BALLOT_NONCE_INDEX = 0;
48
+ // Index for the voting option root in the ballot array.
49
+ var BALLOT_VOTE_OPTION_ROOT_INDEX = 1;
50
+ // Difference in tree depths, used in path calculations.
51
+ var STATE_TREE_DEPTH_DIFFERENCE = stateTreeDepth - tallyProcessingStateTreeDepth;
52
+ // Number of elements in each vote count leaf.
53
+ var VOTE_COUNTS_LENGTH = 2;
54
+ // Index for the voting option index.
55
+ var VOTE_COUNTS_NONCE_INDEX = 0;
56
+ // Index for root of the vote count per option.
57
+ var VOTE_COUNTS_ROOT_INDEX = 1;
58
+
59
+ // Root of the state Merkle tree, representing the overall state before voting.
60
+ signal input stateRoot;
61
+ // Root of the ballot Merkle tree, representing the submitted ballots.
62
+ signal input ballotRoot;
63
+ // Root of the vote counts Merkle tree, representing the counts of votes for each option.
64
+ signal input voteCountsRoot;
65
+ // Salt used in commitment to secure the ballot data.
66
+ signal input sbSalt;
67
+ // Commitment to the state and ballots.
68
+ signal input sbCommitment;
69
+ // Commitment to the current tally before this batch.
70
+ signal input currentTallyCommitment;
71
+ // Commitment to the new tally after processing this batch.
72
+ signal input newTallyCommitment;
73
+ // Start index of given batch
74
+ signal input index;
75
+ // Number of users that signup
76
+ signal input totalSignups;
77
+ // Ballots and their corresponding path elements for verification in the tree.
78
+ signal input ballots[ballotBatchSize][BALLOT_LENGTH];
79
+ signal input ballotPathElements[STATE_TREE_DEPTH_DIFFERENCE][BALLOT_TREE_ARITY - 1];
80
+ signal input votes[ballotBatchSize][totalVoteOptions];
81
+ // Individual vote count tree and their corresponding path elements for verification in the tree.
82
+ signal input voteCounts[voteCountsBatchSize][VOTE_COUNTS_LENGTH];
83
+ signal input voteCountsPathElements[STATE_TREE_DEPTH_DIFFERENCE][VOTE_COUNTS_TREE_ARITY - 1];
84
+ signal input voteCountsData[voteCountsBatchSize][totalVoteOptions];
85
+ // Current results for each vote option.
86
+ signal input currentResults[totalVoteOptions];
87
+ // Salt for the root of the current results.
88
+ signal input currentResultsRootSalt;
89
+ // Total voice credits spent so far.
90
+ signal input currentSpentVoiceCreditSubtotal;
91
+ // Salt for the total spent voice credits.
92
+ signal input currentSpentVoiceCreditSubtotalSalt;
93
+ // Spent voice credits per vote option.
94
+ signal input currentPerVoteOptionSpentVoiceCredits[totalVoteOptions];
95
+ // Salt for the root of spent credits per option.
96
+ signal input currentPerVoteOptionSpentVoiceCreditsRootSalt;
97
+ // Salt for the root of the new results.
98
+ signal input newResultsRootSalt;
99
+ // Salt for the new spent credits per vote option root.
100
+ signal input newPerVoteOptionSpentVoiceCreditsRootSalt;
101
+ // Salt for the new total spent voice credits root.
102
+ signal input newSpentVoiceCreditSubtotalSalt;
103
+
104
+ // Verify sbCommitment.
105
+ var computedSbCommitment = PoseidonHasher(3)([stateRoot, ballotRoot, sbSalt]);
106
+ computedSbCommitment === sbCommitment;
107
+
108
+ // Validates that the index is within the valid range of sign-ups.
109
+ var totalSignupsValid = LessEqThan(50)([index, totalSignups]);
110
+ totalSignupsValid === 1;
111
+
112
+ // Hashes each ballot for subroot generation, and checks the existence of the leaf in the Merkle tree.
113
+ var computedBallotHashers[ballotBatchSize];
114
+ var computedVoteCountsHashers[voteCountsBatchSize];
115
+
116
+ for (var i = 0; i < ballotBatchSize; i++) {
117
+ computedBallotHashers[i] = PoseidonHasher(2)([
118
+ ballots[i][BALLOT_NONCE_INDEX],
119
+ ballots[i][BALLOT_VOTE_OPTION_ROOT_INDEX]
120
+ ]);
121
+ }
122
+
123
+ for (var i = 0; i < voteCountsBatchSize; i++) {
124
+ computedVoteCountsHashers[i] = PoseidonHasher(2)([
125
+ voteCounts[i][VOTE_COUNTS_NONCE_INDEX],
126
+ voteCounts[i][VOTE_COUNTS_ROOT_INDEX]
127
+ ]);
128
+ }
129
+
130
+ var computedBallotSubroot = CheckRoot(tallyProcessingStateTreeDepth)(computedBallotHashers);
131
+ var computedBallotPathIndices[STATE_TREE_DEPTH_DIFFERENCE] = Num2Bits(STATE_TREE_DEPTH_DIFFERENCE)(index / ballotBatchSize);
132
+
133
+ var computedVoteCountsSubroot = CheckRoot(tallyProcessingStateTreeDepth)(computedVoteCountsHashers);
134
+ var computedVoteCountsPathIndices[STATE_TREE_DEPTH_DIFFERENCE] = Num2Bits(STATE_TREE_DEPTH_DIFFERENCE)(index / voteCountsBatchSize);
135
+
136
+ // Verifies each ballot's existence within the ballot tree.
137
+ LeafExists(STATE_TREE_DEPTH_DIFFERENCE)(
138
+ computedBallotSubroot,
139
+ ballotPathElements,
140
+ computedBallotPathIndices,
141
+ ballotRoot
142
+ );
143
+
144
+ // Verifies each vote count's existence within the vote count tree.
145
+ LeafExists(STATE_TREE_DEPTH_DIFFERENCE)(
146
+ computedVoteCountsSubroot,
147
+ voteCountsPathElements,
148
+ computedVoteCountsPathIndices,
149
+ voteCountsRoot
150
+ );
151
+
152
+ // Processes vote options, verifying each against its declared root.
153
+ var computedVoteTree[ballotBatchSize];
154
+
155
+ for (var i = 0; i < ballotBatchSize; i++) {
156
+ computedVoteTree[i] = QuinaryCheckRoot(voteOptionTreeDepth)(votes[i]);
157
+ computedVoteTree[i] === ballots[i][BALLOT_VOTE_OPTION_ROOT_INDEX];
158
+ }
159
+
160
+ // Processes vote counts, verifying each against its declared root.
161
+ var computedVoteCountsTree[voteCountsBatchSize];
162
+
163
+ for (var i = 0; i < voteCountsBatchSize; i++) {
164
+ computedVoteCountsTree[i] = QuinaryCheckRoot(voteOptionTreeDepth)(voteCountsData[i]);
165
+ computedVoteCountsTree[i] === voteCounts[i][VOTE_COUNTS_ROOT_INDEX];
166
+ }
167
+
168
+ // Calculates new results and spent voice credits based on the current and incoming votes.
169
+ var computedIsFirstBatch = IsZero()(index);
170
+ var computedIsZero = IsZero()(computedIsFirstBatch);
171
+
172
+ // Tally the new results.
173
+ var computedCalculateTotalResult[totalVoteOptions];
174
+ for (var i = 0; i < totalVoteOptions; i++) {
175
+ var numsRC[ballotBatchSize + 1];
176
+ numsRC[ballotBatchSize] = currentResults[i] * computedIsZero;
177
+ for (var j = 0; j < ballotBatchSize; j++) {
178
+ numsRC[j] = votes[j][i];
179
+ }
180
+
181
+ computedCalculateTotalResult[i] = CalculateTotal(ballotBatchSize + 1)(numsRC);
182
+ }
183
+
184
+ // Tally the new spent voice credit total.
185
+ var numsSVC[ballotBatchSize * totalVoteOptions + 1];
186
+ numsSVC[ballotBatchSize * totalVoteOptions] = currentSpentVoiceCreditSubtotal * computedIsZero;
187
+ for (var i = 0; i < ballotBatchSize; i++) {
188
+ for (var j = 0; j < totalVoteOptions; j++) {
189
+ numsSVC[i * totalVoteOptions + j] = votes[i][j] * votes[i][j];
190
+ }
191
+ }
192
+
193
+ var computedNewSpentVoiceCreditSubtotal = CalculateTotal(ballotBatchSize * totalVoteOptions + 1)(numsSVC);
194
+
195
+ // Tally the spent voice credits per vote option.
196
+ var computedNewPerVOSpentVoiceCredits[totalVoteOptions];
197
+
198
+ for (var i = 0; i < totalVoteOptions; i++) {
199
+ var computedTotalVoiceCreditSpent[ballotBatchSize + 1];
200
+ computedTotalVoiceCreditSpent[ballotBatchSize] = currentPerVoteOptionSpentVoiceCredits[i] * computedIsZero;
201
+ for (var j = 0; j < ballotBatchSize; j++) {
202
+ computedTotalVoiceCreditSpent[j] = votes[j][i] * votes[j][i];
203
+ }
204
+
205
+ computedNewPerVOSpentVoiceCredits[i] = CalculateTotal(ballotBatchSize + 1)(computedTotalVoiceCreditSpent);
206
+ }
207
+
208
+ // Verifies the updated results and spent credits, ensuring consistency and correctness of tally updates.
209
+ ResultCommitmentVerifierQv(voteOptionTreeDepth)(
210
+ computedIsFirstBatch,
211
+ currentTallyCommitment,
212
+ newTallyCommitment,
213
+ currentResults,
214
+ currentResultsRootSalt,
215
+ computedCalculateTotalResult,
216
+ newResultsRootSalt,
217
+ currentSpentVoiceCreditSubtotal,
218
+ currentSpentVoiceCreditSubtotalSalt,
219
+ computedNewSpentVoiceCreditSubtotal,
220
+ newSpentVoiceCreditSubtotalSalt,
221
+ currentPerVoteOptionSpentVoiceCredits,
222
+ currentPerVoteOptionSpentVoiceCreditsRootSalt,
223
+ computedNewPerVOSpentVoiceCredits,
224
+ newPerVoteOptionSpentVoiceCreditsRootSalt
225
+ );
226
+ }
@@ -1,24 +1,24 @@
1
1
  pragma circom 2.0.0;
2
2
 
3
3
  /**
4
- * Computes the cumulative sum of an array of n input signals.
4
+ * Computes the cumulative sum of an array of length input signals.
5
5
  * It iterates through each input, aggregating the sum up to that point,
6
6
  * and outputs the total sum of all inputs. This template is useful for
7
7
  * operations requiring the total sum of multiple signals, ensuring the
8
8
  * final output reflects the cumulative total of the inputs provided.
9
9
  */
10
- template CalculateTotal(n) {
10
+ template CalculateTotal(length) {
11
11
  // Array of values.
12
- signal input nums[n];
12
+ signal input nums[length];
13
13
  // Total sum.
14
14
  signal output sum;
15
15
 
16
- signal sums[n];
16
+ signal sums[length];
17
17
  sums[0] <== nums[0];
18
18
 
19
- for (var i = 1; i < n; i++) {
19
+ for (var i = 1; i < length; i++) {
20
20
  sums[i] <== sums[i - 1] + nums[i];
21
21
  }
22
22
 
23
- sum <== sums[n - 1];
23
+ sum <== sums[length - 1];
24
24
  }
@@ -29,10 +29,10 @@ template PrivateToPublicKey() {
29
29
  isLessThan === 1;
30
30
 
31
31
  // Convert the private key to bits.
32
- var computedPrivBits[253] = Num2Bits(253)(privateKey);
32
+ var computedPrivateBits[253] = Num2Bits(253)(privateKey);
33
33
 
34
34
  // Perform scalar multiplication with the basepoint.
35
- var computedEscalarMulFix[2] = EscalarMulFix(253, BASE8)(computedPrivBits);
35
+ var computedPublicKey[2] = EscalarMulFix(253, BASE8)(computedPrivateBits);
36
36
 
37
- publicKey <== computedEscalarMulFix;
37
+ publicKey <== computedPublicKey;
38
38
  }
@@ -0,0 +1,91 @@
1
+ pragma circom 2.0.0;
2
+
3
+ // zk-kit imports
4
+ include "./safe-comparators.circom";
5
+ // local imports
6
+ include "../VerifySignature.circom";
7
+
8
+ /**
9
+ * Checks if a MACI message is valid or not.
10
+ * This template supports the full mode (all credits are spent on one option)
11
+ */
12
+ template MessageValidatorFull() {
13
+ // Length of the packed command.
14
+ var PACKED_COMMAND_LENGTH = 4;
15
+ // Number of checks to be performed.
16
+ var TOTAL_CHECKS = 5;
17
+
18
+ // State index of the user.
19
+ signal input stateTreeIndex;
20
+ // Number of user sign-ups in the state tree.
21
+ signal input totalSignups;
22
+ // Vote option index.
23
+ signal input voteOptionIndex;
24
+ // Number of valid vote options for the poll.
25
+ signal input voteOptions;
26
+ // Ballot nonce.
27
+ signal input originalNonce;
28
+ // Command nonce.
29
+ signal input commandNonce;
30
+ // Packed command.
31
+ signal input command[PACKED_COMMAND_LENGTH];
32
+ // Public key of the state leaf (user).
33
+ signal input publicKey[2];
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;
38
+ // State leaf current voice credit balance.
39
+ signal input currentVoiceCreditBalance;
40
+ // Current number of votes for specific option.
41
+ signal input currentVotesForOption;
42
+ // Vote weight.
43
+ signal input voteWeight;
44
+
45
+ // True when the command is valid; otherwise false.
46
+ signal output isValid;
47
+ // True if the state leaf index is valid
48
+ signal output isStateLeafIndexValid;
49
+ // True if the vote option index is valid
50
+ signal output isVoteOptionIndexValid;
51
+
52
+ // Check (1) - The state leaf index must be valid.
53
+ // The check ensure that the stateTreeIndex < totalSignups as first validation.
54
+ // Must be < because the stateTreeIndex is 0-based. Zero is for blank state leaf
55
+ // while 1 is for the first actual user.
56
+ var computedIsStateLeafIndexValid = SafeLessThan(252)([stateTreeIndex, totalSignups]);
57
+
58
+ // Check (2) - The vote option index must be less than the number of valid vote options (0 indexed).
59
+ var computedIsVoteOptionIndexValid = SafeLessThan(252)([voteOptionIndex, voteOptions]);
60
+
61
+ // Check (3) - The nonce must be correct.
62
+ var computedIsNonceValid = IsEqual()([originalNonce + 1, commandNonce]);
63
+
64
+ // Check (4) - The signature must be correct.
65
+ var computedIsSignatureValid = VerifySignature()(publicKey, signaturePoint, signatureScalar, command);
66
+
67
+ // Check (5) - There must be sufficient voice credits.
68
+ // The check ensure that currentVotesForOption + currentVoiceCreditBalance is equal to voteWeight.
69
+ var computedAreVoiceCreditsSpent = IsEqual()(
70
+ [
71
+ currentVotesForOption + currentVoiceCreditBalance,
72
+ voteWeight
73
+ ]
74
+ );
75
+
76
+ // When all five checks are correct, then isValid = 1.
77
+ var computedIsUpdateValid = IsEqual()(
78
+ [
79
+ TOTAL_CHECKS,
80
+ computedIsSignatureValid +
81
+ computedAreVoiceCreditsSpent +
82
+ computedIsNonceValid +
83
+ computedIsStateLeafIndexValid +
84
+ computedIsVoteOptionIndexValid
85
+ ]
86
+ );
87
+
88
+ isValid <== computedIsUpdateValid;
89
+ isStateLeafIndexValid <== computedIsStateLeafIndexValid;
90
+ isVoteOptionIndexValid <== computedIsVoteOptionIndexValid;
91
+ }
@@ -0,0 +1,122 @@
1
+ pragma circom 2.0.0;
2
+
3
+ // circomlib import
4
+ include "./mux1.circom";
5
+ // local import
6
+ include "./MessageValidator.circom";
7
+
8
+ /**
9
+ * Processes a command by verifying its validity and updates the state leaf and ballot accordingly.
10
+ * If the message is correct, updates the public key in the state leaf and the nonce
11
+ * in the ballot using multiplexer components.
12
+ * This template supports the full mode (all credits are spent on one option)
13
+ */
14
+ template StateLeafAndBallotTransformerFull() {
15
+ // Length of the packed command.
16
+ var PACKED_COMMAND_LENGTH = 4;
17
+
18
+ // Number of user sign-ups in the state tree.
19
+ signal input totalSignups;
20
+ // Number of valid vote options for the poll.
21
+ signal input voteOptions;
22
+
23
+ // The following signals represents a state leaf (signed up user).
24
+ // Public key.
25
+ signal input stateLeafPublicKey[2];
26
+ // Current voice credit balance.
27
+ signal input stateLeafVoiceCreditBalance;
28
+
29
+ // The following signals represents a ballot.
30
+ // Nonce.
31
+ signal input ballotNonce;
32
+ // Current number of votes for specific option.
33
+ signal input ballotCurrentVotesForOption;
34
+
35
+ // The following signals represents a command.
36
+ // State index of the user.
37
+ signal input commandStateIndex;
38
+ // Public key of the user.
39
+ signal input commandPublicKey[2];
40
+ // Vote option index.
41
+ signal input commandVoteOptionIndex;
42
+ // Vote weight.
43
+ signal input commandNewVoteWeight;
44
+ // Nonce.
45
+ signal input commandNonce;
46
+ // Poll identifier.
47
+ signal input commandPollId;
48
+ // Salt.
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
+ // Packed command.
55
+ // nb. we are assuming that the packedCommand is always valid.
56
+ signal input packedCommand[PACKED_COMMAND_LENGTH];
57
+
58
+ // New state leaf (if the command is valid).
59
+ signal output newStateLeafPublicKey[2];
60
+ // New ballot (if the command is valid).
61
+ signal output newBallotNonce;
62
+
63
+ // True when the command is valid; otherwise false.
64
+ signal output isValid;
65
+ // True if the state leaf index is valid
66
+ signal output isStateLeafIndexValid;
67
+ // True if the vote option index is valid
68
+ signal output isVoteOptionIndexValid;
69
+
70
+ // Check if the command / message is valid.
71
+ var (
72
+ computedIsValid,
73
+ computedIsStateLeafIndexValid,
74
+ computedIsVoteOptionIndexValid
75
+ ) = MessageValidatorFull()(
76
+ commandStateIndex,
77
+ totalSignups,
78
+ commandVoteOptionIndex,
79
+ voteOptions,
80
+ ballotNonce,
81
+ commandNonce,
82
+ packedCommand,
83
+ stateLeafPublicKey,
84
+ commandSignaturePoint,
85
+ commandSignatureScalar,
86
+ stateLeafVoiceCreditBalance,
87
+ ballotCurrentVotesForOption,
88
+ commandNewVoteWeight
89
+ );
90
+
91
+ // If the message is valid then we swap out the public key.
92
+ // This means using a Mux1() for publicKey[0] and another one
93
+ // for publicKey[1].
94
+ var computedNewstateLeafPublicKey0Mux = Mux1()(
95
+ [
96
+ stateLeafPublicKey[0],
97
+ commandPublicKey[0]
98
+ ],
99
+ computedIsValid
100
+ );
101
+
102
+ var computedNewstateLeafPublicKey1Mux = Mux1()(
103
+ [
104
+ stateLeafPublicKey[1],
105
+ commandPublicKey[1]
106
+ ],
107
+ computedIsValid
108
+ );
109
+
110
+ newStateLeafPublicKey[0] <== computedNewstateLeafPublicKey0Mux;
111
+ newStateLeafPublicKey[1] <== computedNewstateLeafPublicKey1Mux;
112
+
113
+ // If the message is valid, then we swap out the ballot nonce
114
+ // using a Mux1().
115
+ var computedNewBallotNonceMux = Mux1()([ballotNonce, commandNonce], computedIsValid);
116
+
117
+ newBallotNonce <== computedNewBallotNonceMux;
118
+
119
+ isValid <== computedIsValid;
120
+ isStateLeafIndexValid <== computedIsStateLeafIndexValid;
121
+ isVoteOptionIndexValid <== computedIsVoteOptionIndexValid;
122
+ }
@@ -26,14 +26,14 @@ template MessageValidatorNonQv() {
26
26
  // Ballot nonce.
27
27
  signal input originalNonce;
28
28
  // Command nonce.
29
- signal input nonce;
29
+ signal input commandNonce;
30
30
  // Packed command.
31
31
  signal input command[PACKED_COMMAND_LENGTH];
32
32
  // Public key of the state leaf (user).
33
33
  signal input publicKey[2];
34
- // ECDSA signature of the command (R part).
34
+ // EdDSA signature of the command (R part).
35
35
  signal input signaturePoint[2];
36
- // ECDSA signature of the command (S part).
36
+ // EdDSA signature of the command (S part).
37
37
  signal input signatureScalar;
38
38
  // State leaf current voice credit balance.
39
39
  signal input currentVoiceCreditBalance;
@@ -59,7 +59,7 @@ template MessageValidatorNonQv() {
59
59
  var computedIsVoteOptionIndexValid = SafeLessThan(252)([voteOptionIndex, voteOptions]);
60
60
 
61
61
  // Check (3) - The nonce must be correct.
62
- var computedIsNonceValid = IsEqual()([originalNonce + 1, nonce]);
62
+ var computedIsNonceValid = IsEqual()([originalNonce + 1, commandNonce]);
63
63
 
64
64
  // Check (4) - The signature must be correct.
65
65
  var computedIsSignatureValid = VerifySignature()(publicKey, signaturePoint, signatureScalar, command);
@@ -0,0 +1,84 @@
1
+ pragma circom 2.0.0;
2
+
3
+ // circomlib import
4
+ include "./comparators.circom";
5
+ // local imports
6
+ include "../trees/QuinaryCheckRoot.circom";
7
+ include "../PoseidonHasher.circom";
8
+
9
+ /**
10
+ * Performs verifications and computations related to current voting results.
11
+ * Also, computes and outputs a commitment to the new results.
12
+ * This template does not support Quadratic Voting (QV).
13
+ */
14
+ template ResultCommitmentVerifierNonQv(voteOptionTreeDepth) {
15
+ // Number of children per node in the tree, defining the tree's branching factor.
16
+ var TREE_ARITY = 5;
17
+ // Number of voting options available, determined by the depth of the vote option tree.
18
+ var totalVoteOptions = TREE_ARITY ** voteOptionTreeDepth;
19
+
20
+ // Equal to 1 if this is the first batch, otherwise 0.
21
+ signal input isFirstBatch;
22
+ // Commitment to the current tally before this batch.
23
+ signal input currentTallyCommitment;
24
+ // Commitment to the new tally after processing this batch.
25
+ signal input newTallyCommitment;
26
+
27
+ // Current results for each vote option.
28
+ signal input currentResults[totalVoteOptions];
29
+ // Salt for the root of the current results.
30
+ signal input currentResultsRootSalt;
31
+
32
+ // New results for each vote option.
33
+ signal input newResults[totalVoteOptions];
34
+ // Salt for the root of the new results.
35
+ signal input newResultsRootSalt;
36
+
37
+ // Total voice credits spent so far.
38
+ signal input currentSpentVoiceCreditSubtotal;
39
+ // Salt for the total spent voice credits.
40
+ signal input currentSpentVoiceCreditSubtotalSalt;
41
+
42
+ // Total new voice credits spent.
43
+ signal input newSpentVoiceCreditSubtotal;
44
+ // Salt for the new total spent voice credits.
45
+ signal input newSpentVoiceCreditSubtotalSalt;
46
+
47
+ // Compute the commitment to the current results.
48
+ var computedCurrentResultsRoot = QuinaryCheckRoot(voteOptionTreeDepth)(currentResults);
49
+
50
+ // Verify currentResultsCommitmentHash.
51
+ var computedCurrentResultsCommitment = PoseidonHasher(2)([computedCurrentResultsRoot, currentResultsRootSalt]);
52
+
53
+ // Compute the commitment to the current spent voice credits.
54
+ var computedCurrentSpentVoiceCreditsCommitment = PoseidonHasher(2)([currentSpentVoiceCreditSubtotal, currentSpentVoiceCreditSubtotalSalt]);
55
+
56
+ // Commit to the current tally
57
+ var computedCurrentTallyCommitment = PoseidonHasher(2)([computedCurrentResultsCommitment, computedCurrentSpentVoiceCreditsCommitment]);
58
+
59
+ // Check if the current tally commitment is correct only if this is not the first batch.
60
+ // computedIsZero.out is 1 if this is not the first batch.
61
+ // computedIsZero.out is 0 if this is the first batch.
62
+ var computedIsZero = IsZero()(isFirstBatch);
63
+
64
+ // isFirstCommitment is 0 if this is the first batch, currentTallyCommitment should be 0 if this is the first batch.
65
+ // isFirstCommitment is 1 if this is not the first batch, currentTallyCommitment should not be 0 if this is the first batch.
66
+ signal isFirstCommitment;
67
+ isFirstCommitment <== computedIsZero * computedCurrentTallyCommitment;
68
+ isFirstCommitment === currentTallyCommitment;
69
+
70
+ // Compute the root of the new results.
71
+ var computedNewResultsRoot = QuinaryCheckRoot(voteOptionTreeDepth)(newResults);
72
+ var computedNewResultsCommitment = PoseidonHasher(2)([computedNewResultsRoot, newResultsRootSalt]);
73
+
74
+ // Compute the commitment to the new spent voice credits value.
75
+ var computedNewSpentVoiceCreditsCommitment = PoseidonHasher(2)([newSpentVoiceCreditSubtotal, newSpentVoiceCreditSubtotalSalt]);
76
+
77
+ // Commit to the new tally.
78
+ var computedNewTallyCommitment = PoseidonHasher(2)([
79
+ computedNewResultsCommitment,
80
+ computedNewSpentVoiceCreditsCommitment
81
+ ]);
82
+
83
+ computedNewTallyCommitment === newTallyCommitment;
84
+ }
@@ -47,9 +47,9 @@ template StateLeafAndBallotTransformerNonQv() {
47
47
  signal input commandPollId;
48
48
  // Salt.
49
49
  signal input commandSalt;
50
- // ECDSA signature of the command (R part).
50
+ // EdDSA signature of the command (R part).
51
51
  signal input commandSignaturePoint[2];
52
- // ECDSA signature of the command (S part).
52
+ // EdDSA signature of the command (S part).
53
53
  signal input commandSignatureScalar;
54
54
  // Packed command.
55
55
  // nb. we are assuming that the packedCommand is always valid.
@@ -68,7 +68,7 @@ template StateLeafAndBallotTransformerNonQv() {
68
68
  signal output isVoteOptionIndexValid;
69
69
 
70
70
  // Check if the command / message is valid.
71
- var (computedMessageValidator, computedIsStateLeafIndexValid, computedIsVoteOptionIndexValid) = MessageValidatorNonQv()(
71
+ var (computedIsValid, computedIsStateLeafIndexValid, computedIsVoteOptionIndexValid) = MessageValidatorNonQv()(
72
72
  commandStateIndex,
73
73
  totalSignups,
74
74
  commandVoteOptionIndex,
@@ -87,19 +87,19 @@ template StateLeafAndBallotTransformerNonQv() {
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 computedNewstateLeafPublicKey0Mux = Mux1()([stateLeafPublicKey[0], commandPublicKey[0]], computedMessageValidator);
91
- var computedNewstateLeafPublicKey1Mux = Mux1()([stateLeafPublicKey[1], commandPublicKey[1]], computedMessageValidator);
90
+ var computedNewstateLeafPublicKey0Mux = Mux1()([stateLeafPublicKey[0], commandPublicKey[0]], computedIsValid);
91
+ var computedNewstateLeafPublicKey1Mux = Mux1()([stateLeafPublicKey[1], commandPublicKey[1]], computedIsValid);
92
92
 
93
93
  newStateLeafPublicKey[0] <== computedNewstateLeafPublicKey0Mux;
94
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, commandNonce], 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
  }
@@ -26,14 +26,14 @@ template MessageValidator() {
26
26
  // Ballot nonce.
27
27
  signal input originalNonce;
28
28
  // Command nonce.
29
- signal input nonce;
29
+ signal input commandNonce;
30
30
  // Packed command.
31
31
  signal input command[PACKED_COMMAND_LENGTH];
32
32
  // Public key of the state leaf (user).
33
33
  signal input publicKey[2];
34
- // ECDSA signature of the command (R part).
34
+ // EdDSA signature of the command (R part).
35
35
  signal input signaturePoint[2];
36
- // ECDSA signature of the command (S part).
36
+ // EdDSA signature of the command (S part).
37
37
  signal input signatureScalar;
38
38
  // State leaf current voice credit balance.
39
39
  signal input currentVoiceCreditBalance;
@@ -59,7 +59,7 @@ template MessageValidator() {
59
59
  var computedIsVoteOptionIndexValid = SafeLessThan(252)([voteOptionIndex, voteOptions]);
60
60
 
61
61
  // Check (3) - The nonce must be correct.
62
- var computedIsNonceValid = IsEqual()([originalNonce + 1, nonce]);
62
+ var computedIsNonceValid = IsEqual()([originalNonce + 1, commandNonce]);
63
63
 
64
64
  // Check (4) - The signature must be correct.
65
65
  var computedIsSignatureValid = VerifySignature()(publicKey, signaturePoint, signatureScalar, command);