@maci-protocol/core 0.0.0-ci.e0aedb2 → 0.0.0-ci.e2759dd
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/LICENSE +1 -2
- package/build/ts/MaciState.d.ts +9 -7
- package/build/ts/MaciState.d.ts.map +1 -1
- package/build/ts/MaciState.js +21 -20
- package/build/ts/MaciState.js.map +1 -1
- package/build/ts/Poll.d.ts +50 -42
- package/build/ts/Poll.d.ts.map +1 -1
- package/build/ts/Poll.js +274 -311
- package/build/ts/Poll.js.map +1 -1
- package/build/ts/index.d.ts +3 -2
- package/build/ts/index.d.ts.map +1 -1
- package/build/ts/index.js +11 -9
- package/build/ts/index.js.map +1 -1
- package/build/ts/utils/constants.d.ts +9 -0
- package/build/ts/utils/constants.d.ts.map +1 -1
- package/build/ts/utils/constants.js +11 -1
- package/build/ts/utils/constants.js.map +1 -1
- package/build/ts/utils/errors.d.ts +2 -1
- package/build/ts/utils/errors.d.ts.map +1 -1
- package/build/ts/utils/errors.js +1 -0
- package/build/ts/utils/errors.js.map +1 -1
- package/build/ts/utils/types.d.ts +61 -36
- package/build/ts/utils/types.d.ts.map +1 -1
- package/build/ts/utils/utils.d.ts +16 -16
- package/build/ts/utils/utils.d.ts.map +1 -1
- package/build/ts/utils/utils.js +21 -21
- package/build/ts/utils/utils.js.map +1 -1
- package/build/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +9 -7
package/LICENSE
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
MIT License
|
|
2
2
|
|
|
3
|
-
Copyright (c)
|
|
4
|
-
Cory Dickson, Han Jian, Chih-Cheng Liang, and Koh Wei Jie
|
|
3
|
+
Copyright (c) 2025 Ethereum Foundation
|
|
5
4
|
|
|
6
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
7
6
|
of this software and associated documentation files (the "Software"), to deal
|
package/build/ts/MaciState.d.ts
CHANGED
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
import { IncrementalQuinTree } from "@maci-protocol/crypto";
|
|
2
|
-
import {
|
|
3
|
-
import type { IJsonMaciState, IMaciState,
|
|
2
|
+
import { PublicKey, type Keypair } from "@maci-protocol/domainobjs";
|
|
3
|
+
import type { IJsonMaciState, IMaciState, ITreeDepths } from "./utils/types";
|
|
4
4
|
import { Poll } from "./Poll";
|
|
5
|
+
import { EMode } from "./utils/constants";
|
|
5
6
|
/**
|
|
6
7
|
* A representation of the MACI contract.
|
|
7
8
|
*/
|
|
8
9
|
export declare class MaciState implements IMaciState {
|
|
9
10
|
polls: Map<bigint, Poll>;
|
|
10
|
-
|
|
11
|
+
publicKeys: PublicKey[];
|
|
11
12
|
stateTreeDepth: number;
|
|
12
13
|
stateTree?: IncrementalQuinTree;
|
|
13
|
-
|
|
14
|
+
totalSignups: number;
|
|
14
15
|
pollBeingProcessed?: boolean;
|
|
15
16
|
currentPollBeingProcessed?: bigint;
|
|
16
17
|
/**
|
|
@@ -20,10 +21,10 @@ export declare class MaciState implements IMaciState {
|
|
|
20
21
|
constructor(stateTreeDepth: number);
|
|
21
22
|
/**
|
|
22
23
|
* Sign up a user with the given public key.
|
|
23
|
-
* @param
|
|
24
|
+
* @param publicKey - The public key of the user.
|
|
24
25
|
* @returns The index of the newly signed-up user in the state tree.
|
|
25
26
|
*/
|
|
26
|
-
signUp(
|
|
27
|
+
signUp(publicKey: PublicKey): number;
|
|
27
28
|
/**
|
|
28
29
|
* Deploy a new poll with the given parameters.
|
|
29
30
|
* @param pollEndTimestamp - The Unix timestamp at which the poll ends.
|
|
@@ -31,9 +32,10 @@ export declare class MaciState implements IMaciState {
|
|
|
31
32
|
* @param messageBatchSize - The batch size for processing messages.
|
|
32
33
|
* @param coordinatorKeypair - The keypair of the MACI round coordinator.
|
|
33
34
|
* @param voteOptions - The number of vote options for this poll.
|
|
35
|
+
* @param mode - The voting mode
|
|
34
36
|
* @returns The index of the newly deployed poll.
|
|
35
37
|
*/
|
|
36
|
-
deployPoll(pollEndTimestamp: bigint, treeDepths:
|
|
38
|
+
deployPoll(pollEndTimestamp: bigint, treeDepths: ITreeDepths, messageBatchSize: number, coordinatorKeypair: Keypair, voteOptions: bigint, mode: EMode): bigint;
|
|
37
39
|
/**
|
|
38
40
|
* Deploy a null poll.
|
|
39
41
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"MaciState.d.ts","sourceRoot":"","sources":["../../ts/MaciState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"MaciState.d.ts","sourceRoot":"","sources":["../../ts/MaciState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,KAAK,OAAO,EAAU,MAAM,2BAA2B,CAAC;AAE5E,OAAO,KAAK,EAAE,cAAc,EAAa,UAAU,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAExF,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,KAAK,EAAoB,MAAM,mBAAmB,CAAC;AAE5D;;GAEG;AACH,qBAAa,SAAU,YAAW,UAAU;IAE1C,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAA2B;IAGnD,UAAU,EAAE,SAAS,EAAE,CAAM;IAG7B,cAAc,EAAE,MAAM,CAAC;IAGvB,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAEhC,YAAY,SAAK;IAGjB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;OAGG;gBACS,cAAc,EAAE,MAAM;IAUlC;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM;IAOpC;;;;;;;;;OASG;IACH,UAAU,CACR,gBAAgB,EAAE,MAAM,EACxB,UAAU,EAAE,WAAW,EACvB,gBAAgB,EAAE,MAAM,EACxB,kBAAkB,EAAE,OAAO,EAC3B,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,KAAK,GACV,MAAM;IAkBT;;OAEG;IACH,cAAc,IAAI,IAAI;IAItB;;;OAGG;IACH,IAAI,QAAO,SAAS,CAQlB;IAEF;;;;OAIG;IACH,MAAM,GAAI,GAAG,SAAS,KAAG,OAAO,CAsB9B;IAEF;;;OAGG;IACH,MAAM,IAAI,cAAc;IAWxB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,SAAS;CAgBjD"}
|
package/build/ts/MaciState.js
CHANGED
|
@@ -16,15 +16,15 @@ class MaciState {
|
|
|
16
16
|
// a MaciState can hold multiple polls
|
|
17
17
|
this.polls = new Map();
|
|
18
18
|
// the public keys of the users
|
|
19
|
-
this.
|
|
20
|
-
this.
|
|
19
|
+
this.publicKeys = [];
|
|
20
|
+
this.totalSignups = 0;
|
|
21
21
|
/**
|
|
22
22
|
* Create a deep copy of the MaciState object.
|
|
23
23
|
* @returns A new instance of the MaciState object with the same properties.
|
|
24
24
|
*/
|
|
25
25
|
this.copy = () => {
|
|
26
26
|
const copied = new MaciState(this.stateTreeDepth);
|
|
27
|
-
copied.
|
|
27
|
+
copied.publicKeys = this.publicKeys.map((x) => x.copy());
|
|
28
28
|
copied.polls = new Map(Array.from(this.polls, ([key, value]) => [key, value.copy()]));
|
|
29
29
|
return copied;
|
|
30
30
|
};
|
|
@@ -36,7 +36,7 @@ class MaciState {
|
|
|
36
36
|
this.equals = (m) => {
|
|
37
37
|
const result = this.stateTreeDepth === m.stateTreeDepth &&
|
|
38
38
|
this.polls.size === m.polls.size &&
|
|
39
|
-
this.
|
|
39
|
+
this.publicKeys.length === m.publicKeys.length;
|
|
40
40
|
if (!result) {
|
|
41
41
|
return false;
|
|
42
42
|
}
|
|
@@ -45,8 +45,8 @@ class MaciState {
|
|
|
45
45
|
return false;
|
|
46
46
|
}
|
|
47
47
|
}
|
|
48
|
-
for (let i = 0; i < this.
|
|
49
|
-
if (!this.
|
|
48
|
+
for (let i = 0; i < this.publicKeys.length; i += 1) {
|
|
49
|
+
if (!this.publicKeys[i].equals(m.publicKeys[i])) {
|
|
50
50
|
return false;
|
|
51
51
|
}
|
|
52
52
|
}
|
|
@@ -54,20 +54,20 @@ class MaciState {
|
|
|
54
54
|
};
|
|
55
55
|
this.stateTreeDepth = stateTreeDepth;
|
|
56
56
|
// we put a blank state leaf to prevent a DoS attack
|
|
57
|
-
this.
|
|
57
|
+
this.publicKeys.push(domainobjs_1.padKey);
|
|
58
58
|
// we need to increase the number of signups by one given
|
|
59
59
|
// that we already added the blank leaf
|
|
60
|
-
this.
|
|
60
|
+
this.totalSignups += 1;
|
|
61
61
|
}
|
|
62
62
|
/**
|
|
63
63
|
* Sign up a user with the given public key.
|
|
64
|
-
* @param
|
|
64
|
+
* @param publicKey - The public key of the user.
|
|
65
65
|
* @returns The index of the newly signed-up user in the state tree.
|
|
66
66
|
*/
|
|
67
|
-
signUp(
|
|
68
|
-
this.
|
|
69
|
-
this.stateTree?.insert(
|
|
70
|
-
return this.
|
|
67
|
+
signUp(publicKey) {
|
|
68
|
+
this.totalSignups += 1;
|
|
69
|
+
this.stateTree?.insert(publicKey.hash());
|
|
70
|
+
return this.publicKeys.push(publicKey.copy()) - 1;
|
|
71
71
|
}
|
|
72
72
|
/**
|
|
73
73
|
* Deploy a new poll with the given parameters.
|
|
@@ -76,13 +76,14 @@ class MaciState {
|
|
|
76
76
|
* @param messageBatchSize - The batch size for processing messages.
|
|
77
77
|
* @param coordinatorKeypair - The keypair of the MACI round coordinator.
|
|
78
78
|
* @param voteOptions - The number of vote options for this poll.
|
|
79
|
+
* @param mode - The voting mode
|
|
79
80
|
* @returns The index of the newly deployed poll.
|
|
80
81
|
*/
|
|
81
|
-
deployPoll(pollEndTimestamp, treeDepths, messageBatchSize, coordinatorKeypair, voteOptions) {
|
|
82
|
+
deployPoll(pollEndTimestamp, treeDepths, messageBatchSize, coordinatorKeypair, voteOptions, mode) {
|
|
82
83
|
const poll = new Poll_1.Poll(pollEndTimestamp, coordinatorKeypair, treeDepths, {
|
|
83
84
|
messageBatchSize,
|
|
84
|
-
tallyBatchSize: constants_1.STATE_TREE_ARITY ** treeDepths.
|
|
85
|
-
}, this, voteOptions);
|
|
85
|
+
tallyBatchSize: constants_1.STATE_TREE_ARITY ** treeDepths.tallyProcessingStateTreeDepth,
|
|
86
|
+
}, this, voteOptions, mode);
|
|
86
87
|
this.polls.set(BigInt(this.polls.size), poll);
|
|
87
88
|
return BigInt(this.polls.size - 1);
|
|
88
89
|
}
|
|
@@ -100,10 +101,10 @@ class MaciState {
|
|
|
100
101
|
return {
|
|
101
102
|
stateTreeDepth: this.stateTreeDepth,
|
|
102
103
|
polls: Array.from(this.polls.values()).map((poll) => poll.toJSON()),
|
|
103
|
-
|
|
104
|
+
publicKeys: this.publicKeys.map((publicKey) => publicKey.toJSON()),
|
|
104
105
|
pollBeingProcessed: Boolean(this.pollBeingProcessed),
|
|
105
106
|
currentPollBeingProcessed: this.currentPollBeingProcessed ? this.currentPollBeingProcessed.toString() : "",
|
|
106
|
-
|
|
107
|
+
totalSignups: this.totalSignups,
|
|
107
108
|
};
|
|
108
109
|
}
|
|
109
110
|
/**
|
|
@@ -114,10 +115,10 @@ class MaciState {
|
|
|
114
115
|
static fromJSON(json) {
|
|
115
116
|
const maciState = new MaciState(json.stateTreeDepth);
|
|
116
117
|
// assign the json values to the new instance
|
|
117
|
-
maciState.
|
|
118
|
+
maciState.publicKeys = json.publicKeys.map((publicKey) => domainobjs_1.PublicKey.fromJSON(publicKey));
|
|
118
119
|
maciState.pollBeingProcessed = json.pollBeingProcessed;
|
|
119
120
|
maciState.currentPollBeingProcessed = BigInt(json.currentPollBeingProcessed);
|
|
120
|
-
maciState.
|
|
121
|
+
maciState.totalSignups = json.totalSignups;
|
|
121
122
|
// re-generate the polls and set the maci state reference
|
|
122
123
|
maciState.polls = new Map(json.polls.map((jsonPoll, index) => [BigInt(index), Poll_1.Poll.fromJSON(jsonPoll, maciState)]));
|
|
123
124
|
return maciState;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"MaciState.js","sourceRoot":"","sources":["../../ts/MaciState.ts"],"names":[],"mappings":";;;AACA,
|
|
1
|
+
{"version":3,"file":"MaciState.js","sourceRoot":"","sources":["../../ts/MaciState.ts"],"names":[],"mappings":";;;AACA,0DAA4E;AAI5E,iCAA8B;AAC9B,iDAA4D;AAE5D;;GAEG;AACH,MAAa,SAAS;IAoBpB;;;OAGG;IACH,YAAY,cAAsB;QAvBlC,sCAAsC;QACtC,UAAK,GAAsB,IAAI,GAAG,EAAgB,CAAC;QAEnD,+BAA+B;QAC/B,eAAU,GAAgB,EAAE,CAAC;QAQ7B,iBAAY,GAAG,CAAC,CAAC;QA2EjB;;;WAGG;QACH,SAAI,GAAG,GAAc,EAAE;YACrB,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAElD,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAY,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YAEpE,MAAM,CAAC,KAAK,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAEtF,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QAEF;;;;WAIG;QACH,WAAM,GAAG,CAAC,CAAY,EAAW,EAAE;YACjC,MAAM,MAAM,GACV,IAAI,CAAC,cAAc,KAAK,CAAC,CAAC,cAAc;gBACxC,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI;gBAChC,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;YAEjD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,KAAK,CAAC;YACf,CAAC;YAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC5C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAE,CAAC,EAAE,CAAC;oBAChE,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAChD,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QAxGA,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QAErC,oDAAoD;QACpD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,mBAAM,CAAC,CAAC;QAC7B,yDAAyD;QACzD,uCAAuC;QACvC,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAoB;QACzB,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC;QAEvB,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CACR,gBAAwB,EACxB,UAAuB,EACvB,gBAAwB,EACxB,kBAA2B,EAC3B,WAAmB,EACnB,IAAW;QAEX,MAAM,IAAI,GAAS,IAAI,WAAI,CACzB,gBAAgB,EAChB,kBAAkB,EAClB,UAAU,EACV;YACE,gBAAgB;YAChB,cAAc,EAAE,4BAAgB,IAAI,UAAU,CAAC,6BAA6B;SAC7E,EACD,IAAI,EACJ,WAAW,EACX,IAAI,CACL,CAAC;QAEF,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;QAC9C,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAuB,CAAC,CAAC;IACnE,CAAC;IA6CD;;;OAGG;IACH,MAAM;QACJ,OAAO;YACL,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACnE,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YAClE,kBAAkB,EAAE,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC;YACpD,yBAAyB,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE;YAC1G,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAoB;QAClC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAErD,6CAA6C;QAC7C,SAAS,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,sBAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QACzF,SAAS,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC;QACvD,SAAS,CAAC,yBAAyB,GAAG,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAC7E,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAE3C,yDAAyD;QACzD,SAAS,CAAC,KAAK,GAAG,IAAI,GAAG,CACvB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAmB,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,WAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CACpG,CAAC;QAEF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAvKD,8BAuKC"}
|
package/build/ts/Poll.d.ts
CHANGED
|
@@ -1,39 +1,39 @@
|
|
|
1
1
|
import { IncrementalQuinTree } from "@maci-protocol/crypto";
|
|
2
|
-
import {
|
|
2
|
+
import { VoteCommand, Keypair, Ballot, PublicKey, Message, StateLeaf } from "@maci-protocol/domainobjs";
|
|
3
3
|
import { LeanIMT } from "@zk-kit/lean-imt";
|
|
4
|
-
import type {
|
|
4
|
+
import type { ITreeDepths, IBatchSizes, IPoll, IJsonPoll, IProcessMessagesOutput, IVoteTallyCircuitInputs, IProcessMessagesCircuitInputs, IPollJoiningCircuitInputs, IJoiningCircuitArgs } from "./index";
|
|
5
5
|
import type { MaciState } from "./MaciState";
|
|
6
|
-
import type { IJoinedCircuitArgs, IPollJoinedCircuitInputs } from "./utils/types";
|
|
6
|
+
import type { IGetVoiceCreditsLeft, IJoinedCircuitArgs, IPollJoinedCircuitInputs } from "./utils/types";
|
|
7
|
+
import { EMode } from "./utils/constants";
|
|
7
8
|
/**
|
|
8
9
|
* A representation of the Poll contract.
|
|
9
10
|
*/
|
|
10
11
|
export declare class Poll implements IPoll {
|
|
11
12
|
coordinatorKeypair: Keypair;
|
|
12
|
-
treeDepths:
|
|
13
|
-
batchSizes:
|
|
13
|
+
treeDepths: ITreeDepths;
|
|
14
|
+
batchSizes: IBatchSizes;
|
|
14
15
|
voteOptions: bigint;
|
|
15
16
|
maxVoteOptions: number;
|
|
16
|
-
stateTreeDepth: number;
|
|
17
17
|
actualStateTreeDepth: number;
|
|
18
18
|
pollEndTimestamp: bigint;
|
|
19
19
|
ballots: Ballot[];
|
|
20
20
|
ballotTree?: IncrementalQuinTree;
|
|
21
21
|
messages: Message[];
|
|
22
|
-
commands:
|
|
23
|
-
|
|
22
|
+
commands: VoteCommand[];
|
|
23
|
+
encryptionPublicKeys: PublicKey[];
|
|
24
24
|
stateCopied: boolean;
|
|
25
|
-
|
|
25
|
+
publicKeys: PublicKey[];
|
|
26
26
|
stateTree?: LeanIMT;
|
|
27
|
-
|
|
27
|
+
totalBatchesProcessed: number;
|
|
28
28
|
currentMessageBatchIndex: number;
|
|
29
29
|
maciStateRef: MaciState;
|
|
30
30
|
pollId: bigint;
|
|
31
31
|
sbSalts: Record<number | string, bigint>;
|
|
32
32
|
resultRootSalts: Record<number | string, bigint>;
|
|
33
|
-
|
|
33
|
+
perVoteOptionSpentVoiceCreditsRootSalts: Record<number | string, bigint>;
|
|
34
34
|
spentVoiceCreditSubtotalSalts: Record<number | string, bigint>;
|
|
35
35
|
tallyResult: bigint[];
|
|
36
|
-
|
|
36
|
+
perVoteOptionSpentVoiceCredits: bigint[];
|
|
37
37
|
numBatchesTallied: number;
|
|
38
38
|
totalSpentVoiceCredits: bigint;
|
|
39
39
|
emptyBallot: Ballot;
|
|
@@ -43,7 +43,8 @@ export declare class Poll implements IPoll {
|
|
|
43
43
|
pollStateLeaves: StateLeaf[];
|
|
44
44
|
pollStateTree?: IncrementalQuinTree;
|
|
45
45
|
pollNullifiers: Map<bigint, boolean>;
|
|
46
|
-
private
|
|
46
|
+
private mode;
|
|
47
|
+
private totalSignups;
|
|
47
48
|
/**
|
|
48
49
|
* Constructs a new Poll object.
|
|
49
50
|
* @param pollEndTimestamp - The Unix timestamp at which the poll ends.
|
|
@@ -53,7 +54,7 @@ export declare class Poll implements IPoll {
|
|
|
53
54
|
* @param maciStateRef - The reference to the MACI state.
|
|
54
55
|
* @param pollId - The poll id
|
|
55
56
|
*/
|
|
56
|
-
constructor(pollEndTimestamp: bigint, coordinatorKeypair: Keypair, treeDepths:
|
|
57
|
+
constructor(pollEndTimestamp: bigint, coordinatorKeypair: Keypair, treeDepths: ITreeDepths, batchSizes: IBatchSizes, maciStateRef: MaciState, voteOptions: bigint, mode: EMode);
|
|
57
58
|
/**
|
|
58
59
|
* Check if user has already joined the poll by checking if the nullifier is registered
|
|
59
60
|
*/
|
|
@@ -61,37 +62,44 @@ export declare class Poll implements IPoll {
|
|
|
61
62
|
/**
|
|
62
63
|
* Join the anonymous user to the Poll (to the tree)
|
|
63
64
|
* @param nullifier - Hashed private key used as nullifier
|
|
64
|
-
* @param
|
|
65
|
+
* @param publicKey - The poll public key.
|
|
65
66
|
* @param newVoiceCreditBalance - New voice credit balance of the user.
|
|
66
67
|
* @returns The index of added state leaf
|
|
67
68
|
*/
|
|
68
|
-
joinPoll: (nullifier: bigint,
|
|
69
|
+
joinPoll: (nullifier: bigint, publicKey: PublicKey, newVoiceCreditBalance: bigint) => number;
|
|
69
70
|
/**
|
|
70
71
|
* Update a Poll with data from MaciState.
|
|
71
72
|
* This is the step where we copy the state from the MaciState instance,
|
|
72
73
|
* and set the number of signups we have so far.
|
|
73
|
-
* @note It should be called to generate the state for poll joining with
|
|
74
|
-
* the number of signups in the MaciState. For message processing, you should set
|
|
74
|
+
* @note It should be called to generate the state for poll joining with totalSignups set as
|
|
75
|
+
* the number of signups in the MaciState. For message processing, you should set totalSignups as
|
|
75
76
|
* the number of users who joined the poll.
|
|
76
77
|
*/
|
|
77
|
-
updatePoll: (
|
|
78
|
+
updatePoll: (totalSignups: bigint) => void;
|
|
78
79
|
/**
|
|
79
80
|
* Process one message.
|
|
80
81
|
* @param message - The message to process.
|
|
81
|
-
* @param
|
|
82
|
+
* @param encryptionPublicKey - The public key associated with the encryption private key.
|
|
82
83
|
* @returns A number of variables which will be used in the zk-SNARK circuit.
|
|
83
84
|
*/
|
|
84
|
-
processMessage: (message: Message,
|
|
85
|
+
processMessage: (message: Message, encryptionPublicKey: PublicKey) => IProcessMessagesOutput;
|
|
86
|
+
/**
|
|
87
|
+
* Get voice credits left for the voting command.
|
|
88
|
+
*
|
|
89
|
+
* @param args - arguments for getting voice credits
|
|
90
|
+
* @returns voice credits left
|
|
91
|
+
*/
|
|
92
|
+
getVoiceCreditsLeft({ stateLeaf, originalVoteWeight, newVoteWeight, mode }: IGetVoiceCreditsLeft): bigint;
|
|
85
93
|
/**
|
|
86
94
|
* Inserts a Message and the corresponding public key used to generate the
|
|
87
95
|
* ECDH shared key which was used to encrypt said message.
|
|
88
96
|
* @param message - The message to insert
|
|
89
|
-
* @param
|
|
97
|
+
* @param encryptionPublicKey - The public key used to encrypt the message
|
|
90
98
|
*/
|
|
91
|
-
publishMessage: (message: Message,
|
|
99
|
+
publishMessage: (message: Message, encryptionPublicKey: PublicKey) => void;
|
|
92
100
|
/**
|
|
93
101
|
* Updates message chain hash
|
|
94
|
-
* @param messageHash hash of message with
|
|
102
|
+
* @param messageHash hash of message with encryptionPublicKey
|
|
95
103
|
*/
|
|
96
104
|
updateChainHash: (messageHash: bigint) => void;
|
|
97
105
|
/**
|
|
@@ -99,13 +107,13 @@ export declare class Poll implements IPoll {
|
|
|
99
107
|
* @param args Poll joining circuit inputs
|
|
100
108
|
* @returns stringified circuit inputs
|
|
101
109
|
*/
|
|
102
|
-
joiningCircuitInputs: ({
|
|
110
|
+
joiningCircuitInputs: ({ maciPrivateKey, stateLeafIndex, pollPublicKey, }: IJoiningCircuitArgs) => IPollJoiningCircuitInputs;
|
|
103
111
|
/**
|
|
104
112
|
* Create circuit input for pollJoined
|
|
105
113
|
* @param args Poll joined circuit inputs
|
|
106
114
|
* @returns stringified circuit inputs
|
|
107
115
|
*/
|
|
108
|
-
joinedCircuitInputs: ({
|
|
116
|
+
joinedCircuitInputs: ({ maciPrivateKey, stateLeafIndex, voiceCreditsBalance, }: IJoinedCircuitArgs) => IPollJoinedCircuitInputs;
|
|
109
117
|
/**
|
|
110
118
|
* Pad last unclosed batch
|
|
111
119
|
*/
|
|
@@ -130,13 +138,13 @@ export declare class Poll implements IPoll {
|
|
|
130
138
|
* @param quiet - Whether to log errors or not
|
|
131
139
|
* @returns stringified circuit inputs
|
|
132
140
|
*/
|
|
133
|
-
processMessages: (pollId: bigint,
|
|
141
|
+
processMessages: (pollId: bigint, quiet?: boolean) => IProcessMessagesCircuitInputs;
|
|
134
142
|
/**
|
|
135
143
|
* Generates partial circuit inputs for processing a batch of messages
|
|
136
144
|
* @param index - The index of the partial batch.
|
|
137
145
|
* @returns stringified partial circuit inputs
|
|
138
146
|
*/
|
|
139
|
-
private
|
|
147
|
+
private generateProcessMessagesCircuitInputsPartial;
|
|
140
148
|
/**
|
|
141
149
|
* Process all messages. This function does not update the ballots or state
|
|
142
150
|
* leaves; rather, it copies and then updates them. This makes it possible
|
|
@@ -154,30 +162,30 @@ export declare class Poll implements IPoll {
|
|
|
154
162
|
hasUntalliedBallots: () => boolean;
|
|
155
163
|
/**
|
|
156
164
|
* This method tallies a ballots and updates the tally results.
|
|
157
|
-
*
|
|
165
|
+
*
|
|
166
|
+
* @returns the circuit inputs for the VoteTally circuit.
|
|
158
167
|
*/
|
|
159
|
-
tallyVotes: () =>
|
|
160
|
-
tallyVotesNonQv: () => ITallyCircuitInputs;
|
|
168
|
+
tallyVotes: () => IVoteTallyCircuitInputs;
|
|
161
169
|
/**
|
|
162
170
|
* This method generates a commitment to the total spent voice credits.
|
|
163
171
|
*
|
|
164
172
|
* This is the hash of the total spent voice credits and a salt, computed as Poseidon([totalCredits, _salt]).
|
|
165
173
|
* @param salt - The salt used in the hash function.
|
|
166
|
-
* @param
|
|
167
|
-
* @param
|
|
174
|
+
* @param ballotsToCount - The number of ballots to count for the calculation.
|
|
175
|
+
* @param mode - Voting mode, default is QV.
|
|
168
176
|
* @returns Returns the hash of the total spent voice credits and a salt, computed as Poseidon([totalCredits, _salt]).
|
|
169
177
|
*/
|
|
170
|
-
private
|
|
178
|
+
private generateSpentVoiceCreditSubtotalCommitment;
|
|
171
179
|
/**
|
|
172
180
|
* This method generates a commitment to the spent voice credits per vote option.
|
|
173
181
|
*
|
|
174
182
|
* This is the hash of the Merkle root of the spent voice credits per vote option and a salt, computed as Poseidon([root, _salt]).
|
|
175
183
|
* @param salt - The salt used in the hash function.
|
|
176
|
-
* @param
|
|
177
|
-
* @param
|
|
184
|
+
* @param ballotsToCount - The number of ballots to count for the calculation.
|
|
185
|
+
* @param mode - Voting mode, default is QV.
|
|
178
186
|
* @returns Returns the hash of the Merkle root of the spent voice credits per vote option and a salt, computed as Poseidon([root, _salt]).
|
|
179
187
|
*/
|
|
180
|
-
private
|
|
188
|
+
private generatePerVoteOptionSpentVoiceCreditsCommitment;
|
|
181
189
|
/**
|
|
182
190
|
* Create a deep copy of the Poll object.
|
|
183
191
|
* @returns A new instance of the Poll object with the same properties.
|
|
@@ -185,10 +193,10 @@ export declare class Poll implements IPoll {
|
|
|
185
193
|
copy: () => Poll;
|
|
186
194
|
/**
|
|
187
195
|
* Check if the Poll object is equal to another Poll object.
|
|
188
|
-
* @param
|
|
196
|
+
* @param poll - The Poll object to compare.
|
|
189
197
|
* @returns True if the two Poll objects are equal, false otherwise.
|
|
190
198
|
*/
|
|
191
|
-
equals: (
|
|
199
|
+
equals: (poll: Poll) => boolean;
|
|
192
200
|
/**
|
|
193
201
|
* Serialize the Poll object to a JSON object
|
|
194
202
|
* @returns a JSON object
|
|
@@ -208,13 +216,13 @@ export declare class Poll implements IPoll {
|
|
|
208
216
|
setCoordinatorKeypair: (serializedPrivateKey: string) => void;
|
|
209
217
|
/**
|
|
210
218
|
* Set the number of signups to match the ones from the contract
|
|
211
|
-
* @param
|
|
219
|
+
* @param totalSignups - the number of signups
|
|
212
220
|
*/
|
|
213
|
-
|
|
221
|
+
setTotalSignups: (totalSignups: bigint) => void;
|
|
214
222
|
/**
|
|
215
223
|
* Get the number of signups
|
|
216
224
|
* @returns The number of signups
|
|
217
225
|
*/
|
|
218
|
-
|
|
226
|
+
gettotalSignups: () => bigint;
|
|
219
227
|
}
|
|
220
228
|
//# sourceMappingURL=Poll.d.ts.map
|
package/build/ts/Poll.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Poll.d.ts","sourceRoot":"","sources":["../../ts/Poll.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EAYpB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,
|
|
1
|
+
{"version":3,"file":"Poll.d.ts","sourceRoot":"","sources":["../../ts/Poll.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EAYpB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,WAAW,EACX,OAAO,EACP,MAAM,EACN,SAAS,EAET,OAAO,EACP,SAAS,EAMV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,OAAO,EAAuB,MAAM,kBAAkB,CAAC;AAKhE,OAAO,KAAK,EAEV,WAAW,EACX,WAAW,EACX,KAAK,EACL,SAAS,EACT,sBAAsB,EACtB,uBAAuB,EACvB,6BAA6B,EAC7B,yBAAyB,EACzB,mBAAmB,EACpB,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAGxG,OAAO,EAAE,KAAK,EAA4C,MAAM,mBAAmB,CAAC;AAGpF;;GAEG;AACH,qBAAa,IAAK,YAAW,KAAK;IAGhC,kBAAkB,EAAE,OAAO,CAAC;IAE5B,UAAU,EAAE,WAAW,CAAC;IAExB,UAAU,EAAE,WAAW,CAAC;IAExB,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,EAAE,MAAM,CAAC;IAGvB,oBAAoB,EAAE,MAAM,CAAC;IAE7B,gBAAgB,EAAE,MAAM,CAAC;IAEzB,OAAO,EAAE,MAAM,EAAE,CAAM;IAEvB,UAAU,CAAC,EAAE,mBAAmB,CAAC;IAEjC,QAAQ,EAAE,OAAO,EAAE,CAAM;IAEzB,QAAQ,EAAE,WAAW,EAAE,CAAM;IAE7B,oBAAoB,EAAE,SAAS,EAAE,CAAM;IAEvC,WAAW,UAAS;IAEpB,UAAU,EAAE,SAAS,EAAE,CAAY;IAEnC,SAAS,CAAC,EAAE,OAAO,CAAC;IAGpB,qBAAqB,SAAK;IAE1B,wBAAwB,EAAE,MAAM,CAAC;IAEjC,YAAY,EAAE,SAAS,CAAC;IAExB,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,CAAM;IAE9C,eAAe,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,CAAM;IAEtD,uCAAuC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,CAAM;IAE9E,6BAA6B,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,CAAM;IAGpE,WAAW,EAAE,MAAM,EAAE,CAAM;IAE3B,8BAA8B,EAAE,MAAM,EAAE,CAAM;IAE9C,iBAAiB,SAAK;IAEtB,sBAAsB,SAAM;IAI5B,WAAW,EAAE,MAAM,CAAC;IAEpB,eAAe,CAAC,EAAE,MAAM,CAAC;IAGzB,SAAS,SAAwB;IAGjC,WAAW,WAA0B;IAGrC,eAAe,EAAE,SAAS,EAAE,CAAoB;IAGhD,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAGpC,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAErC,OAAO,CAAC,IAAI,CAAQ;IAGpB,OAAO,CAAC,YAAY,CAAM;IAE1B;;;;;;;;OAQG;gBAED,gBAAgB,EAAE,MAAM,EACxB,kBAAkB,EAAE,OAAO,EAC3B,UAAU,EAAE,WAAW,EACvB,UAAU,EAAE,WAAW,EACvB,YAAY,EAAE,SAAS,EACvB,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,KAAK;IA2Bb;;OAEG;IACH,SAAS,GAAI,WAAW,MAAM,KAAG,OAAO,CAA+C;IAEvF;;;;;;OAMG;IACH,QAAQ,GAAI,WAAW,MAAM,EAAE,WAAW,SAAS,EAAE,uBAAuB,MAAM,KAAG,MAAM,CAYzF;IAEF;;;;;;;OAOG;IACH,UAAU,GAAI,cAAc,MAAM,KAAG,IAAI,CAoDvC;IAEF;;;;;OAKG;IACH,cAAc,GAAI,SAAS,OAAO,EAAE,qBAAqB,SAAS,KAAG,sBAAsB,CAiHzF;IAEF;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,SAAS,EAAE,kBAAkB,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,oBAAoB,GAAG,MAAM;IA0BzG;;;;;OAKG;IACH,cAAc,GAAI,SAAS,OAAO,EAAE,qBAAqB,SAAS,KAAG,IAAI,CAiCvE;IAEF;;;OAGG;IACH,eAAe,GAAI,aAAa,MAAM,KAAG,IAAI,CAO3C;IAEF;;;;OAIG;IACH,oBAAoB,GAAI,oDAIrB,mBAAmB,KAAG,yBAAyB,CA2ChD;IAEF;;;;OAIG;IACH,mBAAmB,GAAI,0DAIpB,kBAAkB,KAAG,wBAAwB,CAuB9C;IAEF;;OAEG;IACH,YAAY,QAAO,IAAI,CAIrB;IAEF;;;;OAIG;IACH,sBAAsB,QAAO,OAAO,CAUlC;IAEF;;;;;;;;;;;;;OAaG;IACH,eAAe,GAAI,QAAQ,MAAM,EAAE,eAAY,KAAG,6BAA6B,CAyR7E;IAEF;;;;OAIG;IACH,OAAO,CAAC,2CAA2C,CAmFjD;IAEF;;;;;OAKG;IACH,kBAAkB,QAAO;QAAE,WAAW,EAAE,SAAS,EAAE,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAUtE;IAEF;;;OAGG;IACH,mBAAmB,QAAO,OAAO,CAAkF;IAEnH;;;;OAIG;IACH,UAAU,QAAO,uBAAuB,CAoMtC;IAEF;;;;;;;;OAQG;IACH,OAAO,CAAC,0CAA0C,CAmBhD;IAEF;;;;;;;;OAQG;IACH,OAAO,CAAC,gDAAgD,CAoBtD;IAEF;;;OAGG;IACH,IAAI,QAAO,IAAI,CAoEb;IAEF;;;;OAIG;IACH,MAAM,GAAI,MAAM,IAAI,KAAG,OAAO,CA2B5B;IAEF;;;OAGG;IACH,MAAM,IAAI,SAAS;IAyBnB;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI;IA8B5D;;;OAGG;IACH,qBAAqB,GAAI,sBAAsB,MAAM,KAAG,IAAI,CAE1D;IAEF;;;OAGG;IACH,eAAe,GAAI,cAAc,MAAM,KAAG,IAAI,CAE5C;IAEF;;;OAGG;IACH,eAAe,QAAO,MAAM,CAAsB;CACnD"}
|