@dorafactory/maci-sdk 0.0.1

package/package.json

@@ -0,0 +1,154 @@
+{
+  "name": "@dorafactory/maci-sdk",
+  "version": "0.0.1",
+  "description": "SDK for interacting with maci",
+  "keywords": [
+    "maci",
+    "blockchain"
+  ],
+  "author": "team@dorafactory.org",
+  "homepage": "https://github.com/dorafactory/maci-sdk",
+  "bugs": "https://github.com/dorafactory/maci-sdk/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dorafactory/maci-sdk.git"
+  },
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./types": "./src/types/index.ts",
+    "./client": "./src/indexer.ts",
+    "./const": "./src/libs/const.ts"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@cosmjs/amino": "^0.32.1",
+    "@cosmjs/cosmwasm-stargate": "^0.32.1",
+    "@cosmjs/crypto": "^0.32.1",
+    "@cosmjs/launchpad": "^0.27.1",
+    "@cosmjs/proto-signing": "^0.32.1",
+    "@cosmjs/stargate": "^0.32.1",
+    "@injectivelabs/sdk-ts": "^1.14.33",
+    "assert": "^2.1.0",
+    "bech32": "1.1.4",
+    "superstruct": "^1.0.3",
+    "ts-retry-promise": "^0.7.1",
+    "tweetnacl": "^1.0.3",
+    "colorts": "^0.1.63",
+    "husky": "^8.0.3",
+    "keccak256": "^1.0.6",
+    "process": "^0.11.10",
+    "gql.tada": "^1.7.0",
+    "graphql": "^16.8.1",
+    "tmp": "^0.2.1",
+    "valibot": "0.36.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^18.0.0",
+    "@commitlint/config-conventional": "^18.0.0",
+    "@commitlint/prompt-cli": "^18.0.0",
+    "@types/node": "^20.8.7",
+    "@types/tmp": "^0.2.5",
+    "@typescript-eslint/eslint-plugin": "^6.8.0",
+    "@typescript-eslint/parser": "^6.8.0",
+    "dotenv": "^16.3.1",
+    "eslint": "^8.52.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "lint-staged": "^15.0.2",
+    "prettier": "^2.8.8",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.2.0",
+    "tsup": "^7.1.0",
+    "typedoc": "^0.25.2",
+    "typescript": "^5.2.2"
+  },
+  "lint-staged": {
+    "**/*.ts": [
+      "pnpm run format:fix",
+      "pnpm run lint:fix"
+    ],
+    "**/*.json|md": [
+      "pnpm run format:fix"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "prettier": {
+    "trailingComma": "es5",
+    "tabWidth": 2,
+    "semi": true,
+    "singleQuote": true,
+    "useTabs": false,
+    "quoteProps": "as-needed",
+    "bracketSpacing": true,
+    "arrowParens": "always",
+    "endOfLine": "lf"
+  },
+  "eslintConfig": {
+    "root": true,
+    "env": {
+      "browser": true,
+      "node": true,
+      "es2022": true
+    },
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:prettier/recommended"
+    ],
+    "plugins": [
+      "@typescript-eslint",
+      "prettier"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "rules": {
+      "prettier/prettier": "warn",
+      "@typescript-eslint/no-explicit-any": "off",
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          "argsIgnorePattern": "^_",
+          "varsIgnorePattern": "^_",
+          "caughtErrorsIgnorePattern": "^_"
+        }
+      ]
+    }
+  },
+  "scripts": {
+    "clean": "rm -rf tsconfig.tsbuildinfo ./dist",
+    "build": "npm run build:types && npm run build:tsup",
+    "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",
+    "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"
+  }
+}

package/src/index.ts

@@ -0,0 +1,11 @@
+export * from './libs';
+export type * from './types';
+export * from './libs/const';
+export { MaciClient } from './maci';
+export { Http } from './libs/http';
+export { Round } from './libs/query';
+export { Account } from './libs/query';
+export { Circuit } from './libs/query';
+export { Operator } from './libs/query';
+export { Proof } from './libs/query';
+export { Transaction } from './libs/query';

package/src/libs/const.ts

@@ -0,0 +1,196 @@
+import type { CircuitType } from '../types';
+
+export const circuits: Record<string, CircuitType> = {
+  'maci-1p1v': {
+    maciType: 'MACI',
+    circuitType: '1p1v',
+    displayName: 'MACI-1p1v',
+    repoUrl:
+      'https://github.com/DoraFactory/Vota-Circuits/tree/main/circuits/maci',
+    zipUrl:
+      'https://github.com/DoraFactory/Vota-Circuits/archive/refs/heads/main.zip',
+  },
+  'maci-qv': {
+    maciType: 'MACI',
+    circuitType: 'QV',
+    displayName: 'MACI-QV',
+    repoUrl:
+      'https://github.com/DoraFactory/Vota-Circuits/tree/main/circuits/maci',
+    zipUrl:
+      'https://github.com/DoraFactory/Vota-Circuits/archive/refs/heads/main.zip',
+  },
+  'amaci-1p1v': {
+    maciType: 'aMACI',
+    circuitType: '1p1v',
+    displayName: 'aMACI-1p1v',
+    repoUrl:
+      'https://github.com/DoraFactory/Vota-Circuits/tree/main/circuits/amaci',
+    zipUrl:
+      'https://github.com/DoraFactory/Vota-Circuits/archive/refs/heads/main.zip',
+  },
+  'amaci-qv': {
+    maciType: 'aMACI',
+    circuitType: 'QV',
+    displayName: 'aMACI-QV',
+    repoUrl:
+      'https://github.com/DoraFactory/Vota-Circuits/tree/main/circuits/amaci',
+    zipUrl:
+      'https://github.com/DoraFactory/Vota-Circuits/archive/refs/heads/main.zip',
+  },
+};
+
+export const validator_operator_set = {
+  doravaloper12yk434ut3un4wx0rult2aww89rsrel8nhmp387: {
+    operator_address: '',
+    account_address: 'dora12yk434ut3un4wx0rult2aww89rsrel8nydy83p',
+    allocation: '22571615985356796592128',
+    allocation_dora: 22571.615985356795,
+    moniker: '𝐥𝐞𝐬𝐧𝐢𝐤 | 𝐔𝐓𝐒𝐀',
+    program_voting_power: 0.06432895760166438,
+    tokens: '200731587709257889972292',
+  },
+  doravaloper15frh0nn3v4yp3vv6sk4pn6jg9l8rt82f7uqfk5: {
+    operator_address: '',
+    account_address: 'dora15frh0nn3v4yp3vv6sk4pn6jg9l8rt82fd29lqt',
+    allocation: '33745159209325474873344',
+    allocation_dora: 33745.15920932547,
+    moniker: 'NomadValidator',
+    program_voting_power: 0.09617348254756773,
+    tokens: '300099000000000000000000',
+  },
+  doravaloper1ddewp74vd2w8jhth2p0uazmc8ajgtcuf3ntqgn: {
+    operator_address: '',
+    account_address: 'dora1ddewp74vd2w8jhth2p0uazmc8ajgtcufz9wk7v',
+    allocation: '40789397021635754590208',
+    allocation_dora: 40789.397021635756,
+    moniker: 'polkachu.com',
+    program_voting_power: 0.11624951413777938,
+    tokens: '362744095556470434789338',
+  },
+  doravaloper1gh8j89jtc2vx6d3y4ehllcdlvluwa49w6xmjsm: {
+    operator_address: '',
+    account_address: 'dora1gh8j89jtc2vx6d3y4ehllcdlvluwa49wfs7yxy',
+    allocation: '33743029941764137943040',
+    allocation_dora: 33743.029941764136,
+    moniker: 'ITRocket',
+    program_voting_power: 0.09616741414897524,
+    tokens: '300080064215405665352721',
+  },
+  doravaloper1j8ru7p8zctup6grfwuga6ndrjj7v88wzn407x7: {
+    operator_address: '',
+    account_address: 'dora1j8ru7p8zctup6grfwuga6ndrjj7v88wzqr2gsp',
+    allocation: '22646525272055477174272',
+    allocation_dora: 22646.525272055478,
+    moniker: 'StakeUs',
+    program_voting_power: 0.06454244857772638,
+    tokens: '201397763319500000000000',
+  },
+  doravaloper1l5zz0kkjt2n7nllsrymy96mc2v2gehda0zc85s: {
+    operator_address: '',
+    account_address: 'dora1l5zz0kkjt2n7nllsrymy96mc2v2gehdau5a3z0',
+    allocation: '22622846742220005965824',
+    allocation_dora: 22622.846742220005,
+    moniker: 'BlackNodes',
+    program_voting_power: 0.06447496492290769,
+    tokens: '201187187838702364379121',
+  },
+  doravaloper1m9v3txhhtadjxpv09gwjhhs344qsxgfscwxjkg: {
+    operator_address: '',
+    account_address: 'dora1m9v3txhhtadjxpv09gwjhhs344qsxgfstcryqh',
+    allocation: '22549006983854435598336',
+    allocation_dora: 22549.006983854437,
+    moniker: '👋 79anvi 🍀',
+    program_voting_power: 0.06426452209558432,
+    tokens: '200530523648490887200824',
+  },
+  doravaloper1tu8006g60t62zwgwf5knkaujv0uzhp2a6wh94h: {
+    operator_address: '',
+    account_address: 'dora1tu8006g60t62zwgwf5knkaujv0uzhp2afcjnrg',
+    allocation: '39369183740744815345664',
+    allocation_dora: 39369.18374074482,
+    moniker: 'Citadel.one',
+    program_voting_power: 0.11220191559671686,
+    tokens: '350114000000000000000000',
+  },
+  doravaloper1x5z0tkafrgyeuqkrwfjr933vghjxchqnqlhcdw: {
+    operator_address: '',
+    account_address: 'dora1x5z0tkafrgyeuqkrwfjr933vghjxchqnnfjwm3',
+    allocation: '22611521290904268701696',
+    allocation_dora: 22611.521290904268,
+    moniker: '1ce',
+    program_voting_power: 0.064442687460896,
+    tokens: '201086469492900000000000',
+  },
+  doravaloper1z6kfew2nhuh02szc2hdecw4fqey2d32auucvux: {
+    operator_address: '',
+    account_address: 'dora1z6kfew2nhuh02szc2hdecw4fqey2d32a02a62e',
+    allocation: '45246951843662957379584',
+    allocation_dora: 45246.95184366296,
+    moniker: 'Nodes.Guru',
+    program_voting_power: 0.12895351616135226,
+    tokens: '402385566389000000000006',
+  },
+  doravaloper1zzne8ufazycklx4j6mgc987t8ykd6wxu63223v: {
+    operator_address: '',
+    account_address: 'dora1zzne8ufazycklx4j6mgc987t8ykd6wxu63223v',
+    allocation: '44982761968475888943104',
+    allocation_dora: 44982.76196847589,
+    moniker: 'ZKV',
+    program_voting_power: 0.12820057674882976,
+    tokens: '400036100000000000000000',
+  },
+};
+
+export interface NetworkConfig {
+  network: string;
+  chainId: string;
+  rpcEndpoint: string;
+  restEndpoint: string;
+  apiEndpoint: string;
+  certificateApiEndpoint: string;
+  registryAddress: string;
+  maciCodeId: number;
+  oracleCodeId: number;
+  oracleWhitelistBackendPubkey: string;
+  oracleFeegrantOperator: string;
+}
+
+export function getDefaultParams(
+  network: 'mainnet' | 'testnet' = 'mainnet'
+): NetworkConfig {
+  switch (network) {
+    case 'mainnet':
+      return {
+        network: 'mainnet',
+        chainId: 'vota-ash',
+        rpcEndpoint: 'https://vota-rpc.dorafactory.org',
+        restEndpoint: 'https://vota-rest.dorafactory.org',
+        apiEndpoint: 'https://vota-api.dorafactory.org',
+        certificateApiEndpoint: 'https://vota-certificate-api.dorafactory.org',
+        registryAddress:
+          'dora1smg5qp5trjdkcekdjssqpjehdjf6n4cjss0clyvqcud3t3u3948s8rmgg4',
+        maciCodeId: 106,
+        oracleCodeId: 111,
+        oracleWhitelistBackendPubkey:
+          'A61YtCv2ibMZmDeM02nEElil8wlHx1tLKogBk5dPgf/Q',
+        oracleFeegrantOperator: 'dora16s9tljk8dy9ae335yvyzlm8gvkypx9228q8pq8',
+      };
+    case 'testnet':
+      return {
+        network: 'testnet',
+        chainId: 'vota-testnet',
+        rpcEndpoint: 'https://vota-testnet-rpc.dorafactory.org',
+        restEndpoint: 'https://vota-testnet-rest.dorafactory.org',
+        apiEndpoint: 'https://vota-testnet-api.dorafactory.org',
+        certificateApiEndpoint:
+          'https://vota-testnet-certificate-api.dorafactory.org',
+        registryAddress:
+          'dora13c8aecstyxrhax9znvvh5zey89edrmd2k5va57pxvpe3fxtfsfeqlhsjnd',
+        maciCodeId: 107,
+        oracleCodeId: 110,
+        oracleWhitelistBackendPubkey:
+          'AoYo/zENN/JquagPdG0/NMbWBBYxOM8BVN677mBXJKJQ',
+        oracleFeegrantOperator: 'dora1xp0twdzsdeq4qg3c64v66552deax8zmvq4zw78',
+      };
+  }
+}

package/src/libs/contract/config.ts

@@ -0,0 +1,117 @@
+import { Secp256k1HdWallet } from '@cosmjs/launchpad';
+import { OfflineSigner } from '@cosmjs/proto-signing';
+import {
+  GasPrice,
+  SigningStargateClient,
+  SigningStargateClientOptions,
+} from '@cosmjs/stargate';
+import {
+  SigningCosmWasmClient,
+  SigningCosmWasmClientOptions,
+} from '@cosmjs/cosmwasm-stargate';
+import { MaciClient } from './ts/Maci.client';
+import { AMaciClient } from './ts/AMaci.client';
+import { RegistryClient } from './ts/Registry.client';
+import { OracleMaciClient } from './ts/OracleMaci.client';
+
+const defaultSigningClientOptions: SigningStargateClientOptions = {
+  broadcastPollIntervalMs: 8_000,
+  broadcastTimeoutMs: 64_000,
+  gasPrice: GasPrice.fromString('100000000000peaka'),
+};
+
+export async function createMaciClientBy({
+  rpcEndpoint,
+  wallet,
+  contractAddress,
+}: {
+  rpcEndpoint: string;
+  wallet: OfflineSigner;
+  contractAddress: string;
+}) {
+  const signingCosmWasmClient = await createContractClientByWallet(
+    rpcEndpoint,
+    wallet
+  );
+  const [{ address }] = await wallet.getAccounts();
+  return new MaciClient(signingCosmWasmClient, address, contractAddress);
+}
+
+export async function createAMaciClientBy({
+  rpcEndpoint,
+  wallet,
+  contractAddress,
+}: {
+  rpcEndpoint: string;
+  wallet: OfflineSigner;
+  contractAddress: string;
+}) {
+  const signingCosmWasmClient = await createContractClientByWallet(
+    rpcEndpoint,
+    wallet
+  );
+  const [{ address }] = await wallet.getAccounts();
+  return new AMaciClient(signingCosmWasmClient, address, contractAddress);
+}
+
+export async function createRegistryClientBy({
+  rpcEndpoint,
+  wallet,
+  contractAddress,
+}: {
+  rpcEndpoint: string;
+  wallet: OfflineSigner;
+  contractAddress: string;
+}) {
+  const signingCosmWasmClient = await createContractClientByWallet(
+    rpcEndpoint,
+    wallet
+  );
+  const [{ address }] = await wallet.getAccounts();
+  return new RegistryClient(signingCosmWasmClient, address, contractAddress);
+}
+
+export async function createOracleMaciClientBy({
+  rpcEndpoint,
+  wallet,
+  contractAddress,
+}: {
+  rpcEndpoint: string;
+  wallet: OfflineSigner;
+  contractAddress: string;
+}) {
+  const signingCosmWasmClient = await createContractClientByWallet(
+    rpcEndpoint,
+    wallet
+  );
+  const [{ address }] = await wallet.getAccounts();
+  return new OracleMaciClient(signingCosmWasmClient, address, contractAddress);
+}
+
+export async function createContractClientByWallet(
+  rpcEndpoint: string,
+  wallet: OfflineSigner
+) {
+  const client = await SigningCosmWasmClient.connectWithSigner(
+    rpcEndpoint,
+    wallet,
+    {
+      ...defaultSigningClientOptions,
+    }
+  );
+  return client;
+}
+
+export async function getSignerClientByWallet(
+  rpcEndpoint: string,
+  wallet: OfflineSigner
+) {
+  const signingStargateClient = await SigningStargateClient.connectWithSigner(
+    rpcEndpoint,
+    wallet,
+    {
+      ...defaultSigningClientOptions,
+    }
+  );
+  return signingStargateClient;
+}