@x402x/extensions 2.2.1 → 2.3.1

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Nuwa Protocol
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/client/index.d.mts

@@ -0,0 +1,183 @@
+import { SchemeNetworkClient, PaymentRequirements, PaymentPayload, Network } from '@x402/core/types';
+import { x402Client } from '@x402/core/client';
+
+/**
+ * x402x EVM Client Scheme with Router Settlement
+ *
+ * This scheme extends the standard EVM exact scheme to support x402x router settlement.
+ * The key difference is using a commitment hash (binding all settlement parameters)
+ * as the EIP-3009 nonce instead of a random value.
+ */
+
+/**
+ * Client EVM signer interface
+ * Compatible with viem WalletClient and LocalAccount
+ */
+type ClientEvmSigner = {
+    readonly address: `0x${string}`;
+    signTypedData(message: {
+        domain: Record<string, unknown>;
+        types: Record<string, unknown>;
+        primaryType: string;
+        message: Record<string, unknown>;
+    }): Promise<`0x${string}`>;
+};
+/**
+ * EVM client implementation for the Exact payment scheme with x402x router settlement.
+ *
+ * This scheme uses a commitment hash as the EIP-3009 nonce to cryptographically bind
+ * all settlement parameters (salt, hook, hookData, etc.) to the user's signature,
+ * preventing parameter tampering attacks.
+ *
+ * @example
+ * ```typescript
+ * import { ExactEvmSchemeWithRouterSettlement } from '@x402x/extensions/client';
+ * import { x402Client } from '@x402/core/client';
+ *
+ * const signer = { address, signTypedData }; // viem WalletClient or LocalAccount
+ * const scheme = new ExactEvmSchemeWithRouterSettlement(signer);
+ *
+ * const client = new x402Client()
+ *   .register('eip155:84532', scheme);
+ * ```
+ */
+declare class ExactEvmSchemeWithRouterSettlement implements SchemeNetworkClient {
+    private readonly signer;
+    readonly scheme = "exact";
+    /**
+     * Per-request router settlement extension (typically sourced from PaymentRequired.extensions).
+     *
+     * IMPORTANT: We do NOT put this on `paymentRequirements.extra`, because for x402 v2 the
+     * server matches paid requests by deep-equality between `paymentPayload.accepted` and the
+     * server-side `accepts[]`. Mutating `accepted` will cause "No matching payment requirements".
+     */
+    private routerSettlementFromPaymentRequired?;
+    /**
+     * Creates a new ExactEvmSchemeWithRouterSettlement instance.
+     *
+     * @param signer - The EVM signer for client operations (viem WalletClient or LocalAccount)
+     */
+    constructor(signer: ClientEvmSigner);
+    /**
+     * Set router-settlement extension data for the next payment payload creation.
+     *
+     * Intended to be called from an `x402Client.onBeforePaymentCreation` hook, which has access
+     * to `paymentRequired.extensions`.
+     */
+    setRouterSettlementExtensionFromPaymentRequired(ext: unknown | undefined): void;
+    /**
+     * Creates a payment payload for the Exact scheme with router settlement.
+     *
+     * This method:
+     * 1. Extracts settlement parameters from PaymentRequired.extensions
+     * 2. Calculates a commitment hash binding all parameters
+     * 3. Uses the commitment as the EIP-3009 nonce
+     * 4. Signs with settlementRouter as the 'to' address
+     *
+     * @param x402Version - The x402 protocol version (must be 2)
+     * @param paymentRequirements - The payment requirements from the server
+     * @returns Promise resolving to a payment payload
+     *
+     * @throws Error if x402Version is not 2
+     * @throws Error if x402x-router-settlement extension is missing
+     * @throws Error if required settlement parameters are missing
+     */
+    createPaymentPayload(x402Version: number, paymentRequirements: PaymentRequirements): Promise<Pick<PaymentPayload, "x402Version" | "payload">>;
+    /**
+     * Sign the EIP-3009 authorization using EIP-712
+     *
+     * @param authorization - The authorization to sign
+     * @param requirements - The payment requirements
+     * @param chainId - The chain ID
+     * @returns Promise resolving to the signature
+     */
+    private signAuthorization;
+}
+
+/**
+ * x402x Extension Handler
+ *
+ * Provides utilities to integrate x402x router settlement with official x402 SDK.
+ *
+ * The challenge: x402 v2 spec places extensions at root level in PaymentRequired,
+ * but x402x scheme needs settlement parameters from PaymentRequirements.extra.
+ *
+ * Solution: Provide two-layer API:
+ * 1. High-level: registerX402xScheme() - one line setup (recommended)
+ * 2. Low-level: injectX402xExtensionHandler() - flexible configuration
+ */
+
+/**
+ * Injects x402x extension handler into x402Client (Low-level API).
+ *
+ * IMPORTANT (x402 v2 + x402x multi-network):
+ * - Server returns per-option x402x info in `accepts[i].extra["x402x-router-settlement"]`
+ * - x402Client only passes `PaymentRequirements` to scheme (no root extensions)
+ * - Facilitator v2 reads from `paymentPayload.extensions["x402x-router-settlement"]`
+ *
+ * Solution: Copy the selected option's x402x info from `selectedRequirements.extra`
+ * into `paymentRequired.extensions` so it gets included in `paymentPayload.extensions`.
+ *
+ * This does NOT mutate `selectedRequirements` (which becomes `paymentPayload.accepted`),
+ * so v2 deepEqual matching still works.
+ *
+ * @param client - x402Client instance to inject handler into
+ * @param onRouterSettlementExtension - Callback to receive the per-request extension object
+ * @returns The same client instance for chaining
+ *
+ * @example Low-level API (for advanced users)
+ * ```typescript
+ * import { x402Client } from '@x402/core/client';
+ * import {
+ *   injectX402xExtensionHandler,
+ *   ExactEvmSchemeWithRouterSettlement
+ * } from '@x402x/extensions';
+ *
+ * const client = new x402Client();
+ * const scheme = new ExactEvmSchemeWithRouterSettlement(signer);
+ * injectX402xExtensionHandler(client, (ext) => scheme.setRouterSettlementExtensionFromPaymentRequired(ext))
+ *   .register('eip155:84532', scheme);
+ * ```
+ */
+declare function injectX402xExtensionHandler(client: x402Client, onRouterSettlementExtension?: (extension: unknown | undefined) => void): x402Client;
+/**
+ * Register x402x router settlement scheme with automatic extension handling (High-level API).
+ *
+ * This is the recommended way to set up x402x payments. It combines:
+ * 1. Extension handler injection (injectX402xExtensionHandler)
+ * 2. Scheme registration (ExactEvmSchemeWithRouterSettlement)
+ *
+ * Use this for the simplest integration - just provide your signer and network.
+ *
+ * @param client - x402Client instance
+ * @param network - Network identifier in CAIP-2 format (e.g., "eip155:84532")
+ * @param signer - EVM signer with address and signTypedData method
+ * @returns The client instance for chaining
+ *
+ * @example High-level API (recommended)
+ * ```typescript
+ * import { x402Client } from '@x402/core/client';
+ * import { registerX402xScheme } from '@x402x/extensions';
+ * import { useWalletClient } from 'wagmi';
+ *
+ * const { data: walletClient } = useWalletClient();
+ *
+ * const client = new x402Client();
+ * registerX402xScheme(client, 'eip155:84532', {
+ *   address: walletClient.account.address,
+ *   signTypedData: walletClient.signTypedData,
+ * });
+ *
+ * // That's it! Client is ready for x402x payments
+ * ```
+ *
+ * @example Multiple networks
+ * ```typescript
+ * const client = new x402Client();
+ * registerX402xScheme(client, 'eip155:84532', signer); // Base Sepolia
+ * registerX402xScheme(client, 'eip155:8453', signer);  // Base Mainnet
+ * ```
+ */
+declare function registerX402xScheme(client: x402Client, network: Network, signer: ClientEvmSigner): x402Client;
+
+export { type ClientEvmSigner, ExactEvmSchemeWithRouterSettlement, injectX402xExtensionHandler, registerX402xScheme };

package/dist/client/index.d.ts

@@ -0,0 +1,183 @@
+import { SchemeNetworkClient, PaymentRequirements, PaymentPayload, Network } from '@x402/core/types';
+import { x402Client } from '@x402/core/client';
+
+/**
+ * x402x EVM Client Scheme with Router Settlement
+ *
+ * This scheme extends the standard EVM exact scheme to support x402x router settlement.
+ * The key difference is using a commitment hash (binding all settlement parameters)
+ * as the EIP-3009 nonce instead of a random value.
+ */
+
+/**
+ * Client EVM signer interface
+ * Compatible with viem WalletClient and LocalAccount
+ */
+type ClientEvmSigner = {
+    readonly address: `0x${string}`;
+    signTypedData(message: {
+        domain: Record<string, unknown>;
+        types: Record<string, unknown>;
+        primaryType: string;
+        message: Record<string, unknown>;
+    }): Promise<`0x${string}`>;
+};
+/**
+ * EVM client implementation for the Exact payment scheme with x402x router settlement.
+ *
+ * This scheme uses a commitment hash as the EIP-3009 nonce to cryptographically bind
+ * all settlement parameters (salt, hook, hookData, etc.) to the user's signature,
+ * preventing parameter tampering attacks.
+ *
+ * @example
+ * ```typescript
+ * import { ExactEvmSchemeWithRouterSettlement } from '@x402x/extensions/client';
+ * import { x402Client } from '@x402/core/client';
+ *
+ * const signer = { address, signTypedData }; // viem WalletClient or LocalAccount
+ * const scheme = new ExactEvmSchemeWithRouterSettlement(signer);
+ *
+ * const client = new x402Client()
+ *   .register('eip155:84532', scheme);
+ * ```
+ */
+declare class ExactEvmSchemeWithRouterSettlement implements SchemeNetworkClient {
+    private readonly signer;
+    readonly scheme = "exact";
+    /**
+     * Per-request router settlement extension (typically sourced from PaymentRequired.extensions).
+     *
+     * IMPORTANT: We do NOT put this on `paymentRequirements.extra`, because for x402 v2 the
+     * server matches paid requests by deep-equality between `paymentPayload.accepted` and the
+     * server-side `accepts[]`. Mutating `accepted` will cause "No matching payment requirements".
+     */
+    private routerSettlementFromPaymentRequired?;
+    /**
+     * Creates a new ExactEvmSchemeWithRouterSettlement instance.
+     *
+     * @param signer - The EVM signer for client operations (viem WalletClient or LocalAccount)
+     */
+    constructor(signer: ClientEvmSigner);
+    /**
+     * Set router-settlement extension data for the next payment payload creation.
+     *
+     * Intended to be called from an `x402Client.onBeforePaymentCreation` hook, which has access
+     * to `paymentRequired.extensions`.
+     */
+    setRouterSettlementExtensionFromPaymentRequired(ext: unknown | undefined): void;
+    /**
+     * Creates a payment payload for the Exact scheme with router settlement.
+     *
+     * This method:
+     * 1. Extracts settlement parameters from PaymentRequired.extensions
+     * 2. Calculates a commitment hash binding all parameters
+     * 3. Uses the commitment as the EIP-3009 nonce
+     * 4. Signs with settlementRouter as the 'to' address
+     *
+     * @param x402Version - The x402 protocol version (must be 2)
+     * @param paymentRequirements - The payment requirements from the server
+     * @returns Promise resolving to a payment payload
+     *
+     * @throws Error if x402Version is not 2
+     * @throws Error if x402x-router-settlement extension is missing
+     * @throws Error if required settlement parameters are missing
+     */
+    createPaymentPayload(x402Version: number, paymentRequirements: PaymentRequirements): Promise<Pick<PaymentPayload, "x402Version" | "payload">>;
+    /**
+     * Sign the EIP-3009 authorization using EIP-712
+     *
+     * @param authorization - The authorization to sign
+     * @param requirements - The payment requirements
+     * @param chainId - The chain ID
+     * @returns Promise resolving to the signature
+     */
+    private signAuthorization;
+}
+
+/**
+ * x402x Extension Handler
+ *
+ * Provides utilities to integrate x402x router settlement with official x402 SDK.
+ *
+ * The challenge: x402 v2 spec places extensions at root level in PaymentRequired,
+ * but x402x scheme needs settlement parameters from PaymentRequirements.extra.
+ *
+ * Solution: Provide two-layer API:
+ * 1. High-level: registerX402xScheme() - one line setup (recommended)
+ * 2. Low-level: injectX402xExtensionHandler() - flexible configuration
+ */
+
+/**
+ * Injects x402x extension handler into x402Client (Low-level API).
+ *
+ * IMPORTANT (x402 v2 + x402x multi-network):
+ * - Server returns per-option x402x info in `accepts[i].extra["x402x-router-settlement"]`
+ * - x402Client only passes `PaymentRequirements` to scheme (no root extensions)
+ * - Facilitator v2 reads from `paymentPayload.extensions["x402x-router-settlement"]`
+ *
+ * Solution: Copy the selected option's x402x info from `selectedRequirements.extra`
+ * into `paymentRequired.extensions` so it gets included in `paymentPayload.extensions`.
+ *
+ * This does NOT mutate `selectedRequirements` (which becomes `paymentPayload.accepted`),
+ * so v2 deepEqual matching still works.
+ *
+ * @param client - x402Client instance to inject handler into
+ * @param onRouterSettlementExtension - Callback to receive the per-request extension object
+ * @returns The same client instance for chaining
+ *
+ * @example Low-level API (for advanced users)
+ * ```typescript
+ * import { x402Client } from '@x402/core/client';
+ * import {
+ *   injectX402xExtensionHandler,
+ *   ExactEvmSchemeWithRouterSettlement
+ * } from '@x402x/extensions';
+ *
+ * const client = new x402Client();
+ * const scheme = new ExactEvmSchemeWithRouterSettlement(signer);
+ * injectX402xExtensionHandler(client, (ext) => scheme.setRouterSettlementExtensionFromPaymentRequired(ext))
+ *   .register('eip155:84532', scheme);
+ * ```
+ */
+declare function injectX402xExtensionHandler(client: x402Client, onRouterSettlementExtension?: (extension: unknown | undefined) => void): x402Client;
+/**
+ * Register x402x router settlement scheme with automatic extension handling (High-level API).
+ *
+ * This is the recommended way to set up x402x payments. It combines:
+ * 1. Extension handler injection (injectX402xExtensionHandler)
+ * 2. Scheme registration (ExactEvmSchemeWithRouterSettlement)
+ *
+ * Use this for the simplest integration - just provide your signer and network.
+ *
+ * @param client - x402Client instance
+ * @param network - Network identifier in CAIP-2 format (e.g., "eip155:84532")
+ * @param signer - EVM signer with address and signTypedData method
+ * @returns The client instance for chaining
+ *
+ * @example High-level API (recommended)
+ * ```typescript
+ * import { x402Client } from '@x402/core/client';
+ * import { registerX402xScheme } from '@x402x/extensions';
+ * import { useWalletClient } from 'wagmi';
+ *
+ * const { data: walletClient } = useWalletClient();
+ *
+ * const client = new x402Client();
+ * registerX402xScheme(client, 'eip155:84532', {
+ *   address: walletClient.account.address,
+ *   signTypedData: walletClient.signTypedData,
+ * });
+ *
+ * // That's it! Client is ready for x402x payments
+ * ```
+ *
+ * @example Multiple networks
+ * ```typescript
+ * const client = new x402Client();
+ * registerX402xScheme(client, 'eip155:84532', signer); // Base Sepolia
+ * registerX402xScheme(client, 'eip155:8453', signer);  // Base Mainnet
+ * ```
+ */
+declare function registerX402xScheme(client: x402Client, network: Network, signer: ClientEvmSigner): x402Client;
+
+export { type ClientEvmSigner, ExactEvmSchemeWithRouterSettlement, injectX402xExtensionHandler, registerX402xScheme };