@crisp-e3/sdk 0.5.7 → 0.5.9

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { LeanIMTMerkleProof, LeanIMT } from '@zk-kit/lean-imt';
-import { ProofData } from '@aztec/bb.js';
 import { Hex } from 'viem';
 
 /**
@@ -81,17 +80,13 @@ 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;
+    encryptedVote: Uint8Array;
 };
 type MaskVoteProofInputs = {
     publicKey: Uint8Array;
@@ -99,6 +94,7 @@ type MaskVoteProofInputs = {
     slotAddress: string;
     merkleLeaves: string[] | bigint[];
     previousCiphertext?: Uint8Array;
+    numOptions: number;
 };
 type MaskVoteProofRequest = {
     e3Id: number;
@@ -106,6 +102,7 @@ type MaskVoteProofRequest = {
     balance: bigint;
     slotAddress: string;
     merkleLeaves: string[] | bigint[];
+    numOptions: number;
 };
 type VoteProofInputs = {
     merkleLeaves: string[] | bigint[];
@@ -157,11 +154,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
@@ -191,13 +183,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.
@@ -210,6 +215,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.
@@ -234,7 +245,7 @@ declare const verifyProof: (proof: ProofData) => Promise<boolean>;
  * @param proof The proof data.
  * @returns The encoded proof data as a hex string.
  */
-declare const encodeSolidityProof: (proof: ProofData) => Hex;
+declare const encodeSolidityProof: ({ publicInputs, proof, encryptedVote }: ProofData) => Hex;
 
 /**
  * A class representing the CRISP SDK.
@@ -264,4 +275,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 { 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 };