@crisp-e3/sdk 0.4.2 → 0.5.3

package/dist/index.d.ts

@@ -94,11 +94,29 @@ type Vote = {
     no: bigint;
 };
 type MaskVoteProofInputs = {
-    previousCiphertext?: Uint8Array;
+    publicKey: Uint8Array;
+    balance: bigint;
+    slotAddress: string;
     merkleLeaves: string[] | bigint[];
+    isFirstVote: boolean;
+    previousCiphertext: Uint8Array;
+};
+type MaskVoteProofRequest = {
+    e3Id: number;
     publicKey: Uint8Array;
     balance: bigint;
     slotAddress: string;
+    merkleLeaves: string[] | bigint[];
+};
+type VoteProofRequest = {
+    e3Id: number;
+    merkleLeaves: string[] | bigint[];
+    publicKey: Uint8Array;
+    balance: bigint;
+    vote: Vote;
+    signature: `0x${string}`;
+    messageHash: `0x${string}`;
+    slotAddress: string;
 };
 type VoteProofInputs = {
     merkleLeaves: string[] | bigint[];
@@ -106,6 +124,10 @@ type VoteProofInputs = {
     balance: bigint;
     vote: Vote;
     signature: `0x${string}`;
+    messageHash: `0x${string}`;
+    slotAddress: string;
+    isFirstVote: boolean;
+    previousCiphertext: Uint8Array;
 };
 
 /**
@@ -119,18 +141,36 @@ declare const getRoundDetails: (serverUrl: string, e3Id: number) => Promise<Roun
  * @returns The token address, balance threshold and snapshot block
  */
 declare const getRoundTokenDetails: (serverUrl: string, e3Id: number) => Promise<TokenDetails>;
+/**
+ * Get the previous ciphertext for a slot from the CRISP server
+ * @param serverUrl - The base URL of the CRISP server
+ * @param e3Id - The e3Id of the round
+ * @param address - The address of the slot
+ * @returns The previous ciphertext for the slot
+ */
+declare const getPreviousCiphertext: (serverUrl: string, e3Id: number, address: string) => Promise<Uint8Array>;
+/**
+ * Check if a slot is empty for a given E3 ID and slot address
+ * @param serverUrl - The base URL of the CRISP server
+ * @param e3Id - The e3Id of the round
+ * @param address - The address of the slot
+ * @returns Whether the slot is empty or not
+ */
+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^28 - 1
- * The minimum degree that BFV should use is 56 (to accommodate both Yes and No votes)
+ * 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: bigint;
+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
+ * @notice Apps ideally want to use a different message to avoid signature reuse across different applications
  */
 declare const SIGNATURE_MESSAGE = "CRISP: Sign this message to prove ownership of your Ethereum account";
+declare const SIGNATURE_MESSAGE_HASH: `0x${string}`;
 
 /**
  * Hash a leaf node for the Merkle tree
@@ -152,18 +192,43 @@ declare const generateMerkleTree: (leaves: bigint[]) => LeanIMT;
  * @param leaves The leaves of the Merkle tree
  */
 declare const generateMerkleProof: (balance: bigint, address: string, leaves: bigint[] | string[]) => MerkleProof;
-declare const getAddressFromSignature: (signature: `0x${string}`) => Promise<string>;
+declare const getAddressFromSignature: (signature: `0x${string}`, messageHash?: `0x${string}`) => Promise<string>;
 
 /**
  * Decode an encoded tally into its decimal representation.
- * @param tally The encoded tally to decode.
+ * @param tallyBytes The encoded tally as a hex string (bytes).
  * @returns The decoded tally as an IVote.
  */
-declare const decodeTally: (tally: string[]) => Vote;
+declare const decodeTally: (tallyBytes: string) => Vote;
+/**
+ * Encrypt the vote using the public key.
+ * @param vote - The vote to encrypt.
+ * @param publicKey - The public key to use for encryption.
+ * @returns The encrypted vote as a Uint8Array.
+ */
 declare const encryptVote: (vote: Vote, publicKey: Uint8Array) => Uint8Array;
+/**
+ * Generate a random public key.
+ * @returns The generated public key as a Uint8Array.
+ */
 declare const generatePublicKey: () => Uint8Array;
+/**
+ * Generate a vote proof for the CRISP circuit given the vote proof inputs.
+ * @param voteProofInputs - The vote proof inputs.
+ * @returns The vote proof.
+ */
 declare const generateVoteProof: (voteProofInputs: VoteProofInputs) => Promise<ProofData>;
+/**
+ * Generate a proof for a vote masking operation.
+ * @param maskVoteProofInputs The mask vote proof inputs.
+ * @returns
+ */
 declare const generateMaskVoteProof: (maskVoteProofInputs: MaskVoteProofInputs) => Promise<ProofData>;
+/**
+ * Locally verify a Noir proof.
+ * @param proof - The proof to verify.
+ * @returns True if the proof is valid, false otherwise.
+ */
 declare const verifyProof: (proof: ProofData) => Promise<boolean>;
 /**
  * Encode the proof data into a format that can be used by the CRISP program in Solidity
@@ -173,4 +238,30 @@ declare const verifyProof: (proof: ProofData) => Promise<boolean>;
  */
 declare const encodeSolidityProof: (proof: ProofData) => Hex;
 
-export { MAXIMUM_VOTE_VALUE, MERKLE_TREE_MAX_DEPTH, type MaskVoteProofInputs, type RoundDetails, type RoundDetailsResponse, SIGNATURE_MESSAGE, type TokenDetails, type Vote, type VoteProofInputs, decodeTally, encodeSolidityProof, encryptVote, generateMaskVoteProof, generateMerkleProof, generateMerkleTree, generatePublicKey, generateVoteProof, getAddressFromSignature, getBalanceAt, getRoundDetails, getRoundTokenDetails, getTotalSupplyAt, getTreeData, hashLeaf, verifyProof };
+/**
+ * A class representing the Crisp SDK.
+ */
+declare class CrispSDK {
+    /**
+     * The server URL for the Crisp SDK.
+     * It's used by methods that communicate directly with the Crisp server.
+     */
+    private serverUrl;
+    /**
+     * Create a new instance
+     * @param serverUrl
+     */
+    constructor(serverUrl: string);
+    /**
+     * Generate a proof for a vote masking.
+     */
+    generateMaskVoteProof(maskProofInputs: MaskVoteProofRequest): Promise<ProofData>;
+    /**
+     * Generate a proof for a vote.
+     * @param voteProofInputs - The inputs required to generate the vote proof.
+     * @returns A promise that resolves to the generated proof data.
+     */
+    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 };