@solarity/zkit 0.1.0

package/dist/core/CircuitZKit.js

@@ -0,0 +1,342 @@
+"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.CircuitZKit = void 0;
+const ejs_1 = __importDefault(require("ejs"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const snarkjs = __importStar(require("snarkjs"));
+const config_1 = require("../config/config");
+const utils_1 = require("../utils/utils");
+const { CircomRunner, bindings } = require("@distributedlab/circom2");
+/**
+ * `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.
+ */
+class CircuitZKit {
+    _circuit;
+    _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, _manager) {
+        this._circuit = _circuit;
+        this._manager = _manager;
+    }
+    /**
+     * 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.
+     */
+    async compile(options = config_1.defaultCompileOptions) {
+        const tempDir = this._manager.getTempDir();
+        try {
+            const artifactDir = this._getDir("artifact");
+            fs_1.default.mkdirSync(tempDir, { recursive: true });
+            const overriddenOptions = { ...config_1.defaultCompileOptions, ...options };
+            await this._compile(overriddenOptions, tempDir);
+            await this._generateZKey(tempDir);
+            await this._generateVKey(tempDir);
+            this._moveFromTempDirToOutDir(tempDir, artifactDir);
+        }
+        finally {
+            fs_1.default.rmSync(tempDir, { recursive: true, force: true });
+        }
+    }
+    /**
+     * Creates a verifier contract.
+     */
+    async createVerifier() {
+        const tempDir = this._manager.getTempDir();
+        try {
+            const verifierDir = this._getDir("verifier");
+            fs_1.default.mkdirSync(tempDir, { recursive: true });
+            const vKeyFile = this._mustGetFile("vkey");
+            const verifierFile = this._getFile("sol", tempDir);
+            const groth16Template = this._manager.getTemplate("groth16");
+            const templateParams = JSON.parse(fs_1.default.readFileSync(vKeyFile, "utf-8"));
+            templateParams["verifier_id"] = this.getVerifierId();
+            const verifierCode = ejs_1.default.render(groth16Template, templateParams);
+            fs_1.default.writeFileSync(verifierFile, verifierCode, "utf-8");
+            this._moveFromTempDirToOutDir(tempDir, verifierDir);
+        }
+        finally {
+            fs_1.default.rmSync(tempDir, { recursive: true, force: true });
+        }
+    }
+    /**
+     * 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.
+     */
+    async generateProof(inputs) {
+        const zKeyFile = this._mustGetFile("zkey");
+        const wasmFile = this._mustGetFile("wasm");
+        return (await snarkjs.groth16.fullProve(inputs, wasmFile, zKeyFile));
+    }
+    /**
+     * 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.
+     */
+    async verifyProof(proof) {
+        const vKeyFile = this._mustGetFile("vkey");
+        const verifier = JSON.parse(fs_1.default.readFileSync(vKeyFile).toString());
+        return await snarkjs.groth16.verify(verifier, proof.publicSignals, proof.proof);
+    }
+    /**
+     * 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.
+     */
+    async generateCalldata(proof) {
+        const calldata = await snarkjs.groth16.exportSolidityCallData(proof.proof, proof.publicSignals);
+        return JSON.parse(`[${calldata}]`);
+    }
+    /**
+     * Returns the circuit ID. The circuit ID is the name of the circuit file without the extension.
+     *
+     * @returns {string} The circuit ID.
+     */
+    getCircuitId() {
+        return path_1.default.parse(this._circuit).name;
+    }
+    /**
+     * 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() {
+        return `${path_1.default.parse(this._circuit).name}Verifier`;
+    }
+    /**
+     * 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
+     */
+    async _generateZKey(outDir) {
+        const r1csFile = this._getFile("r1cs", outDir);
+        const zKeyFile = this._getFile("zkey", outDir);
+        const constraints = await this._getConstraints(outDir);
+        const ptauFile = await this._manager.fetchPtauFile(constraints);
+        await snarkjs.zKey.newZKey(r1csFile, ptauFile, zKeyFile);
+    }
+    /**
+     * Generates verification key for the circuit.
+     *
+     * @param {string} outDir - The directory to save the generated key.
+     */
+    async _generateVKey(outDir) {
+        const zKeyFile = this._getFile("zkey", outDir);
+        const vKeyFile = this._getFile("vkey", outDir);
+        const vKeyData = await snarkjs.zKey.exportVerificationKey(zKeyFile);
+        fs_1.default.writeFileSync(vKeyFile, JSON.stringify(vKeyData));
+    }
+    /**
+     * 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.
+     */
+    _getCompileArgs(options, outDir) {
+        let args = [this._circuit, "--r1cs", "--wasm"];
+        options.sym && args.push("--sym");
+        options.json && args.push("--json");
+        options.c && args.push("--c");
+        args.push("-o", outDir);
+        return args;
+    }
+    /**
+     * Compiles the circuit.
+     *
+     * @param {CompileOptions} options - Compilation options.
+     * @param {string} outDir - The directory to save the compiled artifacts.
+     */
+    async _compile(options, outDir) {
+        const args = this._getCompileArgs(options, outDir);
+        try {
+            await this._getCircomRunner(args, options.quiet).execute(this._manager.getCompiler());
+        }
+        catch (err) {
+            if (options.quiet) {
+                throw new Error('Compilation failed with an unknown error. Consider passing "quiet=false" flag to see the compilation error.', { cause: err });
+            }
+            throw new Error("Compilation failed.", { cause: err });
+        }
+    }
+    /**
+     * 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.
+     */
+    async _getConstraints(outDir) {
+        const r1csFile = this._getFile("r1cs", outDir);
+        const r1csDescriptor = fs_1.default.openSync(r1csFile, "r");
+        const readBytes = (position, length) => {
+            const buffer = Buffer.alloc(length);
+            fs_1.default.readSync(r1csDescriptor, buffer, { length, position });
+            return BigInt(`0x${buffer.reverse().toString("hex")}`);
+        };
+        /// @dev https://github.com/iden3/r1csfile/blob/d82959da1f88fbd06db0407051fde94afbf8824a/doc/r1cs_bin_format.md#format-of-the-file
+        const numberOfSections = readBytes(8, 4);
+        let sectionStart = 12;
+        for (let i = 0; i < numberOfSections; ++i) {
+            const sectionType = Number(readBytes(sectionStart, 4));
+            const sectionSize = Number(readBytes(sectionStart + 4, 8));
+            /// @dev Reading header section
+            if (sectionType == 1) {
+                const totalConstraintsOffset = 4 + 8 + 4 + 32 + 4 + 4 + 4 + 4 + 8;
+                return Number(readBytes(sectionStart + totalConstraintsOffset, 4));
+            }
+            sectionStart += 4 + 8 + sectionSize;
+        }
+        throw new Error("Header section is not found.");
+    }
+    /**
+     * 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.
+     */
+    _getFile(fileType, temp) {
+        const circuitId = this.getCircuitId();
+        switch (fileType) {
+            case "r1cs":
+                return path_1.default.join(temp ?? this._getDir("artifact"), `${circuitId}.r1cs`);
+            case "zkey":
+                return path_1.default.join(temp ?? this._getDir("artifact"), `${circuitId}.zkey`);
+            case "vkey":
+                return path_1.default.join(temp ?? this._getDir("artifact"), `${circuitId}.vkey.json`);
+            case "sym":
+                return path_1.default.join(temp ?? this._getDir("artifact"), `${circuitId}.sym`);
+            case "json":
+                return path_1.default.join(temp ?? this._getDir("artifact"), `${circuitId}.json`);
+            case "wasm":
+                return path_1.default.join(temp ?? this._getDir("artifact"), `${circuitId}_js`, `${circuitId}.wasm`);
+            case "sol":
+                return path_1.default.join(temp ?? this._getDir("verifier"), `${circuitId}Verifier.sol`);
+            default:
+                throw new Error(`Ambiguous file type: ${fileType}.`);
+        }
+    }
+    /**
+     * 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.
+     */
+    _getDir(dirType) {
+        const circuitRelativePath = path_1.default.relative(this._manager.getCircuitsDir(), this._circuit);
+        switch (dirType) {
+            case "circuit":
+                return path_1.default.join(this._manager.getCircuitsDir(), circuitRelativePath, "..");
+            case "artifact":
+                return path_1.default.join(this._manager.getArtifactsDir(), circuitRelativePath);
+            case "verifier":
+                return path_1.default.join(this._manager.getVerifiersDir(), circuitRelativePath, "..");
+            default:
+                throw new Error(`Ambiguous dir type: ${dirType}.`);
+        }
+    }
+    /**
+     * 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.
+     */
+    _mustGetFile(fileType, temp) {
+        const file = this._getFile(fileType, temp);
+        if (!fs_1.default.existsSync(file)) {
+            throw new Error(`Expected the file "${file}" to exist`);
+        }
+        return file;
+    }
+    /**
+     * Moves the files from the temporary directory to the output directory.
+     *
+     * @param {string} tempDir - The temporary directory.
+     * @param {string} outDir - The output directory.
+     */
+    _moveFromTempDirToOutDir(tempDir, outDir) {
+        fs_1.default.rmSync(outDir, { recursive: true, force: true });
+        fs_1.default.mkdirSync(outDir, { recursive: true });
+        (0, utils_1.readDirRecursively)(tempDir, (dir, file) => {
+            const correspondingOutDir = path_1.default.join(outDir, path_1.default.relative(tempDir, dir));
+            const correspondingOutFile = path_1.default.join(outDir, path_1.default.relative(tempDir, file));
+            if (!fs_1.default.existsSync(correspondingOutDir)) {
+                fs_1.default.mkdirSync(correspondingOutDir);
+            }
+            fs_1.default.copyFileSync(file, correspondingOutFile);
+        });
+    }
+    /**
+     * 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.
+     */
+    _getCircomRunner(args, quiet) {
+        return new CircomRunner({
+            args,
+            preopens: { "/": "/" },
+            bindings: {
+                ...bindings,
+                exit(code) {
+                    throw new Error(`Compilation error. Exit code: ${code}.`);
+                },
+                fs: fs_1.default,
+            },
+            quiet,
+        });
+    }
+}
+exports.CircuitZKit = CircuitZKit;
+//# sourceMappingURL=CircuitZKit.js.map

package/dist/core/CircuitZKit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CircuitZKit.js","sourceRoot":"","sources":["../../src/core/CircuitZKit.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,8CAAsB;AACtB,4CAAoB;AACpB,gDAAwB;AACxB,iDAAmC;AAEnC,6CAAyE;AAGzE,0CAAoD;AAEpD,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;AAEtE;;;;GAIG;AACH,MAAa,WAAW;IAQH;IACA;IARnB;;;;;OAKG;IACH,YACmB,QAAgB,EAChB,QAAqB;QADrB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,aAAQ,GAAR,QAAQ,CAAa;IACrC,CAAC;IAEJ;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO,CAAC,UAAmC,8BAAqB;QAC3E,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QAE3C,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAE7C,YAAE,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAE3C,MAAM,iBAAiB,GAAmB,EAAE,GAAG,8BAAqB,EAAE,GAAG,OAAO,EAAE,CAAC;YAEnF,MAAM,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;YAEhD,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YAClC,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YAElC,IAAI,CAAC,wBAAwB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QACtD,CAAC;gBAAS,CAAC;YACT,YAAE,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc;QACzB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QAE3C,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAE7C,YAAE,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAE3C,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YAC3C,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAEnD,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;YAE7D,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;YACtE,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YAErD,MAAM,YAAY,GAAG,aAAG,CAAC,MAAM,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;YAEjE,YAAE,CAAC,aAAa,CAAC,YAAY,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;YAEtD,IAAI,CAAC,wBAAwB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QACtD,CAAC;gBAAS,CAAC;YACT,YAAE,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,aAAa,CAAC,MAAc;QACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAE3C,OAAO,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAgB,CAAC;IACtF,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,WAAW,CAAC,KAAkB;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAE3C,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAElE,OAAO,MAAM,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,gBAAgB,CAAC,KAAkB;QAC9C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;QAEhG,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,QAAQ,GAAG,CAAa,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,YAAY;QACjB,OAAO,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,aAAa;QAClB,OAAO,GAAG,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,UAAU,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,aAAa,CAAC,MAAc;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAE/C,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QAEhE,MAAM,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,aAAa,CAAC,MAAc;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAE/C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QAEpE,YAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACK,eAAe,CAAC,OAAuB,EAAE,MAAc;QAC7D,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAE/C,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE9B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAExB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,QAAQ,CAAC,OAAuB,EAAE,MAAc;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAEnD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;QACxF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CACb,6GAA6G,EAC7G,EAAE,KAAK,EAAE,GAAG,EAAE,CACf,CAAC;YACJ,CAAC;YAED,MAAM,IAAI,KAAK,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,MAAc;QAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAE/C,MAAM,cAAc,GAAG,YAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAElD,MAAM,SAAS,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAU,EAAE;YAC7D,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAEpC,YAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;YAE1D,OAAO,MAAM,CAAC,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC,CAAC;QAEF,kIAAkI;QAClI,MAAM,gBAAgB,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACzC,IAAI,YAAY,GAAG,EAAE,CAAC;QAEtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,EAAE,EAAE,CAAC,EAAE,CAAC;YAC1C,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC;YACvD,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAE3D,+BAA+B;YAC/B,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;gBACrB,MAAM,sBAAsB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAElE,OAAO,MAAM,CAAC,SAAS,CAAC,YAAY,GAAG,sBAAsB,EAAE,CAAC,CAAC,CAAC,CAAC;YACrE,CAAC;YAED,YAAY,IAAI,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC;QACtC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACK,QAAQ,CAAC,QAAkB,EAAE,IAAa;QAChD,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAEtC,QAAQ,QAAQ,EAAE,CAAC;YACjB,KAAK,MAAM;gBACT,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,GAAG,SAAS,OAAO,CAAC,CAAC;YAC1E,KAAK,MAAM;gBACT,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,GAAG,SAAS,OAAO,CAAC,CAAC;YAC1E,KAAK,MAAM;gBACT,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,GAAG,SAAS,YAAY,CAAC,CAAC;YAC/E,KAAK,KAAK;gBACR,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,GAAG,SAAS,MAAM,CAAC,CAAC;YACzE,KAAK,MAAM;gBACT,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,GAAG,SAAS,OAAO,CAAC,CAAC;YAC1E,KAAK,MAAM;gBACT,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,GAAG,SAAS,KAAK,EAAE,GAAG,SAAS,OAAO,CAAC,CAAC;YAC7F,KAAK,KAAK;gBACR,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,GAAG,SAAS,cAAc,CAAC,CAAC;YACjF;gBACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,QAAQ,GAAG,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,OAAO,CAAC,OAAgB;QAC9B,MAAM,mBAAmB,GAAG,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEzF,QAAQ,OAAO,EAAE,CAAC;YAChB,KAAK,SAAS;gBACZ,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;YAC9E,KAAK,UAAU;gBACb,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,EAAE,mBAAmB,CAAC,CAAC;YACzE,KAAK,UAAU;gBACb,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;YAC/E;gBACE,MAAM,IAAI,KAAK,CAAC,uBAAuB,OAAO,GAAG,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,YAAY,CAAC,QAAkB,EAAE,IAAa;QACpD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAE3C,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,YAAY,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACK,wBAAwB,CAAC,OAAe,EAAE,MAAc;QAC9D,YAAE,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACpD,YAAE,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE1C,IAAA,0BAAkB,EAAC,OAAO,EAAE,CAAC,GAAW,EAAE,IAAY,EAAE,EAAE;YACxD,MAAM,mBAAmB,GAAG,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;YAC3E,MAAM,oBAAoB,GAAG,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;YAE7E,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,CAAC;gBACxC,YAAE,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;YACpC,CAAC;YAED,YAAE,CAAC,YAAY,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACK,gBAAgB,CAAC,IAAc,EAAE,KAAc;QACrD,OAAO,IAAI,YAAY,CAAC;YACtB,IAAI;YACJ,QAAQ,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE;YACtB,QAAQ,EAAE;gBACR,GAAG,QAAQ;gBACX,IAAI,CAAC,IAAY;oBACf,MAAM,IAAI,KAAK,CAAC,iCAAiC,IAAI,GAAG,CAAC,CAAC;gBAC5D,CAAC;gBACD,EAAE,EAAF,YAAE;aACH;YACD,KAAK;SACN,CAAC,CAAC;IACL,CAAC;CACF;AArWD,kCAqWC"}

package/dist/core/ManagerZKit.d.ts

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

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

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