@dorafactory/maci-sdk 0.0.34 → 0.0.36

package/dist/types/index.d.ts

@@ -0,0 +1,383 @@
+import { OfflineSigner } from '@cosmjs/proto-signing';
+import { Keypair } from '../libs/crypto';
+import { FetchOptions } from '../libs/http/http';
+export type * from '../libs/contract/types';
+export type * from '../libs/crypto/types';
+export declare enum MaciCircuitType {
+    IP1V = "0",
+    QV = "1"
+}
+export declare enum MaciCertSystemType {
+    GROTH16 = "groth16",
+    PLONK = "plonk"
+}
+export declare enum MaciRoundType {
+    MACI = "0",
+    AMACI = "1",
+    ORACLE_MACI = "2"
+}
+export type CertificateEcosystem = 'cosmoshub' | 'doravota';
+export type ClientParams = {
+    signer: OfflineSigner;
+    network: 'mainnet' | 'testnet';
+    rpcEndpoint?: string;
+    restEndpoint?: string;
+    apiEndpoint?: string;
+    certificateApiEndpoint?: string;
+    registryAddress?: string;
+    maciCodeId?: number;
+    oracleCodeId?: number;
+    customFetch?: typeof fetch;
+    defaultOptions?: FetchOptions;
+    feegrantOperator?: string;
+    whitelistBackendPubkey?: string;
+    maciKeypair?: Keypair;
+    secretKey?: string;
+    mnemonic?: string;
+};
+export type ContractParams = {
+    rpcEndpoint: string;
+    registryAddress: string;
+    maciCodeId: number;
+    oracleCodeId: number;
+    whitelistBackendPubkey: string;
+    feegrantOperator: string;
+};
+export type TransactionType = {
+    id: string;
+    blockHeight: string;
+    txHash: string;
+    timestamp: string;
+    type: string;
+    status: string;
+    circuitName: string;
+    fee: string;
+    gasUsed: string;
+    gasWanted: string;
+    caller: string;
+    contractAddress: string;
+};
+export type RoundType = {
+    id: string;
+    blockHeight: string;
+    txHash: string;
+    caller: string;
+    admin: string;
+    operator: string;
+    contractAddress: string;
+    circuitName: string;
+    timestamp: string;
+    votingStart: string;
+    votingEnd: string;
+    status: string;
+    period: string;
+    actionType: string;
+    roundTitle: string;
+    roundDescription: string;
+    roundLink: string;
+    coordinatorPubkeyX: string;
+    coordinatorPubkeyY: string;
+    voteOptionMap: string;
+    results: string;
+    allResult: string;
+    gasStationEnable: boolean;
+    totalGrant: string;
+    baseGrant: string;
+    totalBond: string;
+    circuitType: string;
+    circuitPower: string;
+    certificationSystem: string;
+    codeId: string;
+    maciType: string;
+    voiceCreditAmount: string;
+    preDeactivateRoot: string;
+    identity: string;
+    operatorLogoUrl?: string;
+    operatorMoniker?: string;
+    resultsList?: {
+        v: number;
+        v2: number;
+    }[];
+};
+export type SelectiveRoundType = Partial<RoundType>;
+export type ProofType = {
+    nodes: {
+        id: string;
+        blockHeight: string;
+        txHash: string;
+        contractAddress: string;
+        timestamp: string;
+        actionType: string;
+        commitment: string;
+        proof: string;
+    }[];
+};
+export type OperatorDelayType = {
+    blockHeight: string;
+    delayProcessDmsgCount: number;
+    delayDuration: string;
+    delayReason: string;
+    delayType: string;
+    id: string;
+    nodeId: string;
+    operatorAddress: string;
+    timestamp: string;
+    roundAddress: string;
+};
+export type OperatorType = {
+    id: string;
+    validatorAddress: string;
+    operatorAddress: string;
+    coordinatorPubkeyX: string;
+    coordinatorPubkeyY: string;
+    identity: string;
+    logoUrl: string;
+    moniker: string;
+    activeRoundsCount: number;
+    completedRoundsCount: number;
+};
+export type CircuitType = {
+    maciType: string;
+    circuitType: string;
+    displayName: string;
+    repoUrl: string;
+    zipUrl: string;
+    roundCount?: number;
+};
+export type SignUpEventType = {
+    id: string;
+    blockHeight: string;
+    txHash: string;
+    contractAddress: string;
+    timestamp: string;
+    pubKey: string;
+    stateIdx: number;
+    balance: string;
+};
+export type CircuitsCountGraphqlResponse = {
+    data: {
+        rounds: {
+            totalCount: number;
+        };
+    };
+};
+export type ErrorResponse = {
+    code: number;
+    error: {
+        message: string;
+        type: string;
+    };
+};
+export type SuccessResponse<T> = {
+    code: 200;
+    data: T;
+};
+export type CircuitResponse = SuccessResponse<{
+    circuit: CircuitType;
+}> | ErrorResponse;
+export type CircuitsResponse = SuccessResponse<{
+    circuits: CircuitType[];
+}> | ErrorResponse;
+export type BalanceResponse = SuccessResponse<{
+    balance: string;
+}> | ErrorResponse;
+export type OperatorResponse = SuccessResponse<{
+    operator: OperatorType;
+}> | ErrorResponse;
+export type MissRateResponse = SuccessResponse<{
+    missRate: (MissRateType & {
+        date: string;
+    })[];
+}> | ErrorResponse;
+export type OperatorDelayOperationsResponse = SuccessResponse<{
+    operatorDelayOperations: {
+        pageInfo: {
+            endCursor: string;
+            hasNextPage: boolean;
+        };
+        edges: {
+            cursor: string;
+            node: OperatorDelayType;
+        }[];
+        totalCount: number;
+    };
+}> | ErrorResponse;
+export type OperatorsResponse = SuccessResponse<{
+    operators: {
+        pageInfo: {
+            endCursor: string;
+            hasNextPage: boolean;
+        };
+        edges: {
+            cursor: string;
+            node: OperatorType;
+        }[];
+        totalCount: number;
+    };
+}> | ErrorResponse;
+export type OperatorsGraphqlResponse = {
+    data: {
+        operators: {
+            pageInfo: {
+                endCursor: string;
+                hasNextPage: boolean;
+            };
+            edges: {
+                cursor: string;
+                node: OperatorType;
+            }[];
+            totalCount: number;
+        };
+    };
+};
+export type RoundsCountGraphqlResponse = {
+    data: {
+        activeRoundsCount: {
+            totalCount: number;
+        };
+        completedRoundsCount: {
+            totalCount: number;
+        };
+    };
+};
+export type VoteCountGraphqlResponse = {
+    data: {
+        signupsCount: {
+            totalCount: number;
+        };
+        messagesCount: {
+            totalCount: number;
+        };
+    };
+};
+export type OperatorDelayOperationsGraphqlResponse = {
+    data: {
+        operatorDelayOperations: {
+            pageInfo: {
+                endCursor: string;
+                hasNextPage: boolean;
+            };
+            edges: {
+                cursor: string;
+                node: OperatorDelayType;
+            }[];
+            totalCount: number;
+        };
+    };
+};
+export type TransactionGraphqlResponse = {
+    data: {
+        transaction: TransactionType;
+    };
+};
+export type TransactionResponse = SuccessResponse<{
+    transaction: TransactionType;
+}> | ErrorResponse;
+export type TransactionsGraphqlResponse = {
+    data: {
+        transactions: {
+            pageInfo: {
+                endCursor: string;
+                hasNextPage: boolean;
+            };
+            edges: {
+                cursor: string;
+                node: TransactionType;
+            }[];
+            totalCount: number;
+        };
+    };
+};
+export type TransactionsResponse = SuccessResponse<{
+    transactions: {
+        pageInfo: {
+            endCursor: string;
+            hasNextPage: boolean;
+        };
+        edges: {
+            cursor: string;
+            node: TransactionType;
+        }[];
+        totalCount: number;
+    };
+}> | ErrorResponse;
+export type RoundResponse = SuccessResponse<{
+    round: RoundType;
+}> | ErrorResponse;
+export type SelectiveRoundResponse = SuccessResponse<{
+    round: SelectiveRoundType;
+}> | ErrorResponse;
+export type RoundsResponse = SuccessResponse<{
+    rounds: {
+        pageInfo: {
+            endCursor: string;
+            hasNextPage: boolean;
+        };
+        edges: {
+            cursor: string;
+            node: RoundType;
+        }[];
+        totalCount: number;
+    };
+}> | ErrorResponse;
+export type RoundGraphqlResponse = {
+    data: {
+        round: RoundType;
+    };
+};
+/**
+ * GraphQL response type for selective round fields
+ */
+export type SelectiveRoundGraphqlResponse = {
+    data: {
+        round: SelectiveRoundType;
+    };
+};
+export type RoundsGraphqlResponse = {
+    data: {
+        rounds: {
+            pageInfo: {
+                endCursor: string;
+                hasNextPage: boolean;
+            };
+            edges: {
+                cursor: string;
+                node: RoundType;
+            }[];
+            totalCount: number;
+        };
+    };
+};
+export type ProofResponse = SuccessResponse<{
+    proofData: ProofType;
+}> | ErrorResponse;
+export type ProofGraphqlResponse = {
+    data: {
+        proofData: ProofType;
+    };
+};
+export type SignUpEventsResponse = SuccessResponse<{
+    signUpEvents: SignUpEventType[];
+}> | ErrorResponse;
+export type SignUpEventsGraphqlResponse = {
+    data: {
+        signUpEvents: {
+            nodes: SignUpEventType[];
+        };
+    };
+};
+export type MissRateType = {
+    delayCount: number;
+    deactivateDelay: {
+        count: number;
+        dmsgCount: number;
+    };
+    tallyDelay: {
+        count: number;
+    };
+    totalDelayDuration: number;
+    avgDelayDuration: number;
+    tallyCount: number;
+    deactivateCount: number;
+    missRate: number;
+};

package/dist/utils/index.d.ts

@@ -0,0 +1,7 @@
+export declare function isValidAddress(address: string): boolean;
+/**
+ * Converts a hexadecimal string to a decimal string.
+ * @param hexString - The hexadecimal string to convert.
+ * @returns The decimal string representation of the input.
+ */
+export declare function hexToDecimalString(hexString: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dorafactory/maci-sdk",
-  "version": "0.0.34",
+  "version": "0.0.36",
   "description": "SDK for interacting with maci",
   "keywords": [
     "maci",
@@ -20,18 +20,9 @@
   "engines": {
     "node": ">=18"
   },
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "default": "./dist/index.js"
-    },
-    "./browser": {
-      "types": "./dist/browser.d.ts",
-      "import": "./dist/browser.mjs"
-    }
-  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist",
     "src"
@@ -43,13 +34,16 @@
     "@cosmjs/launchpad": "^0.27.1",
     "@cosmjs/proto-signing": "^0.32.1",
     "@cosmjs/stargate": "^0.32.1",
+    "@zk-kit/baby-jubjub": "^1.0.3",
+    "@zk-kit/eddsa-poseidon": "^1.1.0",
+    "@zk-kit/poseidon-cipher": "^0.3.2",
+    "@zk-kit/utils": "^1.4.1",
     "assert": "^2.1.0",
     "bech32": "1.1.4",
     "blake-hash": "^2.0.0",
     "colorts": "^0.1.63",
     "cosmjs-types": "^0.9.0",
     "ethers": "^6.13.4",
-    "ffjavascript": "^0.2.60",
     "gql.tada": "^1.7.0",
     "graphql": "^16.8.1",
     "husky": "^8.0.3",
@@ -59,8 +53,7 @@
     "tmp": "^0.2.1",
     "ts-retry-promise": "^0.7.1",
     "tweetnacl": "^1.0.3",
-    "valibot": "0.36.0",
-    "@dorafactory/circomlib": "0.0.3"
+    "valibot": "0.36.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^18.0.0",
@@ -70,6 +63,7 @@
     "@types/tmp": "^0.2.5",
     "@typescript-eslint/eslint-plugin": "^6.8.0",
     "@typescript-eslint/parser": "^6.8.0",
+    "browserify-zlib": "^0.2.0",
     "buffer": "^6.0.3",
     "crypto-browserify": "^3.12.1",
     "dotenv": "^16.3.1",
@@ -81,7 +75,7 @@
     "events-browserify": "^0.0.1",
     "https-browserify": "^1.0.0",
     "lint-staged": "^15.0.2",
-    "prettier": "^2.8.8",
+    "prettier": "^3.5.3",
     "process": "^0.11.10",
     "stream-browserify": "^3.0.0",
     "stream-http": "^3.2.0",
@@ -89,8 +83,7 @@
     "tsconfig-paths": "^4.2.0",
     "tsup": "^8.0.0",
     "typedoc": "^0.25.2",
-    "typescript": "^5.2.2",
-    "browserify-zlib": "^0.2.0"
+    "typescript": "^5.2.2"
   },
   "lint-staged": {
     "**/*.ts": [
@@ -151,17 +144,18 @@
   "scripts": {
     "clean": "rm -rf tsconfig.tsbuildinfo ./dist",
     "build": "npm run build:types && npm run build:tsup",
-    "build:tsup": "tsup",
-    "build:types": "tsc --emitDeclarationOnly --declaration --declarationDir dist",
+    "build:tsup": "tsup ./src/index.ts --format esm,cjs --sourcemap",
+    "build:types": "tsc --build",
     "watch:tsup": "tsup ./src/index.ts --format esm,cjs --clean --splitting --watch",
     "watch:types": "tsc --watch",
     "watch": "pnpm run clean & pnpm run watch:types & pnpm run watch:tsup",
     "test": "pnpm test:typecheck && pnpm test:unit",
+    "test:typecheck": "tsc -p ./test",
+    "test:unit": "vitest run --test-timeout=60000",
+    "test:watch": "vitest",
     "format:fix": "prettier --ignore-path 'dist/* docs/*' --write '**/*.{ts,json,md}'",
     "lint:fix": "eslint . --ignore-pattern dist --ext .ts --fix",
     "commit": "commit",
-    "doc": "typedoc --out docs src/index.ts",
-    "chalk": "^5.0.1",
-    "prettier": "^2.8.4"
+    "doc": "typedoc --out docs src/index.ts"
   }
 }

package/src/index.ts

@@ -10,7 +10,5 @@ export { Circuit } from './libs/query';
 export { Operator } from './libs/query';
 export { Proof } from './libs/query';
 export { Transaction } from './libs/query';
-export * from './libs/circom';
+export * from './libs/crypto';
 export * from './utils';
-export { Scalar, utils } from 'ffjavascript';
-export { default as createBlakeHash } from 'blake-hash';

package/src/libs/contract/contract.ts

@@ -34,7 +34,7 @@ import {
 } from './utils';
 import { QTR_LIB } from './vars';
 import { MaciRoundType, MaciCertSystemType } from '../../types';
-import { decompressPublicKey } from '../../utils';
+import { unpackPubKey } from '../crypto';
 
 export const prefix = 'dora';
 
@@ -76,10 +76,9 @@ export class Contract {
     voiceCreditAmount,
     circuitType,
     preDeactivateRoot,
-  }: CreateAMaciRoundParams) {
+  }: CreateAMaciRoundParams & { signer: OfflineSigner }) {
     const start_time = (startVoting.getTime() * 10 ** 6).toString();
     const end_time = (endVoting.getTime() * 10 ** 6).toString();
-
     const client = await createRegistryClientBy({
       rpcEndpoint: this.rpcEndpoint,
       wallet: signer,
@@ -145,13 +144,14 @@ export class Contract {
     maxOption,
     circuitType,
     certSystemType,
-  }: CreateMaciRoundParams) {
+  }: CreateMaciRoundParams & { signer: OfflineSigner }) {
     const start_time = (startVoting.getTime() * 10 ** 6).toString();
     const end_time = (endVoting.getTime() * 10 ** 6).toString();
     const [{ address }] = await signer.getAccounts();
     const client = await createContractClientByWallet(this.rpcEndpoint, signer);
-    const { x: operatorPubkeyX, y: operatorPubkeyY } =
-      decompressPublicKey(operatorPubkey);
+    const [operatorPubkeyX, operatorPubkeyY] = unpackPubKey(
+      BigInt(operatorPubkey)
+    );
     const {
       parameters,
       groth16ProcessVkey,
@@ -178,8 +178,8 @@ export class Contract {
         },
         parameters,
         coordinator: {
-          x: operatorPubkeyX,
-          y: operatorPubkeyY,
+          x: operatorPubkeyX.toString(),
+          y: operatorPubkeyY.toString(),
         },
         groth16_process_vkey: groth16ProcessVkey,
         groth16_tally_vkey: groth16TallyVkey,
@@ -211,13 +211,14 @@ export class Contract {
     whitelistEcosystem,
     whitelistSnapshotHeight,
     whitelistVotingPowerArgs,
-  }: CreateOracleMaciRoundParams) {
+  }: CreateOracleMaciRoundParams & { signer: OfflineSigner }) {
     const start_time = (startVoting.getTime() * 1_000_000).toString();
     const end_time = (endVoting.getTime() * 1_000_000).toString();
     const [{ address }] = await signer.getAccounts();
     const client = await createContractClientByWallet(this.rpcEndpoint, signer);
-    const { x: operatorPubkeyX, y: operatorPubkeyY } =
-      decompressPublicKey(operatorPubkey);
+    const [operatorPubkeyX, operatorPubkeyY] = unpackPubKey(
+      BigInt(operatorPubkey)
+    );
     const { maciVoteType, maciCertSystem } = getContractParams(
       MaciRoundType.ORACLE_MACI,
       circuitType,
@@ -235,8 +236,8 @@ export class Contract {
           end_time,
         },
         coordinator: {
-          x: operatorPubkeyX,
-          y: operatorPubkeyY,
+          x: operatorPubkeyX.toString(),
+          y: operatorPubkeyY.toString(),
         },
         vote_option_map: voteOptionMap,
         whitelist_backend_pubkey: this.whitelistBackendPubkey,

package/src/libs/contract/types.ts

@@ -8,7 +8,7 @@ import {
 } from '../../types';
 
 export type CreateRoundParams = {
-  signer: OfflineSigner;
+  signer?: OfflineSigner;
   title: string;
   description?: string;
   link?: string;
@@ -29,14 +29,14 @@ export type CreateAMaciRoundParams = {
 export type CreateMaciRoundParams = {
   maxVoter: number;
   maxOption: number;
-  operatorPubkey: string;
+  operatorPubkey: bigint | string;
   whitelist: MaciWhitelist;
   certSystemType: MaciCertSystemType;
 } & CreateRoundParams;
 
 export type CreateOracleMaciRoundParams = {
   voteOptionMap: string[];
-  operatorPubkey: string;
+  operatorPubkey: bigint | string;
   whitelistEcosystem: CertificateEcosystem;
   whitelistSnapshotHeight: string;
   whitelistVotingPowerArgs: {