@crisp-e3/sdk 0.4.1 → 0.5.2

package/README.md

@@ -1,7 +1,7 @@
 # CRISP SDK
 
-TypeScript SDK for interacting with CRISP (Cryptographically Secure and Private voting protocol) and
-the CRISP server.
+TypeScript SDK for interacting with CRISP (Coercion-Resistant Impartial Selection Protocol) and the
+CRISP server.
 
 ## Installation
 

package/dist/index.d.ts

@@ -106,6 +106,8 @@ type VoteProofInputs = {
     balance: bigint;
     vote: Vote;
     signature: `0x${string}`;
+    previousCiphertext?: Uint8Array;
+    messageHash: `0x${string}`;
 };
 
 /**
@@ -122,15 +124,17 @@ declare const getRoundTokenDetails: (serverUrl: string, e3Id: number) => Promise
 
 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;
 /**
  * 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,7 +156,7 @@ 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.
@@ -173,4 +177,4 @@ 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 };
+export { 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, getRoundDetails, getRoundTokenDetails, getTotalSupplyAt, getTreeData, hashLeaf, verifyProof };