@zkpassport/sdk 0.4.1 → 0.4.2

package/dist/cjs/index.d.ts

@@ -205,7 +205,7 @@ export declare class ZKPassport {
      * @param evmChain The EVM chain to use for the request (if using the proof onchain)
      * @returns The query builder object.
      */
-    request({ name, logo, purpose, scope, mode, evmChain, validity, devMode, topicOverride, keyPairOverride, }: {
+    request({ name, logo, purpose, scope, mode, evmChain, validity, devMode, topicOverride, keyPairOverride, cloudProverUrl, bridgeUrl, }: {
         name: string;
         logo: string;
         purpose: string;
@@ -219,6 +219,8 @@ export declare class ZKPassport {
             privateKey: Uint8Array;
             publicKey: Uint8Array;
         };
+        cloudProverUrl?: string;
+        bridgeUrl?: string;
     }): Promise<QueryBuilder>;
     private checkDiscloseBytesPublicInputs;
     private checkAgePublicInputs;
@@ -280,6 +282,7 @@ export declare class ZKPassport {
         scope?: string;
         devMode?: boolean;
     }): SolidityVerifierParameters;
+    private _getUrl;
     /**
      * @notice Returns the URL of the request.
      * @param requestId The request ID.

package/dist/cjs/index.js

@@ -13,6 +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.4.2";
 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") {
@@ -334,12 +335,9 @@ class ZKPassport {
                 return this.getZkPassportRequest(topic);
             },
             done: () => {
-                const base64Config = buffer_1.Buffer.from(JSON.stringify(this.topicToConfig[topic])).toString("base64");
-                const base64Service = buffer_1.Buffer.from(JSON.stringify(this.topicToService[topic])).toString("base64");
-                const pubkey = this.topicToPublicKey[topic];
                 this.setExpectedProofCount(topic);
                 return {
-                    url: `https://zkpassport.id/r?d=${this.domain}&t=${topic}&c=${base64Config}&s=${base64Service}&p=${pubkey}&m=${this.topicToLocalConfig[topic].mode}`,
+                    url: this._getUrl(topic),
                     requestId: topic,
                     onRequestReceived: (callback) => this.onRequestReceivedCallbacks[topic].push(callback),
                     onGeneratingProof: (callback) => this.onGeneratingProofCallbacks[topic].push(callback),
@@ -365,10 +363,11 @@ class ZKPassport {
      * @param evmChain The EVM chain to use for the request (if using the proof onchain)
      * @returns The query builder object.
      */
-    async request({ name, logo, purpose, scope, mode, evmChain, validity, devMode, topicOverride, keyPairOverride, }) {
+    async request({ name, logo, purpose, scope, mode, evmChain, validity, devMode, topicOverride, keyPairOverride, cloudProverUrl, bridgeUrl, }) {
         const bridge = await bridge_1.Bridge.create({
             keyPair: keyPairOverride,
             bridgeId: topicOverride,
+            bridgeUrl,
         });
         const topic = bridge.connection.getBridgeId();
         this.topicToConfig[topic] = {};
@@ -378,6 +377,8 @@ class ZKPassport {
             purpose,
             scope,
             chainId: evmChain ? getChainIdFromEVMChain(evmChain) : undefined,
+            cloudProverUrl,
+            bridgeUrl,
         };
         this.topicToProofs[topic] = [];
         this.topicToExpectedProofCount[topic] = 0;
@@ -2241,16 +2242,19 @@ class ZKPassport {
         };
         return params;
     }
+    _getUrl(requestId) {
+        const base64Config = buffer_1.Buffer.from(JSON.stringify(this.topicToConfig[requestId])).toString("base64");
+        const base64Service = buffer_1.Buffer.from(JSON.stringify(this.topicToService[requestId])).toString("base64");
+        const pubkey = this.topicToPublicKey[requestId];
+        return `https://zkpassport.id/r?d=${this.domain}&t=${requestId}&c=${base64Config}&s=${base64Service}&p=${pubkey}&m=${this.topicToLocalConfig[requestId].mode}&v=${VERSION}`;
+    }
     /**
      * @notice Returns the URL of the request.
      * @param requestId The request ID.
      * @returns The URL of the request.
      */
     getUrl(requestId) {
-        const pubkey = this.topicToPublicKey[requestId];
-        const base64Config = buffer_1.Buffer.from(JSON.stringify(this.topicToConfig[requestId])).toString("base64");
-        const base64Service = buffer_1.Buffer.from(JSON.stringify(this.topicToService[requestId])).toString("base64");
-        return `https://zkpassport.id/r?d=${this.domain}&t=${requestId}&c=${base64Config}&s=${base64Service}&p=${pubkey}&m=${this.topicToLocalConfig[requestId].mode}`;
+        return this._getUrl(requestId);
     }
     /**
      * @notice Cancels a request by closing the WebSocket connection and deleting the associated data.

package/dist/esm/index.d.ts

@@ -205,7 +205,7 @@ export declare class ZKPassport {
      * @param evmChain The EVM chain to use for the request (if using the proof onchain)
      * @returns The query builder object.
      */
-    request({ name, logo, purpose, scope, mode, evmChain, validity, devMode, topicOverride, keyPairOverride, }: {
+    request({ name, logo, purpose, scope, mode, evmChain, validity, devMode, topicOverride, keyPairOverride, cloudProverUrl, bridgeUrl, }: {
         name: string;
         logo: string;
         purpose: string;
@@ -219,6 +219,8 @@ export declare class ZKPassport {
             privateKey: Uint8Array;
             publicKey: Uint8Array;
         };
+        cloudProverUrl?: string;
+        bridgeUrl?: string;
     }): Promise<QueryBuilder>;
     private checkDiscloseBytesPublicInputs;
     private checkAgePublicInputs;
@@ -280,6 +282,7 @@ export declare class ZKPassport {
         scope?: string;
         devMode?: boolean;
     }): SolidityVerifierParameters;
+    private _getUrl;
     /**
      * @notice Returns the URL of the request.
      * @param requestId The request ID.

package/dist/esm/index.js

@@ -9,6 +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.4.2";
 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") {
@@ -324,12 +325,9 @@ export class ZKPassport {
                 return this.getZkPassportRequest(topic);
             },
             done: () => {
-                const base64Config = Buffer.from(JSON.stringify(this.topicToConfig[topic])).toString("base64");
-                const base64Service = Buffer.from(JSON.stringify(this.topicToService[topic])).toString("base64");
-                const pubkey = this.topicToPublicKey[topic];
                 this.setExpectedProofCount(topic);
                 return {
-                    url: `https://zkpassport.id/r?d=${this.domain}&t=${topic}&c=${base64Config}&s=${base64Service}&p=${pubkey}&m=${this.topicToLocalConfig[topic].mode}`,
+                    url: this._getUrl(topic),
                     requestId: topic,
                     onRequestReceived: (callback) => this.onRequestReceivedCallbacks[topic].push(callback),
                     onGeneratingProof: (callback) => this.onGeneratingProofCallbacks[topic].push(callback),
@@ -355,10 +353,11 @@ export class ZKPassport {
      * @param evmChain The EVM chain to use for the request (if using the proof onchain)
      * @returns The query builder object.
      */
-    async request({ name, logo, purpose, scope, mode, evmChain, validity, devMode, topicOverride, keyPairOverride, }) {
+    async request({ name, logo, purpose, scope, mode, evmChain, validity, devMode, topicOverride, keyPairOverride, cloudProverUrl, bridgeUrl, }) {
         const bridge = await Bridge.create({
             keyPair: keyPairOverride,
             bridgeId: topicOverride,
+            bridgeUrl,
         });
         const topic = bridge.connection.getBridgeId();
         this.topicToConfig[topic] = {};
@@ -368,6 +367,8 @@ export class ZKPassport {
             purpose,
             scope,
             chainId: evmChain ? getChainIdFromEVMChain(evmChain) : undefined,
+            cloudProverUrl,
+            bridgeUrl,
         };
         this.topicToProofs[topic] = [];
         this.topicToExpectedProofCount[topic] = 0;
@@ -2231,16 +2232,19 @@ export class ZKPassport {
         };
         return params;
     }
+    _getUrl(requestId) {
+        const base64Config = Buffer.from(JSON.stringify(this.topicToConfig[requestId])).toString("base64");
+        const base64Service = Buffer.from(JSON.stringify(this.topicToService[requestId])).toString("base64");
+        const pubkey = this.topicToPublicKey[requestId];
+        return `https://zkpassport.id/r?d=${this.domain}&t=${requestId}&c=${base64Config}&s=${base64Service}&p=${pubkey}&m=${this.topicToLocalConfig[requestId].mode}&v=${VERSION}`;
+    }
     /**
      * @notice Returns the URL of the request.
      * @param requestId The request ID.
      * @returns The URL of the request.
      */
     getUrl(requestId) {
-        const pubkey = this.topicToPublicKey[requestId];
-        const base64Config = Buffer.from(JSON.stringify(this.topicToConfig[requestId])).toString("base64");
-        const base64Service = Buffer.from(JSON.stringify(this.topicToService[requestId])).toString("base64");
-        return `https://zkpassport.id/r?d=${this.domain}&t=${requestId}&c=${base64Config}&s=${base64Service}&p=${pubkey}&m=${this.topicToLocalConfig[requestId].mode}`;
+        return this._getUrl(requestId);
     }
     /**
      * @notice Cancels a request by closing the WebSocket connection and deleting the associated data.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zkpassport/sdk",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Privacy-preserving identity verification using passports and ID cards",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -42,9 +42,9 @@
     "@noble/ciphers": "^1.2.1",
     "@noble/hashes": "^1.7.2",
     "@noble/secp256k1": "^2.2.3",
-    "@obsidion/bridge": "^0.9.0",
-    "@zkpassport/registry": "^0.1.9",
-    "@zkpassport/utils": "^0.9.4",
+    "@obsidion/bridge": "^0.10.0",
+    "@zkpassport/registry": "^0.2.1",
+    "@zkpassport/utils": "^0.9.6",
     "buffer": "^6.0.3",
     "i18n-iso-countries": "^7.12.0",
     "pako": "^2.1.0",

package/src/index.ts

@@ -62,10 +62,10 @@ import {
   getBindEVMParameterCommitment,
   getBindParameterCommitment,
   formatBoundData,
+  Service,
 } from "@zkpassport/utils"
 import { bytesToHex } from "@noble/ciphers/utils"
 import { noLogger as logger } from "./logger"
-import { inflate } from "pako"
 import i18en from "i18n-iso-countries/langs/en.json"
 import { Buffer } from "buffer/"
 import { sha256 } from "@noble/hashes/sha2"
@@ -74,6 +74,8 @@ import ZKPassportVerifierAbi from "./assets/abi/ZKPassportVerifier.json"
 import { RegistryClient } from "@zkpassport/registry"
 import { Bridge, BridgeInterface } from "@obsidion/bridge"
 
+const VERSION = "0.4.2"
+
 const DEFAULT_DATE_VALUE = new Date(1111, 10, 11)
 
 // If Buffer is not defined, then we use the Buffer from the buffer package
@@ -382,10 +384,7 @@ export class ZKPassport {
   private topicToPublicKey: Record<string, string> = {}
   private topicToBridge: Record<string, BridgeInterface> = {}
   private topicToRequestReceived: Record<string, boolean> = {}
-  private topicToService: Record<
-    string,
-    { name: string; logo: string; purpose: string; scope?: string; chainId?: number }
-  > = {}
+  private topicToService: Record<string, Service> = {}
   private topicToProofs: Record<string, Array<ProofResult>> = {}
   private topicToExpectedProofCount: Record<string, number> = {}
   private topicToFailedProofCount: Record<string, number> = {}
@@ -659,16 +658,9 @@ export class ZKPassport {
         return this.getZkPassportRequest(topic)
       },
       done: () => {
-        const base64Config = Buffer.from(JSON.stringify(this.topicToConfig[topic])).toString(
-          "base64",
-        )
-        const base64Service = Buffer.from(JSON.stringify(this.topicToService[topic])).toString(
-          "base64",
-        )
-        const pubkey = this.topicToPublicKey[topic]
         this.setExpectedProofCount(topic)
         return {
-          url: `https://zkpassport.id/r?d=${this.domain}&t=${topic}&c=${base64Config}&s=${base64Service}&p=${pubkey}&m=${this.topicToLocalConfig[topic].mode}`,
+          url: this._getUrl(topic),
           requestId: topic,
           onRequestReceived: (callback: () => void) =>
             this.onRequestReceivedCallbacks[topic].push(callback),
@@ -718,6 +710,8 @@ export class ZKPassport {
     devMode,
     topicOverride,
     keyPairOverride,
+    cloudProverUrl,
+    bridgeUrl,
   }: {
     name: string
     logo: string
@@ -729,10 +723,13 @@ export class ZKPassport {
     devMode?: boolean
     topicOverride?: string
     keyPairOverride?: { privateKey: Uint8Array; publicKey: Uint8Array }
+    cloudProverUrl?: string
+    bridgeUrl?: string
   }): Promise<QueryBuilder> {
     const bridge = await Bridge.create({
       keyPair: keyPairOverride,
       bridgeId: topicOverride,
+      bridgeUrl,
     })
 
     const topic = bridge.connection.getBridgeId()
@@ -744,6 +741,8 @@ export class ZKPassport {
       purpose,
       scope,
       chainId: evmChain ? getChainIdFromEVMChain(evmChain) : undefined,
+      cloudProverUrl,
+      bridgeUrl,
     }
     this.topicToProofs[topic] = []
     this.topicToExpectedProofCount[topic] = 0
@@ -3055,20 +3054,24 @@ export class ZKPassport {
     return params
   }
 
-  /**
-   * @notice Returns the URL of the request.
-   * @param requestId The request ID.
-   * @returns The URL of the request.
-   */
-  public getUrl(requestId: string) {
-    const pubkey = this.topicToPublicKey[requestId]
+  private _getUrl(requestId: string) {
     const base64Config = Buffer.from(JSON.stringify(this.topicToConfig[requestId])).toString(
       "base64",
     )
     const base64Service = Buffer.from(JSON.stringify(this.topicToService[requestId])).toString(
       "base64",
     )
-    return `https://zkpassport.id/r?d=${this.domain}&t=${requestId}&c=${base64Config}&s=${base64Service}&p=${pubkey}&m=${this.topicToLocalConfig[requestId].mode}`
+    const pubkey = this.topicToPublicKey[requestId]
+    return `https://zkpassport.id/r?d=${this.domain}&t=${requestId}&c=${base64Config}&s=${base64Service}&p=${pubkey}&m=${this.topicToLocalConfig[requestId].mode}&v=${VERSION}`
+  }
+
+  /**
+   * @notice Returns the URL of the request.
+   * @param requestId The request ID.
+   * @returns The URL of the request.
+   */
+  public getUrl(requestId: string) {
+    return this._getUrl(requestId)
   }
 
   /**