@zkpassport/sdk 0.4.3 → 0.5.0

package/dist/cjs/index.js

@@ -13,7 +13,7 @@ const utils_3 = require("@noble/hashes/utils");
 const ZKPassportVerifier_json_1 = tslib_1.__importDefault(require("./assets/abi/ZKPassportVerifier.json"));
 const registry_1 = require("@zkpassport/registry");
 const bridge_1 = require("@obsidion/bridge");
-const VERSION = "0.4.2";
+const VERSION = "0.5.0";
 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") {
@@ -292,6 +292,9 @@ class ZKPassport {
             },
             gte: (key, value) => {
                 numericalCompare("gte", key, value, topic, this.topicToConfig);
+                if (key === "age" && (value < 1 || value >= 100)) {
+                    throw new Error("Age must be between 1 and 99 (inclusive)");
+                }
                 return this.getZkPassportRequest(topic);
             },
             /*gt: <T extends NumericalIDCredential>(key: T, value: IDCredentialValue<T>) => {
@@ -1268,17 +1271,8 @@ class ZKPassport {
             // Maintained certificate registry settled onchain
             // Here we use Ethereum Sepolia
             const registryClient = new registry_1.RegistryClient({ chainId: 11155111 });
-            await registryClient.getCertificates(`0x${root.padStart(64, "0")}`);
-        }
-        catch (error) {
-            console.warn(error);
-            // Check the legacy static roots that were used before the registry was deployed onchain
-            const VALID_CERTIFICATE_REGISTRY_ROOT = [
-                BigInt("20192042006788880778219739574377003123593792072535937278552252195461520776494"),
-                BigInt("21301853597069384763054217328384418971999152625381818922211526730996340553696"),
-                BigInt("10839898448097753834842514286432152806152415606387598803678317315409344029817"),
-            ];
-            if (!VALID_CERTIFICATE_REGISTRY_ROOT.includes(BigInt(root))) {
+            const isValid = await registryClient.isCertificateRootValid(root);
+            if (!isValid) {
                 console.warn("The ID was signed by an unrecognized root certificate");
                 isCorrect = false;
                 queryResultErrors[outer ? "outer" : "sig_check_dsc"].certificate = {
@@ -1288,6 +1282,43 @@ class ZKPassport {
                 };
             }
         }
+        catch (error) {
+            console.warn(error);
+            console.warn("The ID was signed by an unrecognized root certificate");
+            isCorrect = false;
+            queryResultErrors[outer ? "outer" : "sig_check_dsc"].certificate = {
+                expected: `A valid root from ZKPassport Registry`,
+                received: `Got invalid certificate registry root: ${root}`,
+                message: "The ID was signed by an unrecognized root certificate",
+            };
+        }
+        return { isCorrect, queryResultErrors };
+    }
+    async checkCircuitRegistryRoot(root, queryResultErrors) {
+        let isCorrect = true;
+        try {
+            const registryClient = new registry_1.RegistryClient({ chainId: 11155111 });
+            const isValid = await registryClient.isCircuitRootValid(root);
+            if (!isValid) {
+                console.warn("The proof uses unrecognized circuits");
+                isCorrect = false;
+                queryResultErrors.outer.circuit = {
+                    expected: `A valid circuit from ZKPassport Registry`,
+                    received: `Got invalid circuit registry root: ${root}`,
+                    message: "The proof uses an unrecognized circuit",
+                };
+            }
+        }
+        catch (error) {
+            console.warn(error);
+            console.warn("The proof uses unrecognized circuits");
+            isCorrect = false;
+            queryResultErrors.outer.circuit = {
+                expected: `A valid circuit from ZKPassport Registry`,
+                received: `Got invalid circuit registry root: ${root}`,
+                message: "The proof uses an unrecognized circuit",
+            };
+        }
         return { isCorrect, queryResultErrors };
     }
     checkBindPublicInputs(queryResult, boundData) {
@@ -1395,6 +1426,13 @@ class ZKPassport {
                     ...queryResultErrors,
                     ...queryResultErrorsCertificateRegistryRoot,
                 };
+                const circuitRegistryRoot = (0, utils_1.getCircuitRegistryRootFromOuterProof)(proofData);
+                const { isCorrect: isCorrectCircuitRegistryRoot, queryResultErrors: queryResultErrorsCircuitRegistryRoot, } = await this.checkCircuitRegistryRoot(circuitRegistryRoot.toString(16), queryResultErrors);
+                isCorrect = isCorrect && isCorrectCircuitRegistryRoot;
+                queryResultErrors = {
+                    ...queryResultErrors,
+                    ...queryResultErrorsCircuitRegistryRoot,
+                };
                 const currentDate = (0, utils_1.getCurrentDateFromOuterProof)(proofData);
                 const todayToCurrentDate = today.getTime() - currentDate.getTime();
                 const differenceInDays = validity ?? 180;
@@ -2026,9 +2064,14 @@ class ZKPassport {
         }
         // Only proceed with the proof verification if the public inputs are correct
         if (verified) {
+            const registryClient = new registry_1.RegistryClient({ chainId: 11155111 });
+            const circuitManifest = await registryClient.getCircuitManifest(undefined, {
+                // We assume all proofs have the same version
+                version: proofs[0].version,
+            });
             for (const proof of proofs) {
                 const proofData = (0, utils_1.getProofData)(proof.proof, (0, utils_1.getNumberOfPublicInputs)(proof.name));
-                const hostedPackagedCircuit = await (0, utils_1.getHostedPackagedCircuitByName)(proof.version, proof.name);
+                const hostedPackagedCircuit = await registryClient.getPackagedCircuit(proof.name, circuitManifest);
                 if (proof.name?.startsWith("outer_evm")) {
                     try {
                         const { createPublicClient, http } = await Promise.resolve().then(() => tslib_1.__importStar(require("viem")));
@@ -2091,7 +2134,7 @@ class ZKPassport {
         if (network === "ethereum_sepolia") {
             return {
                 ...baseConfig,
-                address: "0x5e4B11F7B7995F5Cee0134692a422b045091112F",
+                address: "0xEE9F10f38319eAE2730dBa28fB09081dB806c5E5",
             };
         }
         else if (network === "local_anvil") {
@@ -2197,7 +2240,7 @@ class ZKPassport {
             }
             committedInputs.push({ circuitName, inputs: compressedCommittedInputs });
         }
-        const parameterCommitments = proofData.publicInputs.slice(11, proofData.publicInputs.length - 1);
+        const parameterCommitments = proofData.publicInputs.slice(12, proofData.publicInputs.length - 1);
         let compressedCommittedInputs = "";
         let committedInputCountsArray = [];
         for (const commitment of parameterCommitments) {