@solarity/zkit 0.1.1 → 0.2.0

package/src/types/{types.ts → circuit-zkit.ts}

@@ -28,16 +28,12 @@ export type InputLike = NumberLike | ArrayLike;
 
 export type Inputs = Record<string, InputLike>;
 
-export type CircuitInfo = {
-  path: string;
-  id: string | null;
-};
-
-export type FileType = "r1cs" | "zkey" | "vkey" | "sym" | "json" | "wasm" | "sol";
-export type DirType = "circuit" | "artifact" | "verifier";
-export type TemplateType = "groth16";
-
-export type PtauInfo = {
-  file: string;
-  url: string | null;
+export type ArtifactsFileType = "r1cs" | "zkey" | "vkey" | "sym" | "json" | "wasm";
+export type VerifierTemplateType = "groth16";
+
+export type CircuitZKitConfig = {
+  circuitName: string;
+  circuitArtifactsPath: string;
+  verifierDirPath: string;
+  templateType?: VerifierTemplateType;
 };

package/src/config/config.ts

@@ -1,43 +0,0 @@
-import { TemplateType } from "../types/types";
-
-const { Context } = require("@distributedlab/circom2");
-
-export type ManagerZKitConfig = {
-  circuitsDir: string;
-  artifactsDir: string;
-  verifiersDir: string;
-  ptauDir: string;
-  allowDownload: boolean;
-};
-
-export const defaultManagerOptions: Partial<ManagerZKitConfig> = {
-  circuitsDir: "circuits",
-  artifactsDir: "zkit-artifacts",
-  verifiersDir: "contracts/verifiers",
-  allowDownload: true,
-};
-
-export type CompileOptions = {
-  sym: boolean;
-  json: boolean;
-  c: boolean;
-  quiet: boolean;
-  setup: TemplateType;
-  contributions: number;
-};
-
-export const defaultCompileOptions: CompileOptions = {
-  sym: false,
-  json: false,
-  c: false,
-  quiet: false,
-  setup: "groth16",
-  contributions: 5,
-};
-
-export type ManagerZKitPrivateConfig = ManagerZKitConfig & {
-  compiler: typeof Context;
-  templates: {
-    groth16: string;
-  };
-};

package/src/core/CircomZKit.ts

@@ -1,110 +0,0 @@
-import os from "os";
-import path from "path";
-
-import { CircuitZKit } from "./CircuitZKit";
-import { ManagerZKit } from "./ManagerZKit";
-import { CircuitInfo } from "../types/types";
-import { readDirRecursively } from "../utils/utils";
-import { defaultManagerOptions, ManagerZKitConfig } from "../config/config";
-
-/**
- * `CircomZKit` acts as a factory for `CircuitZKit` instances.
- */
-export class CircomZKit {
-  private readonly _manager: ManagerZKit;
-
-  /**
-   * Creates a new `CircomZKit` instance.
-   *
-   * @param {Partial<ManagerZKitConfig>} [options=defaultManagerOptions] - The configuration options to use.
-   */
-  constructor(options: Partial<ManagerZKitConfig> = defaultManagerOptions) {
-    this._manager = new ManagerZKit({ ...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.
-   */
-  public getCircuit(circuit: string): CircuitZKit {
-    const circuits = this._getAllCircuits();
-
-    const candidates = circuits.filter((file) => {
-      if (circuit.endsWith(".circom")) {
-        return file == path.normalize(circuit);
-      }
-
-      return path.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.EOL)}`,
-      );
-    }
-
-    return new CircuitZKit(path.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.
-   */
-  public getCircuits(): CircuitInfo[] {
-    const circuits = this._getAllCircuits();
-
-    let circuitsCount = {} as Record<string, number>;
-
-    for (const circuit of circuits) {
-      const circuitId = path.parse(circuit).name;
-
-      circuitsCount[circuitId] = (circuitsCount[circuitId] || 0) + 1;
-    }
-
-    let result = [] as CircuitInfo[];
-
-    for (const circuit of circuits) {
-      const circuitId = path.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.
-   */
-  private _getAllCircuits(): string[] {
-    const circuitsDir = this._manager.getCircuitsDir();
-
-    let circuits = [] as string[];
-
-    readDirRecursively(circuitsDir, (_dir: string, file: string) => {
-      if (path.extname(file) == ".circom") {
-        circuits.push(path.relative(circuitsDir, file));
-      }
-    });
-
-    return circuits;
-  }
-}

package/src/core/ManagerZKit.ts

@@ -1,231 +0,0 @@
-import fs from "fs";
-import os from "os";
-import path from "path";
-import process from "process";
-import * as readline from "readline";
-import { v4 as uuid } from "uuid";
-
-import { ManagerZKitConfig, ManagerZKitPrivateConfig, defaultManagerOptions } from "../config/config";
-import { PtauInfo, TemplateType } from "../types/types";
-import { downloadFile } from "../utils/utils";
-
-/**
- * `ManagerZKit` provides configuration options and utility methods used by the `CircomZKit` and `CircuitZKit` classes.
- */
-export class ManagerZKit {
-  private _config: ManagerZKitPrivateConfig;
-
-  /**
-   * Creates a new `ManagerZKit` instance.
-   *
-   * @param {Partial<ManagerZKitConfig>} [config=defaultManagerOptions] - The configuration options to use.
-   */
-  constructor(config: Partial<ManagerZKitConfig> = defaultManagerOptions) {
-    const overriddenConfig = { ...defaultManagerOptions, ...config } as ManagerZKitConfig;
-
-    overriddenConfig.circuitsDir = path.join(process.cwd(), overriddenConfig.circuitsDir);
-    overriddenConfig.artifactsDir = path.join(process.cwd(), overriddenConfig.artifactsDir);
-    overriddenConfig.verifiersDir = path.join(process.cwd(), overriddenConfig.verifiersDir);
-
-    if (overriddenConfig.ptauDir) {
-      overriddenConfig.ptauDir = path.join(process.cwd(), overriddenConfig.ptauDir);
-    } else {
-      overriddenConfig.ptauDir = path.join(os.homedir(), ".zkit", ".ptau");
-    }
-
-    this._config = {
-      ...overriddenConfig,
-      compiler: fs.readFileSync(require.resolve("@distributedlab/circom2/circom.wasm")),
-      templates: {
-        groth16: fs.readFileSync(path.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.
-   */
-  public async fetchPtauFile(minConstraints: number): Promise<string> {
-    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.
-   */
-  public getArtifactsDir(): string {
-    return this._config.artifactsDir;
-  }
-
-  /**
-   * Returns the path to the circuits' directory.
-   *
-   * @returns {string} The path to the circuits' directory.
-   */
-  public getCircuitsDir(): string {
-    return this._config.circuitsDir;
-  }
-
-  /**
-   * Returns the path to the verifiers' directory.
-   *
-   * @returns {string} The path to the verifiers' directory.
-   */
-  public getVerifiersDir(): string {
-    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.
-   */
-  public getPtauDir(): string {
-    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.
-   */
-  public getTempDir(): string {
-    return path.join(os.tmpdir(), ".zkit", uuid());
-  }
-
-  /**
-   * Returns the circom compiler's wasm binary.
-   *
-   * @returns {string} The circom compiler's wasm binary.
-   */
-  public getCompiler(): string {
-    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.
-   */
-  public getTemplate(templateType: TemplateType): string {
-    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.
-   */
-  public getAllowDownload(): boolean {
-    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.
-   */
-  private async _downloadPtau(ptauInfo: PtauInfo): Promise<void> {
-    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.mkdirSync(this.getPtauDir(), { recursive: true });
-
-    if (!(await 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.
-   */
-  private _searchPtau(ptauId: number): PtauInfo {
-    let entries = [] as fs.Dirent[];
-
-    if (fs.existsSync(this.getPtauDir())) {
-      entries = fs.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.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.
-   */
-  private _askForDownloadAllowance(ptauInfo: PtauInfo): Promise<boolean> {
-    return new Promise((resolve) => {
-      const readLine = readline.createInterface({
-        input: process.stdin,
-        output: process.stdout,
-      });
-
-      readLine.question(
-        `No ptau found. Press [Y] to download it from "${ptauInfo.url!}" to ${ptauInfo.file}: `,
-        (response) => {
-          readLine.close();
-          resolve(response.toUpperCase() == "Y");
-        },
-      );
-    });
-  }
-}

package/src/utils/utils.ts

@@ -1,60 +0,0 @@
-import fs from "fs";
-import path from "path";
-import https from "https";
-
-/**
- * Reads a directory recursively and calls the callback for each file.
- *
- * @dev After Node.js 20.0.0 the `recursive` option is available.
- *
- * @param {string} dir - The directory to read.
- * @param {(dir: string, file: string) => void} callback - The callback function.
- */
-export function readDirRecursively(dir: string, callback: (dir: string, file: string) => void): void {
-  if (!fs.existsSync(dir)) {
-    return;
-  }
-
-  const entries = fs.readdirSync(dir, { withFileTypes: true });
-
-  for (const entry of entries) {
-    const entryPath = path.join(dir, entry.name);
-
-    if (entry.isDirectory()) {
-      readDirRecursively(entryPath, callback);
-    }
-
-    if (entry.isFile()) {
-      callback(dir, entryPath);
-    }
-  }
-}
-
-/**
- * Downloads a file from the specified URL.
- *
- * @param {string} file - The path to save the file to.
- * @param {string} url - The URL to download the file from.
- * @returns {Promise<boolean>} Whether the file was downloaded successfully.
- */
-export async function downloadFile(file: string, url: string): Promise<boolean> {
-  const fileStream = fs.createWriteStream(file);
-
-  return new Promise((resolve, reject) => {
-    const request = https.get(url, (response) => {
-      response.pipe(fileStream);
-    });
-
-    fileStream.on("finish", () => resolve(true));
-
-    request.on("error", (err) => {
-      fs.unlink(file, () => reject(err));
-    });
-
-    fileStream.on("error", (err) => {
-      fs.unlink(file, () => reject(err));
-    });
-
-    request.end();
-  });
-}