@zkproofport-app/sdk 0.4.0 → 0.4.2

package/dist/index.js

@@ -103,6 +103,18 @@ const CIRCUIT_METADATA = {
         publicInputsCount: 192,
         publicInputNames: ['signal_hash', 'domain_separator', 'action_hash', 'signer_list_merkle_root', 'scope', 'nullifier'],
     },
+    // Experimental, GIWA Sepolia only. The wallet signs the request (an EIP-712
+    // action, or signal_hash when none is given -- the same branch as GIWA), and
+    // the same key must have signed a payAndIssueEAS() call to the Playground
+    // faucet. No issuer list, so no merkle root: 5 x [u8; 32] = 160, read off the
+    // compiled ABI -- signal_hash 0-31, domain_separator 32-63, action_hash
+    // 64-95, scope 96-127, nullifier 128-159.
+    dojang_playground: {
+        name: 'Dojang Playground',
+        description: 'Prove this wallet issued itself a Dojang through the GIWA Playground, optionally authorizing one EIP-712 action',
+        publicInputsCount: 160,
+        publicInputNames: ['signal_hash', 'domain_separator', 'action_hash', '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.
@@ -377,6 +389,8 @@ const CIRCUIT_IDS = Object.freeze({
     OIDC_DOMAIN_ATTESTATION: 'oidc_domain_attestation',
     /** GIWA attestation. Planned — not officially supported yet. */
     GIWA_ATTESTATION: 'giwa_attestation',
+    /** Dojang Playground on GIWA Sepolia. Experimental — testnet only. */
+    DOJANG_PLAYGROUND: 'dojang_playground',
     /** 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. */
@@ -408,6 +422,9 @@ const CIRCUIT_SUPPORT_STATUS = Object.freeze({
     // 'supported' is that it is testnet-only, so the app offers it behind
     // Developer Mode and reads its files from main rather than a release tag.
     giwa_attestation: 'experimental',
+    // Same footing as GIWA: built, verifier deployed on GIWA Sepolia, a real
+    // proof verifies there. Testnet only.
+    dojang_playground: 'experimental',
     mdl_kr_ownership: 'planned',
     mdl_kr_age: 'planned',
     mdl_kr_region: 'planned',
@@ -437,6 +454,7 @@ const CIRCUIT_VK_PATHS = Object.freeze({
     coinbase_country_attestation: 'coinbase-country-attestation/target/vk/vk',
     oidc_domain_attestation: 'oidc-domain-attestation/target/vk/vk',
     giwa_attestation: 'giwa-attestation/target/vk/vk',
+    dojang_playground: 'dojang-playground/target/vk/vk',
     mdl_kr_ownership: 'mdl/kr-ownership/target/vk/vk',
     mdl_kr_age: 'mdl/kr-age/target/vk/vk',
     mdl_kr_region: 'mdl/kr-region/target/vk/vk',
@@ -525,6 +543,8 @@ const CIRCUIT_ACTION_BINDING = {
     // Branches in-circuit: with an action the wallet signs the typed data,
     // without one it personal_signs the request's signal hash.
     giwa_attestation: 'optional',
+    // Same branch as GIWA; see dojang-playground/src/main.nr.
+    dojang_playground: 'optional',
     mdl_kr_ownership: 'none',
     mdl_kr_age: 'none',
     mdl_kr_region: 'none',
@@ -565,6 +585,9 @@ const CIRCUIT_NEEDS_WALLET_SIGNATURE = {
     // -- it sat under the Web2 comment above and was never revisited. A request
     // for it would have reached the relay with no signer.
     giwa_attestation: true,
+    // The wallet signs the request, and the same key must have signed its
+    // Playground faucet transaction.
+    dojang_playground: true,
 };
 
 const ADDRESS = /^0x[0-9a-fA-F]{40}$/;
@@ -1648,6 +1671,9 @@ const PUBLIC_INPUT_OFFSETS = Object.freeze({
     // it reads: signal_hash, domain_separator, action_hash, merkle root, then
     // scope and nullifier 64 bytes further along than Coinbase.
     giwa_attestation: { scope: [128, 159], nullifier: [160, 191] },
+    // signal_hash, domain_separator, action_hash, scope, nullifier: GIWA's
+    // order without the merkle root, since there is no issuer list.
+    dojang_playground: { scope: [96, 127], nullifier: [128, 159] },
     // country_list, country_list_length and is_included sit before scope.
     coinbase_country_attestation: { scope: [86, 117], nullifier: [118, 149] },
     // pubkey_modulus_limbs and the bounded domain sit before scope.
@@ -2028,6 +2054,17 @@ async function verifyProofOffChain(circuit, proof, publicInputs, options = {}) {
     }
 }
 
+/**
+ * The statuses a relay request ends in, as a runtime list. `satisfies` keeps it
+ * in step with the `RelayTerminalStatus` type in both directions: a status
+ * added to the type and not here, or here and not in the type, fails to compile.
+ */
+const RELAY_TERMINAL_STATUSES = ['completed', 'error', 'failed', 'cancelled', 'expired'];
+/** True when `status` is one a relay request ends in. */
+function isTerminalRelayStatus(status) {
+    return RELAY_TERMINAL_STATUSES.includes(status);
+}
+
 /**
  * Proofport SDK - Main class
  */
@@ -3153,7 +3190,9 @@ class ProofportSDK {
         return await response.json();
     }
     /**
-     * Polls the relay until proof is completed or failed, with configurable interval and timeout.
+     * Polls the relay until the request reaches a terminal status
+     * (`completed`, `error`, `failed`, `cancelled` or `expired`), with
+     * configurable interval and timeout. Branch on `result.status`.
      *
      * @param requestId - The relay-issued request ID
      * @param options - Polling options
@@ -3174,7 +3213,10 @@ class ProofportSDK {
                 lastStatus = result.status;
                 options.onStatusChange?.(result);
             }
-            if (result.status === 'completed' || result.status === 'failed') {
+            // Every terminal status ends the wait, not only success: an app error,
+            // a cancellation and a relay-side timeout are answers too, and polling
+            // past them would only end in this method's own timeout.
+            if (isTerminalRelayStatus(result.status)) {
                 return result;
             }
             await new Promise(resolve => setTimeout(resolve, interval));
@@ -3192,7 +3234,7 @@ class ProofportSDK {
      * @param requestId - The relay-issued request ID to subscribe to
      * @param callbacks - Event callbacks for status changes and results
      * @param callbacks.onStatus - Called on status updates (pending, generating)
-     * @param callbacks.onResult - Called when proof is completed or failed
+     * @param callbacks.onResult - Called once with the terminal result: completed, error, failed, cancelled or expired
      * @param callbacks.onError - Called on errors
      * @returns Unsubscribe function to clean up the connection
      * @throws Error if relayUrl not set or socket.io-client not installed
@@ -3411,6 +3453,7 @@ 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.RELAY_TERMINAL_STATUSES = RELAY_TERMINAL_STATUSES;
 exports.SUPPORTED_CIRCUIT_IDS = SUPPORTED_CIRCUIT_IDS;
 exports.circuitActionBinding = circuitActionBinding;
 exports.default = ProofportSDK;
@@ -3420,6 +3463,7 @@ exports.extractScopeFromPublicInputs = extractScopeFromPublicInputs;
 exports.getCircuitSupportStatus = getCircuitSupportStatus;
 exports.isCircuitId = isCircuitId;
 exports.isSupportedCircuitId = isSupportedCircuitId;
+exports.isTerminalRelayStatus = isTerminalRelayStatus;
 exports.parseTypedAction = parseTypedAction;
 exports.validateTypedAction = validateTypedAction;
 exports.verifyProofOffChain = verifyProofOffChain;