@zkproofport-app/sdk 0.4.1 → 0.4.2

package/dist/index.js

@@ -2054,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
  */
@@ -3179,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
@@ -3200,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));
@@ -3218,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
@@ -3437,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;
@@ -3446,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;