@zkpassport/sdk 0.2.15 → 0.3.1

package/dist/esm/index.d.ts

@@ -1,11 +1,11 @@
-import { type DisclosableIDCredential, type IDCredential, type IDCredentialValue, type NumericalIDCredential, type ProofResult, type QueryResult } from "@zkpassport/utils";
+import { type DisclosableIDCredential, type IDCredential, type IDCredentialValue, type NumericalIDCredential, type ProofResult, type QueryResult, ProofMode } 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" | "disclose"]: {
+    [key in IDCredential | "sig_check_dsc" | "sig_check_id_data" | "data_check_integrity" | "outer" | "disclose"]: {
         disclose?: QueryResultError<string | number | Date>;
         gte?: QueryResultError<number | Date>;
         lte?: QueryResultError<number | Date>;
@@ -17,8 +17,20 @@ export type QueryResultErrors = {
         commitment?: QueryResultError<string>;
         date?: QueryResultError<string>;
         certificate?: QueryResultError<string>;
+        scope?: QueryResultError<string>;
     };
 };
+export type SolidityVerifierParameters = {
+    vkeyHash: string;
+    proof: string;
+    publicInputs: string[];
+    committedInputs: string;
+    committedInputCounts: number[];
+    validityPeriodInDays: number;
+    scope: string;
+    subscope: string;
+};
+export type EVMChain = "ethereum_sepolia" | "local_anvil";
 export type * from "@zkpassport/utils";
 export { SANCTIONED_COUNTRIES, EU_COUNTRIES, EEA_COUNTRIES, SCHENGEN_COUNTRIES, ASEAN_COUNTRIES, MERCOSUR_COUNTRIES, } from "@zkpassport/utils";
 export type QueryBuilderResult = {
@@ -185,11 +197,12 @@ export declare class ZKPassport {
      * @param validity How many days ago should have the ID been last scanned by the user?
      * @returns The query builder object.
      */
-    request({ name, logo, purpose, scope, validity, topicOverride, keyPairOverride, }: {
+    request({ name, logo, purpose, scope, mode, validity, topicOverride, keyPairOverride, }: {
         name: string;
         logo: string;
         purpose: string;
         scope?: string;
+        mode?: ProofMode;
         validity?: number;
         topicOverride?: string;
         keyPairOverride?: {
@@ -197,6 +210,15 @@ export declare class ZKPassport {
             publicKey: Uint8Array;
         };
     }): Promise<QueryBuilder>;
+    private checkDiscloseBytesPublicInputs;
+    private checkAgePublicInputs;
+    private checkBirthdatePublicInputs;
+    private checkExpiryDatePublicInputs;
+    private checkNationalityExclusionPublicInputs;
+    private checkIssuingCountryExclusionPublicInputs;
+    private checkNationalityInclusionPublicInputs;
+    private checkIssuingCountryInclusionPublicInputs;
+    private checkScopeFromDisclosureProof;
     private checkPublicInputs;
     /**
      * @notice Verify the proofs received from the mobile app.
@@ -206,15 +228,40 @@ export declare class ZKPassport {
      * @returns An object containing the unique identifier associated to the user
      * and a boolean indicating whether the proofs were successfully verified.
      */
-    verify({ proofs, queryResult, validity, }: {
+    verify({ proofs, queryResult, validity, scope, }: {
         proofs: Array<ProofResult>;
         queryResult: QueryResult;
         validity?: number;
+        scope?: string;
     }): Promise<{
         uniqueIdentifier: string | undefined;
         verified: boolean;
         queryResultErrors?: QueryResultErrors;
     }>;
+    getSolidityVerifierDetails(network: EVMChain): {
+        address: `0x${string}`;
+        functionName: string;
+        abi: {
+            type: "function" | "event" | "constructor";
+            name: string;
+            inputs: {
+                name: string;
+                type: string;
+                internalType: string;
+            }[];
+            outputs: {
+                name: string;
+                type: string;
+                internalType: string;
+            }[];
+        }[];
+    };
+    getSolidityVerifierParameters({ proof, validityPeriodInDays, domain, scope, }: {
+        proof: ProofResult;
+        validityPeriodInDays?: number;
+        domain?: string;
+        scope?: string;
+    }): SolidityVerifierParameters;
     /**
      * @notice Returns the URL of the request.
      * @param requestId The request ID.