@zkpassport/sdk 0.2.9 → 0.2.11

package/dist/cjs/index.d.ts

@@ -125,13 +125,13 @@ export type QueryBuilder = {
      * @param key The attribute to compare.
      * @param value The list of values to check inclusion against.
      */
-    in: <T extends "nationality">(key: T, value: IDCredentialValue<T>[]) => QueryBuilder;
+    in: <T extends "nationality" | "issuing_country">(key: T, value: IDCredentialValue<T>[]) => QueryBuilder;
     /**
      * Requires this attribute to be excluded from the provided list.
      * @param key The attribute to compare.
      * @param value The list of values to check exclusion against.
      */
-    out: <T extends "nationality">(key: T, value: IDCredentialValue<T>[]) => QueryBuilder;
+    out: <T extends "nationality" | "issuing_country">(key: T, value: IDCredentialValue<T>[]) => QueryBuilder;
     /**
      * Requires this attribute to be disclosed.
      * @param key The attribute to disclose.
@@ -200,13 +200,17 @@ export declare class ZKPassport {
     private checkPublicInputs;
     /**
      * @notice Verify the proofs received from the mobile app.
-     * @param requestId The request ID.
      * @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?
      * @returns An object containing the unique identifier associated to the user
      * and a boolean indicating whether the proofs were successfully verified.
      */
-    verify(requestId: string, proofs?: Array<ProofResult>, queryResult?: QueryResult): Promise<{
+    verify({ proofs, queryResult, validity, }: {
+        proofs: Array<ProofResult>;
+        queryResult: QueryResult;
+        validity?: number;
+    }): Promise<{
         uniqueIdentifier: string | undefined;
         verified: boolean;
         queryResultErrors?: QueryResultErrors;

package/dist/cjs/index.js

@@ -11,8 +11,6 @@ const json_rpc_1 = require("./json-rpc");
 const encryption_1 = require("./encryption");
 const logger_1 = require("./logger");
 const pako_1 = require("pako");
-//import initNoirC from '@noir-lang/noirc_abi'
-//import initACVM from '@noir-lang/acvm_js'
 const en_json_1 = tslib_1.__importDefault(require("i18n-iso-countries/langs/en.json"));
 const buffer_1 = require("buffer/");
 // If Buffer is not defined, then we use the Buffer from the buffer package
@@ -94,18 +92,17 @@ class ZKPassport {
         }
         this.domain = _domain || window.location.hostname;
     }
-    /*private async initWasmVerifier() {
-      const acvm = await import('@noir-lang/acvm_js/web/acvm_js_bg.wasm')
-      const noirc = await import('@noir-lang/noirc_abi/web/noirc_abi_wasm_bg.wasm')
-      await Promise.all([initACVM(acvm), initNoirC(noirc)])
-      this.wasmVerifierInit = true
-    }*/
     async handleResult(topic) {
         const result = this.topicToResults[topic];
         // Clear the results straight away to avoid concurrency issues
         delete this.topicToResults[topic];
         // Verify the proofs and extract the unique identifier (aka nullifier) and the verification result
-        const { uniqueIdentifier, verified, queryResultErrors } = await this.verify(topic, this.topicToProofs[topic], result);
+        const { uniqueIdentifier, verified, queryResultErrors } = await this.verify({
+            proofs: this.topicToProofs[topic],
+            queryResult: result,
+            validity: this.topicToLocalConfig[topic]?.validity,
+        });
+        delete this.topicToProofs[topic];
         const hasFailedProofs = this.topicToFailedProofCount[topic] > 0;
         await Promise.all(this.onResultCallbacks[topic].map((callback) => callback({
             // If there are failed proofs, we don't return the unique identifier
@@ -151,13 +148,23 @@ class ZKPassport {
                         }
                         break;
                     case "in":
-                        if (field === "nationality" && !neededCircuits.includes("inclusion_check_country")) {
-                            neededCircuits.push("inclusion_check_country");
+                        if (field === "nationality" &&
+                            !neededCircuits.includes("inclusion_check_nationality")) {
+                            neededCircuits.push("inclusion_check_nationality");
+                        }
+                        else if (field === "issuing_country" &&
+                            !neededCircuits.includes("inclusion_check_issuing_country")) {
+                            neededCircuits.push("inclusion_check_issuing_country");
                         }
                         break;
                     case "out":
-                        if (field === "nationality" && !neededCircuits.includes("exclusion_check_country")) {
-                            neededCircuits.push("exclusion_check_country");
+                        if (field === "nationality" &&
+                            !neededCircuits.includes("exclusion_check_nationality")) {
+                            neededCircuits.push("exclusion_check_nationality");
+                        }
+                        else if (field === "issuing_country" &&
+                            !neededCircuits.includes("exclusion_check_issuing_country")) {
+                            neededCircuits.push("exclusion_check_issuing_country");
                         }
                         break;
                 }
@@ -391,7 +398,7 @@ class ZKPassport {
         };
         return this.getZkPassportRequest(topic);
     }
-    async checkPublicInputs(proofs, queryResult, topic) {
+    async checkPublicInputs(proofs, queryResult, validity) {
         let commitmentIn;
         let commitmentOut;
         let isCorrect = true;
@@ -428,8 +435,10 @@ class ZKPassport {
                 "compare_age",
                 "compare_birthdate",
                 "compare_expiry",
-                "exclusion_check_country",
-                "inclusion_check_country",
+                "exclusion_check_nationality",
+                "inclusion_check_nationality",
+                "exclusion_check_issuing_country",
+                "inclusion_check_issuing_country",
             ];
             const getIndex = (proof) => {
                 const name = proof.name || "";
@@ -479,14 +488,15 @@ class ZKPassport {
                 commitmentOut = (0, utils_1.getCommitmentOutFromIntegrityProof)(proofData);
                 const currentDate = (0, utils_1.getCurrentDateFromIntegrityProof)(proofData);
                 const todayToCurrentDate = today.getTime() - currentDate.getTime();
-                const expectedDifference = this.topicToLocalConfig[topic]?.validity * 86400000;
+                const differenceInDays = validity ?? 180;
+                const expectedDifference = differenceInDays * 86400000;
                 const actualDifference = today.getTime() - (today.getTime() - expectedDifference);
                 // The ID should not expire within the next 6 months (or whatever the custom value is)
                 if (todayToCurrentDate >= actualDifference) {
-                    console.warn(`The date used to check the validity of the ID is older than ${this.topicToLocalConfig[topic]?.validity} days. You can ask the user to rescan their ID or ask them to disclose their expiry date`);
+                    console.warn(`The date used to check the validity of the ID is older than ${differenceInDays} days. You can ask the user to rescan their ID or ask them to disclose their expiry date`);
                     isCorrect = false;
                     queryResultErrors.data_check_integrity.date = {
-                        expected: `Difference: ${this.topicToLocalConfig[topic]?.validity} days`,
+                        expected: `Difference: ${differenceInDays} days`,
                         received: `Difference: ${Math.round(todayToCurrentDate / 86400000)} days`,
                         message: "The date used to check the validity of the ID is older than the validity period",
                     };
@@ -516,7 +526,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.document_type.eq = {
                             expected: `${queryResult.document_type.eq.expected}`,
-                            received: `${disclosedDataPassport.documentType}`,
+                            received: `${disclosedDataPassport.documentType ?? disclosedDataIDCard.documentType}`,
                             message: "Document type does not match the expected document type",
                         };
                     }
@@ -525,7 +535,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.document_type.disclose = {
                             expected: `${queryResult.document_type.disclose?.result}`,
-                            received: `${disclosedDataIDCard.documentType}`,
+                            received: `${disclosedDataIDCard.documentType ?? disclosedDataPassport.documentType}`,
                             message: "Document type does not match the disclosed document type in query result",
                         };
                     }
@@ -541,7 +551,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.birthdate.eq = {
                             expected: `${queryResult.birthdate.eq.expected.toISOString()}`,
-                            received: `${birthdatePassport.toISOString()}`,
+                            received: `${birthdatePassport?.toISOString() ?? birthdateIDCard?.toISOString()}`,
                             message: "Birthdate does not match the expected birthdate",
                         };
                     }
@@ -552,7 +562,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.birthdate.disclose = {
                             expected: `${queryResult.birthdate.disclose.result.toISOString()}`,
-                            received: `${birthdatePassport.toISOString()}`,
+                            received: `${birthdatePassport?.toISOString() ?? birthdateIDCard?.toISOString()}`,
                             message: "Birthdate does not match the disclosed birthdate in query result",
                         };
                     }
@@ -568,7 +578,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.expiry_date.eq = {
                             expected: `${queryResult.expiry_date.eq.expected.toISOString()}`,
-                            received: `${expiryDatePassport.toISOString()}`,
+                            received: `${expiryDatePassport?.toISOString() ?? expiryDateIDCard?.toISOString()}`,
                             message: "Expiry date does not match the expected expiry date",
                         };
                     }
@@ -579,7 +589,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.expiry_date.disclose = {
                             expected: `${queryResult.expiry_date.disclose.result.toISOString()}`,
-                            received: `${expiryDatePassport.toISOString()}`,
+                            received: `${expiryDatePassport?.toISOString() ?? expiryDateIDCard?.toISOString()}`,
                             message: "Expiry date does not match the disclosed expiry date in query result",
                         };
                     }
@@ -595,7 +605,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.nationality.eq = {
                             expected: `${queryResult.nationality.eq.expected}`,
-                            received: `${nationalityPassport}`,
+                            received: `${nationalityPassport ?? nationalityIDCard}`,
                             message: "Nationality does not match the expected nationality",
                         };
                     }
@@ -606,7 +616,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.nationality.disclose = {
                             expected: `${queryResult.nationality.disclose.result}`,
-                            received: `${nationalityPassport}`,
+                            received: `${nationalityPassport ?? nationalityIDCard}`,
                             message: "Nationality does not match the disclosed nationality in query result",
                         };
                     }
@@ -622,7 +632,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.document_number.eq = {
                             expected: `${queryResult.document_number.eq.expected}`,
-                            received: `${documentNumberPassport}`,
+                            received: `${documentNumberPassport ?? documentNumberIDCard}`,
                             message: "Document number does not match the expected document number",
                         };
                     }
@@ -633,7 +643,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.document_number.disclose = {
                             expected: `${queryResult.document_number.disclose.result}`,
-                            received: `${documentNumberPassport}`,
+                            received: `${documentNumberPassport ?? documentNumberIDCard}`,
                             message: "Document number does not match the disclosed document number in query result",
                         };
                     }
@@ -649,7 +659,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.gender.eq = {
                             expected: `${queryResult.gender.eq.expected}`,
-                            received: `${genderPassport}`,
+                            received: `${genderPassport ?? genderIDCard}`,
                             message: "Gender does not match the expected gender",
                         };
                     }
@@ -660,7 +670,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.gender.disclose = {
                             expected: `${queryResult.gender.disclose.result}`,
-                            received: `${genderPassport}`,
+                            received: `${genderPassport ?? genderIDCard}`,
                             message: "Gender does not match the disclosed gender in query result",
                         };
                     }
@@ -676,7 +686,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.issuing_country.eq = {
                             expected: `${queryResult.issuing_country.eq.expected}`,
-                            received: `${issuingCountryPassport}`,
+                            received: `${issuingCountryPassport ?? issuingCountryIDCard}`,
                             message: "Issuing country does not match the expected issuing country",
                         };
                     }
@@ -687,7 +697,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.issuing_country.disclose = {
                             expected: `${queryResult.issuing_country.disclose.result}`,
-                            received: `${issuingCountryPassport}`,
+                            received: `${issuingCountryPassport ?? issuingCountryIDCard}`,
                             message: "Issuing country does not match the disclosed issuing country in query result",
                         };
                     }
@@ -705,7 +715,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.fullname.eq = {
                             expected: `${queryResult.fullname.eq.expected}`,
-                            received: `${fullnamePassport}`,
+                            received: `${fullnamePassport ?? fullnameIDCard}`,
                             message: "Fullname does not match the expected fullname",
                         };
                     }
@@ -718,7 +728,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.fullname.disclose = {
                             expected: `${queryResult.fullname.disclose.result}`,
-                            received: `${fullnamePassport}`,
+                            received: `${fullnamePassport ?? fullnameIDCard}`,
                             message: "Fullname does not match the disclosed fullname in query result",
                         };
                     }
@@ -741,7 +751,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.firstname.eq = {
                             expected: `${queryResult.firstname.eq.expected}`,
-                            received: `${firstnamePassport}`,
+                            received: `${firstnamePassport ?? firstnameIDCard}`,
                             message: "Firstname does not match the expected firstname",
                         };
                     }
@@ -754,7 +764,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.firstname.disclose = {
                             expected: `${queryResult.firstname.disclose.result}`,
-                            received: `${firstnamePassport}`,
+                            received: `${firstnamePassport ?? firstnameIDCard}`,
                             message: "Firstname does not match the disclosed firstname in query result",
                         };
                     }
@@ -777,7 +787,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.lastname.eq = {
                             expected: `${queryResult.lastname.eq.expected}`,
-                            received: `${lastnamePassport}`,
+                            received: `${lastnamePassport ?? lastnameIDCard}`,
                             message: "Lastname does not match the expected lastname",
                         };
                     }
@@ -790,7 +800,7 @@ class ZKPassport {
                         isCorrect = false;
                         queryResultErrors.lastname.disclose = {
                             expected: `${queryResult.lastname.disclose.result}`,
-                            received: `${lastnamePassport}`,
+                            received: `${lastnamePassport ?? lastnameIDCard}`,
                             message: "Lastname does not match the disclosed lastname in query result",
                         };
                     }
@@ -894,7 +904,7 @@ class ZKPassport {
                         message: "Current date in the proof is too old",
                     };
                 }
-                uniqueIdentifier = (0, utils_1.getCommitmentInFromDisclosureProof)(proofData).toString(10);
+                uniqueIdentifier = (0, utils_1.getNullifierFromDisclosureProof)(proofData).toString(10);
             }
             else if (proof.name === "compare_birthdate") {
                 commitmentIn = (0, utils_1.getCommitmentInFromDisclosureProof)(proofData);
@@ -975,7 +985,7 @@ class ZKPassport {
                         message: "Birthdate is not set in the query result",
                     };
                 }
-                uniqueIdentifier = (0, utils_1.getCommitmentInFromDisclosureProof)(proofData).toString(10);
+                uniqueIdentifier = (0, utils_1.getNullifierFromDisclosureProof)(proofData).toString(10);
             }
             else if (proof.name === "compare_expiry") {
                 commitmentIn = (0, utils_1.getCommitmentInFromDisclosureProof)(proofData);
@@ -1058,15 +1068,15 @@ class ZKPassport {
                 }
                 uniqueIdentifier = (0, utils_1.getNullifierFromDisclosureProof)(proofData).toString(10);
             }
-            else if (proof.name === "exclusion_check_country") {
+            else if (proof.name === "exclusion_check_nationality") {
                 commitmentIn = (0, utils_1.getCommitmentInFromDisclosureProof)(proofData);
                 if (commitmentIn !== commitmentOut) {
-                    console.warn("Failed to check the link between the validity of the ID and the country exclusion check");
+                    console.warn("Failed to check the link between the validity of the ID and the nationality exclusion check");
                     isCorrect = false;
                     queryResultErrors.nationality.commitment = {
                         expected: `Commitment: ${commitmentOut}`,
                         received: `Commitment: ${commitmentIn}`,
-                        message: "Failed to check the link between the validity of the ID and the country exclusion check",
+                        message: "Failed to check the link between the validity of the ID and the nationality exclusion check",
                     };
                 }
                 const countryList = (0, utils_1.getCountryListFromExclusionProof)(proofData);
@@ -1074,12 +1084,12 @@ class ZKPassport {
                     queryResult.nationality.out &&
                     queryResult.nationality.out.result) {
                     if (!queryResult.nationality.out.expected?.every((country) => countryList.includes(country))) {
-                        console.warn("Country exclusion list does not match the one from the query results");
+                        console.warn("Nationality exclusion list does not match the one from the query results");
                         isCorrect = false;
                         queryResultErrors.nationality.out = {
                             expected: queryResult.nationality.out.expected,
                             received: countryList,
-                            message: "Country exclusion list does not match the one from the query results",
+                            message: "Nationality exclusion list does not match the one from the query results",
                         };
                     }
                 }
@@ -1104,15 +1114,61 @@ class ZKPassport {
                 }
                 uniqueIdentifier = (0, utils_1.getNullifierFromDisclosureProof)(proofData).toString(10);
             }
-            else if (proof.name === "inclusion_check_country") {
+            else if (proof.name === "exclusion_check_issuing_country") {
+                commitmentIn = (0, utils_1.getCommitmentInFromDisclosureProof)(proofData);
+                if (commitmentIn !== commitmentOut) {
+                    console.warn("Failed to check the link between the validity of the ID and the issuing country exclusion check");
+                    isCorrect = false;
+                    queryResultErrors.nationality.commitment = {
+                        expected: `Commitment: ${commitmentOut}`,
+                        received: `Commitment: ${commitmentIn}`,
+                        message: "Failed to check the link between the validity of the ID and the issuing country exclusion check",
+                    };
+                }
+                const countryList = (0, utils_1.getCountryListFromExclusionProof)(proofData);
+                if (queryResult.issuing_country &&
+                    queryResult.issuing_country.out &&
+                    queryResult.issuing_country.out.result) {
+                    if (!queryResult.issuing_country.out.expected?.every((country) => countryList.includes(country))) {
+                        console.warn("Issuing country exclusion list does not match the one from the query results");
+                        isCorrect = false;
+                        queryResultErrors.issuing_country.out = {
+                            expected: queryResult.issuing_country.out.expected,
+                            received: countryList,
+                            message: "Issuing country exclusion list does not match the one from the query results",
+                        };
+                    }
+                }
+                else if (!queryResult.issuing_country || !queryResult.issuing_country.out) {
+                    console.warn("Issuing country exclusion is not set in the query result");
+                    isCorrect = false;
+                    queryResultErrors.issuing_country.out = {
+                        message: "Issuing country exclusion is not set in the query result",
+                    };
+                }
+                // Check the countryList is in ascending order
+                // If the prover doesn't use a sorted list then the proof cannot be trusted
+                // as it is requirement in the circuit for the exclusion check to work
+                for (let i = 1; i < countryList.length; i++) {
+                    if (countryList[i] < countryList[i - 1]) {
+                        console.warn("The issuing country exclusion list has not been sorted, and thus the proof cannot be trusted");
+                        isCorrect = false;
+                        queryResultErrors.issuing_country.out = {
+                            message: "The issuing country exclusion list has not been sorted, and thus the proof cannot be trusted",
+                        };
+                    }
+                }
+                uniqueIdentifier = (0, utils_1.getNullifierFromDisclosureProof)(proofData).toString(10);
+            }
+            else if (proof.name === "inclusion_check_nationality") {
                 commitmentIn = (0, utils_1.getCommitmentInFromDisclosureProof)(proofData);
                 if (commitmentIn !== commitmentOut) {
-                    console.warn("Failed to check the link between the validity of the ID and the country inclusion check");
+                    console.warn("Failed to check the link between the validity of the ID and the nationality inclusion check");
                     isCorrect = false;
                     queryResultErrors.nationality.commitment = {
                         expected: `Commitment: ${commitmentOut}`,
                         received: `Commitment: ${commitmentIn}`,
-                        message: "Failed to check the link between the validity of the ID and the country inclusion check",
+                        message: "Failed to check the link between the validity of the ID and the nationality inclusion check",
                     };
                 }
                 const countryList = (0, utils_1.getCountryListFromInclusionProof)(proofData);
@@ -1120,12 +1176,12 @@ class ZKPassport {
                     queryResult.nationality.in &&
                     queryResult.nationality.in.result) {
                     if (!queryResult.nationality.in.expected?.every((country) => countryList.includes(country))) {
-                        console.warn("Country inclusion list does not match the one from the query results");
+                        console.warn("Nationality inclusion list does not match the one from the query results");
                         isCorrect = false;
                         queryResultErrors.nationality.in = {
                             expected: queryResult.nationality.in.expected,
                             received: countryList,
-                            message: "Country inclusion list does not match the one from the query results",
+                            message: "Nationality inclusion list does not match the one from the query results",
                         };
                     }
                 }
@@ -1138,40 +1194,64 @@ class ZKPassport {
                 }
                 uniqueIdentifier = (0, utils_1.getNullifierFromDisclosureProof)(proofData).toString(10);
             }
+            else if (proof.name === "inclusion_check_issuing_country") {
+                commitmentIn = (0, utils_1.getCommitmentInFromDisclosureProof)(proofData);
+                if (commitmentIn !== commitmentOut) {
+                    console.warn("Failed to check the link between the validity of the ID and the issuing country inclusion check");
+                    isCorrect = false;
+                    queryResultErrors.nationality.commitment = {
+                        expected: `Commitment: ${commitmentOut}`,
+                        received: `Commitment: ${commitmentIn}`,
+                        message: "Failed to check the link between the validity of the ID and the issuing country inclusion check",
+                    };
+                }
+                const countryList = (0, utils_1.getCountryListFromInclusionProof)(proofData);
+                if (queryResult.issuing_country &&
+                    queryResult.issuing_country.in &&
+                    queryResult.issuing_country.in.result) {
+                    if (!queryResult.issuing_country.in.expected?.every((country) => countryList.includes(country))) {
+                        console.warn("Issuing country inclusion list does not match the one from the query results");
+                        isCorrect = false;
+                        queryResultErrors.issuing_country.in = {
+                            expected: queryResult.issuing_country.in.expected,
+                            received: countryList,
+                            message: "Issuing country inclusion list does not match the one from the query results",
+                        };
+                    }
+                }
+                else if (!queryResult.issuing_country || !queryResult.issuing_country.in) {
+                    console.warn("Issuing country inclusion is not set in the query result");
+                    isCorrect = false;
+                    queryResultErrors.issuing_country.in = {
+                        message: "Issuing country inclusion is not set in the query result",
+                    };
+                }
+                uniqueIdentifier = (0, utils_1.getNullifierFromDisclosureProof)(proofData).toString(10);
+            }
         }
         return { isCorrect, uniqueIdentifier, queryResultErrors };
     }
     /**
      * @notice Verify the proofs received from the mobile app.
-     * @param requestId The request ID.
      * @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?
      * @returns An object containing the unique identifier associated to the user
      * and a boolean indicating whether the proofs were successfully verified.
      */
-    async verify(requestId, proofs, queryResult) {
-        let proofsToVerify = proofs;
-        // There is a minimum of 4 subproofs to make a complete proof
-        if (!proofs || proofs.length < 4) {
-            proofsToVerify = this.topicToProofs[requestId];
-        }
+    async verify({ proofs, queryResult, validity, }) {
         const { BarretenbergVerifier } = await Promise.resolve().then(() => tslib_1.__importStar(require("@aztec/bb.js")));
         const verifier = new BarretenbergVerifier();
-        /*if (!this.wasmVerifierInit) {
-          await this.initWasmVerifier()
-        }*/
         let verified = true;
         let uniqueIdentifier;
         let queryResultErrors;
-        if (queryResult) {
-            const { isCorrect, uniqueIdentifier: uniqueIdentifierFromPublicInputs, queryResultErrors: queryResultErrorsFromPublicInputs, } = await this.checkPublicInputs(proofsToVerify, queryResult, requestId);
-            uniqueIdentifier = uniqueIdentifierFromPublicInputs;
-            verified = isCorrect;
-            queryResultErrors = isCorrect ? undefined : queryResultErrorsFromPublicInputs;
-        }
+        const { isCorrect, uniqueIdentifier: uniqueIdentifierFromPublicInputs, queryResultErrors: queryResultErrorsFromPublicInputs, } = await this.checkPublicInputs(proofs, queryResult, validity);
+        uniqueIdentifier = uniqueIdentifierFromPublicInputs;
+        verified = isCorrect;
+        queryResultErrors = isCorrect ? undefined : queryResultErrorsFromPublicInputs;
         // Only proceed with the proof verification if the public inputs are correct
-        if (verified && queryResult) {
-            for (const proof of proofsToVerify) {
+        if (verified) {
+            for (const proof of proofs) {
                 const proofData = (0, utils_1.getProofData)(proof.proof, true);
                 const hostedPackagedCircuit = await (0, utils_1.getHostedPackagedCircuitByName)(proof.version, proof.name);
                 const vkeyBytes = buffer_1.Buffer.from(hostedPackagedCircuit.vkey, "base64");
@@ -1189,7 +1269,8 @@ class ZKPassport {
                 }
             }
         }
-        this.topicToProofs[requestId] = [];
+        // If the proofs are not verified, we don't return the unique identifier
+        uniqueIdentifier = verified ? uniqueIdentifier : undefined;
         return { uniqueIdentifier, verified, queryResultErrors };
     }
     /**

package/dist/esm/index.d.ts

@@ -125,13 +125,13 @@ export type QueryBuilder = {
      * @param key The attribute to compare.
      * @param value The list of values to check inclusion against.
      */
-    in: <T extends "nationality">(key: T, value: IDCredentialValue<T>[]) => QueryBuilder;
+    in: <T extends "nationality" | "issuing_country">(key: T, value: IDCredentialValue<T>[]) => QueryBuilder;
     /**
      * Requires this attribute to be excluded from the provided list.
      * @param key The attribute to compare.
      * @param value The list of values to check exclusion against.
      */
-    out: <T extends "nationality">(key: T, value: IDCredentialValue<T>[]) => QueryBuilder;
+    out: <T extends "nationality" | "issuing_country">(key: T, value: IDCredentialValue<T>[]) => QueryBuilder;
     /**
      * Requires this attribute to be disclosed.
      * @param key The attribute to disclose.
@@ -200,13 +200,17 @@ export declare class ZKPassport {
     private checkPublicInputs;
     /**
      * @notice Verify the proofs received from the mobile app.
-     * @param requestId The request ID.
      * @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?
      * @returns An object containing the unique identifier associated to the user
      * and a boolean indicating whether the proofs were successfully verified.
      */
-    verify(requestId: string, proofs?: Array<ProofResult>, queryResult?: QueryResult): Promise<{
+    verify({ proofs, queryResult, validity, }: {
+        proofs: Array<ProofResult>;
+        queryResult: QueryResult;
+        validity?: number;
+    }): Promise<{
         uniqueIdentifier: string | undefined;
         verified: boolean;
         queryResultErrors?: QueryResultErrors;