@solarity/zkit 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Solarity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,120 @@
+[![npm](https://img.shields.io/npm/v/@solarity/zkit.svg)](https://www.npmjs.com/package/@solarity/zkit)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# ZKit - Circom Zero Knowledge Kit
+
+**A zero knowledge kit that helps you develop circuits using Circom.**
+
+- Compile and interact with circuits without snarkjs hassle.
+- Generate and verify ZK proofs with a single line of code.
+- Render optimized Solidity verifiers.
+- Forget about native dependencies - everything is in TypeScript.
+
+## Installation
+
+To install the package, run:
+
+```bash
+npm install --save-dev @solarity/zkit
+```
+
+## Usage
+
+### CircomZKit
+
+ZKit is a configless package, which means you don't need to provide any configuration to use it:
+
+```typescript
+import { CircomZKit } from "@solarity/zkit";
+
+async function main() {
+  const zkit = new CircomZKit();
+  
+  const multiplier = zkit.getCircuit("Multiplier");
+  
+  // Generates artifacts in the "./zkit-artifacts" directory
+  await multiplier.compile();
+
+  // Generates ZK proof
+  const proof = await multiplier.generateProof({ a: 2, b: 3});
+}
+```
+
+By default, ZKit will look for the circuit file in the `./circuits` directory. However, you can change this by providing a custom one:
+
+```typescript
+new CircomZKit({ circuitsDir: "./my-circuits" });
+```
+
+To generate zkey, the power-of-tau file is required. ZKit automatically downloads those files from [Hermes](https://hermez.s3-eu-west-1.amazonaws.com/) to the `${HOME}/.zkit/.ptau` directory, so you don't need to re-download them every time you start a new project.
+
+You can also provide a custom path to the directory where the power-of-tau files are stored:
+
+```typescript
+new CircomZKit({ ptauDir: "./my-ptau" });
+```
+
+> [!IMPORTANT]
+> Note that all the files in the `ptauDir` directory must have the `powers-of-tau-{x}.ptau` name format, where `{x}` is a maximum degree (2<sup>x</sup>) of constraints a `ptau` supports.
+
+ZKit may also ask you for the permission to download the power-of-tau files. You can enable this by toggling off the `allowDownload` option:
+
+```typescript
+new CircomZKit({ allowDownload: false });
+```
+
+### CircuitZKit
+
+Once you created a `CircuitZKit` instance using the `getCircuit` method, you can manage the underlying circuit using the following methods:
+
+> [!NOTE]
+> You should first compile the circuit before creating verifiers or generating proofs.
+
+#### compile()
+
+Compiles the circuit and generates the artifacts in the `./zkit-artifacts` or in the provided `artifactsDir` directory. The default output is `r1cs`, `zkey` and `vkey` files.
+
+```typescript
+await multiplier.compile();
+```
+
+#### createVerifier()
+
+Creates Solidity verifier contract  in the `./contracts/verifiers` or in the provided `verifiersDir` directory. 
+
+```typescript
+await multiplier.createVerifier();
+```
+
+#### generateProof()
+
+Generates a proof for the given inputs.
+
+```typescript
+/// { proof: { pi_a, pi_b, pi_c, protocol, curve }, publicSignals: [6] }
+const proof = await multiplier.generateProof({ a: 2, b: 3});
+```
+
+#### verifyProof()
+
+Verifies the proof.
+
+```typescript
+/// true
+const isValidProof = await multiplier.verifyProof(proof);
+```
+
+#### generateCalldata()
+
+Generates calldata by proof for the Solidity verifier's `verifyProof()` method.
+
+```typescript
+/// You can use this calldata to call the verifier contract
+const calldata = await multiplier.generateCalldata(proof);
+```
+
+## Known limitations
+
+- Currently, ZKit supports only the Groth16 proving system.
+- Zkey generation doesn't allow additional contributions.
+- The `compile` method may cause [issues](https://github.com/iden3/snarkjs/issues/494).

package/dist/config/config.d.ts

@@ -0,0 +1,24 @@
+declare const Context: any;
+export type ManagerZKitConfig = {
+    circuitsDir: string;
+    artifactsDir: string;
+    verifiersDir: string;
+    ptauDir: string;
+    allowDownload: boolean;
+};
+export declare const defaultManagerOptions: Partial<ManagerZKitConfig>;
+export type CompileOptions = {
+    sym: boolean;
+    json: boolean;
+    c: boolean;
+    quiet: boolean;
+};
+export declare const defaultCompileOptions: CompileOptions;
+export type ManagerZKitPrivateConfig = ManagerZKitConfig & {
+    compiler: typeof Context;
+    templates: {
+        groth16: string;
+    };
+};
+export {};
+//# sourceMappingURL=config.d.ts.map

package/dist/config/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config/config.ts"],"names":[],"mappings":"AAAA,QAAA,MAAQ,OAAO,KAAuC,CAAC;AAEvD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,OAAO,CAAC,iBAAiB,CAK5D,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,OAAO,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;IACd,CAAC,EAAE,OAAO,CAAC;IACX,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,cAKnC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,GAAG;IACzD,QAAQ,EAAE,OAAO,OAAO,CAAC;IACzB,SAAS,EAAE;QACT,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC"}

package/dist/config/config.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultCompileOptions = exports.defaultManagerOptions = void 0;
+const { Context } = require("@distributedlab/circom2");
+exports.defaultManagerOptions = {
+    circuitsDir: "circuits",
+    artifactsDir: "zkit-artifacts",
+    verifiersDir: "contracts/verifiers",
+    allowDownload: true,
+};
+exports.defaultCompileOptions = {
+    sym: false,
+    json: false,
+    c: false,
+    quiet: false,
+};
+//# sourceMappingURL=config.js.map

package/dist/config/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config/config.ts"],"names":[],"mappings":";;;AAAA,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;AAU1C,QAAA,qBAAqB,GAA+B;IAC/D,WAAW,EAAE,UAAU;IACvB,YAAY,EAAE,gBAAgB;IAC9B,YAAY,EAAE,qBAAqB;IACnC,aAAa,EAAE,IAAI;CACpB,CAAC;AASW,QAAA,qBAAqB,GAAmB;IACnD,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,KAAK;IACX,CAAC,EAAE,KAAK;IACR,KAAK,EAAE,KAAK;CACb,CAAC"}

package/dist/core/CircomZKit.d.ts

@@ -0,0 +1,39 @@
+import { CircuitZKit } from "./CircuitZKit";
+import { CircuitInfo } from "../types/types";
+import { ManagerZKitConfig } from "../config/config";
+/**
+ * `CircomZKit` acts as a factory for `CircuitZKit` instances.
+ */
+export declare class CircomZKit {
+    private readonly _manager;
+    /**
+     * Creates a new `CircomZKit` instance.
+     *
+     * @param {Partial<ManagerZKitConfig>} [options=defaultManagerOptions] - The configuration options to use.
+     */
+    constructor(options?: Partial<ManagerZKitConfig>);
+    /**
+     * Returns a `CircuitZKit` instance for the specified circuit.
+     *
+     * @dev If the circuit id is not unique, the path to the circuit file must be provided.
+     *
+     * @param {string} circuit - The path to the circuit file or the circuit id (filename without extension).
+     * @returns {CircomZKit} The `CircuitZKit` instance.
+     */
+    getCircuit(circuit: string): CircuitZKit;
+    /**
+     * Returns an array of all circuits available in the circuits directory.
+     *
+     * @dev If a circuit id is not unique, the id will be set to `null`.
+     *
+     * @returns {CircuitInfo[]} An array of circuit information objects.
+     */
+    getCircuits(): CircuitInfo[];
+    /**
+     * Returns an array of all circuits paths available in the circuits directory.
+     *
+     * @returns {string[]} An array of circuit paths.
+     */
+    private _getAllCircuits;
+}
+//# sourceMappingURL=CircomZKit.d.ts.map

package/dist/core/CircomZKit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CircomZKit.d.ts","sourceRoot":"","sources":["../../src/core/CircomZKit.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EAAyB,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE5E;;GAEG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAc;IAEvC;;;;OAIG;gBACS,OAAO,GAAE,OAAO,CAAC,iBAAiB,CAAyB;IAIvE;;;;;;;OAOG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW;IA2B/C;;;;;;OAMG;IACI,WAAW,IAAI,WAAW,EAAE;IAyBnC;;;;OAIG;IACH,OAAO,CAAC,eAAe;CAaxB"}

package/dist/core/CircomZKit.js

@@ -0,0 +1,94 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CircomZKit = void 0;
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const CircuitZKit_1 = require("./CircuitZKit");
+const ManagerZKit_1 = require("./ManagerZKit");
+const utils_1 = require("../utils/utils");
+const config_1 = require("../config/config");
+/**
+ * `CircomZKit` acts as a factory for `CircuitZKit` instances.
+ */
+class CircomZKit {
+    _manager;
+    /**
+     * Creates a new `CircomZKit` instance.
+     *
+     * @param {Partial<ManagerZKitConfig>} [options=defaultManagerOptions] - The configuration options to use.
+     */
+    constructor(options = config_1.defaultManagerOptions) {
+        this._manager = new ManagerZKit_1.ManagerZKit({ ...config_1.defaultManagerOptions, ...options });
+    }
+    /**
+     * Returns a `CircuitZKit` instance for the specified circuit.
+     *
+     * @dev If the circuit id is not unique, the path to the circuit file must be provided.
+     *
+     * @param {string} circuit - The path to the circuit file or the circuit id (filename without extension).
+     * @returns {CircomZKit} The `CircuitZKit` instance.
+     */
+    getCircuit(circuit) {
+        const circuits = this._getAllCircuits();
+        const candidates = circuits.filter((file) => {
+            if (circuit.endsWith(".circom")) {
+                return file == path_1.default.normalize(circuit);
+            }
+            return path_1.default.basename(file) == `${circuit}.circom`;
+        });
+        if (candidates.length == 0) {
+            throw Error(`No circuits with name \"${circuit}\" found`);
+        }
+        if (candidates.length > 1) {
+            throw Error(`Found multiple entries for the circuit "${circuit}".
+
+        \rConsider replacing \"${circuit}\" with one of the valid paths:
+        \r${candidates.map((candidate) => `"${candidate}"`).join(os_1.default.EOL)}`);
+        }
+        return new CircuitZKit_1.CircuitZKit(path_1.default.join(this._manager.getCircuitsDir(), candidates[0]), this._manager);
+    }
+    /**
+     * Returns an array of all circuits available in the circuits directory.
+     *
+     * @dev If a circuit id is not unique, the id will be set to `null`.
+     *
+     * @returns {CircuitInfo[]} An array of circuit information objects.
+     */
+    getCircuits() {
+        const circuits = this._getAllCircuits();
+        let circuitsCount = {};
+        for (const circuit of circuits) {
+            const circuitId = path_1.default.parse(circuit).name;
+            circuitsCount[circuitId] = (circuitsCount[circuitId] || 0) + 1;
+        }
+        let result = [];
+        for (const circuit of circuits) {
+            const circuitId = path_1.default.parse(circuit).name;
+            result.push({
+                path: circuit,
+                id: circuitsCount[circuitId] > 1 ? null : circuitId,
+            });
+        }
+        return result;
+    }
+    /**
+     * Returns an array of all circuits paths available in the circuits directory.
+     *
+     * @returns {string[]} An array of circuit paths.
+     */
+    _getAllCircuits() {
+        const circuitsDir = this._manager.getCircuitsDir();
+        let circuits = [];
+        (0, utils_1.readDirRecursively)(circuitsDir, (_dir, file) => {
+            if (path_1.default.extname(file) == ".circom") {
+                circuits.push(path_1.default.relative(circuitsDir, file));
+            }
+        });
+        return circuits;
+    }
+}
+exports.CircomZKit = CircomZKit;
+//# sourceMappingURL=CircomZKit.js.map

package/dist/core/CircomZKit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CircomZKit.js","sourceRoot":"","sources":["../../src/core/CircomZKit.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AAExB,+CAA4C;AAC5C,+CAA4C;AAE5C,0CAAoD;AACpD,6CAA4E;AAE5E;;GAEG;AACH,MAAa,UAAU;IACJ,QAAQ,CAAc;IAEvC;;;;OAIG;IACH,YAAY,UAAsC,8BAAqB;QACrE,IAAI,CAAC,QAAQ,GAAG,IAAI,yBAAW,CAAC,EAAE,GAAG,8BAAqB,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACI,UAAU,CAAC,OAAe;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAExC,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YAC1C,IAAI,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChC,OAAO,IAAI,IAAI,cAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACzC,CAAC;YAED,OAAO,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,GAAG,OAAO,SAAS,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YAC3B,MAAM,KAAK,CAAC,2BAA2B,OAAO,UAAU,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,KAAK,CACT,2CAA2C,OAAO;;iCAEzB,OAAO;YAC5B,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,SAAS,GAAG,CAAC,CAAC,IAAI,CAAC,YAAE,CAAC,GAAG,CAAC,EAAE,CACnE,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,yBAAW,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;OAMG;IACI,WAAW;QAChB,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAExC,IAAI,aAAa,GAAG,EAA4B,CAAC;QAEjD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,SAAS,GAAG,cAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;YAE3C,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACjE,CAAC;QAED,IAAI,MAAM,GAAG,EAAmB,CAAC;QAEjC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,SAAS,GAAG,cAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;YAE3C,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,OAAO;gBACb,EAAE,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;aACpD,CAAC,CAAC;QACL,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACK,eAAe;QACrB,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;QAEnD,IAAI,QAAQ,GAAG,EAAc,CAAC;QAE9B,IAAA,0BAAkB,EAAC,WAAW,EAAE,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE;YAC7D,IAAI,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,SAAS,EAAE,CAAC;gBACpC,QAAQ,CAAC,IAAI,CAAC,cAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC;YAClD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAjGD,gCAiGC"}

package/dist/core/CircuitZKit.d.ts

@@ -0,0 +1,146 @@
+import { CompileOptions } from "../config/config";
+import { ManagerZKit } from "./ManagerZKit";
+import { Calldata, Inputs, ProofStruct } from "../types/types";
+/**
+ * `CircuitZKit` represents a single circuit and provides a high-level API to work with it.
+ *
+ * @dev This class is not meant to be used directly. Use the `CircomZKit` to create its instance.
+ */
+export declare class CircuitZKit {
+    private readonly _circuit;
+    private readonly _manager;
+    /**
+     * Creates a new instance of `CircuitZKit`.
+     *
+     * @param {string} _circuit - The path to the circuit.
+     * @param {ManagerZKit} _manager - The manager that maintains the global state.
+     */
+    constructor(_circuit: string, _manager: ManagerZKit);
+    /**
+     * Compiles the circuit and generates the artifacts.
+     *
+     * @dev If compilation fails, the latest valid artifacts will be preserved.
+     * @dev Doesn't show the compilation error if `quiet` is set to `true`.
+     *
+     * @param {Partial<CompileOptions>} [options=defaultCompileOptions] - Compilation options.
+     */
+    compile(options?: Partial<CompileOptions>): Promise<void>;
+    /**
+     * Creates a verifier contract.
+     */
+    createVerifier(): Promise<void>;
+    /**
+     * Generates a proof for the given inputs.
+     *
+     * @dev The `inputs` should be in the same order as the circuit expects them.
+     *
+     * @param {Inputs} inputs - The inputs for the circuit.
+     * @returns {Promise<ProofStruct>} The generated proof.
+     * @todo Add support for other proving systems.
+     */
+    generateProof(inputs: Inputs): Promise<ProofStruct>;
+    /**
+     * Verifies the given proof.
+     *
+     * @dev The `proof` can be generated using the `generateProof` method.
+     * @dev The `proof.publicSignals` should be in the same order as the circuit expects them.
+     *
+     * @param {ProofStruct} proof - The proof to verify.
+     * @returns {Promise<boolean>} Whether the proof is valid.
+     */
+    verifyProof(proof: ProofStruct): Promise<boolean>;
+    /**
+     * Generates the calldata for the given proof. The calldata can be used to verify the proof on-chain.
+     *
+     * @param {ProofStruct} proof - The proof to generate calldata for.
+     * @returns {Promise<Calldata>} - The generated calldata.
+     * @todo Add other types of calldata.
+     */
+    generateCalldata(proof: ProofStruct): Promise<Calldata>;
+    /**
+     * Returns the circuit ID. The circuit ID is the name of the circuit file without the extension.
+     *
+     * @returns {string} The circuit ID.
+     */
+    getCircuitId(): string;
+    /**
+     * Returns the verifier ID. The verifier ID is the name of the circuit file without the extension, suffixed with "Verifier".
+     *
+     * @returns {string} The verifier ID.
+     */
+    getVerifierId(): string;
+    /**
+     * Generates zero-knowledge key for the circuit.
+     *
+     * @param {string} outDir - The directory to save the generated key.
+     * @todo This method may cause issues https://github.com/iden3/snarkjs/issues/494
+     */
+    private _generateZKey;
+    /**
+     * Generates verification key for the circuit.
+     *
+     * @param {string} outDir - The directory to save the generated key.
+     */
+    private _generateVKey;
+    /**
+     * Returns the arguments to compile the circuit.
+     *
+     * @param {CompileOptions} options - Compilation options.
+     * @param {string} outDir - The directory to save the compiled artifacts.
+     * @returns {string[]} The arguments to compile the circuit.
+     */
+    private _getCompileArgs;
+    /**
+     * Compiles the circuit.
+     *
+     * @param {CompileOptions} options - Compilation options.
+     * @param {string} outDir - The directory to save the compiled artifacts.
+     */
+    private _compile;
+    /**
+     * Returns the number of constraints in the circuit. This value is used to fetch the correct `ptau` file.
+     *
+     * @param {string} outDir - The directory where the compiled artifacts are saved.
+     * @returns {Promise<number>} The number of constraints in the circuit.
+     */
+    _getConstraints(outDir: string): Promise<number>;
+    /**
+     * Returns the path to the file of the given type.
+     *
+     * @param {FileType} fileType - The type of the file.
+     * @param {string | undefined} temp - The temporary directory to use.
+     * @returns {string} The path to the file.
+     */
+    private _getFile;
+    /**
+     * Returns the path to the directory of the given type.
+     *
+     * @param {DirType} dirType - The type of the directory.
+     * @returns {string} The path to the directory.
+     */
+    private _getDir;
+    /**
+     * Returns the path to the file of the given type. Throws an error if the file doesn't exist.
+     *
+     * @param {FileType} fileType - The type of the file.
+     * @param {string | undefined} temp - The temporary directory to use.
+     * @returns {string} The path to the file.
+     */
+    private _mustGetFile;
+    /**
+     * Moves the files from the temporary directory to the output directory.
+     *
+     * @param {string} tempDir - The temporary directory.
+     * @param {string} outDir - The output directory.
+     */
+    private _moveFromTempDirToOutDir;
+    /**
+     * Returns a new instance of `CircomRunner`. The `CircomRunner` is used to compile the circuit.
+     *
+     * @param {string[]} args - The arguments to run the `circom` compiler.
+     * @param {boolean} quiet - Whether to suppress the compilation error.
+     * @returns {typeof CircomRunner} The `CircomRunner` instance.
+     */
+    private _getCircomRunner;
+}
+//# sourceMappingURL=CircuitZKit.d.ts.map

package/dist/core/CircuitZKit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CircuitZKit.d.ts","sourceRoot":"","sources":["../../src/core/CircuitZKit.ts"],"names":[],"mappings":"AAKA,OAAO,EAAyB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAqB,MAAM,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAKlF;;;;GAIG;AACH,qBAAa,WAAW;IAQpB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAR3B;;;;;OAKG;gBAEgB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,WAAW;IAGxC;;;;;;;OAOG;IACU,OAAO,CAAC,OAAO,GAAE,OAAO,CAAC,cAAc,CAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB7F;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IA0B5C;;;;;;;;OAQG;IACU,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOhE;;;;;;;;OAQG;IACU,WAAW,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAQ9D;;;;;;OAMG;IACU,gBAAgB,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAMpE;;;;OAIG;IACI,YAAY,IAAI,MAAM;IAI7B;;;;OAIG;IACI,aAAa,IAAI,MAAM;IAI9B;;;;;OAKG;YACW,aAAa;IAU3B;;;;OAIG;YACW,aAAa;IAS3B;;;;;;OAMG;IACH,OAAO,CAAC,eAAe;IAYvB;;;;;OAKG;YACW,QAAQ;IAiBtB;;;;;OAKG;IACG,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkCtD;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ;IAuBhB;;;;;OAKG;IACH,OAAO,CAAC,OAAO;IAef;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;IAUpB;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAgBhC;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;CAczB"}