@wtflabs/x402 0.0.1-beta.0

package/README.md

@@ -0,0 +1,60 @@
+# x402
+
+Core TypeScript implementation of the x402 Payment Protocol. This package provides the foundational types, schemas, and utilities that power all x402 integrations.
+
+## Installation
+
+```bash
+npm install x402
+```
+
+## Overview
+
+The x402 package provides the core building blocks for implementing the x402 Payment Protocol in TypeScript. It's designed to be used by:
+
+- Middleware implementations (Express, Hono, Next.js)
+- Client-side payment handlers (fetch wrapper)
+- Facilitator services
+- Custom integrations
+
+## Integration Packages
+
+This core package is used by the following integration packages:
+
+- `x402-express`: Express.js middleware
+- `x402-hono`: Hono middleware
+- `x402-next`: Next.js middleware
+- `x402-fetch`: Fetch API wrapper
+- `x402-axios`: Axios interceptor
+
+## Manual Server Integration
+
+If you're not using one of our server middleware packages, you can implement the x402 protocol manually. Here's what you'll need to handle:
+
+1. Return 402 error responses with the appropriate response body
+2. Use the facilitator to validate payments
+3. Use the facilitator to settle payments
+4. Return the appropriate response header to the caller
+
+For a complete example implementation, see our [advanced server example](https://github.com/coinbase/x402/tree/main/examples/typescript/servers/advanced) which demonstrates both synchronous and asynchronous payment processing patterns.
+
+## Manual Client Integration
+
+If you're not using our `x402-fetch` or `x402-axios` packages, you can manually integrate the x402 protocol in your client application. Here's how:
+
+1. Make a request to a x402-protected endpoint. The server will respond with a 402 status code and a JSON object containing:
+   - `x402Version`: The version of the x402 protocol being used
+   - `accepts`: An array of payment requirements you can fulfill
+
+2. Select the payment requirement you wish to fulfill from the `accepts` array
+
+3. Create the payment header using the selected payment requirement
+
+4. Retry your network call with:
+   - The payment header assigned to the `X-PAYMENT` field
+   - The `Access-Control-Expose-Headers` field set to `"X-PAYMENT-RESPONSE"` to receive the server's transaction response
+
+For implementation examples, we recommend reviewing our official client packages:
+- [x402-fetch implementation](https://github.com/coinbase/x402/blob/main/typescript/packages/x402-fetch/src/index.ts)
+- [x402-axios implementation](https://github.com/coinbase/x402/blob/main/typescript/packages/x402-axios/src/index.ts)
+

package/dist/cjs/client/index.d.ts

@@ -0,0 +1,64 @@
+import { X as X402Config } from '../config-Dfuvno71.js';
+import { P as PaymentRequirements, p as UnsignedEip3009PaymentPayload } from '../x402Specs-CYq5tSY1.js';
+import { S as Signer, M as MultiNetworkSigner } from '../wallet-CQ0Fe_M5.js';
+import { Address } from 'viem';
+import { N as Network } from '../network-FrFmmiyj.js';
+import 'zod';
+import '../wallet-SJKJpUgQ.js';
+import 'viem/chains';
+import '../wallet-BTqCm9Zp.js';
+import '@solana/kit';
+
+/**
+ * Creates a payment header based on the provided client and payment requirements.
+ *
+ * @param client - The signer wallet instance used to create the payment header
+ * @param x402Version - The version of the X402 protocol to use
+ * @param paymentRequirements - The payment requirements containing scheme and network information
+ * @param config - Optional configuration for X402 operations (e.g., custom RPC URLs)
+ * @returns A promise that resolves to the created payment header string
+ */
+declare function createPaymentHeader(client: Signer | MultiNetworkSigner, x402Version: number, paymentRequirements: PaymentRequirements, config?: X402Config): Promise<string>;
+
+/**
+ * Prepares a payment header with the given sender address and payment requirements.
+ *
+ * @param from - The sender's address from which the payment will be made
+ * @param x402Version - The version of the X402 protocol to use
+ * @param paymentRequirements - The payment requirements containing scheme and network information
+ * @returns An unsigned payment payload that can be used to create a payment header
+ */
+declare function preparePaymentHeader(from: Address, x402Version: number, paymentRequirements: PaymentRequirements): UnsignedEip3009PaymentPayload;
+
+/**
+ * Default selector for payment requirements.
+ * Default behavior is to select the first payment requirement that has a USDC asset.
+ * If no USDC payment requirement is found, the first payment requirement is selected.
+ *
+ * @param paymentRequirements - The payment requirements to select from.
+ * @param network - The network to check against. If not provided, the network will not be checked.
+ * @param scheme - The scheme to check against. If not provided, the scheme will not be checked.
+ * @returns The payment requirement that is the most appropriate for the user.
+ */
+declare function selectPaymentRequirements(paymentRequirements: PaymentRequirements[], network?: Network | Network[], scheme?: "exact"): PaymentRequirements;
+/**
+ * Selector for payment requirements.
+ *
+ * @param paymentRequirements - The payment requirements to select from.
+ * @param network - The network to check against. If not provided, the network will not be checked.
+ * @param scheme - The scheme to check against. If not provided, the scheme will not be checked.
+ * @returns The payment requirement that is the most appropriate for the user.
+ */
+type PaymentRequirementsSelector = (paymentRequirements: PaymentRequirements[], network?: Network | Network[], scheme?: "exact") => PaymentRequirements;
+
+/**
+ * Signs a payment header using the provided client and payment requirements.
+ *
+ * @param client - The signer wallet instance used to sign the payment header
+ * @param paymentRequirements - The payment requirements containing scheme and network information
+ * @param unsignedPaymentHeader - The unsigned payment payload to be signed
+ * @returns A promise that resolves to the encoded signed payment header string
+ */
+declare function signPaymentHeader(client: Signer | MultiNetworkSigner, paymentRequirements: PaymentRequirements, unsignedPaymentHeader: UnsignedEip3009PaymentPayload): Promise<string>;
+
+export { type PaymentRequirementsSelector, createPaymentHeader, preparePaymentHeader, selectPaymentRequirements, signPaymentHeader };