@maci-protocol/sdk 0.0.0-ci.185b643

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, pollWitgen, pollWasm, 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.PrivKey.isValidSerializedPrivKey(privateKey)) {
+        throw new Error("Invalid MACI private key");
+    }
+    if (pollId < 0) {
+        throw new Error("Invalid poll id");
+    }
+    const userMaciPrivKey = domainobjs_1.PrivKey.deserialize(privateKey);
+    const userMaciPubKey = new domainobjs_1.Keypair(userMaciPrivKey).pubKey;
+    const nullifier = (0, crypto_1.poseidon)([BigInt(userMaciPrivKey.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(userMaciPubKey.hash()).catch(() => -1n);
+    let circuitInputs;
+    if (stateFile) {
+        circuitInputs = await (0, utils_1.getPollJoiningCircuitInputsFromStateFile)({
+            stateFile,
+            pollId,
+            stateIndex,
+            userMaciPrivKey,
+        });
+    }
+    else {
+        circuitInputs = await (0, utils_1.getPollJoiningCircuitEvents)({
+            maciContract,
+            stateIndex,
+            pollId,
+            userMaciPrivKey,
+            signer,
+            startBlock,
+            endBlock,
+            blocksPerBatch,
+        });
+    }
+    const currentStateRootIndex = Number.parseInt((await maciContract.numSignUps()).toString(), 10) - 1;
+    // generate the proof for this batch
+    const proof = await (0, proofs_1.generateAndVerifyProof)(circuitInputs, pollJoiningZkey, useWasm, rapidsnark, pollWitgen, pollWasm);
+    // submit the message onchain as well as the encryption public key
+    const tx = await pollContract.joinPoll(nullifier, userMaciPubKey.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,0DAA6D;AAK7D,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,UAAU,EACV,QAAQ,EACR,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,oBAAO,CAAC,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC;QAClD,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,eAAe,GAAG,oBAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IACxD,MAAM,cAAc,GAAG,IAAI,oBAAO,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC;IAC3D,MAAM,SAAS,GAAG,IAAA,iBAAQ,EAAC,CAAC,MAAM,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAEhF,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,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAE5F,IAAI,aAA4B,CAAC;IAEjC,IAAI,SAAS,EAAE,CAAC;QACd,aAAa,GAAG,MAAM,IAAA,gDAAwC,EAAC;YAC7D,SAAS;YACT,MAAM;YACN,UAAU;YACV,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,aAAa,GAAG,MAAM,IAAA,mCAA2B,EAAC;YAChD,YAAY;YACZ,UAAU;YACV,MAAM;YACN,eAAe;YACf,MAAM;YACN,UAAU;YACV,QAAQ;YACR,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,MAAM,qBAAqB,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,YAAY,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;IAEpG,oCAAoC;IACpC,MAAM,KAAK,GAAG,MAAM,IAAA,+BAAsB,EAAC,aAAa,EAAE,eAAe,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IAEtH,kEAAkE;IAClE,MAAM,EAAE,GAAG,MAAM,YAAY,CAAC,QAAQ,CACpC,SAAS,EACT,cAAc,CAAC,eAAe,EAAE,EAChC,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;AA5GW,QAAA,QAAQ,YA4GnB"}

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, maciPubKey, signer, startBlock, }: 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: ({ maciPubKey, 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, maciPubKey, 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;AAMtH;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAU,kDAKvC,mBAAmB,KAAG,OAAO,CAAC,iBAAiB,CAiBjD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,MAAM,GAAU,6CAA6C,WAAW,KAAG,OAAO,CAAC,WAAW,CA6C1G,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAU,qCAAqC,oBAAoB,KAAG,OAAO,CAAC,OAAO,CAMhH,CAAC"}

package/build/ts/user/signup.js

@@ -0,0 +1,79 @@
+"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");
+const utils_1 = require("./utils");
+/**
+ * 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, maciPubKey, signer, startBlock, }) => {
+    const maciContract = typechain_types_1.MACI__factory.connect(maciAddress, signer);
+    const publicKey = domainobjs_1.PubKey.deserialize(maciPubKey);
+    const startBlockNumber = startBlock || 0;
+    const currentBlock = await signer.provider.getBlockNumber();
+    const { stateIndex } = await (0, utils_1.parseSignupEvents)({
+        maciContract,
+        startBlock: startBlockNumber,
+        currentBlock,
+        publicKey,
+    });
+    return {
+        isRegistered: stateIndex !== undefined,
+        stateIndex,
+    };
+};
+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 ({ maciPubKey, maciAddress, sgData, signer }) => {
+    // validate user key
+    if (!domainobjs_1.PubKey.isValidSerializedPubKey(maciPubKey)) {
+        throw new Error("Invalid MACI public key");
+    }
+    const userMaciPubKey = domainobjs_1.PubKey.deserialize(maciPubKey);
+    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(userMaciPubKey.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, maciPubKey, signer }) => {
+    const maciContract = typechain_types_1.MACI__factory.connect(maciAddress, signer);
+    const stateIndex = await maciContract.getStateIndex(domainobjs_1.PubKey.deserialize(maciPubKey).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,0DAAmD;AACnD,mCAAiE;AAIjE,kDAAoD;AAEpD,mCAA4C;AAE5C;;;;GAIG;AACI,MAAM,mBAAmB,GAAG,KAAK,EAAE,EACxC,WAAW,EACX,UAAU,EACV,MAAM,EACN,UAAU,GACU,EAA8B,EAAE;IACpD,MAAM,YAAY,GAAG,+BAAW,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC9D,MAAM,SAAS,GAAG,mBAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IACjD,MAAM,gBAAgB,GAAG,UAAU,IAAI,CAAC,CAAC;IACzC,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,QAAS,CAAC,cAAc,EAAE,CAAC;IAE7D,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,IAAA,yBAAiB,EAAC;QAC7C,YAAY;QACZ,UAAU,EAAE,gBAAgB;QAC5B,YAAY;QACZ,SAAS;KACV,CAAC,CAAC;IAEH,OAAO;QACL,YAAY,EAAE,UAAU,KAAK,SAAS;QACtC,UAAU;KACX,CAAC;AACJ,CAAC,CAAC;AAtBW,QAAA,mBAAmB,uBAsB9B;AAEF;;;;GAIG;AACI,MAAM,MAAM,GAAG,KAAK,EAAE,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAe,EAAwB,EAAE;IAC7G,oBAAoB;IACpB,IAAI,CAAC,mBAAM,CAAC,uBAAuB,CAAC,UAAU,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,cAAc,GAAG,mBAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAEtD,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,cAAc,CAAC,eAAe,EAAE,EAAE,MAAM,CAAC,CAAC;IAC/E,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,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,EAAwB,EAAoB,EAAE;IACnH,MAAM,YAAY,GAAG,+BAAW,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAE9D,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,aAAa,CAAC,mBAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAE3F,OAAO,UAAU,KAAK,EAAE,CAAC;AAC3B,CAAC,CAAC;AANW,QAAA,eAAe,mBAM1B"}

package/build/ts/user/types.d.ts

@@ -0,0 +1,416 @@
+import type { MACI, Poll } from "@maci-protocol/contracts/typechain-types";
+import type { PrivKey, PubKey } from "@maci-protocol/domainobjs";
+import type { Signer } from "ethers";
+/**
+ * Interface for the arguments to the isJoinedUser command
+ */
+export interface IJoinedUserArgs {
+    /**
+     * The address of the MACI contract
+     */
+    maciAddress: string;
+    /**
+     * The id of the poll
+     */
+    pollId: bigint;
+    /**
+     * Poll public key for the poll
+     */
+    pollPubKey: string;
+    /**
+     * A signer object
+     */
+    signer: Signer;
+    /**
+     * The start block number
+     */
+    startBlock: number;
+}
+/**
+ * Interface for the return data to the isRegisteredUser function
+ */
+export interface IIsRegisteredUser {
+    /**
+     * Whether the user is registered
+     */
+    isRegistered: boolean;
+    /**
+     * The state index of the user
+     */
+    stateIndex?: string;
+}
+/**
+ * Interface for the return data to the isJoinedUser function
+ */
+export interface IIsJoinedUser {
+    /**
+     * Whether the user joined the poll
+     */
+    isJoined: boolean;
+    /**
+     * The state index of the user
+     */
+    pollStateIndex?: string;
+    /**
+     * The voice credits of the user
+     */
+    voiceCredits?: string;
+}
+/**
+ * Interface for the arguments to the signup command
+ */
+export interface ISignupArgs {
+    /**
+     * The public key of the user
+     */
+    maciPubKey: string;
+    /**
+     * A signer object
+     */
+    signer: Signer;
+    /**
+     * The address of the MACI contract
+     */
+    maciAddress: string;
+    /**
+     * The signup policy data
+     */
+    sgData: string;
+}
+/**
+ * Interface for the return data to the signup command
+ */
+export interface ISignupData {
+    /**
+     * The state index of the user
+     */
+    stateIndex: string;
+    /**
+     * The signup transaction hash
+     */
+    transactionHash: string;
+}
+/**
+ * Interface for the arguments to the register check command
+ */
+export interface IRegisteredUserArgs {
+    /**
+     * A signer object
+     */
+    signer: Signer;
+    /**
+     * The public key of the user
+     */
+    maciPubKey: string;
+    /**
+     * The address of the MACI contract
+     */
+    maciAddress: string;
+    /**
+     * Start block for event parsing
+     */
+    startBlock?: number;
+}
+/**
+ * Interface for the arguments to the parsePollJoinEvents function
+ */
+export interface IParsePollJoinEventsArgs {
+    /**
+     * The MACI contract
+     */
+    pollContract: Poll;
+    /**
+     * The start block
+     */
+    startBlock: number;
+    /**
+     * The current block
+     */
+    currentBlock: number;
+    /**
+     * The public key
+     */
+    pollPublicKey: PubKey;
+}
+/**
+ * Interface for the arguments to the parseSignupEvents function
+ */
+export interface IParseSignupEventsArgs {
+    /**
+     * The MACI contract
+     */
+    maciContract: MACI;
+    /**
+     * The start block
+     */
+    startBlock: number;
+    /**
+     * The current block
+     */
+    currentBlock: number;
+    /**
+     * The public key
+     */
+    publicKey: PubKey;
+}
+/**
+ * An interface describing the circuit inputs to the PollJoining circuit
+ */
+export interface IPollJoiningCircuitInputs {
+    /**
+     * The private key
+     */
+    privKey: string;
+    /**
+     * The poll public key
+     */
+    pollPubKey: string[];
+    /**
+     * The state leaf
+     */
+    stateLeaf: string[];
+    /**
+     * The siblings for the merkle proof
+     */
+    siblings: string[][];
+    /**
+     * The path indices
+     */
+    indices: string[];
+    /**
+     * The nullifier
+     */
+    nullifier: string;
+    /**
+     * The state root
+     */
+    stateRoot: string;
+    /**
+     * The actual state tree depth
+     */
+    actualStateTreeDepth: string;
+    /**
+     * The poll id
+     */
+    pollId: string;
+}
+/**
+ * An interface describing the circuit inputs to the PollJoined circuit
+ */
+export interface IPollJoinedCircuitInputs {
+    /**
+     * The private key
+     */
+    privKey: string;
+    /**
+     * The voice credits balance
+     */
+    voiceCreditsBalance: string;
+    /**
+     * The state leaf
+     */
+    stateLeaf: string[];
+    /**
+     * The path elements
+     */
+    pathElements: string[][];
+    /**
+     * The path indices
+     */
+    pathIndices: string[];
+    /**
+     * The state root
+     */
+    stateRoot: string;
+    /**
+     * The actual state tree depth
+     */
+    actualStateTreeDepth: string;
+}
+/**
+ * Interface for the arguments to the joinPoll command
+ */
+export interface IJoinPollArgs {
+    /**
+     * A signer object
+     */
+    signer: Signer;
+    /**
+     * The private key of the user
+     */
+    privateKey: string;
+    /**
+     * The id of the poll
+     */
+    pollId: bigint;
+    /**
+     * The index of the public key in the state tree
+     */
+    stateIndex?: bigint;
+    /**
+     * Path to the state file with MACI state
+     */
+    stateFile?: string;
+    /**
+     * The address of the MACI contract
+     */
+    maciAddress: string;
+    /**
+     * The end block number
+     */
+    endBlock?: number;
+    /**
+     * The start block number
+     */
+    startBlock?: number;
+    /**
+     * The number of blocks to fetch per batch
+     */
+    blocksPerBatch?: number;
+    /**
+     * The path to the poll zkey file
+     */
+    pollJoiningZkey: string;
+    /**
+     * Whether to use wasm or rapidsnark
+     */
+    useWasm?: boolean;
+    /**
+     * The path to the rapidsnark binary
+     */
+    rapidsnark?: string;
+    /**
+     * The path to the poll witnessgen binary
+     */
+    pollWitgen?: string;
+    /**
+     * The path to the poll wasm file
+     */
+    pollWasm?: string;
+    /**
+     * The signup policy data
+     */
+    sgDataArg: string;
+    /**
+     * The initial voice credit proxy data
+     */
+    ivcpDataArg: string;
+}
+/**
+ * Interface for the return data to the joinPoll command
+ */
+export interface IJoinPollData {
+    /**
+     * The poll state index of the joined user
+     */
+    pollStateIndex: string;
+    /**
+     * Voice credits balance
+     */
+    voiceCredits: string;
+    /**
+     * Private key nullifier
+     */
+    nullifier: string;
+    /**
+     * The join poll transaction hash
+     */
+    hash: string;
+}
+/**
+ * The arguments to check if a nullifier is on chain
+ */
+export interface IIsNullifierOnChainArgs {
+    /**
+     * The address of the MACI contract
+     */
+    maciAddress: string;
+    /**
+     * The id of the poll
+     */
+    pollId: bigint;
+    /**
+     * The nullifier to check
+     */
+    nullifier: bigint;
+    /**
+     * The signer to use
+     */
+    signer: Signer;
+}
+/**
+ * Arguments for getPollJoiningCircuitEvents
+ */
+export interface IGetPollJoiningCircuitEventsArgs {
+    /**
+     * The MACI contract
+     */
+    maciContract: MACI;
+    /**
+     * The state index
+     */
+    stateIndex: bigint;
+    /**
+     * The poll id
+     */
+    pollId: bigint;
+    /**
+     * The user's maci private key
+     */
+    userMaciPrivKey: PrivKey;
+    /**
+     * The signer
+     */
+    signer: Signer;
+    /**
+     * The start block
+     */
+    startBlock?: number;
+    /**
+     * The end block
+     */
+    endBlock?: number;
+    /**
+     * The blocks per batch
+     */
+    blocksPerBatch?: number;
+}
+/**
+ * Arguments for getPollJoiningCircuitInputsFromStateFile
+ */
+export interface IGetPollJoiningCircuitInputsFromStateFileArgs {
+    /**
+     * The path to the file containing the serialized MACI state
+     */
+    stateFile: string;
+    /**
+     * The poll id
+     */
+    pollId: bigint;
+    /**
+     * The state index
+     */
+    stateIndex: bigint;
+    /**
+     * The user's maci private key
+     */
+    userMaciPrivKey: PrivKey;
+}
+/**
+ * Interface for the arguments for the is signed up command
+ */
+export interface IHasUserSignedUpArgs {
+    /**
+     * The address of the MACI contract
+     */
+    maciAddress: string;
+    /**
+     * The public key of the user
+     */
+    maciPubKey: string;
+    /**
+     * The signer to use for the transaction
+     */
+    signer: Signer;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../ts/user/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,0CAA0C,CAAC;AAC3E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,YAAY,EAAE,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,YAAY,EAAE,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,EAAE,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,EAAE,CAAC;IAEtB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,YAAY,EAAE,IAAI,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,6CAA6C;IAC5D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB"}

package/build/ts/user/types.js

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

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

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