@crisp-e3/sdk 0.2.2-test → 0.3.0-test

package/LICENSE.md

@@ -1,102 +1,83 @@
-GNU LESSER GENERAL PUBLIC LICENSE
-                      Version 3, 29 June 2007
+GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007
 
-Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy
+and distribute verbatim copies of this license document, but changing it is not allowed.
 
+This version of the GNU Lesser General Public License incorporates the terms and conditions of
+version 3 of the GNU General Public License, supplemented by the additional permissions listed
+below.
 
- This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
+0.  Additional Definitions.
 
- 0. Additional Definitions.
+As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the
+"GNU GPL" refers to version 3 of the GNU General Public License.
 
- As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
+"The Library" refers to a covered work governed by this License, other than an Application or a
+Combined Work as defined below.
 
- "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
+An "Application" is any work that makes use of an interface provided by the Library, but which is
+not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed
+a mode of using an interface provided by the Library.
 
- An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
- A "Combined Work" is a work produced by combining or linking an
-Application with the Library.  The particular version of the Library
-with which the Combined Work was made is also called the "Linked
+A "Combined Work" is a work produced by combining or linking an Application with the Library. The
+particular version of the Library with which the Combined Work was made is also called the "Linked
 Version".
 
- The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
+The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the
+Combined Work, excluding any source code for portions of the Combined Work that, considered in
+isolation, are based on the Application, and not on the Linked Version.
 
- The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
+The "Corresponding Application Code" for a Combined Work means the object code and/or source code
+for the Application, including any data and utility programs needed for reproducing the Combined
+Work from the Application, but excluding the System Libraries of the Combined Work.
 
- 1. Exception to Section 3 of the GNU GPL.
+1.  Exception to Section 3 of the GNU GPL.
 
- You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
+You may convey a covered work under sections 3 and 4 of this License without being bound by section
+3 of the GNU GPL.
 
- 2. Conveying Modified Versions.
+2.  Conveying Modified Versions.
 
- If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
+If you modify a copy of the Library, and, in your modifications, a facility refers to a function or
+data to be supplied by an Application that uses the facility (other than as an argument passed when
+the facility is invoked), then you may convey a copy of the modified version:
 
-  a) under this License, provided that you make a good faith effort to
-  ensure that, in the event an Application does not supply the
-  function or data, the facility still operates, and performs
-  whatever part of its purpose remains meaningful, or
+a) under this License, provided that you make a good faith effort to ensure that, in the event an
+Application does not supply the function or data, the facility still operates, and performs whatever
+part of its purpose remains meaningful, or
 
-  b) under the GNU GPL, with none of the additional permissions of
-  this License applicable to that copy.
+b) under the GNU GPL, with none of the additional permissions of this License applicable to that
+copy.
 
- 3. Object Code Incorporating Material from Library Header Files.
+3.  Object Code Incorporating Material from Library Header Files.
 
- The object code form of an Application may incorporate material from
-a header file that is part of the Library.  You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
+The object code form of an Application may incorporate material from a header file that is part of
+the Library. You may convey such object code under terms of your choice, provided that, if the
+incorporated material is not limited to numerical parameters, data structure layouts and accessors,
+or small macros, inline functions and templates (ten or fewer lines in length), you do both of the
+following:
 
-  a) Give prominent notice with each copy of the object code that the
-  Library is used in it and that the Library and its use are
-  covered by this License.
+a) Give prominent notice with each copy of the object code that the Library is used in it and that
+the Library and its use are covered by this License.
 
-  b) Accompany the object code with a copy of the GNU GPL and this license
-  document.
+b) Accompany the object code with a copy of the GNU GPL and this license document.
 
- 4. Combined Works.
+4.  Combined Works.
 
- You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
+You may convey a Combined Work under terms of your choice that, taken together, effectively do not
+restrict modification of the portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of the following:
 
-  a) Give prominent notice with each copy of the Combined Work that
-  the Library is used in it and that the Library and its use are
-  covered by this License.
+a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that
+the Library and its use are covered by this License.
 
-  b) Accompany the Combined Work with a copy of the GNU GPL and this license
-  document.
+b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
 
-  c) For a Combined Work that displays copyright notices during
-  execution, include the copyright notice for the Library among
-  these notices, as well as a reference directing the user to the
-  copies of the GNU GPL and this license document.
+c) For a Combined Work that displays copyright notices during execution, include the copyright
+notice for the Library among these notices, as well as a reference directing the user to the copies
+of the GNU GPL and this license document.
 
-  d) Do one of the following:
+d) Do one of the following:
 
       0) Convey the Minimal Corresponding Source under the terms of this
       License, and the Corresponding Application Code in a form
@@ -113,53 +94,41 @@ the following:
       of the Library that is interface-compatible with the Linked
       Version.
 
-  e) Provide Installation Information, but only if you would otherwise
-  be required to provide such information under section 6 of the
-  GNU GPL, and only to the extent that such information is
-  necessary to install and execute a modified version of the
-  Combined Work produced by recombining or relinking the
-  Application with a modified version of the Linked Version. (If
-  you use option 4d0, the Installation Information must accompany
-  the Minimal Corresponding Source and Corresponding Application
-  Code. If you use option 4d1, you must provide the Installation
-  Information in the manner specified by section 6 of the GNU GPL
-  for conveying Corresponding Source.)
-
- 5. Combined Libraries.
-
- You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
-  a) Accompany the combined library with a copy of the same work based
-  on the Library, uncombined with any other library facilities,
-  conveyed under the terms of this License.
-
-  b) Give prominent notice with the combined library that part of it
-  is a work based on the Library, and explaining where to find the
-  accompanying uncombined form of the same work.
-
- 6. Revised Versions of the GNU Lesser General Public License.
-
- The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
- Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
- If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.
+e) Provide Installation Information, but only if you would otherwise be required to provide such
+information under section 6 of the GNU GPL, and only to the extent that such information is
+necessary to install and execute a modified version of the Combined Work produced by recombining or
+relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the
+Installation Information must accompany the Minimal Corresponding Source and Corresponding
+Application Code. If you use option 4d1, you must provide the Installation Information in the manner
+specified by section 6 of the GNU GPL for conveying Corresponding Source.)
+
+5.  Combined Libraries.
+
+You may place library facilities that are a work based on the Library side by side in a single
+library together with other library facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your choice, if you do both of the
+following:
+
+a) Accompany the combined library with a copy of the same work based on the Library, uncombined with
+any other library facilities, conveyed under the terms of this License.
+
+b) Give prominent notice with the combined library that part of it is a work based on the Library,
+and explaining where to find the accompanying uncombined form of the same work.
+
+6.  Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General
+Public License from time to time. Such new versions will be similar in spirit to the present
+version, but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library as you received it specifies
+that a certain numbered version of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and conditions either of that published
+version or of any later version published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser General Public License, you may
+choose any version of the GNU Lesser General Public License ever published by the Free Software
+Foundation.
+
+If the Library as you received it specifies that a proxy can decide whether future versions of the
+GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any
+version is permanent authorization for you to choose that version for the Library.

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { LeanIMTMerkleProof, LeanIMT } from '@zk-kit/lean-imt';
 import { ProofData } from '@aztec/bb.js';
+import { Hex } from 'viem';
 
 /**
  * Get the merkle tree data from the CRISP server
@@ -174,14 +175,6 @@ interface CRISPCircuitInputs {
     balance: string;
     is_first_vote: boolean;
 }
-/**
- * Interface representing the BFV parameters
- */
-interface BFVParams {
-    degree: number;
-    plaintextModulus: bigint;
-    moduli: BigInt64Array;
-}
 /**
  * Interface representing the inputs for Noir signature verification
  */
@@ -214,7 +207,6 @@ interface EncryptVoteAndGenerateCRISPInputsParams {
     message: string;
     merkleData: IMerkleProof;
     balance: bigint;
-    bfvParams?: BFVParams;
     slotAddress: string;
     isFirstVote: boolean;
 }
@@ -244,11 +236,6 @@ declare const HALF_LARGEST_MINIMUM_DEGREE = 28;
  * The minimum degree that BFV should use is 56 (to accommodate both Yes and No votes)
  */
 declare const MAXIMUM_VOTE_VALUE: bigint;
-/**
- * Default BFV parameters for the CRISP ZK inputs generator.
- * These are the parameters used for the default testing purposes only.
- */
-declare const DEFAULT_BFV_PARAMS: BFVParams;
 /**
  * Mock message for masking signature
  */
@@ -303,7 +290,7 @@ declare const calculateValidIndicesForPlaintext: (totalVotingPower: bigint, degr
  * @param bfvParams The BFV parameters to use for encoding
  * @returns The encoded vote as a string
  */
-declare const encodeVote: (vote: IVote, votingMode: VotingMode, votingPower: bigint, bfvParams?: BFVParams) => string[];
+declare const encodeVote: (vote: IVote, votingMode: VotingMode, votingPower: bigint) => string[];
 /**
  * Given an encoded tally, decode it into its decimal representation
  * @param tally The encoded tally to decode
@@ -318,6 +305,7 @@ declare const decodeTally: (tally: string[], votingMode: VotingMode) => IVote;
  */
 declare const validateVote: (votingMode: VotingMode, vote: IVote, votingPower: bigint) => void;
 declare const encryptVote: (encodedVote: string[], publicKey: Uint8Array) => Promise<Uint8Array>;
+declare const generatePublicKey: () => Promise<Uint8Array>;
 /**
  * This is a wrapper around enclave-e3/sdk encryption functions as CRISP circuit will require some more
  * input values which generic Greco do not need.
@@ -333,19 +321,18 @@ declare const encryptVote: (encodedVote: string[], publicKey: Uint8Array) => Pro
  * @param isFirstVote Whether this is the first vote for this slot
  * @returns The CRISP circuit inputs
  */
-declare const encryptVoteAndGenerateCRISPInputs: ({ encodedVote, publicKey, previousCiphertext, bfvParams, merkleData, message, signature, balance, slotAddress, isFirstVote, }: EncryptVoteAndGenerateCRISPInputsParams) => Promise<CRISPCircuitInputs>;
+declare const encryptVoteAndGenerateCRISPInputs: ({ encodedVote, publicKey, previousCiphertext, merkleData, message, signature, balance, slotAddress, isFirstVote, }: EncryptVoteAndGenerateCRISPInputsParams) => Promise<CRISPCircuitInputs>;
 /**
  * A function to generate the data required to mask a vote
  * @param voter The voter's address
  * @param publicKey The voter's public key
  * @param previousCiphertext The previous ciphertext
- * @param bfvParams The BFV parameters
  * @param merkleRoot The merkle root of the census tree
  * @param slotAddress The voter's slot address
  * @param isFirstVote Whether this is the first vote for this slot
  * @returns The CRISP circuit inputs for a mask vote
  */
-declare const generateMaskVote: (publicKey: Uint8Array, previousCiphertext: Uint8Array, bfvParams: BFVParams | undefined, merkleRoot: bigint, slotAddress: string, isFirstVote: boolean) => Promise<CRISPCircuitInputs>;
+declare const generateMaskVote: (publicKey: Uint8Array, previousCiphertext: Uint8Array, merkleRoot: bigint, slotAddress: string, isFirstVote: boolean) => Promise<CRISPCircuitInputs>;
 declare const generateProof: (crispInputs: CRISPCircuitInputs) => Promise<ProofData>;
 declare const generateProofWithReturnValue: (crispInputs: CRISPCircuitInputs) => Promise<{
     returnValue: unknown;
@@ -355,6 +342,13 @@ declare const getCircuitOutputValue: (crispInputs: CRISPCircuitInputs) => Promis
     returnValue: unknown;
 }>;
 declare const verifyProof: (proof: ProofData) => Promise<boolean>;
+/**
+ * Encode the proof data into a format that can be used by the CRISP program in Solidity
+ * to validate the proof.
+ * @param proof The proof data.
+ * @returns The encoded proof data as a hex string.
+ */
+declare const encodeSolidityProof: (proof: ProofData) => Hex;
 
 /**
  * Given a message and its signed version, extract the signature components
@@ -364,4 +358,4 @@ declare const verifyProof: (proof: ProofData) => Promise<boolean>;
  */
 declare const extractSignature: (message: string, signedMessage: `0x${string}`) => Promise<NoirSignatureInputs>;
 
-export { type CRISPCircuitInputs, CRISP_SERVER_STATE_LITE_ENDPOINT, CRISP_SERVER_TOKEN_TREE_ENDPOINT, DEFAULT_BFV_PARAMS, HALF_LARGEST_MINIMUM_DEGREE, type IMerkleProof, type IRoundDetails, type IRoundDetailsResponse, type ITokenDetails, type IVote, MAXIMUM_VOTE_VALUE, MERKLE_TREE_MAX_DEPTH, MESSAGE, type NoirSignatureInputs, VotingMode, calculateValidIndicesForPlaintext, decodeTally, encodeVote, encryptVote, encryptVoteAndGenerateCRISPInputs, extractSignature, generateMaskVote, generateMerkleProof, generateMerkleTree, generateProof, generateProofWithReturnValue, getBalanceAt, getCircuitOutputValue, getRoundDetails, getRoundTokenDetails, getTotalSupplyAt, getTreeData, hashLeaf, toBinary, validateVote, verifyProof };
+export { type CRISPCircuitInputs, CRISP_SERVER_STATE_LITE_ENDPOINT, CRISP_SERVER_TOKEN_TREE_ENDPOINT, HALF_LARGEST_MINIMUM_DEGREE, type IMerkleProof, type IRoundDetails, type IRoundDetailsResponse, type ITokenDetails, type IVote, MAXIMUM_VOTE_VALUE, MERKLE_TREE_MAX_DEPTH, MESSAGE, type NoirSignatureInputs, VotingMode, calculateValidIndicesForPlaintext, decodeTally, encodeSolidityProof, encodeVote, encryptVote, encryptVoteAndGenerateCRISPInputs, extractSignature, generateMaskVote, generateMerkleProof, generateMerkleTree, generateProof, generateProofWithReturnValue, generatePublicKey, getBalanceAt, getCircuitOutputValue, getRoundDetails, getRoundTokenDetails, getTotalSupplyAt, getTreeData, hashLeaf, toBinary, validateVote, verifyProof };