@dorafactory/maci-sdk 0.0.1

package/src/libs/contract/ts/Registry.types.ts

@@ -0,0 +1,127 @@
+/**
+ * This file was automatically generated by @cosmwasm/ts-codegen@1.11.1.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run the @cosmwasm/ts-codegen generate command to regenerate this file.
+ */
+
+export type Addr = string;
+export interface InstantiateMsg {
+	admin: Addr;
+	amaci_code_id: number;
+	operator: Addr;
+}
+export type ExecuteMsg =
+	| {
+			set_maci_operator: {
+				operator: Addr;
+			};
+	  }
+	| {
+			set_maci_operator_pubkey: {
+				pubkey: PubKey;
+			};
+	  }
+	| {
+			set_maci_operator_identity: {
+				identity: string;
+			};
+	  }
+	| {
+			create_round: {
+				certification_system: Uint256;
+				circuit_type: Uint256;
+				max_option: Uint256;
+				max_voter: Uint256;
+				operator: Addr;
+				pre_deactivate_root: Uint256;
+				round_info: RoundInfo;
+				voice_credit_amount: Uint256;
+				voting_time: VotingTime;
+				whitelist?: Whitelist | null;
+			};
+	  }
+	| {
+			set_validators: {
+				addresses: ValidatorSet;
+			};
+	  }
+	| {
+			remove_validator: {
+				address: Addr;
+			};
+	  }
+	| {
+			update_amaci_code_id: {
+				amaci_code_id: number;
+			};
+	  }
+	| {
+			change_operator: {
+				address: Addr;
+			};
+	  };
+export type Uint256 = string;
+export type Timestamp = Uint64;
+export type Uint64 = string;
+export interface PubKey {
+	x: Uint256;
+	y: Uint256;
+}
+export interface RoundInfo {
+	description: string;
+	link: string;
+	title: string;
+}
+export interface VotingTime {
+	end_time: Timestamp;
+	start_time: Timestamp;
+}
+export interface Whitelist {
+	users: WhitelistConfig[];
+}
+export interface WhitelistConfig {
+	addr: Addr;
+}
+export interface ValidatorSet {
+	addresses: Addr[];
+}
+export type QueryMsg =
+	| {
+			admin: {};
+	  }
+	| {
+			operator: {};
+	  }
+	| {
+			is_maci_operator: {
+				address: Addr;
+			};
+	  }
+	| {
+			is_validator: {
+				address: Addr;
+			};
+	  }
+	| {
+			get_validators: {};
+	  }
+	| {
+			get_validator_operator: {
+				address: Addr;
+			};
+	  }
+	| {
+			get_maci_operator_pubkey: {
+				address: Addr;
+			};
+	  }
+	| {
+			get_maci_operator_identity: {
+				address: Addr;
+			};
+	  };
+export interface AdminResponse {
+	admin: Addr;
+}
+export type String = string;
+export type Boolean = boolean;

package/src/libs/contract/types.ts

@@ -0,0 +1,57 @@
+import { Whitelist as RegistryWhitelist } from './ts/Registry.types';
+import { Whitelist as MaciWhitelist } from './ts/Maci.types';
+import { OfflineSigner } from '@cosmjs/proto-signing';
+
+export enum MaciCircuitType {
+  IP1V = '0',
+  QV = '1',
+}
+
+export enum MaciCertSystemType {
+  GROTH16 = 'groth16',
+  PLONK = 'plonk',
+}
+
+export enum MaciRoundType {
+  MACI = '0',
+  AMACI = '1',
+  ORACLE_MACI = '2',
+}
+
+export interface CreateRoundParams {
+  signer: OfflineSigner;
+  title: string;
+  description?: string;
+  link?: string;
+  startVoting: Date;
+  endVoting: Date;
+  maxVoter: string;
+  maxOption: string;
+  circuitType: MaciCircuitType;
+}
+
+export type CreateAMaciRoundParams = {
+  operator: string;
+  whitelist: RegistryWhitelist;
+  voiceCreditAmount: string;
+  preDeactivateRoot?: string;
+} & CreateRoundParams;
+
+export type CreateMaciRoundParams = {
+  operatorPubkey: string;
+  whitelist: MaciWhitelist;
+  certSystemType: MaciCertSystemType;
+} & CreateRoundParams;
+
+export type CreateOracleMaciRoundParams = {
+  operatorPubkey: string;
+  whitelistEcosystem: string;
+  whitelistSnapshotHeight: string;
+  whitelistVotingPowerArgs: {
+    mode: string;
+    slope: string;
+    threshold: string;
+  };
+  whitelistBackendPubkey?: string;
+  feegrantOperator?: string;
+} & CreateRoundParams;

package/src/libs/contract/utils.ts

@@ -0,0 +1,175 @@
+import { MaciCertSystemType, MaciCircuitType, MaciRoundType } from './types';
+import { CIRCUIT_INFO } from './vars';
+
+type MixedData<T> = T | Array<MixedData<T>> | { [key: string]: MixedData<T> };
+
+export const stringizing = (
+  o: MixedData<bigint>,
+  path: MixedData<bigint>[] = []
+): MixedData<string> => {
+  if (path.includes(o)) {
+    throw new Error('loop nesting!');
+  }
+  const newPath = [...path, o];
+
+  if (Array.isArray(o)) {
+    return o.map((item) => stringizing(item, newPath));
+  } else if (typeof o === 'object') {
+    const output: { [key: string]: MixedData<string> } = {};
+    for (const key in o) {
+      output[key] = stringizing(o[key], newPath);
+    }
+    return output;
+  } else {
+    return o.toString();
+  }
+};
+
+export function getContractParams(
+  type: MaciRoundType,
+  circuitType: MaciCircuitType,
+  proofSystem: MaciCertSystemType,
+  maxVoter: string,
+  maxOption: string
+) {
+  let parameters: {
+    state_tree_depth: string;
+    int_state_tree_depth: string;
+    vote_option_tree_depth: string;
+    message_batch_size: string;
+  };
+  let groth16ProcessVkey = null;
+  let groth16TallyVkey = null;
+  let plonkProcessVkey = null;
+  let plonkTallyVkey = null;
+  let maciVoteType = null;
+  let maciCertSystem = null;
+
+  switch (circuitType) {
+    case MaciCircuitType.IP1V:
+      maciVoteType = '0';
+      break;
+    case MaciCircuitType.QV:
+      maciVoteType = '1';
+      break;
+    default:
+      throw new Error(
+        `Invalid circuit type ${circuitType}, only support 1P1V and QV`
+      );
+  }
+
+  switch (proofSystem) {
+    case MaciCertSystemType.GROTH16:
+      maciCertSystem = '0';
+      break;
+    case MaciCertSystemType.PLONK:
+      maciCertSystem = '1';
+      break;
+    default:
+      throw new Error(
+        `Invalid proof system ${proofSystem}, only support GROTH16 and PLONK`
+      );
+  }
+
+  if (Number(maxVoter) <= 25 && Number(maxOption) <= 5) {
+    // state_tree_depth: 2
+    // vote_option_tree_depth: 1
+    parameters = CIRCUIT_INFO['2-1-1-5'].parameter;
+    if (proofSystem === MaciCertSystemType.GROTH16) {
+      groth16ProcessVkey = CIRCUIT_INFO['2-1-1-5']['groth16'].process_vkey;
+      groth16TallyVkey = CIRCUIT_INFO['2-1-1-5']['groth16'].tally_vkey;
+    } else if (proofSystem === MaciCertSystemType.PLONK) {
+      plonkProcessVkey = CIRCUIT_INFO['2-1-1-5']['plonk']?.process_vkey;
+      plonkTallyVkey = CIRCUIT_INFO['2-1-1-5']['plonk']?.tally_vkey;
+    }
+  } else if (Number(maxVoter) <= 625 && Number(maxOption) <= 25) {
+    // state_tree_depth: 4
+    // vote_option_tree_depth: 2
+    parameters = CIRCUIT_INFO['4-2-2-25'].parameter;
+    if (proofSystem === MaciCertSystemType.GROTH16) {
+      groth16ProcessVkey = CIRCUIT_INFO['4-2-2-25']['groth16'].process_vkey;
+      groth16TallyVkey = CIRCUIT_INFO['4-2-2-25']['groth16'].tally_vkey;
+    } else if (proofSystem === MaciCertSystemType.PLONK) {
+      plonkProcessVkey = CIRCUIT_INFO['4-2-2-25']['plonk']?.process_vkey;
+      plonkTallyVkey = CIRCUIT_INFO['4-2-2-25']['plonk']?.tally_vkey;
+    }
+  } else if (Number(maxVoter) <= 15625 && Number(maxOption) <= 125) {
+    // state_tree_depth: 6
+    // vote_option_tree_depth: 3
+    parameters = CIRCUIT_INFO['6-3-3-125'].parameter;
+    if (proofSystem === MaciCertSystemType.GROTH16) {
+      groth16ProcessVkey = CIRCUIT_INFO['6-3-3-125']['groth16'].process_vkey;
+      groth16TallyVkey = CIRCUIT_INFO['6-3-3-125']['groth16'].tally_vkey;
+    } else if (proofSystem === MaciCertSystemType.PLONK) {
+      plonkProcessVkey = CIRCUIT_INFO['6-3-3-125']['plonk']?.process_vkey;
+      plonkTallyVkey = CIRCUIT_INFO['6-3-3-125']['plonk']?.tally_vkey;
+    }
+  } else if (Number(maxVoter) <= 1953125 && Number(maxOption) <= 125) {
+    // state_tree_depth: 9
+    // vote_option_tree_depth: 3
+    parameters = CIRCUIT_INFO['9-4-3-625'].parameter;
+    if (proofSystem === MaciCertSystemType.GROTH16) {
+      groth16ProcessVkey = CIRCUIT_INFO['9-4-3-625']['groth16'].process_vkey;
+      groth16TallyVkey = CIRCUIT_INFO['9-4-3-625']['groth16'].tally_vkey;
+    } else if (proofSystem === MaciCertSystemType.PLONK) {
+      throw new Error('PLONK is not supported for MACI-9');
+    }
+  } else {
+    throw new Error('Number of voters or options is too large.');
+  }
+  switch (type) {
+    case MaciRoundType.MACI:
+      return {
+        parameters,
+        groth16ProcessVkey,
+        groth16TallyVkey,
+        plonkProcessVkey,
+        plonkTallyVkey,
+        maciVoteType,
+        maciCertSystem,
+      };
+    case MaciRoundType.AMACI:
+      return {
+        // parameters,
+        // groth16ProcessVkey,
+        // groth16TallyVkey,
+        // plonkProcessVkey,
+        // plonkTallyVkey,
+      };
+    case MaciRoundType.ORACLE_MACI:
+      return {
+        parameters: CIRCUIT_INFO['9-4-3-625'].parameter,
+        groth16ProcessVkey: CIRCUIT_INFO['9-4-3-625']['groth16'].process_vkey,
+        groth16TallyVkey: CIRCUIT_INFO['9-4-3-625']['groth16'].tally_vkey,
+        plonkProcessVkey: null,
+        plonkTallyVkey: null,
+        maciVoteType,
+        maciCertSystem: '0',
+      };
+  }
+}
+
+/**
+ * Converts a hexadecimal string to a decimal string.
+ * @param hexString - The hexadecimal string to convert.
+ * @returns The decimal string representation of the input.
+ */
+function hexToDecimalString(hexString: string) {
+  const decimalString = BigInt('0x' + hexString).toString(10);
+  return decimalString;
+}
+
+/**
+ * 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 parsePubkey(publickKey: string) {
+  const x = publickKey.slice(0, 64);
+  const y = publickKey.slice(64);
+
+  return {
+    x: hexToDecimalString(x),
+    y: hexToDecimalString(y),
+  };
+}