@zkpassport/sdk 0.3.3 → 0.4.0

package/dist/esm/index.js

@@ -1,18 +1,14 @@
-import { randomBytes } from "crypto";
 import { getAlpha3Code, registerLocale } from "i18n-iso-countries";
-import { getProofData, getCommitmentFromDSCProof, getCommitmentInFromIDDataProof, getCommitmentOutFromIDDataProof, getNullifierFromDisclosureProof, getCommitmentInFromIntegrityProof, getCommitmentOutFromIntegrityProof, getCommitmentInFromDisclosureProof, getMerkleRootFromDSCProof, getCurrentDateFromIntegrityProof, DisclosedData, formatName, getHostedPackagedCircuitByName, getNumberOfPublicInputs, getParameterCommitmentFromDisclosureProof, getCountryParameterCommitment, getDiscloseParameterCommitment, getDateParameterCommitment, getCertificateRegistryRootFromOuterProof, getParamCommitmentsFromOuterProof, getCurrentDateFromCommittedInputs, getMinAgeFromCommittedInputs, getMaxAgeFromCommittedInputs, getAgeParameterCommitment, getMinDateFromCommittedInputs, getMaxDateFromCommittedInputs, getCurrentDateFromOuterProof, getNullifierFromOuterProof, getAgeEVMParameterCommitment, getDateEVMParameterCommitment, getDiscloseEVMParameterCommitment, getCountryEVMParameterCommitment, rightPadArrayWithZeros, getCommittedInputCount, ProofType, getScopeHash, getScopeFromOuterProof, getSubscopeFromOuterProof, } from "@zkpassport/utils";
+import { getProofData, getCommitmentFromDSCProof, getCommitmentInFromIDDataProof, getCommitmentOutFromIDDataProof, getNullifierFromDisclosureProof, getCommitmentInFromIntegrityProof, getCommitmentOutFromIntegrityProof, getCommitmentInFromDisclosureProof, getMerkleRootFromDSCProof, getCurrentDateFromIntegrityProof, DisclosedData, formatName, getHostedPackagedCircuitByName, getNumberOfPublicInputs, getParameterCommitmentFromDisclosureProof, getCountryParameterCommitment, getDiscloseParameterCommitment, getDateParameterCommitment, getCertificateRegistryRootFromOuterProof, getParamCommitmentsFromOuterProof, getCurrentDateFromCommittedInputs, getMinAgeFromCommittedInputs, getMaxAgeFromCommittedInputs, getAgeParameterCommitment, getMinDateFromCommittedInputs, getMaxDateFromCommittedInputs, getCurrentDateFromOuterProof, getNullifierFromOuterProof, getAgeEVMParameterCommitment, getDateEVMParameterCommitment, getDiscloseEVMParameterCommitment, getCountryEVMParameterCommitment, rightPadArrayWithZeros, getCommittedInputCount, ProofType, getScopeHash, getScopeFromOuterProof, getSubscopeFromOuterProof, getServiceScopeHash, } from "@zkpassport/utils";
 import { bytesToHex } from "@noble/ciphers/utils";
-import { getWebSocketClient } from "./websocket";
-import { createEncryptedJsonRpcRequest } from "./json-rpc";
-import { decrypt, generateECDHKeyPair, getSharedSecret } from "./encryption";
 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";
 import { hexToBytes } from "@noble/hashes/utils";
 import ZKPassportVerifierAbi from "./assets/abi/ZKPassportVerifier.json";
 import { RegistryClient } from "@zkpassport/registry";
+import { Bridge } from "@obsidion/bridge";
 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") {
@@ -21,6 +17,24 @@ if (typeof globalThis.Buffer === "undefined") {
         window.Buffer = Buffer;
     }
 }
+function getChainIdFromEVMChain(chain) {
+    if (chain === "ethereum_sepolia") {
+        return 11155111;
+    }
+    else if (chain === "local_anvil") {
+        return 31337;
+    }
+    throw new Error(`Unsupported chain: ${chain}`);
+}
+function getEVMChainFromChainId(chainId) {
+    if (chainId === 11155111) {
+        return "ethereum_sepolia";
+    }
+    else if (chainId === 31337) {
+        return "local_anvil";
+    }
+    throw new Error(`Unsupported chain ID: ${chainId}`);
+}
 registerLocale(i18en);
 function hasRequestedAccessToField(credentialsRequest, field) {
     const fieldValue = credentialsRequest[field];
@@ -69,9 +83,8 @@ export class ZKPassport {
     constructor(_domain) {
         this.topicToConfig = {};
         this.topicToLocalConfig = {};
-        this.topicToKeyPair = {};
-        this.topicToWebSocketClient = {};
-        this.topicToSharedSecret = {};
+        this.topicToPublicKey = {};
+        this.topicToBridge = {};
         this.topicToRequestReceived = {};
         this.topicToService = {};
         this.topicToProofs = {};
@@ -100,6 +113,9 @@ export class ZKPassport {
             queryResult: result,
             validity: this.topicToLocalConfig[topic]?.validity,
             scope: this.topicToService[topic]?.scope,
+            evmChain: this.topicToService[topic]?.chainId
+                ? getEVMChainFromChainId(this.topicToService[topic]?.chainId)
+                : undefined,
             devMode: this.topicToLocalConfig[topic]?.devMode,
         });
         delete this.topicToProofs[topic];
@@ -187,7 +203,7 @@ export class ZKPassport {
      * @param request The request.
      * @param outerRequest The outer request.
      */
-    async handleEncryptedMessage(topic, request, outerRequest) {
+    async handleEncryptedMessage(topic, request) {
         logger.debug("Received encrypted message:", request);
         if (request.method === "accept") {
             logger.debug(`User accepted the request and is generating a proof`);
@@ -199,30 +215,8 @@ export class ZKPassport {
         }
         else if (request.method === "proof") {
             logger.debug(`User generated proof`);
-            // Uncompress the proof and convert it to a hex string
-            const bytesProof = Buffer.from(request.params.proof, "base64");
-            const bytesCommittedInputs = request.params.committedInputs
-                ? Buffer.from(request.params.committedInputs, "base64")
-                : null;
-            const uncompressedProof = inflate(bytesProof);
-            const uncompressedCommittedInputs = bytesCommittedInputs
-                ? inflate(bytesCommittedInputs)
-                : null;
-            // The gzip lib in the app compress the proof as ASCII
-            // and since the app passes the proof as a hex string, we can
-            // just decode the bytes as hex characters using the TextDecoder
-            const hexProof = new TextDecoder().decode(uncompressedProof);
-            const processedProof = {
-                proof: hexProof,
-                vkeyHash: request.params.vkeyHash,
-                name: request.params.name,
-                version: request.params.version,
-                committedInputs: uncompressedCommittedInputs
-                    ? JSON.parse(new TextDecoder().decode(uncompressedCommittedInputs))
-                    : undefined,
-            };
-            this.topicToProofs[topic].push(processedProof);
-            await Promise.all(this.onProofGeneratedCallbacks[topic].map((callback) => callback(processedProof)));
+            this.topicToProofs[topic].push(request.params);
+            await Promise.all(this.onProofGeneratedCallbacks[topic].map((callback) => callback(request.params)));
             // If the results were received before all the proofs were generated,
             // we can handle the result now
             if (this.topicToResults[topic] &&
@@ -322,7 +316,7 @@ export class ZKPassport {
             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 = bytesToHex(this.topicToKeyPair[topic].publicKey);
+                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}`,
@@ -334,7 +328,7 @@ export class ZKPassport {
                     onResult: (callback) => this.onResultCallbacks[topic].push(callback),
                     onReject: (callback) => this.onRejectCallbacks[topic].push(callback),
                     onError: (callback) => this.onErrorCallbacks[topic].push(callback),
-                    isBridgeConnected: () => this.topicToWebSocketClient[topic].readyState === WebSocket.OPEN,
+                    isBridgeConnected: () => this.topicToBridge[topic].isBridgeConnected(),
                     requestReceived: () => this.topicToRequestReceived[topic] === true,
                 };
             },
@@ -348,17 +342,23 @@ export class ZKPassport {
      * @param scope Scope this request to a specific use case
      * @param validity How many days ago should have the ID been last scanned by the user?
      * @param devMode Whether to enable dev mode. This will allow you to verify mock proofs (i.e. from ZKR)
+     * @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, validity, devMode, topicOverride, keyPairOverride, }) {
-        const topic = topicOverride || randomBytes(16).toString("hex");
-        const keyPair = keyPairOverride || (await generateECDHKeyPair());
-        this.topicToKeyPair[topic] = {
-            privateKey: keyPair.privateKey,
-            publicKey: keyPair.publicKey,
-        };
+    async request({ name, logo, purpose, scope, mode, evmChain, validity, devMode, topicOverride, keyPairOverride, }) {
+        const bridge = await Bridge.create({
+            keyPair: keyPairOverride,
+            bridgeId: topicOverride,
+        });
+        const topic = bridge.connection.getBridgeId();
         this.topicToConfig[topic] = {};
-        this.topicToService[topic] = { name, logo, purpose, scope };
+        this.topicToService[topic] = {
+            name,
+            logo,
+            purpose,
+            scope,
+            chainId: evmChain ? getChainIdFromEVMChain(evmChain) : undefined,
+        };
         this.topicToProofs[topic] = [];
         this.topicToExpectedProofCount[topic] = 0;
         this.topicToLocalConfig[topic] = {
@@ -374,53 +374,21 @@ export class ZKPassport {
         this.onResultCallbacks[topic] = [];
         this.onRejectCallbacks[topic] = [];
         this.onErrorCallbacks[topic] = [];
-        const wsClient = getWebSocketClient(`wss://bridge.zkpassport.id?topic=${topic}`, this.domain);
-        this.topicToWebSocketClient[topic] = wsClient;
-        wsClient.onopen = async () => {
-            logger.info("[frontend] WebSocket connection established");
+        this.topicToPublicKey[topic] = bridge.getPublicKey();
+        this.topicToBridge[topic] = bridge;
+        bridge.onConnect(async (reconnection) => {
+            logger.debug("Bridge connected");
+            logger.debug("Is reconnection:", reconnection);
             await Promise.all(this.onBridgeConnectCallbacks[topic].map((callback) => callback()));
-        };
-        wsClient.addEventListener("message", async (event) => {
-            logger.debug("[frontend] Received message:", event.data);
-            try {
-                const data = JSON.parse(event.data);
-                // Handshake happens when the mobile app scans the QR code and connects to the bridge
-                if (data.method === "handshake") {
-                    logger.debug("[frontend] Received handshake:", event.data);
-                    this.topicToRequestReceived[topic] = true;
-                    this.topicToSharedSecret[topic] = await getSharedSecret(bytesToHex(keyPair.privateKey), data.params.pubkey);
-                    logger.debug("[frontend] Shared secret:", Buffer.from(this.topicToSharedSecret[topic]).toString("hex"));
-                    const encryptedMessage = await createEncryptedJsonRpcRequest("hello", null, this.topicToSharedSecret[topic], topic);
-                    logger.debug("[frontend] Sending encrypted message:", encryptedMessage);
-                    wsClient.send(JSON.stringify(encryptedMessage));
-                    await Promise.all(this.onRequestReceivedCallbacks[topic].map((callback) => callback()));
-                    return;
-                }
-                // Handle encrypted messages
-                if (data.method === "encryptedMessage") {
-                    // Decode the payload from base64 to Uint8Array
-                    const payload = new Uint8Array(atob(data.params.payload)
-                        .split("")
-                        .map((c) => c.charCodeAt(0)));
-                    try {
-                        // Decrypt the payload using the shared secret
-                        const decrypted = await decrypt(payload, this.topicToSharedSecret[topic], topic);
-                        const decryptedJson = JSON.parse(decrypted);
-                        this.handleEncryptedMessage(topic, decryptedJson, data);
-                    }
-                    catch (error) {
-                        logger.error("[frontend] Error decrypting message:", error);
-                    }
-                    return;
-                }
-            }
-            catch (error) {
-                logger.error("[frontend] Error:", error);
-            }
         });
-        wsClient.onerror = (error) => {
-            logger.error("[frontend] WebSocket error:", error);
-        };
+        bridge.onSecureChannelEstablished(async () => {
+            logger.debug("Secure channel established");
+            await Promise.all(this.onRequestReceivedCallbacks[topic].map((callback) => callback()));
+        });
+        bridge.onSecureMessage(async (message) => {
+            logger.debug("Received message:", message);
+            this.handleEncryptedMessage(topic, message);
+        });
         return this.getZkPassportRequest(topic);
     }
     checkDiscloseBytesPublicInputs(proof, queryResult) {
@@ -1242,13 +1210,14 @@ export class ZKPassport {
         }
         return { isCorrect, queryResultErrors };
     }
-    checkScopeFromDisclosureProof(proofData, queryResultErrors, key, scope) {
+    checkScopeFromDisclosureProof(proofData, queryResultErrors, key, scope, chainId) {
         let isCorrect = true;
-        if (this.domain && getScopeHash(this.domain) !== BigInt(proofData.publicInputs[1])) {
+        if (this.domain &&
+            getServiceScopeHash(this.domain, chainId) !== BigInt(proofData.publicInputs[1])) {
             console.warn("The proof comes from a different domain than the one expected");
             isCorrect = false;
             queryResultErrors[key].scope = {
-                expected: `Scope: ${getScopeHash(this.domain).toString()}`,
+                expected: `Scope: ${getServiceScopeHash(this.domain, chainId).toString()}`,
                 received: `Scope: ${BigInt(proofData.publicInputs[1]).toString()}`,
                 message: "The proof comes from a different domain than the one expected",
             };
@@ -1292,7 +1261,7 @@ export class ZKPassport {
         }
         return { isCorrect, queryResultErrors };
     }
-    async checkPublicInputs(proofs, queryResult, validity, scope) {
+    async checkPublicInputs(proofs, queryResult, validity, scope, chainId) {
         let commitmentIn;
         let commitmentOut;
         let isCorrect = true;
@@ -1377,11 +1346,12 @@ export class ZKPassport {
                         message: "The proof does not verify all the requested conditions and information",
                     };
                 }
-                if (this.domain && getScopeHash(this.domain) !== getScopeFromOuterProof(proofData)) {
+                if (this.domain &&
+                    getServiceScopeHash(this.domain, chainId) !== getScopeFromOuterProof(proofData)) {
                     console.warn("The proof comes from a different domain than the one expected");
                     isCorrect = false;
                     queryResultErrors.outer.scope = {
-                        expected: `Scope: ${getScopeHash(this.domain).toString()}`,
+                        expected: `Scope: ${getServiceScopeHash(this.domain, chainId).toString()}`,
                         received: `Scope: ${getScopeFromOuterProof(proofData).toString()}`,
                         message: "The proof comes from a different domain than the one expected",
                     };
@@ -1896,10 +1866,21 @@ export class ZKPassport {
      * @param proofs The proofs to verify.
      * @param queryResult The query result to verify against
      * @param validity How many days ago should have the ID been last scanned by the user?
+     * @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)
      * @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, devMode = false, }) {
+    async verify({ proofs, queryResult, validity, scope, evmChain, devMode = false, }) {
+        // 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) {
+            return {
+                uniqueIdentifier: undefined,
+                verified: false,
+            };
+        }
         const formattedResult = queryResult;
         // Make sure to reconvert the dates to Date objects
         if (formattedResult.birthdate && formattedResult.birthdate.disclose) {
@@ -1913,7 +1894,8 @@ export class ZKPassport {
         let verified = true;
         let uniqueIdentifier;
         let queryResultErrors;
-        const { isCorrect, uniqueIdentifier: uniqueIdentifierFromPublicInputs, queryResultErrors: queryResultErrorsFromPublicInputs, } = await this.checkPublicInputs(proofs, formattedResult, validity, scope);
+        const chainId = evmChain ? getChainIdFromEVMChain(evmChain) : undefined;
+        const { isCorrect, uniqueIdentifier: uniqueIdentifierFromPublicInputs, queryResultErrors: queryResultErrorsFromPublicInputs, } = await this.checkPublicInputs(proofs, formattedResult, validity, scope, chainId);
         uniqueIdentifier = uniqueIdentifierFromPublicInputs;
         verified = isCorrect;
         queryResultErrors = isCorrect ? undefined : queryResultErrorsFromPublicInputs;
@@ -1991,7 +1973,7 @@ export class ZKPassport {
         if (network === "ethereum_sepolia") {
             return {
                 ...baseConfig,
-                address: "0x8c6982D77f7a8f60aE3133cA9b2FAA6f3e78c394",
+                address: "0xDfE02DFd5c208854884B58bFf6522De5c42F73E3",
             };
         }
         else if (network === "local_anvil") {
@@ -2140,7 +2122,7 @@ export class ZKPassport {
      * @returns The URL of the request.
      */
     getUrl(requestId) {
-        const pubkey = bytesToHex(this.topicToKeyPair[requestId].publicKey);
+        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}`;
@@ -2150,14 +2132,13 @@ export class ZKPassport {
      * @param requestId The request ID.
      */
     cancelRequest(requestId) {
-        if (this.topicToWebSocketClient[requestId]) {
-            this.topicToWebSocketClient[requestId].close();
-            delete this.topicToWebSocketClient[requestId];
+        if (this.topicToBridge[requestId]) {
+            this.topicToBridge[requestId].close();
+            delete this.topicToBridge[requestId];
         }
-        delete this.topicToKeyPair[requestId];
+        delete this.topicToPublicKey[requestId];
         delete this.topicToConfig[requestId];
         delete this.topicToLocalConfig[requestId];
-        delete this.topicToSharedSecret[requestId];
         delete this.topicToProofs[requestId];
         delete this.topicToExpectedProofCount[requestId];
         delete this.topicToFailedProofCount[requestId];
@@ -2173,7 +2154,7 @@ export class ZKPassport {
      * @notice Clears all requests.
      */
     clearAllRequests() {
-        for (const requestId in this.topicToWebSocketClient) {
+        for (const requestId in this.topicToBridge) {
             this.cancelRequest(requestId);
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zkpassport/sdk",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "description": "Privacy-preserving identity verification using passports and ID cards",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -42,8 +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.7.4",
+    "@zkpassport/utils": "^0.8.2",
     "buffer": "^6.0.3",
     "i18n-iso-countries": "^7.12.0",
     "pako": "^2.1.0",