@zk-email/sdk 0.0.86 → 0.0.88

package/dist/types/proof.d.ts

@@ -0,0 +1,52 @@
+import { Blueprint } from "./blueprint";
+import { ExternalInputProof, ProofProps, ProofResponse, ProofStatus, PublicProofData } from "./types/proof";
+/**
+ * A generated proof. You get get proof data and verify proofs on chain.
+ */
+export declare class Proof {
+    blueprint: Blueprint;
+    props: ProofProps;
+    private lastCheckedStatus;
+    constructor(blueprint: Blueprint, props: ProofProps);
+    getId(): string;
+    /**
+     * Returns a download link for the files of the proof.
+     * @returns The the url to download a zip of the proof files.
+     */
+    getProofDataDownloadLink(): Promise<string>;
+    startFilesDownload(): Promise<void>;
+    /**
+     * Checks the status of proof.
+     * checkStatus can be used in a while(await checkStatus()) loop, since it will wait a fixed
+     * amount of time before the second time you call it.
+     * @returns A promise with the Status.
+     */
+    checkStatus(): Promise<ProofStatus>;
+    waitForCompletion(): Promise<ProofStatus>;
+    /**
+     * Verifies the proof on chain using the verifier contract defined in the blueprint.
+     * Will throw an error if it cannot verify the proof. If the function call succeeds,
+     * the proof was validated.
+     */
+    verifyOnChain(): Promise<void>;
+    /**
+     * Generates call data for the proof that can be used to verify the proof on chain.
+     */
+    createCallData(): Promise<(bigint[] | bigint[][])[]>;
+    /**
+     * Fetches an existing Proof from the database.
+     * @param id - Id of the Proof.
+     * @returns A promise that resolves to a new instance of Proof.
+     */
+    static getProofById(id: string, baseUrl: string): Promise<Proof>;
+    static responseToProofProps(response: ProofResponse): ProofProps;
+    /**
+     * @returns The public data and proof data.
+     */
+    getProofData(): {
+        proofData: string;
+        publicData: PublicProofData;
+        publicOutputs: string[];
+        externalInputs: ExternalInputProof;
+    };
+}

package/dist/types/prover.d.ts

@@ -0,0 +1,39 @@
+import { Blueprint } from "./blueprint";
+import { Proof } from "./proof";
+import { ExternalInputInput, ProverOptions } from "./types/prover";
+/**
+ * Represents a Prover generated from a blueprint that can generate Proofs
+ */
+export declare class Prover {
+    options: ProverOptions;
+    blueprint: Blueprint;
+    constructor(blueprint: Blueprint, options?: ProverOptions);
+    /**
+     * Generates a proof for a given email.
+     * @param eml - Email to prove agains the blueprint of this Prover.
+     * @returns A promise that resolves to a new instance of Proof. The Proof will have the status
+     * Done or Failed.
+     */
+    generateProof(eml: string, externalInputs?: ExternalInputInput[]): Promise<Proof>;
+    /**
+     * Generates inputs needed to generate a proof
+     * @param eml - Email to prove agains the blueprint of this Prover.
+     * @returns A promise that resolves to the inputs.
+     */
+    generateProofInputs(eml: string, externalInputs?: ExternalInputInput[]): Promise<string>;
+    /**
+     * Starts proving for a given email.
+     * @param eml - Email to prove agains the blueprint of this Prover.
+     * @returns A promise that resolves to a new instance of Proof. The Proof will have the status
+     * InProgress.
+     */
+    generateProofRequest(eml: string, externalInputs?: ExternalInputInput[]): Promise<Proof>;
+    /**
+     * Starts proving locally for a given email.
+     * @param eml - Email to prove agains the blueprint of this Prover.
+     * @returns A promise that resolves to a new instance of Proof. The Proof will have the status
+     * Done or Failed.
+     */
+    generateLocalProof(eml: string, externalInputs?: ExternalInputInput[]): Promise<Proof>;
+    private _incNumLocalProofs;
+}

package/dist/types/relayerUtils.d.ts

@@ -0,0 +1,14 @@
+import { DecomposedRegex, DecomposedRegexJson } from "./blueprint";
+import { BlueprintProps, GenerateProofInputsParams, ParsedEmail, ExternalInputInput, PublicProofData } from "./types";
+export declare function parseEmail(eml: string): Promise<ParsedEmail>;
+export declare function testBlueprint(eml: string, blueprint: BlueprintProps, revealPrivate?: boolean): Promise<string[][]>;
+export declare function testDecomposedRegex(body: string, header: string, decomposedRegex: DecomposedRegex | DecomposedRegexJson, revealPrivate?: boolean): Promise<string[]>;
+export declare function generateProofInputs(eml: string, decomposedRegexes: DecomposedRegex[], externalInputs: ExternalInputInput[], params: GenerateProofInputsParams): Promise<string>;
+export declare function getMaxEmailBodyLength(emlContent: string, shaPrecomputeSelector: string): Promise<number>;
+export declare function extractEMLDetails(emlContent: string): Promise<{
+    senderDomain: string | null;
+    headerLength: number;
+    emailQuery: string;
+    emailBodyMaxLength: number;
+}>;
+export declare function parsePublicSignals(publicSignals: string[], decomposedRegexes: DecomposedRegex[]): PublicProofData;

package/dist/types/types/auth.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Interface for authentication for creating and updating blueprints
+ */
+export type Auth = {
+    /**
+     * Retrieves the authentication token
+     * e.g. from a req for next.js or the localstorage for frontend
+     * @returns Promise that resolves to the token string or null if no token exists
+     */
+    getToken: () => Promise<string | null>;
+    /**
+     * Callback triggered when the authentication token expires
+     * @returns Promise that resolves when expired token is handled
+     */
+    onTokenExpired: () => Promise<void>;
+};

package/dist/types/types/blueprint.d.ts

@@ -0,0 +1,155 @@
+export type BlueprintProps = {
+    id?: string;
+    title: string;
+    description?: string;
+    slug?: string;
+    tags?: string[];
+    emailQuery?: string;
+    circuitName: string;
+    ignoreBodyHashCheck?: boolean;
+    shaPrecomputeSelector?: string;
+    emailBodyMaxLength?: number;
+    emailHeaderMaxLength?: number;
+    removeSoftLinebreaks?: boolean;
+    githubUsername?: string;
+    senderDomain?: string;
+    enableHeaderMasking?: boolean;
+    enableBodyMasking?: boolean;
+    zkFramework?: ZkFramework;
+    isPublic?: boolean;
+    createdAt?: Date;
+    updatedAt?: Date;
+    externalInputs?: ExternalInput[];
+    decomposedRegexes: DecomposedRegex[];
+    status?: Status;
+    verifierContract?: VerifierContract;
+    version?: number;
+    stars?: number;
+    numLocalProofs?: number;
+};
+export type DecomposedRegex = {
+    parts: DecomposedRegexPart[];
+    name: string;
+    maxLength: number;
+    location: "body" | "header";
+};
+export type DecomposedRegexPart = {
+    isPublic: boolean;
+    regexDef: string;
+};
+export type DecomposedRegexJson = {
+    parts: DecomposedRegexPartJson[];
+    name: string;
+    max_length: number;
+    location: "body" | "header";
+};
+export type DecomposedRegexPartJson = {
+    is_public: boolean;
+    regex_def: string;
+};
+export type ExternalInput = {
+    name: string;
+    maxLength: number;
+};
+export declare enum ZkFramework {
+    Circom = "circom"
+}
+export declare enum Status {
+    None = 0,
+    Draft = 1,
+    InProgress = 2,
+    Done = 3,
+    Failed = 4
+}
+export type VerifierContract = {
+    address?: string;
+    chain: number;
+};
+export type BlueprintRequest = {
+    id?: string;
+    title: string;
+    description?: string;
+    slug?: string;
+    tags?: string[];
+    email_query?: string;
+    circuit_name?: string;
+    ignore_body_hash_check?: boolean;
+    sha_precompute_selector?: string;
+    email_body_max_length?: number;
+    email_header_max_length?: number;
+    remove_soft_linebreaks?: boolean;
+    github_username?: string;
+    sender_domain?: string;
+    enable_header_masking?: boolean;
+    enable_body_masking?: boolean;
+    zk_framework?: string;
+    is_public?: boolean;
+    external_inputs?: ExternalInputResponse[];
+    decomposed_regexes: DecomposedRegexResponse[];
+    status?: string;
+    verifier_contract_address?: string;
+    verifier_contract_chain?: number;
+    version?: number;
+};
+export type BlueprintResponse = {
+    id: string;
+    title: string;
+    description: string;
+    slug: string;
+    tags: string[];
+    email_query: string;
+    circuit_name: string;
+    ignore_body_hash_check: boolean;
+    sha_precompute_selector: string;
+    email_body_max_length: number;
+    email_header_max_length?: number;
+    remove_soft_linebreaks?: boolean;
+    github_username?: string;
+    sender_domain: string;
+    enable_header_masking?: boolean;
+    enable_body_masking?: boolean;
+    zk_framework: string;
+    is_public: boolean;
+    created_at: ServerDate;
+    updated_at: ServerDate;
+    external_inputs: ExternalInputResponse[];
+    decomposed_regexes: DecomposedRegexResponse[];
+    status: number;
+    verifier_contract_address: string;
+    verifier_contract_chain: number;
+    version: number;
+    stars: number;
+    num_local_proofs: number;
+};
+export type ServerDate = {
+    seconds: number;
+    nanos: number;
+};
+export type ExternalInputResponse = {
+    name: string;
+    max_length: number;
+};
+export type DecomposedRegexResponse = {
+    parts: DecomposedRegexPartResponse[];
+    name: string;
+    max_length: number;
+    location: "body" | "header";
+};
+export type DecomposedRegexPartResponse = {
+    is_public: boolean;
+    regex_def: string;
+};
+export type ListBlueprintsOptions = {
+    skip?: number;
+    limit?: number;
+    sort?: -1 | 1;
+    sortBy?: "updatedAt" | "stars";
+    status?: Status[];
+    isPublic?: boolean;
+    search?: string;
+};
+export type DownloadUrls = Record<string, string>;
+export type ChunkedZkeyUrl = {
+    url: string;
+    suffix: "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k";
+};

package/dist/types/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./auth";
+export * from "./blueprint";
+export * from "./proof";
+export * from "./prover";
+export * from "./sdk";
+export * from "./utils";

package/dist/types/types/proof.d.ts

@@ -0,0 +1,63 @@
+import { ServerDate } from "./blueprint";
+export declare enum ProofStatus {
+    None = 0,
+    InProgress = 1,
+    Done = 2,
+    Failed = 3
+}
+export type PublicProofData = {
+    [key: string]: string[];
+};
+export type ExternalInputProof = {
+    [key: string]: string;
+};
+export type ProofProps = {
+    id: string;
+    blueprintId: string;
+    input: string;
+    proofData?: string;
+    publicData?: PublicProofData;
+    publicOutputs?: string[];
+    externalInputs?: ExternalInputProof;
+    status?: ProofStatus;
+    startedAt?: Date;
+    provedAt?: Date;
+    isLocal: boolean;
+};
+export type ProofResponse = {
+    id: string;
+    blueprint_id: string;
+    input: string;
+    proof?: string;
+    public?: PublicProofData;
+    external_inputs?: ExternalInputProof;
+    public_outputs?: string[];
+    started_at: ServerDate;
+    proved_at?: ServerDate;
+    status: number;
+};
+export type ProofRequest = {
+    blueprint_id: string;
+    input: any;
+    external_inputs: any;
+};
+export type GenerateProofInputsParams = {
+    emailHeaderMaxLength: number;
+    emailBodyMaxLength: number;
+    ignoreBodyHashCheck: boolean;
+    removeSoftLinebreaks: boolean;
+    shaPrecomputeSelector?: string;
+};
+export type GenerateProofInputsParamsInternal = {
+    maxHeaderLength: number;
+    maxBodyLength: number;
+    ignoreBodyHashCheck: boolean;
+    removeSoftLinesBreaks: boolean;
+    shaPrecomputeSelector?: string;
+};
+export type ProofData = {
+    pi_a: [string, string, string];
+    pi_b: [[string, string], [string, string], [string, string]];
+    pi_c: [string, string, string];
+    protocol: string;
+};

package/dist/types/types/prover.d.ts

@@ -0,0 +1,8 @@
+export type ProverOptions = {
+    isLocal: boolean;
+};
+export type ExternalInputInput = {
+    name: string;
+    value: string;
+    maxLength: number;
+};

package/dist/types/types/sdk.d.ts

@@ -0,0 +1,5 @@
+import { Auth } from "./auth";
+export type SdkOptions = {
+    auth?: Auth;
+    baseUrl?: string;
+};

package/dist/types/types/utils.d.ts

@@ -0,0 +1,8 @@
+export type ParsedEmail = {
+    canonicalizedHeader: string;
+    canonicalizedBody: string;
+    signature: number[];
+    publicKey: any[];
+    cleanedBody: string;
+    headers: Map<string, string[]>;
+};

package/dist/types/user.d.ts

@@ -0,0 +1,5 @@
+import { Auth } from "./types";
+/**
+ * @returns An array of slugs that the user starred
+ */
+export declare function getStarredBlueprints(baseUrl: string, auth: Auth): Promise<string[]>;

package/dist/types/utils.d.ts

@@ -0,0 +1,7 @@
+import { Auth } from "./types/auth";
+export declare function post<T>(url: string, data?: object | null, auth?: Auth): Promise<T>;
+export declare function patch<T>(url: string, data?: object | null, auth?: Auth): Promise<T>;
+export declare function get<T>(url: string, queryParams?: object | null, auth?: Auth): Promise<T>;
+export declare function del<T>(url: string, data?: object | null, auth?: Auth): Promise<T>;
+export declare function startJsonFileDownload(json: string, name?: string): void;
+export declare function getDKIMSelector(emlContent: string): string | null;

package/dist/zk-email-sdk.cjs.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("./index-76VwpgoI.js");exports.Blueprint=e.Blueprint;exports.Proof=e.Proof;Object.defineProperty(exports,"ProofStatus",{enumerable:!0,get:()=>e.ProofStatus});Object.defineProperty(exports,"Status",{enumerable:!0,get:()=>e.Status});Object.defineProperty(exports,"ZkFramework",{enumerable:!0,get:()=>e.ZkFramework});exports.ZodError=e.ZodError;exports.default=e.index;exports.generateProofInputs=e.generateProofInputs;exports.getDKIMSelector=e.getDKIMSelector;exports.getLoginWithGithubUrl=e.getLoginWithGithubUrl;exports.parseEmail=e.parseEmail;exports.startJsonFileDownload=e.startJsonFileDownload;exports.testBlueprint=e.testBlueprint;exports.testDecomposedRegex=e.testDecomposedRegex;
+//# sourceMappingURL=zk-email-sdk.cjs.js.map

package/dist/zk-email-sdk.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zk-email-sdk.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/zk-email-sdk.es.js

@@ -0,0 +1,18 @@
+import { h as t, P as e, q as o, S as r, o as l, Z as n, f as i, l as p, k as u, n as f, p as g, j as m, m as d, t as P } from "./index-BBAkhu6Z.mjs";
+export {
+  t as Blueprint,
+  e as Proof,
+  o as ProofStatus,
+  r as Status,
+  l as ZkFramework,
+  n as ZodError,
+  i as default,
+  p as generateProofInputs,
+  u as getDKIMSelector,
+  f as getLoginWithGithubUrl,
+  g as parseEmail,
+  m as startJsonFileDownload,
+  d as testBlueprint,
+  P as testDecomposedRegex
+};
+//# sourceMappingURL=zk-email-sdk.es.js.map

package/dist/zk-email-sdk.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zk-email-sdk.es.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@zk-email/sdk",
-  "version": "0.0.86",
+  "version": "0.0.88",
   "description": "ZK Email SDK for TypeScript",
   "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "module": "./dist/zk-email-sdk.es.js",
+  "types": "./dist/types/index.d.ts",
   "exports": {
     ".": {
-      "require": "./dist/index.js",
-      "import": "./dist/index.mjs",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/zk-email-sdk.cjs.js",
+      "import": "./dist/zk-email-sdk.es.js",
+      "types": "./dist/types/index.d.ts"
     }
   },
   "files": [
@@ -17,13 +17,15 @@
     "README.md"
   ],
   "scripts": {
-    "build": "bunx tsup",
+    "build-old": "bunx tsup src/index.ts src/localProverWorker.ts --format esm,cjs --dts",
+    "build": "vite build",
+    "build-prove-worker": "bun x vite build --config vite.config.worker.ts && bun scripts/escape_str_chars.js",
+    "publish": "bun run build && npm publish --access public",
     "typecheck": "tsc --noEmit",
     "test": "echo \"Error: no test specified\" && exit 1",
     "prepublishOnly": "bun run build",
     "clean": "rm -rf dist",
-    "publish": "npm publish --access public",
-    "publish-nightly": "npm publish --access public --tag nightly"
+    "publish-nightly": "bun run build && npm publish --access public --tag nightly"
   },
   "keywords": [
     "zk",
@@ -34,18 +36,30 @@
   "author": "",
   "license": "MIT",
   "devDependencies": {
+    "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
+    "@rollup/plugin-typescript": "^12.1.2",
     "@types/bun": "^1.1.12",
     "@types/pg": "^8.11.10",
     "open": "^10.1.0",
     "pg": "^8.13.0",
     "prettier": "^3.3.3",
-    "tsup": "^8.3.5"
+    "rollup-plugin-node-polyfills": "^0.2.1",
+    "vite": "^6.0.7",
+    "vite-plugin-commonjs": "^0.10.4",
+    "crypto-browserify": "^3.12.1",
+    "stream-browserify": "^3.0.0",
+    "buffer": "^6.0.3",
+    "vite-plugin-replace": "^0.1.1",
+    "localforage": "^1.10.0",
+    "localforage-memoryStorageDriver": "^0.9.2",
+    "pako": "^2.1.0",
+    "snarkjs": "https://github.com/sampritipanda/snarkjs.git#fef81fc51d17a734637555c6edbd585ecda02d9e"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"
   },
   "dependencies": {
-    "@zk-email/relayer-utils": "0.4.59",
+    "@zk-email/relayer-utils": "0.4.60",
     "ethers": "^6.13.4",
     "viem": "^2.21.53",
     "zod": "^3.23.8"