@dorafactory/maci-sdk 0.0.27 → 0.0.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dorafactory/maci-sdk",
-  "version": "0.0.27",
+  "version": "0.0.28",
   "description": "SDK for interacting with maci",
   "keywords": [
     "maci",
@@ -43,7 +43,6 @@
     "@cosmjs/launchpad": "^0.27.1",
     "@cosmjs/proto-signing": "^0.32.1",
     "@cosmjs/stargate": "^0.32.1",
-    "@dorafactory/circomlib": "^0.0.3",
     "assert": "^2.1.0",
     "bech32": "1.1.4",
     "blake-hash": "^2.0.0",
@@ -60,7 +59,8 @@
     "tmp": "^0.2.1",
     "ts-retry-promise": "^0.7.1",
     "tweetnacl": "^1.0.3",
-    "valibot": "0.36.0"
+    "valibot": "0.36.0",
+    "@dorafactory/circomlib": "0.0.3"
   },
   "devDependencies": {
     "@commitlint/cli": "^18.0.0",

package/src/libs/const.ts

@@ -153,6 +153,7 @@ export interface NetworkConfig {
   oracleCodeId: number;
   oracleWhitelistBackendPubkey: string;
   oracleFeegrantOperator: string;
+  oracleCodeIds: string[];
 }
 
 export function getDefaultParams(
@@ -172,10 +173,11 @@ export function getDefaultParams(
           'dora1smg5qp5trjdkcekdjssqpjehdjf6n4cjss0clyvqcud3t3u3948s8rmgg4',
         maciCodeId: 106,
         // oracleCodeId: 116,// 9-4-3-625
-        oracleCodeId: 117, // 6-3-3-125
+        oracleCodeId: 119, // 6-3-3-125
         oracleWhitelistBackendPubkey:
           'A61YtCv2ibMZmDeM02nEElil8wlHx1tLKogBk5dPgf/Q',
         oracleFeegrantOperator: 'dora16s9tljk8dy9ae335yvyzlm8gvkypx9228q8pq8',
+        oracleCodeIds: ['101', '116', '117', '119'],
       };
     case 'testnet':
       return {
@@ -190,10 +192,11 @@ export function getDefaultParams(
           'dora13c8aecstyxrhax9znvvh5zey89edrmd2k5va57pxvpe3fxtfsfeqlhsjnd',
         maciCodeId: 107,
         // oracleCodeId: 113, // 9-4-3-625
-        oracleCodeId: 115, // 6-3-3-125
+        oracleCodeId: 123, // 6-3-3-125
         oracleWhitelistBackendPubkey:
           'AoYo/zENN/JquagPdG0/NMbWBBYxOM8BVN677mBXJKJQ',
         oracleFeegrantOperator: 'dora1xp0twdzsdeq4qg3c64v66552deax8zmvq4zw78',
+        oracleCodeIds: ['102', '105', '108', '110', '113', '115', '123'],
       };
   }
 }

package/src/libs/errors/types.ts

@@ -15,4 +15,6 @@ export const ERROR = {
   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_INVALID_FIELDS: 'ERROR_INVALID_FIELDS',
+  ERROR_CLAIM_INFOS_NOT_FOUND: 'ERROR_CLAIM_INFOS_NOT_FOUND',
+} as const;

package/src/libs/indexer/indexer.ts

@@ -12,6 +12,7 @@ import {
   SignUpEventsResponse,
   OperatorDelayOperationsResponse,
   MissRateResponse,
+  SelectiveRoundResponse,
 } from '../../types';
 import { IndexerParams } from './types';
 import { Http } from '../http';
@@ -88,6 +89,20 @@ export class Indexer {
     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: string,
+    fields?: string[]
+  ): Promise<SelectiveRoundResponse> {
+    return await this.round.getRoundWithFields(address, fields);
+  }
+
   /**
    * @method getRounds
    * @description Get multiple rounds.

package/src/libs/maci/maci.ts

@@ -15,7 +15,7 @@ import {
 } from '@cosmjs/cosmwasm-stargate';
 import { GasPrice, calculateFee, StdFee } from '@cosmjs/stargate';
 import { MsgExecuteContract } from 'cosmjs-types/cosmwasm/wasm/v1/tx.js';
-import { CertificateEcosystem, ErrorResponse } from '../../types';
+import { CertificateEcosystem, ErrorResponse, RoundType } from '../../types';
 import { SignatureResponse } from '../oracle-certificate/types';
 import { OracleWhitelistConfig } from '../contract/ts/OracleMaci.types';
 import { getAMaciRoundCircuitFee } from '../contract/utils';
@@ -130,6 +130,24 @@ export class MACI {
     }
   }
 
+  async hasFeegrant({
+    address,
+    contractAddress,
+  }: {
+    address: string;
+    contractAddress: string;
+  }): Promise<boolean> {
+    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,
@@ -152,10 +170,16 @@ export class MACI {
       });
 
       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}`
@@ -231,7 +255,7 @@ export class MACI {
   }
 
   async getRoundInfo({ contractAddress }: { contractAddress: string }) {
-    const roundInfo = await this.indexer.getRoundById(contractAddress);
+    const roundInfo = await this.indexer.getRoundWithFields(contractAddress);
 
     if (isErrorResponse(roundInfo)) {
       throw new Error(
@@ -239,7 +263,7 @@ export class MACI {
       );
     }
 
-    return roundInfo.data.round;
+    return roundInfo.data.round as RoundType;
   }
 
   async getRoundCircuitType({ contractAddress }: { contractAddress: string }) {

package/src/libs/query/round.ts

@@ -3,6 +3,8 @@ import {
   RoundResponse,
   RoundGraphqlResponse,
   RoundsGraphqlResponse,
+  SelectiveRoundResponse,
+  SelectiveRoundGraphqlResponse,
 } from '../../types';
 import { Http } from '../../libs';
 import { isValidAddress } from '../../utils';
@@ -135,6 +137,116 @@ export class Round {
     }
   }
 
+  /**
+   * 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: string,
+    fields?: string[]
+  ): Promise<SelectiveRoundResponse> {
+    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<SelectiveRoundGraphqlResponse>(
+          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: any) {
+      return handleError(error as ErrorType);
+    }
+  }
+
   async getRounds(after: string, limit?: number): Promise<RoundsResponse> {
     try {
       const ROUND_HISTORY_QUERY = `query ($limit: Int, $after: Cursor) {

package/src/maci.ts

@@ -10,6 +10,7 @@ import {
   TransactionsResponse,
   CircuitsResponse,
   ProofResponse,
+  SelectiveRoundResponse,
 } from './types';
 import {
   Http,
@@ -191,6 +192,20 @@ export class MaciClient {
     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: string,
+    fields?: string[]
+  ): Promise<SelectiveRoundResponse> {
+    return await this.indexer.round.getRoundWithFields(address, fields);
+  }
+
   /**
    * @method getRounds
    * @description Get multiple rounds.

package/src/types/index.ts

@@ -93,6 +93,7 @@ export type RoundType = {
   voiceCreditAmount: string;
   preDeactivateRoot: string;
   identity: string;
+  funds: string;
   operatorLogoUrl?: string;
   operatorMoniker?: string;
   resultsList?: {
@@ -101,6 +102,8 @@ export type RoundType = {
   }[];
 };
 
+export type SelectiveRoundType = Partial<RoundType>;
+
 export type ProofType = {
   nodes: {
     id: string;
@@ -355,6 +358,12 @@ export type RoundResponse =
     }>
   | ErrorResponse;
 
+export type SelectiveRoundResponse =
+  | SuccessResponse<{
+      round: SelectiveRoundType;
+    }>
+  | ErrorResponse;
+
 export type RoundsResponse =
   | SuccessResponse<{
       rounds: {
@@ -377,6 +386,15 @@ export type RoundGraphqlResponse = {
   };
 };
 
+/**
+ * GraphQL response type for selective round fields
+ */
+export type SelectiveRoundGraphqlResponse = {
+  data: {
+    round: SelectiveRoundType;
+  };
+};
+
 export type RoundsGraphqlResponse = {
   data: {
     rounds: {