@maci-protocol/circuits 0.0.0-ci.ffabe48 → 3.0.0

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 (27) hide show
  1. package/CHANGELOG.md +432 -0
  2. package/README.md +2 -2
  3. package/build/ts/types.d.ts +4 -4
  4. package/build/ts/types.d.ts.map +1 -1
  5. package/build/tsconfig.build.tsbuildinfo +1 -1
  6. package/circom/circuits.json +12 -12
  7. package/circom/coordinator/full/MessageProcessor.circom +5 -13
  8. package/circom/coordinator/full/SingleMessageProcessor.circom +3 -4
  9. package/circom/coordinator/non-qv/{processMessages.circom → MessageProcessor.circom} +8 -211
  10. package/circom/coordinator/non-qv/SingleMessageProcessor.circom +197 -0
  11. package/circom/coordinator/non-qv/{tallyVotes.circom → VoteTally.circom} +3 -80
  12. package/circom/coordinator/qv/{processMessages.circom → MessageProcessor.circom} +9 -219
  13. package/circom/coordinator/qv/SingleMessageProcessor.circom +204 -0
  14. package/circom/coordinator/qv/{tallyVotes.circom → VoteTally.circom} +4 -104
  15. package/circom/coordinator/qv/VoteTallyWithIndividualCounts.circom +226 -0
  16. package/circom/utils/EdDSAPoseidonVerifier.circom +8 -3
  17. package/circom/utils/IsOnCurve.circom +40 -0
  18. package/circom/utils/full/StateLeafAndBallotTransformer.circom +5 -0
  19. package/circom/utils/non-qv/ResultCommitmentVerifier.circom +84 -0
  20. package/circom/utils/non-qv/StateLeafAndBallotTransformer.circom +5 -0
  21. package/circom/utils/qv/ResultCommitmentVerifier.circom +107 -0
  22. package/circom/utils/qv/StateLeafAndBallotTransformer.circom +5 -0
  23. package/circom/utils/trees/BinaryMerkleRoot.circom +6 -3
  24. package/circom/voter/PollJoined.circom +3 -3
  25. package/circom/voter/PollJoining.circom +3 -3
  26. package/package.json +17 -16
  27. package/circom/utils/trees/MerklePathIndicesGenerator.circom +0 -44
@@ -6,9 +6,9 @@ include "./comparators.circom";
6
6
  include "./unpack-element.circom";
7
7
  // local imports
8
8
  include "../../utils/trees/CheckRoot.circom";
9
- include "../../utils/trees/MerklePathIndicesGenerator.circom";
10
9
  include "../../utils/trees/LeafExists.circom";
11
10
  include "../../utils/trees/QuinaryCheckRoot.circom";
11
+ include "../../utils/qv/ResultCommitmentVerifier.circom";
12
12
  include "../../utils/CalculateTotal.circom";
13
13
  include "../../utils/PoseidonHasher.circom";
14
14
 
@@ -16,7 +16,7 @@ include "../../utils/PoseidonHasher.circom";
16
16
  * Processes batches of votes and verifies their validity in a Merkle tree structure.
17
17
  * This template supports Quadratic Voting (QV).
18
18
  */
19
- template TallyVotes(
19
+ template VoteTallyQv(
20
20
  stateTreeDepth,
21
21
  tallyProcessingStateTreeDepth,
22
22
  voteOptionTreeDepth
@@ -101,7 +101,7 @@ template TallyVotes(
101
101
  }
102
102
 
103
103
  var computedBallotSubroot = CheckRoot(tallyProcessingStateTreeDepth)(computedBallotHashers);
104
- var computedBallotPathIndices[STATE_TREE_DEPTH_DIFFERENCE] = MerklePathIndicesGenerator(STATE_TREE_DEPTH_DIFFERENCE)(index / batchSize);
104
+ var computedBallotPathIndices[STATE_TREE_DEPTH_DIFFERENCE] = Num2Bits(STATE_TREE_DEPTH_DIFFERENCE)(index / batchSize);
105
105
 
106
106
  // Verifies each ballot's existence within the ballot tree.
107
107
  LeafExists(STATE_TREE_DEPTH_DIFFERENCE)(
@@ -159,7 +159,7 @@ template TallyVotes(
159
159
  }
160
160
 
161
161
  // Verifies the updated results and spent credits, ensuring consistency and correctness of tally updates.
162
- ResultCommitmentVerifier(voteOptionTreeDepth)(
162
+ ResultCommitmentVerifierQv(voteOptionTreeDepth)(
163
163
  computedIsFirstBatch,
164
164
  currentTallyCommitment,
165
165
  newTallyCommitment,
@@ -177,103 +177,3 @@ template TallyVotes(
177
177
  newPerVoteOptionSpentVoiceCreditsRootSalt
178
178
  );
179
179
  }
180
-
181
- /**
182
- * Performs verifications and computations related to current voting results.
183
- * Also, computes and outputs a commitment to the new results.
184
- * This template supports the Quadratic Voting (QV).
185
- */
186
- template ResultCommitmentVerifier(voteOptionTreeDepth) {
187
- // Number of children per node in the tree, defining the tree's branching factor.
188
- var TREE_ARITY = 5;
189
- // Number of voting options available, determined by the depth of the vote option tree.
190
- var totalVoteOptions = TREE_ARITY ** voteOptionTreeDepth;
191
-
192
- // Equal to 1 if this is the first batch, otherwise 0.
193
- signal input isFirstBatch;
194
- // Commitment to the current tally before this batch.
195
- signal input currentTallyCommitment;
196
- // Commitment to the new tally after processing this batch.
197
- signal input newTallyCommitment;
198
-
199
- // Current results for each vote option.
200
- signal input currentResults[totalVoteOptions];
201
- // Salt for the root of the current results.
202
- signal input currentResultsRootSalt;
203
-
204
- // New results for each vote option.
205
- signal input newResults[totalVoteOptions];
206
- // Salt for the root of the new results.
207
- signal input newResultsRootSalt;
208
-
209
- // Total voice credits spent so far.
210
- signal input currentSpentVoiceCreditSubtotal;
211
- // Salt for the total spent voice credits.
212
- signal input currentSpentVoiceCreditSubtotalSalt;
213
-
214
- // Total new voice credits spent.
215
- signal input newSpentVoiceCreditSubtotal;
216
- // Salt for the new total spent voice credits.
217
- signal input newSpentVoiceCreditSubtotalSalt;
218
-
219
- // Spent voice credits per vote option.
220
- signal input currentPerVoteOptionSpentVoiceCredits[totalVoteOptions];
221
- // Salt for the root of spent credits per option.
222
- signal input currentPerVoteOptionSpentVoiceCreditsRootSalt;
223
-
224
- // New spent voice credits per vote option.
225
- signal input newPerVoteOptionSpentVoiceCredits[totalVoteOptions];
226
- // Salt for the root of new spent credits per option.
227
- signal input newPerVoteOptionSpentVoiceCreditsRootSalt;
228
-
229
- // Compute the commitment to the current results.
230
- var computedCurrentResultsRoot = QuinaryCheckRoot(voteOptionTreeDepth)(currentResults);
231
-
232
- // Verify currentResultsCommitmentHash.
233
- var computedCurrentResultsCommitment = PoseidonHasher(2)([computedCurrentResultsRoot, currentResultsRootSalt]);
234
-
235
- // Compute the commitment to the current spent voice credits.
236
- var computedCurrentSpentVoiceCreditsCommitment = PoseidonHasher(2)([currentSpentVoiceCreditSubtotal, currentSpentVoiceCreditSubtotalSalt]);
237
-
238
- // Compute the root of the spent voice credits per vote option.
239
- var computedCurrentPerVoteOptionSpentVoiceCreditsRoot = QuinaryCheckRoot(voteOptionTreeDepth)(currentPerVoteOptionSpentVoiceCredits);
240
- var computedCurrentPerVoteOptionSpentVoiceCreditsCommitment = PoseidonHasher(2)([computedCurrentPerVoteOptionSpentVoiceCreditsRoot, currentPerVoteOptionSpentVoiceCreditsRootSalt]);
241
-
242
- // Commit to the current tally.
243
- var computedCurrentTallyCommitment = PoseidonHasher(3)([
244
- computedCurrentResultsCommitment,
245
- computedCurrentSpentVoiceCreditsCommitment,
246
- computedCurrentPerVoteOptionSpentVoiceCreditsCommitment
247
- ]);
248
-
249
- // Check if the current tally commitment is correct only if this is not the first batch.
250
- // computedIsZero.out is 1 if this is not the first batch.
251
- // computedIsZero.out is 0 if this is the first batch.
252
- var computedIsZero = IsZero()(isFirstBatch);
253
-
254
- // isFirstCommitment is 0 if this is the first batch, currentTallyCommitment should be 0 if this is the first batch.
255
- // isFirstCommitment is 1 if this is not the first batch, currentTallyCommitment should not be 0 if this is the first batch.
256
- signal isFirstCommitment;
257
- isFirstCommitment <== computedIsZero * computedCurrentTallyCommitment;
258
- isFirstCommitment === currentTallyCommitment;
259
-
260
- // Compute the root of the new results.
261
- var computedNewResultsRoot = QuinaryCheckRoot(voteOptionTreeDepth)(newResults);
262
- var computedNewResultsCommitment = PoseidonHasher(2)([computedNewResultsRoot, newResultsRootSalt]);
263
-
264
- // Compute the commitment to the new spent voice credits value.
265
- var computedNewSpentVoiceCreditsCommitment = PoseidonHasher(2)([newSpentVoiceCreditSubtotal, newSpentVoiceCreditSubtotalSalt]);
266
-
267
- // Compute the root of the spent voice credits per vote option.
268
- var computedNewPerVoteOptionSpentVoiceCreditsRoot = QuinaryCheckRoot(voteOptionTreeDepth)(newPerVoteOptionSpentVoiceCredits);
269
- var computedNewPerVoteOptionSpentVoiceCreditsCommitment = PoseidonHasher(2)([computedNewPerVoteOptionSpentVoiceCreditsRoot, newPerVoteOptionSpentVoiceCreditsRootSalt]);
270
-
271
- // Commit to the new tally.
272
- var computedNewTallyCommitment = PoseidonHasher(3)([
273
- computedNewResultsCommitment,
274
- computedNewSpentVoiceCreditsCommitment,
275
- computedNewPerVoteOptionSpentVoiceCreditsCommitment
276
- ]);
277
-
278
- computedNewTallyCommitment === newTallyCommitment;
279
- }
@@ -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
+ }
@@ -9,6 +9,7 @@ include "./escalarmulany.circom";
9
9
  include "./escalarmulfix.circom";
10
10
  // local imports
11
11
  include "./PoseidonHasher.circom";
12
+ include "./IsOnCurve.circom";
12
13
 
13
14
  /**
14
15
  * Variant of the EdDSAPoseidonVerifier template from circomlib
@@ -37,9 +38,13 @@ template EdDSAPoseidonVerifier() {
37
38
  // Output signal for the validity of the signature.
38
39
  signal output isValid;
39
40
 
41
+ // Verify the public key and signature point are on the BabyJubJub curve.
42
+ var computedIsPkOnCurve = IsOnCurve()(publicKeyX, publicKeyY);
43
+ var computedIsSpOnCurve = IsOnCurve()(signaturePointX, signaturePointY);
44
+
40
45
  // Ensure signatureScalar<Subgroup Order.
41
46
  // convert the signature scalar signatureScalar into its binary representation.
42
- var computedNum2Bits[254] = Num2Bits(254)(signatureScalar);
47
+ var computedNum2Bits[254] = Num2Bits_strict()(signatureScalar);
43
48
 
44
49
  var computedCompConstantIn[254] = computedNum2Bits;
45
50
  computedCompConstantIn[253] = 0;
@@ -82,10 +87,10 @@ template EdDSAPoseidonVerifier() {
82
87
  // Components to handle edge cases and ensure that all conditions
83
88
  // for a valid signature are met, including the
84
89
  // public key not being zero and other integrity checks.
85
- var computedIsAxZero = IsZero()(publicKeyX);
90
+ var computedIsAxZero = IsZero()(computedDouble3XOut);
86
91
  var computedIsAxEqual = IsEqual()([computedIsAxZero, 0]);
87
92
  var computedIsCcZero = IsZero()(computedCompConstant);
88
- var computedIsValid = IsEqual()([computedIsLeftRightValid + computedIsAxEqual + computedIsCcZero, 3]);
93
+ var computedIsValid = IsEqual()([computedIsLeftRightValid + computedIsAxEqual + computedIsCcZero + computedIsPkOnCurve + computedIsSpOnCurve, 5]);
89
94
 
90
95
  isValid <== computedIsValid;
91
96
  }
@@ -0,0 +1,40 @@
1
+ pragma circom 2.0.0;
2
+
3
+ // zk-kit imports
4
+ include "./comparators.circom";
5
+
6
+ /**
7
+ * Returns 0 or 1 depending on if the point is on the BabyJubJub curve or not. The point is on the
8
+ * BabyJubJub curve if the following equation is true: a*x^2 + y^2 == 1 + d*x^2*y^2
9
+ * This template is identical to the BabyCheck template from circomlib, but it returns 0 or 1
10
+ * instead of having a hard constraint.
11
+ * Based on: https://github.com/iden3/circomlib/blob/master/circuits/babyjub.circom
12
+ */
13
+ template IsOnCurve() {
14
+ // x coordinate of the point on the BabyJubJub curve.
15
+ signal input x;
16
+ // y coordinate of the point on the BabyJubJub curve.
17
+ signal input y;
18
+ // True when the point (x, y) satisfies the BabyJubJub curve equation.
19
+ signal output isValid;
20
+
21
+ // x^2 and y^2 intermediate values.
22
+ signal x2;
23
+ signal y2;
24
+ // x^2 * y^2 intermediate value.
25
+ signal x2y2;
26
+
27
+ // BabyJubJub curve parameters.
28
+ var a = 168700;
29
+ var d = 168696;
30
+
31
+ // Compute x^2 and y^2.
32
+ x2 <== x * x;
33
+ y2 <== y * y;
34
+
35
+ // Compute x^2 * y^2.
36
+ x2y2 <== x2 * y2;
37
+
38
+ // Check if a*x^2 + y^2 == 1 + d*x^2*y^2.
39
+ isValid <== IsEqual()([a * x2 + y2, 1 + d * x2y2]);
40
+ }
@@ -119,4 +119,9 @@ template StateLeafAndBallotTransformerFull() {
119
119
  isValid <== computedIsValid;
120
120
  isStateLeafIndexValid <== computedIsStateLeafIndexValid;
121
121
  isVoteOptionIndexValid <== computedIsVoteOptionIndexValid;
122
+
123
+ // Constrain commandPollId and commandSalt using dummy squares.
124
+ // This binds the proof to a specific poll and salt.
125
+ signal commandPollIdSquare <== commandPollId * commandPollId;
126
+ signal commandSaltSquared <== commandSalt * commandSalt;
122
127
  }
@@ -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
+ }
@@ -102,4 +102,9 @@ template StateLeafAndBallotTransformerNonQv() {
102
102
  isValid <== computedIsValid;
103
103
  isStateLeafIndexValid <== computedIsStateLeafIndexValid;
104
104
  isVoteOptionIndexValid <== computedIsVoteOptionIndexValid;
105
+
106
+ // Constrain commandPollId and commandSalt using dummy squares.
107
+ // This binds the proof to a specific poll and salt.
108
+ signal commandPollIdSquare <== commandPollId * commandPollId;
109
+ signal commandSaltSquared <== commandSalt * commandSalt;
105
110
  }
@@ -0,0 +1,107 @@
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 supports the Quadratic Voting (QV).
13
+ */
14
+ template ResultCommitmentVerifierQv(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
+ // Spent voice credits per vote option.
48
+ signal input currentPerVoteOptionSpentVoiceCredits[totalVoteOptions];
49
+ // Salt for the root of spent credits per option.
50
+ signal input currentPerVoteOptionSpentVoiceCreditsRootSalt;
51
+
52
+ // New spent voice credits per vote option.
53
+ signal input newPerVoteOptionSpentVoiceCredits[totalVoteOptions];
54
+ // Salt for the root of new spent credits per option.
55
+ signal input newPerVoteOptionSpentVoiceCreditsRootSalt;
56
+
57
+ // Compute the commitment to the current results.
58
+ var computedCurrentResultsRoot = QuinaryCheckRoot(voteOptionTreeDepth)(currentResults);
59
+
60
+ // Verify currentResultsCommitmentHash.
61
+ var computedCurrentResultsCommitment = PoseidonHasher(2)([computedCurrentResultsRoot, currentResultsRootSalt]);
62
+
63
+ // Compute the commitment to the current spent voice credits.
64
+ var computedCurrentSpentVoiceCreditsCommitment = PoseidonHasher(2)([currentSpentVoiceCreditSubtotal, currentSpentVoiceCreditSubtotalSalt]);
65
+
66
+ // Compute the root of the spent voice credits per vote option.
67
+ var computedCurrentPerVoteOptionSpentVoiceCreditsRoot = QuinaryCheckRoot(voteOptionTreeDepth)(currentPerVoteOptionSpentVoiceCredits);
68
+ var computedCurrentPerVoteOptionSpentVoiceCreditsCommitment = PoseidonHasher(2)([computedCurrentPerVoteOptionSpentVoiceCreditsRoot, currentPerVoteOptionSpentVoiceCreditsRootSalt]);
69
+
70
+ // Commit to the current tally.
71
+ var computedCurrentTallyCommitment = PoseidonHasher(3)([
72
+ computedCurrentResultsCommitment,
73
+ computedCurrentSpentVoiceCreditsCommitment,
74
+ computedCurrentPerVoteOptionSpentVoiceCreditsCommitment
75
+ ]);
76
+
77
+ // Check if the current tally commitment is correct only if this is not the first batch.
78
+ // computedIsZero.out is 1 if this is not the first batch.
79
+ // computedIsZero.out is 0 if this is the first batch.
80
+ var computedIsZero = IsZero()(isFirstBatch);
81
+
82
+ // isFirstCommitment is 0 if this is the first batch, currentTallyCommitment should be 0 if this is the first batch.
83
+ // isFirstCommitment is 1 if this is not the first batch, currentTallyCommitment should not be 0 if this is the first batch.
84
+ signal isFirstCommitment;
85
+ isFirstCommitment <== computedIsZero * computedCurrentTallyCommitment;
86
+ isFirstCommitment === currentTallyCommitment;
87
+
88
+ // Compute the root of the new results.
89
+ var computedNewResultsRoot = QuinaryCheckRoot(voteOptionTreeDepth)(newResults);
90
+ var computedNewResultsCommitment = PoseidonHasher(2)([computedNewResultsRoot, newResultsRootSalt]);
91
+
92
+ // Compute the commitment to the new spent voice credits value.
93
+ var computedNewSpentVoiceCreditsCommitment = PoseidonHasher(2)([newSpentVoiceCreditSubtotal, newSpentVoiceCreditSubtotalSalt]);
94
+
95
+ // Compute the root of the spent voice credits per vote option.
96
+ var computedNewPerVoteOptionSpentVoiceCreditsRoot = QuinaryCheckRoot(voteOptionTreeDepth)(newPerVoteOptionSpentVoiceCredits);
97
+ var computedNewPerVoteOptionSpentVoiceCreditsCommitment = PoseidonHasher(2)([computedNewPerVoteOptionSpentVoiceCreditsRoot, newPerVoteOptionSpentVoiceCreditsRootSalt]);
98
+
99
+ // Commit to the new tally.
100
+ var computedNewTallyCommitment = PoseidonHasher(3)([
101
+ computedNewResultsCommitment,
102
+ computedNewSpentVoiceCreditsCommitment,
103
+ computedNewPerVoteOptionSpentVoiceCreditsCommitment
104
+ ]);
105
+
106
+ computedNewTallyCommitment === newTallyCommitment;
107
+ }
@@ -102,4 +102,9 @@ template StateLeafAndBallotTransformer() {
102
102
  isValid <== computedIsValid;
103
103
  isStateLeafIndexValid <== computedIsStateLeafIndexValid;
104
104
  isVoteOptionIndexValid <== computedIsVoteOptionIndexValid;
105
+
106
+ // Constrain commandPollId and commandSalt using dummy squares.
107
+ // This binds the proof to a specific poll and salt.
108
+ signal commandPollIdSquare <== commandPollId * commandPollId;
109
+ signal commandSaltSquared <== commandSalt * commandSalt;
105
110
  }