@payai/x402-axios-starter 0.1.2 → 2.3.0

package/NOTICE

@@ -1,2 +1,2 @@
 This package includes portions derived from coinbase/x402 (examples/typescript/clients/axios), Apache-2.0,
-commit ed2438706202fc45046405ba147c5d555393c82f. See LICENSE and upstream LICENSE notices.
+commit 6a99ba028b0d657122db8a06328cd432bdd8c7c0. See LICENSE and upstream LICENSE notices.

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "@payai/x402-axios-starter",
-  "version": "0.1.2",
+  "version": "2.3.0",
   "private": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
   "description": "Create an x402 Axios client in less than 2 minutes!",
   "type": "module",
   "bin": {
@@ -33,7 +37,6 @@
     "url": "https://github.com/PayAINetwork/x402-axios-starter"
   },
   "config": {
-    "x402AxiosVersion": "0.5.1"
+    "x402AxiosVersion": "2.3.0"
   }
 }
-

package/template/.env-local

@@ -1,3 +1,4 @@
+EVM_PRIVATE_KEY=
+SVM_PRIVATE_KEY=
 RESOURCE_SERVER_URL=http://localhost:4021
-ENDPOINT_PATH=/weather
-PRIVATE_KEY=
+ENDPOINT_PATH=/weather

package/template/README.md

@@ -1,80 +1,56 @@
-# x402-axios Example Client
+# @x402/axios Example Client
 
-This is an example client that demonstrates how to use the `x402-axios` package to make HTTP requests to endpoints protected by the x402 payment protocol.
+Example client demonstrating how to use `@x402/axios` to make HTTP requests to endpoints protected by the x402 payment protocol.
+
+```typescript
+import { x402Client, wrapAxiosWithPayment } from "@x402/axios";
+import { registerExactEvmScheme } from "@x402/evm/exact/client";
+import { privateKeyToAccount } from "viem/accounts";
+import axios from "axios";
+
+const client = new x402Client();
+registerExactEvmScheme(client, { signer: privateKeyToAccount(process.env.EVM_PRIVATE_KEY) });
+
+const api = wrapAxiosWithPayment(axios.create(), client);
+
+const response = await api.get("http://localhost:4021/weather");
+console.log(response.data);
+```
 
 ## Prerequisites
 
 - Node.js v20+ (install via [nvm](https://github.com/nvm-sh/nvm))
 - pnpm v10 (install via [pnpm.io/installation](https://pnpm.io/installation))
-- A running x402 server (you can use the example express server at `examples/typescript/servers/express`)
-- A valid Ethereum private key for making payments
+- A running x402 server (see [express server example](../../servers/express))
+- Valid EVM and/or SVM private keys for making payments
 
 ## Setup
 
 1. Install and build all packages from the typescript examples root:
+
 ```bash
 cd ../../
-pnpm install
-pnpm build
+pnpm install && pnpm build
 cd clients/axios
 ```
 
-2. Copy `.env-local` to `.env` and add your Ethereum private key (remember it should have USDC on Base Sepolia, which you can provision using the [CDP Faucet](https://portal.cdp.coinbase.com/products/faucet)):
-```bash
-cp .env-local .env
-```
+2. Copy `.env-local` to `.env` and add your private keys:
 
-3. Start the example client (remember you need to be running a server locally or point at an endpoint):
 ```bash
-pnpm dev
+cp .env-local .env
 ```
 
-## How It Works
+Required environment variables:
 
-The example demonstrates how to:
-1. Create a wallet client using viem
-2. Create an Axios instance with x402 payment handling
-3. Make a request to a paid endpoint
-4. Handle the response or any errors
+- `EVM_PRIVATE_KEY` - Ethereum private key for EVM payments
+- `SVM_PRIVATE_KEY` - Solana private key for SVM payments
 
-## Example Code
+3. Run the client:
 
-```typescript
-import { config } from "dotenv";
-import { createWalletClient, http, publicActions } from "viem";
-import { privateKeyToAccount } from "viem/accounts";
-import { withPaymentInterceptor } from "x402-axios";
-import axios from "axios";
-import { baseSepolia } from "viem/chains";
-
-config();
-
-const { RESOURCE_SERVER_URL, PRIVATE_KEY, ENDPOINT_PATH } = process.env;
-
-// Create wallet client
-const account = privateKeyToAccount(PRIVATE_KEY as "0x${string}");
-const client = createWalletClient({
-  account,
-  transport: http(),
-  chain: baseSepolia,
-}).extend(publicActions);
-
-// Create Axios instance with payment handling
-const api = withPaymentInterceptor(
-  axios.create({
-    baseURL: RESOURCE_SERVER_URL,
-  }),
-  client
-);
-
-// Make request to paid endpoint
-api
-  .get(ENDPOINT_PATH)
-  .then(response => {
-    console.log(response.headers);
-    console.log(response.data);
-  })
-  .catch(error => {
-    console.error(error.response?.data?.error);
-  });
+```bash
+pnpm start
 ```
+
+## Next Steps
+
+See [Advanced Examples](../advanced/) for builder pattern registration, payment lifecycle hooks, and network preferences.

package/template/index.ts

@@ -1,43 +1,56 @@
-import axios from "axios";
 import { config } from "dotenv";
-import { withPaymentInterceptor, decodeXPaymentResponse, createSigner, type Hex } from "x402-axios";
+import { x402Client, wrapAxiosWithPayment, x402HTTPClient } from "@x402/axios";
+import { registerExactEvmScheme } from "@x402/evm/exact/client";
+import { registerExactSvmScheme } from "@x402/svm/exact/client";
+import { privateKeyToAccount } from "viem/accounts";
+import { createKeyPairSignerFromBytes } from "@solana/kit";
+import { base58 } from "@scure/base";
+import axios from "axios";
 
 config();
 
-const privateKey = process.env.PRIVATE_KEY as Hex | string;
-const baseURL = process.env.RESOURCE_SERVER_URL as string; // e.g. https://example.com
-const endpointPath = process.env.ENDPOINT_PATH as string; // e.g. /weather
-
-if (!baseURL || !privateKey || !endpointPath) {
-  console.error("Missing required environment variables");
-  process.exit(1);
-}
+const evmPrivateKey = process.env.EVM_PRIVATE_KEY as `0x${string}`;
+const svmPrivateKey = process.env.SVM_PRIVATE_KEY as string;
+const baseURL = process.env.RESOURCE_SERVER_URL || "http://localhost:4021";
+const endpointPath = process.env.ENDPOINT_PATH || "/weather";
+const url = `${baseURL}${endpointPath}`;
 
 /**
- * This example shows how to use the x402-axios package to make a request to a resource server that requires a payment.
+ * Example demonstrating how to use @x402/axios to make requests to x402-protected endpoints.
  *
- * To run this example, you need to set the following environment variables:
- * - PRIVATE_KEY: The private key of the signer
- * - RESOURCE_SERVER_URL: The URL of the resource server
- * - ENDPOINT_PATH: The path of the endpoint to call on the resource server
+ * This uses the helper registration functions from @x402/evm and @x402/svm to register
+ * all supported networks for both v1 and v2 protocols.
  *
+ * Required environment variables:
+ * - EVM_PRIVATE_KEY: The private key of the EVM signer
+ * - SVM_PRIVATE_KEY: The private key of the SVM signer
  */
 async function main(): Promise<void> {
-  // const signer = await createSigner("solana-devnet", privateKey); // uncomment for solana
-  const signer = await createSigner("base-sepolia", privateKey);
-
-  const api = withPaymentInterceptor(
-    axios.create({
-      baseURL,
-    }),
-    signer,
-  );
-
-  const response = await api.get(endpointPath);
-  console.log(response.data);
-
-  const paymentResponse = decodeXPaymentResponse(response.headers["x-payment-response"]);
-  console.log(paymentResponse);
+  const evmSigner = privateKeyToAccount(evmPrivateKey);
+  const svmSigner = await createKeyPairSignerFromBytes(base58.decode(svmPrivateKey));
+
+  const client = new x402Client();
+  registerExactEvmScheme(client, { signer: evmSigner });
+  registerExactSvmScheme(client, { signer: svmSigner });
+
+  const api = wrapAxiosWithPayment(axios.create(), client);
+
+  console.log(`Making request to: ${url}\n`);
+  const response = await api.get(url);
+  const body = response.data;
+  console.log("Response body:", body);
+
+  if (response.status < 400) {
+    const paymentResponse = new x402HTTPClient(client).getPaymentSettleResponse(
+      name => response.headers[name.toLowerCase()],
+    );
+    console.log("\nPayment response:", paymentResponse);
+  } else {
+    console.log(`\nNo payment settled (response status: ${response.status})`);
+  }
 }
 
-main();
+main().catch(error => {
+  console.error(error?.response?.data?.error ?? error);
+  process.exit(1);
+});

package/template/package.json

@@ -1,19 +1,26 @@
 {
-  "name": "axios-client-example",
+  "name": "@x402/axios-client-example",
   "private": true,
   "type": "module",
   "scripts": {
-    "dev": "tsx index.ts",
-    "dev:multi-network-signer": "tsx multi-network-signer.ts",
+    "start": "tsx index.ts",
+    "dev": "tsx index.ts builder-pattern",
+    "dev:hooks": "tsx index.ts hooks",
+    "dev:mechanism-helper-registration": "tsx index.ts mechanism-helper-registration",
     "format": "prettier -c .prettierrc --write \"**/*.{ts,js,cjs,json,md}\"",
     "format:check": "prettier -c .prettierrc --check \"**/*.{ts,js,cjs,json,md}\"",
     "lint": "eslint . --ext .ts --fix",
     "lint:check": "eslint . --ext .ts"
   },
   "dependencies": {
-    "axios": "^1.7.9",
-    "dotenv": "^16.5.0",
-    "x402-axios": "^0.6.0"
+    "@scure/base": "^1.2.6",
+    "@solana/kit": "^2.1.1",
+    "@x402/axios": "^2.3.0",
+    "@x402/evm": "^2.3.0",
+    "@x402/svm": "^2.3.0",
+    "axios": "^1.13.2",
+    "dotenv": "^16.4.7",
+    "viem": "^2.39.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.24.0",

package/template/multi-network-signer.ts

@@ -1,51 +0,0 @@
-import axios from "axios";
-import { config } from "dotenv";
-import {
-  withPaymentInterceptor,
-  decodeXPaymentResponse,
-  createSigner,
-  type Hex,
-  MultiNetworkSigner,
-} from "x402-axios";
-
-config();
-
-const evmPrivateKey = process.env.EVM_PRIVATE_KEY as Hex;
-const svmPrivateKey = process.env.SVM_PRIVATE_KEY as string;
-const baseURL = process.env.RESOURCE_SERVER_URL as string; // e.g. https://example.com
-const endpointPath = process.env.ENDPOINT_PATH as string; // e.g. /weather
-
-if (!baseURL || !evmPrivateKey || !svmPrivateKey || !endpointPath) {
-  console.error("Missing required environment variables");
-  process.exit(1);
-}
-
-/**
- * This example shows how to use the x402-axios package to make a request to a resource server that requires a payment.
- *
- * To run this example, you need to set the following environment variables:
- * - PRIVATE_KEY: The private key of the signer
- * - RESOURCE_SERVER_URL: The URL of the resource server
- * - ENDPOINT_PATH: The path of the endpoint to call on the resource server
- *
- */
-async function main(): Promise<void> {
-  const evmSigner = await createSigner("base-sepolia", evmPrivateKey);
-  const svmSigner = await createSigner("solana-devnet", svmPrivateKey);
-  const signer = { evm: evmSigner, svm: svmSigner } as MultiNetworkSigner;
-
-  const api = withPaymentInterceptor(
-    axios.create({
-      baseURL,
-    }),
-    signer,
-  );
-
-  const response = await api.get(endpointPath);
-  console.log(response.data);
-
-  const paymentResponse = decodeXPaymentResponse(response.headers["x-payment-response"]);
-  console.log(paymentResponse);
-}
-
-main();