@zkproofport-app/sdk 0.2.7 → 0.2.9

package/dist/index.js

@@ -78,6 +78,26 @@ const CIRCUIT_METADATA = {
         publicInputsCount: 148,
         publicInputNames: ['pubkey_modulus_limbs', 'domain', 'scope', 'nullifier', 'provider'],
     },
+    // Korea Mobile ID (mDL) circuits. Counts are byte-flattened field totals
+    // from the compiled circuit ABIs: [u8; 32] arrays contribute 32 inputs each.
+    mdl_kr_ownership: {
+        name: 'Korea Mobile ID — Ownership',
+        description: "Prove valid Korean mobile driver's license ownership with selective disclosure",
+        publicInputsCount: 97,
+        publicInputNames: ['scope', 'nullifier_value', 'disclose_flags', 'owner_commit'],
+    },
+    mdl_kr_age: {
+        name: 'Korea Mobile ID — Age',
+        description: "Prove minimum age from Korean mobile driver's license without revealing birth date",
+        publicInputsCount: 66,
+        publicInputNames: ['scope', 'nullifier_value', 'age_threshold', 'current_year'],
+    },
+    mdl_kr_region: {
+        name: 'Korea Mobile ID — Region',
+        description: "Prove si/do residency from Korean mobile driver's license without revealing address",
+        publicInputsCount: 96,
+        publicInputNames: ['scope', 'nullifier_value', 'region_code'],
+    },
 };
 /**
  * Standard verifier contract ABI shared across all Barretenberg-generated verifiers.
@@ -209,6 +229,36 @@ const COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT = {
     NULLIFIER_START: 118,
     NULLIFIER_END: 149,
 };
+/**
+ * Korea Mobile ID (mDL) circuit public input layout (field offsets).
+ * All three mDL circuits share the same prefix: scope [0..31] and
+ * nullifier_value [32..63], each stored one byte per field element.
+ * The suffix differs per predicate circuit:
+ * - mdl_kr_ownership (97 inputs): disclose_flags [64], owner_commit [65..96]
+ * - mdl_kr_age (66 inputs): age_threshold [64], current_year [65]
+ * - mdl_kr_region (96 inputs): region_code [64..95]
+ *
+ * @example
+ * ```typescript
+ * const nullifier = publicInputs.slice(
+ *   MDL_KR_PUBLIC_INPUT_LAYOUT.NULLIFIER_START,
+ *   MDL_KR_PUBLIC_INPUT_LAYOUT.NULLIFIER_END + 1
+ * );
+ * ```
+ */
+const MDL_KR_PUBLIC_INPUT_LAYOUT = {
+    SCOPE_START: 0,
+    SCOPE_END: 31,
+    NULLIFIER_START: 32,
+    NULLIFIER_END: 63,
+    OWNERSHIP_DISCLOSE_FLAGS: 64,
+    OWNERSHIP_OWNER_COMMIT_START: 65,
+    OWNERSHIP_OWNER_COMMIT_END: 96,
+    AGE_THRESHOLD: 64,
+    AGE_CURRENT_YEAR: 65,
+    REGION_CODE_START: 64,
+    REGION_CODE_END: 95,
+};
 /**
  * OIDC Domain Attestation circuit public input layout (field offsets).
  * Defines the field positions in the flattened public inputs array (148 fields total).
@@ -489,6 +539,142 @@ function isProofportDeepLink(url, scheme = DEFAULT_SCHEME) {
  * @param request - Proof request to validate
  * @returns Validation result with `valid` flag and optional `error` message
  */
+/**
+ * Validates a free-text mDL input (scope / targetRegion).
+ * Rejects empty or whitespace-only values, control characters (which break
+ * deep-link query encoding and downstream logging), and values over 256 chars
+ * (server-side length cap mirror). UTF-8 text such as Korean region names is
+ * allowed.
+ *
+ * @returns Error message string, or null when valid.
+ */
+function validateMdlTextInput(value, fieldName) {
+    if (typeof value !== 'string' || value.trim() === '') {
+        return `${fieldName} is required and must be a non-empty string`;
+    }
+    if (value.length > 256) {
+        return `${fieldName} must be 256 characters or fewer`;
+    }
+    // eslint-disable-next-line no-control-regex
+    if (/[\u0000-\u001F\u007F]/.test(value)) {
+        return `${fieldName} must not contain control characters`;
+    }
+    return null;
+}
+/**
+ * Validates dapp-supplied inputs for the Korea Mobile ID (mDL) circuits.
+ * Shared by deep-link request validation and relay request creation so the
+ * same guards apply on every request path.
+ *
+ * Rules:
+ * - `scope` — required non-empty string, ≤256 chars, no control characters
+ * - `mdl_kr_ownership.discloseFlags` — optional integer 0–15 (0x0F bitmask)
+ * - `mdl_kr_age.ageThreshold` — required integer 1–150
+ * - `mdl_kr_region.targetRegion` — required non-empty string (Korean si/do),
+ *   ≤256 chars, no control characters
+ *
+ * @param circuit - One of the three mDL circuit identifiers
+ * @param inputs - Dapp-supplied circuit inputs
+ * @returns Error message string, or null when the inputs are valid
+ */
+function validateMdlInputs(circuit, inputs) {
+    const scopeError = validateMdlTextInput(inputs.scope, 'scope');
+    if (scopeError) {
+        return scopeError;
+    }
+    if (circuit === 'mdl_kr_ownership') {
+        const { discloseFlags } = inputs;
+        if (discloseFlags !== undefined) {
+            if (typeof discloseFlags !== 'number' ||
+                !Number.isInteger(discloseFlags) ||
+                discloseFlags < 0 ||
+                discloseFlags > 0x0f) {
+                return 'discloseFlags must be an integer between 0 and 15';
+            }
+        }
+    }
+    else if (circuit === 'mdl_kr_age') {
+        const { ageThreshold } = inputs;
+        if (typeof ageThreshold !== 'number' ||
+            !Number.isInteger(ageThreshold) ||
+            ageThreshold < 1 ||
+            ageThreshold > 150) {
+            return 'ageThreshold is required and must be an integer between 1 and 150';
+        }
+    }
+    else {
+        const { targetRegion } = inputs;
+        const regionError = validateMdlTextInput(targetRegion, 'targetRegion');
+        if (regionError) {
+            return regionError;
+        }
+    }
+    return null;
+}
+/**
+ * Longest accepted `returnScheme` value.
+ * Kept in sync with proofport-relay `src/returnScheme.ts`.
+ */
+const MAX_RETURN_SCHEME_LENGTH = 128;
+/** RFC 3986 scheme (`ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )`) followed by exactly `://`. */
+const BARE_SCHEME_RE = /^[a-z][a-z0-9+.-]*:\/\/$/;
+/** `https://host[:port]` with no userinfo, path, query or fragment. */
+const HTTPS_ORIGIN_RE = /^https:\/\/[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+(:[0-9]{1,5})?$/;
+const DENIED_RETURN_SCHEMES = new Set([
+    'about',
+    'blob',
+    'content',
+    'data',
+    'facetime',
+    'facetime-audio',
+    'file',
+    'ftp',
+    'http',
+    'intent',
+    'javascript',
+    'jar',
+    'mailto',
+    'sms',
+    'tel',
+    'vbscript',
+]);
+/**
+ * Validates a `returnScheme` before it is sent to the relay, so a malformed
+ * value fails fast in the integrator's own code instead of coming back as a
+ * relay 400. The relay re-validates and is the authority.
+ *
+ * @param value - Candidate return target
+ * @returns `null` when acceptable, otherwise a human-readable error message
+ *
+ * @internal
+ */
+function validateReturnScheme(value) {
+    if (typeof value !== 'string') {
+        return 'returnScheme must be a string';
+    }
+    if (value.length === 0) {
+        return 'returnScheme must not be empty';
+    }
+    // Length is checked before any regex so a huge string never reaches the matcher.
+    if (value.length > MAX_RETURN_SCHEME_LENGTH) {
+        return `returnScheme must be at most ${MAX_RETURN_SCHEME_LENGTH} characters`;
+    }
+    if (/\s/.test(value)) {
+        return 'returnScheme must not contain whitespace';
+    }
+    const normalized = value.toLowerCase();
+    if (HTTPS_ORIGIN_RE.test(normalized)) {
+        return null;
+    }
+    if (!BARE_SCHEME_RE.test(normalized)) {
+        return 'returnScheme must be a bare custom scheme such as "mydapp://" or an https origin such as "https://myapp.com" — paths, query strings and fragments are not accepted';
+    }
+    const schemeName = normalized.slice(0, normalized.indexOf(':'));
+    if (DENIED_RETURN_SCHEMES.has(schemeName)) {
+        return `returnScheme "${schemeName}" is not allowed`;
+    }
+    return null;
+}
 function validateProofRequest(request) {
     if (!request.requestId) {
         return { valid: false, error: 'Missing requestId' };
@@ -496,7 +682,14 @@ function validateProofRequest(request) {
     if (!request.circuit) {
         return { valid: false, error: 'Missing circuit type' };
     }
-    if (!['coinbase_attestation', 'coinbase_country_attestation', 'oidc_domain_attestation'].includes(request.circuit)) {
+    if (![
+        'coinbase_attestation',
+        'coinbase_country_attestation',
+        'oidc_domain_attestation',
+        'mdl_kr_ownership',
+        'mdl_kr_age',
+        'mdl_kr_region',
+    ].includes(request.circuit)) {
         return { valid: false, error: `Invalid circuit type: ${request.circuit}` };
     }
     if (!request.callbackUrl) {
@@ -538,6 +731,14 @@ function validateProofRequest(request) {
             return { valid: false, error: 'provider must be a non-empty string when specified' };
         }
     }
+    else if (request.circuit === 'mdl_kr_ownership' ||
+        request.circuit === 'mdl_kr_age' ||
+        request.circuit === 'mdl_kr_region') {
+        const mdlError = validateMdlInputs(request.circuit, request.inputs);
+        if (mdlError) {
+            return { valid: false, error: mdlError };
+        }
+    }
     // Check expiry
     if (request.expiresAt && Date.now() > request.expiresAt) {
         return { valid: false, error: 'Request has expired' };
@@ -976,6 +1177,11 @@ function extractScopeFromPublicInputs(publicInputsHex, circuit) {
         start = 83;
         end = 114;
     }
+    else if (circuit !== undefined && circuit.startsWith('mdl_kr_')) {
+        // All Korea mDL circuits: scope [0..31], nullifier_value [32..63]
+        start = 0;
+        end = 31;
+    }
     else {
         start = 64;
         end = 95;
@@ -1013,6 +1219,11 @@ function extractNullifierFromPublicInputs(publicInputsHex, circuit) {
         start = 115;
         end = 146;
     }
+    else if (circuit !== undefined && circuit.startsWith('mdl_kr_')) {
+        // All Korea mDL circuits: scope [0..31], nullifier_value [32..63]
+        start = 32;
+        end = 63;
+    }
     else {
         start = 96;
         end = 127;
@@ -1280,10 +1491,48 @@ class ProofportSDK {
         if (circuit === 'coinbase_country_attestation') {
             return this.createCoinbaseCountryRequest(inputs, options);
         }
+        else if (circuit === 'mdl_kr_ownership' ||
+            circuit === 'mdl_kr_age' ||
+            circuit === 'mdl_kr_region') {
+            return this.createMdlKrRequest(circuit, inputs, options);
+        }
         else {
             return this.createCoinbaseKycRequest(inputs, options);
         }
     }
+    /**
+     * @internal
+     * Creates a Korea Mobile ID (mDL) proof request for any of the three
+     * mDL predicate circuits (ownership / age / region).
+     *
+     * The mobile app collects the license data on-device; the dapp only
+     * supplies the predicate parameters validated here. No wallet signature
+     * is required for mDL circuits.
+     *
+     * @param circuit - 'mdl_kr_ownership' | 'mdl_kr_age' | 'mdl_kr_region'
+     * @param inputs - Predicate inputs (see MdlKr*Inputs types)
+     * @param options - Request configuration options
+     *
+     * @throws Error if the predicate inputs fail validation
+     */
+    createMdlKrRequest(circuit, inputs, options = {}) {
+        const mdlError = validateMdlInputs(circuit, inputs);
+        if (mdlError) {
+            throw new Error(`${mdlError} (circuit: ${circuit})`);
+        }
+        const request = {
+            requestId: generateRequestId(),
+            circuit,
+            inputs,
+            message: options.message,
+            dappName: options.dappName,
+            dappIcon: options.dappIcon,
+            createdAt: Date.now(),
+            expiresAt: Date.now() + (options.expiresInMs || DEFAULT_REQUEST_EXPIRY_MS),
+        };
+        this.pendingRequests.set(request.requestId, request);
+        return request;
+    }
     // ============ Deep Link Generation ============
     /**
      * @internal
@@ -1944,6 +2193,22 @@ class ProofportSDK {
         if (needsSignature && !this.signer) {
             throw new Error('Signer not set. Call setSigner() first. Wallet signature is required for this circuit.');
         }
+        // mDL circuits: validate predicate inputs client-side before hitting the
+        // relay, so a bad ageThreshold / targetRegion fails fast with a clear error.
+        if (circuit === 'mdl_kr_ownership' || circuit === 'mdl_kr_age' || circuit === 'mdl_kr_region') {
+            const mdlError = validateMdlInputs(circuit, inputs);
+            if (mdlError) {
+                throw new Error(`${mdlError} (circuit: ${circuit})`);
+            }
+        }
+        // Return target: validated before we burn a challenge, so a typo surfaces
+        // as a local error instead of a relay 400 on the second round trip.
+        if (options.returnScheme !== undefined) {
+            const returnSchemeError = validateReturnScheme(options.returnScheme);
+            if (returnSchemeError) {
+                throw new Error(returnSchemeError);
+            }
+        }
         // Get challenge + requestId from relay
         const { requestId, challenge } = await this.getChallenge();
         const body = {
@@ -1964,6 +2229,8 @@ class ProofportSDK {
             body.dappIcon = options.dappIcon;
         if (options.nonce)
             body.nonce = options.nonce;
+        if (options.returnScheme)
+            body.returnScheme = options.returnScheme;
         const response = await fetch(`${this.relayUrl}/api/v1/proof/request`, {
             method: 'POST',
             headers: {
@@ -2264,9 +2531,29 @@ class ProofportSDK {
  *
  * @param circuit - Circuit type identifier
  * @param inputs - Circuit-specific inputs
- * @param options - Request options (message, dappName, dappIcon, nonce)
+ * @param options - Request options (message, dappName, dappIcon, nonce, returnScheme)
+ * @param options.returnScheme - Which app the ZKProofport app should switch back
+ *   to once it has finished. Put **your own** deep link scheme here — the bare
+ *   scheme your app registers, e.g. `'mydapp://'`. A web app can instead pass its
+ *   own https origin, e.g. `'https://myapp.com'`.
+ *
+ *   This is intentionally **not** a URL and not a return address: no path, query
+ *   string or fragment is accepted, and the ZKProofport app never sends the proof
+ *   there. The proof still comes back to you the same way it always did — over the
+ *   relay, via `waitForProof()` / `waitForResult()`. `returnScheme` only answers
+ *   "which app should come back to the foreground", exactly like the
+ *   `redirect.native` value a wallet uses to hand control back after signing.
+ *
+ *   **Omit it and nothing changes** — the user simply stays in the ZKProofport app
+ *   after the proof and switches back manually. There is no auto-switch on proof
+ *   failure either; only on success and on the user declining the request.
+ *
+ *   Rejected with an error before the request is sent: empty or whitespace values,
+ *   anything longer than 128 characters, values containing a path/query/fragment,
+ *   and the `http:`, `file:`, `data:`, `javascript:`, `intent:`, `tel:`, `sms:`,
+ *   `mailto:` families.
  * @returns Promise resolving to RelayProofRequest with requestId, deepLink, pollUrl
- * @throws Error if signer not set or relay request fails
+ * @throws Error if signer not set, returnScheme is malformed, or the relay request fails
  *
  * @example
  * ```typescript
@@ -2275,7 +2562,7 @@ class ProofportSDK {
  *
  * const relay = await sdk.createRelayRequest('coinbase_attestation', {
  *   scope: 'myapp.com'
- * }, { dappName: 'My DApp' });
+ * }, { dappName: 'My DApp', returnScheme: 'mydapp://' });
  *
  * // Generate QR code from relay deep link
  * const qr = await sdk.generateQRCode(relay.deepLink);
@@ -2292,6 +2579,7 @@ ProofportSDK.WALLET_SIGNATURE_CIRCUITS = [
 
 exports.COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT = COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT;
 exports.COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT = COINBASE_COUNTRY_PUBLIC_INPUT_LAYOUT;
+exports.MDL_KR_PUBLIC_INPUT_LAYOUT = MDL_KR_PUBLIC_INPUT_LAYOUT;
 exports.OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT = OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT;
 exports.ProofportSDK = ProofportSDK;
 exports.default = ProofportSDK;