@fatsolutions/privacy-pools-core-circuits 1.0.0

package/README.md

@@ -0,0 +1,86 @@
+# Privacy Pool Circuits
+
+This package contains the zero-knowledge circuit implementations for the Privacy Pool protocol. The circuits are written in Circom and are designed to work together to enable private withdrawals with membership proofs.
+
+## Circuit Architecture
+
+The protocol implements three main circuits that work together:
+
+### Withdrawal Circuit
+
+The withdrawal circuit verifies that a user can privately withdraw funds from the protocol. It takes as input:
+
+- The withdrawal amount and details
+- The unique related commitments identifier (label)
+- A state root and ASP (Association Set Provider) root
+- A proof of inclusion in the state tree
+- A proof of inclusion in the ASP tree
+- Nullifier and commitment secrets
+
+The circuit ensures the withdrawal is valid by verifying:
+
+- The user knows the preimage of the commitment
+- The commitment exists in the state tree
+- The comimtment label is included in the ASP tree
+- The withdrawal amount is valid and matches the commitment
+
+### LeanIMT Circuit
+
+The LeanIMT (Lean Incremental Merkle Tree) circuit handles merkle tree operations. It implements an optimized merkle tree that:
+
+- Supports dynamic depth
+- Optimizes node computations by propagating single child values
+- Verifies inclusion proofs efficiently
+
+### Commitment Circuit
+
+The commitment circuit manages the hashing and verification of commitments. It:
+
+- Computes commitment hashes from input values and secrets
+- Generates nullifier hashes for preventing double-spending
+- Creates precommitment hashes for privacy preservation
+
+## Development
+
+### Prerequisites
+
+- Node.js 20+
+- Yarn
+- circom 2.2.0+
+
+### Building
+
+```bash
+# Compile circuits
+yarn compile
+```
+
+### Testing
+
+```bash
+# Run circuit tests
+yarn test
+```
+
+### Generating Groth16 Solidity verifiers
+
+```bash
+# Generate verifier for the withdrawal circuit
+yarn gencontract:withdraw
+```
+
+```bash
+# Generate verifier for the commitment circuit
+yarn gencontract:commitment
+```
+
+## Directory Structure
+
+```
+circuits/
+├── circuits/
+│   ├── commitment.circom     # Commitment circuit
+│   ├── merkleTree.circom     # LeanIMT circuit
+│   └── withdraw.circom       # Withdrawal circuit
+└── tests/                    # Circuit tests
+```

package/artifacts/commitment.vkey

@@ -0,0 +1,109 @@
+{
+ "protocol": "groth16",
+ "curve": "bn128",
+ "nPublic": 4,
+ "vk_alpha_1": [
+  "16428432848801857252194528405604668803277877773566238944394625302971855135431",
+  "16846502678714586896801519656441059708016666274385668027902869494772365009666",
+  "1"
+ ],
+ "vk_beta_2": [
+  [
+   "16348171800823588416173124589066524623406261996681292662100840445103873053252",
+   "3182164110458002340215786955198810119980427837186618912744689678939861918171"
+  ],
+  [
+   "19687132236965066906216944365591810874384658708175106803089633851114028275753",
+   "4920802715848186258981584729175884379674325733638798907835771393452862684714"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_gamma_2": [
+  [
+   "10857046999023057135944570762232829481370756359578518086990519993285655852781",
+   "11559732032986387107991004021392285783925812861821192530917403151452391805634"
+  ],
+  [
+   "8495653923123431417604973247489272438418190587263600148770280649306958101930",
+   "4082367875863433681332203403145435568316851327593401208105741076214120093531"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_delta_2": [
+  [
+   "21776852187814503669288941195438703300133533055551110414135507755772009048755",
+   "14071349277984160738769650232570048842420599174481891079570637520850148195985"
+  ],
+  [
+   "14829896038465638754619183039629777804281009075842360651276603555963792313589",
+   "17768817325504614104442767796226297300876042529701251019410487903768062418156"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_alphabeta_12": [
+  [
+   [
+    "5275725312362878540782176211860327475781113689246818544623830805017503247034",
+    "700769043921060225711174322502145319612473365595920873303028146383045646735"
+   ],
+   [
+    "16577533945604560505206253312979863148043263406037367789711279754781525822966",
+    "9408338099405950952721388539539775335199747835458172188116297223654842340186"
+   ],
+   [
+    "12663399896275491035004982800573482669934131767886952660443268164480899034271",
+    "4432711152773877173921024337047412943791122852326272337530740732443732395954"
+   ]
+  ],
+  [
+   [
+    "13121778684901402722679281862736806628725205381360313795132945954337708567513",
+    "9534744673358550231812045647241180985734073058548683258847806241019905135720"
+   ],
+   [
+    "21329152369227346659770815132468371951064045353268189088026893413117512652875",
+    "17209195434408943681049655974234541356066884378594227002358272904159790622854"
+   ],
+   [
+    "5346467096835895366917814311591075634165750361894629082277248282132405045579",
+    "15508364027636868967189209273443690126627947943852338696115233789046842639684"
+   ]
+  ]
+ ],
+ "IC": [
+  [
+   "19389685603863983493459600466245000912176323935722089191442216924893875659471",
+   "21368310947604120084615976168620713319957912144314383367152441982584687704754",
+   "1"
+  ],
+  [
+   "20480370908727861268768811690351970824724320271007139967515539994552383745448",
+   "6543788534290546924704177190532160218635019071447323280686282609769447108534",
+   "1"
+  ],
+  [
+   "6221997045242061390626775825094098886891157777390462309437733708122892686303",
+   "2977171917149158683110905238240269877054732203916711132834349252293157981665",
+   "1"
+  ],
+  [
+   "17383678627611548606682427983617497767432126302933563182026534678391392668921",
+   "3215629258564266791517073142612182991488671524212271597007691057737644736842",
+   "1"
+  ],
+  [
+   "8279881556386467131443125483794142587933910369215858657040335636659378561647",
+   "13829047140424789745087385395711127297752590615995160902909738061982036826097",
+   "1"
+  ]
+ ]
+}

package/artifacts/withdraw.vkey

@@ -0,0 +1,129 @@
+{
+ "protocol": "groth16",
+ "curve": "bn128",
+ "nPublic": 8,
+ "vk_alpha_1": [
+  "16428432848801857252194528405604668803277877773566238944394625302971855135431",
+  "16846502678714586896801519656441059708016666274385668027902869494772365009666",
+  "1"
+ ],
+ "vk_beta_2": [
+  [
+   "16348171800823588416173124589066524623406261996681292662100840445103873053252",
+   "3182164110458002340215786955198810119980427837186618912744689678939861918171"
+  ],
+  [
+   "19687132236965066906216944365591810874384658708175106803089633851114028275753",
+   "4920802715848186258981584729175884379674325733638798907835771393452862684714"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_gamma_2": [
+  [
+   "10857046999023057135944570762232829481370756359578518086990519993285655852781",
+   "11559732032986387107991004021392285783925812861821192530917403151452391805634"
+  ],
+  [
+   "8495653923123431417604973247489272438418190587263600148770280649306958101930",
+   "4082367875863433681332203403145435568316851327593401208105741076214120093531"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_delta_2": [
+  [
+   "11377546232269146885719711323617440487334358631817944307305954377320021081609",
+   "355730187017390060257088699243557931444743893437609284639879195946356391671"
+  ],
+  [
+   "14925671126934765953425446845541707408298799882358491896288696759849089416456",
+   "14828571047823507951936654719331566168682863576761372686128260593891040163007"
+  ],
+  [
+   "1",
+   "0"
+  ]
+ ],
+ "vk_alphabeta_12": [
+  [
+   [
+    "5275725312362878540782176211860327475781113689246818544623830805017503247034",
+    "700769043921060225711174322502145319612473365595920873303028146383045646735"
+   ],
+   [
+    "16577533945604560505206253312979863148043263406037367789711279754781525822966",
+    "9408338099405950952721388539539775335199747835458172188116297223654842340186"
+   ],
+   [
+    "12663399896275491035004982800573482669934131767886952660443268164480899034271",
+    "4432711152773877173921024337047412943791122852326272337530740732443732395954"
+   ]
+  ],
+  [
+   [
+    "13121778684901402722679281862736806628725205381360313795132945954337708567513",
+    "9534744673358550231812045647241180985734073058548683258847806241019905135720"
+   ],
+   [
+    "21329152369227346659770815132468371951064045353268189088026893413117512652875",
+    "17209195434408943681049655974234541356066884378594227002358272904159790622854"
+   ],
+   [
+    "5346467096835895366917814311591075634165750361894629082277248282132405045579",
+    "15508364027636868967189209273443690126627947943852338696115233789046842639684"
+   ]
+  ]
+ ],
+ "IC": [
+  [
+   "20917852783971662989037834579922189207796850157455689196836407829693273058181",
+   "14309172700509163829827835936087829189193823544006124999667589607573555153317",
+   "1"
+  ],
+  [
+   "4002318554163308338961115195600756325669504095744400749661836505711747131480",
+   "19388553801400869339697580180794985615392396320851212290435880306887322433262",
+   "1"
+  ],
+  [
+   "4254123736274716305094004322466639736349000292613093104635160011340821139688",
+   "19581123507269704428735684612376263280905609143077051758684797548075203355862",
+   "1"
+  ],
+  [
+   "12829149822163537636941647022474968478908625676617259064999683111486877280191",
+   "11906986527782177454913261933143777359684553833291705890148735374364062300950",
+   "1"
+  ],
+  [
+   "14959519196996577022953934863461427249996916985368164934760550902108247251314",
+   "17153998018818455451015682095753537372058398415644924731407055981674255991568",
+   "1"
+  ],
+  [
+   "386592992276936501107132673378759567169940445750810516666781824566579325489",
+   "6545363418535856048783449340812901581000301323807547677423370106415935030419",
+   "1"
+  ],
+  [
+   "14405334651179970829248032802453416652902403107461697011217734903378819167500",
+   "5941867495000526980426755384727509338287954936978959436019043816230884260430",
+   "1"
+  ],
+  [
+   "6593325309923573421969784559603844408437482353554868263039840702125354704945",
+   "19710681365262161445645108505967116609968223704683705865914938644210040221046",
+   "1"
+  ],
+  [
+   "13832774438085654502815602896317109691851791928314457690314578958243235503172",
+   "2034154171145211628085643224823864015412822036123513499722451852634747199812",
+   "1"
+  ]
+ ]
+}

package/dist/circuits.d.ts

@@ -0,0 +1,25 @@
+import { Binaries, CircuitArtifacts, CircuitNameString, CircuitsInterface, VersionString } from "./types.js";
+interface CircuitOptions {
+    baseUrl?: string;
+    browser?: boolean;
+}
+export declare class Circuits implements CircuitsInterface {
+    protected initialized: boolean;
+    protected version: VersionString;
+    protected binaries: Binaries;
+    protected baseUrl: string;
+    protected readonly browser: boolean;
+    constructor(options?: CircuitOptions);
+    _browser(): boolean;
+    protected _initialize(binaries: Binaries, version: VersionString): void;
+    protected _handleInitialization(version?: VersionString): Promise<void>;
+    _fetchVersionedArtifact(artifactPath: string): Promise<Uint8Array>;
+    _downloadCircuitArtifacts(circuitName: CircuitNameString): Promise<CircuitArtifacts>;
+    downloadArtifacts(_version: VersionString): Promise<Binaries>;
+    initArtifacts(version: VersionString): Promise<void>;
+    getVerificationKey(circuitName: CircuitNameString, version?: VersionString): Promise<Uint8Array>;
+    getProvingKey(circuitName: CircuitNameString, version?: VersionString): Promise<Uint8Array>;
+    getWasm(circuitName: CircuitNameString, version?: VersionString): Promise<Uint8Array>;
+}
+export {};
+//# sourceMappingURL=circuits.d.ts.map

package/dist/circuits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuits.d.ts","sourceRoot":"","sources":["../lib/circuits.ts"],"names":[],"mappings":"AACA,OAAO,EACL,QAAQ,EACR,gBAAgB,EAEhB,iBAAiB,EACjB,iBAAiB,EAGjB,aAAa,EACd,MAAM,YAAY,CAAC;AAGpB,UAAU,cAAc;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,qBAAa,QAAS,YAAW,iBAAiB;IAChD,SAAS,CAAC,WAAW,EAAE,OAAO,CAAS;IACvC,SAAS,CAAC,OAAO,EAAE,aAAa,CAAkB;IAClD,SAAS,CAAC,QAAQ,EAAG,QAAQ,CAAC;IAC9B,SAAS,CAAC,OAAO,EAAE,MAAM,CAAwC;IACjE,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAQ;gBAE/B,OAAO,CAAC,EAAE,cAAc;IASpC,QAAQ,IAAI,OAAO;IAInB,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa;cAMhD,qBAAqB,CACnC,OAAO,GAAE,aAA8B;IAgBnC,uBAAuB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAQlE,yBAAyB,CAC7B,WAAW,EAAE,iBAAiB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAUtB,iBAAiB,CACrB,QAAQ,EAAE,aAAa,GACtB,OAAO,CAAC,QAAQ,CAAC;IAQd,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAKpD,kBAAkB,CACtB,WAAW,EAAE,iBAAiB,EAC9B,OAAO,GAAE,aAA8B,GACtC,OAAO,CAAC,UAAU,CAAC;IAWhB,aAAa,CACjB,WAAW,EAAE,iBAAiB,EAC9B,OAAO,GAAE,aAA8B,GACtC,OAAO,CAAC,UAAU,CAAC;IAWhB,OAAO,CACX,WAAW,EAAE,iBAAiB,EAC9B,OAAO,GAAE,aAA8B,GACtC,OAAO,CAAC,UAAU,CAAC;CAUvB"}

package/dist/circuits.js

@@ -0,0 +1,92 @@
+import { CircuitInitialization, FetchArtifact } from "./errors.js";
+import { CircuitName, circuitToAsset, Version, } from "./types.js";
+import { importFetchVersionedArtifact } from "./fetchArtifacts.js";
+export class Circuits {
+    initialized = false;
+    version = Version.Latest;
+    binaries;
+    baseUrl = new URL("../", import.meta.url).href;
+    browser = true;
+    constructor(options) {
+        if (options?.baseUrl) {
+            this.baseUrl = options.baseUrl;
+        }
+        if (options?.browser !== undefined) {
+            this.browser = options.browser;
+        }
+    }
+    _browser() {
+        return typeof window !== "undefined";
+    }
+    _initialize(binaries, version) {
+        this.binaries = binaries;
+        this.version = version;
+        this.initialized = true;
+    }
+    async _handleInitialization(version = Version.Latest) {
+        if (!this.initialized || this.binaries === undefined) {
+            try {
+                await this.initArtifacts(version);
+            }
+            catch (e) {
+                if (e instanceof FetchArtifact) {
+                    throw new CircuitInitialization(`${e.name}: ${e.message}`);
+                }
+                else {
+                    console.error(e);
+                    throw new CircuitInitialization(`UnknownError: ${e}`);
+                }
+            }
+        }
+    }
+    async _fetchVersionedArtifact(artifactPath) {
+        const artifactUrl = new URL(artifactPath, this.baseUrl);
+        const { fetchVersionedArtifact } = await importFetchVersionedArtifact(this.browser);
+        return fetchVersionedArtifact(artifactUrl);
+    }
+    async _downloadCircuitArtifacts(circuitName) {
+        const assetName = circuitToAsset[circuitName];
+        const [wasm, vkey, zkey] = await Promise.all([
+            this._fetchVersionedArtifact(["artifacts", assetName.wasm].join("/")),
+            this._fetchVersionedArtifact(["artifacts", assetName.vkey].join("/")),
+            this._fetchVersionedArtifact(["artifacts", assetName.zkey].join("/")),
+        ]);
+        return { wasm, vkey, zkey };
+    }
+    async downloadArtifacts(_version) {
+        const [commitment, withdraw] = await Promise.all([
+            this._downloadCircuitArtifacts(CircuitName.Commitment),
+            this._downloadCircuitArtifacts(CircuitName.Withdraw),
+        ]);
+        return { commitment, withdraw };
+    }
+    async initArtifacts(version) {
+        const binaries = await this.downloadArtifacts(version);
+        this._initialize(binaries, version);
+    }
+    async getVerificationKey(circuitName, version = Version.Latest) {
+        await this._handleInitialization(version);
+        const artifacts = this.binaries[circuitName];
+        if (!artifacts) {
+            throw new CircuitInitialization(`Circuit artifacts not found for ${circuitName}`);
+        }
+        return artifacts.vkey;
+    }
+    async getProvingKey(circuitName, version = Version.Latest) {
+        await this._handleInitialization(version);
+        const artifacts = this.binaries[circuitName];
+        if (!artifacts) {
+            throw new CircuitInitialization(`Circuit artifacts not found for ${circuitName}`);
+        }
+        return artifacts.zkey;
+    }
+    async getWasm(circuitName, version = Version.Latest) {
+        await this._handleInitialization(version);
+        const artifacts = this.binaries[circuitName];
+        if (!artifacts) {
+            throw new CircuitInitialization(`Circuit artifacts not found for ${circuitName}`);
+        }
+        return artifacts.wasm;
+    }
+}
+//# sourceMappingURL=circuits.js.map

package/dist/circuits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuits.js","sourceRoot":"","sources":["../lib/circuits.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,EAGL,WAAW,EAGX,cAAc,EACd,OAAO,GAER,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,4BAA4B,EAAE,MAAM,qBAAqB,CAAC;AAOnE,MAAM,OAAO,QAAQ;IACT,WAAW,GAAY,KAAK,CAAC;IAC7B,OAAO,GAAkB,OAAO,CAAC,MAAM,CAAC;IACxC,QAAQ,CAAY;IACpB,OAAO,GAAW,IAAI,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;IAC9C,OAAO,GAAY,IAAI,CAAC;IAE3C,YAAY,OAAwB;QAClC,IAAI,OAAO,EAAE,OAAO,EAAE,CAAC;YACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QACjC,CAAC;QACD,IAAI,OAAO,EAAE,OAAO,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QACjC,CAAC;IACH,CAAC;IAED,QAAQ;QACN,OAAO,OAAO,MAAM,KAAK,WAAW,CAAC;IACvC,CAAC;IAES,WAAW,CAAC,QAAkB,EAAE,OAAsB;QAC9D,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;IAES,KAAK,CAAC,qBAAqB,CACnC,UAAyB,OAAO,CAAC,MAAM;QAEvC,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACrD,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACpC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,YAAY,aAAa,EAAE,CAAC;oBAC/B,MAAM,IAAI,qBAAqB,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC7D,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACjB,MAAM,IAAI,qBAAqB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;gBACxD,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,YAAoB;QAChD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,4BAA4B,CACnE,IAAI,CAAC,OAAO,CACb,CAAC;QACF,OAAO,sBAAsB,CAAC,WAAW,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,yBAAyB,CAC7B,WAA8B;QAE9B,MAAM,SAAS,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;QAC9C,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC3C,IAAI,CAAC,uBAAuB,CAAC,CAAC,WAAW,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrE,IAAI,CAAC,uBAAuB,CAAC,CAAC,WAAW,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrE,IAAI,CAAC,uBAAuB,CAAC,CAAC,WAAW,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACtE,CAAC,CAAC;QACH,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,QAAuB;QAEvB,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC/C,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,UAAU,CAAC;YACtD,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,QAAQ,CAAC;SACrD,CAAC,CAAC;QACH,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAsB;QACxC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,WAA8B,EAC9B,UAAyB,OAAO,CAAC,MAAM;QAEvC,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,qBAAqB,CAC7B,mCAAmC,WAAW,EAAE,CACjD,CAAC;QACJ,CAAC;QACD,OAAO,SAAS,CAAC,IAAI,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,WAA8B,EAC9B,UAAyB,OAAO,CAAC,MAAM;QAEvC,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,qBAAqB,CAC7B,mCAAmC,WAAW,EAAE,CACjD,CAAC;QACJ,CAAC;QACD,OAAO,SAAS,CAAC,IAAI,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,OAAO,CACX,WAA8B,EAC9B,UAAyB,OAAO,CAAC,MAAM;QAEvC,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,qBAAqB,CAC7B,mCAAmC,WAAW,EAAE,CACjD,CAAC;QACJ,CAAC;QACD,OAAO,SAAS,CAAC,IAAI,CAAC;IACxB,CAAC;CACF"}

package/dist/errors.d.ts

@@ -0,0 +1,7 @@
+export declare class FetchArtifact extends Error {
+    constructor(artifact: URL);
+}
+export declare class CircuitInitialization extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../lib/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,QAAQ,EAAE,GAAG;CAK1B;AAED,qBAAa,qBAAsB,SAAQ,KAAK;gBAClC,OAAO,EAAE,MAAM;CAI5B"}

package/dist/errors.js

@@ -0,0 +1,14 @@
+export class FetchArtifact extends Error {
+    constructor(artifact) {
+        const message = `Encountered error while loading artifact at ${artifact.toString()}.`;
+        super(message);
+        this.name = "FetchArtifact";
+    }
+}
+export class CircuitInitialization extends Error {
+    constructor(message) {
+        super(`There was an error initializing the circuits: ${message}`);
+        this.name = "CircuitInitialization";
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../lib/errors.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC,YAAY,QAAa;QACvB,MAAM,OAAO,GAAG,+CAA+C,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC;QACtF,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;IAC9B,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,OAAe;QACzB,KAAK,CAAC,iDAAiD,OAAO,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACtC,CAAC;CACF"}

package/dist/fetchArtifacts.d.ts

@@ -0,0 +1,2 @@
+export declare function importFetchVersionedArtifact(isBrowser: boolean): Promise<typeof import("./fetchArtifacts.esm.js")>;
+//# sourceMappingURL=fetchArtifacts.d.ts.map

package/dist/fetchArtifacts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchArtifacts.d.ts","sourceRoot":"","sources":["../lib/fetchArtifacts.ts"],"names":[],"mappings":"AAAA,wBAAsB,4BAA4B,CAAC,SAAS,EAAE,OAAO,qDAMpE"}

package/dist/fetchArtifacts.esm.d.ts

@@ -0,0 +1,2 @@
+export declare function fetchVersionedArtifact(artifactUrl: URL): Promise<Uint8Array>;
+//# sourceMappingURL=fetchArtifacts.esm.d.ts.map

package/dist/fetchArtifacts.esm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchArtifacts.esm.d.ts","sourceRoot":"","sources":["../lib/fetchArtifacts.esm.ts"],"names":[],"mappings":"AAEA,wBAAsB,sBAAsB,CAC1C,WAAW,EAAE,GAAG,GACf,OAAO,CAAC,UAAU,CAAC,CAOrB"}

package/dist/fetchArtifacts.esm.js

@@ -0,0 +1,10 @@
+import { FetchArtifact } from "./errors.js";
+export async function fetchVersionedArtifact(artifactUrl) {
+    const res = await fetch(artifactUrl);
+    if (res.status !== 200) {
+        throw new FetchArtifact(artifactUrl);
+    }
+    const aBuf = await res.arrayBuffer();
+    return new Uint8Array(aBuf);
+}
+//# sourceMappingURL=fetchArtifacts.esm.js.map

package/dist/fetchArtifacts.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchArtifacts.esm.js","sourceRoot":"","sources":["../lib/fetchArtifacts.esm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,WAAgB;IAEhB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,WAAW,CAAC,CAAC;IACrC,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QACvB,MAAM,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,WAAW,EAAE,CAAC;IACrC,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC"}

package/dist/fetchArtifacts.js

@@ -0,0 +1,9 @@
+export async function importFetchVersionedArtifact(isBrowser) {
+    if (isBrowser) {
+        return import("./fetchArtifacts.esm.js");
+    }
+    else {
+        return import("./fetchArtifacts.node.js");
+    }
+}
+//# sourceMappingURL=fetchArtifacts.js.map

package/dist/fetchArtifacts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchArtifacts.js","sourceRoot":"","sources":["../lib/fetchArtifacts.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAAC,SAAkB;IACnE,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,MAAM,CAAC,yBAAyB,CAAC,CAAC;IAC3C,CAAC;SAAM,CAAC;QACN,OAAO,MAAM,CAAC,0BAA0B,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC"}

package/dist/fetchArtifacts.node.d.ts

@@ -0,0 +1,2 @@
+export declare function fetchVersionedArtifact(artifactUrl: URL): Promise<Uint8Array>;
+//# sourceMappingURL=fetchArtifacts.node.d.ts.map

package/dist/fetchArtifacts.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchArtifacts.node.d.ts","sourceRoot":"","sources":["../lib/fetchArtifacts.node.ts"],"names":[],"mappings":"AAEA,wBAAsB,sBAAsB,CAC1C,WAAW,EAAE,GAAG,GACf,OAAO,CAAC,UAAU,CAAC,CAkBrB"}

package/dist/fetchArtifacts.node.js

@@ -0,0 +1,23 @@
+import { FetchArtifact } from "./errors.js";
+export async function fetchVersionedArtifact(artifactUrl) {
+    try {
+        const fs = (await import("fs")).default;
+        const readPromise = new Promise((resolve, reject) => {
+            fs.readFile(artifactUrl.pathname, (err, data) => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve(data);
+                }
+            });
+        });
+        const buf = await readPromise;
+        return new Uint8Array(buf);
+    }
+    catch (error) {
+        console.error(error);
+        throw new FetchArtifact(artifactUrl);
+    }
+}
+//# sourceMappingURL=fetchArtifacts.node.js.map

package/dist/fetchArtifacts.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchArtifacts.node.js","sourceRoot":"","sources":["../lib/fetchArtifacts.node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,WAAgB;IAEhB,IAAI,CAAC;QACH,MAAM,EAAE,GAAG,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;QACxC,MAAM,WAAW,GAAoB,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnE,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;gBAC9C,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,IAAI,CAAC,CAAC;gBAChB,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC;QAC9B,OAAO,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,MAAM,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;AACH,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { Circuits } from "./circuits.js";
+export { CircuitName, Version, circuitToAsset, } from "./types.js";
+export type { CircuitsInterface, CircuitNameString, VersionString, CircuitArtifacts, Binaries, Circ2Asset, } from "./types.js";
+export { FetchArtifact, CircuitInitialization } from "./errors.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EACL,WAAW,EACX,OAAO,EACP,cAAc,GACf,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,QAAQ,EACR,UAAU,GACX,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { Circuits } from "./circuits.js";
+export { CircuitName, Version, circuitToAsset, } from "./types.js";
+export { FetchArtifact, CircuitInitialization } from "./errors.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EACL,WAAW,EACX,OAAO,EACP,cAAc,GACf,MAAM,YAAY,CAAC;AASpB,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,34 @@
+export declare enum Version {
+    Latest = "latest"
+}
+export type VersionString = `${Version}`;
+export declare enum CircuitName {
+    Commitment = "commitment",
+    Withdraw = "withdraw"
+}
+export type CircuitNameString = `${CircuitName}`;
+export interface CircuitArtifacts {
+    wasm: Uint8Array;
+    vkey: Uint8Array;
+    zkey: Uint8Array;
+}
+export type Circ2Asset = {
+    [key in CircuitName]: {
+        wasm: string;
+        vkey: string;
+        zkey: string;
+    };
+};
+export declare const circuitToAsset: Circ2Asset;
+export interface Binaries {
+    commitment: CircuitArtifacts;
+    withdraw: CircuitArtifacts;
+}
+export interface CircuitsInterface {
+    downloadArtifacts(version: VersionString): Promise<Binaries>;
+    initArtifacts(version: VersionString): Promise<void>;
+    getVerificationKey(circuitName: CircuitNameString, version?: VersionString): Promise<Uint8Array>;
+    getProvingKey(circuitName: CircuitNameString, version?: VersionString): Promise<Uint8Array>;
+    getWasm(circuitName: CircuitNameString, version?: VersionString): Promise<Uint8Array>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../lib/types.ts"],"names":[],"mappings":"AAAA,oBAAY,OAAO;IACjB,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,aAAa,GAAG,GAAG,OAAO,EAAE,CAAC;AAEzC,oBAAY,WAAW;IACrB,UAAU,eAAe;IACzB,QAAQ,aAAa;CACtB;AAED,MAAM,MAAM,iBAAiB,GAAG,GAAG,WAAW,EAAE,CAAC;AAEjD,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,MAAM,UAAU,GAAG;KACtB,GAAG,IAAI,WAAW,GAAG;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KACd;CACF,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,UAWnB,CAAC;AAEX,MAAM,WAAW,QAAQ;IACvB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,QAAQ,EAAE,gBAAgB,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC,iBAAiB,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC7D,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrD,kBAAkB,CAChB,WAAW,EAAE,iBAAiB,EAC9B,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,UAAU,CAAC,CAAC;IACvB,aAAa,CACX,WAAW,EAAE,iBAAiB,EAC9B,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,UAAU,CAAC,CAAC;IACvB,OAAO,CACL,WAAW,EAAE,iBAAiB,EAC9B,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,UAAU,CAAC,CAAC;CACxB"}

package/dist/types.js

@@ -0,0 +1,22 @@
+export var Version;
+(function (Version) {
+    Version["Latest"] = "latest";
+})(Version || (Version = {}));
+export var CircuitName;
+(function (CircuitName) {
+    CircuitName["Commitment"] = "commitment";
+    CircuitName["Withdraw"] = "withdraw";
+})(CircuitName || (CircuitName = {}));
+export const circuitToAsset = {
+    [CircuitName.Commitment]: {
+        wasm: "commitment.wasm",
+        vkey: "commitment.vkey",
+        zkey: "commitment.zkey",
+    },
+    [CircuitName.Withdraw]: {
+        wasm: "withdraw.wasm",
+        vkey: "withdraw.vkey",
+        zkey: "withdraw.zkey",
+    },
+};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,OAEX;AAFD,WAAY,OAAO;IACjB,4BAAiB,CAAA;AACnB,CAAC,EAFW,OAAO,KAAP,OAAO,QAElB;AAID,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,wCAAyB,CAAA;IACzB,oCAAqB,CAAA;AACvB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB;AAkBD,MAAM,CAAC,MAAM,cAAc,GAAe;IACxC,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE;QACxB,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,iBAAiB;KACxB;IACD,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;QACtB,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,eAAe;KACtB;CACO,CAAC"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@fatsolutions/privacy-pools-core-circuits",
+  "private": false,
+  "version": "1.0.0",
+  "description": "Circom circuits and pre-built artifacts for the Privacy Pool protocol",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/0xbow-io/privacy-pools-core.git"
+  },
+  "license": "Apache-2.0",
+  "author": "Wonderland",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./artifacts/*": "./artifacts/*"
+  },
+  "files": [
+    "dist",
+    "artifacts"
+  ],
+  "scripts": {
+    "build:lib": "tsc -p tsconfig.build.json",
+    "stage-artifacts": "sh ./scripts/present.sh",
+    "compile": "npx ts-node -P tsconfig.json ./src/index.ts",
+    "test": "npx mocha",
+    "test:merkle": "npx mocha --ignore tests/commitment.test.ts --ignore tests/withdrawal.test.ts",
+    "test:withdraw": "npx mocha --ignore tests/commitment.test.ts --ignore tests/lean-imt.test.ts",
+    "test:commitment": "npx mocha --ignore tests/withdrawal.test.ts --ignore tests/lean-imt.test.ts",
+    "circomspect": "circomspect -L ../../node_modules/circomlib/circuits/comparators.circom -L ../../node_modules/circomlib/circuits/mux1.circom -L ../../node_modules/circomlib/circuits/poseidon.circom ./circuits/*",
+    "info:withdraw": "npx circomkit info withdraw",
+    "info:commitment": "npx circomkit info commitment",
+    "setup:ptau": "npx circomkit ptau withdraw",
+    "setup:all": "yarn setup:ptau && yarn setup:withdraw && yarn setup:merkle && yarn setup:commitment",
+    "setup:withdraw": "npx circomkit setup withdraw ptau/powersOfTau28_hez_final_16.ptau",
+    "setup:commitment": "npx circomkit setup commitment ptau/powersOfTau28_hez_final_16.ptau",
+    "setup:merkle": "npx circomkit setup merkleTree ptau/powersOfTau28_hez_final_16.ptau",
+    "present": "sh ./scripts/present.sh",
+    "prove:withdraw": "npx circomkit prove withdraw default",
+    "prove:commitment": "npx circomkit prove commitment default",
+    "verify:withdraw": "npx circomkit verify withdraw default",
+    "verify:commitment": "npx circomkit verify commitment default",
+    "gencontract:withdraw": "npx snarkjs zkey export solidityverifier trusted-setup/final-keys/withdraw.zkey WithdrawalVerifier.sol",
+    "gencontract:commitment": "npx snarkjs zkey export solidityverifier trusted-setup/final-keys/commitment.zkey CommitmentVerifier.sol"
+  },
+  "devDependencies": {
+    "@types/mocha": "^10.0.1",
+    "@types/node": "20.3.1",
+    "@zk-kit/lean-imt": "2.2.2",
+    "chai": "5.1.2",
+    "circomkit": "0.3.2",
+    "circomlib": "2.0.5",
+    "maci-circuits": "2.5.0",
+    "maci-crypto": "2.5.0",
+    "mocha": "^10.2.0",
+    "snarkjs": "0.7.5",
+    "ts-node": "^10.9.1",
+    "typescript": "5.5.4",
+    "viem": "2.21.57"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}