x402-express-mantle 1.0.0 → 1.0.2

package/README.md

@@ -116,7 +116,7 @@ EVM_ADDRESS=0xYourMantleWalletAddress
 Check the `examples/` directory for complete working examples:
 
 ```bash
-cd node_modules/x402-express-mantle/examples
+cd examples/express
 npm install
 npm start
 ```
@@ -136,6 +136,24 @@ This SDK includes custom Mantle configurations:
 
 ```bash
 npm install x402-express-mantle
+
+## Quick Example
+
+```bash
+# Try the example server
+cd examples/express
+npm install
+cp .env-local .env
+# Edit .env with your facilitator URL and EVM address
+npm run dev
+```
+
+The example server demonstrates:
+- Mantle testnet payment integration
+- Multiple pricing tiers ($0.001 and $0.005 USDC)
+- Free and paid endpoints
+- Complete payment flow
+
 # Deploy to Vercel with your environment variables
 ```
 

package/lib/cjs/index.d.ts

@@ -1,91 +1,111 @@
-import { HTTPAdapter, RoutesConfig, x402ResourceServer, PaywallConfig, PaywallProvider, FacilitatorClient } from '@x402/core/server';
-export { PaywallConfig, PaywallProvider, RouteConfigurationError, RouteValidationError, x402HTTPResourceServer, x402ResourceServer } from '@x402/core/server';
-import { Network, SchemeNetworkServer } from '@x402/core/types';
-export { Network, PaymentPayload, PaymentRequired, PaymentRequirements, SchemeNetworkServer } from '@x402/core/types';
-import { Request, Response, NextFunction } from 'express';
+import {
+  HTTPAdapter,
+  RoutesConfig,
+  x402ResourceServer,
+  PaywallConfig,
+  PaywallProvider,
+  FacilitatorClient,
+} from "x402-core-mantle/server";
+export {
+  PaywallConfig,
+  PaywallProvider,
+  RouteConfigurationError,
+  RouteValidationError,
+  x402HTTPResourceServer,
+  x402ResourceServer,
+} from "x402-core-mantle/server";
+import { Network, SchemeNetworkServer } from "x402-core-mantle/types";
+export {
+  Network,
+  PaymentPayload,
+  PaymentRequired,
+  PaymentRequirements,
+  SchemeNetworkServer,
+} from "x402-core-mantle/types";
+import { Request, Response, NextFunction } from "express";
 
 /**
  * Express adapter implementation
  */
 declare class ExpressAdapter implements HTTPAdapter {
-    private req;
-    /**
-     * Creates a new ExpressAdapter instance.
-     *
-     * @param req - The Express request object
-     */
-    constructor(req: Request);
-    /**
-     * Gets a header value from the request.
-     *
-     * @param name - The header name
-     * @returns The header value or undefined
-     */
-    getHeader(name: string): string | undefined;
-    /**
-     * Gets the HTTP method of the request.
-     *
-     * @returns The HTTP method
-     */
-    getMethod(): string;
-    /**
-     * Gets the path of the request.
-     *
-     * @returns The request path
-     */
-    getPath(): string;
-    /**
-     * Gets the full URL of the request.
-     *
-     * @returns The full request URL
-     */
-    getUrl(): string;
-    /**
-     * Gets the Accept header from the request.
-     *
-     * @returns The Accept header value or empty string
-     */
-    getAcceptHeader(): string;
-    /**
-     * Gets the User-Agent header from the request.
-     *
-     * @returns The User-Agent header value or empty string
-     */
-    getUserAgent(): string;
-    /**
-     * Gets all query parameters from the request URL.
-     *
-     * @returns Record of query parameter key-value pairs
-     */
-    getQueryParams(): Record<string, string | string[]>;
-    /**
-     * Gets a specific query parameter by name.
-     *
-     * @param name - The query parameter name
-     * @returns The query parameter value(s) or undefined
-     */
-    getQueryParam(name: string): string | string[] | undefined;
-    /**
-     * Gets the parsed request body.
-     * Requires express.json() or express.urlencoded() middleware.
-     *
-     * @returns The parsed request body
-     */
-    getBody(): unknown;
+  private req;
+  /**
+   * Creates a new ExpressAdapter instance.
+   *
+   * @param req - The Express request object
+   */
+  constructor(req: Request);
+  /**
+   * Gets a header value from the request.
+   *
+   * @param name - The header name
+   * @returns The header value or undefined
+   */
+  getHeader(name: string): string | undefined;
+  /**
+   * Gets the HTTP method of the request.
+   *
+   * @returns The HTTP method
+   */
+  getMethod(): string;
+  /**
+   * Gets the path of the request.
+   *
+   * @returns The request path
+   */
+  getPath(): string;
+  /**
+   * Gets the full URL of the request.
+   *
+   * @returns The full request URL
+   */
+  getUrl(): string;
+  /**
+   * Gets the Accept header from the request.
+   *
+   * @returns The Accept header value or empty string
+   */
+  getAcceptHeader(): string;
+  /**
+   * Gets the User-Agent header from the request.
+   *
+   * @returns The User-Agent header value or empty string
+   */
+  getUserAgent(): string;
+  /**
+   * Gets all query parameters from the request URL.
+   *
+   * @returns Record of query parameter key-value pairs
+   */
+  getQueryParams(): Record<string, string | string[]>;
+  /**
+   * Gets a specific query parameter by name.
+   *
+   * @param name - The query parameter name
+   * @returns The query parameter value(s) or undefined
+   */
+  getQueryParam(name: string): string | string[] | undefined;
+  /**
+   * Gets the parsed request body.
+   * Requires express.json() or express.urlencoded() middleware.
+   *
+   * @returns The parsed request body
+   */
+  getBody(): unknown;
 }
 
 /**
  * Configuration for registering a payment scheme with a specific network
  */
 interface SchemeRegistration {
-    /**
-     * The network identifier (e.g., 'eip155:84532', 'solana:mainnet')
-     */
-    network: Network;
-    /**
-     * The scheme server implementation for this network
-     */
-    server: SchemeNetworkServer;
+  /**
+   * The network identifier (e.g., 'eip155:84532', 'solana:mainnet')
+   */
+  network: Network;
+  /**
+   * The scheme server implementation for this network
+   */
+  server: SchemeNetworkServer;
 }
 /**
  * Express payment middleware for x402 protocol (direct server instance).
@@ -104,7 +124,7 @@ interface SchemeRegistration {
  * @example
  * ```typescript
  * import { paymentMiddleware } from "@x402/express";
- * import { x402ResourceServer } from "@x402/core/server";
+ * import { x402ResourceServer } from "x402-core-mantle/server";
  * import { registerExactEvmScheme } from "@x402/evm/exact/server";
  *
  * const server = new x402ResourceServer(myFacilitatorClient);
@@ -113,7 +133,13 @@ interface SchemeRegistration {
  * app.use(paymentMiddleware(routes, server, paywallConfig));
  * ```
  */
-declare function paymentMiddleware(routes: RoutesConfig, server: x402ResourceServer, paywallConfig?: PaywallConfig, paywall?: PaywallProvider, syncFacilitatorOnStart?: boolean): (req: Request, res: Response, next: NextFunction) => Promise<void>;
+declare function paymentMiddleware(
+  routes: RoutesConfig,
+  server: x402ResourceServer,
+  paywallConfig?: PaywallConfig,
+  paywall?: PaywallProvider,
+  syncFacilitatorOnStart?: boolean
+): (req: Request, res: Response, next: NextFunction) => Promise<void>;
 /**
  * Express payment middleware for x402 protocol (configuration-based).
  *
@@ -140,6 +166,18 @@ declare function paymentMiddleware(routes: RoutesConfig, server: x402ResourceSer
  * ));
  * ```
  */
-declare function paymentMiddlewareFromConfig(routes: RoutesConfig, facilitatorClients?: FacilitatorClient | FacilitatorClient[], schemes?: SchemeRegistration[], paywallConfig?: PaywallConfig, paywall?: PaywallProvider, syncFacilitatorOnStart?: boolean): (req: Request, res: Response, next: NextFunction) => Promise<void>;
+declare function paymentMiddlewareFromConfig(
+  routes: RoutesConfig,
+  facilitatorClients?: FacilitatorClient | FacilitatorClient[],
+  schemes?: SchemeRegistration[],
+  paywallConfig?: PaywallConfig,
+  paywall?: PaywallProvider,
+  syncFacilitatorOnStart?: boolean
+): (req: Request, res: Response, next: NextFunction) => Promise<void>;
 
-export { ExpressAdapter, type SchemeRegistration, paymentMiddleware, paymentMiddlewareFromConfig };
+export {
+  ExpressAdapter,
+  type SchemeRegistration,
+  paymentMiddleware,
+  paymentMiddlewareFromConfig,
+};

package/lib/cjs/index.js

@@ -38,7 +38,7 @@ __export(src_exports, {
   x402ResourceServer: () => import_server2.x402ResourceServer
 });
 module.exports = __toCommonJS(src_exports);
-var import_server = require("@x402/core/server");
+var import_server = require("x402-core-mantle/server");
 
 // src/adapter.ts
 var ExpressAdapter = class {
@@ -130,8 +130,8 @@ var ExpressAdapter = class {
 };
 
 // src/index.ts
-var import_server2 = require("@x402/core/server");
-var import_server3 = require("@x402/core/server");
+var import_server2 = require("x402-core-mantle/server");
+var import_server3 = require("x402-core-mantle/server");
 function checkIfBazaarNeeded(routes) {
   if ("accepts" in routes) {
     return !!(routes.extensions && "bazaar" in routes.extensions);

package/lib/esm/index.d.mts

@@ -1,7 +1,7 @@
-import { HTTPAdapter, RoutesConfig, x402ResourceServer, PaywallConfig, PaywallProvider, FacilitatorClient } from '@x402/core/server';
-export { PaywallConfig, PaywallProvider, RouteConfigurationError, RouteValidationError, x402HTTPResourceServer, x402ResourceServer } from '@x402/core/server';
-import { Network, SchemeNetworkServer } from '@x402/core/types';
-export { Network, PaymentPayload, PaymentRequired, PaymentRequirements, SchemeNetworkServer } from '@x402/core/types';
+import { HTTPAdapter, RoutesConfig, x402ResourceServer, PaywallConfig, PaywallProvider, FacilitatorClient } from 'x402-core-mantle/server';
+export { PaywallConfig, PaywallProvider, RouteConfigurationError, RouteValidationError, x402HTTPResourceServer, x402ResourceServer } from 'x402-core-mantle/server';
+import { Network, SchemeNetworkServer } from 'x402-core-mantle/types';
+export { Network, PaymentPayload, PaymentRequired, PaymentRequirements, SchemeNetworkServer } from 'x402-core-mantle/types';
 import { Request, Response, NextFunction } from 'express';
 
 /**
@@ -104,7 +104,7 @@ interface SchemeRegistration {
  * @example
  * ```typescript
  * import { paymentMiddleware } from "@x402/express";
- * import { x402ResourceServer } from "@x402/core/server";
+ * import { x402ResourceServer } from "x402-core-mantle/server";
  * import { registerExactEvmScheme } from "@x402/evm/exact/server";
  *
  * const server = new x402ResourceServer(myFacilitatorClient);

package/lib/esm/index.mjs

@@ -2,7 +2,7 @@
 import {
   x402HTTPResourceServer,
   x402ResourceServer
-} from "@x402/core/server";
+} from "x402-core-mantle/server";
 
 // src/adapter.ts
 var ExpressAdapter = class {
@@ -94,8 +94,8 @@ var ExpressAdapter = class {
 };
 
 // src/index.ts
-import { x402ResourceServer as x402ResourceServer2, x402HTTPResourceServer as x402HTTPResourceServer2 } from "@x402/core/server";
-import { RouteConfigurationError } from "@x402/core/server";
+import { x402ResourceServer as x402ResourceServer2, x402HTTPResourceServer as x402HTTPResourceServer2 } from "x402-core-mantle/server";
+import { RouteConfigurationError } from "x402-core-mantle/server";
 function checkIfBazaarNeeded(routes) {
   if ("accepts" in routes) {
     return !!(routes.extensions && "bazaar" in routes.extensions);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "x402-express-mantle",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "main": "./src/index.js",
   "type": "module",
   "scripts": {
@@ -20,6 +20,9 @@
   "author": "Mantle x402 Team",
   "description": "x402 Express middleware SDK with built-in Mantle testnet support and USDC Token configurations",
   "dependencies": {
+    "x402-core-mantle": "2.1.1-mantle",
+    "x402-evm-mantle": "2.1.1-mantle",
+    "x402-svm-mantle": "2.1.1-mantle",
     "@solana/kit": "^2.1.1",
     "viem": "^2.39.3",
     "zod": "^3.24.2"
@@ -31,9 +34,7 @@
     ".": "./src/index.js"
   },
   "files": [
-    "src",
     "lib",
-    "examples",
     "README.md"
   ]
 }

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

@@ -1,243 +0,0 @@
-import { c as PaymentRequired, a as PaymentRequirements, P as PaymentPayload, N as Network, d as SchemeNetworkClient, S as SettleResponse } from '../mechanisms-CzuGzYsS.js';
-
-/**
- * Client Hook Context Interfaces
- */
-interface PaymentCreationContext {
-    paymentRequired: PaymentRequired;
-    selectedRequirements: PaymentRequirements;
-}
-interface PaymentCreatedContext extends PaymentCreationContext {
-    paymentPayload: PaymentPayload;
-}
-interface PaymentCreationFailureContext extends PaymentCreationContext {
-    error: Error;
-}
-/**
- * Client Hook Type Definitions
- */
-type BeforePaymentCreationHook = (context: PaymentCreationContext) => Promise<void | {
-    abort: true;
-    reason: string;
-}>;
-type AfterPaymentCreationHook = (context: PaymentCreatedContext) => Promise<void>;
-type OnPaymentCreationFailureHook = (context: PaymentCreationFailureContext) => Promise<void | {
-    recovered: true;
-    payload: PaymentPayload;
-}>;
-type SelectPaymentRequirements = (x402Version: number, paymentRequirements: PaymentRequirements[]) => PaymentRequirements;
-/**
- * A policy function that filters or transforms payment requirements.
- * Policies are applied in order before the selector chooses the final option.
- *
- * @param x402Version - The x402 protocol version
- * @param paymentRequirements - Array of payment requirements to filter/transform
- * @returns Filtered array of payment requirements
- */
-type PaymentPolicy = (x402Version: number, paymentRequirements: PaymentRequirements[]) => PaymentRequirements[];
-/**
- * Configuration for registering a payment scheme with a specific network
- */
-interface SchemeRegistration {
-    /**
-     * The network identifier (e.g., 'eip155:8453', 'solana:mainnet')
-     */
-    network: Network;
-    /**
-     * The scheme client implementation for this network
-     */
-    client: SchemeNetworkClient;
-    /**
-     * The x402 protocol version to use for this scheme
-     *
-     * @default 2
-     */
-    x402Version?: number;
-}
-/**
- * Configuration options for the fetch wrapper
- */
-interface x402ClientConfig {
-    /**
-     * Array of scheme registrations defining which payment methods are supported
-     */
-    schemes: SchemeRegistration[];
-    /**
-     * Policies to apply to the client
-     */
-    policies?: PaymentPolicy[];
-    /**
-     * Custom payment requirements selector function
-     * If not provided, uses the default selector (first available option)
-     */
-    paymentRequirementsSelector?: SelectPaymentRequirements;
-}
-/**
- * Core client for managing x402 payment schemes and creating payment payloads.
- *
- * Handles registration of payment schemes, policy-based filtering of payment requirements,
- * and creation of payment payloads based on server requirements.
- */
-declare class x402Client {
-    private readonly paymentRequirementsSelector;
-    private readonly registeredClientSchemes;
-    private readonly policies;
-    private beforePaymentCreationHooks;
-    private afterPaymentCreationHooks;
-    private onPaymentCreationFailureHooks;
-    /**
-     * Creates a new x402Client instance.
-     *
-     * @param paymentRequirementsSelector - Function to select payment requirements from available options
-     */
-    constructor(paymentRequirementsSelector?: SelectPaymentRequirements);
-    /**
-     * Creates a new x402Client instance from a configuration object.
-     *
-     * @param config - The client configuration including schemes, policies, and payment requirements selector
-     * @returns A configured x402Client instance
-     */
-    static fromConfig(config: x402ClientConfig): x402Client;
-    /**
-     * Registers a scheme client for the current x402 version.
-     *
-     * @param network - The network to register the client for
-     * @param client - The scheme network client to register
-     * @returns The x402Client instance for chaining
-     */
-    register(network: Network, client: SchemeNetworkClient): x402Client;
-    /**
-     * Registers a scheme client for x402 version 1.
-     *
-     * @param network - The v1 network identifier (e.g., 'base-sepolia', 'solana-devnet')
-     * @param client - The scheme network client to register
-     * @returns The x402Client instance for chaining
-     */
-    registerV1(network: string, client: SchemeNetworkClient): x402Client;
-    /**
-     * Registers a policy to filter or transform payment requirements.
-     *
-     * Policies are applied in order after filtering by registered schemes
-     * and before the selector chooses the final payment requirement.
-     *
-     * @param policy - Function to filter/transform payment requirements
-     * @returns The x402Client instance for chaining
-     *
-     * @example
-     * ```typescript
-     * // Prefer cheaper options
-     * client.registerPolicy((version, reqs) =>
-     *   reqs.filter(r => BigInt(r.value) < BigInt('1000000'))
-     * );
-     *
-     * // Prefer specific networks
-     * client.registerPolicy((version, reqs) =>
-     *   reqs.filter(r => r.network.startsWith('eip155:'))
-     * );
-     * ```
-     */
-    registerPolicy(policy: PaymentPolicy): x402Client;
-    /**
-     * Register a hook to execute before payment payload creation.
-     * Can abort creation by returning { abort: true, reason: string }
-     *
-     * @param hook - The hook function to register
-     * @returns The x402Client instance for chaining
-     */
-    onBeforePaymentCreation(hook: BeforePaymentCreationHook): x402Client;
-    /**
-     * Register a hook to execute after successful payment payload creation.
-     *
-     * @param hook - The hook function to register
-     * @returns The x402Client instance for chaining
-     */
-    onAfterPaymentCreation(hook: AfterPaymentCreationHook): x402Client;
-    /**
-     * Register a hook to execute when payment payload creation fails.
-     * Can recover from failure by returning { recovered: true, payload: PaymentPayload }
-     *
-     * @param hook - The hook function to register
-     * @returns The x402Client instance for chaining
-     */
-    onPaymentCreationFailure(hook: OnPaymentCreationFailureHook): x402Client;
-    /**
-     * Creates a payment payload based on a PaymentRequired response.
-     *
-     * Automatically extracts x402Version, resource, and extensions from the PaymentRequired
-     * response and constructs a complete PaymentPayload with the accepted requirements.
-     *
-     * @param paymentRequired - The PaymentRequired response from the server
-     * @returns Promise resolving to the complete payment payload
-     */
-    createPaymentPayload(paymentRequired: PaymentRequired): Promise<PaymentPayload>;
-    /**
-     * Selects appropriate payment requirements based on registered clients and policies.
-     *
-     * Selection process:
-     * 1. Filter by registered schemes (network + scheme support)
-     * 2. Apply all registered policies in order
-     * 3. Use selector to choose final requirement
-     *
-     * @param x402Version - The x402 protocol version
-     * @param paymentRequirements - Array of available payment requirements
-     * @returns The selected payment requirements
-     */
-    private selectPaymentRequirements;
-    /**
-     * Internal method to register a scheme client.
-     *
-     * @param x402Version - The x402 protocol version
-     * @param network - The network to register the client for
-     * @param client - The scheme network client to register
-     * @returns The x402Client instance for chaining
-     */
-    private _registerScheme;
-}
-
-/**
- * HTTP-specific client for handling x402 payment protocol over HTTP.
- *
- * Wraps a x402Client to provide HTTP-specific encoding/decoding functionality
- * for payment headers and responses while maintaining the builder pattern.
- */
-declare class x402HTTPClient {
-    private readonly client;
-    /**
-     * Creates a new x402HTTPClient instance.
-     *
-     * @param client - The underlying x402Client for payment logic
-     */
-    constructor(client: x402Client);
-    /**
-     * Encodes a payment payload into appropriate HTTP headers based on version.
-     *
-     * @param paymentPayload - The payment payload to encode
-     * @returns HTTP headers containing the encoded payment signature
-     */
-    encodePaymentSignatureHeader(paymentPayload: PaymentPayload): Record<string, string>;
-    /**
-     * Extracts payment required information from HTTP response.
-     *
-     * @param getHeader - Function to retrieve header value by name (case-insensitive)
-     * @param body - Optional response body for v1 compatibility
-     * @returns The payment required object
-     */
-    getPaymentRequiredResponse(getHeader: (name: string) => string | null | undefined, body?: unknown): PaymentRequired;
-    /**
-     * Extracts payment settlement response from HTTP headers.
-     *
-     * @param getHeader - Function to retrieve header value by name (case-insensitive)
-     * @returns The settlement response object
-     */
-    getPaymentSettleResponse(getHeader: (name: string) => string | null | undefined): SettleResponse;
-    /**
-     * Creates a payment payload for the given payment requirements.
-     * Delegates to the underlying x402Client.
-     *
-     * @param paymentRequired - The payment required response from the server
-     * @returns Promise resolving to the payment payload
-     */
-    createPaymentPayload(paymentRequired: PaymentRequired): Promise<PaymentPayload>;
-}
-
-export { type AfterPaymentCreationHook, type BeforePaymentCreationHook, type OnPaymentCreationFailureHook, type PaymentCreatedContext, type PaymentCreationContext, type PaymentCreationFailureContext, type PaymentPolicy, type SchemeRegistration, type SelectPaymentRequirements, x402Client, type x402ClientConfig, x402HTTPClient };