@zkproofport-app/sdk 0.2.11 → 0.2.12

package/dist/index.js

@@ -56,20 +56,26 @@ const DEEP_LINK_HOSTS = {
  * ```typescript
  * const metadata = CIRCUIT_METADATA['coinbase_attestation'];
  * console.log(metadata.name); // "Coinbase KYC"
- * console.log(metadata.publicInputsCount); // 2
+ * console.log(metadata.publicInputsCount); // 128
  * ```
  */
 const CIRCUIT_METADATA = {
     coinbase_attestation: {
         name: 'Coinbase KYC',
         description: 'Prove Coinbase identity verification',
-        publicInputsCount: 2,
+        // 4 x `pub [u8; 32]` in coinbase-attestation/src/main.nr, flattened to
+        // bytes: signal_hash, signer_list_merkle_root, scope, nullifier.
+        // Read 2 here until 2026-09-04, which was wrong under any reading —
+        // the circuit has never had two public inputs, logical or flattened.
+        publicInputsCount: 128,
         publicInputNames: ['signal_hash', 'signer_list_merkle_root'],
     },
     coinbase_country_attestation: {
         name: 'Coinbase Country',
         description: 'Prove Coinbase country verification',
-        publicInputsCount: 14,
+        // 32 + 32 + (10 x 2) + 1 + 1 + 32 + 32 = 150, counted off
+        // coinbase-country-attestation/src/main.nr. Read 14 until 2026-09-04.
+        publicInputsCount: 150,
         publicInputNames: ['signal_hash', 'signer_list_merkle_root', 'country_list', 'country_list_length', 'is_included'],
     },
     oidc_domain_attestation: {
@@ -78,8 +84,22 @@ 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.
+    // Planned circuit — the identifier is reserved and the circuit exists, but it
+    // is not officially supported yet. See CIRCUIT_SUPPORT_STATUS in ./circuits.
+    // Forked from coinbase_attestation and shares its four public inputs, so the
+    // count is the byte-flattened total (4 x [u8; 32] = 128), matching the
+    // COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT indices below. The
+    // coinbase_attestation entry above reports a legacy logical count of 2 and is
+    // left as-is for backwards compatibility.
+    giwa_attestation: {
+        name: 'GIWA Attestation',
+        description: 'Prove GIWA identity verification (planned — not officially supported yet)',
+        publicInputsCount: 128,
+        publicInputNames: ['signal_hash', 'signer_list_merkle_root', 'scope', 'nullifier'],
+    },
+    // Korea Mobile ID (mDL) circuits. Planned — not officially supported yet.
+    // 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",
@@ -2691,13 +2711,167 @@ ProofportSDK.WALLET_SIGNATURE_CIRCUITS = [
     'coinbase_country_attestation',
 ];
 
+/**
+ * Canonical ZKProofport circuit identifiers.
+ *
+ * This module is the single source of truth for circuit IDs. Every other layer
+ * — the mobile app, the demo, the relay, server-side provers — reads its list
+ * from here instead of keeping a private copy that silently drifts.
+ *
+ * It has **no imports and no dependencies**, so it can be pulled in on its own:
+ *
+ * ```typescript
+ * import { CIRCUIT_IDS, isCircuitId } from '@zkproofport-app/sdk/circuits';
+ * ```
+ *
+ * The same names are also re-exported from the package root
+ * (`@zkproofport-app/sdk`) for callers that already import the SDK.
+ *
+ * ## Identifiers are canonical and case-sensitive
+ *
+ * Each ID is the circuit's `name` in its `Nargo.toml`, verbatim. The format is
+ * lowercase with underscores. Hyphenated spellings (`coinbase-kyc`,
+ * `mdl-kr-age`) are directory or UI route names in other repositories — they
+ * are **not** circuit IDs, and passing one produces a nullifier mismatch or a
+ * failed on-chain lookup rather than a clear error.
+ */
+/**
+ * Canonical circuit identifiers, keyed by a stable constant name.
+ *
+ * Prefer these constants over string literals so a rename is a compile error
+ * rather than a runtime surprise.
+ *
+ * @example
+ * ```typescript
+ * import { CIRCUIT_IDS } from '@zkproofport-app/sdk/circuits';
+ *
+ * const relay = await sdk.createRelayRequest(CIRCUIT_IDS.COINBASE_ATTESTATION, {
+ *   scope: 'myapp.com',
+ * });
+ * ```
+ */
+const CIRCUIT_IDS = Object.freeze({
+    /** Coinbase KYC attestation. Officially supported. */
+    COINBASE_ATTESTATION: 'coinbase_attestation',
+    /** Coinbase country attestation (inclusion / exclusion). Officially supported. */
+    COINBASE_COUNTRY_ATTESTATION: 'coinbase_country_attestation',
+    /** OIDC email-domain attestation. Officially supported. */
+    OIDC_DOMAIN_ATTESTATION: 'oidc_domain_attestation',
+    /** GIWA attestation. Planned — not officially supported yet. */
+    GIWA_ATTESTATION: 'giwa_attestation',
+    /** Korea Mobile ID ownership. Planned — not officially supported yet. */
+    MDL_KR_OWNERSHIP: 'mdl_kr_ownership',
+    /** Korea Mobile ID age threshold. Planned — not officially supported yet. */
+    MDL_KR_AGE: 'mdl_kr_age',
+    /** Korea Mobile ID si/do region. Planned — not officially supported yet. */
+    MDL_KR_REGION: 'mdl_kr_region',
+});
+/**
+ * Support status for every circuit.
+ *
+ * The record is exhaustive over {@link CircuitId}: adding an identifier without
+ * giving it a status is a compile error, so this list cannot drift from
+ * {@link CIRCUIT_IDS}.
+ *
+ * @example
+ * ```typescript
+ * import { CIRCUIT_SUPPORT_STATUS } from '@zkproofport-app/sdk/circuits';
+ *
+ * CIRCUIT_SUPPORT_STATUS.coinbase_attestation; // 'supported'
+ * CIRCUIT_SUPPORT_STATUS.mdl_kr_age;           // 'planned'
+ * ```
+ */
+const CIRCUIT_SUPPORT_STATUS = Object.freeze({
+    coinbase_attestation: 'supported',
+    coinbase_country_attestation: 'supported',
+    oidc_domain_attestation: 'supported',
+    giwa_attestation: 'planned',
+    mdl_kr_ownership: 'planned',
+    mdl_kr_age: 'planned',
+    mdl_kr_region: 'planned',
+});
+/**
+ * Every canonical circuit identifier, in declaration order.
+ *
+ * Includes circuits that are still `planned`. Use {@link SUPPORTED_CIRCUIT_IDS}
+ * when you only want the ones that are officially supported today.
+ */
+const ALL_CIRCUIT_IDS = Object.freeze(Object.values(CIRCUIT_IDS));
+/**
+ * Circuits that are officially supported today: the two Coinbase circuits and
+ * OIDC domain attestation.
+ *
+ * Derived from {@link CIRCUIT_SUPPORT_STATUS}, so it cannot fall out of sync.
+ */
+const SUPPORTED_CIRCUIT_IDS = Object.freeze(ALL_CIRCUIT_IDS.filter((id) => CIRCUIT_SUPPORT_STATUS[id] === 'supported'));
+/**
+ * Circuits whose identifiers are reserved but which are not officially
+ * supported yet: GIWA attestation and the three Korea Mobile ID circuits.
+ *
+ * Derived from {@link CIRCUIT_SUPPORT_STATUS}, so it cannot fall out of sync.
+ */
+const PLANNED_CIRCUIT_IDS = Object.freeze(ALL_CIRCUIT_IDS.filter((id) => CIRCUIT_SUPPORT_STATUS[id] === 'planned'));
+/**
+ * Narrows an unknown value to a canonical circuit identifier.
+ *
+ * Returns `false` for hyphenated route names such as `'coinbase-kyc'`, which
+ * are not circuit IDs.
+ *
+ * @example
+ * ```typescript
+ * isCircuitId('coinbase_attestation'); // true
+ * isCircuitId('coinbase-kyc');         // false
+ * ```
+ */
+function isCircuitId(value) {
+    return typeof value === 'string' && ALL_CIRCUIT_IDS.includes(value);
+}
+/**
+ * Narrows an unknown value to a circuit identifier that is officially supported
+ * today. Planned circuits return `false`.
+ *
+ * @example
+ * ```typescript
+ * isSupportedCircuitId('oidc_domain_attestation'); // true
+ * isSupportedCircuitId('mdl_kr_age');              // false — planned
+ * ```
+ */
+function isSupportedCircuitId(value) {
+    return isCircuitId(value) && CIRCUIT_SUPPORT_STATUS[value] === 'supported';
+}
+/**
+ * Returns the support status of a circuit.
+ *
+ * @param circuit - A canonical circuit identifier.
+ * @throws Error when the value is not a canonical circuit identifier.
+ *
+ * @example
+ * ```typescript
+ * getCircuitSupportStatus('giwa_attestation'); // 'planned'
+ * ```
+ */
+function getCircuitSupportStatus(circuit) {
+    if (!isCircuitId(circuit)) {
+        throw new Error(`Unknown circuit '${String(circuit)}'. Expected one of: ${ALL_CIRCUIT_IDS.join(', ')}`);
+    }
+    return CIRCUIT_SUPPORT_STATUS[circuit];
+}
+
+exports.ALL_CIRCUIT_IDS = ALL_CIRCUIT_IDS;
+exports.CIRCUIT_IDS = CIRCUIT_IDS;
+exports.CIRCUIT_SUPPORT_STATUS = CIRCUIT_SUPPORT_STATUS;
 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.PLANNED_CIRCUIT_IDS = PLANNED_CIRCUIT_IDS;
 exports.ProofportSDK = ProofportSDK;
+exports.SUPPORTED_CIRCUIT_IDS = SUPPORTED_CIRCUIT_IDS;
 exports.default = ProofportSDK;
 exports.extractDomainFromPublicInputs = extractDomainFromPublicInputs;
 exports.extractNullifierFromPublicInputs = extractNullifierFromPublicInputs;
 exports.extractScopeFromPublicInputs = extractScopeFromPublicInputs;
+exports.getCircuitSupportStatus = getCircuitSupportStatus;
+exports.isCircuitId = isCircuitId;
+exports.isSupportedCircuitId = isSupportedCircuitId;
 //# sourceMappingURL=index.js.map