zkcloudworker 0.6.3 → 0.7.1

package/lib/ts/src/cloud/cache.js

@@ -1,98 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cache = void 0;
-const node_fs_1 = require("node:fs");
-const node_path_1 = require("node:path");
-const jsEnvironment = "node";
-const cacheHeaderVersion = 1;
-function withVersion(header, version = cacheHeaderVersion) {
-    let uniqueId = `${header.uniqueId}-${version}`;
-    return { ...header, version, uniqueId };
-}
-function readCache(cache, header, transform) {
-    try {
-        let result = cache.read(header);
-        if (result === undefined) {
-            if (cache.debug)
-                console.trace("cache miss");
-            return undefined;
-        }
-        if (transform === undefined)
-            return result;
-        return transform(result);
-    }
-    catch (e) {
-        if (cache.debug)
-            console.log("Failed to read cache", e);
-        return undefined;
-    }
-}
-function writeCache(cache, header, value) {
-    if (!cache.canWrite)
-        return false;
-    try {
-        cache.write(header, value);
-        return true;
-    }
-    catch (e) {
-        if (cache.debug)
-            console.log("Failed to write cache", e);
-        return false;
-    }
-}
-const None = {
-    read() {
-        throw Error("not available");
-    },
-    write() {
-        throw Error("not available");
-    },
-    canWrite: false,
-};
-const FileSystem = (cacheDirectory, debug) => ({
-    read({ persistentId, uniqueId, dataType }) {
-        if (jsEnvironment !== "node")
-            throw Error("file system not available");
-        // read current uniqueId, return data if it matches
-        let currentId = (0, node_fs_1.readFileSync)((0, node_path_1.resolve)(cacheDirectory, `${persistentId}.header`), "utf8");
-        if (currentId !== uniqueId)
-            return undefined;
-        if (dataType === "string") {
-            let string = (0, node_fs_1.readFileSync)((0, node_path_1.resolve)(cacheDirectory, persistentId), "utf8");
-            return new TextEncoder().encode(string);
-        }
-        else {
-            let buffer = (0, node_fs_1.readFileSync)((0, node_path_1.resolve)(cacheDirectory, persistentId));
-            return new Uint8Array(buffer.buffer);
-        }
-    },
-    write({ persistentId, uniqueId, dataType }, data) {
-        if (jsEnvironment !== "node")
-            throw Error("file system not available");
-        (0, node_fs_1.mkdirSync)(cacheDirectory, { recursive: true });
-        (0, node_fs_1.writeFileSync)((0, node_path_1.resolve)(cacheDirectory, `${persistentId}.header`), uniqueId, {
-            encoding: "utf8",
-        });
-        (0, node_fs_1.writeFileSync)((0, node_path_1.resolve)(cacheDirectory, persistentId), data, {
-            encoding: dataType === "string" ? "utf8" : undefined,
-        });
-    },
-    canWrite: jsEnvironment === "node",
-    debug,
-});
-const Cache = {
-    /**
-     * Store data on the file system, in a directory of your choice.
-     *
-     * Data will be stored in two files per cache entry: a data file and a `.header` file.
-     * The header file just contains a unique string which is used to determine whether we can use the cached data.
-     *
-     * Note: this {@link Cache} only caches data in Node.js.
-     */
-    FileSystem,
-    /**
-     * Don't store anything.
-     */
-    None,
-};
-exports.Cache = Cache;

package/lib/web/src/cloud/cache.d.ts

@@ -1,97 +0,0 @@
-export { Cache };
-/**
- * Interface for storing and retrieving values, for caching.
- * `read()` and `write()` can just throw errors on failure.
- *
- * The data that will be passed to the cache for writing is exhaustively described by the {@link CacheHeader} type.
- * It represents one of the following:
- * - The SRS. This is a deterministic lists of curve points (one per curve) that needs to be generated just once,
- *   to be used for polynomial commitments.
- * - Lagrange basis commitments. Similar to the SRS, this will be created once for every power-of-2 circuit size.
- * - Prover and verifier keys for every compiled circuit.
- *
- * Per smart contract or ZkProgram, several different keys are created:
- * - a step prover key (`step-pk`) and verification key (`step-vk`) _for every method_.
- * - a wrap prover key (`wrap-pk`) and verification key (`wrap-vk`) for the entire contract.
- */
-type Cache = {
-    /**
-     * Read a value from the cache.
-     *
-     * @param header A small header to identify what is read from the cache.
-     */
-    read(header: CacheHeader): Uint8Array | undefined;
-    /**
-     * Write a value to the cache.
-     *
-     * @param header A small header to identify what is written to the cache. This will be used by `read()` to retrieve the data.
-     * @param value The value to write to the cache, as a byte array.
-     */
-    write(header: CacheHeader, value: Uint8Array): void;
-    /**
-     * Indicates whether the cache is writable.
-     */
-    canWrite: boolean;
-    /**
-     * If `debug` is toggled, `read()` and `write()` errors are logged to the console.
-     *
-     * By default, cache errors are silent, because they don't necessarily represent an error condition,
-     * but could just be a cache miss, or file system permissions incompatible with writing data.
-     */
-    debug?: boolean;
-};
-type CommonHeader = {
-    /**
-     * Header version to avoid parsing incompatible headers.
-     */
-    version: number;
-    /**
-     * An identifier that is persistent even as versions of the data change. Safe to use as a file path.
-     */
-    persistentId: string;
-    /**
-     * A unique identifier for the data to be read. Safe to use as a file path.
-     */
-    uniqueId: string;
-    /**
-     * Specifies whether the data to be read is a utf8-encoded string or raw binary data. This was added
-     * because node's `fs.readFileSync` returns garbage when reading string files without specifying the encoding.
-     */
-    dataType: "string" | "bytes";
-};
-type StepKeyHeader<Kind> = {
-    kind: Kind;
-    programName: string;
-    methodName: string;
-    methodIndex: number;
-    hash: string;
-};
-type WrapKeyHeader<Kind> = {
-    kind: Kind;
-    programName: string;
-    hash: string;
-};
-type PlainHeader<Kind> = {
-    kind: Kind;
-};
-/**
- * A header that is passed to the caching layer, to support rich caching strategies.
- *
- * Both `uniqueId` and `programId` can safely be used as a file path.
- */
-type CacheHeader = (StepKeyHeader<"step-pk"> | StepKeyHeader<"step-vk"> | WrapKeyHeader<"wrap-pk"> | WrapKeyHeader<"wrap-vk"> | PlainHeader<"srs"> | PlainHeader<"lagrange-basis">) & CommonHeader;
-declare const Cache: {
-    /**
-     * Store data on the file system, in a directory of your choice.
-     *
-     * Data will be stored in two files per cache entry: a data file and a `.header` file.
-     * The header file just contains a unique string which is used to determine whether we can use the cached data.
-     *
-     * Note: this {@link Cache} only caches data in Node.js.
-     */
-    FileSystem: (cacheDirectory: string, debug?: boolean) => Cache;
-    /**
-     * Don't store anything.
-     */
-    None: Cache;
-};

package/lib/web/src/cloud/cache.js

@@ -1,97 +0,0 @@
-import { writeFileSync, readFileSync, mkdirSync } from "node:fs";
-import { resolve } from "node:path";
-const jsEnvironment = "node";
-// external API
-export { Cache };
-const cacheHeaderVersion = 1;
-function withVersion(header, version = cacheHeaderVersion) {
-    let uniqueId = `${header.uniqueId}-${version}`;
-    return { ...header, version, uniqueId };
-}
-function readCache(cache, header, transform) {
-    try {
-        let result = cache.read(header);
-        if (result === undefined) {
-            if (cache.debug)
-                console.trace("cache miss");
-            return undefined;
-        }
-        if (transform === undefined)
-            return result;
-        return transform(result);
-    }
-    catch (e) {
-        if (cache.debug)
-            console.log("Failed to read cache", e);
-        return undefined;
-    }
-}
-function writeCache(cache, header, value) {
-    if (!cache.canWrite)
-        return false;
-    try {
-        cache.write(header, value);
-        return true;
-    }
-    catch (e) {
-        if (cache.debug)
-            console.log("Failed to write cache", e);
-        return false;
-    }
-}
-const None = {
-    read() {
-        throw Error("not available");
-    },
-    write() {
-        throw Error("not available");
-    },
-    canWrite: false,
-};
-const FileSystem = (cacheDirectory, debug) => ({
-    read({ persistentId, uniqueId, dataType }) {
-        if (jsEnvironment !== "node")
-            throw Error("file system not available");
-        // read current uniqueId, return data if it matches
-        let currentId = readFileSync(resolve(cacheDirectory, `${persistentId}.header`), "utf8");
-        if (currentId !== uniqueId)
-            return undefined;
-        if (dataType === "string") {
-            let string = readFileSync(resolve(cacheDirectory, persistentId), "utf8");
-            return new TextEncoder().encode(string);
-        }
-        else {
-            let buffer = readFileSync(resolve(cacheDirectory, persistentId));
-            return new Uint8Array(buffer.buffer);
-        }
-    },
-    write({ persistentId, uniqueId, dataType }, data) {
-        if (jsEnvironment !== "node")
-            throw Error("file system not available");
-        mkdirSync(cacheDirectory, { recursive: true });
-        writeFileSync(resolve(cacheDirectory, `${persistentId}.header`), uniqueId, {
-            encoding: "utf8",
-        });
-        writeFileSync(resolve(cacheDirectory, persistentId), data, {
-            encoding: dataType === "string" ? "utf8" : undefined,
-        });
-    },
-    canWrite: jsEnvironment === "node",
-    debug,
-});
-const Cache = {
-    /**
-     * Store data on the file system, in a directory of your choice.
-     *
-     * Data will be stored in two files per cache entry: a data file and a `.header` file.
-     * The header file just contains a unique string which is used to determine whether we can use the cached data.
-     *
-     * Note: this {@link Cache} only caches data in Node.js.
-     */
-    FileSystem,
-    /**
-     * Don't store anything.
-     */
-    None,
-};
-//# sourceMappingURL=cache.js.map

package/lib/web/src/cloud/cache.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../../../../src/cloud/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,MAAM,aAAa,GAAG,MAAM,CAAC;AAE7B,eAAe;AACf,OAAO,EAAE,KAAK,EAAE,CAAC;AA+CjB,MAAM,kBAAkB,GAAG,CAAC,CAAC;AA+C7B,SAAS,WAAW,CAClB,MAAoC,EACpC,OAAO,GAAG,kBAAkB;IAE5B,IAAI,QAAQ,GAAG,GAAG,MAAM,CAAC,QAAQ,IAAI,OAAO,EAAE,CAAC;IAC/C,OAAO,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAiB,CAAC;AACzD,CAAC;AAUD,SAAS,SAAS,CAChB,KAAY,EACZ,MAAmB,EACnB,SAAgC;IAEhC,IAAI,CAAC;QACH,IAAI,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAChC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,KAAK,CAAC,KAAK;gBAAE,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC7C,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,SAAS,KAAK,SAAS;YAAE,OAAO,MAAkB,CAAC;QACvD,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,KAAK,CAAC,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC;QACxD,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,KAAY,EAAE,MAAmB,EAAE,KAAiB;IACtE,IAAI,CAAC,KAAK,CAAC,QAAQ;QAAE,OAAO,KAAK,CAAC;IAClC,IAAI,CAAC;QACH,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,KAAK,CAAC,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;QACzD,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,IAAI,GAAU;IAClB,IAAI;QACF,MAAM,KAAK,CAAC,eAAe,CAAC,CAAC;IAC/B,CAAC;IACD,KAAK;QACH,MAAM,KAAK,CAAC,eAAe,CAAC,CAAC;IAC/B,CAAC;IACD,QAAQ,EAAE,KAAK;CAChB,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,cAAsB,EAAE,KAAe,EAAS,EAAE,CAAC,CAAC;IACtE,IAAI,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE;QACvC,IAAI,aAAa,KAAK,MAAM;YAAE,MAAM,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAEvE,mDAAmD;QACnD,IAAI,SAAS,GAAG,YAAY,CAC1B,OAAO,CAAC,cAAc,EAAE,GAAG,YAAY,SAAS,CAAC,EACjD,MAAM,CACP,CAAC;QACF,IAAI,SAAS,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QAE7C,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1B,IAAI,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,cAAc,EAAE,YAAY,CAAC,EAAE,MAAM,CAAC,CAAC;YACzE,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,IAAI,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC;YACjE,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IACD,KAAK,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,IAAI;QAC9C,IAAI,aAAa,KAAK,MAAM;YAAE,MAAM,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACvE,SAAS,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/C,aAAa,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,YAAY,SAAS,CAAC,EAAE,QAAQ,EAAE;YACzE,QAAQ,EAAE,MAAM;SACjB,CAAC,CAAC;QACH,aAAa,CAAC,OAAO,CAAC,cAAc,EAAE,YAAY,CAAC,EAAE,IAAI,EAAE;YACzD,QAAQ,EAAE,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;SACrD,CAAC,CAAC;IACL,CAAC;IACD,QAAQ,EAAE,aAAa,KAAK,MAAM;IAClC,KAAK;CACN,CAAC,CAAC;AAEH,MAAM,KAAK,GAAG;IACZ;;;;;;;OAOG;IACH,UAAU;IACV;;OAEG;IACH,IAAI;CACL,CAAC"}