@dorafactory/maci-sdk 0.0.34 → 0.0.36

package/src/maci.ts

@@ -1,28 +1,5 @@
-import {
-  BalanceResponse,
-  ClientParams,
-  RoundResponse,
-  RoundsResponse,
-  OperatorResponse,
-  OperatorsResponse,
-  CircuitResponse,
-  TransactionResponse,
-  TransactionsResponse,
-  CircuitsResponse,
-  ProofResponse,
-  SelectiveRoundResponse,
-  CertificateEcosystem,
-  ErrorResponse,
-  RoundType,
-} from './types';
-import {
-  Http,
-  Indexer,
-  Contract,
-  OracleCertificate,
-  Circom,
-  MACI,
-} from './libs';
+import { ClientParams, CertificateEcosystem } from './types';
+import { Http, Indexer, Contract, OracleCertificate, MACI } from './libs';
 import { getDefaultParams } from './libs/const';
 import {
   CreateAMaciRoundParams,
@@ -30,17 +7,23 @@ import {
   CreateOracleMaciRoundParams,
 } from './libs/contract/types';
 import { OfflineSigner } from '@cosmjs/proto-signing';
-import { Account, PublicKey } from './libs/circom';
-import { SigningCosmWasmClient } from '@cosmjs/cosmwasm-stargate';
+import {
+  genKeypair,
+  genKeypairFromSign,
+  Keypair,
+  packPubKey,
+  PubKey,
+  unpackPubKey,
+} from './libs/crypto';
 import { OracleWhitelistConfig } from './libs/contract/ts/OracleMaci.types';
 import { SignatureResponse } from './libs/oracle-certificate/types';
-import { StdFee } from '@cosmjs/stargate';
 
 /**
  * @class MaciClient
  * @description This class is used to interact with Maci Client.
  */
 export class MaciClient {
+  public network: 'mainnet' | 'testnet';
   public rpcEndpoint: string;
   public restEndpoint: string;
   public apiEndpoint: string;
@@ -55,15 +38,18 @@ export class MaciClient {
   public http: Http;
   public indexer: Indexer;
   public contract: Contract;
-  public circom: Circom;
   public oracleCertificate: OracleCertificate;
   public maci: MACI;
+  public maciKeypair: Keypair;
+
+  public signer: OfflineSigner;
 
   /**
    * @constructor
    * @param {ClientParams} params - The parameters for the Maci Client instance.
    */
   constructor({
+    signer,
     network,
     rpcEndpoint,
     restEndpoint,
@@ -76,7 +62,10 @@ export class MaciClient {
     feegrantOperator,
     whitelistBackendPubkey,
     certificateApiEndpoint,
+    maciKeypair,
   }: ClientParams) {
+    this.signer = signer;
+    this.network = network;
     const defaultParams = getDefaultParams(network);
 
     this.rpcEndpoint = rpcEndpoint || defaultParams.rpcEndpoint;
@@ -91,6 +80,7 @@ export class MaciClient {
       feegrantOperator || defaultParams.oracleFeegrantOperator;
     this.whitelistBackendPubkey =
       whitelistBackendPubkey || defaultParams.oracleWhitelistBackendPubkey;
+    this.maciKeypair = maciKeypair ?? genKeypair();
 
     this.http = new Http(
       this.apiEndpoint,
@@ -112,26 +102,51 @@ export class MaciClient {
       feegrantOperator: this.feegrantOperator,
       whitelistBackendPubkey: this.whitelistBackendPubkey,
     });
-    this.circom = new Circom({ network });
     this.oracleCertificate = new OracleCertificate({
       certificateApiEndpoint: this.certificateApiEndpoint,
       http: this.http,
     });
     this.maci = new MACI({
-      circom: this.circom,
       contract: this.contract,
       indexer: this.indexer,
       oracleCertificate: this.oracleCertificate,
+      maciKeypair: this.maciKeypair,
     });
   }
 
+  getSigner(signer?: OfflineSigner) {
+    return signer || this.signer;
+  }
+
+  getMaciKeypair() {
+    return this.maciKeypair;
+  }
+
+  getMaciPubkey() {
+    return this.packMaciPubkey(this.maciKeypair.pubKey);
+  }
+
+  packMaciPubkey(pubkey?: PubKey) {
+    return packPubKey(pubkey || this.maciKeypair.pubKey);
+  }
+
+  unpackMaciPubkey(pubkey: bigint | string) {
+    return unpackPubKey(BigInt(pubkey));
+  }
+
+  async getAddress(signer?: OfflineSigner) {
+    const [{ address }] = await this.getSigner(signer).getAccounts();
+    return address;
+  }
+
   async oracleMaciClient({
     signer,
     contractAddress,
   }: {
-    signer: OfflineSigner;
+    signer?: OfflineSigner;
     contractAddress: string;
   }) {
+    signer = this.getSigner(signer);
     return await this.contract.oracleMaciClient({
       signer,
       contractAddress,
@@ -142,9 +157,10 @@ export class MaciClient {
     signer,
     contractAddress,
   }: {
-    signer: OfflineSigner;
+    signer?: OfflineSigner;
     contractAddress: string;
   }) {
+    signer = this.getSigner(signer);
     return await this.contract.registryClient({ signer, contractAddress });
   }
 
@@ -152,9 +168,10 @@ export class MaciClient {
     signer,
     contractAddress,
   }: {
-    signer: OfflineSigner;
+    signer?: OfflineSigner;
     contractAddress: string;
   }) {
+    signer = this.getSigner(signer);
     return await this.contract.maciClient({ signer, contractAddress });
   }
 
@@ -162,22 +179,46 @@ export class MaciClient {
     signer,
     contractAddress,
   }: {
-    signer: OfflineSigner;
+    signer?: OfflineSigner;
     contractAddress: string;
   }) {
+    signer = this.getSigner(signer);
     return await this.contract.amaciClient({ signer, contractAddress });
   }
 
   async createAMaciRound(params: CreateAMaciRoundParams) {
-    return await this.contract.createAMaciRound(params);
+    return await this.contract.createAMaciRound({
+      signer: this.getSigner(),
+      ...params,
+    });
   }
 
   async createMaciRound(params: CreateMaciRoundParams) {
-    return await this.contract.createMaciRound(params);
+    return await this.contract.createMaciRound({
+      signer: this.getSigner(),
+      ...params,
+    });
   }
 
   async createOracleMaciRound(params: CreateOracleMaciRoundParams) {
-    return await this.contract.createOracleMaciRound(params);
+    return await this.contract.createOracleMaciRound({
+      signer: this.getSigner(),
+      ...params,
+    });
+  }
+
+  async genKeypairFromSign({
+    signer,
+    address,
+  }: {
+    signer?: OfflineSigner;
+    address?: string;
+  } = {}) {
+    return await genKeypairFromSign({
+      signer: this.getSigner(signer),
+      address,
+      network: this.network,
+    });
   }
 
   async getStateIdxInc({
@@ -185,12 +226,12 @@ export class MaciClient {
     address,
     contractAddress,
   }: {
-    signer: OfflineSigner;
-    address: string;
+    signer?: OfflineSigner;
+    address?: string;
     contractAddress: string;
   }) {
     return await this.maci.getStateIdxInc({
-      signer,
+      signer: this.getSigner(signer),
       address,
       contractAddress,
     });
@@ -201,12 +242,12 @@ export class MaciClient {
     stateIdx,
     contractAddress,
   }: {
-    signer: OfflineSigner;
+    signer?: OfflineSigner;
     stateIdx: number;
     contractAddress: string;
   }) {
     return await this.maci.getVoiceCreditBalance({
-      signer,
+      signer: this.getSigner(signer),
       stateIdx,
       contractAddress,
     });
@@ -226,12 +267,15 @@ export class MaciClient {
   }
 
   async feegrantAllowance({
+    signer,
     address,
     contractAddress,
   }: {
-    address: string;
+    signer?: OfflineSigner;
+    address?: string;
     contractAddress: string;
   }) {
+    address = await this.getAddress(signer);
     return await this.maci.feegrantAllowance({
       address,
       contractAddress,
@@ -239,12 +283,15 @@ export class MaciClient {
   }
 
   async hasFeegrant({
+    signer,
     address,
     contractAddress,
   }: {
-    address: string;
+    signer?: OfflineSigner;
+    address?: string;
     contractAddress: string;
   }): Promise<boolean> {
+    address = await this.getAddress(signer);
     return await this.maci.hasFeegrant({
       address,
       contractAddress,
@@ -258,12 +305,19 @@ export class MaciClient {
     certificate,
     mode = 'maci',
   }: {
-    signer: OfflineSigner;
-    address: string;
+    signer?: OfflineSigner;
+    address?: string;
     contractAddress: string;
-    certificate?: string;
+    certificate?: {
+      signature: string;
+      amount: string;
+    };
     mode?: 'maci' | 'amaci';
   }): Promise<string> {
+    signer = this.getSigner(signer);
+    if (!address) {
+      address = await this.getAddress(signer);
+    }
     return await this.maci.queryWhitelistBalanceOf({
       signer,
       address,
@@ -278,10 +332,14 @@ export class MaciClient {
     address,
     contractAddress,
   }: {
-    signer: OfflineSigner;
-    address: string;
+    signer?: OfflineSigner;
+    address?: string;
     contractAddress: string;
   }) {
+    signer = this.getSigner(signer);
+    if (!address) {
+      address = await this.getAddress(signer);
+    }
     return await this.maci.isWhitelisted({
       signer,
       address,
@@ -293,11 +351,11 @@ export class MaciClient {
     signer,
     contractAddress,
   }: {
-    signer: OfflineSigner;
+    signer?: OfflineSigner;
     contractAddress: string;
   }): Promise<OracleWhitelistConfig> {
     return await this.maci.getOracleWhitelistConfig({
-      signer,
+      signer: this.getSigner(signer),
       contractAddress,
     });
   }
@@ -366,13 +424,13 @@ export class MaciClient {
     address,
     contractAddress,
   }: {
-    signer: OfflineSigner;
+    signer?: OfflineSigner;
     ecosystem: CertificateEcosystem;
-    address: string;
+    address?: string;
     contractAddress: string;
   }): Promise<SignatureResponse> {
     return await this.maci.requestOracleCertificate({
-      signer,
+      signer: this.getSigner(signer),
       ecosystem,
       address,
       contractAddress,
@@ -383,14 +441,14 @@ export class MaciClient {
     signer,
     address,
     contractAddress,
-    maciAccount,
+    maciKeypair,
     oracleCertificate,
     gasStation = false,
   }: {
-    signer: OfflineSigner;
-    address: string;
+    signer?: OfflineSigner;
+    address?: string;
     contractAddress: string;
-    maciAccount?: Account;
+    maciKeypair?: Keypair;
     oracleCertificate?: {
       amount: string;
       signature: string;
@@ -398,10 +456,10 @@ export class MaciClient {
     gasStation?: boolean;
   }) {
     return await this.maci.signup({
-      signer,
+      signer: this.getSigner(signer),
       address,
       contractAddress,
-      maciAccount,
+      maciKeypair,
       oracleCertificate,
       gasStation,
     });
@@ -414,54 +472,29 @@ export class MaciClient {
     contractAddress,
     selectedOptions,
     operatorCoordPubKey,
-    maciAccount,
+    maciKeypair,
     gasStation = false,
   }: {
-    signer: OfflineSigner;
-    address: string;
+    signer?: OfflineSigner;
+    address?: string;
     stateIdx: number;
     contractAddress: string;
     selectedOptions: {
       idx: number;
       vc: number;
     }[];
-    operatorCoordPubKey: PublicKey;
-    maciAccount?: Account;
+    operatorCoordPubKey: PubKey;
+    maciKeypair?: Keypair;
     gasStation?: boolean;
   }) {
     return await this.maci.vote({
-      signer,
+      signer: this.getSigner(signer),
       address,
       stateIdx,
       contractAddress,
       selectedOptions,
       operatorCoordPubKey,
-      maciAccount,
-      gasStation,
-    });
-  }
-
-  async publishMessage({
-    client,
-    address,
-    payload,
-    contractAddress,
-    gasStation,
-  }: {
-    client: SigningCosmWasmClient;
-    address: string;
-    payload: {
-      msg: bigint[];
-      encPubkeys: PublicKey;
-    }[];
-    contractAddress: string;
-    gasStation: boolean;
-  }) {
-    return await this.maci.publishMessage({
-      client,
-      address,
-      payload,
-      contractAddress,
+      maciKeypair,
       gasStation,
     });
   }
@@ -470,9 +503,10 @@ export class MaciClient {
     signer,
     contractAddress,
   }: {
-    signer: OfflineSigner;
+    signer?: OfflineSigner;
     contractAddress: string;
   }) {
+    signer = this.getSigner(signer);
     return await this.maci.claimAMaciRound({
       signer,
       contractAddress,
@@ -489,13 +523,16 @@ export class MaciClient {
     address,
     amount,
   }: {
-    signer: OfflineSigner;
+    signer?: OfflineSigner;
     contractAddress: string;
-    address: string;
+    address?: string;
     amount: string;
   }) {
+    if (!address) {
+      address = await this.getAddress(signer);
+    }
     return await this.maci.batchGrantWithBond({
-      signer,
+      signer: this.getSigner(signer),
       contractAddress,
       address,
       amount,
@@ -507,12 +544,15 @@ export class MaciClient {
     contractAddress,
     address,
   }: {
-    signer: OfflineSigner;
+    signer?: OfflineSigner;
     contractAddress: string;
-    address: string;
+    address?: string;
   }) {
+    if (!address) {
+      address = await this.getAddress(signer);
+    }
     return await this.maci.batchRevokeWithdraw({
-      signer,
+      signer: this.getSigner(signer),
       contractAddress,
       address,
     });

package/src/types/index.ts

@@ -1,5 +1,8 @@
+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 enum MaciCircuitType {
   IP1V = '0',
@@ -20,6 +23,7 @@ export enum MaciRoundType {
 export type CertificateEcosystem = 'cosmoshub' | 'doravota';
 
 export type ClientParams = {
+  signer: OfflineSigner;
   network: 'mainnet' | 'testnet';
   rpcEndpoint?: string;
   restEndpoint?: string;
@@ -32,6 +36,9 @@ export type ClientParams = {
   defaultOptions?: FetchOptions;
   feegrantOperator?: string;
   whitelistBackendPubkey?: string;
+  maciKeypair?: Keypair;
+  secretKey?: string;
+  mnemonic?: string;
 };
 
 export type ContractParams = {

package/src/utils/index.ts

@@ -36,25 +36,25 @@ function padWithZerosIfNeeded(inputString: string) {
   throw new Error('Invalid input string length');
 }
 
-/**
- * Parses a public key string into its x and y coordinates.
- * @param publickKey - The public key string to parse (128 characters long).
- * @returns An object containing the x and y coordinates as decimal strings.
- */
-export function decompressPublicKey(compressedPubkey: string) {
-  const x = compressedPubkey.slice(0, 64);
-  const y = compressedPubkey.slice(64);
-
-  return {
-    x: hexToDecimalString(x),
-    y: hexToDecimalString(y),
-  };
-}
-
-export function compressPublicKey(decompressedPubkey: any[]) {
-  const x = decompressedPubkey[0];
-  const y = decompressedPubkey[1];
-  const compressedPubkey =
-    padWithZerosIfNeeded(x.toString(16)) + padWithZerosIfNeeded(y.toString(16));
-  return compressedPubkey;
-}
+// /**
+//  * Parses a public key string into its x and y coordinates.
+//  * @param publickKey - The public key string to parse (128 characters long).
+//  * @returns An object containing the x and y coordinates as decimal strings.
+//  */
+// export function decompressPublicKey(compressedPubkey: string) {
+//   const x = compressedPubkey.slice(0, 64);
+//   const y = compressedPubkey.slice(64);
+
+//   return {
+//     x: hexToDecimalString(x),
+//     y: hexToDecimalString(y),
+//   };
+// }
+
+// export function compressPublicKey(decompressedPubkey: any[]) {
+//   const x = decompressedPubkey[0];
+//   const y = decompressedPubkey[1];
+//   const compressedPubkey =
+//     padWithZerosIfNeeded(x.toString(16)) + padWithZerosIfNeeded(y.toString(16));
+//   return compressedPubkey;
+// }