@okxweb3/app-x402-core 0.1.2

package/dist/esm/client/index.mjs

@@ -0,0 +1,318 @@
+import {
+  x402HTTPClient
+} from "../chunk-XBQG2CDV.mjs";
+import {
+  x402Version
+} from "../chunk-O3IYMTNT.mjs";
+import "../chunk-CAXWAW23.mjs";
+import {
+  findByNetworkAndScheme,
+  findSchemesByNetwork
+} from "../chunk-TDLQZ6MP.mjs";
+import "../chunk-CS33MEMU.mjs";
+
+// src/client/x402Client.ts
+var x402Client = class _x402Client {
+  /**
+   * Creates a new x402Client instance.
+   *
+   * @param paymentRequirementsSelector - Function to select payment requirements from available options
+   */
+  constructor(paymentRequirementsSelector) {
+    this.registeredClientSchemes = /* @__PURE__ */ new Map();
+    this.policies = [];
+    this.registeredExtensions = /* @__PURE__ */ new Map();
+    this.beforePaymentCreationHooks = [];
+    this.afterPaymentCreationHooks = [];
+    this.onPaymentCreationFailureHooks = [];
+    this.paymentRequirementsSelector = paymentRequirementsSelector || ((x402Version2, accepts) => accepts[0]);
+  }
+  /**
+   * Creates a new x402Client instance from a configuration object.
+   *
+   * @param config - The client configuration including schemes, policies, and payment requirements selector
+   * @returns A configured x402Client instance
+   */
+  static fromConfig(config) {
+    const client = new _x402Client(config.paymentRequirementsSelector);
+    config.schemes.forEach((scheme) => {
+      client.register(scheme.network, scheme.client);
+    });
+    config.policies?.forEach((policy) => {
+      client.registerPolicy(policy);
+    });
+    return client;
+  }
+  /**
+   * Registers a scheme client for the current x402 version.
+   *
+   * @param network - The network to register the client for
+   * @param client - The scheme network client to register
+   * @returns The x402Client instance for chaining
+   */
+  register(network, client) {
+    return this._registerScheme(x402Version, network, client);
+  }
+  /**
+   * Registers a policy to filter or transform payment requirements.
+   *
+   * Policies are applied in order after filtering by registered schemes
+   * and before the selector chooses the final payment requirement.
+   *
+   * @param policy - Function to filter/transform payment requirements
+   * @returns The x402Client instance for chaining
+   *
+   * @example
+   * ```typescript
+   * // Prefer cheaper options
+   * client.registerPolicy((version, reqs) =>
+   *   reqs.filter(r => BigInt(r.value) < BigInt('1000000'))
+   * );
+   *
+   * // Prefer specific networks
+   * client.registerPolicy((version, reqs) =>
+   *   reqs.filter(r => r.network.startsWith('eip155:'))
+   * );
+   * ```
+   */
+  registerPolicy(policy) {
+    this.policies.push(policy);
+    return this;
+  }
+  /**
+   * Registers a client extension that can enrich payment payloads.
+   *
+   * Extensions are invoked after the scheme creates the base payload and the
+   * payload is wrapped with extensions/resource/accepted data. If the extension's
+   * key is present in `paymentRequired.extensions`, the extension's
+   * `enrichPaymentPayload` hook is called to modify the payload.
+   *
+   * @param extension - The client extension to register
+   * @returns The x402Client instance for chaining
+   */
+  registerExtension(extension) {
+    this.registeredExtensions.set(extension.key, extension);
+    return this;
+  }
+  /**
+   * Register a hook to execute before payment payload creation.
+   * Can abort creation by returning { abort: true, reason: string }
+   *
+   * @param hook - The hook function to register
+   * @returns The x402Client instance for chaining
+   */
+  onBeforePaymentCreation(hook) {
+    this.beforePaymentCreationHooks.push(hook);
+    return this;
+  }
+  /**
+   * Register a hook to execute after successful payment payload creation.
+   *
+   * @param hook - The hook function to register
+   * @returns The x402Client instance for chaining
+   */
+  onAfterPaymentCreation(hook) {
+    this.afterPaymentCreationHooks.push(hook);
+    return this;
+  }
+  /**
+   * Register a hook to execute when payment payload creation fails.
+   * Can recover from failure by returning { recovered: true, payload: PaymentPayload }
+   *
+   * @param hook - The hook function to register
+   * @returns The x402Client instance for chaining
+   */
+  onPaymentCreationFailure(hook) {
+    this.onPaymentCreationFailureHooks.push(hook);
+    return this;
+  }
+  /**
+   * Creates a payment payload based on a PaymentRequired response.
+   *
+   * Automatically extracts x402Version, resource, and extensions from the PaymentRequired
+   * response and constructs a complete PaymentPayload with the accepted requirements.
+   *
+   * @param paymentRequired - The PaymentRequired response from the server
+   * @returns Promise resolving to the complete payment payload
+   */
+  async createPaymentPayload(paymentRequired) {
+    const clientSchemesByNetwork = this.registeredClientSchemes.get(paymentRequired.x402Version);
+    if (!clientSchemesByNetwork) {
+      throw new Error(`No client registered for x402 version: ${paymentRequired.x402Version}`);
+    }
+    const requirements = this.selectPaymentRequirements(paymentRequired.x402Version, paymentRequired.accepts);
+    const context = {
+      paymentRequired,
+      selectedRequirements: requirements
+    };
+    for (const hook of this.beforePaymentCreationHooks) {
+      const result = await hook(context);
+      if (result && "abort" in result && result.abort) {
+        throw new Error(`Payment creation aborted: ${result.reason}`);
+      }
+    }
+    try {
+      const schemeNetworkClient = findByNetworkAndScheme(clientSchemesByNetwork, requirements.scheme, requirements.network);
+      if (!schemeNetworkClient) {
+        throw new Error(`No client registered for scheme: ${requirements.scheme} and network: ${requirements.network}`);
+      }
+      const partialPayload = await schemeNetworkClient.createPaymentPayload(
+        paymentRequired.x402Version,
+        requirements,
+        { extensions: paymentRequired.extensions }
+      );
+      const mergedExtensions = this.mergeExtensions(
+        paymentRequired.extensions,
+        partialPayload.extensions
+      );
+      const acceptedRequirements = partialPayload.acceptedExtraOverrides && Object.keys(partialPayload.acceptedExtraOverrides).length > 0 ? {
+        ...requirements,
+        extra: {
+          ...requirements.extra,
+          ...partialPayload.acceptedExtraOverrides
+        }
+      } : requirements;
+      let paymentPayload = {
+        x402Version: partialPayload.x402Version,
+        payload: partialPayload.payload,
+        extensions: mergedExtensions,
+        resource: paymentRequired.resource,
+        accepted: acceptedRequirements
+      };
+      paymentPayload = await this.enrichPaymentPayloadWithExtensions(paymentPayload, paymentRequired);
+      const createdContext = {
+        ...context,
+        paymentPayload
+      };
+      for (const hook of this.afterPaymentCreationHooks) {
+        await hook(createdContext);
+      }
+      return paymentPayload;
+    } catch (error) {
+      const failureContext = {
+        ...context,
+        error
+      };
+      for (const hook of this.onPaymentCreationFailureHooks) {
+        const result = await hook(failureContext);
+        if (result && "recovered" in result && result.recovered) {
+          return result.payload;
+        }
+      }
+      throw error;
+    }
+  }
+  /**
+   * Merges server-declared extensions with scheme-provided extensions.
+   * Scheme extensions overlay on top of server extensions at each key,
+   * preserving server-provided schema while overlaying scheme-provided info.
+   *
+   * @param serverExtensions - Extensions declared by the server in the 402 response
+   * @param schemeExtensions - Extensions provided by the scheme client (e.g. EIP-2612)
+   * @returns The merged extensions object, or undefined if both inputs are undefined
+   */
+  mergeExtensions(serverExtensions, schemeExtensions) {
+    if (!schemeExtensions) return serverExtensions;
+    if (!serverExtensions) return schemeExtensions;
+    const merged = { ...serverExtensions };
+    for (const [key, schemeValue] of Object.entries(schemeExtensions)) {
+      const serverValue = merged[key];
+      if (serverValue && typeof serverValue === "object" && schemeValue && typeof schemeValue === "object") {
+        merged[key] = { ...serverValue, ...schemeValue };
+      } else {
+        merged[key] = schemeValue;
+      }
+    }
+    return merged;
+  }
+  /**
+   * Enriches a payment payload by calling registered extension hooks.
+   * For each extension key present in the PaymentRequired response,
+   * invokes the corresponding extension's enrichPaymentPayload callback.
+   *
+   * @param paymentPayload - The payment payload to enrich with extension data
+   * @param paymentRequired - The PaymentRequired response containing extension declarations
+   * @returns The enriched payment payload with extension data applied
+   */
+  async enrichPaymentPayloadWithExtensions(paymentPayload, paymentRequired) {
+    if (!paymentRequired.extensions || this.registeredExtensions.size === 0) {
+      return paymentPayload;
+    }
+    let enriched = paymentPayload;
+    for (const [key, extension] of this.registeredExtensions) {
+      if (key in paymentRequired.extensions && extension.enrichPaymentPayload) {
+        enriched = await extension.enrichPaymentPayload(enriched, paymentRequired);
+      }
+    }
+    return enriched;
+  }
+  /**
+   * Selects appropriate payment requirements based on registered clients and policies.
+   *
+   * Selection process:
+   * 1. Filter by registered schemes (network + scheme support)
+   * 2. Apply all registered policies in order
+   * 3. Use selector to choose final requirement
+   *
+   * @param x402Version - The x402 protocol version
+   * @param paymentRequirements - Array of available payment requirements
+   * @returns The selected payment requirements
+   */
+  selectPaymentRequirements(x402Version2, paymentRequirements) {
+    const clientSchemesByNetwork = this.registeredClientSchemes.get(x402Version2);
+    if (!clientSchemesByNetwork) {
+      throw new Error(`No client registered for x402 version: ${x402Version2}`);
+    }
+    const supportedPaymentRequirements = paymentRequirements.filter((requirement) => {
+      let clientSchemes = findSchemesByNetwork(clientSchemesByNetwork, requirement.network);
+      if (!clientSchemes) {
+        return false;
+      }
+      return clientSchemes.has(requirement.scheme);
+    });
+    if (supportedPaymentRequirements.length === 0) {
+      throw new Error(`No network/scheme registered for x402 version: ${x402Version2} which comply with the payment requirements. ${JSON.stringify({
+        x402Version: x402Version2,
+        paymentRequirements,
+        x402Versions: Array.from(this.registeredClientSchemes.keys()),
+        networks: Array.from(clientSchemesByNetwork.keys()),
+        schemes: Array.from(clientSchemesByNetwork.values()).map((schemes) => Array.from(schemes.keys())).flat()
+      })}`);
+    }
+    let filteredRequirements = supportedPaymentRequirements;
+    for (const policy of this.policies) {
+      filteredRequirements = policy(x402Version2, filteredRequirements);
+      if (filteredRequirements.length === 0) {
+        throw new Error(`All payment requirements were filtered out by policies for x402 version: ${x402Version2}`);
+      }
+    }
+    return this.paymentRequirementsSelector(x402Version2, filteredRequirements);
+  }
+  /**
+   * Internal method to register a scheme client.
+   *
+   * @param x402Version - The x402 protocol version
+   * @param network - The network to register the client for
+   * @param client - The scheme network client to register
+   * @returns The x402Client instance for chaining
+   */
+  _registerScheme(x402Version2, network, client) {
+    if (!this.registeredClientSchemes.has(x402Version2)) {
+      this.registeredClientSchemes.set(x402Version2, /* @__PURE__ */ new Map());
+    }
+    const clientSchemesByNetwork = this.registeredClientSchemes.get(x402Version2);
+    if (!clientSchemesByNetwork.has(network)) {
+      clientSchemesByNetwork.set(network, /* @__PURE__ */ new Map());
+    }
+    const clientByScheme = clientSchemesByNetwork.get(network);
+    if (!clientByScheme.has(client.scheme)) {
+      clientByScheme.set(client.scheme, client);
+    }
+    return this;
+  }
+};
+export {
+  x402Client,
+  x402HTTPClient
+};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/client/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/client/x402Client.ts"],"sourcesContent":["import { x402Version } from \"..\";\nimport { SchemeNetworkClient } from \"../types/mechanisms\";\nimport { PaymentPayload, PaymentRequirements } from \"../types/payments\";\nimport { Network, PaymentRequired } from \"../types\";\nimport { findByNetworkAndScheme, findSchemesByNetwork } from \"../utils\";\n\n/**\n * Client Hook Context Interfaces\n */\n\nexport interface PaymentCreationContext {\n  paymentRequired: PaymentRequired;\n  selectedRequirements: PaymentRequirements;\n}\n\nexport interface PaymentCreatedContext extends PaymentCreationContext {\n  paymentPayload: PaymentPayload;\n}\n\nexport interface PaymentCreationFailureContext extends PaymentCreationContext {\n  error: Error;\n}\n\n/**\n * Client Hook Type Definitions\n */\n\nexport type BeforePaymentCreationHook = (\n  context: PaymentCreationContext,\n) => Promise<void | { abort: true; reason: string }>;\n\nexport type AfterPaymentCreationHook = (context: PaymentCreatedContext) => Promise<void>;\n\nexport type OnPaymentCreationFailureHook = (\n  context: PaymentCreationFailureContext,\n) => Promise<void | { recovered: true; payload: PaymentPayload }>;\n\nexport type SelectPaymentRequirements = (x402Version: number, paymentRequirements: PaymentRequirements[]) => PaymentRequirements;\n\n/**\n * Extension that can enrich payment payloads on the client side.\n *\n * Client extensions are invoked after the scheme creates the base payment payload\n * but before it is returned. This allows mechanism-specific logic (e.g., EVM EIP-2612\n * permit signing) to enrich the payload's extensions data.\n */\nexport interface ClientExtension {\n  /**\n   * Unique key identifying this extension (e.g., \"eip2612GasSponsoring\").\n   * Must match the extension key used in PaymentRequired.extensions.\n   */\n  key: string;\n\n  /**\n   * Called after payload creation when the extension key is present in\n   * paymentRequired.extensions. Allows the extension to enrich the payload\n   * with extension-specific data (e.g., signing an EIP-2612 permit).\n   *\n   * @param paymentPayload - The payment payload to enrich\n   * @param paymentRequired - The original PaymentRequired response\n   * @returns The enriched payment payload\n   */\n  enrichPaymentPayload?: (\n    paymentPayload: PaymentPayload,\n    paymentRequired: PaymentRequired,\n  ) => Promise<PaymentPayload>;\n}\n\n/**\n * A policy function that filters or transforms payment requirements.\n * Policies are applied in order before the selector chooses the final option.\n *\n * @param x402Version - The x402 protocol version\n * @param paymentRequirements - Array of payment requirements to filter/transform\n * @returns Filtered array of payment requirements\n */\nexport type PaymentPolicy = (x402Version: number, paymentRequirements: PaymentRequirements[]) => PaymentRequirements[];\n\n\n/**\n * Configuration for registering a payment scheme with a specific network\n */\nexport interface SchemeRegistration {\n  /**\n   * The network identifier (e.g., 'eip155:196', 'eip155:196')\n   */\n  network: Network;\n\n  /**\n   * The scheme client implementation for this network\n   */\n  client: SchemeNetworkClient;\n\n  /**\n   * The x402 protocol version to use for this scheme\n   *\n   * @default 2\n   */\n  x402Version?: number;\n}\n\n/**\n * Configuration options for the fetch wrapper\n */\nexport interface x402ClientConfig {\n  /**\n   * Array of scheme registrations defining which payment methods are supported\n   */\n  schemes: SchemeRegistration[];\n\n  /**\n   * Policies to apply to the client\n   */\n  policies?: PaymentPolicy[];\n\n  /**\n   * Custom payment requirements selector function\n   * If not provided, uses the default selector (first available option)\n   */\n  paymentRequirementsSelector?: SelectPaymentRequirements;\n}\n\n/**\n * Core client for managing x402 payment schemes and creating payment payloads.\n *\n * Handles registration of payment schemes, policy-based filtering of payment requirements,\n * and creation of payment payloads based on server requirements.\n */\nexport class x402Client {\n  private readonly paymentRequirementsSelector: SelectPaymentRequirements;\n  private readonly registeredClientSchemes: Map<number, Map<string, Map<string, SchemeNetworkClient>>> = new Map();\n  private readonly policies: PaymentPolicy[] = [];\n  private readonly registeredExtensions: Map<string, ClientExtension> = new Map();\n\n  private beforePaymentCreationHooks: BeforePaymentCreationHook[] = [];\n  private afterPaymentCreationHooks: AfterPaymentCreationHook[] = [];\n  private onPaymentCreationFailureHooks: OnPaymentCreationFailureHook[] = [];\n\n  /**\n   * Creates a new x402Client instance.\n   *\n   * @param paymentRequirementsSelector - Function to select payment requirements from available options\n   */\n  constructor(paymentRequirementsSelector?: SelectPaymentRequirements) {\n    this.paymentRequirementsSelector = paymentRequirementsSelector || ((x402Version, accepts) => accepts[0]);\n  }\n\n  /**\n   * Creates a new x402Client instance from a configuration object.\n   *\n   * @param config - The client configuration including schemes, policies, and payment requirements selector\n   * @returns A configured x402Client instance\n   */\n  static fromConfig(config: x402ClientConfig): x402Client {\n    const client = new x402Client(config.paymentRequirementsSelector);\n    config.schemes.forEach(scheme => {\n      client.register(scheme.network, scheme.client);\n    });\n    config.policies?.forEach(policy => {\n      client.registerPolicy(policy);\n    });\n    return client;\n  }\n\n  /**\n   * Registers a scheme client for the current x402 version.\n   *\n   * @param network - The network to register the client for\n   * @param client - The scheme network client to register\n   * @returns The x402Client instance for chaining\n   */\n  register(network: Network, client: SchemeNetworkClient): x402Client {\n    return this._registerScheme(x402Version, network, client);\n  }\n\n  /**\n   * Registers a policy to filter or transform payment requirements.\n   *\n   * Policies are applied in order after filtering by registered schemes\n   * and before the selector chooses the final payment requirement.\n   *\n   * @param policy - Function to filter/transform payment requirements\n   * @returns The x402Client instance for chaining\n   *\n   * @example\n   * ```typescript\n   * // Prefer cheaper options\n   * client.registerPolicy((version, reqs) =>\n   *   reqs.filter(r => BigInt(r.value) < BigInt('1000000'))\n   * );\n   *\n   * // Prefer specific networks\n   * client.registerPolicy((version, reqs) =>\n   *   reqs.filter(r => r.network.startsWith('eip155:'))\n   * );\n   * ```\n   */\n  registerPolicy(policy: PaymentPolicy): x402Client {\n    this.policies.push(policy);\n    return this;\n  }\n\n  /**\n   * Registers a client extension that can enrich payment payloads.\n   *\n   * Extensions are invoked after the scheme creates the base payload and the\n   * payload is wrapped with extensions/resource/accepted data. If the extension's\n   * key is present in `paymentRequired.extensions`, the extension's\n   * `enrichPaymentPayload` hook is called to modify the payload.\n   *\n   * @param extension - The client extension to register\n   * @returns The x402Client instance for chaining\n   */\n  registerExtension(extension: ClientExtension): x402Client {\n    this.registeredExtensions.set(extension.key, extension);\n    return this;\n  }\n\n  /**\n   * Register a hook to execute before payment payload creation.\n   * Can abort creation by returning { abort: true, reason: string }\n   *\n   * @param hook - The hook function to register\n   * @returns The x402Client instance for chaining\n   */\n  onBeforePaymentCreation(hook: BeforePaymentCreationHook): x402Client {\n    this.beforePaymentCreationHooks.push(hook);\n    return this;\n  }\n\n  /**\n   * Register a hook to execute after successful payment payload creation.\n   *\n   * @param hook - The hook function to register\n   * @returns The x402Client instance for chaining\n   */\n  onAfterPaymentCreation(hook: AfterPaymentCreationHook): x402Client {\n    this.afterPaymentCreationHooks.push(hook);\n    return this;\n  }\n\n  /**\n   * Register a hook to execute when payment payload creation fails.\n   * Can recover from failure by returning { recovered: true, payload: PaymentPayload }\n   *\n   * @param hook - The hook function to register\n   * @returns The x402Client instance for chaining\n   */\n  onPaymentCreationFailure(hook: OnPaymentCreationFailureHook): x402Client {\n    this.onPaymentCreationFailureHooks.push(hook);\n    return this;\n  }\n\n  /**\n   * Creates a payment payload based on a PaymentRequired response.\n   *\n   * Automatically extracts x402Version, resource, and extensions from the PaymentRequired\n   * response and constructs a complete PaymentPayload with the accepted requirements.\n   *\n   * @param paymentRequired - The PaymentRequired response from the server\n   * @returns Promise resolving to the complete payment payload\n   */\n  async createPaymentPayload(\n    paymentRequired: PaymentRequired,\n  ): Promise<PaymentPayload> {\n    const clientSchemesByNetwork = this.registeredClientSchemes.get(paymentRequired.x402Version);\n    if (!clientSchemesByNetwork) {\n      throw new Error(`No client registered for x402 version: ${paymentRequired.x402Version}`);\n    }\n\n    const requirements = this.selectPaymentRequirements(paymentRequired.x402Version, paymentRequired.accepts);\n\n    const context: PaymentCreationContext = {\n      paymentRequired,\n      selectedRequirements: requirements,\n    };\n\n    // Execute beforePaymentCreation hooks\n    for (const hook of this.beforePaymentCreationHooks) {\n      const result = await hook(context);\n      if (result && \"abort\" in result && result.abort) {\n        throw new Error(`Payment creation aborted: ${result.reason}`);\n      }\n    }\n\n    try {\n      const schemeNetworkClient = findByNetworkAndScheme(clientSchemesByNetwork, requirements.scheme, requirements.network);\n      if (!schemeNetworkClient) {\n        throw new Error(`No client registered for scheme: ${requirements.scheme} and network: ${requirements.network}`);\n      }\n\n      const partialPayload = await schemeNetworkClient.createPaymentPayload(\n        paymentRequired.x402Version,\n        requirements,\n        { extensions: paymentRequired.extensions },\n      );\n\n      // Merge server-declared extensions with any scheme-provided extensions.\n      // Scheme extensions overlay on top (e.g., EIP-2612 info enriches server declaration).\n      const mergedExtensions = this.mergeExtensions(\n        paymentRequired.extensions,\n        partialPayload.extensions,\n      );\n\n      // Apply acceptedExtraOverrides: OKX extension for injecting scheme-specific\n      // fields (e.g. sessionCert) into accepted.extra per the OKX API spec.\n      const acceptedRequirements =\n        partialPayload.acceptedExtraOverrides && Object.keys(partialPayload.acceptedExtraOverrides).length > 0\n          ? {\n              ...requirements,\n              extra: {\n                ...requirements.extra,\n                ...partialPayload.acceptedExtraOverrides,\n              },\n            }\n          : requirements;\n\n      let paymentPayload: PaymentPayload = {\n        x402Version: partialPayload.x402Version,\n        payload: partialPayload.payload,\n        extensions: mergedExtensions,\n        resource: paymentRequired.resource,\n        accepted: acceptedRequirements,\n      };\n\n      // Enrich payload via registered client extensions (for non-scheme extensions)\n      paymentPayload = await this.enrichPaymentPayloadWithExtensions(paymentPayload, paymentRequired);\n\n      // Execute afterPaymentCreation hooks\n      const createdContext: PaymentCreatedContext = {\n        ...context,\n        paymentPayload,\n      };\n\n      for (const hook of this.afterPaymentCreationHooks) {\n        await hook(createdContext);\n      }\n\n      return paymentPayload;\n    } catch (error) {\n      const failureContext: PaymentCreationFailureContext = {\n        ...context,\n        error: error as Error,\n      };\n\n      // Execute onPaymentCreationFailure hooks\n      for (const hook of this.onPaymentCreationFailureHooks) {\n        const result = await hook(failureContext);\n        if (result && \"recovered\" in result && result.recovered) {\n          return result.payload;\n        }\n      }\n\n      throw error;\n    }\n  }\n\n\n\n  /**\n   * Merges server-declared extensions with scheme-provided extensions.\n   * Scheme extensions overlay on top of server extensions at each key,\n   * preserving server-provided schema while overlaying scheme-provided info.\n   *\n   * @param serverExtensions - Extensions declared by the server in the 402 response\n   * @param schemeExtensions - Extensions provided by the scheme client (e.g. EIP-2612)\n   * @returns The merged extensions object, or undefined if both inputs are undefined\n   */\n  private mergeExtensions(\n    serverExtensions?: Record<string, unknown>,\n    schemeExtensions?: Record<string, unknown>,\n  ): Record<string, unknown> | undefined {\n    if (!schemeExtensions) return serverExtensions;\n    if (!serverExtensions) return schemeExtensions;\n\n    const merged = { ...serverExtensions };\n    for (const [key, schemeValue] of Object.entries(schemeExtensions)) {\n      const serverValue = merged[key];\n      if (\n        serverValue &&\n        typeof serverValue === \"object\" &&\n        schemeValue &&\n        typeof schemeValue === \"object\"\n      ) {\n        // Deep merge: scheme info overlays server info, schema preserved\n        merged[key] = { ...serverValue as Record<string, unknown>, ...schemeValue as Record<string, unknown> };\n      } else {\n        merged[key] = schemeValue;\n      }\n    }\n    return merged;\n  }\n\n  /**\n   * Enriches a payment payload by calling registered extension hooks.\n   * For each extension key present in the PaymentRequired response,\n   * invokes the corresponding extension's enrichPaymentPayload callback.\n   *\n   * @param paymentPayload - The payment payload to enrich with extension data\n   * @param paymentRequired - The PaymentRequired response containing extension declarations\n   * @returns The enriched payment payload with extension data applied\n   */\n  private async enrichPaymentPayloadWithExtensions(\n    paymentPayload: PaymentPayload,\n    paymentRequired: PaymentRequired,\n  ): Promise<PaymentPayload> {\n    if (!paymentRequired.extensions || this.registeredExtensions.size === 0) {\n      return paymentPayload;\n    }\n\n    let enriched = paymentPayload;\n    for (const [key, extension] of this.registeredExtensions) {\n      if (key in paymentRequired.extensions && extension.enrichPaymentPayload) {\n        enriched = await extension.enrichPaymentPayload(enriched, paymentRequired);\n      }\n    }\n\n    return enriched;\n  }\n\n  /**\n   * Selects appropriate payment requirements based on registered clients and policies.\n   *\n   * Selection process:\n   * 1. Filter by registered schemes (network + scheme support)\n   * 2. Apply all registered policies in order\n   * 3. Use selector to choose final requirement\n   *\n   * @param x402Version - The x402 protocol version\n   * @param paymentRequirements - Array of available payment requirements\n   * @returns The selected payment requirements\n   */\n  private selectPaymentRequirements(x402Version: number, paymentRequirements: PaymentRequirements[]): PaymentRequirements {\n    const clientSchemesByNetwork = this.registeredClientSchemes.get(x402Version);\n    if (!clientSchemesByNetwork) {\n      throw new Error(`No client registered for x402 version: ${x402Version}`);\n    }\n\n    // Step 1: Filter by registered schemes\n    const supportedPaymentRequirements = paymentRequirements.filter(requirement => {\n      let clientSchemes = findSchemesByNetwork(clientSchemesByNetwork, requirement.network);\n      if (!clientSchemes) {\n        return false;\n      }\n\n      return clientSchemes.has(requirement.scheme);\n    })\n\n    if (supportedPaymentRequirements.length === 0) {\n      throw new Error(`No network/scheme registered for x402 version: ${x402Version} which comply with the payment requirements. ${JSON.stringify({\n        x402Version,\n        paymentRequirements,\n        x402Versions: Array.from(this.registeredClientSchemes.keys()),\n        networks: Array.from(clientSchemesByNetwork.keys()),\n        schemes: Array.from(clientSchemesByNetwork.values()).map(schemes => Array.from(schemes.keys())).flat(),\n      })}`);\n    }\n\n    // Step 2: Apply all policies in order\n    let filteredRequirements = supportedPaymentRequirements;\n    for (const policy of this.policies) {\n      filteredRequirements = policy(x402Version, filteredRequirements);\n\n      if (filteredRequirements.length === 0) {\n        throw new Error(`All payment requirements were filtered out by policies for x402 version: ${x402Version}`);\n      }\n    }\n\n    // Step 3: Use selector to choose final requirement\n    return this.paymentRequirementsSelector(x402Version, filteredRequirements);\n  }\n\n  /**\n   * Internal method to register a scheme client.\n   *\n   * @param x402Version - The x402 protocol version\n   * @param network - The network to register the client for\n   * @param client - The scheme network client to register\n   * @returns The x402Client instance for chaining\n   */\n  private _registerScheme(x402Version: number, network: Network, client: SchemeNetworkClient): x402Client {\n    if (!this.registeredClientSchemes.has(x402Version)) {\n      this.registeredClientSchemes.set(x402Version, new Map());\n    }\n    const clientSchemesByNetwork = this.registeredClientSchemes.get(x402Version)!;\n    if (!clientSchemesByNetwork.has(network)) {\n      clientSchemesByNetwork.set(network, new Map());\n    }\n\n    const clientByScheme = clientSchemesByNetwork.get(network)!;\n    if (!clientByScheme.has(client.scheme)) {\n      clientByScheme.set(client.scheme, client);\n    }\n\n    return this;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;AAgIO,IAAM,aAAN,MAAM,YAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAetB,YAAY,6BAAyD;AAbrE,SAAiB,0BAAsF,oBAAI,IAAI;AAC/G,SAAiB,WAA4B,CAAC;AAC9C,SAAiB,uBAAqD,oBAAI,IAAI;AAE9E,SAAQ,6BAA0D,CAAC;AACnE,SAAQ,4BAAwD,CAAC;AACjE,SAAQ,gCAAgE,CAAC;AAQvE,SAAK,8BAA8B,gCAAgC,CAACA,cAAa,YAAY,QAAQ,CAAC;AAAA,EACxG;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAO,WAAW,QAAsC;AACtD,UAAM,SAAS,IAAI,YAAW,OAAO,2BAA2B;AAChE,WAAO,QAAQ,QAAQ,YAAU;AAC/B,aAAO,SAAS,OAAO,SAAS,OAAO,MAAM;AAAA,IAC/C,CAAC;AACD,WAAO,UAAU,QAAQ,YAAU;AACjC,aAAO,eAAe,MAAM;AAAA,IAC9B,CAAC;AACD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,SAAS,SAAkB,QAAyC;AAClE,WAAO,KAAK,gBAAgB,aAAa,SAAS,MAAM;AAAA,EAC1D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBA,eAAe,QAAmC;AAChD,SAAK,SAAS,KAAK,MAAM;AACzB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,kBAAkB,WAAwC;AACxD,SAAK,qBAAqB,IAAI,UAAU,KAAK,SAAS;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,wBAAwB,MAA6C;AACnE,SAAK,2BAA2B,KAAK,IAAI;AACzC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,uBAAuB,MAA4C;AACjE,SAAK,0BAA0B,KAAK,IAAI;AACxC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,yBAAyB,MAAgD;AACvE,SAAK,8BAA8B,KAAK,IAAI;AAC5C,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAM,qBACJ,iBACyB;AACzB,UAAM,yBAAyB,KAAK,wBAAwB,IAAI,gBAAgB,WAAW;AAC3F,QAAI,CAAC,wBAAwB;AAC3B,YAAM,IAAI,MAAM,0CAA0C,gBAAgB,WAAW,EAAE;AAAA,IACzF;AAEA,UAAM,eAAe,KAAK,0BAA0B,gBAAgB,aAAa,gBAAgB,OAAO;AAExG,UAAM,UAAkC;AAAA,MACtC;AAAA,MACA,sBAAsB;AAAA,IACxB;AAGA,eAAW,QAAQ,KAAK,4BAA4B;AAClD,YAAM,SAAS,MAAM,KAAK,OAAO;AACjC,UAAI,UAAU,WAAW,UAAU,OAAO,OAAO;AAC/C,cAAM,IAAI,MAAM,6BAA6B,OAAO,MAAM,EAAE;AAAA,MAC9D;AAAA,IACF;AAEA,QAAI;AACF,YAAM,sBAAsB,uBAAuB,wBAAwB,aAAa,QAAQ,aAAa,OAAO;AACpH,UAAI,CAAC,qBAAqB;AACxB,cAAM,IAAI,MAAM,oCAAoC,aAAa,MAAM,iBAAiB,aAAa,OAAO,EAAE;AAAA,MAChH;AAEA,YAAM,iBAAiB,MAAM,oBAAoB;AAAA,QAC/C,gBAAgB;AAAA,QAChB;AAAA,QACA,EAAE,YAAY,gBAAgB,WAAW;AAAA,MAC3C;AAIA,YAAM,mBAAmB,KAAK;AAAA,QAC5B,gBAAgB;AAAA,QAChB,eAAe;AAAA,MACjB;AAIA,YAAM,uBACJ,eAAe,0BAA0B,OAAO,KAAK,eAAe,sBAAsB,EAAE,SAAS,IACjG;AAAA,QACE,GAAG;AAAA,QACH,OAAO;AAAA,UACL,GAAG,aAAa;AAAA,UAChB,GAAG,eAAe;AAAA,QACpB;AAAA,MACF,IACA;AAEN,UAAI,iBAAiC;AAAA,QACnC,aAAa,eAAe;AAAA,QAC5B,SAAS,eAAe;AAAA,QACxB,YAAY;AAAA,QACZ,UAAU,gBAAgB;AAAA,QAC1B,UAAU;AAAA,MACZ;AAGA,uBAAiB,MAAM,KAAK,mCAAmC,gBAAgB,eAAe;AAG9F,YAAM,iBAAwC;AAAA,QAC5C,GAAG;AAAA,QACH;AAAA,MACF;AAEA,iBAAW,QAAQ,KAAK,2BAA2B;AACjD,cAAM,KAAK,cAAc;AAAA,MAC3B;AAEA,aAAO;AAAA,IACT,SAAS,OAAO;AACd,YAAM,iBAAgD;AAAA,QACpD,GAAG;AAAA,QACH;AAAA,MACF;AAGA,iBAAW,QAAQ,KAAK,+BAA+B;AACrD,cAAM,SAAS,MAAM,KAAK,cAAc;AACxC,YAAI,UAAU,eAAe,UAAU,OAAO,WAAW;AACvD,iBAAO,OAAO;AAAA,QAChB;AAAA,MACF;AAEA,YAAM;AAAA,IACR;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaQ,gBACN,kBACA,kBACqC;AACrC,QAAI,CAAC,iBAAkB,QAAO;AAC9B,QAAI,CAAC,iBAAkB,QAAO;AAE9B,UAAM,SAAS,EAAE,GAAG,iBAAiB;AACrC,eAAW,CAAC,KAAK,WAAW,KAAK,OAAO,QAAQ,gBAAgB,GAAG;AACjE,YAAM,cAAc,OAAO,GAAG;AAC9B,UACE,eACA,OAAO,gBAAgB,YACvB,eACA,OAAO,gBAAgB,UACvB;AAEA,eAAO,GAAG,IAAI,EAAE,GAAG,aAAwC,GAAG,YAAuC;AAAA,MACvG,OAAO;AACL,eAAO,GAAG,IAAI;AAAA,MAChB;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAc,mCACZ,gBACA,iBACyB;AACzB,QAAI,CAAC,gBAAgB,cAAc,KAAK,qBAAqB,SAAS,GAAG;AACvE,aAAO;AAAA,IACT;AAEA,QAAI,WAAW;AACf,eAAW,CAAC,KAAK,SAAS,KAAK,KAAK,sBAAsB;AACxD,UAAI,OAAO,gBAAgB,cAAc,UAAU,sBAAsB;AACvE,mBAAW,MAAM,UAAU,qBAAqB,UAAU,eAAe;AAAA,MAC3E;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcQ,0BAA0BA,cAAqB,qBAAiE;AACtH,UAAM,yBAAyB,KAAK,wBAAwB,IAAIA,YAAW;AAC3E,QAAI,CAAC,wBAAwB;AAC3B,YAAM,IAAI,MAAM,0CAA0CA,YAAW,EAAE;AAAA,IACzE;AAGA,UAAM,+BAA+B,oBAAoB,OAAO,iBAAe;AAC7E,UAAI,gBAAgB,qBAAqB,wBAAwB,YAAY,OAAO;AACpF,UAAI,CAAC,eAAe;AAClB,eAAO;AAAA,MACT;AAEA,aAAO,cAAc,IAAI,YAAY,MAAM;AAAA,IAC7C,CAAC;AAED,QAAI,6BAA6B,WAAW,GAAG;AAC7C,YAAM,IAAI,MAAM,kDAAkDA,YAAW,gDAAgD,KAAK,UAAU;AAAA,QAC1I,aAAAA;AAAA,QACA;AAAA,QACA,cAAc,MAAM,KAAK,KAAK,wBAAwB,KAAK,CAAC;AAAA,QAC5D,UAAU,MAAM,KAAK,uBAAuB,KAAK,CAAC;AAAA,QAClD,SAAS,MAAM,KAAK,uBAAuB,OAAO,CAAC,EAAE,IAAI,aAAW,MAAM,KAAK,QAAQ,KAAK,CAAC,CAAC,EAAE,KAAK;AAAA,MACvG,CAAC,CAAC,EAAE;AAAA,IACN;AAGA,QAAI,uBAAuB;AAC3B,eAAW,UAAU,KAAK,UAAU;AAClC,6BAAuB,OAAOA,cAAa,oBAAoB;AAE/D,UAAI,qBAAqB,WAAW,GAAG;AACrC,cAAM,IAAI,MAAM,4EAA4EA,YAAW,EAAE;AAAA,MAC3G;AAAA,IACF;AAGA,WAAO,KAAK,4BAA4BA,cAAa,oBAAoB;AAAA,EAC3E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUQ,gBAAgBA,cAAqB,SAAkB,QAAyC;AACtG,QAAI,CAAC,KAAK,wBAAwB,IAAIA,YAAW,GAAG;AAClD,WAAK,wBAAwB,IAAIA,cAAa,oBAAI,IAAI,CAAC;AAAA,IACzD;AACA,UAAM,yBAAyB,KAAK,wBAAwB,IAAIA,YAAW;AAC3E,QAAI,CAAC,uBAAuB,IAAI,OAAO,GAAG;AACxC,6BAAuB,IAAI,SAAS,oBAAI,IAAI,CAAC;AAAA,IAC/C;AAEA,UAAM,iBAAiB,uBAAuB,IAAI,OAAO;AACzD,QAAI,CAAC,eAAe,IAAI,OAAO,MAAM,GAAG;AACtC,qBAAe,IAAI,OAAO,QAAQ,MAAM;AAAA,IAC1C;AAEA,WAAO;AAAA,EACT;AACF;","names":["x402Version"]}

package/dist/esm/facilitator/index.d.mts

@@ -0,0 +1,198 @@
+import { P as PaymentPayload, a as PaymentRequirements, S as SettleResponse, V as VerifyResponse, N as Network, b as SchemeNetworkFacilitator, F as FacilitatorExtension } from '../mechanisms-sojpSwWW.mjs';
+export { O as OKXConfig, a as OKXFacilitatorClient } from '../OKXFacilitatorClient-D5E3LX50.mjs';
+
+/**
+ * Facilitator Hook Context Interfaces
+ */
+interface FacilitatorVerifyContext {
+    paymentPayload: PaymentPayload;
+    requirements: PaymentRequirements;
+}
+interface FacilitatorVerifyResultContext extends FacilitatorVerifyContext {
+    result: VerifyResponse;
+}
+interface FacilitatorVerifyFailureContext extends FacilitatorVerifyContext {
+    error: Error;
+}
+interface FacilitatorSettleContext {
+    paymentPayload: PaymentPayload;
+    requirements: PaymentRequirements;
+}
+interface FacilitatorSettleResultContext extends FacilitatorSettleContext {
+    result: SettleResponse;
+}
+interface FacilitatorSettleFailureContext extends FacilitatorSettleContext {
+    error: Error;
+}
+/**
+ * Facilitator Hook Type Definitions
+ */
+type FacilitatorBeforeVerifyHook = (context: FacilitatorVerifyContext) => Promise<void | {
+    abort: true;
+    reason: string;
+}>;
+type FacilitatorAfterVerifyHook = (context: FacilitatorVerifyResultContext) => Promise<void>;
+type FacilitatorOnVerifyFailureHook = (context: FacilitatorVerifyFailureContext) => Promise<void | {
+    recovered: true;
+    result: VerifyResponse;
+}>;
+type FacilitatorBeforeSettleHook = (context: FacilitatorSettleContext) => Promise<void | {
+    abort: true;
+    reason: string;
+}>;
+type FacilitatorAfterSettleHook = (context: FacilitatorSettleResultContext) => Promise<void>;
+type FacilitatorOnSettleFailureHook = (context: FacilitatorSettleFailureContext) => Promise<void | {
+    recovered: true;
+    result: SettleResponse;
+}>;
+/**
+ * Facilitator client for the x402 payment protocol.
+ * Manages payment scheme registration, verification, and settlement.
+ */
+declare class x402Facilitator {
+    private readonly registeredFacilitatorSchemes;
+    private readonly extensions;
+    private beforeVerifyHooks;
+    private afterVerifyHooks;
+    private onVerifyFailureHooks;
+    private beforeSettleHooks;
+    private afterSettleHooks;
+    private onSettleFailureHooks;
+    /**
+     * Registers a scheme facilitator for the current x402 version.
+     * Networks are stored and used for getSupported() - no need to specify them later.
+     *
+     * @param networks - Single network or array of networks this facilitator supports
+     * @param facilitator - The scheme network facilitator to register
+     * @returns The x402Facilitator instance for chaining
+     */
+    register(networks: Network | Network[], facilitator: SchemeNetworkFacilitator): x402Facilitator;
+    /**
+     * Registers a protocol extension.
+     *
+     * @param extension - The extension object to register
+     * @returns The x402Facilitator instance for chaining
+     */
+    registerExtension(extension: FacilitatorExtension): x402Facilitator;
+    /**
+     * Gets the list of registered extension keys.
+     *
+     * @returns Array of extension key strings
+     */
+    getExtensions(): string[];
+    /**
+     * Gets a registered extension by key.
+     *
+     * @param key - The extension key to look up
+     * @returns The extension object, or undefined if not registered
+     */
+    getExtension<T extends FacilitatorExtension = FacilitatorExtension>(key: string): T | undefined;
+    /**
+     * Register a hook to execute before facilitator payment verification.
+     * Can abort verification by returning { abort: true, reason: string }
+     *
+     * @param hook - The hook function to register
+     * @returns The x402Facilitator instance for chaining
+     */
+    onBeforeVerify(hook: FacilitatorBeforeVerifyHook): x402Facilitator;
+    /**
+     * Register a hook to execute after successful facilitator payment verification (isValid: true).
+     * This hook is NOT called when verification fails (isValid: false) - use onVerifyFailure for that.
+     *
+     * @param hook - The hook function to register
+     * @returns The x402Facilitator instance for chaining
+     */
+    onAfterVerify(hook: FacilitatorAfterVerifyHook): x402Facilitator;
+    /**
+     * Register a hook to execute when facilitator payment verification fails.
+     * Called when: verification returns isValid: false, or an exception is thrown during verification.
+     * Can recover from failure by returning { recovered: true, result: VerifyResponse }
+     *
+     * @param hook - The hook function to register
+     * @returns The x402Facilitator instance for chaining
+     */
+    onVerifyFailure(hook: FacilitatorOnVerifyFailureHook): x402Facilitator;
+    /**
+     * Register a hook to execute before facilitator payment settlement.
+     * Can abort settlement by returning { abort: true, reason: string }
+     *
+     * @param hook - The hook function to register
+     * @returns The x402Facilitator instance for chaining
+     */
+    onBeforeSettle(hook: FacilitatorBeforeSettleHook): x402Facilitator;
+    /**
+     * Register a hook to execute after successful facilitator payment settlement.
+     *
+     * @param hook - The hook function to register
+     * @returns The x402Facilitator instance for chaining
+     */
+    onAfterSettle(hook: FacilitatorAfterSettleHook): x402Facilitator;
+    /**
+     * Register a hook to execute when facilitator payment settlement fails.
+     * Can recover from failure by returning { recovered: true, result: SettleResponse }
+     *
+     * @param hook - The hook function to register
+     * @returns The x402Facilitator instance for chaining
+     */
+    onSettleFailure(hook: FacilitatorOnSettleFailureHook): x402Facilitator;
+    /**
+     * Gets supported payment kinds, extensions, and signers.
+     * Uses networks registered during register() calls - no parameters needed.
+     * Returns flat array format for backward compatibility with V1 clients.
+     *
+     * @returns Supported response with kinds as array (with version in each element), extensions, and signers
+     */
+    getSupported(): {
+        kinds: Array<{
+            x402Version: number;
+            scheme: string;
+            network: string;
+            extra?: Record<string, unknown>;
+        }>;
+        extensions: string[];
+        signers: Record<string, string[]>;
+    };
+    /**
+     * Verifies a payment payload against requirements.
+     *
+     * @param paymentPayload - The payment payload to verify
+     * @param paymentRequirements - The payment requirements to verify against
+     * @returns Promise resolving to the verification response
+     */
+    verify(paymentPayload: PaymentPayload, paymentRequirements: PaymentRequirements): Promise<VerifyResponse>;
+    /**
+     * Settles a payment based on the payload and requirements.
+     *
+     * @param paymentPayload - The payment payload to settle
+     * @param paymentRequirements - The payment requirements for settlement
+     * @returns Promise resolving to the settlement response
+     */
+    settle(paymentPayload: PaymentPayload, paymentRequirements: PaymentRequirements): Promise<SettleResponse>;
+    /**
+     * Builds a FacilitatorContext from the registered extensions map.
+     * Passed to mechanism verify/settle so they can access extension capabilities.
+     *
+     * @returns A FacilitatorContext backed by this facilitator's registered extensions
+     */
+    private buildFacilitatorContext;
+    /**
+     * Internal method to register a scheme facilitator.
+     *
+     * @param x402Version - The x402 protocol version
+     * @param networks - Array of concrete networks this facilitator supports
+     * @param facilitator - The scheme network facilitator to register
+     * @returns The x402Facilitator instance for chaining
+     */
+    private _registerScheme;
+    /**
+     * Derives a wildcard pattern from an array of networks.
+     * If all networks share the same namespace, returns wildcard pattern.
+     * Otherwise returns the first network for exact matching.
+     *
+     * @param networks - Array of networks
+     * @returns Derived pattern for matching
+     */
+    private derivePattern;
+}
+
+export { type FacilitatorAfterSettleHook, type FacilitatorAfterVerifyHook, type FacilitatorBeforeSettleHook, type FacilitatorBeforeVerifyHook, type FacilitatorOnSettleFailureHook, type FacilitatorOnVerifyFailureHook, type FacilitatorSettleContext, type FacilitatorSettleFailureContext, type FacilitatorSettleResultContext, type FacilitatorVerifyContext, type FacilitatorVerifyFailureContext, type FacilitatorVerifyResultContext, x402Facilitator };