refactor: contract imports and proofs (#2074)

privacy-scaling-explorations · Jan 29, 2025 · 66dfab7 · 66dfab7
1 parent 44c9e1e
commit 66dfab7
Show file tree

Hide file tree

Showing 59 changed files with 486 additions and 336 deletions.
diff --git a/apps/relayer/package.json b/apps/relayer/package.json
@@ -45,9 +45,9 @@
     "helia": "^5.2.0",
     "helmet": "^8.0.0",
     "lodash": "^4.17.21",
-    "maci-circuits": "workspace:^2.5.0",
     "maci-cli": "workspace:^2.5.0",
     "maci-contracts": "workspace:^2.5.0",
+    "maci-sdk": "workspace:^0.0.1",
     "maci-domainobjs": "workspace:^2.5.0",
     "mongoose": "^8.9.5",
     "multiformats": "^13.3.1",

diff --git a/apps/relayer/tests/messages.test.ts b/apps/relayer/tests/messages.test.ts
@@ -2,10 +2,10 @@ import { jest } from "@jest/globals";
 import { HttpStatus, ValidationPipe, type INestApplication } from "@nestjs/common";
 import { Test } from "@nestjs/testing";
 import hardhat from "hardhat";
-import { genProof } from "maci-circuits";
 import { deploy, deployPoll, deployVkRegistryContract, joinPoll, setVerifyingKeys, signup } from "maci-cli";
 import { formatProofForVerifierContract, genMaciStateFromContract } from "maci-contracts";
 import { Keypair } from "maci-domainobjs";
+import { genProofSnarkjs } from "maci-sdk";
 import request from "supertest";
 
 import type { App } from "supertest/types";
@@ -22,9 +22,6 @@ import {
   processMessagesZkeyPathNonQv,
   tallyVotesZkeyPathNonQv,
   pollWasm,
-  pollWitgen,
-  rapidsnark,
-  pollJoinedWitgen,
   pollJoinedWasm,
 } from "./constants";
 
@@ -81,8 +78,6 @@ describe("Integration messages", () => {
       stateIndex: 1n,
       pollJoiningZkey,
       pollWasm,
-      pollWitgen,
-      rapidsnark,
       signer,
       useWasm: true,
       quiet: true,
@@ -156,12 +151,9 @@ describe("Integration messages", () => {
     });
 
     test("should throw an error if dto is invalid", async () => {
-      const { proof } = await genProof({
+      const { proof } = await genProofSnarkjs({
         inputs: circuitInputs,
         zkeyPath: pollJoinedZkey,
-        useWasm: true,
-        rapidsnarkExePath: rapidsnark,
-        witnessExePath: pollJoinedWitgen,
         wasmPath: pollJoinedWasm,
       });
 
@@ -189,12 +181,9 @@ describe("Integration messages", () => {
     });
 
     test("should throw an error if messages dto is invalid", async () => {
-      const { proof } = await genProof({
+      const { proof } = await genProofSnarkjs({
         inputs: circuitInputs,
         zkeyPath: pollJoinedZkey,
-        useWasm: true,
-        rapidsnarkExePath: rapidsnark,
-        witnessExePath: pollJoinedWitgen,
         wasmPath: pollJoinedWasm,
       });
 
@@ -217,12 +206,9 @@ describe("Integration messages", () => {
     });
 
     test("should publish user messages properly", async () => {
-      const { proof } = await genProof({
+      const { proof } = await genProofSnarkjs({
         inputs: circuitInputs,
         zkeyPath: pollJoinedZkey,
-        useWasm: true,
-        rapidsnarkExePath: rapidsnark,
-        witnessExePath: pollJoinedWitgen,
         wasmPath: pollJoinedWasm,
       });
 

diff --git a/apps/relayer/ts/messageBatch/__tests__/messageBatch.service.test.ts b/apps/relayer/ts/messageBatch/__tests__/messageBatch.service.test.ts
@@ -1,6 +1,6 @@
 import { jest } from "@jest/globals";
 import { ZeroAddress } from "ethers";
-import { MACI__factory as MACIFactory, Poll__factory as PollFactory } from "maci-contracts";
+import { MACI__factory as MACIFactory, Poll__factory as PollFactory } from "maci-sdk";
 
 import { IpfsService } from "../../ipfs/ipfs.service";
 import { MessageBatchDto } from "../messageBatch.dto";

diff --git a/apps/relayer/ts/messageBatch/messageBatch.service.ts b/apps/relayer/ts/messageBatch/messageBatch.service.ts
@@ -2,8 +2,8 @@ import { Injectable, Logger } from "@nestjs/common";
 import { validate } from "class-validator";
 import flatten from "lodash/flatten";
 import uniqBy from "lodash/uniqBy";
-import { MACI__factory as MACIFactory, Poll__factory as PollFactory } from "maci-contracts";
 import { PubKey } from "maci-domainobjs";
+import { MACI__factory as MACIFactory, Poll__factory as PollFactory } from "maci-sdk";
 
 import type { MessageBatchDto } from "./messageBatch.dto";
 

diff --git a/packages/circuits/package.json b/packages/circuits/package.json
@@ -45,7 +45,7 @@
     "maci-core": "^2.5.0",
     "maci-crypto": "^2.5.0",
     "maci-domainobjs": "^2.5.0",
-    "snarkjs": "^0.7.5"
+    "maci-sdk": "^0.0.1"
   },
   "devDependencies": {
     "@types/chai": "^4.3.11",

diff --git a/packages/circuits/ts/genZkeys.ts b/packages/circuits/ts/genZkeys.ts
@@ -1,12 +1,11 @@
 import { type CircomkitConfig, type CircuitConfig, Circomkit } from "circomkit";
+import { cleanThreads } from "maci-sdk";
 
 import fs from "fs";
 import path from "path";
 
 import type { CircuitConfigWithName } from "./types";
 
-import { cleanThreads } from "./utils";
-
 /**
  * Generate the zkeys for MACI's circuits using circomkit
  * @dev This should only be used for testing purposes, or to generate the genesis zkey

diff --git a/packages/circuits/ts/index.ts b/packages/circuits/ts/index.ts
diff --git a/packages/circuits/ts/types.ts b/packages/circuits/ts/types.ts
@@ -1,6 +1,4 @@
 import type { CircuitConfig } from "circomkit";
-import type { CircuitInputs } from "maci-core";
-import type { Groth16Proof, PublicSignals } from "snarkjs";
 
 export type BigNumberish = number | string | bigint;
 
@@ -19,27 +17,6 @@ export interface ISnarkJSVerificationKey {
   IC: BigNumberish[][];
 }
 
-/**
- * Return type for proof generation function
- */
-export interface FullProveResult {
-  proof: Groth16Proof;
-  publicSignals: PublicSignals;
-}
-
-/**
- * Parameters for the genProof function
- */
-export interface IGenProofOptions {
-  inputs: CircuitInputs;
-  zkeyPath: string;
-  useWasm?: boolean;
-  rapidsnarkExePath?: string;
-  witnessExePath?: string;
-  wasmPath?: string;
-  silent?: boolean;
-}
-
 /**
  * Inputs for circuit PollJoining
  */

diff --git a/packages/circuits/ts/utils.ts b/packages/circuits/ts/utils.ts
diff --git a/packages/cli/tests/ceremony-params/ceremonyParams.test.ts b/packages/cli/tests/ceremony-params/ceremonyParams.test.ts
@@ -1,6 +1,6 @@
-import { getDefaultSigner } from "maci-contracts";
 import { genRandomSalt } from "maci-crypto";
 import { Keypair } from "maci-domainobjs";
+import { getDefaultSigner } from "maci-sdk";
 
 import type { Signer } from "ethers";
 

diff --git a/packages/cli/tests/e2e/e2e.nonQv.test.ts b/packages/cli/tests/e2e/e2e.nonQv.test.ts
@@ -1,6 +1,6 @@
-import { getDefaultSigner } from "maci-contracts";
 import { genRandomSalt } from "maci-crypto";
 import { Keypair } from "maci-domainobjs";
+import { getDefaultSigner } from "maci-sdk";
 
 import type { Signer } from "ethers";
 

diff --git a/packages/cli/tests/e2e/e2e.test.ts b/packages/cli/tests/e2e/e2e.test.ts
@@ -1,7 +1,7 @@
 import { expect } from "chai";
-import { getDefaultSigner } from "maci-contracts";
 import { genRandomSalt } from "maci-crypto";
 import { Keypair } from "maci-domainobjs";
+import { getDefaultSigner } from "maci-sdk";
 
 import fs from "fs";
 

diff --git a/packages/cli/tests/e2e/keyChange.test.ts b/packages/cli/tests/e2e/keyChange.test.ts
@@ -1,7 +1,7 @@
 import { expect } from "chai";
-import { getDefaultSigner } from "maci-contracts";
 import { genRandomSalt } from "maci-crypto";
 import { Keypair } from "maci-domainobjs";
+import { getDefaultSigner } from "maci-sdk";
 
 import fs from "fs";
 

diff --git a/packages/cli/tests/unit/fundWallet.test.ts b/packages/cli/tests/unit/fundWallet.test.ts
@@ -1,6 +1,6 @@
 import { expect } from "chai";
 import { ZeroAddress } from "ethers";
-import { getDefaultSigner } from "maci-contracts";
+import { getDefaultSigner } from "maci-sdk";
 
 import { fundWallet } from "../../ts";
 

diff --git a/packages/cli/tests/unit/joinPoll.test.ts b/packages/cli/tests/unit/joinPoll.test.ts
@@ -1,7 +1,7 @@
 import { expect } from "chai";
 import { Signer } from "ethers";
-import { getDefaultSigner } from "maci-contracts";
 import { Keypair } from "maci-domainobjs";
+import { getDefaultSigner } from "maci-sdk";
 
 import {
   deploy,

diff --git a/packages/cli/tests/unit/poll.test.ts b/packages/cli/tests/unit/poll.test.ts
@@ -1,5 +1,5 @@
 import { expect } from "chai";
-import { getDefaultSigner } from "maci-contracts";
+import { getDefaultSigner } from "maci-sdk";
 
 import type { Signer } from "ethers";
 

diff --git a/packages/cli/tests/unit/publish.test.ts b/packages/cli/tests/unit/publish.test.ts
@@ -1,8 +1,8 @@
 import { expect } from "chai";
-import { getDefaultSigner } from "maci-contracts";
 import { Poll__factory as PollFactory } from "maci-contracts/typechain-types";
 import { SNARK_FIELD_SIZE } from "maci-crypto";
 import { Keypair } from "maci-domainobjs";
+import { getDefaultSigner } from "maci-sdk";
 
 import type { Signer } from "ethers";
 

diff --git a/packages/cli/tests/unit/signup.test.ts b/packages/cli/tests/unit/signup.test.ts
@@ -1,7 +1,7 @@
 import { expect } from "chai";
 import { Signer } from "ethers";
-import { getDefaultSigner } from "maci-contracts";
 import { Keypair } from "maci-domainobjs";
+import { getDefaultSigner } from "maci-sdk";
 
 import {
   deploy,

diff --git a/packages/cli/tests/unit/timeTravel.test.ts b/packages/cli/tests/unit/timeTravel.test.ts
@@ -1,5 +1,5 @@
 import { expect } from "chai";
-import { getDefaultSigner } from "maci-contracts";
+import { getDefaultSigner } from "maci-sdk";
 
 import { timeTravel } from "../../ts";
 

diff --git a/packages/cli/ts/commands/checkVerifyingKeys.ts b/packages/cli/ts/commands/checkVerifyingKeys.ts
@@ -1,5 +1,4 @@
-import { EMode } from "maci-contracts";
-import { extractAllVks, compareVks, getAllOnChainVks } from "maci-sdk";
+import { extractAllVks, compareVks, getAllOnChainVks, EMode } from "maci-sdk";
 
 import fs from "fs";
 

diff --git a/packages/cli/ts/commands/deploy.ts b/packages/cli/ts/commands/deploy.ts
@@ -3,7 +3,7 @@ import {
   deployFreeForAllSignUpGatekeeper,
   deployVerifier,
   deployMaci,
-} from "maci-contracts";
+} from "maci-sdk";
 
 import {
   banner,

diff --git a/packages/cli/ts/commands/deployPoll.ts b/packages/cli/ts/commands/deployPoll.ts
@@ -1,10 +1,10 @@
+import { PubKey } from "maci-domainobjs";
 import {
   MACI__factory as MACIFactory,
   EMode,
   deployFreeForAllSignUpGatekeeper,
   deployConstantInitialVoiceCreditProxy,
-} from "maci-contracts";
-import { PubKey } from "maci-domainobjs";
+} from "maci-sdk";
 
 import {
   banner,

diff --git a/packages/cli/ts/commands/deployVkRegistry.ts b/packages/cli/ts/commands/deployVkRegistry.ts
@@ -1,4 +1,4 @@
-import { deployVkRegistry } from "maci-contracts";
+import { deployVkRegistry } from "maci-sdk";
 
 import fs from "fs";
 

diff --git a/packages/cli/ts/commands/extractVkToFile.ts b/packages/cli/ts/commands/extractVkToFile.ts
@@ -1,4 +1,4 @@
-import { extractVk } from "maci-circuits";
+import { extractVk } from "maci-sdk";
 
 import fs from "fs";
 

diff --git a/packages/cli/ts/commands/genLocalState.ts b/packages/cli/ts/commands/genLocalState.ts
@@ -1,6 +1,6 @@
 import { JsonRpcProvider } from "ethers";
-import { MACI__factory as MACIFactory, Poll__factory as PollFactory, genMaciStateFromContract } from "maci-contracts";
 import { Keypair, PrivKey } from "maci-domainobjs";
+import { MACI__factory as MACIFactory, Poll__factory as PollFactory, genMaciStateFromContract } from "maci-sdk";
 
 import fs from "fs";