@zkpassport/sdk 0.5.2 → 0.5.4

package/dist/cjs/index.d.ts

@@ -243,17 +243,19 @@ export declare class ZKPassport {
      * @param scope Scope this request to a specific use case
      * @param evmChain The EVM chain to use for the verification (if using the proof onchain)
      * @param devMode Whether to enable dev mode. This will allow you to verify mock proofs (i.e. from ZKR)
+     * @param writingDirectory The directory (e.g. `./tmp`) where the necessary temporary artifacts for verification are written to.
+     * It should only be needed when running the `verify` function on a server with restricted write access (e.g. Vercel)
      * @returns An object containing the unique identifier associated to the user
      * and a boolean indicating whether the proofs were successfully verified.
      */
-    verify({ proofs, queryResult, validity, scope, evmChain, devMode, crsPath, }: {
+    verify({ proofs, queryResult, validity, scope, evmChain, devMode, writingDirectory, }: {
         proofs: Array<ProofResult>;
         queryResult: QueryResult;
         validity?: number;
         scope?: string;
         evmChain?: EVMChain;
         devMode?: boolean;
-        crsPath?: string;
+        writingDirectory?: string;
     }): Promise<{
         uniqueIdentifier: string | undefined;
         verified: boolean;

package/dist/cjs/index.js

@@ -13,7 +13,7 @@ const utils_3 = require("@noble/hashes/utils");
 const ZKPassportVerifier_json_1 = tslib_1.__importDefault(require("./assets/abi/ZKPassportVerifier.json"));
 const registry_1 = require("@zkpassport/registry");
 const bridge_1 = require("@obsidion/bridge");
-const VERSION = "0.5.2";
+const VERSION = "0.5.3";
 const DEFAULT_DATE_VALUE = new Date(1111, 10, 11);
 // If Buffer is not defined, then we use the Buffer from the buffer package
 if (typeof globalThis.Buffer === "undefined") {
@@ -2025,10 +2025,12 @@ class ZKPassport {
      * @param scope Scope this request to a specific use case
      * @param evmChain The EVM chain to use for the verification (if using the proof onchain)
      * @param devMode Whether to enable dev mode. This will allow you to verify mock proofs (i.e. from ZKR)
+     * @param writingDirectory The directory (e.g. `./tmp`) where the necessary temporary artifacts for verification are written to.
+     * It should only be needed when running the `verify` function on a server with restricted write access (e.g. Vercel)
      * @returns An object containing the unique identifier associated to the user
      * and a boolean indicating whether the proofs were successfully verified.
      */
-    async verify({ proofs, queryResult, validity, scope, evmChain, devMode = false, crsPath, }) {
+    async verify({ proofs, queryResult, validity, scope, evmChain, devMode = false, writingDirectory, }) {
         // If no proofs were generated, the results can't be trusted.
         // We still return it but verified will be false
         if (!proofs || proofs.length === 0) {
@@ -2046,8 +2048,13 @@ class ZKPassport {
             formattedResult.expiry_date.disclose.result = new Date(formattedResult.expiry_date.disclose.result);
         }
         const { BarretenbergVerifier } = await Promise.resolve().then(() => tslib_1.__importStar(require("@aztec/bb.js")));
+        // Automatically set the writing directory to `/tmp` if it is not provided
+        // and the code is not running in the browser
+        if (typeof window === "undefined" && !writingDirectory) {
+            writingDirectory = "/tmp";
+        }
         const verifier = new BarretenbergVerifier({
-            crsPath,
+            crsPath: writingDirectory ? writingDirectory + "/.bb-crs" : undefined,
         });
         let verified = true;
         let uniqueIdentifier;
@@ -2057,8 +2064,10 @@ class ZKPassport {
         uniqueIdentifier = uniqueIdentifierFromPublicInputs;
         verified = isCorrect;
         queryResultErrors = isCorrect ? undefined : queryResultErrorsFromPublicInputs;
-        if (uniqueIdentifier && BigInt(uniqueIdentifier) === BigInt(0) && !devMode) {
-            // If the unique identifier is 0 and it is not in dev mode,
+        if (uniqueIdentifier &&
+            (BigInt(uniqueIdentifier) === BigInt(1) || BigInt(uniqueIdentifier) === BigInt(0)) &&
+            !devMode) {
+            // If the unique identifier is 0 (old ZKR proofs) or 1 (new ZKR proofs) and it is not in dev mode,
             // the proofs are considered invalid as these are mock proofs only meant
             // for testing purposes
             verified = false;

package/dist/esm/index.d.ts

@@ -243,17 +243,19 @@ export declare class ZKPassport {
      * @param scope Scope this request to a specific use case
      * @param evmChain The EVM chain to use for the verification (if using the proof onchain)
      * @param devMode Whether to enable dev mode. This will allow you to verify mock proofs (i.e. from ZKR)
+     * @param writingDirectory The directory (e.g. `./tmp`) where the necessary temporary artifacts for verification are written to.
+     * It should only be needed when running the `verify` function on a server with restricted write access (e.g. Vercel)
      * @returns An object containing the unique identifier associated to the user
      * and a boolean indicating whether the proofs were successfully verified.
      */
-    verify({ proofs, queryResult, validity, scope, evmChain, devMode, crsPath, }: {
+    verify({ proofs, queryResult, validity, scope, evmChain, devMode, writingDirectory, }: {
         proofs: Array<ProofResult>;
         queryResult: QueryResult;
         validity?: number;
         scope?: string;
         evmChain?: EVMChain;
         devMode?: boolean;
-        crsPath?: string;
+        writingDirectory?: string;
     }): Promise<{
         uniqueIdentifier: string | undefined;
         verified: boolean;

package/dist/esm/index.js

@@ -9,7 +9,7 @@ import { hexToBytes } from "@noble/hashes/utils";
 import ZKPassportVerifierAbi from "./assets/abi/ZKPassportVerifier.json";
 import { RegistryClient } from "@zkpassport/registry";
 import { Bridge } from "@obsidion/bridge";
-const VERSION = "0.5.2";
+const VERSION = "0.5.3";
 const DEFAULT_DATE_VALUE = new Date(1111, 10, 11);
 // If Buffer is not defined, then we use the Buffer from the buffer package
 if (typeof globalThis.Buffer === "undefined") {
@@ -2015,10 +2015,12 @@ export class ZKPassport {
      * @param scope Scope this request to a specific use case
      * @param evmChain The EVM chain to use for the verification (if using the proof onchain)
      * @param devMode Whether to enable dev mode. This will allow you to verify mock proofs (i.e. from ZKR)
+     * @param writingDirectory The directory (e.g. `./tmp`) where the necessary temporary artifacts for verification are written to.
+     * It should only be needed when running the `verify` function on a server with restricted write access (e.g. Vercel)
      * @returns An object containing the unique identifier associated to the user
      * and a boolean indicating whether the proofs were successfully verified.
      */
-    async verify({ proofs, queryResult, validity, scope, evmChain, devMode = false, crsPath, }) {
+    async verify({ proofs, queryResult, validity, scope, evmChain, devMode = false, writingDirectory, }) {
         // If no proofs were generated, the results can't be trusted.
         // We still return it but verified will be false
         if (!proofs || proofs.length === 0) {
@@ -2036,8 +2038,13 @@ export class ZKPassport {
             formattedResult.expiry_date.disclose.result = new Date(formattedResult.expiry_date.disclose.result);
         }
         const { BarretenbergVerifier } = await import("@aztec/bb.js");
+        // Automatically set the writing directory to `/tmp` if it is not provided
+        // and the code is not running in the browser
+        if (typeof window === "undefined" && !writingDirectory) {
+            writingDirectory = "/tmp";
+        }
         const verifier = new BarretenbergVerifier({
-            crsPath,
+            crsPath: writingDirectory ? writingDirectory + "/.bb-crs" : undefined,
         });
         let verified = true;
         let uniqueIdentifier;
@@ -2047,8 +2054,10 @@ export class ZKPassport {
         uniqueIdentifier = uniqueIdentifierFromPublicInputs;
         verified = isCorrect;
         queryResultErrors = isCorrect ? undefined : queryResultErrorsFromPublicInputs;
-        if (uniqueIdentifier && BigInt(uniqueIdentifier) === BigInt(0) && !devMode) {
-            // If the unique identifier is 0 and it is not in dev mode,
+        if (uniqueIdentifier &&
+            (BigInt(uniqueIdentifier) === BigInt(1) || BigInt(uniqueIdentifier) === BigInt(0)) &&
+            !devMode) {
+            // If the unique identifier is 0 (old ZKR proofs) or 1 (new ZKR proofs) and it is not in dev mode,
             // the proofs are considered invalid as these are mock proofs only meant
             // for testing purposes
             verified = false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zkpassport/sdk",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "description": "Privacy-preserving identity verification using passports and ID cards",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -43,7 +43,7 @@
     "@noble/hashes": "^1.7.2",
     "@noble/secp256k1": "^2.2.3",
     "@obsidion/bridge": "^0.10.2",
-    "@zkpassport/registry": "^0.5.1",
+    "@zkpassport/registry": "^0.5.2",
     "@zkpassport/utils": "^0.13.1",
     "buffer": "^6.0.3",
     "i18n-iso-countries": "^7.12.0",

package/src/index.ts

@@ -76,7 +76,7 @@ import ZKPassportVerifierAbi from "./assets/abi/ZKPassportVerifier.json"
 import { RegistryClient } from "@zkpassport/registry"
 import { Bridge, BridgeInterface } from "@obsidion/bridge"
 
-const VERSION = "0.5.2"
+const VERSION = "0.5.3"
 
 const DEFAULT_DATE_VALUE = new Date(1111, 10, 11)
 
@@ -2782,6 +2782,8 @@ export class ZKPassport {
    * @param scope Scope this request to a specific use case
    * @param evmChain The EVM chain to use for the verification (if using the proof onchain)
    * @param devMode Whether to enable dev mode. This will allow you to verify mock proofs (i.e. from ZKR)
+   * @param writingDirectory The directory (e.g. `./tmp`) where the necessary temporary artifacts for verification are written to.
+   * It should only be needed when running the `verify` function on a server with restricted write access (e.g. Vercel)
    * @returns An object containing the unique identifier associated to the user
    * and a boolean indicating whether the proofs were successfully verified.
    */
@@ -2792,7 +2794,7 @@ export class ZKPassport {
     scope,
     evmChain,
     devMode = false,
-    crsPath,
+    writingDirectory,
   }: {
     proofs: Array<ProofResult>
     queryResult: QueryResult
@@ -2800,7 +2802,7 @@ export class ZKPassport {
     scope?: string
     evmChain?: EVMChain
     devMode?: boolean
-    crsPath?: string
+    writingDirectory?: string
   }): Promise<{
     uniqueIdentifier: string | undefined
     verified: boolean
@@ -2828,8 +2830,13 @@ export class ZKPassport {
     }
 
     const { BarretenbergVerifier } = await import("@aztec/bb.js")
+    // Automatically set the writing directory to `/tmp` if it is not provided
+    // and the code is not running in the browser
+    if (typeof window === "undefined" && !writingDirectory) {
+      writingDirectory = "/tmp"
+    }
     const verifier = new BarretenbergVerifier({
-      crsPath,
+      crsPath: writingDirectory ? writingDirectory + "/.bb-crs" : undefined,
     })
     let verified = true
     let uniqueIdentifier: string | undefined
@@ -2843,8 +2850,12 @@ export class ZKPassport {
     uniqueIdentifier = uniqueIdentifierFromPublicInputs
     verified = isCorrect
     queryResultErrors = isCorrect ? undefined : queryResultErrorsFromPublicInputs
-    if (uniqueIdentifier && BigInt(uniqueIdentifier) === BigInt(0) && !devMode) {
-      // If the unique identifier is 0 and it is not in dev mode,
+    if (
+      uniqueIdentifier &&
+      (BigInt(uniqueIdentifier) === BigInt(1) || BigInt(uniqueIdentifier) === BigInt(0)) &&
+      !devMode
+    ) {
+      // If the unique identifier is 0 (old ZKR proofs) or 1 (new ZKR proofs) and it is not in dev mode,
       // the proofs are considered invalid as these are mock proofs only meant
       // for testing purposes
       verified = false