@maci-protocol/sdk 0.0.0-ci.00107eb

package/build/ts/trees/stateTree.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateSignUpTreeFromKeys = exports.generateSignUpTreeWithEndKey = exports.generateSignUpTree = void 0;
+/* eslint-disable no-underscore-dangle */
+const typechain_types_1 = require("@maci-protocol/contracts/typechain-types");
+const crypto_1 = require("@maci-protocol/crypto");
+const domainobjs_1 = require("@maci-protocol/domainobjs");
+const lean_imt_1 = require("@zk-kit/lean-imt");
+const utils_1 = require("../utils/utils");
+/**
+ * Generate a State tree object from the events of a MACI smart contracts
+ * @param provider - the ethereum provider
+ * @param address - the address of the MACI contract
+ * @param fromBlock - the block number from which to start fetching events
+ * @param blocksPerRequest - the number of blocks to fetch in each request
+ * @param endBlock - the block number at which to stop fetching events
+ * @param sleepAmount - the amount of time to sleep between each request
+ * @returns State tree
+ */
+const generateSignUpTree = async ({ provider, address, fromBlock = 0, blocksPerRequest = 50, endBlock, sleepAmount, }) => {
+    const lastBlock = endBlock || (await provider.getBlockNumber());
+    const maciContract = typechain_types_1.MACI__factory.connect(address, provider);
+    const signUpTree = new lean_imt_1.LeanIMT(crypto_1.hashLeanIMT);
+    signUpTree.insert(crypto_1.PAD_KEY_HASH);
+    const publicKeys = [];
+    // Fetch event logs in batches (lastBlock inclusive)
+    for (let i = fromBlock; i <= lastBlock; i += blocksPerRequest + 1) {
+        // the last block batch will be either current iteration block + blockPerRequest
+        // or the end block if it is set
+        const toBlock = i + blocksPerRequest >= lastBlock ? lastBlock : i + blocksPerRequest;
+        // eslint-disable-next-line no-await-in-loop
+        const signUpLogs = await maciContract.queryFilter(maciContract.filters.SignUp(), i, toBlock);
+        signUpLogs.forEach((event) => {
+            const publicKeyX = event.args._userPublicKeyX;
+            const publicKeyY = event.args._userPublicKeyY;
+            const publicKey = new domainobjs_1.PublicKey([publicKeyX, publicKeyY]);
+            publicKeys.push(publicKey);
+            signUpTree.insert((0, crypto_1.hashLeftRight)(publicKeyX, publicKeyY));
+        });
+        if (sleepAmount) {
+            // eslint-disable-next-line no-await-in-loop
+            await (0, utils_1.sleep)(sleepAmount);
+        }
+    }
+    return {
+        signUpTree,
+        publicKeys,
+    };
+};
+exports.generateSignUpTree = generateSignUpTree;
+/**
+ * Generate a State tree object from the events of a MACI smart contracts
+ * @param provider - the ethereum provider
+ * @param address - the address of the MACI contract
+ * @param fromBlock - the block number from which to start fetching events
+ * @param blocksPerRequest - the number of blocks to fetch in each request
+ * @param endBlock - the block number at which to stop fetching events
+ * @param sleepAmount - the amount of time to sleep between each request
+ * @param userPublicKey - the user public key where we end/stop the signUpTree replica.
+ *        If user public key is 4th then the returned signUpTree will have only 4 leaves
+ *        (does not matter if MACI' signUpTree has more).
+ * @returns State tree
+ */
+const generateSignUpTreeWithEndKey = async ({ provider, address, fromBlock = 0, blocksPerRequest = 50, endBlock, sleepAmount, userPublicKey, }) => {
+    const lastBlock = endBlock || (await provider.getBlockNumber());
+    const maciContract = typechain_types_1.MACI__factory.connect(address, provider);
+    const signUpTree = new lean_imt_1.LeanIMT(crypto_1.hashLeanIMT);
+    signUpTree.insert(crypto_1.PAD_KEY_HASH);
+    const publicKeys = [];
+    // Fetch event logs in batches (lastBlock inclusive)
+    for (let i = fromBlock; i <= lastBlock; i += blocksPerRequest + 1) {
+        // the last block batch will be either current iteration block + blockPerRequest
+        // or the end block if it is set
+        const toBlock = i + blocksPerRequest >= lastBlock ? lastBlock : i + blocksPerRequest;
+        // eslint-disable-next-line no-await-in-loop
+        const signUpLogs = await maciContract.queryFilter(maciContract.filters.SignUp(), i, toBlock);
+        // eslint-disable-next-line @typescript-eslint/prefer-for-of
+        for (let j = 0; j < signUpLogs.length; j += 1) {
+            const event = signUpLogs[j];
+            const publicKeyX = event.args._userPublicKeyX;
+            const publicKeyY = event.args._userPublicKeyY;
+            const publicKey = new domainobjs_1.PublicKey([publicKeyX, publicKeyY]);
+            publicKeys.push(publicKey);
+            signUpTree.insert((0, crypto_1.hashLeftRight)(publicKeyX, publicKeyY));
+            // early return cause we found the user
+            if (publicKey.equals(userPublicKey)) {
+                return {
+                    signUpTree,
+                    publicKeys,
+                };
+            }
+        }
+        if (sleepAmount) {
+            // eslint-disable-next-line no-await-in-loop
+            await (0, utils_1.sleep)(sleepAmount);
+        }
+    }
+    return {
+        signUpTree,
+        publicKeys,
+    };
+};
+exports.generateSignUpTreeWithEndKey = generateSignUpTreeWithEndKey;
+/**
+ * Generate a sign up tree from the public keys
+ * @param publicKeys - the public keys to generate the sign up tree from
+ * @returns the sign up tree
+ */
+const generateSignUpTreeFromKeys = (publicKeys) => {
+    const signUpTree = new lean_imt_1.LeanIMT(crypto_1.hashLeanIMT);
+    publicKeys.forEach((key) => {
+        signUpTree.insert(key.hash());
+    });
+    return signUpTree;
+};
+exports.generateSignUpTreeFromKeys = generateSignUpTreeFromKeys;
+//# sourceMappingURL=stateTree.js.map

package/build/ts/trees/stateTree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stateTree.js","sourceRoot":"","sources":["../../../ts/trees/stateTree.ts"],"names":[],"mappings":";;;AAAA,yCAAyC;AACzC,8EAAwF;AACxF,kDAAiF;AACjF,0DAAsD;AACtD,+CAAqE;AAIrE,0CAAuC;AAEvC;;;;;;;;;GASG;AACI,MAAM,kBAAkB,GAAG,KAAK,EAAE,EACvC,QAAQ,EACR,OAAO,EACP,SAAS,GAAG,CAAC,EACb,gBAAgB,GAAG,EAAE,EACrB,QAAQ,EACR,WAAW,GACa,EAAgC,EAAE;IAC1D,MAAM,SAAS,GAAG,QAAQ,IAAI,CAAC,MAAM,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAC;IAEhE,MAAM,YAAY,GAAG,+BAAW,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5D,MAAM,UAAU,GAAG,IAAI,kBAAO,CAAC,oBAAkC,CAAC,CAAC;IACnE,UAAU,CAAC,MAAM,CAAC,qBAAY,CAAC,CAAC;IAChC,MAAM,UAAU,GAAgB,EAAE,CAAC;IAEnC,oDAAoD;IACpD,KAAK,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC,IAAI,SAAS,EAAE,CAAC,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;QAClE,gFAAgF;QAChF,gCAAgC;QAChC,MAAM,OAAO,GAAG,CAAC,GAAG,gBAAgB,IAAI,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC;QAErF,4CAA4C;QAC5C,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;QAC7F,UAAU,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3B,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC;YAC9C,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC;YAE9C,MAAM,SAAS,GAAG,IAAI,sBAAS,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;YAE1D,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC3B,UAAU,CAAC,MAAM,CAAC,IAAA,sBAAa,EAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,IAAI,WAAW,EAAE,CAAC;YAChB,4CAA4C;YAC5C,MAAM,IAAA,aAAK,EAAC,WAAW,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,OAAO;QACL,UAAU;QACV,UAAU;KACX,CAAC;AACJ,CAAC,CAAC;AA3CW,QAAA,kBAAkB,sBA2C7B;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,4BAA4B,GAAG,KAAK,EAAE,EACjD,QAAQ,EACR,OAAO,EACP,SAAS,GAAG,CAAC,EACb,gBAAgB,GAAG,EAAE,EACrB,QAAQ,EACR,WAAW,EACX,aAAa,GACqB,EAAgC,EAAE;IACpE,MAAM,SAAS,GAAG,QAAQ,IAAI,CAAC,MAAM,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAC;IAEhE,MAAM,YAAY,GAAG,+BAAW,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5D,MAAM,UAAU,GAAG,IAAI,kBAAO,CAAC,oBAAkC,CAAC,CAAC;IACnE,UAAU,CAAC,MAAM,CAAC,qBAAY,CAAC,CAAC;IAChC,MAAM,UAAU,GAAgB,EAAE,CAAC;IAEnC,oDAAoD;IACpD,KAAK,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC,IAAI,SAAS,EAAE,CAAC,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;QAClE,gFAAgF;QAChF,gCAAgC;QAChC,MAAM,OAAO,GAAG,CAAC,GAAG,gBAAgB,IAAI,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC;QAErF,4CAA4C;QAC5C,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;QAC7F,4DAA4D;QAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9C,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;YAC5B,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC;YAC9C,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC;YAE9C,MAAM,SAAS,GAAG,IAAI,sBAAS,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;YAE1D,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC3B,UAAU,CAAC,MAAM,CAAC,IAAA,sBAAa,EAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;YAEzD,uCAAuC;YACvC,IAAI,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;gBACpC,OAAO;oBACL,UAAU;oBACV,UAAU;iBACX,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,4CAA4C;YAC5C,MAAM,IAAA,aAAK,EAAC,WAAW,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,OAAO;QACL,UAAU;QACV,UAAU;KACX,CAAC;AACJ,CAAC,CAAC;AAtDW,QAAA,4BAA4B,gCAsDvC;AAEF;;;;GAIG;AACI,MAAM,0BAA0B,GAAG,CAAC,UAAuB,EAAW,EAAE;IAC7E,MAAM,UAAU,GAAG,IAAI,kBAAO,CAAC,oBAAW,CAAC,CAAC;IAC5C,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACzB,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IACH,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AANW,QAAA,0BAA0B,8BAMrC"}

package/build/ts/trees/types.d.ts

@@ -0,0 +1,55 @@
+import type { PublicKey } from "@maci-protocol/domainobjs";
+import type { LeanIMT } from "@zk-kit/lean-imt";
+import type { Provider } from "ethers";
+/**
+ * An interface that represents arguments of generation sign up tree and state leaves
+ */
+export interface IGenerateSignUpTreeArgs {
+    /**
+     * The etherum provider
+     */
+    provider: Provider;
+    /**
+     * The address of MACI contract
+     */
+    address: string;
+    /**
+     * The block number from which to start fetching events
+     */
+    fromBlock?: number;
+    /**
+     * The number of blocks to fetch in each request
+     */
+    blocksPerRequest?: number;
+    /**
+     * The block number at which to stop fetching events
+     */
+    endBlock?: number;
+    /**
+     * The amount of time to sleep between each request
+     */
+    sleepAmount?: number;
+}
+/**
+ * An interface that represents arguments of generation sign up tree which stops fetching at a given public key
+ */
+export interface IGenerateSignUpTreeWithEndKeyArgs extends IGenerateSignUpTreeArgs {
+    /**
+     * The public key of the user
+     */
+    userPublicKey: PublicKey;
+}
+/**
+ * An interface that represents sign up tree and state leaves
+ */
+export interface IGenerateSignUpTree {
+    /**
+     * Sign up tree
+     */
+    signUpTree: LeanIMT;
+    /**
+     * State leaves
+     */
+    publicKeys: PublicKey[];
+}
+//# sourceMappingURL=types.d.ts.map

package/build/ts/trees/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../ts/trees/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,iCAAkC,SAAQ,uBAAuB;IAChF;;OAEG;IACH,aAAa,EAAE,SAAS,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB"}

package/build/ts/trees/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/ts/trees/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../ts/trees/types.ts"],"names":[],"mappings":""}

package/build/ts/user/index.d.ts

@@ -0,0 +1,5 @@
+export { joinPoll } from "./joinPoll";
+export { getSignedupUserData, signup, hasUserSignedUp } from "./signup";
+export { getJoinedUserData, hasUserJoinedPoll, generateMaciStateTree, generateMaciStateTreeWithEndKey, getPollJoiningCircuitEvents, joiningCircuitInputs, } from "./utils";
+export type { IJoinedUserArgs, IIsRegisteredUser, IIsJoinedUser, ISignupArgs, IRegisteredUserArgs, IPollJoinedCircuitInputs, IPollJoiningCircuitInputs, IJoinPollArgs, IIsNullifierOnChainArgs, IGetPollJoiningCircuitEventsArgs, IGetPollJoiningCircuitInputsFromStateFileArgs, IJoinPollData, IParsePollJoinEventsArgs, IParseSignupEventsArgs, ISignupData, IHasUserSignedUpArgs, IGenerateMaciStateTreeArgs, IGenerateMaciStateTreeWithEndKeyArgs, } from "./types";
+//# sourceMappingURL=index.d.ts.map

package/build/ts/user/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../ts/user/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AACxE,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,+BAA+B,EAC/B,2BAA2B,EAC3B,oBAAoB,GACrB,MAAM,SAAS,CAAC;AACjB,YAAY,EACV,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,WAAW,EACX,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,aAAa,EACb,uBAAuB,EACvB,gCAAgC,EAChC,6CAA6C,EAC7C,aAAa,EACb,wBAAwB,EACxB,sBAAsB,EACtB,WAAW,EACX,oBAAoB,EACpB,0BAA0B,EAC1B,oCAAoC,GACrC,MAAM,SAAS,CAAC"}

package/build/ts/user/index.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.joiningCircuitInputs = exports.getPollJoiningCircuitEvents = exports.generateMaciStateTreeWithEndKey = exports.generateMaciStateTree = exports.hasUserJoinedPoll = exports.getJoinedUserData = exports.hasUserSignedUp = exports.signup = exports.getSignedupUserData = exports.joinPoll = void 0;
+var joinPoll_1 = require("./joinPoll");
+Object.defineProperty(exports, "joinPoll", { enumerable: true, get: function () { return joinPoll_1.joinPoll; } });
+var signup_1 = require("./signup");
+Object.defineProperty(exports, "getSignedupUserData", { enumerable: true, get: function () { return signup_1.getSignedupUserData; } });
+Object.defineProperty(exports, "signup", { enumerable: true, get: function () { return signup_1.signup; } });
+Object.defineProperty(exports, "hasUserSignedUp", { enumerable: true, get: function () { return signup_1.hasUserSignedUp; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "getJoinedUserData", { enumerable: true, get: function () { return utils_1.getJoinedUserData; } });
+Object.defineProperty(exports, "hasUserJoinedPoll", { enumerable: true, get: function () { return utils_1.hasUserJoinedPoll; } });
+Object.defineProperty(exports, "generateMaciStateTree", { enumerable: true, get: function () { return utils_1.generateMaciStateTree; } });
+Object.defineProperty(exports, "generateMaciStateTreeWithEndKey", { enumerable: true, get: function () { return utils_1.generateMaciStateTreeWithEndKey; } });
+Object.defineProperty(exports, "getPollJoiningCircuitEvents", { enumerable: true, get: function () { return utils_1.getPollJoiningCircuitEvents; } });
+Object.defineProperty(exports, "joiningCircuitInputs", { enumerable: true, get: function () { return utils_1.joiningCircuitInputs; } });
+//# sourceMappingURL=index.js.map

package/build/ts/user/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../ts/user/index.ts"],"names":[],"mappings":";;;AAAA,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,mCAAwE;AAA/D,6GAAA,mBAAmB,OAAA;AAAE,gGAAA,MAAM,OAAA;AAAE,yGAAA,eAAe,OAAA;AACrD,iCAOiB;AANf,0GAAA,iBAAiB,OAAA;AACjB,0GAAA,iBAAiB,OAAA;AACjB,8GAAA,qBAAqB,OAAA;AACrB,wHAAA,+BAA+B,OAAA;AAC/B,oHAAA,2BAA2B,OAAA;AAC3B,6GAAA,oBAAoB,OAAA"}

package/build/ts/user/joinPoll.d.ts

@@ -0,0 +1,8 @@
+import type { IJoinPollData, IJoinPollArgs } from "./types";
+/**
+ * Join Poll user to the Poll contract
+ * @param {IJoinPollArgs} args - The arguments for the join poll command
+ * @returns {IJoinPollData} The poll state index of the joined user and transaction hash
+ */
+export declare const joinPoll: ({ maciAddress, privateKey, stateFile, pollId, signer, startBlock, endBlock, blocksPerBatch, pollJoiningZkey, useWasm, rapidsnark, pollWitnessGenerator, pollJoiningWasm, sgDataArg, ivcpDataArg, }: IJoinPollArgs) => Promise<IJoinPollData>;
+//# sourceMappingURL=joinPoll.d.ts.map

package/build/ts/user/joinPoll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"joinPoll.d.ts","sourceRoot":"","sources":["../../../ts/user/joinPoll.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAQ5D;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAU,oMAgB5B,aAAa,KAAG,OAAO,CAAC,aAAa,CAmGvC,CAAC"}

package/build/ts/user/joinPoll.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.joinPoll = void 0;
+/* eslint-disable no-underscore-dangle */
+const typechain_types_1 = require("@maci-protocol/contracts/typechain-types");
+const crypto_1 = require("@maci-protocol/crypto");
+const domainobjs_1 = require("@maci-protocol/domainobjs");
+const contracts_1 = require("../utils/contracts");
+const proofs_1 = require("../utils/proofs");
+const utils_1 = require("./utils");
+/**
+ * Join Poll user to the Poll contract
+ * @param {IJoinPollArgs} args - The arguments for the join poll command
+ * @returns {IJoinPollData} The poll state index of the joined user and transaction hash
+ */
+const joinPoll = async ({ maciAddress, privateKey, stateFile, pollId, signer, startBlock, endBlock, blocksPerBatch, pollJoiningZkey, useWasm, rapidsnark, pollWitnessGenerator, pollJoiningWasm, sgDataArg, ivcpDataArg, }) => {
+    const validContract = await (0, contracts_1.contractExists)(signer.provider, maciAddress);
+    if (!validContract) {
+        throw new Error("MACI contract does not exist");
+    }
+    if (!domainobjs_1.PrivateKey.isValidSerialized(privateKey)) {
+        throw new Error("Invalid MACI private key");
+    }
+    if (pollId < 0) {
+        throw new Error("Invalid poll id");
+    }
+    const userMaciPrivateKey = domainobjs_1.PrivateKey.deserialize(privateKey);
+    const userMaciPublicKey = new domainobjs_1.Keypair(userMaciPrivateKey).publicKey;
+    const nullifier = (0, crypto_1.poseidon)([BigInt(userMaciPrivateKey.asCircuitInputs()), pollId]);
+    // check if the user has already joined the poll based on the nullifier
+    const hasUserJoinedAlready = await (0, utils_1.hasUserJoinedPoll)({
+        maciAddress,
+        pollId,
+        nullifier,
+        signer,
+    });
+    if (hasUserJoinedAlready) {
+        throw new Error("User has already joined");
+    }
+    const maciContract = typechain_types_1.MACI__factory.connect(maciAddress, signer);
+    const pollContracts = await maciContract.getPoll(pollId);
+    const pollContract = typechain_types_1.Poll__factory.connect(pollContracts.poll, signer);
+    // get the state index from the MACI contract
+    const stateIndex = await maciContract.getStateIndex(userMaciPublicKey.hash()).catch(() => -1n);
+    let circuitInputs;
+    if (stateFile) {
+        circuitInputs = await (0, utils_1.getPollJoiningCircuitInputsFromStateFile)({
+            stateFile,
+            pollId,
+            stateIndex,
+            userMaciPrivateKey,
+        });
+    }
+    else {
+        circuitInputs = await (0, utils_1.getPollJoiningCircuitEvents)({
+            maciContract,
+            stateIndex,
+            pollId,
+            userMaciPrivateKey,
+            signer,
+            startBlock,
+            endBlock,
+            blocksPerBatch,
+        });
+    }
+    const currentStateRootIndex = Number.parseInt((await maciContract.totalSignups()).toString(), 10) - 1;
+    // generate the proof for this batch
+    const proof = await (0, proofs_1.generateAndVerifyProof)(circuitInputs, pollJoiningZkey, useWasm, rapidsnark, pollWitnessGenerator, pollJoiningWasm);
+    // submit the message onchain as well as the encryption public key
+    const tx = await pollContract.joinPoll(nullifier, userMaciPublicKey.asContractParam(), currentStateRootIndex, proof, sgDataArg, ivcpDataArg);
+    const receipt = await tx.wait();
+    if (receipt?.status !== 1) {
+        throw new Error("Transaction failed");
+    }
+    const [{ args }] = await pollContract.queryFilter(pollContract.filters.PollJoined, receipt.blockNumber, receipt.blockNumber);
+    return {
+        pollStateIndex: args._pollStateIndex.toString(),
+        voiceCredits: args._voiceCreditBalance.toString(),
+        nullifier: nullifier.toString(),
+        hash: receipt.hash,
+    };
+};
+exports.joinPoll = joinPoll;
+//# sourceMappingURL=joinPoll.js.map

package/build/ts/user/joinPoll.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"joinPoll.js","sourceRoot":"","sources":["../../../ts/user/joinPoll.ts"],"names":[],"mappings":";;;AAAA,yCAAyC;AACzC,8EAAsH;AACtH,kDAAiD;AACjD,0DAAgE;AAKhE,kDAAoD;AACpD,4CAAyD;AAEzD,mCAAmH;AAEnH;;;;GAIG;AACI,MAAM,QAAQ,GAAG,KAAK,EAAE,EAC7B,WAAW,EACX,UAAU,EACV,SAAS,EACT,MAAM,EACN,MAAM,EACN,UAAU,EACV,QAAQ,EACR,cAAc,EACd,eAAe,EACf,OAAO,EACP,UAAU,EACV,oBAAoB,EACpB,eAAe,EACf,SAAS,EACT,WAAW,GACG,EAA0B,EAAE;IAC1C,MAAM,aAAa,GAAG,MAAM,IAAA,0BAAc,EAAC,MAAM,CAAC,QAAS,EAAE,WAAW,CAAC,CAAC;IAE1E,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,uBAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IAED,MAAM,kBAAkB,GAAG,uBAAU,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC9D,MAAM,iBAAiB,GAAG,IAAI,oBAAO,CAAC,kBAAkB,CAAC,CAAC,SAAS,CAAC;IACpE,MAAM,SAAS,GAAG,IAAA,iBAAQ,EAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,eAAe,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAEnF,uEAAuE;IACvE,MAAM,oBAAoB,GAAG,MAAM,IAAA,yBAAiB,EAAC;QACnD,WAAW;QACX,MAAM;QACN,SAAS;QACT,MAAM;KACP,CAAC,CAAC;IAEH,IAAI,oBAAoB,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,YAAY,GAAG,+BAAW,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC9D,MAAM,aAAa,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzD,MAAM,YAAY,GAAG,+BAAW,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAErE,6CAA6C;IAC7C,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,aAAa,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAE/F,IAAI,aAA6B,CAAC;IAElC,IAAI,SAAS,EAAE,CAAC;QACd,aAAa,GAAG,MAAM,IAAA,gDAAwC,EAAC;YAC7D,SAAS;YACT,MAAM;YACN,UAAU;YACV,kBAAkB;SACnB,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,aAAa,GAAG,MAAM,IAAA,mCAA2B,EAAC;YAChD,YAAY;YACZ,UAAU;YACV,MAAM;YACN,kBAAkB;YAClB,MAAM;YACN,UAAU;YACV,QAAQ;YACR,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,MAAM,qBAAqB,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,YAAY,CAAC,YAAY,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;IAEtG,oCAAoC;IACpC,MAAM,KAAK,GAAG,MAAM,IAAA,+BAAsB,EACxC,aAAa,EACb,eAAe,EACf,OAAO,EACP,UAAU,EACV,oBAAoB,EACpB,eAAe,CAChB,CAAC;IAEF,kEAAkE;IAClE,MAAM,EAAE,GAAG,MAAM,YAAY,CAAC,QAAQ,CACpC,SAAS,EACT,iBAAiB,CAAC,eAAe,EAAE,EACnC,qBAAqB,EACrB,KAAK,EACL,SAAS,EACT,WAAW,CACZ,CAAC;IACF,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;IAEhC,IAAI,OAAO,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,YAAY,CAAC,WAAW,CAC/C,YAAY,CAAC,OAAO,CAAC,UAAU,EAC/B,OAAO,CAAC,WAAW,EACnB,OAAO,CAAC,WAAW,CACpB,CAAC;IAEF,OAAO;QACL,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE;QAC/C,YAAY,EAAE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE;QACjD,SAAS,EAAE,SAAS,CAAC,QAAQ,EAAE;QAC/B,IAAI,EAAE,OAAO,CAAC,IAAI;KACnB,CAAC;AACJ,CAAC,CAAC;AAnHW,QAAA,QAAQ,YAmHnB"}

package/build/ts/user/signup.d.ts

@@ -0,0 +1,20 @@
+import type { IIsRegisteredUser, ISignupArgs, ISignupData, IRegisteredUserArgs, IHasUserSignedUpArgs } from "./types";
+/**
+ * Checks if user is registered with a given public key and get its data
+ * @param IRegisteredArgs - The arguments for the check register command
+ * @returns whether the user is registered or not and their state index
+ */
+export declare const getSignedupUserData: ({ maciAddress, maciPublicKey, signer, }: IRegisteredUserArgs) => Promise<IIsRegisteredUser>;
+/**
+ * Signup a user to the MACI contract
+ * @param {SignupArgs} args - The arguments for the signup command
+ * @returns {ISignupData} The state index of the user and transaction hash
+ */
+export declare const signup: ({ maciPublicKey, maciAddress, sgData, signer }: ISignupArgs) => Promise<ISignupData>;
+/**
+ * Checks if a user is signed up with a given public key
+ * @param {IIsSignedUpArgs} args - The arguments for the is signed up command
+ * @returns {boolean} Whether the user is signed up or not
+ */
+export declare const hasUserSignedUp: ({ maciAddress, maciPublicKey, signer, }: IHasUserSignedUpArgs) => Promise<boolean>;
+//# sourceMappingURL=signup.d.ts.map

package/build/ts/user/signup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signup.d.ts","sourceRoot":"","sources":["../../../ts/user/signup.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAItH;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAU,yCAIvC,mBAAmB,KAAG,OAAO,CAAC,iBAAiB,CAsBjD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,MAAM,GAAU,gDAAgD,WAAW,KAAG,OAAO,CAAC,WAAW,CA6C7G,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAU,yCAInC,oBAAoB,KAAG,OAAO,CAAC,OAAO,CAMxC,CAAC"}

package/build/ts/user/signup.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasUserSignedUp = exports.signup = exports.getSignedupUserData = void 0;
+const typechain_types_1 = require("@maci-protocol/contracts/typechain-types");
+const domainobjs_1 = require("@maci-protocol/domainobjs");
+const ethers_1 = require("ethers");
+const contracts_1 = require("../utils/contracts");
+/**
+ * Checks if user is registered with a given public key and get its data
+ * @param IRegisteredArgs - The arguments for the check register command
+ * @returns whether the user is registered or not and their state index
+ */
+const getSignedupUserData = async ({ maciAddress, maciPublicKey, signer, }) => {
+    const maciContract = typechain_types_1.MACI__factory.connect(maciAddress, signer);
+    const publicKey = domainobjs_1.PublicKey.deserialize(maciPublicKey);
+    try {
+        const stateIndex = await maciContract.getStateIndex(publicKey.hash());
+        return {
+            isRegistered: stateIndex !== 0n, // 0 index is reserved for deleted leaves
+            stateIndex: String(stateIndex),
+        };
+    }
+    catch (error) {
+        // Check if this is a "UserNotSignedUp" maci contract error
+        if (error instanceof Error && error.message.includes("UserNotSignedUp()")) {
+            return {
+                isRegistered: false,
+                stateIndex: undefined,
+            };
+        }
+        // If it's a different error, rethrow it
+        throw error;
+    }
+};
+exports.getSignedupUserData = getSignedupUserData;
+/**
+ * Signup a user to the MACI contract
+ * @param {SignupArgs} args - The arguments for the signup command
+ * @returns {ISignupData} The state index of the user and transaction hash
+ */
+const signup = async ({ maciPublicKey, maciAddress, sgData, signer }) => {
+    // validate user key
+    if (!domainobjs_1.PublicKey.isValidSerialized(maciPublicKey)) {
+        throw new Error("Invalid MACI public key");
+    }
+    const userMaciPublicKey = domainobjs_1.PublicKey.deserialize(maciPublicKey);
+    const validContract = await (0, contracts_1.contractExists)(signer.provider, maciAddress);
+    if (!validContract) {
+        throw new Error("There is no contract deployed at the specified address");
+    }
+    // we validate that the signup data and voice credit data is valid
+    if (!(0, ethers_1.isBytesLike)(sgData)) {
+        throw new Error("invalid signup gateway data");
+    }
+    const maciContract = typechain_types_1.MACI__factory.connect(maciAddress, signer);
+    let stateIndex = "";
+    let receipt = null;
+    // sign up to the MACI contract
+    const tx = await maciContract.signUp(userMaciPublicKey.asContractParam(), sgData);
+    receipt = await tx.wait();
+    if (receipt?.status !== 1) {
+        throw new Error("The transaction failed");
+    }
+    // get state index from the event
+    const [{ args = [] } = { args: [] }] = await maciContract.queryFilter(maciContract.filters.SignUp, receipt.blockNumber, receipt.blockNumber);
+    stateIndex = args[0].toString();
+    return {
+        stateIndex: stateIndex ? stateIndex.toString() : "",
+        transactionHash: receipt.hash,
+    };
+};
+exports.signup = signup;
+/**
+ * Checks if a user is signed up with a given public key
+ * @param {IIsSignedUpArgs} args - The arguments for the is signed up command
+ * @returns {boolean} Whether the user is signed up or not
+ */
+const hasUserSignedUp = async ({ maciAddress, maciPublicKey, signer, }) => {
+    const maciContract = typechain_types_1.MACI__factory.connect(maciAddress, signer);
+    const stateIndex = await maciContract.getStateIndex(domainobjs_1.PublicKey.deserialize(maciPublicKey).hash());
+    return stateIndex !== 0n;
+};
+exports.hasUserSignedUp = hasUserSignedUp;
+//# sourceMappingURL=signup.js.map

package/build/ts/user/signup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signup.js","sourceRoot":"","sources":["../../../ts/user/signup.ts"],"names":[],"mappings":";;;AAAA,8EAAwF;AACxF,0DAAsD;AACtD,mCAAsE;AAItE,kDAAoD;AAEpD;;;;GAIG;AACI,MAAM,mBAAmB,GAAG,KAAK,EAAE,EACxC,WAAW,EACX,aAAa,EACb,MAAM,GACc,EAA8B,EAAE;IACpD,MAAM,YAAY,GAAG,+BAAW,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC9D,MAAM,SAAS,GAAG,sBAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IAEvD,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;QAEtE,OAAO;YACL,YAAY,EAAE,UAAU,KAAK,EAAE,EAAE,yCAAyC;YAC1E,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;SAC/B,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,2DAA2D;QAC3D,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;YAC1E,OAAO;gBACL,YAAY,EAAE,KAAK;gBACnB,UAAU,EAAE,SAAS;aACtB,CAAC;QACJ,CAAC;QACD,wCAAwC;QACxC,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AA1BW,QAAA,mBAAmB,uBA0B9B;AAEF;;;;GAIG;AACI,MAAM,MAAM,GAAG,KAAK,EAAE,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAe,EAAwB,EAAE;IAChH,oBAAoB;IACpB,IAAI,CAAC,sBAAS,CAAC,iBAAiB,CAAC,aAAa,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,iBAAiB,GAAG,sBAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IAE/D,MAAM,aAAa,GAAG,MAAM,IAAA,0BAAc,EAAC,MAAM,CAAC,QAAS,EAAE,WAAW,CAAC,CAAC;IAE1E,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC5E,CAAC;IAED,kEAAkE;IAClE,IAAI,CAAC,IAAA,oBAAW,EAAC,MAAM,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,YAAY,GAAG,+BAAW,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAE9D,IAAI,UAAU,GAAG,EAAE,CAAC;IACpB,IAAI,OAAO,GAAsC,IAAI,CAAC;IAEtD,+BAA+B;IAC/B,MAAM,EAAE,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,iBAAiB,CAAC,eAAe,EAAE,EAAE,MAAM,CAAC,CAAC;IAClF,OAAO,GAAG,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;IAE1B,IAAI,OAAO,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IAED,iCAAiC;IACjC,MAAM,CAAC,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,YAAY,CAAC,WAAW,CACnE,YAAY,CAAC,OAAO,CAAC,MAAM,EAC3B,OAAO,CAAC,WAAW,EACnB,OAAO,CAAC,WAAW,CACpB,CAAC;IAEF,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAEhC,OAAO;QACL,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE;QACnD,eAAe,EAAE,OAAO,CAAC,IAAI;KAC9B,CAAC;AACJ,CAAC,CAAC;AA7CW,QAAA,MAAM,UA6CjB;AAEF;;;;GAIG;AACI,MAAM,eAAe,GAAG,KAAK,EAAE,EACpC,WAAW,EACX,aAAa,EACb,MAAM,GACe,EAAoB,EAAE;IAC3C,MAAM,YAAY,GAAG,+BAAW,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAE9D,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,aAAa,CAAC,sBAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAEjG,OAAO,UAAU,KAAK,EAAE,CAAC;AAC3B,CAAC,CAAC;AAVW,QAAA,eAAe,mBAU1B"}