@zkproofport-app/sdk 0.2.12 → 0.2.13

package/dist/offChainVerifier.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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. `bb` proofs are checked by `acirVerifyUltraKeccakHonk(proof,
+ * vk)` — the keccak variant, matching how these proofs are produced. Two things
+ * have to line up:
+ *
+ *   The version. The verification key format is not stable across bb releases:
+ *   the pinned build emits a 1816-byte key where bb 0.87.0 and 1.2.0 emit 1760.
+ *   `@aztec/bb.js@1.0.0-nightly.20250723` is the WASM build of the same bb the
+ *   circuits were compiled with. A different one will reject valid proofs.
+ *
+ *   The oracle hash. Proofs are generated with `--oracle_hash keccak` so the
+ *   Solidity verifiers can check them, so the poseidon-flavoured verify — which
+ *   is what `BarretenbergVerifier.verifyUltraHonkProof` uses — says false for a
+ *   perfectly good proof.
+ *
+ * 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 `@aztec/bb.js` at the pinned version. It is an optional peer dependency
+ * — the WASM is large and most callers verify on-chain — so the failure to have
+ * it installed says so plainly rather than surfacing as a module-not-found.
+ *
+ * @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.13",
   "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",
@@ -45,14 +45,19 @@
     "tslib": "^2.8.1",
     "typedoc": "^0.28.16",
     "typescript": "^5.3.3",
-    "vitest": "^4.0.18"
+    "vitest": "^4.0.18",
+    "@aztec/bb.js": "1.0.0-nightly.20250723"
   },
   "peerDependencies": {
-    "ethers": "^5.7.0 || ^6.0.0"
+    "ethers": "^5.7.0 || ^6.0.0",
+    "@aztec/bb.js": "1.0.0-nightly.20250723"
   },
   "peerDependenciesMeta": {
     "ethers": {
       "optional": true
+    },
+    "@aztec/bb.js": {
+      "optional": true
     }
   },
   "keywords": [