@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.
- package/README.md +2 -2
- package/build/ts/types.d.ts +7 -7
- package/build/ts/types.d.ts.map +1 -1
- package/build/tsconfig.build.tsbuildinfo +1 -1
- package/circom/circuits.json +28 -12
- package/circom/coordinator/full/MessageProcessor.circom +253 -0
- package/circom/coordinator/full/SingleMessageProcessor.circom +203 -0
- package/circom/coordinator/non-qv/{processMessages.circom → MessageProcessor.circom} +12 -206
- package/circom/coordinator/non-qv/SingleMessageProcessor.circom +199 -0
- package/circom/coordinator/non-qv/{tallyVotes.circom → VoteTally.circom} +22 -99
- package/circom/coordinator/qv/{processMessages.circom → MessageProcessor.circom} +13 -214
- package/circom/coordinator/qv/SingleMessageProcessor.circom +207 -0
- package/circom/coordinator/qv/VoteTally.circom +179 -0
- package/circom/coordinator/qv/VoteTallyWithIndividualCounts.circom +226 -0
- package/circom/utils/CalculateTotal.circom +6 -6
- package/circom/utils/PrivateToPublicKey.circom +3 -3
- package/circom/utils/full/MessageValidator.circom +91 -0
- package/circom/utils/full/StateLeafAndBallotTransformer.circom +122 -0
- package/circom/utils/non-qv/MessageValidator.circom +4 -4
- package/circom/utils/non-qv/ResultCommitmentVerifier.circom +84 -0
- package/circom/utils/non-qv/StateLeafAndBallotTransformer.circom +7 -7
- package/circom/utils/qv/MessageValidator.circom +4 -4
- package/circom/utils/qv/ResultCommitmentVerifier.circom +107 -0
- package/circom/utils/qv/StateLeafAndBallotTransformer.circom +7 -7
- package/circom/utils/trees/BinaryMerkleRoot.circom +6 -3
- package/circom/utils/trees/LeafExists.circom +2 -2
- package/circom/utils/trees/MerkleTreeInclusionProof.circom +4 -4
- package/circom/utils/trees/QuinaryCheckRoot.circom +54 -0
- package/circom/utils/trees/{MerklePathIndicesGenerator.circom → QuinaryGeneratePathIndices.circom} +18 -18
- package/circom/utils/trees/QuinaryLeafExists.circom +30 -0
- package/circom/utils/trees/QuinarySelector.circom +42 -0
- package/circom/utils/trees/QuinaryTreeInclusionProof.circom +55 -0
- package/circom/utils/trees/Splicer.circom +76 -0
- package/circom/voter/PollJoined.circom +5 -5
- package/circom/voter/PollJoining.circom +3 -3
- package/package.json +15 -13
- package/circom/coordinator/qv/tallyVotes.circom +0 -279
- package/circom/utils/trees/incrementalQuinaryTree.circom +0 -287
|
@@ -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
|
+
}
|
|
@@ -47,9 +47,9 @@ template StateLeafAndBallotTransformer() {
|
|
|
47
47
|
signal input commandPollId;
|
|
48
48
|
// Salt.
|
|
49
49
|
signal input commandSalt;
|
|
50
|
-
//
|
|
50
|
+
// EdDSA signature of the command (R part).
|
|
51
51
|
signal input commandSignaturePoint[2];
|
|
52
|
-
//
|
|
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 StateLeafAndBallotTransformer() {
|
|
|
68
68
|
signal output isVoteOptionIndexValid;
|
|
69
69
|
|
|
70
70
|
// Check if the command / message is valid.
|
|
71
|
-
var (
|
|
71
|
+
var (computedIsValid, computedIsStateLeafIndexValid, computedIsVoteOptionIndexValid) = MessageValidator()(
|
|
72
72
|
commandStateIndex,
|
|
73
73
|
totalSignups,
|
|
74
74
|
commandVoteOptionIndex,
|
|
@@ -87,19 +87,19 @@ template StateLeafAndBallotTransformer() {
|
|
|
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]],
|
|
91
|
-
var computedNewstateLeafPublicKey1Mux = Mux1()([stateLeafPublicKey[1], commandPublicKey[1]],
|
|
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],
|
|
98
|
+
var computedNewBallotNonceMux = Mux1()([ballotNonce, commandNonce], computedIsValid);
|
|
99
99
|
|
|
100
100
|
newBallotNonce <== computedNewBallotNonceMux;
|
|
101
101
|
|
|
102
|
-
isValid <==
|
|
102
|
+
isValid <== computedIsValid;
|
|
103
103
|
isStateLeafIndexValid <== computedIsStateLeafIndexValid;
|
|
104
104
|
isVoteOptionIndexValid <== computedIsVoteOptionIndexValid;
|
|
105
105
|
}
|
|
@@ -7,7 +7,7 @@ include "./comparators.circom";
|
|
|
7
7
|
include "../PoseidonHasher.circom";
|
|
8
8
|
|
|
9
9
|
// @note taken from @zk-kit/circuits
|
|
10
|
-
// if used directly in
|
|
10
|
+
// if used directly in MessageProcessor circom complains about duplicated
|
|
11
11
|
// templates (Ark, Poseidon, etc.)
|
|
12
12
|
// This circuit is designed to calculate the root of a binary Merkle
|
|
13
13
|
// tree given a leaf, its depth, and the necessary sibling
|
|
@@ -25,14 +25,17 @@ template BinaryMerkleRoot(MAX_DEPTH) {
|
|
|
25
25
|
signal input leaf;
|
|
26
26
|
// The depth of the Merkle tree.
|
|
27
27
|
signal input depth;
|
|
28
|
-
// The
|
|
29
|
-
signal input
|
|
28
|
+
// The index of the leaf node in the Merkle tree.
|
|
29
|
+
signal input index;
|
|
30
30
|
// The sibling nodes of the leaf node in the Merkle tree.
|
|
31
31
|
signal input siblings[MAX_DEPTH][1];
|
|
32
32
|
|
|
33
33
|
// The output of the Merkle tree root.
|
|
34
34
|
signal output out;
|
|
35
35
|
|
|
36
|
+
// The indices of the leaf node in the Merkle tree.
|
|
37
|
+
signal indices[MAX_DEPTH] <== Num2Bits(MAX_DEPTH)(index);
|
|
38
|
+
|
|
36
39
|
signal nodes[MAX_DEPTH + 1];
|
|
37
40
|
nodes[0] <== leaf;
|
|
38
41
|
|
|
@@ -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
|
|
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
|
-
|
|
22
|
+
path_indices,
|
|
23
23
|
path_elements
|
|
24
24
|
);
|
|
25
25
|
|
|
@@ -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
|
|
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
|
|
29
|
-
|
|
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
|
-
|
|
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
|
+
}
|
package/circom/utils/trees/{MerklePathIndicesGenerator.circom → QuinaryGeneratePathIndices.circom}
RENAMED
|
@@ -1,44 +1,44 @@
|
|
|
1
1
|
pragma circom 2.0.0;
|
|
2
2
|
|
|
3
|
-
// zk-kit
|
|
3
|
+
// zk-kit import
|
|
4
4
|
include "./safe-comparators.circom";
|
|
5
|
-
// local
|
|
5
|
+
// local imports
|
|
6
6
|
include "../CalculateTotal.circom";
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* Calculates the path indices required for Merkle proof verifications.
|
|
10
|
-
* Given a node index within an
|
|
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
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].
|
|
12
13
|
*/
|
|
13
|
-
template
|
|
14
|
-
// The
|
|
15
|
-
var
|
|
14
|
+
template QuinaryGeneratePathIndices(levels) {
|
|
15
|
+
// The number of leaves per node (tree arity)
|
|
16
|
+
var LEAVES_PER_NODE = 5;
|
|
16
17
|
|
|
17
|
-
// The
|
|
18
|
-
signal input
|
|
19
|
-
|
|
20
|
-
// The generated path indices.
|
|
18
|
+
// The index within the tree
|
|
19
|
+
signal input index;
|
|
20
|
+
// The generated path indices leading to the node of the provided index
|
|
21
21
|
signal output out[levels];
|
|
22
22
|
|
|
23
|
-
var
|
|
23
|
+
var indexModulus = index;
|
|
24
24
|
var computedResults[levels];
|
|
25
25
|
|
|
26
26
|
for (var i = 0; i < levels; i++) {
|
|
27
27
|
// circom's best practices suggests to avoid using <-- unless you
|
|
28
28
|
// are aware of what's going on. This is the only way to do modulo operation.
|
|
29
|
-
out[i] <--
|
|
30
|
-
|
|
29
|
+
out[i] <-- indexModulus % LEAVES_PER_NODE;
|
|
30
|
+
indexModulus = indexModulus \ LEAVES_PER_NODE;
|
|
31
31
|
|
|
32
32
|
// Check that each output element is less than the base.
|
|
33
|
-
var computedIsOutputElementLessThanBase = SafeLessThan(3)([out[i],
|
|
33
|
+
var computedIsOutputElementLessThanBase = SafeLessThan(3)([out[i], LEAVES_PER_NODE]);
|
|
34
34
|
computedIsOutputElementLessThanBase === 1;
|
|
35
35
|
|
|
36
36
|
// Re-compute the total sum.
|
|
37
|
-
computedResults[i] = out[i] * (
|
|
37
|
+
computedResults[i] = out[i] * (LEAVES_PER_NODE ** i);
|
|
38
38
|
}
|
|
39
39
|
|
|
40
40
|
// Check that the total sum matches the index.
|
|
41
41
|
var computedCalculateTotal = CalculateTotal(levels)(computedResults);
|
|
42
42
|
|
|
43
|
-
computedCalculateTotal ===
|
|
44
|
-
}
|
|
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
|
+
}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
pragma circom 2.0.0;
|
|
2
|
+
|
|
3
|
+
// circomlib imports
|
|
4
|
+
include "./mux1.circom";
|
|
5
|
+
// zk-kit import
|
|
6
|
+
include "./safe-comparators.circom";
|
|
7
|
+
// local imports
|
|
8
|
+
include "./QuinarySelector.circom";
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* The output array contains the input items, with the leaf inserted at the
|
|
12
|
+
* specified index. For example, if input = [0, 20, 30, 40], index = 3, and
|
|
13
|
+
* leaf = 10, the output will be [0, 20, 30, 10, 40].
|
|
14
|
+
*/
|
|
15
|
+
template Splicer(numItems) {
|
|
16
|
+
// The number of output items (because only one item is inserted).
|
|
17
|
+
var NUM_OUTPUT_ITEMS = numItems + 1;
|
|
18
|
+
|
|
19
|
+
// The input items to splice.
|
|
20
|
+
signal input in[numItems];
|
|
21
|
+
// The leaf to insert.
|
|
22
|
+
signal input leaf;
|
|
23
|
+
// The index at which to insert the leaf.
|
|
24
|
+
signal input index;
|
|
25
|
+
// The output array containing the spliced items.
|
|
26
|
+
signal output out[NUM_OUTPUT_ITEMS];
|
|
27
|
+
|
|
28
|
+
// There is a loop where the goal is to assign values to the output signal.
|
|
29
|
+
//
|
|
30
|
+
// | output[0] | output[1] | output[2] | ...
|
|
31
|
+
//
|
|
32
|
+
// We can either assign the leaf, or an item from the `items` signal, to the output, using Mux1().
|
|
33
|
+
// The Mux1's selector is 0 or 1 depending on whether the index is equal to the loop counter.
|
|
34
|
+
//
|
|
35
|
+
// i --> [IsEqual] <-- index
|
|
36
|
+
// |
|
|
37
|
+
// v
|
|
38
|
+
// leaf --> [Mux1] <-- <item from in>
|
|
39
|
+
// |
|
|
40
|
+
// v
|
|
41
|
+
// output[m]
|
|
42
|
+
//
|
|
43
|
+
// To obtain the value from <item from in>, we need to compute an item
|
|
44
|
+
// index (let it be `s`).
|
|
45
|
+
// 1. if index = 2 and i = 0, then s = 0
|
|
46
|
+
// 2. if index = 2 and i = 1, then s = 1
|
|
47
|
+
// 3. if index = 2 and i = 2, then s = 2
|
|
48
|
+
// 4. if index = 2 and i = 3, then s = 2
|
|
49
|
+
// 5. if index = 2 and i = 4, then s = 3
|
|
50
|
+
// We then wire `s`, as well as each item in `in` to a QuinarySelector.
|
|
51
|
+
// The output signal from the QuinarySelector is <item from in> and gets
|
|
52
|
+
// wired to Mux1 (as above).
|
|
53
|
+
|
|
54
|
+
var inputs[NUM_OUTPUT_ITEMS];
|
|
55
|
+
|
|
56
|
+
for (var i = 0; i < numItems; i++) {
|
|
57
|
+
inputs[i] = in[i];
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
inputs[NUM_OUTPUT_ITEMS - 1] = 0;
|
|
61
|
+
|
|
62
|
+
for (var i = 0; i < NUM_OUTPUT_ITEMS; i++) {
|
|
63
|
+
// Determines if current index is greater than the insertion index.
|
|
64
|
+
var computedIsIndexAfterInsertPoint = SafeGreaterThan(3)([i, index]);
|
|
65
|
+
|
|
66
|
+
// Calculates correct index for original items, adjusting for leaf insertion.
|
|
67
|
+
var computedAdjustedIndex = i - computedIsIndexAfterInsertPoint;
|
|
68
|
+
|
|
69
|
+
// Selects item from the original array or the leaf for insertion.
|
|
70
|
+
var computedQuinarySelected = QuinarySelector(NUM_OUTPUT_ITEMS)(inputs, computedAdjustedIndex);
|
|
71
|
+
var computedIsIndexEqual = IsEqual()([index, i]);
|
|
72
|
+
var mux = Mux1()([computedQuinarySelected, leaf], computedIsIndexEqual);
|
|
73
|
+
|
|
74
|
+
out[i] <== mux;
|
|
75
|
+
}
|
|
76
|
+
}
|
|
@@ -19,8 +19,8 @@ template PollJoined(stateTreeDepth) {
|
|
|
19
19
|
signal input voiceCreditsBalance;
|
|
20
20
|
// Path elements
|
|
21
21
|
signal input pathElements[stateTreeDepth][STATE_TREE_ARITY - 1];
|
|
22
|
-
//
|
|
23
|
-
signal input
|
|
22
|
+
// Index
|
|
23
|
+
signal input index;
|
|
24
24
|
// Poll State tree root which proves the user is joined
|
|
25
25
|
signal input stateRoot;
|
|
26
26
|
// The actual tree depth (might be <= stateTreeDepth) Used in BinaryMerkleRoot
|
|
@@ -32,12 +32,12 @@ template PollJoined(stateTreeDepth) {
|
|
|
32
32
|
var stateLeaf = PoseidonHasher(3)([derivedPublicKey[0], derivedPublicKey[1], voiceCreditsBalance]);
|
|
33
33
|
|
|
34
34
|
// Inclusion proof
|
|
35
|
-
var
|
|
35
|
+
var calculatedRoot = BinaryMerkleRoot(stateTreeDepth)(
|
|
36
36
|
stateLeaf,
|
|
37
37
|
actualStateTreeDepth,
|
|
38
|
-
|
|
38
|
+
index,
|
|
39
39
|
pathElements
|
|
40
40
|
);
|
|
41
41
|
|
|
42
|
-
|
|
42
|
+
calculatedRoot === stateRoot;
|
|
43
43
|
}
|
|
@@ -18,8 +18,8 @@ template PollJoining(stateTreeDepth) {
|
|
|
18
18
|
signal input pollPublicKey[2];
|
|
19
19
|
// Siblings
|
|
20
20
|
signal input siblings[stateTreeDepth][STATE_TREE_ARITY - 1];
|
|
21
|
-
//
|
|
22
|
-
signal input
|
|
21
|
+
// Index
|
|
22
|
+
signal input index;
|
|
23
23
|
// User's hashed private key
|
|
24
24
|
signal input nullifier;
|
|
25
25
|
// MACI State tree root which proves the user is signed up
|
|
@@ -46,7 +46,7 @@ template PollJoining(stateTreeDepth) {
|
|
|
46
46
|
var calculatedRoot = BinaryMerkleRoot(stateTreeDepth)(
|
|
47
47
|
publicKeyHash,
|
|
48
48
|
actualStateTreeDepth,
|
|
49
|
-
|
|
49
|
+
index,
|
|
50
50
|
siblings
|
|
51
51
|
);
|
|
52
52
|
|