@crisp-e3/sdk 0.12.0 → 0.14.0

package/dist/index.d.ts

@@ -38,6 +38,7 @@ type RoundDetails = {
     startTime: bigint;
     endTime: bigint;
     startBlock: bigint;
+    snapshotBlock: bigint;
     committeePublicKey: Uint8Array;
     emojis: [string, string];
     tokenAddress: string;
@@ -47,6 +48,17 @@ type RoundDetails = {
     creditMode: CreditMode;
     credits?: bigint;
 };
+/**
+ * Type representing the round data stored in the CRISPProgram contract
+ */
+type OnChainRoundData = {
+    merkleRoot: bigint;
+    paramsHash: `0x${string}`;
+    numOptions: bigint;
+    creditMode: CreditMode;
+    inputRoot: bigint;
+    numberOfVotes: bigint;
+};
 /**
  * Type representing the token details required for participation in a round
  */
@@ -128,6 +140,7 @@ type E3StateLiteResponse = {
     start_time: number;
     end_time: number;
     start_block: number;
+    snapshot_block: number;
     committee_public_key: number[];
     emojis: [string, string];
     token_address: string;
@@ -224,6 +237,19 @@ 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 round data stored in the CRISPProgram contract, such as the merkle root
+ * of the census and the merkle root of the encrypted votes published so far.
+ *
+ * Unlike {@link getRoundDetails}, this reads directly from the chain and so does not
+ * depend on the CRISP server.
+ *
+ * @param programAddress - The address of the CRISPProgram contract
+ * @param e3Id - The e3Id of the round
+ * @param chainId - The chain ID of the network the program is deployed on
+ * @returns The on chain round data
+ */
+declare const getOnChainRoundData: (programAddress: string, e3Id: number, chainId: number) => Promise<OnChainRoundData>;
 /**
  * Get the previous ciphertext for a slot from the CRISP server.
  * Returns undefined when the slot is empty (404).
@@ -531,6 +557,17 @@ declare class CrispSDK {
      * @returns The round details
      */
     getRoundDetails(e3Id: number): Promise<RoundDetails>;
+    /**
+     * Get the round data stored in the CRISPProgram contract, read directly from the chain.
+     *
+     * When the chain id is omitted it is looked up on the CRISP server.
+     *
+     * @param programAddress - The address of the CRISPProgram contract
+     * @param e3Id - The e3Id of the round
+     * @param chainId - The chain ID of the network the program is deployed on
+     * @returns The on chain round data
+     */
+    getOnChainRoundData(programAddress: string, e3Id: number, chainId?: number): Promise<OnChainRoundData>;
     /**
      * Get the token address, balance threshold and snapshot block for a specific round.
      * @param e3Id - The e3Id of the round
@@ -559,4 +596,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 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, 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 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 };

package/dist/index.js

@@ -20,8 +20,30 @@ var SIGNATURE_MESSAGE_HASH = hashMessage(SIGNATURE_MESSAGE);
 var MASK_SIGNATURE = "0x8e7d77112641d59e9409ec3052041703bb9d9e6ed39bfcf75aefbcafe829ac6b21dd7648116ad5db0466fcb4bd468dcb28f6c069def8bc47cd9d859c85a016e31b";
 
 // src/token.ts
-import { createPublicClient, http, parseAbi } from "viem";
+import { parseAbi } from "viem";
+
+// src/chain.ts
+import { createPublicClient, http } from "viem";
 import { localhost, sepolia } from "viem/chains";
+var getPublicClient = (chainId) => {
+  let chain;
+  switch (chainId) {
+    case 11155111:
+      chain = sepolia;
+      break;
+    case 31337:
+      chain = localhost;
+      break;
+    default:
+      throw new Error("Unsupported chainId");
+  }
+  return createPublicClient({
+    transport: http(),
+    chain
+  });
+};
+
+// src/token.ts
 var getTreeData = async (serverUrl, e3Id) => {
   const response = await fetch(`${serverUrl}/${CRISP_SERVER_TOKEN_TREE_ENDPOINT}`, {
     method: "POST",
@@ -39,21 +61,7 @@ var getTreeData = async (serverUrl, e3Id) => {
   });
 };
 var getBalanceAt = async (voterAddress, tokenAddress, snapshotBlock, chainId) => {
-  let chain;
-  switch (chainId) {
-    case 11155111:
-      chain = sepolia;
-      break;
-    case 31337:
-      chain = localhost;
-      break;
-    default:
-      throw new Error("Unsupported chainId");
-  }
-  const publicClient = createPublicClient({
-    transport: http(),
-    chain
-  });
+  const publicClient = getPublicClient(chainId);
   const balance = await publicClient.readContract({
     address: tokenAddress,
     abi: parseAbi(["function getPastVotes(address, uint256) view returns (uint256)"]),
@@ -63,21 +71,7 @@ var getBalanceAt = async (voterAddress, tokenAddress, snapshotBlock, chainId) =>
   return balance;
 };
 var getTotalSupplyAt = async (tokenAddress, snapshotBlock, chainId) => {
-  let chain;
-  switch (chainId) {
-    case 11155111:
-      chain = sepolia;
-      break;
-    case 31337:
-      chain = localhost;
-      break;
-    default:
-      throw new Error("Unsupported chainId");
-  }
-  const publicClient = createPublicClient({
-    transport: http(),
-    chain
-  });
+  const publicClient = getPublicClient(chainId);
   const totalSupply = await publicClient.readContract({
     address: tokenAddress,
     abi: parseAbi(["function getPastTotalSupply(uint256) view returns (uint256)"]),
@@ -87,6 +81,9 @@ var getTotalSupplyAt = async (tokenAddress, snapshotBlock, chainId) => {
   return totalSupply;
 };
 
+// src/state.ts
+import { parseAbi as parseAbi2 } from "viem";
+
 // src/api.ts
 var postJson = async (serverUrl, endpoint, body) => {
   const response = await fetch(`${serverUrl}/${endpoint}`, {
@@ -175,6 +172,7 @@ var getRoundDetails = async (serverUrl, e3Id) => {
     startTime: BigInt(data.start_time),
     endTime: BigInt(data.end_time),
     startBlock: BigInt(data.start_block),
+    snapshotBlock: BigInt(data.snapshot_block),
     committeePublicKey: new Uint8Array(data.committee_public_key),
     emojis: data.emojis,
     numOptions: BigInt(data.num_options),
@@ -188,7 +186,26 @@ var getRoundTokenDetails = async (serverUrl, e3Id) => {
   return {
     tokenAddress: roundDetails.tokenAddress,
     threshold: roundDetails.balanceThreshold,
-    snapshotBlock: roundDetails.startBlock
+    snapshotBlock: roundDetails.snapshotBlock
+  };
+};
+var getOnChainRoundData = async (programAddress, e3Id, chainId) => {
+  const publicClient = getPublicClient(chainId);
+  const [merkleRoot, paramsHash, numOptions, creditMode, inputRoot, numberOfVotes] = await publicClient.readContract({
+    address: programAddress,
+    abi: parseAbi2([
+      "function getRoundData(uint256 e3Id) view returns (uint256 merkleRoot, bytes32 paramsHash, uint256 numOptions, uint8 creditMode, uint256 inputRoot, uint40 numberOfVotes)"
+    ]),
+    functionName: "getRoundData",
+    args: [BigInt(e3Id)]
+  });
+  return {
+    merkleRoot,
+    paramsHash,
+    numOptions,
+    creditMode,
+    inputRoot,
+    numberOfVotes: BigInt(numberOfVotes)
   };
 };
 var getPreviousCiphertext = async (serverUrl, e3Id, address) => {
@@ -3543,6 +3560,20 @@ var CrispSDK = class {
   async getRoundDetails(e3Id) {
     return getRoundDetails(this.serverUrl, e3Id);
   }
+  /**
+   * Get the round data stored in the CRISPProgram contract, read directly from the chain.
+   *
+   * When the chain id is omitted it is looked up on the CRISP server.
+   *
+   * @param programAddress - The address of the CRISPProgram contract
+   * @param e3Id - The e3Id of the round
+   * @param chainId - The chain ID of the network the program is deployed on
+   * @returns The on chain round data
+   */
+  async getOnChainRoundData(programAddress, e3Id, chainId) {
+    const chain = chainId ?? Number((await getRoundDetails(this.serverUrl, e3Id)).chainId);
+    return getOnChainRoundData(programAddress, e3Id, chain);
+  }
   /**
    * Get the token address, balance threshold and snapshot block for a specific round.
    * @param e3Id - The e3Id of the round
@@ -3609,6 +3640,7 @@ export {
   getCurrentRound,
   getEligibleAddresses,
   getMaxVoteValue,
+  getOnChainRoundData,
   getPreviousCiphertext,
   getRoundCiphertext,
   getRoundDetails,