npm package: @rvk_rishikesh/axios
Description: x402 Payment Protocol
Author: Coinbase Inc.
Latest version: 2.2.0

# x402-axios

A utility package that extends Axios to automatically handle 402 Payment Required responses using the x402 payment protocol v2. This package enables seamless integration of payment functionality into your applications when making HTTP requests.

## Installation

```bash
pnpm install @rvk_rishikesh/axios
```

## Quick Start

```typescript
import axios from "axios";
import { wrapAxiosWithPaymentFromConfig } from "@rvk_rishikesh/axios";
import { ExactEvmScheme } from "@rvk_rishikesh/evm";
import { privateKeyToAccount } from "viem/accounts";

// Create an account
const account = privateKeyToAccount("0xYourPrivateKey");

// Wrap the axios instance with payment handling
const api = wrapAxiosWithPaymentFromConfig(axios.create(), {
  schemes: [
    {
      network: "eip155:8453", // Base Sepolia
      client: new ExactEvmScheme(account),
    },
  ],
});

// Make a request that may require payment
const response = await api.get("https://api.example.com/paid-endpoint");

const data = response.data;
```

## API

### `wrapAxiosWithPayment(axiosInstance, client)`

Wraps an Axios instance to handle 402 Payment Required responses automatically.

#### Parameters

- `axiosInstance`: The Axios instance to wrap (typically from `axios.create()`)
- `client`: An x402Client instance with registered payment schemes

### `wrapAxiosWithPaymentFromConfig(axiosInstance, config)`

Convenience wrapper that creates an x402Client from a configuration object.

#### Parameters

- `axiosInstance`: The Axios instance to wrap (typically from `axios.create()`)
- `config`: Configuration object with the following properties:
  - `schemes`: Array of scheme registrations, each containing:
    - `network`: Network identifier (e.g., 'eip155:8453', 'solana:mainnet', 'eip155:*' for wildcards)
    - `client`: The scheme client implementation (e.g., `ExactEvmScheme`, `ExactSvmScheme`)
    - `x402Version`: Optional protocol version (defaults to 2, set to 1 for legacy support)
  - `paymentRequirementsSelector`: Optional function to select payment requirements from multiple options

#### Returns

A wrapped Axios instance that automatically handles 402 responses by:
1. Making the initial request
2. If a 402 response is received, parsing the payment requirements
3. Creating a payment header using the configured scheme client
4. Retrying the request with the payment header

## Examples

### Basic Usage with EVM

```typescript
import { config } from "dotenv";
import axios from "axios";
import { wrapAxiosWithPaymentFromConfig, decodePaymentResponseHeader } from "@rvk_rishikesh/axios";
import { privateKeyToAccount } from "viem/accounts";
import { ExactEvmScheme } from "@rvk_rishikesh/evm";

config();

const { EVM_PRIVATE_KEY, API_URL } = process.env;

const account = privateKeyToAccount(EVM_PRIVATE_KEY as `0x${string}`);

const api = wrapAxiosWithPaymentFromConfig(axios.create(), {
  schemes: [
    {
      network: "eip155:*", // Support all EVM chains
      client: new ExactEvmScheme(account),
    },
  ],
});

// Make a request to a paid API endpoint
api.get(API_URL)
  .then(response => {
    const data = response.data;
    
    // Optionally decode the payment response header
    const paymentResponse = response.headers["payment-response"];
    if (paymentResponse) {
      const decoded = decodePaymentResponseHeader(paymentResponse);
      console.log("Payment details:", decoded);
    }
    
    console.log("Response data:", data);
  })
  .catch(error => {
    console.error(error);
  });
```

### Using Builder Pattern

For more control, you can use the builder pattern to register multiple schemes:

```typescript
import axios from "axios";
import { wrapAxiosWithPayment, x402Client } from "@rvk_rishikesh/axios";
import { ExactEvmScheme } from "@rvk_rishikesh/evm/exact/client";
import { ExactSvmScheme } from "@rvk_rishikesh/svm/exact/client";
import { privateKeyToAccount } from "viem/accounts";
import { createKeyPairSignerFromBytes } from "@solana/kit";
import { base58 } from "@scure/base";

// Create signers
const evmSigner = privateKeyToAccount("0xYourPrivateKey");
const svmSigner = await createKeyPairSignerFromBytes(base58.decode("YourSvmPrivateKey"));

// Build client with multiple schemes
const client = new x402Client()
  .register("eip155:*", new ExactEvmScheme(evmSigner))
  .register("solana:*", new ExactSvmScheme(svmSigner));

// Wrap axios with the client
const api = wrapAxiosWithPayment(axios.create(), client);
```

### Multi-Chain Support

```typescript
import axios from "axios";
import { wrapAxiosWithPaymentFromConfig } from "@rvk_rishikesh/axios";
import { ExactEvmScheme } from "@rvk_rishikesh/evm";
import { ExactSvmScheme } from "@rvk_rishikesh/svm";

const api = wrapAxiosWithPaymentFromConfig(axios.create(), {
  schemes: [
    // EVM chains
    {
      network: "eip155:8453", // Base Sepolia
      client: new ExactEvmScheme(evmAccount),
    },
    // SVM chains
    {
      network: "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1", // Solana devnet
      client: new ExactSvmScheme(svmSigner),
    },
  ],
});
```

### Custom Payment Requirements Selector

```typescript
import axios from "axios";
import { wrapAxiosWithPaymentFromConfig, type SelectPaymentRequirements } from "@rvk_rishikesh/axios";
import { ExactEvmScheme } from "@rvk_rishikesh/evm";

// Custom selector that prefers the cheapest option
const selectCheapestOption: SelectPaymentRequirements = (version, accepts) => {
  if (!accepts || accepts.length === 0) {
    throw new Error("No payment options available");
  }
  
  // Sort by value and return the cheapest
  const sorted = [...accepts].sort((a, b) => 
    BigInt(a.value) - BigInt(b.value)
  );
  
  return sorted[0];
};

const api = wrapAxiosWithPaymentFromConfig(axios.create(), {
  schemes: [
    {
      network: "eip155:8453",
      client: new ExactEvmScheme(account),
    },
  ],
  paymentRequirementsSelector: selectCheapestOption,
});
```