@4mica/x402 0.1.0

package/dist/client/index.d.ts

@@ -0,0 +1 @@
+export * from './scheme.js';

package/dist/client/index.js

@@ -0,0 +1 @@
+export * from './scheme.js';

package/dist/client/scheme.d.ts

@@ -0,0 +1,11 @@
+import { SchemeNetworkClient, PaymentRequirements, PaymentPayload } from '@x402/core/types';
+import { Account } from 'viem/accounts';
+export declare class FourMicaEvmScheme implements SchemeNetworkClient {
+    private readonly signer;
+    private readonly x402Flows;
+    readonly scheme = "4mica-credit";
+    private constructor();
+    private static createX402Flow;
+    static create(signer: Account): Promise<FourMicaEvmScheme>;
+    createPaymentPayload(x402Version: number, paymentRequirements: PaymentRequirements): Promise<Pick<PaymentPayload, 'x402Version' | 'payload'>>;
+}

package/dist/client/scheme.js

@@ -0,0 +1,65 @@
+import { Client, ConfigBuilder, X402Flow, } from '@4mica/sdk';
+import { SUPPORTED_NETWORKS } from '../server/scheme.js';
+const NETWORK_RPC_URLS = {
+    'eip155:11155111': 'https://ethereum.sepolia.api.4mica.xyz',
+    'eip155:80002': 'https://api.4mica.xyz',
+};
+export class FourMicaEvmScheme {
+    constructor(signer, 
+    // rpcUrl -> x402Flow
+    x402Flows) {
+        this.signer = signer;
+        this.x402Flows = x402Flows;
+        this.scheme = '4mica-credit';
+    }
+    static async createX402Flow(signer, rpcUrl) {
+        const cfg = new ConfigBuilder().rpcUrl(rpcUrl).signer(signer).build();
+        const client = await Client.new(cfg);
+        return X402Flow.fromClient(client);
+    }
+    static async create(signer) {
+        const x402Flows = new Map();
+        for (const network of SUPPORTED_NETWORKS) {
+            const rpcUrl = NETWORK_RPC_URLS[network];
+            if (!rpcUrl)
+                continue;
+            x402Flows.set(rpcUrl, await FourMicaEvmScheme.createX402Flow(signer, rpcUrl));
+        }
+        return new FourMicaEvmScheme(signer, x402Flows);
+    }
+    async createPaymentPayload(x402Version, paymentRequirements) {
+        const network = paymentRequirements.network;
+        if (!network) {
+            throw new Error('Network is required in PaymentRequirements');
+        }
+        const rpcUrl = paymentRequirements.extra?.rpcUrl ?? NETWORK_RPC_URLS[network];
+        if (!rpcUrl) {
+            throw new Error(`No RPC URL configured for network ${network}`);
+        }
+        let x402Flow = this.x402Flows.get(rpcUrl);
+        if (!x402Flow) {
+            x402Flow = await FourMicaEvmScheme.createX402Flow(this.signer, rpcUrl);
+            this.x402Flows.set(rpcUrl, x402Flow);
+        }
+        if (x402Version === 1) {
+            const signed = await x402Flow.signPayment(paymentRequirements, this.signer.address);
+            return {
+                x402Version: 1,
+                payload: signed.payload,
+            };
+        }
+        else if (x402Version === 2) {
+            const paymentRequired = {
+                x402Version: 2,
+                resource: { url: '', description: '', mimeType: '' },
+                accepts: [paymentRequirements],
+            };
+            const signed = await x402Flow.signPaymentV2(paymentRequired, paymentRequirements, this.signer.address);
+            return {
+                x402Version: 2,
+                payload: signed.payload,
+            };
+        }
+        throw new Error(`Unsupported x402Version: ${x402Version}`);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export type { PaymentRequired, PaymentRequirements, PaymentPayload, Network, SchemeNetworkServer, } from '@x402/core/types';

package/dist/index.js

@@ -0,0 +1 @@
+export {};

package/dist/server/express/adapter.d.ts

@@ -0,0 +1,71 @@
+import { HTTPAdapter } from '@x402/core/server';
+import { Request } from 'express';
+/**
+ * Express adapter implementation
+ */
+export 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;
+}

package/dist/server/express/adapter.js

@@ -0,0 +1,90 @@
+/**
+ * Express adapter implementation
+ */
+export class ExpressAdapter {
+    /**
+     * Creates a new ExpressAdapter instance.
+     *
+     * @param req - The Express request object
+     */
+    constructor(req) {
+        this.req = req;
+    }
+    /**
+     * Gets a header value from the request.
+     *
+     * @param name - The header name
+     * @returns The header value or undefined
+     */
+    getHeader(name) {
+        const value = this.req.header(name);
+        return Array.isArray(value) ? value[0] : value;
+    }
+    /**
+     * Gets the HTTP method of the request.
+     *
+     * @returns The HTTP method
+     */
+    getMethod() {
+        return this.req.method;
+    }
+    /**
+     * Gets the path of the request.
+     *
+     * @returns The request path
+     */
+    getPath() {
+        return this.req.path;
+    }
+    /**
+     * Gets the full URL of the request.
+     *
+     * @returns The full request URL
+     */
+    getUrl() {
+        return `${this.req.protocol}://${this.req.headers.host}${this.req.originalUrl}`;
+    }
+    /**
+     * Gets the Accept header from the request.
+     *
+     * @returns The Accept header value or empty string
+     */
+    getAcceptHeader() {
+        return this.req.header('Accept') || '';
+    }
+    /**
+     * Gets the User-Agent header from the request.
+     *
+     * @returns The User-Agent header value or empty string
+     */
+    getUserAgent() {
+        return this.req.header('User-Agent') || '';
+    }
+    /**
+     * Gets all query parameters from the request URL.
+     *
+     * @returns Record of query parameter key-value pairs
+     */
+    getQueryParams() {
+        return this.req.query;
+    }
+    /**
+     * Gets a specific query parameter by name.
+     *
+     * @param name - The query parameter name
+     * @returns The query parameter value(s) or undefined
+     */
+    getQueryParam(name) {
+        const value = this.req.query[name];
+        return value;
+    }
+    /**
+     * Gets the parsed request body.
+     * Requires express.json() or express.urlencoded() middleware.
+     *
+     * @returns The parsed request body
+     */
+    getBody() {
+        return this.req.body;
+    }
+}

package/dist/server/express/index.d.ts

@@ -0,0 +1,122 @@
+import { PaywallConfig, PaywallProvider, x402HTTPResourceServer, x402ResourceServer, RoutesConfig, FacilitatorClient } from '@x402/core/server';
+import { SchemeNetworkServer, Network } from '@x402/core/types';
+import { NextFunction, Request, Response } from 'express';
+/**
+ * Configuration for payment tab handling
+ */
+interface TabConfig {
+    /**
+     * The full URL endpoint for opening payment tabs. This URL is injected into
+     * paymentRequirements.extra and clients use it to open a payment tab.
+     * When a request matches this endpoint's path, the middleware will parse
+     * the request body and call the 4mica facilitator to open a tab.
+     *
+     * @example "https://api.example.com/x402/tab"
+     */
+    advertisedEndpoint: string;
+    /**
+     * The lifetime of the payment tab in seconds. Defines how long the tab
+     * remains valid before expiring.
+     *
+     * @example 3600 // 1 hour
+     */
+    ttlSeconds?: number;
+}
+/**
+ * Configuration for registering a payment scheme with a specific network
+ */
+export interface SchemeRegistration {
+    /**
+     * 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 HTTP server instance).
+ *
+ * Use this when you need to configure HTTP-level hooks.
+ *
+ * @param httpServer - Pre-configured x402HTTPResourceServer instance
+ * @param tabConfig - Configuration for payment tab handling (endpoint URL and TTL)
+ * @param paywallConfig - Optional configuration for the built-in paywall UI
+ * @param paywall - Optional custom paywall provider (overrides default)
+ * @param syncFacilitatorOnStart - Whether to sync with the facilitator on startup (defaults to true)
+ * @returns Express middleware handler
+ *
+ * @example
+ * ```typescript
+ * import { paymentMiddlewareFromHTTPServer, x402ResourceServer, x402HTTPResourceServer } from "@x402/express";
+ *
+ * const resourceServer = new x402ResourceServer(facilitatorClient)
+ *   .register(NETWORK, new ExactEvmScheme())
+ *
+ * const httpServer = new x402HTTPResourceServer(resourceServer, routes)
+ *   .onProtectedRequest(requestHook);
+ *
+ * app.use(paymentMiddlewareFromHTTPServer(
+ *   httpServer,
+ *   { advertisedEndpoint: "https://api.example.com/x402/tab" },
+ * )); * ```
+ */
+export declare function paymentMiddlewareFromHTTPServer(httpServer: x402HTTPResourceServer, tabConfig: TabConfig, paywallConfig?: PaywallConfig, paywall?: PaywallProvider, syncFacilitatorOnStart?: boolean): (req: Request, res: Response, next: NextFunction) => Promise<void | Response<any, Record<string, any>>>;
+/**
+ * Express payment middleware for x402 protocol (direct server instance).
+ *
+ * Use this when you want to pass a pre-configured x402ResourceServer instance.
+ * This provides more flexibility for testing, custom configuration, and reusing
+ * server instances across multiple middlewares.
+ *
+ * @param routes - Route configurations for protected endpoints
+ * @param server - Pre-configured x402ResourceServer instance
+ * @param tabConfig - Configuration for payment tab handling (endpoint URL and TTL)
+ * @param paywallConfig - Optional configuration for the built-in paywall UI
+ * @param paywall - Optional custom paywall provider (overrides default)
+ * @param syncFacilitatorOnStart - Whether to sync with the facilitator on startup (defaults to true)
+ * @returns Express middleware handler
+ *
+ * @example
+ * ```typescript
+ * import { paymentMiddleware } from "@x402/express";
+ *
+ * const server = new x402ResourceServer(myFacilitatorClient)
+ *   .register(NETWORK, new ExactEvmScheme());
+ *
+ * app.use(paymentMiddleware(
+ *   routes,
+ *   server,
+ *   { advertisedEndpoint: "https://api.example.com/x402/tab" },
+ * ));
+ * ```
+ */
+export declare function paymentMiddleware(routes: RoutesConfig, server: x402ResourceServer, tabConfig: TabConfig, paywallConfig?: PaywallConfig, paywall?: PaywallProvider, syncFacilitatorOnStart?: boolean): (req: Request, res: Response, next: NextFunction) => Promise<void | Response<any, Record<string, any>>>;
+/**
+ * Express payment middleware for x402 protocol (configuration-based).
+ *
+ * Use this when you want to quickly set up middleware with simple configuration.
+ * This function creates and configures the x402ResourceServer internally.
+ *
+ * @param routes - Route configurations for protected endpoints
+ * @param tabConfig - Configuration for payment tab handling
+ * @param facilitatorClients - Optional facilitator client(s) for payment processing
+ * @param schemes - Optional array of scheme registrations for server-side payment processing
+ * @param paywallConfig - Optional configuration for the built-in paywall UI
+ * @param paywall - Optional custom paywall provider (overrides default)
+ * @param syncFacilitatorOnStart - Whether to sync with the facilitator on startup (defaults to true)
+ * @returns Express middleware handler
+ *
+ * @example
+ * ```typescript
+ * import { paymentMiddlewareFromConfig } from "@x402/express";
+ *
+ * app.use(paymentMiddlewareFromConfig(
+ *   routes,
+ *   { advertisedEndpoint: "https://api.example.com/x402/tab" },
+ * ));
+ * ```
+ */
+export declare function paymentMiddlewareFromConfig(routes: RoutesConfig, tabConfig: TabConfig, facilitatorClients?: FacilitatorClient | FacilitatorClient[], schemes?: SchemeRegistration[], paywallConfig?: PaywallConfig, paywall?: PaywallProvider, syncFacilitatorOnStart?: boolean): (req: Request, res: Response, next: NextFunction) => Promise<void | Response<any, Record<string, any>>>;
+export { ExpressAdapter } from './adapter.js';