@x402x/client 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/README.md

@@ -87,16 +87,17 @@ function PayButton() {
     const extendedWallet = wallet.extend(publicActions);
 
     // Uses default facilitator at https://facilitator.x402x.dev/
+    // CAIP-2 network identifiers: https://chainlist.org/?testnets=true
     const client = new x402xClient({
       wallet: extendedWallet,
-      network: 'base-sepolia'
+      network: 'eip155:84532' // Base Sepolia testnet
     });
 
     // Convert USD amount to atomic units
-    const atomicAmount = parseDefaultAssetAmount('1', 'base-sepolia'); // '1000000'
+    const atomicAmount = parseDefaultAssetAmount('1', 'eip155:84532'); // '1000000'
 
     const result = await client.execute({
-      hook: TransferHook.getAddress('base-sepolia'),
+      hook: TransferHook.getAddress('eip155:84532'),
       hookData: TransferHook.encode(),
       amount: atomicAmount, // Must be atomic units
       payTo: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb1'
@@ -125,11 +126,12 @@ Use `parseDefaultAssetAmount()` from `@x402x/extensions` to convert USD amounts:
 import { parseDefaultAssetAmount, formatDefaultAssetAmount } from "@x402x/extensions";
 
 // Convert USD to atomic units
-const atomicAmount = parseDefaultAssetAmount("1", "base-sepolia"); // '1000000' (1 USDC)
-const largeAmount = parseDefaultAssetAmount("100", "base-sepolia"); // '100000000' (100 USDC)
+// CAIP-2 format: eip155:<chainId> (e.g., eip155:84532 = Base Sepolia)
+const atomicAmount = parseDefaultAssetAmount("1", "eip155:84532"); // '1000000' (1 USDC)
+const largeAmount = parseDefaultAssetAmount("100", "eip155:84532"); // '100000000' (100 USDC)
 
 // Convert atomic units back to USD (for display)
-const displayAmount = formatDefaultAssetAmount("1000000", "base-sepolia"); // '1'
+const displayAmount = formatDefaultAssetAmount("1000000", "eip155:84532"); // '1'
 ```
 
 ### Why Atomic Units?
@@ -145,10 +147,11 @@ const displayAmount = formatDefaultAssetAmount("1000000", "base-sepolia"); // '1
 import { x402xClient } from "@x402x/client";
 import { parseDefaultAssetAmount } from "@x402x/extensions";
 
-const client = new x402xClient({ wallet, network: "base-sepolia" });
+// CAIP-2 network identifier for Base Sepolia testnet
+const client = new x402xClient({ wallet, network: "eip155:84532" });
 
 // ✅ Correct: Convert first, then pass atomic units
-const atomicAmount = parseDefaultAssetAmount("5", "base-sepolia");
+const atomicAmount = parseDefaultAssetAmount("5", "eip155:84532");
 await client.execute({ amount: atomicAmount, payTo: "0x..." });
 
 // ❌ Wrong: Don't pass USD amounts directly
@@ -180,15 +183,16 @@ class x402xClient {
 import { x402xClient } from "@x402x/client";
 
 // Uses default facilitator at https://facilitator.x402x.dev/
+// CAIP-2 network identifier: eip155:84532 (Base Sepolia testnet)
 const client = new x402xClient({
   wallet: walletClient,
-  network: "base-sepolia",
+  network: "eip155:84532",
 });
 
 // Or specify custom facilitator
 const client = new x402xClient({
   wallet: walletClient,
-  network: "base-sepolia",
+  network: "eip155:84532",
   facilitatorUrl: "https://custom-facilitator.example.com",
   timeout: 30000, // optional
   confirmationTimeout: 60000, // optional
@@ -196,7 +200,7 @@ const client = new x402xClient({
 
 // Convert USD amount to atomic units
 import { parseDefaultAssetAmount } from "@x402x/extensions";
-const atomicAmount = parseDefaultAssetAmount("1", "base-sepolia"); // '1000000'
+const atomicAmount = parseDefaultAssetAmount("1", "eip155:84532"); // '1000000'
 
 const result = await client.execute({
   hook: "0x...",
@@ -253,7 +257,8 @@ function PayButton() {
 
   const handlePay = async () => {
     // Convert USD amount to atomic units
-    const atomicAmount = parseDefaultAssetAmount('1', 'base-sepolia'); // '1000000'
+    // CAIP-2 format: eip155:84532 (Base Sepolia testnet)
+    const atomicAmount = parseDefaultAssetAmount('1', 'eip155:84532'); // '1000000'
 
     await execute({
       hook: '0x...',
@@ -336,11 +341,12 @@ import { prepareSettlement } from "@x402x/client";
 import { parseDefaultAssetAmount } from "@x402x/extensions";
 
 // Convert USD amount to atomic units
-const atomicAmount = parseDefaultAssetAmount("1", "base-sepolia"); // '1000000'
+// CAIP-2 network identifier: eip155:84532 (Base Sepolia testnet)
+const atomicAmount = parseDefaultAssetAmount("1", "eip155:84532"); // '1000000'
 
 const settlement = await prepareSettlement({
   wallet: walletClient,
-  network: "base-sepolia",
+  network: "eip155:84532",
   hook: "0x...",
   hookData: "0x...",
   amount: atomicAmount, // Must be atomic units
@@ -380,16 +386,17 @@ import { x402xClient } from "@x402x/client";
 import { TransferHook, parseDefaultAssetAmount } from "@x402x/extensions";
 
 // Uses default facilitator at https://facilitator.x402x.dev/
+// CAIP-2 network identifier: eip155:84532 (Base Sepolia testnet)
 const client = new x402xClient({
   wallet: walletClient,
-  network: "base-sepolia",
+  network: "eip155:84532",
 });
 
 // Convert USD amount to atomic units
-const atomicAmount = parseDefaultAssetAmount("1", "base-sepolia"); // '1000000'
+const atomicAmount = parseDefaultAssetAmount("1", "eip155:84532"); // '1000000'
 
 const result = await client.execute({
-  hook: TransferHook.getAddress("base-sepolia"),
+  hook: TransferHook.getAddress("eip155:84532"),
   hookData: TransferHook.encode(), // Simple transfer mode
   amount: atomicAmount, // Must be atomic units
   payTo: "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb1",
@@ -406,15 +413,16 @@ TransferHook supports distributing funds to multiple recipients by percentage:
 import { x402xClient } from "@x402x/client";
 import { TransferHook, parseDefaultAssetAmount, type Split } from "@x402x/extensions";
 
+// CAIP-2 network identifier: eip155:84532 (Base Sepolia testnet)
 const client = new x402xClient({
   wallet: walletClient,
-  network: "base-sepolia",
+  network: "eip155:84532",
 });
 
 // Payroll example: Pay 3 employees with different shares
-const payrollAmount = parseDefaultAssetAmount("10", "base-sepolia"); // '10000000' (10 USDC)
+const payrollAmount = parseDefaultAssetAmount("10", "eip155:84532"); // '10000000' (10 USDC)
 const result = await client.execute({
-  hook: TransferHook.getAddress("base-sepolia"),
+  hook: TransferHook.getAddress("eip155:84532"),
   hookData: TransferHook.encode([
     { recipient: "0xEmployee1...", bips: 3000 }, // 30%
     { recipient: "0xEmployee2...", bips: 4000 }, // 40%
@@ -425,9 +433,9 @@ const result = await client.execute({
 });
 
 // Revenue split example: Platform takes 30%, creator gets 70%
-const revenueAmount = parseDefaultAssetAmount("100", "base-sepolia"); // '100000000' (100 USDC)
+const revenueAmount = parseDefaultAssetAmount("100", "eip155:84532"); // '100000000' (100 USDC)
 const result2 = await client.execute({
-  hook: TransferHook.getAddress("base-sepolia"),
+  hook: TransferHook.getAddress("eip155:84532"),
   hookData: TransferHook.encode([
     { recipient: "0xPlatform...", bips: 3000 }, // 30%
   ]),
@@ -457,10 +465,11 @@ function MintNFT() {
 
   const handleMint = async () => {
     // Convert USD amount to atomic units
-    const atomicAmount = parseDefaultAssetAmount('5', 'base-sepolia'); // '5000000'
+    // CAIP-2 format: eip155:84532 (Base Sepolia testnet)
+    const atomicAmount = parseDefaultAssetAmount('5', 'eip155:84532'); // '5000000'
 
     const result = await execute({
-      hook: NFTMintHook.getAddress('base-sepolia'),
+      hook: NFTMintHook.getAddress('eip155:84532'),
       hookData: NFTMintHook.encode({
         collection: '0x...',
         tokenId: 1
@@ -492,21 +501,22 @@ const hookData = TransferHook.encode([
   { recipient: "0xBob...", bips: 4000 }, // 40% to Bob
 ]);
 
+// CAIP-2 network identifier: eip155:84532 (Base Sepolia testnet)
 const feeEstimate = await calculateFacilitatorFee(
   "https://facilitator.x402x.dev",
-  "base-sepolia",
-  TransferHook.getAddress("base-sepolia"),
+  "eip155:84532",
+  TransferHook.getAddress("eip155:84532"),
   hookData,
 );
 
 // 2. Convert USD amount to atomic units
-const atomicAmount = parseDefaultAssetAmount("10", "base-sepolia"); // '10000000'
+const atomicAmount = parseDefaultAssetAmount("10", "eip155:84532"); // '10000000'
 
 // 3. Prepare settlement
 const settlement = await prepareSettlement({
   wallet: walletClient,
-  network: "base-sepolia",
-  hook: TransferHook.getAddress("base-sepolia"),
+  network: "eip155:84532",
+  hook: TransferHook.getAddress("eip155:84532"),
   hookData,
   amount: atomicAmount, // Must be atomic units
   payTo: "0xCharity...", // Receives 0% (full split)
@@ -533,7 +543,8 @@ export function usePayment() {
   const status = ref("idle");
   const error = ref(null);
 
-  const pay = async (walletClient, usdAmount, recipient, network = "base-sepolia") => {
+  // Default to Base Sepolia testnet (CAIP-2 format)
+  const pay = async (walletClient, usdAmount, recipient, network = "eip155:84532") => {
     status.value = "processing";
     error.value = null;
 
@@ -622,10 +633,19 @@ import type {
 
 ## Supported Networks
 
-- Base Sepolia (testnet): `base-sepolia`
-- Base (mainnet): `base`
-- X-Layer (mainnet): `x-layer`
-- X-Layer Testnet: `x-layer-testnet`
+x402x uses CAIP-2 network identifiers (format: `eip155:<chainId>`):
+
+### Mainnet
+- **Base**: `eip155:8453`
+- **X-Layer**: `eip155:196`
+- **BSC**: `eip155:56`
+
+### Testnet
+- **Base Sepolia**: `eip155:84532`
+- **X-Layer Testnet**: `eip155:1952`
+- **BSC Testnet**: `eip155:97`
+
+**Reference**: See [CAIP-2](https://chainlist.org/?testnets=true) for a complete list of chain IDs.
 
 ---
 
@@ -650,6 +670,7 @@ function Component() {
   const { pay, status, error } = usePayment();
 
   const handlePay = () => {
+    // Old v1 format - deprecated
     pay("/api/transfer", "base-sepolia", { amount: "1000000" });
   };
 }
@@ -668,7 +689,8 @@ function Component() {
 
   const handlePay = async () => {
     // Convert USD amount to atomic units
-    const atomicAmount = parseDefaultAssetAmount("1", "base-sepolia"); // '1000000'
+    // CAIP-2 format: eip155:84532 (Base Sepolia testnet)
+    const atomicAmount = parseDefaultAssetAmount("1", "eip155:84532"); // '1000000'
 
     await execute({
       hook: TransferHook.address,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@x402x/client",
-  "version": "2.2.1",
+  "version": "2.3.1",
   "description": "Client SDK for x402x Serverless Mode - execute on-chain contracts directly via facilitator",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -17,17 +17,6 @@
     "dist",
     "README.md"
   ],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:ui": "vitest --ui",
-    "test:coverage": "vitest run --coverage",
-    "type-check": "tsc --noEmit",
-    "format": "prettier --config ../../.prettierrc --ignore-path ../../.prettierignore --write \"**/*.{ts,tsx,js,jsx,cjs,json,md}\"",
-    "format:check": "prettier --config ../../.prettierrc --ignore-path ../../.prettierignore --check \"**/*.{ts,tsx,js,jsx,cjs,json,md}\""
-  },
   "keywords": [
     "x402",
     "x402x",
@@ -42,8 +31,8 @@
   "author": "Nuwa Protocol",
   "license": "Apache-2.0",
   "dependencies": {
-    "@x402x/extensions": "workspace:*",
-    "viem": "2.40.3"
+    "viem": "2.40.3",
+    "@x402x/extensions": "2.3.1"
   },
   "peerDependencies": {
     "react": "^18.0.0",
@@ -65,5 +54,16 @@
     "tsup": "^8.3.5",
     "typescript": "^5.6.3",
     "vitest": "^1.6.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest run --coverage",
+    "type-check": "tsc --noEmit",
+    "format": "prettier --config ../../.prettierrc --ignore-path ../../.prettierignore --write \"**/*.{ts,tsx,js,jsx,cjs,json,md}\"",
+    "format:check": "prettier --config ../../.prettierrc --ignore-path ../../.prettierignore --check \"**/*.{ts,tsx,js,jsx,cjs,json,md}\""
   }
-}
+}