feat(joinpoll cli): add optional parameters

privacy-scaling-explorations · Aug 19, 2024 · 26d69e8 · 26d69e8
1 parent 9425969
commit 26d69e8
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 15 deletions.
diff --git a/cli/ts/commands/joinPoll.ts b/cli/ts/commands/joinPoll.ts
@@ -12,6 +12,7 @@ import type { IJoinPollArgs, IJoinedUserArgs, IParsePollJoinEventsArgs } from ".
 
 import { contractExists, logError, logYellow, info, logGreen, success } from "../utils";
 import { banner } from "../utils/banner";
+import { error } from "console";
 
 /**
  * Create circuit input for pollJoining
@@ -124,17 +125,20 @@ export const joinPoll = async ({
   }
 
   const userMaciPrivKey = PrivKey.deserialize(privateKey);
+  const userMaciPubKey = new Keypair(userMaciPrivKey).pubKey;
   const nullifier = poseidon([BigInt(userMaciPrivKey.asCircuitInputs())]);
 
   // Create poll public key from poll private key
   const pollPrivKeyDeserialized = PrivKey.deserialize(pollPrivKey);
   const pollKeyPair = new Keypair(pollPrivKeyDeserialized);
   const pollPubKey = pollKeyPair.pubKey;
 
-  // check < 1 cause index zero is a blank state leaf
-  if (stateIndex < 1) {
-    logError("Invalid state index");
-  }
+
+  // let loadedStateLeafIndex = stateLeafIndex;
+
+  // if (stateLeafIndex == null) {
+  //   loadedStateLeafIndex = BigInt(stateLeaves.findIndex(leaf => leaf.pubKey.equals());
+  // }
 
   if (pollId < 0) {
     logError("Invalid poll id");
@@ -148,6 +152,9 @@ export const joinPoll = async ({
   }
 
   const pollContract = PollFactory.connect(pollAddress, signer);
+
+  let loadedStateIndex = stateIndex;
+  let loadedCreditBalance = newVoiceCreditBalance;
 
   let maciState: MaciState | undefined;
   let signUpData: IGenSignUpTree | undefined;
@@ -167,14 +174,33 @@ export const joinPoll = async ({
       throw new Error("User the given nullifier has already joined");
     }
 
+    if (stateIndex == null) {
+      const index = maciState?.stateLeaves.findIndex(leaf => leaf.pubKey.equals(userMaciPubKey));
+      if (index != null) {
+        loadedStateIndex = BigInt(index);
+      } else {
+        error('State leaf not found');
+        process.exit();
+      }
+    }
+
+    // check < 1 cause index zero is a blank state leaf
+    if (loadedStateIndex! < 1) {
+      logError("Invalid state index");
+    }
+
     currentStateRootIndex = poll.maciStateRef.numSignUps - 1;
 
     poll.updatePoll(BigInt(maciState!.stateLeaves.length));
 
+    if (newVoiceCreditBalance == null) {
+      loadedCreditBalance = maciState?.stateLeaves[Number(loadedStateIndex!)].voiceCreditBalance!;
+    }
+
     circuitInputs = poll.joiningCircuitInputs({
       maciPrivKey: userMaciPrivKey,
-      stateLeafIndex: stateIndex,
-      credits: newVoiceCreditBalance,
+      stateLeafIndex: loadedStateIndex!,
+      credits: loadedCreditBalance!,
       pollPrivKey: pollPrivKeyDeserialized,
       pollPubKey,
     }) as unknown as CircuitInputs;
@@ -209,12 +235,31 @@ export const joinPoll = async ({
 
     currentStateRootIndex = Number(numSignups) - 1;
 
+    if (stateIndex == null) {
+      const index = signUpData.stateLeaves.findIndex(leaf => leaf.pubKey.equals(userMaciPubKey));
+      if (index != null) {
+        loadedStateIndex = BigInt(index);
+      } else {
+        error('State leaf not found');
+        process.exit();
+      }
+    }
+
+    // check < 1 cause index zero is a blank state leaf
+    if (loadedStateIndex! < 1) {
+      logError("Invalid state index");
+    }
+
+    if (newVoiceCreditBalance == null) {
+      loadedCreditBalance = signUpData.stateLeaves[Number(loadedStateIndex!)].voiceCreditBalance!;
+    }
+
     circuitInputs = joiningCircuitInputs(
       signUpData,
       stateTreeDepth,
       userMaciPrivKey,
-      stateIndex,
-      newVoiceCreditBalance,
+      loadedStateIndex!,
+      loadedCreditBalance!,
       pollPrivKeyDeserialized,
       pollPubKey,
     ) as unknown as CircuitInputs;
@@ -247,7 +292,7 @@ export const joinPoll = async ({
     const tx = await pollContract.joinPoll(
       nullifier,
       pollPubKey.asContractParam(),
-      newVoiceCreditBalance,
+      loadedCreditBalance!,
       currentStateRootIndex,
       proof,
     );

diff --git a/cli/ts/index.ts b/cli/ts/index.ts
@@ -215,9 +215,9 @@ program
   .command("joinPoll")
   .description("join the poll")
   .requiredOption("-sk, --priv-key <privKey>", "the private key")
-  .requiredOption("-i, --state-index <stateIndex>", "the user's state index", BigInt)
+  .option("-i, --state-index <stateIndex>", "the user's state index", BigInt)
   .requiredOption("-esk, --poll-priv-key <pollPrivKey>", "the user ephemeral private key for the poll")
-  .requiredOption(
+  .option(
     "-nv, --new-voice-credit-balance <newVoiceCreditBalance>",
     "the voice credit balance of the user for the poll",
     BigInt,
@@ -250,8 +250,8 @@ program
         maciAddress,
         privateKey,
         pollPrivKey: cmdObj.pollPrivKey,
-        stateIndex: cmdObj.stateIndex,
-        newVoiceCreditBalance: cmdObj.newVoiceCreditBalance,
+        stateIndex: cmdObj.stateIndex || null,
+        newVoiceCreditBalance: cmdObj.newVoiceCreditBalance || null,
         stateFile: cmdObj.stateFile,
         pollId: cmdObj.pollId,
         signer,

diff --git a/cli/ts/utils/interfaces.ts b/cli/ts/utils/interfaces.ts
@@ -366,7 +366,7 @@ export interface IJoinPollArgs {
   /**
    * User's credit balance for voting within this poll
    */
-  newVoiceCreditBalance: bigint;
+  newVoiceCreditBalance: bigint | null;
 
   /**
    * The id of the poll
@@ -376,7 +376,7 @@ export interface IJoinPollArgs {
   /**
    * The index of the state leaf
    */
-  stateIndex: bigint;
+  stateIndex: bigint | null;
 
   /**
    * Whether to log the output