@crisp-e3/sdk 0.5.8 → 0.5.10

package/dist/index.d.ts

@@ -80,18 +80,9 @@ type MerkleProof = {
     indices: number[];
 };
 /**
- * Type representing a vote with power for 'yes' and 'no'
+ * Type representing a vote
  */
-type Vote = {
-    /**
-     * The voting power for 'yes' votes
-     */
-    yes: bigint;
-    /**
-     * The voting power for 'no' votes
-     */
-    no: bigint;
-};
+type Vote = bigint[];
 type ProofData = {
     publicInputs: string[];
     proof: Uint8Array;
@@ -103,6 +94,7 @@ type MaskVoteProofInputs = {
     slotAddress: string;
     merkleLeaves: string[] | bigint[];
     previousCiphertext?: Uint8Array;
+    numOptions: number;
 };
 type MaskVoteProofRequest = {
     e3Id: number;
@@ -110,6 +102,7 @@ type MaskVoteProofRequest = {
     balance: bigint;
     slotAddress: string;
     merkleLeaves: string[] | bigint[];
+    numOptions: number;
 };
 type VoteProofInputs = {
     merkleLeaves: string[] | bigint[];
@@ -131,6 +124,15 @@ type VoteProofRequest = {
     messageHash: `0x${string}`;
     slotAddress: string;
 };
+/**
+ * Enum representing the credit mode for a round, which can be either constant or custom.
+ * In constant mode, all voters receive the same amount of credits, while in custom mode,
+ * the credits can vary based on certain criteria (e.g., voter balance).
+ */
+declare enum CreditMode {
+    CONSTANT = "0",
+    CUSTOM = "1"
+}
 
 /**
  * Get the details of a specific round
@@ -161,11 +163,6 @@ declare const getPreviousCiphertext: (serverUrl: string, e3Id: number, address:
 declare const getIsSlotEmpty: (serverUrl: string, e3Id: number, address: string) => Promise<boolean>;
 
 declare const MERKLE_TREE_MAX_DEPTH = 20;
-/**
- * This is the maximum value for a vote (Yes or No). This is 2^50 - 1
- * The minimum degree that BFV should use is 100 (to accommodate both Yes and No votes)
- */
-declare const MAXIMUM_VOTE_VALUE: number;
 /**
  * Message used by users to prove ownership of their Ethereum account
  * This message is signed by the user's private key to authenticate their identity
@@ -195,13 +192,26 @@ declare const generateMerkleTree: (leaves: bigint[]) => LeanIMT;
  */
 declare const generateMerkleProof: (balance: bigint, address: string, leaves: bigint[] | string[]) => MerkleProof;
 declare const getAddressFromSignature: (signature: `0x${string}`, messageHash?: `0x${string}`) => Promise<string>;
+/**
+ * Get the maximum vote value for a given number of choices.
+ * @param numChoices Number of choices.
+ * @returns Maximum value per choice.
+ */
+declare const getMaxVoteValue: (numChoices: number) => bigint;
+/**
+ * Get a zero vote with the given number of choices.
+ * @param numChoices Number of choices.
+ * @returns A zero vote with the given number of choices.
+ */
+declare const getZeroVote: (numChoices: number) => bigint[];
 
 /**
- * Decode an encoded tally into its decimal representation.
- * @param tallyBytes The encoded tally as a hex string (bytes).
- * @returns The decoded tally as an IVote.
+ * Decode an encoded tally into vote counts for n choices.
+ * @param tallyBytes The encoded tally as a hex string.
+ * @param numChoices Number of choices.
+ * @returns Array of vote counts per choice.
  */
-declare const decodeTally: (tallyBytes: string) => Vote;
+declare const decodeTally: (tallyBytes: string, numChoices: number) => Vote;
 /**
  * Encrypt the vote using the public key.
  * @param vote - The vote to encrypt.
@@ -214,6 +224,12 @@ declare const encryptVote: (vote: Vote, publicKey: Uint8Array) => Uint8Array;
  * @returns The generated public key as a Uint8Array.
  */
 declare const generatePublicKey: () => Uint8Array;
+/**
+ * Validate a vote.
+ * @param vote - The vote to validate.
+ * @param balance - The balance of the voter.
+ */
+declare const validateVote: (vote: Vote, balance: bigint) => void;
 /**
  * Generate a vote proof for the CRISP circuit given the vote proof inputs.
  * @param voteProofInputs - The vote proof inputs.
@@ -268,4 +284,4 @@ declare class CrispSDK {
     generateVoteProof(voteProofInputs: VoteProofRequest): Promise<ProofData>;
 }
 
-export { CrispSDK, MAXIMUM_VOTE_VALUE, MERKLE_TREE_MAX_DEPTH, type MaskVoteProofInputs, type RoundDetails, type RoundDetailsResponse, SIGNATURE_MESSAGE, SIGNATURE_MESSAGE_HASH, type TokenDetails, type Vote, type VoteProofInputs, decodeTally, encodeSolidityProof, encryptVote, generateMaskVoteProof, generateMerkleProof, generateMerkleTree, generatePublicKey, generateVoteProof, getAddressFromSignature, getBalanceAt, getIsSlotEmpty, getPreviousCiphertext, getRoundDetails, getRoundTokenDetails, getTotalSupplyAt, getTreeData, hashLeaf, verifyProof };
+export { CreditMode, CrispSDK, MERKLE_TREE_MAX_DEPTH, type MaskVoteProofInputs, type RoundDetails, type RoundDetailsResponse, SIGNATURE_MESSAGE, SIGNATURE_MESSAGE_HASH, type TokenDetails, type Vote, type VoteProofInputs, decodeTally, encodeSolidityProof, encryptVote, generateMaskVoteProof, generateMerkleProof, generateMerkleTree, generatePublicKey, generateVoteProof, getAddressFromSignature, getBalanceAt, getIsSlotEmpty, getMaxVoteValue, getPreviousCiphertext, getRoundDetails, getRoundTokenDetails, getTotalSupplyAt, getTreeData, getZeroVote, hashLeaf, validateVote, verifyProof };