@zkproofport-app/sdk 0.5.0-beta.0 → 0.5.0-beta.2

package/dist/index.js

@@ -25,6 +25,49 @@ const RELAY_URLS = {
     staging: 'https://stg-relay.zkproofport.app',
     local: 'http://localhost:4001',
 };
+/**
+ * The chain each circuit is verified on, per environment. Complete: a circuit
+ * added to the SDK is a compile error here until somebody names its chain.
+ *
+ * Mirrors the mobile app's `CIRCUIT_NETWORKS` (proofport-app
+ * src/config/contracts.ts), because a proof is checked where the app said its
+ * verifier is: Base for the Coinbase and OIDC circuits, GIWA Sepolia for GIWA
+ * and Dojang (testnet-only), Base Sepolia for Korea Mobile ID (testnet-only).
+ * The ADDRESS on that chain always comes from core's pinned table, never from
+ * a proof response.
+ */
+const VERIFICATION_CHAINS = {
+    production: {
+        coinbase_attestation: 8453,
+        coinbase_country_attestation: 8453,
+        oidc_domain_attestation: 8453,
+        giwa_attestation: 91342,
+        dojang_playground: 91342,
+        mdl_kr_ownership: 84532,
+        mdl_kr_age: 84532,
+        mdl_kr_region: 84532,
+    },
+    staging: {
+        coinbase_attestation: 84532,
+        coinbase_country_attestation: 84532,
+        oidc_domain_attestation: 84532,
+        giwa_attestation: 91342,
+        dojang_playground: 91342,
+        mdl_kr_ownership: 84532,
+        mdl_kr_age: 84532,
+        mdl_kr_region: 84532,
+    },
+    local: {
+        coinbase_attestation: 84532,
+        coinbase_country_attestation: 84532,
+        oidc_domain_attestation: 84532,
+        giwa_attestation: 91342,
+        dojang_playground: 91342,
+        mdl_kr_ownership: 84532,
+        mdl_kr_age: 84532,
+        mdl_kr_region: 84532,
+    },
+};
 /**
  * Default deep link URL scheme for ZKProofport mobile app.
  * Used to construct deep link URLs that open the mobile app.
@@ -1098,6 +1141,10 @@ async function fetchVerificationKey(circuit, timeoutMs) {
  * Needs no setup from the caller: the verifier ships with this SDK and is
  * loaded on first use.
  *
+ * For `oidc_domain_attestation` it first checks the proof's RSA key against the
+ * provider's published JWKS (core's `checkOidcProviderKey`); a key the provider
+ * does not publish, or a JWKS that cannot be fetched, is `{ valid: false }`.
+ *
  * @param circuit - Canonical circuit identifier
  * @param proof - Proof bytes as hex, WITHOUT public inputs (as the relay sends it)
  * @param publicInputs - Public inputs as hex strings, in circuit order
@@ -1116,6 +1163,18 @@ async function fetchVerificationKey(circuit, timeoutMs) {
  */
 async function verifyProofOffChain(circuit, proof, publicInputs, options = {}) {
     const timeoutMs = options.timeoutMs ?? 30000;
+    if (!circuits.isCircuitId(circuit)) {
+        return { valid: false, error: `Unknown circuit '${circuit}'. Known: ${circuits.ALL_CIRCUIT_IDS.join(', ')}.` };
+    }
+    // Before Barretenberg, and for the same reason as on-chain: a proof can be
+    // mathematically valid and still mean nothing, because some circuits take
+    // their trust anchor as a public input the prover chooses. For OIDC that is
+    // the RSA key -- see core's oidcProviderKeys. Checked here so a dApp that
+    // verifies off-chain gets the same answer as one that verifies on-chain.
+    const issuer = await core.checkProofIssuer(circuit, publicInputs);
+    if (!issuer.ok) {
+        return { valid: false, error: issuer.error };
+    }
     // A REQUIRED dependency, loaded lazily.
     //
     // It was briefly an optional peer dependency, on the reasoning that the WASM
@@ -1256,22 +1315,32 @@ class ProofportSDK {
         this.pendingRequests = new Map();
         this.signer = null;
         this.socket = null;
+        /**
+         * Set by {@link ProofportSDK.create} from its environment preset. It decides
+         * which chain a proof is verified on when the dApp configured no verifier
+         * for the circuit; a custom-config SDK has none and must configure one.
+         */
+        this.environment = null;
         this.config = {
             scheme: config.scheme || DEFAULT_SCHEME,
             verifiers: config.verifiers || {},
         };
         this.relayUrl = config.relayUrl || '';
+        if (config.environment !== undefined) {
+            if (!Object.prototype.hasOwnProperty.call(VERIFICATION_CHAINS, config.environment)) {
+                throw new Error(`Unknown environment '${config.environment}'. Known: ${Object.keys(VERIFICATION_CHAINS).join(', ')}.`);
+            }
+            this.environment = config.environment;
+        }
     }
     // ============ Request Creation ============
     /**
      * @internal
-     * Creates a Coinbase KYC verification proof request.
+     * Creates a proof request for a circuit whose dapp-side input is a scope
+     * (Coinbase KYC, OIDC domain, GIWA, Dojang), keeping that circuit's id.
      *
-     * Generates a proof request for verifying Coinbase KYC status without revealing
-     * the actual attestation data. The proof confirms the user has passed Coinbase KYC
-     * while maintaining privacy through zero-knowledge proofs.
-     *
-     * @param inputs - Circuit inputs for Coinbase KYC
+     * @param circuit - The circuit requested; it is the request's circuit
+     * @param inputs - Circuit inputs; `scope` is required (and `domain` for OIDC)
      * @param inputs.scope - Application-specific scope (e.g., domain name)
      * @param options - Request configuration options
   
@@ -1286,7 +1355,7 @@ class ProofportSDK {
      *
      * @example
      * ```typescript
-     * const request = sdk.createCoinbaseKycRequest({
+     * const request = sdk.createScopedRequest('coinbase_attestation', {
      *   scope: 'myapp.com'
      * }, {
      *   dappName: 'My DApp',
@@ -1296,13 +1365,34 @@ class ProofportSDK {
      * const deepLink = sdk.getDeepLinkUrl(request);
      * ```
      */
-    createCoinbaseKycRequest(inputs, options = {}) {
-        if (!inputs.scope) {
-            throw new Error('scope is required for coinbase_attestation circuit');
+    createScopedRequest(circuit, inputs, options = {}) {
+        const scope = inputs.scope;
+        if (typeof scope !== 'string' || scope.trim() === '') {
+            throw new Error(`scope is required for ${circuit} circuit`);
+        }
+        if (circuit === 'oidc_domain_attestation') {
+            const domain = inputs.domain;
+            if (typeof domain !== 'string' || domain.trim() === '') {
+                throw new Error('domain is required for oidc_domain_attestation circuit');
+            }
+        }
+        const action = inputs.action;
+        const binding = circuits.circuitActionBinding(circuit);
+        if (binding === 'none' && action !== undefined) {
+            throw new Error(`${circuit} has no action inputs, so an action sent with it would not be proved.`);
+        }
+        if (binding === 'required' || (binding === 'optional' && action !== undefined)) {
+            const actionError = typedAction.validateTypedAction(action);
+            if (actionError)
+                throw new Error(`${actionError} (circuit: ${circuit})`);
         }
         const request = {
             requestId: generateRequestId(),
-            circuit: 'coinbase_attestation',
+            // The circuit asked for, always. This used to be the literal
+            // 'coinbase_attestation', and every circuit that was not country or mDL
+            // was routed here -- a GIWA, Dojang or OIDC request silently became a
+            // Coinbase KYC request.
+            circuit,
             inputs,
             message: options.message,
             dappName: options.dappName,
@@ -1399,16 +1489,17 @@ class ProofportSDK {
      * ```
      */
     createProofRequest(circuit, inputs, options = {}) {
-        if (circuit === 'coinbase_country_attestation') {
-            return this.createCoinbaseCountryRequest(inputs, options);
+        if (!circuits.isCircuitId(circuit)) {
+            throw new Error(`Unknown circuit '${circuit}'. Known: ${circuits.ALL_CIRCUIT_IDS.join(', ')}.`);
         }
-        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);
+        const builder = ProofportSDK.REQUEST_BUILDERS[circuit];
+        switch (builder) {
+            case 'country':
+                return this.createCoinbaseCountryRequest(inputs, options);
+            case 'mdl':
+                return this.createMdlKrRequest(circuit, inputs, options);
+            case 'scoped':
+                return this.createScopedRequest(circuit, inputs, options);
         }
     }
     /**
@@ -1785,8 +1876,24 @@ class ProofportSDK {
      */
     async verifyOnChain(circuit, proof, publicInputs, providerOrSigner) {
         const parsedProof = core.parseProofForOnChain(proof, publicInputs, publicInputs.length);
-        const customVerifier = this.config.verifiers[circuit];
-        return core.verifyProofOnChain(circuit, parsedProof, providerOrSigner, customVerifier);
+        return core.verifyProofOnChain(circuit, parsedProof, providerOrSigner, this.verifierTarget(circuit));
+    }
+    /**
+     * The verifier for a circuit: the one the dApp configured, otherwise the
+     * pinned deployment on the chain this SDK's environment verifies that
+     * circuit on. `undefined` when neither exists, which core reports as an
+     * error. Never anything a proof response said.
+     */
+    verifierTarget(circuit) {
+        const configured = this.config.verifiers[circuit];
+        if (configured)
+            return configured;
+        if (this.environment === null)
+            return undefined;
+        const chains = VERIFICATION_CHAINS[this.environment];
+        if (!Object.prototype.hasOwnProperty.call(chains, circuit))
+            return undefined;
+        return { chainId: chains[circuit] };
     }
     /**
      * Verifies a proof response on-chain using the deployed verifier contract.
@@ -1827,12 +1934,14 @@ class ProofportSDK {
             return { valid: false, error: 'Invalid or incomplete response' };
         }
         const parsedProof = core.parseProofForOnChain(response.proof, response.publicInputs, response.publicInputs.length);
-        const customVerifier = this.config.verifiers[response.circuit];
-        const responseVerifier = {
+        // The response's verifierAddress and chainId are a claim to check, never
+        // the contract to call: whoever wrote the response would otherwise pick
+        // the judge. A claim that differs from the pinned or configured verifier
+        // is refused.
+        return core.verifyProofOnChain(response.circuit, parsedProof, providerOrSigner, this.verifierTarget(response.circuit), {
             verifierAddress: response.verifierAddress,
             chainId: response.chainId,
-        };
-        return core.verifyProofOnChain(response.circuit, parsedProof, providerOrSigner, customVerifier, responseVerifier);
+        });
     }
     /**
      * Verifies a proof response off-chain, against the circuit's verification key.
@@ -1883,8 +1992,17 @@ class ProofportSDK {
      * ```
      */
     getVerifierAddress(circuit) {
-        const customVerifier = this.config.verifiers[circuit];
-        return core.getVerifierAddress(circuit, customVerifier);
+        return this.requireVerifier(circuit).address;
+    }
+    /** The configured or pinned verifier, or an error saying why there is none. */
+    requireVerifier(circuit) {
+        const target = this.verifierTarget(circuit);
+        if (!target) {
+            throw new Error(`No verifier configured for circuit '${circuit}'. Configure one in the SDK's verifiers option, or create the SDK with ProofportSDK.create() to use the pinned deployment.`);
+        }
+        if ('address' in target)
+            return { address: target.address, chainId: target.chainId };
+        return { address: core.getPinnedVerifier(circuit, target.chainId).address, chainId: target.chainId };
     }
     /**
      * Gets the blockchain chain ID where the verifier contract is deployed.
@@ -1904,8 +2022,7 @@ class ProofportSDK {
      * ```
      */
     getVerifierChainId(circuit) {
-        const customVerifier = this.config.verifiers[circuit];
-        return core.getVerifierChainId(circuit, customVerifier);
+        return this.requireVerifier(circuit).chainId;
     }
     /**
      * Gets metadata for a specific circuit type.
@@ -2052,17 +2169,20 @@ class ProofportSDK {
      */
     static create(envOrConfig) {
         if (typeof envOrConfig === 'undefined') {
-            return new ProofportSDK({ relayUrl: RELAY_URLS.production });
+            return ProofportSDK.forEnvironment('production');
         }
         if (typeof envOrConfig === 'string') {
-            const relayUrl = RELAY_URLS[envOrConfig];
-            if (!relayUrl) {
-                throw new Error(`Unknown environment: ${envOrConfig}. Use 'production', 'staging', or 'local'.`);
-            }
-            return new ProofportSDK({ relayUrl });
+            return ProofportSDK.forEnvironment(envOrConfig);
         }
         return new ProofportSDK(envOrConfig);
     }
+    /** @internal An SDK on an environment preset's relay, verifying on that environment's chains. */
+    static forEnvironment(env) {
+        if (!Object.prototype.hasOwnProperty.call(RELAY_URLS, env)) {
+            throw new Error(`Unknown environment: ${env}. Use 'production', 'staging', or 'local'.`);
+        }
+        return new ProofportSDK({ relayUrl: RELAY_URLS[env], environment: env });
+    }
     /**
      * Detects if the code is running on a mobile device.
      *
@@ -2196,7 +2316,10 @@ class ProofportSDK {
     // calling createRelayRequest() for it with no signer got no local error and
     // a relay 401 two round trips later.
     static needsWalletSignature(circuit) {
-        return circuits.CIRCUIT_NEEDS_WALLET_SIGNATURE[circuit] === true;
+        if (!circuits.isCircuitId(circuit)) {
+            throw new Error(`Unknown circuit '${circuit}'. Expected: ${circuits.ALL_CIRCUIT_IDS.join(', ')}`);
+        }
+        return circuits.CIRCUIT_NEEDS_WALLET_SIGNATURE[circuit];
     }
     async createRelayRequest(circuit, inputs, options = {}) {
         if (!this.relayUrl) {
@@ -2570,6 +2693,21 @@ class ProofportSDK {
         return core.extractDomainFromPublicInputs(publicInputs, circuit);
     }
 }
+/**
+ * How each circuit's request is built and checked. Keyed by circuit id and
+ * exhaustive over it, so a new circuit is a compile error here instead of
+ * falling through to another circuit's builder.
+ */
+ProofportSDK.REQUEST_BUILDERS = {
+    coinbase_attestation: 'scoped',
+    coinbase_country_attestation: 'country',
+    oidc_domain_attestation: 'scoped',
+    giwa_attestation: 'scoped',
+    dojang_playground: 'scoped',
+    mdl_kr_ownership: 'mdl',
+    mdl_kr_age: 'mdl',
+    mdl_kr_region: 'mdl',
+};
 
 Object.defineProperty(exports, "COINBASE_ATTESTATION_PUBLIC_INPUT_LAYOUT", {
     enumerable: true,
@@ -2587,6 +2725,10 @@ Object.defineProperty(exports, "OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT", {
     enumerable: true,
     get: function () { return core.OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT; }
 });
+Object.defineProperty(exports, "PINNED_VERIFIERS", {
+    enumerable: true,
+    get: function () { return core.PINNED_VERIFIERS; }
+});
 Object.defineProperty(exports, "extractDomainFromPublicInputs", {
     enumerable: true,
     get: function () { return core.extractDomainFromPublicInputs; }
@@ -2599,6 +2741,10 @@ Object.defineProperty(exports, "extractScopeFromPublicInputs", {
     enumerable: true,
     get: function () { return core.extractScopeFromPublicInputs; }
 });
+Object.defineProperty(exports, "getPinnedVerifier", {
+    enumerable: true,
+    get: function () { return core.getPinnedVerifier; }
+});
 Object.defineProperty(exports, "ALL_CIRCUIT_IDS", {
     enumerable: true,
     get: function () { return circuits.ALL_CIRCUIT_IDS; }