@crisp-e3/sdk 0.14.0 → 0.16.0

package/dist/index.d.ts

@@ -81,6 +81,15 @@ type MerkleProof = {
  * Type representing a vote
  */
 type Vote = number[];
+/**
+ * Type representing a decoded tally: one total per option.
+ *
+ * @remarks
+ * Uses `bigint` because an aggregated tally coefficient is a sum over all ballots,
+ * so a total can exceed `Number.MAX_SAFE_INTEGER`. This matches the `BigUint` the
+ * CRISP server returns and the `uint256` the CRISP contract returns.
+ */
+type TallyResult = bigint[];
 type ProofData = {
     publicInputs: string[];
     proof: Uint8Array;
@@ -405,6 +414,17 @@ declare const getScaledBalance: (balance: bigint, decimals: bigint) => bigint;
  * encoding, encryption, decryption, and tally decoding.
  */
 
+/**
+ * Encodes vote choices into a polynomial coefficient array for BFV encryption.
+ * Each choice occupies floor(MAX_MSG_NON_ZERO_COEFFS / n) binary coefficients;
+ * remaining slots in the first MAX_MSG_NON_ZERO_COEFFS coeffs are zero; then
+ * the vector is padded to the BFV degree.
+ *
+ * @param vote - Array of numeric values per choice (e.g. [10, 5] for 2 options)
+ * @returns Array of 0s and 1s representing coefficients
+ * @throws If vote has fewer than 2 choices, any value exceeds max for its segment, or degree is too small
+ */
+declare const encodeVote: (vote: Vote) => number[];
 /**
  * Encrypts an encoded vote using BFV homomorphic encryption.
  *
@@ -414,14 +434,29 @@ declare const getScaledBalance: (balance: bigint, decimals: bigint) => bigint;
  */
 declare const encryptVote: (vote: Vote, publicKey: Uint8Array) => Uint8Array;
 /**
- * Decodes raw tally bytes (or hex string) into vote values per choice.
+ * Decodes raw tally bytes (or coefficients) into a total per choice.
  * Expects the same segment layout as used in encodeVote.
  *
- * @param tallyBytes - Hex string or array of decoded numbers from tally/decryption
+ * Mirrors `crisp_utils::decode_tally` (Rust) and `CRISPProgram.decodeTally` (Solidity):
+ * only the first MAX_MSG_NON_ZERO_COEFFS coefficients carry the payload, split into
+ * `floor(MAX_MSG_NON_ZERO_COEFFS / numChoices)` binary coefficients per choice, MSB first.
+ *
+ * @param tallyBytes - Hex string, or the polynomial coefficients from tally/decryption
+ * @param numChoices - Number of vote options: an integer from 2 to MAX_VOTE_OPTIONS
+ * @returns One total per choice
+ * @throws If numChoices is outside 2..MAX_VOTE_OPTIONS or not an integer, or there are fewer
+ *         coefficients than the payload region
+ */
+declare const decodeTally: (tallyBytes: string | number[] | bigint[], numChoices: number) => TallyResult;
+/**
+ * Decrypts a BFV-encrypted vote and decodes it to vote values.
+ *
+ * @param ciphertext - Encrypted vote
+ * @param secretKey - BFV secret key
  * @param numChoices - Number of vote options
- * @returns Vote array with one value per choice
+ * @returns One total per choice
  */
-declare const decodeTally: (tallyBytes: string | number[], numChoices: number) => Vote;
+declare const decryptVote: (ciphertext: Uint8Array, secretKey: Uint8Array, numChoices: number) => TallyResult;
 /**
  * Generates a BFV keypair for vote encryption and decryption.
  *
@@ -596,4 +631,4 @@ declare class CrispSDK {
     getPreviousCiphertext(e3Id: number, address: string): Promise<Uint8Array | undefined>;
 }
 
-export { type BroadcastVoteRequest, type BroadcastVoteResponse, CreditMode, CrispSDK, type CurrentRoundResponse, type E3StateLiteResponse, type JsonResponse, MAX_MSG_NON_ZERO_COEFFS, MAX_VOTE_OPTIONS, MERKLE_TREE_MAX_DEPTH, type MaskVoteProofInputs, type NewRoundRequest, type OnChainRoundData, type ProofData, type RoundDetails, SIGNATURE_MESSAGE, SIGNATURE_MESSAGE_HASH, type TokenDetails, type TokenHolder, type Vote, type VoteProofInputs, type VoteResponseStatus, type VoteStatusResponse, type WebResultResponse, broadcastVote, decodeTally, destroyBBApi, encodeSolidityProof, encryptVote, generateBFVKeys, generateMaskVoteProof, generateMerkleProof, generateMerkleTree, generateVoteProof, getAddressFromSignature, getAllRoundResults, getBalanceAt, getCurrentRound, getEligibleAddresses, getMaxVoteValue, getOnChainRoundData, getPreviousCiphertext, getRoundCiphertext, getRoundDetails, getRoundPublicKey, getRoundResult, getRoundStateLite, getRoundTokenDetails, getScaledBalance, getTokenHolderHashes, getTotalSupplyAt, getTreeData, getVoteStatus, getZeroVote, hashLeaf, requestNewRound, validateVote, verifyProof };
+export { type BroadcastVoteRequest, type BroadcastVoteResponse, CreditMode, CrispSDK, type CurrentRoundResponse, type E3StateLiteResponse, type JsonResponse, MAX_MSG_NON_ZERO_COEFFS, MAX_VOTE_OPTIONS, MERKLE_TREE_MAX_DEPTH, type MaskVoteProofInputs, type NewRoundRequest, type OnChainRoundData, type ProofData, type RoundDetails, SIGNATURE_MESSAGE, SIGNATURE_MESSAGE_HASH, type TallyResult, type TokenDetails, type TokenHolder, type Vote, type VoteProofInputs, type VoteResponseStatus, type VoteStatusResponse, type WebResultResponse, broadcastVote, decodeTally, decryptVote, destroyBBApi, encodeSolidityProof, encodeVote, encryptVote, generateBFVKeys, generateMaskVoteProof, generateMerkleProof, generateMerkleTree, generateVoteProof, getAddressFromSignature, getAllRoundResults, getBalanceAt, getCurrentRound, getEligibleAddresses, getMaxVoteValue, getOnChainRoundData, getPreviousCiphertext, getRoundCiphertext, getRoundDetails, getRoundPublicKey, getRoundResult, getRoundStateLite, getRoundTokenDetails, getScaledBalance, getTokenHolderHashes, getTotalSupplyAt, getTreeData, getVoteStatus, getZeroVote, hashLeaf, requestNewRound, validateVote, verifyProof };