@solarity/zkit 0.2.6 → 0.3.0-rc.1

package/src/types/protocols/groth16.ts

@@ -0,0 +1,21 @@
+import { NumericString, PublicSignals } from "../proof-utils";
+
+export interface Groth16Proof {
+  pi_a: [NumericString, NumericString];
+  pi_b: [[NumericString, NumericString], [NumericString, NumericString]];
+  pi_c: [NumericString, NumericString];
+  protocol: string;
+  curve: string;
+}
+
+export interface Groth16ProofStruct {
+  proof: Groth16Proof;
+  publicSignals: PublicSignals;
+}
+
+export type Groth16Calldata = [
+  [NumericString, NumericString],
+  [[NumericString, NumericString], [NumericString, NumericString]],
+  [NumericString, NumericString],
+  PublicSignals,
+];

package/src/types/protocols/index.ts

@@ -0,0 +1,49 @@
+import { Groth16ProofStruct, Groth16Calldata } from "./groth16";
+import { PlonkProofStruct, PlonkCalldata } from "./plonk";
+
+import { Signals } from "../proof-utils";
+import { VerifierLanguageType } from "../circuit-zkit";
+
+export * from "./groth16";
+export * from "./plonk";
+
+export interface IProtocolImplementer<T extends ProvingSystemType> {
+  createVerifier(
+    circuitName: string,
+    vKeyFilePath: string,
+    verifierFilePath: string,
+    languageExtension: VerifierLanguageType,
+  ): Promise<void>;
+
+  generateProof(inputs: Signals, zKeyFilePath: string, wasmFilePath: string): Promise<ProofStructByProtocol<T>>;
+
+  verifyProof(proof: ProofStructByProtocol<T>, vKeyFilePath: string): Promise<boolean>;
+
+  generateCalldata(proof: ProofStructByProtocol<T>): Promise<CalldataByProtocol<T>>;
+
+  getProvingSystemType(): ProvingSystemType;
+
+  getTemplate(fileExtension: VerifierLanguageType): string;
+
+  getVerifierName(circuitName: string): string;
+
+  getZKeyFileName(circuitName: string): string;
+
+  getVKeyFileName(circuitName: string): string;
+}
+
+export interface ProvingSystemStructMap {
+  groth16: {
+    proofStruct: Groth16ProofStruct;
+    calldata: Groth16Calldata;
+  };
+  plonk: {
+    proofStruct: PlonkProofStruct;
+    calldata: PlonkCalldata;
+  };
+}
+
+export type ProvingSystemType = keyof ProvingSystemStructMap;
+
+export type ProofStructByProtocol<T extends ProvingSystemType> = ProvingSystemStructMap[T]["proofStruct"];
+export type CalldataByProtocol<T extends ProvingSystemType> = ProvingSystemStructMap[T]["calldata"];

package/src/types/protocols/plonk.ts

@@ -0,0 +1,28 @@
+import { NumericString, PublicSignals } from "../proof-utils";
+
+export interface PlonkProof {
+  A: [NumericString, NumericString];
+  B: [NumericString, NumericString];
+  C: [NumericString, NumericString];
+  Z: [NumericString, NumericString];
+  T1: [NumericString, NumericString];
+  T2: [NumericString, NumericString];
+  T3: [NumericString, NumericString];
+  Wxi: [NumericString, NumericString];
+  Wxiw: [NumericString, NumericString];
+  eval_a: NumericString;
+  eval_b: NumericString;
+  eval_c: NumericString;
+  eval_s1: NumericString;
+  eval_s2: NumericString;
+  eval_zw: NumericString;
+  protocol: string;
+  curve: string;
+}
+
+export interface PlonkProofStruct {
+  proof: PlonkProof;
+  publicSignals: PublicSignals;
+}
+
+export type PlonkCalldata = [NumericString[], PublicSignals];

package/dist/config/config.d.ts

@@ -1,27 +0,0 @@
-import { TemplateType } from "../types/types";
-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;
-    setup: TemplateType;
-    contributions: number;
-};
-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

@@ -1 +0,0 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,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;IACf,KAAK,EAAE,YAAY,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,cAOnC,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

@@ -1,19 +0,0 @@
-"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,
-    setup: "groth16",
-    contributions: 5,
-};
-//# sourceMappingURL=config.js.map

package/dist/config/config.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config/config.ts"],"names":[],"mappings":";;;AAEA,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;AAWW,QAAA,qBAAqB,GAAmB;IACnD,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,KAAK;IACX,CAAC,EAAE,KAAK;IACR,KAAK,EAAE,KAAK;IACZ,KAAK,EAAE,SAAS;IAChB,aAAa,EAAE,CAAC;CACjB,CAAC"}

package/dist/core/CircomZKit.d.ts

@@ -1,39 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,94 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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/ManagerZKit.d.ts

@@ -1,97 +0,0 @@
-import { ManagerZKitConfig } from "../config/config";
-import { TemplateType } from "../types/types";
-/**
- * `ManagerZKit` provides configuration options and utility methods used by the `CircomZKit` and `CircuitZKit` classes.
- */
-export declare class ManagerZKit {
-    private _config;
-    /**
-     * Creates a new `ManagerZKit` instance.
-     *
-     * @param {Partial<ManagerZKitConfig>} [config=defaultManagerOptions] - The configuration options to use.
-     */
-    constructor(config?: Partial<ManagerZKitConfig>);
-    /**
-     * Fetches the `ptau` file.
-     *
-     * @dev If `ptau` file is not found, this method will try to download it. Use `allowDownload=false` to disable this behavior.
-     *
-     * @param {number} minConstraints - The minimum number of constraints the `ptau` file must support.
-     * @returns {Promise<string>} The path to the `ptau` file.
-     */
-    fetchPtauFile(minConstraints: number): Promise<string>;
-    /**
-     * Returns the path to the artifacts' directory.
-     *
-     * @returns {string} The path to the artifacts' directory.
-     */
-    getArtifactsDir(): string;
-    /**
-     * Returns the path to the circuits' directory.
-     *
-     * @returns {string} The path to the circuits' directory.
-     */
-    getCircuitsDir(): string;
-    /**
-     * Returns the path to the verifiers' directory.
-     *
-     * @returns {string} The path to the verifiers' directory.
-     */
-    getVerifiersDir(): string;
-    /**
-     * Returns the path to the `ptau` directory.
-     *
-     * @dev The default `ptau` directory is located at `${HOME}/.zkit/.ptau`.
-     *
-     * @returns {string} The path to the `ptau` directory.
-     */
-    getPtauDir(): string;
-    /**
-     * Returns a temporary directory path.
-     *
-     * @dev Temporary files are stored in the OS's temporary directory.
-     *
-     * @returns {string} A temporary directory path.
-     */
-    getTempDir(): string;
-    /**
-     * Returns the circom compiler's wasm binary.
-     *
-     * @returns {string} The circom compiler's wasm binary.
-     */
-    getCompiler(): string;
-    /**
-     * Returns the Solidity verifier template for the specified proving system.
-     *
-     * @param {TemplateType} templateType - The template type.
-     * @returns {string} The Solidity verifier template.
-     */
-    getTemplate(templateType: TemplateType): string;
-    /**
-     * Returns whether the download of the `ptau` file is allowed.
-     *
-     * @returns {boolean} Whether the download of the `ptau` file is allowed.
-     */
-    getAllowDownload(): boolean;
-    /**
-     * Downloads the `ptau` file. The download is allowed only if the user confirms it.
-     *
-     * @param {PtauInfo} ptauInfo - The `ptau` file and download url.
-     */
-    private _downloadPtau;
-    /**
-     * Searches for the `ptau` file that supports the specified number of constraints.
-     *
-     * @param {number} ptauId - The `ptau` file id.
-     * @returns {PtauInfo} The `ptau` file path and download url if the file doesn't exist.
-     */
-    private _searchPtau;
-    /**
-     * Prompts the user to allow the download of the `ptau` file.
-     *
-     * @param {PtauInfo} ptauInfo - The `ptau` file and download url.
-     * @returns {Promise<boolean>} Whether the download is allowed.
-     */
-    private _askForDownloadAllowance;
-}
-//# sourceMappingURL=ManagerZKit.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"ManagerZKit.d.ts","sourceRoot":"","sources":["../../src/core/ManagerZKit.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,iBAAiB,EAAmD,MAAM,kBAAkB,CAAC;AACtG,OAAO,EAAY,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAGxD;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,OAAO,CAA2B;IAE1C;;;;OAIG;gBACS,MAAM,GAAE,OAAO,CAAC,iBAAiB,CAAyB;IAsBtE;;;;;;;OAOG;IACU,aAAa,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBnE;;;;OAIG;IACI,eAAe,IAAI,MAAM;IAIhC;;;;OAIG;IACI,cAAc,IAAI,MAAM;IAI/B;;;;OAIG;IACI,eAAe,IAAI,MAAM;IAIhC;;;;;;OAMG;IACI,UAAU,IAAI,MAAM;IAI3B;;;;;;OAMG;IACI,UAAU,IAAI,MAAM;IAI3B;;;;OAIG;IACI,WAAW,IAAI,MAAM;IAI5B;;;;;OAKG;IACI,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM;IAStD;;;;OAIG;IACI,gBAAgB,IAAI,OAAO;IAIlC;;;;OAIG;YACW,aAAa;IAc3B;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IA+BnB;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;CAgBjC"}

package/dist/core/ManagerZKit.js

@@ -1,222 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ManagerZKit = void 0;
-const fs_1 = __importDefault(require("fs"));
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
-const process_1 = __importDefault(require("process"));
-const readline = __importStar(require("readline"));
-const uuid_1 = require("uuid");
-const config_1 = require("../config/config");
-const utils_1 = require("../utils/utils");
-/**
- * `ManagerZKit` provides configuration options and utility methods used by the `CircomZKit` and `CircuitZKit` classes.
- */
-class ManagerZKit {
-    _config;
-    /**
-     * Creates a new `ManagerZKit` instance.
-     *
-     * @param {Partial<ManagerZKitConfig>} [config=defaultManagerOptions] - The configuration options to use.
-     */
-    constructor(config = config_1.defaultManagerOptions) {
-        const overriddenConfig = { ...config_1.defaultManagerOptions, ...config };
-        overriddenConfig.circuitsDir = path_1.default.join(process_1.default.cwd(), overriddenConfig.circuitsDir);
-        overriddenConfig.artifactsDir = path_1.default.join(process_1.default.cwd(), overriddenConfig.artifactsDir);
-        overriddenConfig.verifiersDir = path_1.default.join(process_1.default.cwd(), overriddenConfig.verifiersDir);
-        if (overriddenConfig.ptauDir) {
-            overriddenConfig.ptauDir = path_1.default.join(process_1.default.cwd(), overriddenConfig.ptauDir);
-        }
-        else {
-            overriddenConfig.ptauDir = path_1.default.join(os_1.default.homedir(), ".zkit", ".ptau");
-        }
-        this._config = {
-            ...overriddenConfig,
-            compiler: fs_1.default.readFileSync(require.resolve("@distributedlab/circom2/circom.wasm")),
-            templates: {
-                groth16: fs_1.default.readFileSync(path_1.default.join(__dirname, "templates", "verifier_groth16.sol.ejs"), "utf8"),
-            },
-        };
-    }
-    /**
-     * Fetches the `ptau` file.
-     *
-     * @dev If `ptau` file is not found, this method will try to download it. Use `allowDownload=false` to disable this behavior.
-     *
-     * @param {number} minConstraints - The minimum number of constraints the `ptau` file must support.
-     * @returns {Promise<string>} The path to the `ptau` file.
-     */
-    async fetchPtauFile(minConstraints) {
-        const ptauId = Math.max(Math.ceil(Math.log2(minConstraints)), 8);
-        if (ptauId > 20) {
-            throw new Error('Circuit has too many constraints. The maximum number of constraints is 2^20. Consider passing "ptauDir=PATH_TO_LOCAL_DIR".');
-        }
-        const ptauInfo = this._searchPtau(ptauId);
-        if (ptauInfo.url) {
-            await this._downloadPtau(ptauInfo);
-        }
-        return ptauInfo.file;
-    }
-    /**
-     * Returns the path to the artifacts' directory.
-     *
-     * @returns {string} The path to the artifacts' directory.
-     */
-    getArtifactsDir() {
-        return this._config.artifactsDir;
-    }
-    /**
-     * Returns the path to the circuits' directory.
-     *
-     * @returns {string} The path to the circuits' directory.
-     */
-    getCircuitsDir() {
-        return this._config.circuitsDir;
-    }
-    /**
-     * Returns the path to the verifiers' directory.
-     *
-     * @returns {string} The path to the verifiers' directory.
-     */
-    getVerifiersDir() {
-        return this._config.verifiersDir;
-    }
-    /**
-     * Returns the path to the `ptau` directory.
-     *
-     * @dev The default `ptau` directory is located at `${HOME}/.zkit/.ptau`.
-     *
-     * @returns {string} The path to the `ptau` directory.
-     */
-    getPtauDir() {
-        return this._config.ptauDir;
-    }
-    /**
-     * Returns a temporary directory path.
-     *
-     * @dev Temporary files are stored in the OS's temporary directory.
-     *
-     * @returns {string} A temporary directory path.
-     */
-    getTempDir() {
-        return path_1.default.join(os_1.default.tmpdir(), ".zkit", (0, uuid_1.v4)());
-    }
-    /**
-     * Returns the circom compiler's wasm binary.
-     *
-     * @returns {string} The circom compiler's wasm binary.
-     */
-    getCompiler() {
-        return this._config.compiler;
-    }
-    /**
-     * Returns the Solidity verifier template for the specified proving system.
-     *
-     * @param {TemplateType} templateType - The template type.
-     * @returns {string} The Solidity verifier template.
-     */
-    getTemplate(templateType) {
-        switch (templateType) {
-            case "groth16":
-                return this._config.templates.groth16;
-            default:
-                throw new Error(`Ambiguous template type: ${templateType}.`);
-        }
-    }
-    /**
-     * Returns whether the download of the `ptau` file is allowed.
-     *
-     * @returns {boolean} Whether the download of the `ptau` file is allowed.
-     */
-    getAllowDownload() {
-        return this._config.allowDownload;
-    }
-    /**
-     * Downloads the `ptau` file. The download is allowed only if the user confirms it.
-     *
-     * @param {PtauInfo} ptauInfo - The `ptau` file and download url.
-     */
-    async _downloadPtau(ptauInfo) {
-        if (!this.getAllowDownload() && !(await this._askForDownloadAllowance(ptauInfo))) {
-            throw new Error('Download is cancelled. Allow download or consider passing "ptauDir=PATH_TO_LOCAL_DIR" to the existing ptau files');
-        }
-        fs_1.default.mkdirSync(this.getPtauDir(), { recursive: true });
-        if (!(await (0, utils_1.downloadFile)(ptauInfo.file, ptauInfo.url))) {
-            throw new Error("Something went wrong while downloading the ptau file.");
-        }
-    }
-    /**
-     * Searches for the `ptau` file that supports the specified number of constraints.
-     *
-     * @param {number} ptauId - The `ptau` file id.
-     * @returns {PtauInfo} The `ptau` file path and download url if the file doesn't exist.
-     */
-    _searchPtau(ptauId) {
-        let entries = [];
-        if (fs_1.default.existsSync(this.getPtauDir())) {
-            entries = fs_1.default.readdirSync(this.getPtauDir(), { withFileTypes: true });
-        }
-        const entry = entries.find((entry) => {
-            if (!entry.isFile()) {
-                return false;
-            }
-            const match = entry.name.match(/^powers-of-tau-(\d+)\.ptau$/);
-            if (!match) {
-                return false;
-            }
-            const entryPtauId = parseInt(match[1]);
-            return ptauId <= entryPtauId;
-        });
-        const file = path_1.default.join(this.getPtauDir(), entry ? entry.name : `powers-of-tau-${ptauId}.ptau`);
-        const url = entry
-            ? null
-            : `https://hermez.s3-eu-west-1.amazonaws.com/powersOfTau28_hez_final_${ptauId.toString().padStart(2, "0")}.ptau`;
-        return { file, url };
-    }
-    /**
-     * Prompts the user to allow the download of the `ptau` file.
-     *
-     * @param {PtauInfo} ptauInfo - The `ptau` file and download url.
-     * @returns {Promise<boolean>} Whether the download is allowed.
-     */
-    _askForDownloadAllowance(ptauInfo) {
-        return new Promise((resolve) => {
-            const readLine = readline.createInterface({
-                input: process_1.default.stdin,
-                output: process_1.default.stdout,
-            });
-            readLine.question(`No ptau found. Press [Y] to download it from "${ptauInfo.url}" to ${ptauInfo.file}: `, (response) => {
-                readLine.close();
-                resolve(response.toUpperCase() == "Y");
-            });
-        });
-    }
-}
-exports.ManagerZKit = ManagerZKit;
-//# sourceMappingURL=ManagerZKit.js.map

package/dist/core/ManagerZKit.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ManagerZKit.js","sourceRoot":"","sources":["../../src/core/ManagerZKit.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAoB;AACpB,4CAAoB;AACpB,gDAAwB;AACxB,sDAA8B;AAC9B,mDAAqC;AACrC,+BAAkC;AAElC,6CAAsG;AAEtG,0CAA8C;AAE9C;;GAEG;AACH,MAAa,WAAW;IACd,OAAO,CAA2B;IAE1C;;;;OAIG;IACH,YAAY,SAAqC,8BAAqB;QACpE,MAAM,gBAAgB,GAAG,EAAE,GAAG,8BAAqB,EAAE,GAAG,MAAM,EAAuB,CAAC;QAEtF,gBAAgB,CAAC,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,iBAAO,CAAC,GAAG,EAAE,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACtF,gBAAgB,CAAC,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,iBAAO,CAAC,GAAG,EAAE,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;QACxF,gBAAgB,CAAC,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,iBAAO,CAAC,GAAG,EAAE,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAExF,IAAI,gBAAgB,CAAC,OAAO,EAAE,CAAC;YAC7B,gBAAgB,CAAC,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,iBAAO,CAAC,GAAG,EAAE,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAChF,CAAC;aAAM,CAAC;YACN,gBAAgB,CAAC,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,YAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,CAAC,OAAO,GAAG;YACb,GAAG,gBAAgB;YACnB,QAAQ,EAAE,YAAE,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,qCAAqC,CAAC,CAAC;YACjF,SAAS,EAAE;gBACT,OAAO,EAAE,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,EAAE,0BAA0B,CAAC,EAAE,MAAM,CAAC;aAChG;SACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,aAAa,CAAC,cAAsB;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAEjE,IAAI,MAAM,GAAG,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CACb,4HAA4H,CAC7H,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAE1C,IAAI,QAAQ,CAAC,GAAG,EAAE,CAAC;YACjB,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,eAAe;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,eAAe;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACI,UAAU;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACI,UAAU;QACf,OAAO,cAAI,CAAC,IAAI,CAAC,YAAE,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,IAAA,SAAI,GAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,YAA0B;QAC3C,QAAQ,YAAY,EAAE,CAAC;YACrB,KAAK,SAAS;gBACZ,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC;YACxC;gBACE,MAAM,IAAI,KAAK,CAAC,4BAA4B,YAAY,GAAG,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,gBAAgB;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,aAAa,CAAC,QAAkB;QAC5C,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YACjF,MAAM,IAAI,KAAK,CACb,kHAAkH,CACnH,CAAC;QACJ,CAAC;QAED,YAAE,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAErD,IAAI,CAAC,CAAC,MAAM,IAAA,oBAAY,EAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAI,CAAC,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,WAAW,CAAC,MAAc;QAChC,IAAI,OAAO,GAAG,EAAiB,CAAC;QAEhC,IAAI,YAAE,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC;YACrC,OAAO,GAAG,YAAE,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QACvE,CAAC;QAED,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACnC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;gBACpB,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;YAE9D,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAEvC,OAAO,MAAM,IAAI,WAAW,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,MAAM,OAAO,CAAC,CAAC;QAC/F,MAAM,GAAG,GAAG,KAAK;YACf,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,qEAAqE,MAAM,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;QAEnH,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACK,wBAAwB,CAAC,QAAkB;QACjD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,MAAM,QAAQ,GAAG,QAAQ,CAAC,eAAe,CAAC;gBACxC,KAAK,EAAE,iBAAO,CAAC,KAAK;gBACpB,MAAM,EAAE,iBAAO,CAAC,MAAM;aACvB,CAAC,CAAC;YAEH,QAAQ,CAAC,QAAQ,CACf,iDAAiD,QAAQ,CAAC,GAAI,QAAQ,QAAQ,CAAC,IAAI,IAAI,EACvF,CAAC,QAAQ,EAAE,EAAE;gBACX,QAAQ,CAAC,KAAK,EAAE,CAAC;gBACjB,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE,IAAI,GAAG,CAAC,CAAC;YACzC,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxND,kCAwNC"}