@zkproofport-app/sdk 0.2.12 → 0.2.14

package/dist/offChainVerifier.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Off-chain proof verification — checking a proof against its verification key,
+ * with no chain, no RPC, and no gas.
+ *
+ * WHY THIS EXISTS. The SDK had only `verifyProofOnChain`, and every caller that
+ * wanted an off-chain check called that instead and relabelled the result. The
+ * demo page did exactly this from its first commit: pressing "Off-Chain Verify"
+ * ran an on-chain verification and printed "Off-Chain Verification Passed!".
+ * The answer was true and the label was a lie, which is the worst combination —
+ * nothing looked broken. The mobile app has always verified off-chain properly
+ * (through mopro's native Barretenberg); it was only the JavaScript side that
+ * had no such thing.
+ *
+ * HOW IT WORKS. Proofs here are made with `--oracle_hash keccak` and ZK on, so
+ * the matching check is `acirVerifyUltraKeccakZkHonk(proof, vk)`. Two things
+ * have to line up:
+ *
+ *   The version. `@aztec/bb.js@1.0.0-nightly.20250723` is the WASM build of the
+ *   same bb the circuits are compiled with. Versions are not interchangeable:
+ *   measured on the Korea Mobile ID age circuit, the pinned bb writes a 16256-
+ *   byte proof where bb 1.2.0 writes 16224 for the identical circuit and
+ *   witness — and the verification key comes out the SAME either way, so the
+ *   key cannot warn you. A mismatch shows up only as verification failing.
+ *
+ *   The flavour. There are four verify entry points and picking the wrong one
+ *   is not a polite false. `acirVerifyUltraZKHonk` (poseidon) answers false for
+ *   a perfectly good proof, and `acirVerifyUltraKeccakHonk` — keccak without ZK
+ *   — TRAPS the WebAssembly with a bare "unreachable", which looks exactly like
+ *   a corrupt proof, a mismatched key, or a missing SRS.
+ *
+ * THE PROOF ARRIVES IN TWO PIECES. The mobile app splits what Barretenberg
+ * produced into `proof` and `publicInputs` before sending it, because the
+ * Solidity verifier takes them separately. Verifying needs them joined back, in
+ * that order, which is what `reconstructHonkProof` does.
+ */
+import { type CircuitId } from './circuits';
+export interface OffChainVerifyResult {
+    valid: boolean;
+    error?: string;
+}
+export interface OffChainVerifyOptions {
+    /**
+     * Verification key bytes, if the caller already has them. Skips the fetch —
+     * useful offline, in tests, and for anyone who would rather pin the key they
+     * checked than trust a download.
+     */
+    verificationKey?: Uint8Array;
+    /** Milliseconds before the fetch is abandoned. Default 30000. */
+    timeoutMs?: number;
+}
+/**
+ * Verify a proof off-chain, against its verification key.
+ *
+ * Needs no setup from the caller: the verifier ships with this SDK and is
+ * loaded on first use.
+ *
+ * @param circuit - Canonical circuit identifier
+ * @param proof - Proof bytes as hex, WITHOUT public inputs (as the relay sends it)
+ * @param publicInputs - Public inputs as hex strings, in circuit order
+ * @param options - Optional verification key and timeout
+ * @returns `{ valid }`, or `{ valid: false, error }` when the check could not run
+ *
+ * @example
+ * ```typescript
+ * const result = await verifyProofOffChain(
+ *   'coinbase_attestation',
+ *   response.proof,
+ *   response.publicInputs
+ * );
+ * if (result.valid) console.log('Proof is valid, no chain involved');
+ * ```
+ */
+export declare function verifyProofOffChain(circuit: CircuitId, proof: string, publicInputs: string[], options?: OffChainVerifyOptions): Promise<OffChainVerifyResult>;
+/** @internal Test seam — lets a test start from a known-empty cache. */
+export declare function clearVerificationKeyCache(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zkproofport-app/sdk",
-  "version": "0.2.12",
+  "version": "0.2.14",
   "description": "ZKProofport SDK for requesting zero-knowledge proofs from the ZKProofport mobile app and verifying them on-chain",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -32,6 +32,7 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
+    "@aztec/bb.js": "1.0.0-nightly.20250723",
     "qrcode": "^1.5.3",
     "socket.io-client": "^4.8.0"
   },