@zkpassport/sdk 0.4.0 → 0.4.2

package/dist/esm/index.d.ts

@@ -1,11 +1,11 @@
-import { type DisclosableIDCredential, type IDCredential, type IDCredentialValue, type NumericalIDCredential, type ProofResult, type QueryResult, ProofMode } from "@zkpassport/utils";
+import { type DisclosableIDCredential, type IDCredential, type IDCredentialValue, type NumericalIDCredential, type ProofResult, type QueryResult, ProofMode, BoundData } from "@zkpassport/utils";
 export type QueryResultError<T> = {
     expected?: T;
     received?: T;
     message: string;
 };
 export type QueryResultErrors = {
-    [key in IDCredential | "sig_check_dsc" | "sig_check_id_data" | "data_check_integrity" | "outer" | "disclose"]: {
+    [key in IDCredential | "sig_check_dsc" | "sig_check_id_data" | "data_check_integrity" | "outer" | "disclose" | "bind"]: {
         disclose?: QueryResultError<string | number | Date>;
         gte?: QueryResultError<number | Date>;
         lte?: QueryResultError<number | Date>;
@@ -150,6 +150,12 @@ export type QueryBuilder = {
      * @param key The attribute to disclose.
      */
     disclose: (key: DisclosableIDCredential) => QueryBuilder;
+    /**
+     * Binds a value to the request.
+     * @param key The key of the value to bind.
+     * @param value The value to bind the request to.
+     */
+    bind: (key: keyof BoundData, value: BoundData[keyof BoundData]) => QueryBuilder;
     /**
      * Builds the request.
      *
@@ -199,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;
@@ -213,6 +219,8 @@ export declare class ZKPassport {
             privateKey: Uint8Array;
             publicKey: Uint8Array;
         };
+        cloudProverUrl?: string;
+        bridgeUrl?: string;
     }): Promise<QueryBuilder>;
     private checkDiscloseBytesPublicInputs;
     private checkAgePublicInputs;
@@ -224,6 +232,7 @@ export declare class ZKPassport {
     private checkIssuingCountryInclusionPublicInputs;
     private checkScopeFromDisclosureProof;
     private checkCertificateRegistryRoot;
+    private checkBindPublicInputs;
     private checkPublicInputs;
     /**
      * @notice Verify the proofs received from the mobile app.
@@ -273,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

@@ -1,5 +1,5 @@
 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, getServiceScopeHash, } 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, getBindEVMParameterCommitment, getBindParameterCommitment, formatBoundData, } from "@zkpassport/utils";
 import { bytesToHex } from "@noble/ciphers/utils";
 import { noLogger as logger } from "./logger";
 import i18en from "i18n-iso-countries/langs/en.json";
@@ -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") {
@@ -191,6 +192,9 @@ export class ZKPassport {
                 }
             }
         }
+        if (this.topicToConfig[topic].bind) {
+            neededCircuits.push("bind");
+        }
         // From the circuits needed, determine the expected proof count
         // There are at least 4 proofs, 3 base proofs and 1 disclosure proof minimum
         // Each separate needed circuit adds 1 disclosure proof
@@ -313,13 +317,17 @@ export class ZKPassport {
                 };
                 return this.getZkPassportRequest(topic);
             },
+            bind: (key, value) => {
+                this.topicToConfig[topic].bind = {
+                    ...this.topicToConfig[topic].bind,
+                    [key]: value,
+                };
+                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),
@@ -345,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] = {};
@@ -358,6 +367,8 @@ export class ZKPassport {
             purpose,
             scope,
             chainId: evmChain ? getChainIdFromEVMChain(evmChain) : undefined,
+            cloudProverUrl,
+            bridgeUrl,
         };
         this.topicToProofs[topic] = [];
         this.topicToExpectedProofCount[topic] = 0;
@@ -409,6 +420,7 @@ export class ZKPassport {
             fullname: {},
             document_number: {},
             outer: {},
+            bind: {},
         };
         let isCorrect = true;
         // We can't be certain that the disclosed data is for a passport or an ID card
@@ -721,6 +733,7 @@ export class ZKPassport {
             fullname: {},
             document_number: {},
             outer: {},
+            bind: {},
         };
         let isCorrect = true;
         const currentTime = new Date();
@@ -830,6 +843,7 @@ export class ZKPassport {
             fullname: {},
             document_number: {},
             outer: {},
+            bind: {},
         };
         let isCorrect = true;
         const currentTime = new Date();
@@ -933,6 +947,7 @@ export class ZKPassport {
             fullname: {},
             document_number: {},
             outer: {},
+            bind: {},
         };
         let isCorrect = true;
         const currentTime = new Date();
@@ -1036,6 +1051,7 @@ export class ZKPassport {
             fullname: {},
             document_number: {},
             outer: {},
+            bind: {},
         };
         let isCorrect = true;
         if (queryResult.nationality &&
@@ -1090,6 +1106,7 @@ export class ZKPassport {
             fullname: {},
             document_number: {},
             outer: {},
+            bind: {},
         };
         let isCorrect = true;
         if (queryResult.issuing_country &&
@@ -1144,6 +1161,7 @@ export class ZKPassport {
             fullname: {},
             document_number: {},
             outer: {},
+            bind: {},
         };
         let isCorrect = true;
         if (queryResult.nationality &&
@@ -1186,6 +1204,7 @@ export class ZKPassport {
             fullname: {},
             document_number: {},
             outer: {},
+            bind: {},
         };
         let isCorrect = true;
         if (queryResult.issuing_country &&
@@ -1261,6 +1280,51 @@ export class ZKPassport {
         }
         return { isCorrect, queryResultErrors };
     }
+    checkBindPublicInputs(queryResult, boundData) {
+        const queryResultErrors = {
+            sig_check_dsc: {},
+            sig_check_id_data: {},
+            data_check_integrity: {},
+            disclose: {},
+            age: {},
+            birthdate: {},
+            expiry_date: {},
+            document_type: {},
+            issuing_country: {},
+            gender: {},
+            nationality: {},
+            firstname: {},
+            lastname: {},
+            fullname: {},
+            document_number: {},
+            outer: {},
+            bind: {},
+        };
+        let isCorrect = true;
+        if (queryResult.bind) {
+            if (queryResult.bind.user_address?.toLowerCase().replace("0x", "") !==
+                boundData.user_address?.toLowerCase().replace("0x", "")) {
+                console.warn("Bound user address does not match the one from the query results");
+                isCorrect = false;
+                queryResultErrors.bind.eq = {
+                    expected: queryResult.bind.user_address,
+                    received: boundData.user_address,
+                    message: "Bound user address does not match the one from the query results",
+                };
+            }
+            if (queryResult.bind.custom_data?.trim().toLowerCase() !==
+                boundData.custom_data?.trim().toLowerCase()) {
+                console.warn("Bound custom data does not match the one from the query results");
+                isCorrect = false;
+                queryResultErrors.bind.eq = {
+                    expected: queryResult.bind.custom_data,
+                    received: boundData.custom_data,
+                    message: "Bound custom data does not match the one from the query results",
+                };
+            }
+        }
+        return { isCorrect, queryResultErrors };
+    }
     async checkPublicInputs(proofs, queryResult, validity, scope, chainId) {
         let commitmentIn;
         let commitmentOut;
@@ -1285,6 +1349,7 @@ export class ZKPassport {
             fullname: {},
             document_number: {},
             outer: {},
+            bind: {},
         };
         // Since the order is important for the commitments, we need to sort the proofs
         // by their expected order: root signature check -> ID signature check -> integrity check -> disclosure
@@ -1301,6 +1366,7 @@ export class ZKPassport {
                 "inclusion_check_nationality",
                 "exclusion_check_issuing_country",
                 "inclusion_check_issuing_country",
+                "bind",
             ];
             const getIndex = (proof) => {
                 const name = proof.name || "";
@@ -1537,6 +1603,27 @@ export class ZKPassport {
                         ...queryResultErrorsIssuingCountryExclusion,
                     };
                 }
+                else if (!!committedInputs?.bind) {
+                    const bindCommittedInputs = committedInputs?.bind;
+                    const bindParameterCommitment = isForEVM
+                        ? await getBindEVMParameterCommitment(formatBoundData(bindCommittedInputs.data))
+                        : await getBindParameterCommitment(formatBoundData(bindCommittedInputs.data));
+                    if (!paramCommitments.includes(bindParameterCommitment)) {
+                        console.warn("This proof does not verify the bound data");
+                        isCorrect = false;
+                        queryResultErrors.bind.commitment = {
+                            expected: `Bind parameter commitment: ${bindParameterCommitment.toString()}`,
+                            received: `Parameter commitments included: ${paramCommitments.join(", ")}`,
+                            message: "This proof does not verify the bound data",
+                        };
+                    }
+                    const { isCorrect: isCorrectBind, queryResultErrors: queryResultErrorsBind } = this.checkBindPublicInputs(queryResult, bindCommittedInputs.data);
+                    isCorrect = isCorrect && isCorrectBind;
+                    queryResultErrors = {
+                        ...queryResultErrors,
+                        ...queryResultErrorsBind,
+                    };
+                }
                 uniqueIdentifier = getNullifierFromOuterProof(proofData).toString(10);
             }
             else if (proof.name?.startsWith("sig_check_dsc")) {
@@ -1858,6 +1945,27 @@ export class ZKPassport {
                 };
                 uniqueIdentifier = getNullifierFromDisclosureProof(proofData).toString(10);
             }
+            else if (proof.name === "bind") {
+                const bindCommittedInputs = proof.committedInputs?.bind;
+                const paramCommittment = getParameterCommitmentFromDisclosureProof(proofData);
+                const calculatedParamCommitment = await getBindParameterCommitment(formatBoundData(bindCommittedInputs.data));
+                if (paramCommittment !== calculatedParamCommitment) {
+                    console.warn("The bound data does not match the one from the proof");
+                    isCorrect = false;
+                    queryResultErrors.bind.commitment = {
+                        expected: `Commitment: ${calculatedParamCommitment}`,
+                        received: `Commitment: ${paramCommittment}`,
+                        message: "The bound data does not match the one from the proof",
+                    };
+                }
+                const { isCorrect: isCorrectBind, queryResultErrors: queryResultErrorsBind } = this.checkBindPublicInputs(queryResult, bindCommittedInputs.data);
+                isCorrect = isCorrect && isCorrectBind;
+                queryResultErrors = {
+                    ...queryResultErrors,
+                    ...queryResultErrorsBind,
+                };
+                uniqueIdentifier = getNullifierFromDisclosureProof(proofData).toString(10);
+            }
         }
         return { isCorrect, uniqueIdentifier, queryResultErrors };
     }
@@ -1973,7 +2081,7 @@ export class ZKPassport {
         if (network === "ethereum_sepolia") {
             return {
                 ...baseConfig,
-                address: "0xDfE02DFd5c208854884B58bFf6522De5c42F73E3",
+                address: "0x5e4B11F7B7995F5Cee0134692a422b045091112F",
             };
         }
         else if (network === "local_anvil") {
@@ -2066,6 +2174,14 @@ export class ZKPassport {
                         value.discloseMask.map((x) => x.toString(16).padStart(2, "0")).join("") +
                         value.disclosedBytes.map((x) => x.toString(16).padStart(2, "0")).join("");
             }
+            else if (circuitName === "bind_evm") {
+                const value = proof.committedInputs[circuitName];
+                compressedCommittedInputs =
+                    ProofType.BIND.toString(16).padStart(2, "0") +
+                        rightPadArrayWithZeros(formatBoundData(value.data), 500)
+                            .map((x) => x.toString(16).padStart(2, "0"))
+                            .join("");
+            }
             else {
                 throw new Error(`Unsupported circuit for EVM verification: ${circuitName}`);
             }
@@ -2116,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.0",
+  "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.8.2",
+    "@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",