@crisp-e3/sdk 0.27.0-insecure.0 → 0.27.0

package/dist/index.d.ts

@@ -105,6 +105,35 @@ type ProofData = {
      */
     parentIndexPlusOne: number;
 };
+/**
+ * One proof in the ballot pipeline, in the order {@link finishBallotProof} produces them.
+ *
+ * - `encryption_ct0` (`user_data_encryption_ct0`) - `ct0 = pk0·u + e0 + k0·k1` with every term
+ *   bounded: the half of the ciphertext that carries the ballot plaintext `k1` is well formed.
+ * - `encryption_ct1` (`user_data_encryption_ct1`) - `ct1 = pk1·u + e1`: the other half is well
+ *   formed. It does not compare `u` with ct0's.
+ * - `ballot` (`crisp` / `crisp_onchain`) - the ballot rules. A vote is signed over the digest by the
+ *   slot owner and is within the voting power; a mask is zero everywhere. Either way the new slot
+ *   ciphertext is the ballot ciphertext plus the addend (the slot's current ciphertext for a mask,
+ *   zero otherwise).
+ * - `encryption` (`user_data_encryption`) - verifies both halves and asserts they share the same
+ *   randomness `u`, then commits to the key and the ciphertext.
+ * - `fold` (`fold` / `fold_onchain`) - verifies the encryption and ballot proofs, asserts they cover
+ *   the same ciphertext and plaintext, and outputs the key commitment, which the contract checks
+ *   against the round's committee key.
+ */
+type ProofStage = 'encryption_ct0' | 'encryption_ct1' | 'ballot' | 'encryption' | 'fold';
+/** Reported when a proof stage starts. The proof is complete when the promise resolves. */
+type ProofProgress = {
+    stage: ProofStage;
+    /** Zero-based position of `stage` in {@link PROOF_STAGES}. */
+    index: number;
+    total: number;
+};
+type ProofOptions = {
+    /** Called as each stage starts. Proving takes tens of seconds, so a client can show where it is. */
+    onProgress?: (progress: ProofProgress) => void;
+};
 /**
  * Which circuit a ballot is built for.
  *
@@ -679,6 +708,8 @@ declare const getBlockAtTimestamp: (serverUrl: string, timestamp: bigint) => Pro
  */
 declare const chainRpcUrl: (serverUrl: string) => string;
 
+/** The proofs `finishBallotProof` produces, in order. See {@link ProofStage}. */
+declare const PROOF_STAGES: readonly ProofStage[];
 declare const MERKLE_TREE_MAX_DEPTH = 20;
 declare const MAX_MSG_NON_ZERO_COEFFS = 50;
 declare const MAX_VOTE_OPTIONS = 10;
@@ -824,9 +855,10 @@ declare const prepareBallot: (inputs: PrepareBallotInputs) => Promise<PreparedBa
  * @param prepared The output of `prepareBallot`.
  * @param digest The ballot digest.
  * @param signature The voter signature over that digest.
+ * @param options `onProgress` reports each proof stage as it starts.
  * @returns The proof.
  */
-declare const finishBallotProof: (prepared: PreparedBallot, digest: `0x${string}`, signature: `0x${string}`) => Promise<ProofData>;
+declare const finishBallotProof: (prepared: PreparedBallot, digest: `0x${string}`, signature: `0x${string}`, options?: ProofOptions) => Promise<ProofData>;
 /**
  * Phase two for a mask.
  *
@@ -837,9 +869,10 @@ declare const finishBallotProof: (prepared: PreparedBallot, digest: `0x${string}
  *
  * @param prepared The output of `prepareBallot` with `isMaskVote: true`.
  * @param digest The ballot digest, from the same contract call a real vote would use.
+ * @param options `onProgress` reports each proof stage as it starts.
  * @returns The proof.
  */
-declare const finishMaskProof: (prepared: PreparedBallot, digest: `0x${string}`) => Promise<ProofData>;
+declare const finishMaskProof: (prepared: PreparedBallot, digest: `0x${string}`, options?: ProofOptions) => Promise<ProofData>;
 /**
  * Locally verify a Noir proof.
  * @param proof - The proof to verify.
@@ -945,9 +978,10 @@ declare class CrispSDK {
      * @param prepared - The output of {@link prepareBallot}.
      * @param digest - The digest read from `CRISPProgram.ballotDigest`.
      * @param signature - The voter signature, omitted for a mask.
+     * @param options - `onProgress` reports each proof stage as it starts.
      * @returns A promise that resolves to the generated proof data.
      */
-    finishBallot(prepared: PreparedBallot, digest: `0x${string}`, signature?: `0x${string}`): Promise<ProofData>;
+    finishBallot(prepared: PreparedBallot, digest: `0x${string}`, signature?: `0x${string}`, options?: ProofOptions): Promise<ProofData>;
     /**
      * Get the current (most recent) round, optionally filtered by requester addresses.
      * @param requesters - Optional list of requester addresses to filter by
@@ -1104,4 +1138,4 @@ declare class CrispSDK {
     getPreviousCiphertext(e3Id: bigint, address: string): Promise<SlotHead | undefined>;
 }
 
-export { type BroadcastVoteRequest, type BroadcastVoteResponse, type CensusVariant, type ChainHead, type ContractRead, type ContractReadResult, CreditMode, CrispSDK, type CurrentRoundResponse, type E3StateLiteResponse, type IndexedLog, type InputExclusionReason, type InputIdentity, type InputSelectionResponse, type InputSelectionStatus, type JsonResponse, type LogQuery, MAX_MSG_NON_ZERO_COEFFS, MAX_VOTE_OPTIONS, MERKLE_TREE_MAX_DEPTH, type NewRoundRequest, type OnChainRoundData, type PrepareBallotInputs, type PrepareBallotRequest, type PreparedBallot, type ProofData, type RoundDetails, SERVER_RPC, SIGNATURE_MESSAGE, SIGNATURE_MESSAGE_HASH, type SlotHead, type SubmissionStage, type SubmissionStageInputs, type SubmissionStatus, type TallyResult, type TokenDetails, type TokenHolder, type Vote, type VoteResponseStatus, type VoteStatusResponse, type WebResultResponse, broadcastVote, chainRpcUrl, decodeInputIdentity, decodeTally, decryptVote, destroyBBApi, encodeSolidityProof, encodeVote, encryptVote, finishBallotProof, finishMaskProof, generateBFVKeys, generateMerkleProof, generateMerkleTree, getAddressFromSignature, getAllRoundResults, getBalanceAt, getBlockAtTimestamp, getChainHead, getCurrentRound, getEligibleAddresses, getIndexedLogs, getInputSelection, getOnChainRoundData, getOnchainVotingPower, getPreviousCiphertext, getRoundCiphertext, getRoundDetails, getRoundPublicKey, getRoundResult, getRoundStateLite, getRoundTokenDetails, getSubmissionStage, getTokenHolderHashes, getTotalSupplyAt, getTreeData, getVoteAvailability, getVoteStatus, getZeroVote, hashLeaf, prepareBallot, prepareCircuitInputs, readContracts, requestNewRound, splitDigest, validateVote, verifyProof };
+export { type BroadcastVoteRequest, type BroadcastVoteResponse, type CensusVariant, type ChainHead, type ContractRead, type ContractReadResult, CreditMode, CrispSDK, type CurrentRoundResponse, type E3StateLiteResponse, type IndexedLog, type InputExclusionReason, type InputIdentity, type InputSelectionResponse, type InputSelectionStatus, type JsonResponse, type LogQuery, MAX_MSG_NON_ZERO_COEFFS, MAX_VOTE_OPTIONS, MERKLE_TREE_MAX_DEPTH, type NewRoundRequest, type OnChainRoundData, PROOF_STAGES, type PrepareBallotInputs, type PrepareBallotRequest, type PreparedBallot, type ProofData, type ProofOptions, type ProofProgress, type ProofStage, type RoundDetails, SERVER_RPC, SIGNATURE_MESSAGE, SIGNATURE_MESSAGE_HASH, type SlotHead, type SubmissionStage, type SubmissionStageInputs, type SubmissionStatus, type TallyResult, type TokenDetails, type TokenHolder, type Vote, type VoteResponseStatus, type VoteStatusResponse, type WebResultResponse, broadcastVote, chainRpcUrl, decodeInputIdentity, decodeTally, decryptVote, destroyBBApi, encodeSolidityProof, encodeVote, encryptVote, finishBallotProof, finishMaskProof, generateBFVKeys, generateMerkleProof, generateMerkleTree, getAddressFromSignature, getAllRoundResults, getBalanceAt, getBlockAtTimestamp, getChainHead, getCurrentRound, getEligibleAddresses, getIndexedLogs, getInputSelection, getOnChainRoundData, getOnchainVotingPower, getPreviousCiphertext, getRoundCiphertext, getRoundDetails, getRoundPublicKey, getRoundResult, getRoundStateLite, getRoundTokenDetails, getSubmissionStage, getTokenHolderHashes, getTotalSupplyAt, getTreeData, getVoteAvailability, getVoteStatus, getZeroVote, hashLeaf, prepareBallot, prepareCircuitInputs, readContracts, requestNewRound, splitDigest, validateVote, verifyProof };