@dorafactory/maci-sdk 0.0.1

package/dist/libs/errors/types.d.ts

@@ -0,0 +1,14 @@
+export declare const ERROR: {
+    ERROR_ADDRESS_NOT_FOUND: string;
+    ERROR_CIRCUIT_NOT_FOUND: string;
+    ERROR_OPERATOR_INVALID_ADDRESS: string;
+    ERROR_OPERATOR_NOT_FOUND: string;
+    ERROR_OPERATORS_NOT_FOUND: string;
+    ERROR_PROOF_NOT_FOUND: string;
+    ERROR_ROUND_INVALID_ADDRESS: string;
+    ERROR_ROUND_INVALID_STATUS: string;
+    ERROR_ROUND_NOT_FOUND: string;
+    ERROR_ROUNDS_NOT_FOUND: string;
+    ERROR_TRANSACTION_NOT_FOUND: string;
+    ERROR_TRANSACTIONS_NOT_FOUND: string;
+};

package/dist/libs/http/http.d.ts

@@ -0,0 +1,16 @@
+export type FetchOptions = RequestInit & {
+    next?: {
+        revalidate?: boolean | number;
+    };
+};
+export declare class Http {
+    private customFetch?;
+    private apiEndpoint;
+    private restEndpoint;
+    private defaultOptions?;
+    constructor(apiEndpoint: string, restEndpoint: string, customFetch?: typeof fetch | undefined, defaultOptions?: FetchOptions);
+    private getFetch;
+    fetch(url: string): Promise<Response>;
+    fetchGraphql<T>(query: string, after: string, limit?: number | null): Promise<T>;
+    fetchRest(path: string): Promise<any>;
+}

package/dist/libs/http/index.d.ts

@@ -0,0 +1 @@
+export { Http } from './http';

package/dist/libs/index.d.ts

@@ -0,0 +1,4 @@
+export { Http } from './http';
+export * from './query';
+export * from './indexer';
+export * from './contract';

package/dist/libs/indexer/index.d.ts

@@ -0,0 +1 @@
+export { Indexer } from './indexer';

package/dist/libs/indexer/indexer.d.ts

@@ -0,0 +1,133 @@
+import { BalanceResponse, RoundResponse, RoundsResponse, OperatorResponse, OperatorsResponse, CircuitResponse, TransactionResponse, TransactionsResponse, CircuitsResponse, ProofResponse } from '../../types';
+import { IndexerParams } from './types';
+import { Http } from '../http';
+import { Round, Account, Circuit, Operator, Proof, Transaction } from '../query';
+/**
+ * @class Indexer
+ * @description This class is used to interact with Maci Indexer.
+ */
+export declare class Indexer {
+    restEndpoint: string;
+    apiEndpoint: string;
+    registryAddress: string;
+    http: Http;
+    round: Round;
+    account: Account;
+    circuit: Circuit;
+    operator: Operator;
+    proof: Proof;
+    transaction: Transaction;
+    /**
+     * @constructor
+     * @param {IndexerParams} params - The parameters for the Maci Indexer instance.
+     */
+    constructor({ restEndpoint, apiEndpoint, registryAddress, http, }: IndexerParams);
+    /**
+     * @method balanceOf
+     * @description Get the balance of a specific address.
+     * @param {string} address - The address to check the balance for.
+     * @returns {Promise<BalanceResponse>} The balance response.
+     */
+    balanceOf(address: string): Promise<BalanceResponse>;
+    /**
+     * @method getRoundById
+     * @description Get a round by its ID.
+     * @param {string} id - The ID of the round.
+     * @returns {Promise<RoundResponse>} The round response.
+     */
+    getRoundById(id: string): Promise<RoundResponse>;
+    /**
+     * @method getRounds
+     * @description Get multiple rounds.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of rounds to retrieve.
+     * @returns {Promise<RoundsResponse>} The rounds response.
+     */
+    getRounds(after: string, limit?: number): Promise<RoundsResponse>;
+    /**
+     * @method getRoundsByStatus
+     * @description Get rounds by their status.
+     * @param {string} status - The status of the rounds to retrieve.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of rounds to retrieve.
+     * @returns {Promise<RoundsResponse>} The rounds response.
+     */
+    getRoundsByStatus(status: string, after: string, limit?: number): Promise<RoundsResponse>;
+    /**
+     * @method getRoundsByCircuitName
+     * @description Get rounds by their circuit name.
+     * @param {string} name - The name of the circuit.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of rounds to retrieve.
+     * @returns {Promise<RoundsResponse>} The rounds response.
+     */
+    getRoundsByCircuitName(name: string, after: string, limit?: number): Promise<RoundsResponse>;
+    /**
+     * @method getRoundsByOperator
+     * @description Get rounds by their operator address.
+     * @param {string} address - The address of the operator.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of rounds to retrieve.
+     * @returns {Promise<RoundsResponse>} The rounds response.
+     */
+    getRoundsByOperator(address: string, after: string, limit?: number): Promise<RoundsResponse>;
+    /**
+     * @method getOperatorByAddress
+     * @description Get an operator by their address.
+     * @param {string} address - The address of the operator.
+     * @returns {Promise<OperatorResponse>} The operator response.
+     */
+    getOperatorByAddress(address: string): Promise<OperatorResponse>;
+    /**
+     * @method getOperators
+     * @description Get multiple operators.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of operators to retrieve.
+     * @returns {Promise<OperatorsResponse>} The operators response.
+     */
+    getOperators(after: string, limit?: number): Promise<OperatorsResponse>;
+    /**
+     * @method getCircuitByName
+     * @description Get a circuit by its name.
+     * @param {string} name - The name of the circuit.
+     * @returns {Promise<CircuitResponse>} The circuit response.
+     */
+    getCircuitByName(name: string): Promise<CircuitResponse>;
+    /**
+     * @method getCircuits
+     * @description Get all available circuits.
+     * @returns {Promise<CircuitsResponse>} The circuits response.
+     */
+    getCircuits(): Promise<CircuitsResponse>;
+    /**
+     * @method getTransactionByHash
+     * @description Get a transaction by its hash.
+     * @param {string} hash - The hash of the transaction.
+     * @returns {Promise<TransactionResponse>} The transaction response.
+     */
+    getTransactionByHash(hash: string): Promise<TransactionResponse>;
+    /**
+     * @method getTransactions
+     * @description Get multiple transactions.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of transactions to retrieve.
+     * @returns {Promise<TransactionsResponse>} The transactions response.
+     */
+    getTransactions(after: string, limit?: number): Promise<TransactionsResponse>;
+    /**
+     * @method getTransactionsByContractAddress
+     * @description Get transactions by contract address.
+     * @param {string} address - The contract address.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of transactions to retrieve.
+     * @returns {Promise<TransactionsResponse>} The transactions response.
+     */
+    getTransactionsByContractAddress(address: string, after: string, limit?: number): Promise<TransactionsResponse>;
+    /**
+     * @method getProofByContractAddress
+     * @description Get proof data by contract address.
+     * @param {string} address - The contract address.
+     * @returns {Promise<ProofResponse>} The proof response.
+     */
+    getProofByContractAddress(address: string): Promise<ProofResponse>;
+}

package/dist/libs/indexer/types.d.ts

@@ -0,0 +1,7 @@
+import { Http } from '../http/http';
+export type IndexerParams = {
+    restEndpoint: string;
+    apiEndpoint: string;
+    registryAddress: string;
+    http: Http;
+};

package/dist/libs/query/account.d.ts

@@ -0,0 +1,7 @@
+import { Http } from '../http';
+import { BalanceResponse } from '../../types';
+export declare class Account {
+    http: Http;
+    constructor(http: Http);
+    balanceOf(address: string): Promise<BalanceResponse>;
+}

package/dist/libs/query/circuit.d.ts

@@ -0,0 +1,8 @@
+import { Http } from '../../libs';
+import { CircuitResponse, CircuitsResponse } from '../../types';
+export declare class Circuit {
+    http: Http;
+    constructor(http: Http);
+    getCircuitByName(name: string): Promise<CircuitResponse>;
+    getCircuits(): Promise<CircuitsResponse>;
+}

package/dist/libs/query/index.d.ts

@@ -0,0 +1,6 @@
+export { Account } from './account';
+export { Circuit } from './circuit';
+export { Operator } from './operator';
+export { Round } from './round';
+export { Transaction } from './transaction';
+export { Proof } from './proof';

package/dist/libs/query/operator.d.ts

@@ -0,0 +1,9 @@
+import { Http } from '../../libs';
+import { OperatorResponse, OperatorsResponse } from '../../types';
+export declare class Operator {
+    http: Http;
+    amaciRegistryContract: string;
+    constructor(http: Http, amaciRegistryContract: string);
+    getOperatorByAddress(address: string): Promise<OperatorResponse>;
+    getOperators(after: string, limit?: number): Promise<OperatorsResponse>;
+}

package/dist/libs/query/proof.d.ts

@@ -0,0 +1,7 @@
+import { Http } from '../../libs';
+import { ProofResponse } from '../../types';
+export declare class Proof {
+    http: Http;
+    constructor(http: Http);
+    getProofByContractAddress(address: string): Promise<ProofResponse>;
+}

package/dist/libs/query/round.d.ts

@@ -0,0 +1,11 @@
+import { RoundsResponse, RoundResponse } from '../../types';
+import { Http } from '../../libs';
+export declare class Round {
+    http: Http;
+    constructor(http: Http);
+    getRoundById(address: string): Promise<RoundResponse>;
+    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>;
+    getRoundsByOperator(operator: string, after: string, limit?: number): Promise<RoundsResponse>;
+}

package/dist/libs/query/transaction.d.ts

@@ -0,0 +1,9 @@
+import { TransactionsResponse, TransactionResponse } from '../../types';
+import { Http } from '../../libs';
+export declare class Transaction {
+    http: Http;
+    constructor(http: Http);
+    getTransactionByHash(txHash: string): Promise<TransactionResponse>;
+    getTransactions(after: string, limit?: number): Promise<TransactionsResponse>;
+    getTransactionsByContractAddress(address: string, after: string, limit?: number): Promise<TransactionsResponse>;
+}

package/dist/maci.d.ts

@@ -0,0 +1,151 @@
+import { BalanceResponse, ClientParams, RoundResponse, RoundsResponse, OperatorResponse, OperatorsResponse, CircuitResponse, TransactionResponse, TransactionsResponse, CircuitsResponse, ProofResponse } from './types';
+import { Http, Indexer, Contract } from './libs';
+import { CreateAMaciRoundParams, CreateMaciRoundParams, CreateOracleMaciRoundParams } from './libs/contract/types';
+import { OfflineSigner } from '@cosmjs/proto-signing';
+/**
+ * @class MaciClient
+ * @description This class is used to interact with Maci Client.
+ */
+export declare class MaciClient {
+    rpcEndpoint: string;
+    restEndpoint: string;
+    apiEndpoint: string;
+    registryAddress: string;
+    maciCodeId: number;
+    oracleCodeId: number;
+    http: Http;
+    indexer: Indexer;
+    contract: Contract;
+    /**
+     * @constructor
+     * @param {ClientParams} params - The parameters for the Maci Client instance.
+     */
+    constructor({ network, rpcEndpoint, restEndpoint, apiEndpoint, registryAddress, maciCodeId, oracleCodeId, customFetch, defaultOptions, }: ClientParams);
+    oracleMaciClient({ signer, contractAddress, }: {
+        signer: OfflineSigner;
+        contractAddress: string;
+    }): Promise<import("./libs/contract/ts/OracleMaci.client").OracleMaciClient>;
+    registryClient({ signer, contractAddress, }: {
+        signer: OfflineSigner;
+        contractAddress: string;
+    }): Promise<import("./libs/contract/ts/Registry.client").RegistryClient>;
+    maciClient({ signer, contractAddress, }: {
+        signer: OfflineSigner;
+        contractAddress: string;
+    }): Promise<import("./libs/contract/ts/Maci.client").MaciClient>;
+    amaciClient({ signer, contractAddress, }: {
+        signer: OfflineSigner;
+        contractAddress: string;
+    }): Promise<import("./libs/contract/ts/AMaci.client").AMaciClient>;
+    createAMaciRound(params: CreateAMaciRoundParams): Promise<string>;
+    createMaciRound(params: CreateMaciRoundParams): Promise<import("@cosmjs/cosmwasm-stargate").InstantiateResult>;
+    createOracleMaciRound(params: CreateOracleMaciRoundParams): Promise<import("@cosmjs/cosmwasm-stargate").InstantiateResult>;
+    /**
+     * @method balanceOf
+     * @description Get the balance of a specific address.
+     * @param {string} address - The address to check the balance for.
+     * @returns {Promise<BalanceResponse>} The balance response.
+     */
+    balanceOf(address: string): Promise<BalanceResponse>;
+    /**
+     * @method getRoundById
+     * @description Get a round by its ID.
+     * @param {string} id - The ID of the round.
+     * @returns {Promise<RoundResponse>} The round response.
+     */
+    getRoundById(id: string): Promise<RoundResponse>;
+    /**
+     * @method getRounds
+     * @description Get multiple rounds.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of rounds to retrieve.
+     * @returns {Promise<RoundsResponse>} The rounds response.
+     */
+    getRounds(after: string, limit?: number): Promise<RoundsResponse>;
+    /**
+     * @method getRoundsByStatus
+     * @description Get rounds by their status.
+     * @param {string} status - The status of the rounds to retrieve.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of rounds to retrieve.
+     * @returns {Promise<RoundsResponse>} The rounds response.
+     */
+    getRoundsByStatus(status: string, after: string, limit?: number): Promise<RoundsResponse>;
+    /**
+     * @method getRoundsByCircuitName
+     * @description Get rounds by their circuit name.
+     * @param {string} name - The name of the circuit.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of rounds to retrieve.
+     * @returns {Promise<RoundsResponse>} The rounds response.
+     */
+    getRoundsByCircuitName(name: string, after: string, limit?: number): Promise<RoundsResponse>;
+    /**
+     * @method getRoundsByOperator
+     * @description Get rounds by their operator address.
+     * @param {string} address - The address of the operator.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of rounds to retrieve.
+     * @returns {Promise<RoundsResponse>} The rounds response.
+     */
+    getRoundsByOperator(address: string, after: string, limit?: number): Promise<RoundsResponse>;
+    /**
+     * @method getOperatorByAddress
+     * @description Get an operator by their address.
+     * @param {string} address - The address of the operator.
+     * @returns {Promise<OperatorResponse>} The operator response.
+     */
+    getOperatorByAddress(address: string): Promise<OperatorResponse>;
+    /**
+     * @method getOperators
+     * @description Get multiple operators.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of operators to retrieve.
+     * @returns {Promise<OperatorsResponse>} The operators response.
+     */
+    getOperators(after: string, limit?: number): Promise<OperatorsResponse>;
+    /**
+     * @method getCircuitByName
+     * @description Get a circuit by its name.
+     * @param {string} name - The name of the circuit.
+     * @returns {Promise<CircuitResponse>} The circuit response.
+     */
+    getCircuitByName(name: string): Promise<CircuitResponse>;
+    /**
+     * @method getCircuits
+     * @description Get all available circuits.
+     * @returns {Promise<CircuitsResponse>} The circuits response.
+     */
+    getCircuits(): Promise<CircuitsResponse>;
+    /**
+     * @method getTransactionByHash
+     * @description Get a transaction by its hash.
+     * @param {string} hash - The hash of the transaction.
+     * @returns {Promise<TransactionResponse>} The transaction response.
+     */
+    getTransactionByHash(hash: string): Promise<TransactionResponse>;
+    /**
+     * @method getTransactions
+     * @description Get multiple transactions.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of transactions to retrieve.
+     * @returns {Promise<TransactionsResponse>} The transactions response.
+     */
+    getTransactions(after: string, limit?: number): Promise<TransactionsResponse>;
+    /**
+     * @method getTransactionsByContractAddress
+     * @description Get transactions by contract address.
+     * @param {string} address - The contract address.
+     * @param {string} after - The cursor to start after.
+     * @param {number} [limit] - The number of transactions to retrieve.
+     * @returns {Promise<TransactionsResponse>} The transactions response.
+     */
+    getTransactionsByContractAddress(address: string, after: string, limit?: number): Promise<TransactionsResponse>;
+    /**
+     * @method getProofByContractAddress
+     * @description Get proof data by contract address.
+     * @param {string} address - The contract address.
+     * @returns {Promise<ProofResponse>} The proof response.
+     */
+    getProofByContractAddress(address: string): Promise<ProofResponse>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,254 @@
+import { FetchOptions } from '../libs/http/http';
+export type ClientParams = {
+    network: 'mainnet' | 'testnet';
+    rpcEndpoint?: string;
+    restEndpoint?: string;
+    apiEndpoint?: string;
+    registryAddress?: string;
+    maciCodeId?: number;
+    oracleCodeId?: number;
+    customFetch?: typeof fetch;
+    defaultOptions?: FetchOptions;
+};
+export type ContractParams = {
+    rpcEndpoint: string;
+    registryAddress: string;
+    maciCodeId: number;
+    oracleCodeId: number;
+};
+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 ProofType = {
+    nodes: {
+        id: string;
+        blockHeight: string;
+        txHash: string;
+        contractAddress: string;
+        timestamp: string;
+        actionType: string;
+        commitment: string;
+        proof: 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 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 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 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 RoundsResponse = SuccessResponse<{
+    rounds: {
+        pageInfo: {
+            endCursor: string;
+            hasNextPage: boolean;
+        };
+        edges: {
+            cursor: string;
+            node: RoundType;
+        }[];
+        totalCount: number;
+    };
+}> | ErrorResponse;
+export type RoundGraphqlResponse = {
+    data: {
+        round: RoundType;
+    };
+};
+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;
+    };
+};

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export declare function isValidAddress(address: string): boolean;