@dorafactory/maci-sdk 0.0.27 → 0.0.28

package/dist/index.d.mts

@@ -243,6 +243,7 @@ type RoundType = {
     voiceCreditAmount: string;
     preDeactivateRoot: string;
     identity: string;
+    funds: string;
     operatorLogoUrl?: string;
     operatorMoniker?: string;
     resultsList?: {
@@ -250,6 +251,7 @@ type RoundType = {
         v2: number;
     }[];
 };
+type SelectiveRoundType = Partial<RoundType>;
 type ProofType = {
     nodes: {
         id: string;
@@ -454,6 +456,9 @@ type TransactionsResponse = SuccessResponse<{
 type RoundResponse = SuccessResponse<{
     round: RoundType;
 }> | ErrorResponse;
+type SelectiveRoundResponse = SuccessResponse<{
+    round: SelectiveRoundType;
+}> | ErrorResponse;
 type RoundsResponse = SuccessResponse<{
     rounds: {
         pageInfo: {
@@ -472,6 +477,14 @@ type RoundGraphqlResponse = {
         round: RoundType;
     };
 };
+/**
+ * GraphQL response type for selective round fields
+ */
+type SelectiveRoundGraphqlResponse = {
+    data: {
+        round: SelectiveRoundType;
+    };
+};
 type RoundsGraphqlResponse = {
     data: {
         rounds: {
@@ -548,6 +561,13 @@ declare class Round {
     http: Http;
     constructor(http: Http);
     getRoundById(address: string): Promise<RoundResponse>;
+    /**
+     * Get round information with selective fields
+     * @param address Round address
+     * @param fields Array of fields to return, returns all fields if empty
+     * @returns Round information response
+     */
+    getRoundWithFields(address: string, fields?: string[]): Promise<SelectiveRoundResponse>;
     getRounds(after: string, limit?: number): Promise<RoundsResponse>;
     getRoundsByCircuitName(circuitName: string, after: string, limit?: number): Promise<RoundsResponse>;
     getRoundsByStatus(status: string, after: string, limit?: number): Promise<RoundsResponse>;
@@ -616,6 +636,14 @@ declare class Indexer {
      * @returns {Promise<RoundResponse>} The round response.
      */
     getRoundById(id: string): Promise<RoundResponse>;
+    /**
+     * @method getRoundWithFields
+     * @description Get a round by its address with selective fields.
+     * @param {string} address - The address of the round.
+     * @param {string[]} [fields] - The fields to retrieve.
+     * @returns {Promise<SelectiveRoundResponse>} The round response.
+     */
+    getRoundWithFields(address: string, fields?: string[]): Promise<SelectiveRoundResponse>;
     /**
      * @method getRounds
      * @description Get multiple rounds.
@@ -1760,6 +1788,10 @@ declare class MACI {
         address: string;
         contractAddress: string;
     }): Promise<FeegrantAllowanceResponse>;
+    hasFeegrant({ address, contractAddress, }: {
+        address: string;
+        contractAddress: string;
+    }): Promise<boolean>;
     queryWhitelistBalanceOf({ signer, address, contractAddress, certificate, mode, }: {
         signer: OfflineSigner;
         address: string;
@@ -1985,6 +2017,7 @@ interface NetworkConfig {
     oracleCodeId: number;
     oracleWhitelistBackendPubkey: string;
     oracleFeegrantOperator: string;
+    oracleCodeIds: string[];
 }
 declare function getDefaultParams(network?: 'mainnet' | 'testnet'): NetworkConfig;
 
@@ -2054,6 +2087,14 @@ declare class MaciClient {
      * @returns {Promise<RoundResponse>} The round response.
      */
     getRoundById(id: string): Promise<RoundResponse>;
+    /**
+     * @method getRoundWithFields
+     * @description Get a round by its address with selective fields.
+     * @param {string} address - The address of the round.
+     * @param {string[]} [fields] - The fields to retrieve.
+     * @returns {Promise<SelectiveRoundResponse>} The round response.
+     */
+    getRoundWithFields(address: string, fields?: string[]): Promise<SelectiveRoundResponse>;
     /**
      * @method getRounds
      * @description Get multiple rounds.
@@ -2168,4 +2209,4 @@ declare function decompressPublicKey(compressedPubkey: string): {
 };
 declare function compressPublicKey(decompressedPubkey: any[]): string;
 
-export { type Account, type BalanceResponse, type CertificateEcosystem, Circom, Circuit, type CircuitResponse, type CircuitType, type CircuitsCountGraphqlResponse, type CircuitsResponse, type ClientParams, Contract, type ContractParams, type CreateAMaciRoundParams, type CreateMaciRoundParams, type CreateOracleMaciRoundParams, type CreateRoundParams, type ErrorResponse, Event, Http, Indexer, MACI, MaciCertSystemType, MaciCircuitType, MaciClient, MaciRoundType, type MissRateResponse, type MissRateType, type NetworkConfig, Operator, type OperatorDelayOperationsGraphqlResponse, type OperatorDelayOperationsResponse, type OperatorDelayType, type OperatorResponse, type OperatorType, type OperatorsGraphqlResponse, type OperatorsResponse, OracleCertificate, type PrivateKey, Proof, type ProofGraphqlResponse, type ProofResponse, type ProofType, type PublicKey, Round, type RoundGraphqlResponse, type RoundResponse, type RoundType, type RoundsCountGraphqlResponse, type RoundsGraphqlResponse, type RoundsResponse, type SignUpEventType, type SignUpEventsGraphqlResponse, type SignUpEventsResponse, type SuccessResponse, Transaction, type TransactionGraphqlResponse, type TransactionResponse, type TransactionType, type TransactionsGraphqlResponse, type TransactionsResponse, UserAccount, type VoteCountGraphqlResponse, batchGenMessage, circuits, compressPublicKey, decompressPublicKey, genAddKeyProof, genEcdhSharedKey, genKeypair, genMessageFactory, getDefaultParams, hexToDecimalString, isValidAddress, privateKeyFromTxt, stringizing, validator_operator_set };
+export { type Account, type BalanceResponse, type CertificateEcosystem, Circom, Circuit, type CircuitResponse, type CircuitType, type CircuitsCountGraphqlResponse, type CircuitsResponse, type ClientParams, Contract, type ContractParams, type CreateAMaciRoundParams, type CreateMaciRoundParams, type CreateOracleMaciRoundParams, type CreateRoundParams, type ErrorResponse, Event, Http, Indexer, MACI, MaciCertSystemType, MaciCircuitType, MaciClient, MaciRoundType, type MissRateResponse, type MissRateType, type NetworkConfig, Operator, type OperatorDelayOperationsGraphqlResponse, type OperatorDelayOperationsResponse, type OperatorDelayType, type OperatorResponse, type OperatorType, type OperatorsGraphqlResponse, type OperatorsResponse, OracleCertificate, type PrivateKey, Proof, type ProofGraphqlResponse, type ProofResponse, type ProofType, type PublicKey, Round, type RoundGraphqlResponse, type RoundResponse, type RoundType, type RoundsCountGraphqlResponse, type RoundsGraphqlResponse, type RoundsResponse, type SelectiveRoundGraphqlResponse, type SelectiveRoundResponse, type SelectiveRoundType, type SignUpEventType, type SignUpEventsGraphqlResponse, type SignUpEventsResponse, type SuccessResponse, Transaction, type TransactionGraphqlResponse, type TransactionResponse, type TransactionType, type TransactionsGraphqlResponse, type TransactionsResponse, UserAccount, type VoteCountGraphqlResponse, batchGenMessage, circuits, compressPublicKey, decompressPublicKey, genAddKeyProof, genEcdhSharedKey, genKeypair, genMessageFactory, getDefaultParams, hexToDecimalString, isValidAddress, privateKeyFromTxt, stringizing, validator_operator_set };

package/dist/index.d.ts

@@ -243,6 +243,7 @@ type RoundType = {
     voiceCreditAmount: string;
     preDeactivateRoot: string;
     identity: string;
+    funds: string;
     operatorLogoUrl?: string;
     operatorMoniker?: string;
     resultsList?: {
@@ -250,6 +251,7 @@ type RoundType = {
         v2: number;
     }[];
 };
+type SelectiveRoundType = Partial<RoundType>;
 type ProofType = {
     nodes: {
         id: string;
@@ -454,6 +456,9 @@ type TransactionsResponse = SuccessResponse<{
 type RoundResponse = SuccessResponse<{
     round: RoundType;
 }> | ErrorResponse;
+type SelectiveRoundResponse = SuccessResponse<{
+    round: SelectiveRoundType;
+}> | ErrorResponse;
 type RoundsResponse = SuccessResponse<{
     rounds: {
         pageInfo: {
@@ -472,6 +477,14 @@ type RoundGraphqlResponse = {
         round: RoundType;
     };
 };
+/**
+ * GraphQL response type for selective round fields
+ */
+type SelectiveRoundGraphqlResponse = {
+    data: {
+        round: SelectiveRoundType;
+    };
+};
 type RoundsGraphqlResponse = {
     data: {
         rounds: {
@@ -548,6 +561,13 @@ declare class Round {
     http: Http;
     constructor(http: Http);
     getRoundById(address: string): Promise<RoundResponse>;
+    /**
+     * Get round information with selective fields
+     * @param address Round address
+     * @param fields Array of fields to return, returns all fields if empty
+     * @returns Round information response
+     */
+    getRoundWithFields(address: string, fields?: string[]): Promise<SelectiveRoundResponse>;
     getRounds(after: string, limit?: number): Promise<RoundsResponse>;
     getRoundsByCircuitName(circuitName: string, after: string, limit?: number): Promise<RoundsResponse>;
     getRoundsByStatus(status: string, after: string, limit?: number): Promise<RoundsResponse>;
@@ -616,6 +636,14 @@ declare class Indexer {
      * @returns {Promise<RoundResponse>} The round response.
      */
     getRoundById(id: string): Promise<RoundResponse>;
+    /**
+     * @method getRoundWithFields
+     * @description Get a round by its address with selective fields.
+     * @param {string} address - The address of the round.
+     * @param {string[]} [fields] - The fields to retrieve.
+     * @returns {Promise<SelectiveRoundResponse>} The round response.
+     */
+    getRoundWithFields(address: string, fields?: string[]): Promise<SelectiveRoundResponse>;
     /**
      * @method getRounds
      * @description Get multiple rounds.
@@ -1760,6 +1788,10 @@ declare class MACI {
         address: string;
         contractAddress: string;
     }): Promise<FeegrantAllowanceResponse>;
+    hasFeegrant({ address, contractAddress, }: {
+        address: string;
+        contractAddress: string;
+    }): Promise<boolean>;
     queryWhitelistBalanceOf({ signer, address, contractAddress, certificate, mode, }: {
         signer: OfflineSigner;
         address: string;
@@ -1985,6 +2017,7 @@ interface NetworkConfig {
     oracleCodeId: number;
     oracleWhitelistBackendPubkey: string;
     oracleFeegrantOperator: string;
+    oracleCodeIds: string[];
 }
 declare function getDefaultParams(network?: 'mainnet' | 'testnet'): NetworkConfig;
 
@@ -2054,6 +2087,14 @@ declare class MaciClient {
      * @returns {Promise<RoundResponse>} The round response.
      */
     getRoundById(id: string): Promise<RoundResponse>;
+    /**
+     * @method getRoundWithFields
+     * @description Get a round by its address with selective fields.
+     * @param {string} address - The address of the round.
+     * @param {string[]} [fields] - The fields to retrieve.
+     * @returns {Promise<SelectiveRoundResponse>} The round response.
+     */
+    getRoundWithFields(address: string, fields?: string[]): Promise<SelectiveRoundResponse>;
     /**
      * @method getRounds
      * @description Get multiple rounds.
@@ -2168,4 +2209,4 @@ declare function decompressPublicKey(compressedPubkey: string): {
 };
 declare function compressPublicKey(decompressedPubkey: any[]): string;
 
-export { type Account, type BalanceResponse, type CertificateEcosystem, Circom, Circuit, type CircuitResponse, type CircuitType, type CircuitsCountGraphqlResponse, type CircuitsResponse, type ClientParams, Contract, type ContractParams, type CreateAMaciRoundParams, type CreateMaciRoundParams, type CreateOracleMaciRoundParams, type CreateRoundParams, type ErrorResponse, Event, Http, Indexer, MACI, MaciCertSystemType, MaciCircuitType, MaciClient, MaciRoundType, type MissRateResponse, type MissRateType, type NetworkConfig, Operator, type OperatorDelayOperationsGraphqlResponse, type OperatorDelayOperationsResponse, type OperatorDelayType, type OperatorResponse, type OperatorType, type OperatorsGraphqlResponse, type OperatorsResponse, OracleCertificate, type PrivateKey, Proof, type ProofGraphqlResponse, type ProofResponse, type ProofType, type PublicKey, Round, type RoundGraphqlResponse, type RoundResponse, type RoundType, type RoundsCountGraphqlResponse, type RoundsGraphqlResponse, type RoundsResponse, type SignUpEventType, type SignUpEventsGraphqlResponse, type SignUpEventsResponse, type SuccessResponse, Transaction, type TransactionGraphqlResponse, type TransactionResponse, type TransactionType, type TransactionsGraphqlResponse, type TransactionsResponse, UserAccount, type VoteCountGraphqlResponse, batchGenMessage, circuits, compressPublicKey, decompressPublicKey, genAddKeyProof, genEcdhSharedKey, genKeypair, genMessageFactory, getDefaultParams, hexToDecimalString, isValidAddress, privateKeyFromTxt, stringizing, validator_operator_set };
+export { type Account, type BalanceResponse, type CertificateEcosystem, Circom, Circuit, type CircuitResponse, type CircuitType, type CircuitsCountGraphqlResponse, type CircuitsResponse, type ClientParams, Contract, type ContractParams, type CreateAMaciRoundParams, type CreateMaciRoundParams, type CreateOracleMaciRoundParams, type CreateRoundParams, type ErrorResponse, Event, Http, Indexer, MACI, MaciCertSystemType, MaciCircuitType, MaciClient, MaciRoundType, type MissRateResponse, type MissRateType, type NetworkConfig, Operator, type OperatorDelayOperationsGraphqlResponse, type OperatorDelayOperationsResponse, type OperatorDelayType, type OperatorResponse, type OperatorType, type OperatorsGraphqlResponse, type OperatorsResponse, OracleCertificate, type PrivateKey, Proof, type ProofGraphqlResponse, type ProofResponse, type ProofType, type PublicKey, Round, type RoundGraphqlResponse, type RoundResponse, type RoundType, type RoundsCountGraphqlResponse, type RoundsGraphqlResponse, type RoundsResponse, type SelectiveRoundGraphqlResponse, type SelectiveRoundResponse, type SelectiveRoundType, type SignUpEventType, type SignUpEventsGraphqlResponse, type SignUpEventsResponse, type SuccessResponse, Transaction, type TransactionGraphqlResponse, type TransactionResponse, type TransactionType, type TransactionsGraphqlResponse, type TransactionsResponse, UserAccount, type VoteCountGraphqlResponse, batchGenMessage, circuits, compressPublicKey, decompressPublicKey, genAddKeyProof, genEcdhSharedKey, genKeypair, genMessageFactory, getDefaultParams, hexToDecimalString, isValidAddress, privateKeyFromTxt, stringizing, validator_operator_set };

package/dist/index.js

@@ -302,7 +302,9 @@ var ERROR = {
   ERROR_ROUNDS_NOT_FOUND: "ERROR_ROUNDS_NOT_FOUND",
   ERROR_TRANSACTION_NOT_FOUND: "ERROR_TRANSACTION_NOT_FOUND",
   ERROR_TRANSACTIONS_NOT_FOUND: "ERROR_TRANSACTIONS_NOT_FOUND",
-  ERROR_SIGN_UP_EVENTS_NOT_FOUND: "ERROR_SIGN_UP_EVENTS_NOT_FOUND"
+  ERROR_SIGN_UP_EVENTS_NOT_FOUND: "ERROR_SIGN_UP_EVENTS_NOT_FOUND",
+  ERROR_INVALID_FIELDS: "ERROR_INVALID_FIELDS",
+  ERROR_CLAIM_INFOS_NOT_FOUND: "ERROR_CLAIM_INFOS_NOT_FOUND"
 };
 
 // src/libs/query/account.ts
@@ -482,10 +484,11 @@ function getDefaultParams(network = "mainnet") {
         registryAddress: "dora1smg5qp5trjdkcekdjssqpjehdjf6n4cjss0clyvqcud3t3u3948s8rmgg4",
         maciCodeId: 106,
         // oracleCodeId: 116,// 9-4-3-625
-        oracleCodeId: 117,
+        oracleCodeId: 119,
         // 6-3-3-125
         oracleWhitelistBackendPubkey: "A61YtCv2ibMZmDeM02nEElil8wlHx1tLKogBk5dPgf/Q",
-        oracleFeegrantOperator: "dora16s9tljk8dy9ae335yvyzlm8gvkypx9228q8pq8"
+        oracleFeegrantOperator: "dora16s9tljk8dy9ae335yvyzlm8gvkypx9228q8pq8",
+        oracleCodeIds: ["101", "116", "117", "119"]
       };
     case "testnet":
       return {
@@ -498,10 +501,11 @@ function getDefaultParams(network = "mainnet") {
         registryAddress: "dora13c8aecstyxrhax9znvvh5zey89edrmd2k5va57pxvpe3fxtfsfeqlhsjnd",
         maciCodeId: 107,
         // oracleCodeId: 113, // 9-4-3-625
-        oracleCodeId: 115,
+        oracleCodeId: 123,
         // 6-3-3-125
         oracleWhitelistBackendPubkey: "AoYo/zENN/JquagPdG0/NMbWBBYxOM8BVN677mBXJKJQ",
-        oracleFeegrantOperator: "dora1xp0twdzsdeq4qg3c64v66552deax8zmvq4zw78"
+        oracleFeegrantOperator: "dora1xp0twdzsdeq4qg3c64v66552deax8zmvq4zw78",
+        oracleCodeIds: ["102", "105", "108", "110", "113", "115", "123"]
       };
   }
 }
@@ -1211,6 +1215,102 @@ var Round = class {
       return handleError(error);
     }
   }
+  /**
+   * Get round information with selective fields
+   * @param address Round address
+   * @param fields Array of fields to return, returns all fields if empty
+   * @returns Round information response
+   */
+  async getRoundWithFields(address, fields) {
+    try {
+      if (!isValidAddress(address)) {
+        return {
+          code: 400,
+          error: {
+            message: "Invalid round address format",
+            type: ERROR.ERROR_ROUND_INVALID_ADDRESS
+          }
+        };
+      }
+      const defaultFields = [
+        "id",
+        "blockHeight",
+        "txHash",
+        "caller",
+        "admin",
+        "operator",
+        "contractAddress",
+        "circuitName",
+        "timestamp",
+        "votingStart",
+        "votingEnd",
+        "status",
+        "period",
+        "actionType",
+        "roundTitle",
+        "roundDescription",
+        "roundLink",
+        "coordinatorPubkeyX",
+        "coordinatorPubkeyY",
+        "voteOptionMap",
+        "results",
+        "allResult",
+        "gasStationEnable",
+        "totalGrant",
+        "baseGrant",
+        "totalBond",
+        "circuitType",
+        "circuitPower",
+        "certificationSystem",
+        "codeId",
+        "maciType",
+        "voiceCreditAmount",
+        "preDeactivateRoot",
+        "identity",
+        "funds"
+      ];
+      if (fields && fields.length > 0) {
+        const invalidFields = fields.filter(
+          (field) => !defaultFields.includes(field)
+        );
+        if (invalidFields.length > 0) {
+          return {
+            code: 400,
+            error: {
+              message: `Invalid fields: ${invalidFields.join(", ")}`,
+              type: ERROR.ERROR_INVALID_FIELDS
+            }
+          };
+        }
+      }
+      const selectedFields = fields && fields.length > 0 ? fields : defaultFields;
+      const fieldString = selectedFields.join("\n        ");
+      const ROUND_QUERY = `query {
+          round(id: "${address}") {
+            ${fieldString}
+          }
+        }`;
+      const response = await this.http.fetchGraphql(
+        ROUND_QUERY,
+        ""
+      );
+      if (!response || !response.data || !response.data.round) {
+        return {
+          code: 404,
+          error: {
+            message: `No round data found for address ${address}`,
+            type: ERROR.ERROR_ROUND_NOT_FOUND
+          }
+        };
+      }
+      return {
+        code: 200,
+        data: response.data
+      };
+    } catch (error) {
+      return handleError(error);
+    }
+  }
   async getRounds(after, limit) {
     try {
       const ROUND_HISTORY_QUERY = `query ($limit: Int, $after: Cursor) {
@@ -1878,6 +1978,16 @@ var Indexer = class {
   async getRoundById(id) {
     return await this.round.getRoundById(id);
   }
+  /**
+   * @method getRoundWithFields
+   * @description Get a round by its address with selective fields.
+   * @param {string} address - The address of the round.
+   * @param {string[]} [fields] - The fields to retrieve.
+   * @returns {Promise<SelectiveRoundResponse>} The round response.
+   */
+  async getRoundWithFields(address, fields) {
+    return await this.round.getRoundWithFields(address, fields);
+  }
   /**
    * @method getRounds
    * @description Get multiple rounds.
@@ -4792,6 +4902,20 @@ var MACI = class {
       };
     }
   }
+  async hasFeegrant({
+    address,
+    contractAddress
+  }) {
+    try {
+      const response = await this.oracleCertificate.feegrantAllowance(
+        contractAddress,
+        address
+      );
+      return response.spend_limit.length > 0;
+    } catch (error) {
+      return false;
+    }
+  }
   // only for maci and oracle maci, amaci will set the voice credit when deploy the contract
   async queryWhitelistBalanceOf({
     signer,
@@ -4807,9 +4931,15 @@ var MACI = class {
         contractAddress
       });
       if (isWhiteListed) {
-        const round = await this.indexer.getRoundById(contractAddress);
+        const round = await this.indexer.getRoundWithFields(contractAddress, [
+          "voiceCreditAmount"
+        ]);
         if (!isErrorResponse(round)) {
-          return round.data.round.voiceCreditAmount;
+          if (round.data.round.voiceCreditAmount) {
+            return round.data.round.voiceCreditAmount;
+          } else {
+            return "0";
+          }
         } else {
           throw new Error(
             `Failed to query amaci voice credit: ${round.error.type} ${round.error.message}`
@@ -4867,7 +4997,7 @@ var MACI = class {
     return snapshotHeight;
   }
   async getRoundInfo({ contractAddress }) {
-    const roundInfo = await this.indexer.getRoundById(contractAddress);
+    const roundInfo = await this.indexer.getRoundWithFields(contractAddress);
     if (isErrorResponse(roundInfo)) {
       throw new Error(
         `Failed to get round info: ${roundInfo.error.type} ${roundInfo.error.message}`
@@ -5362,6 +5492,16 @@ var MaciClient2 = class {
   async getRoundById(id) {
     return await this.indexer.round.getRoundById(id);
   }
+  /**
+   * @method getRoundWithFields
+   * @description Get a round by its address with selective fields.
+   * @param {string} address - The address of the round.
+   * @param {string[]} [fields] - The fields to retrieve.
+   * @returns {Promise<SelectiveRoundResponse>} The round response.
+   */
+  async getRoundWithFields(address, fields) {
+    return await this.indexer.round.getRoundWithFields(address, fields);
+  }
   /**
    * @method getRounds
    * @description Get multiple rounds.