x402-express-mantle 1.0.0

package/lib/cjs/mechanisms-CzuGzYsS.d.ts

@@ -0,0 +1,270 @@
+type PaymentRequirementsV1 = {
+    scheme: string;
+    network: Network;
+    maxAmountRequired: string;
+    resource: string;
+    description: string;
+    mimeType: string;
+    outputSchema: Record<string, unknown>;
+    payTo: string;
+    maxTimeoutSeconds: number;
+    asset: string;
+    extra: Record<string, unknown>;
+};
+type PaymentRequiredV1 = {
+    x402Version: 1;
+    error?: string;
+    accepts: PaymentRequirementsV1[];
+};
+type PaymentPayloadV1 = {
+    x402Version: 1;
+    scheme: string;
+    network: Network;
+    payload: Record<string, unknown>;
+};
+type VerifyRequestV1 = {
+    paymentPayload: PaymentPayloadV1;
+    paymentRequirements: PaymentRequirementsV1;
+};
+type SettleRequestV1 = {
+    paymentPayload: PaymentPayloadV1;
+    paymentRequirements: PaymentRequirementsV1;
+};
+type SettleResponseV1 = {
+    success: boolean;
+    errorReason?: string;
+    payer?: string;
+    transaction: string;
+    network: Network;
+};
+type SupportedResponseV1 = {
+    kinds: {
+        x402Version: number;
+        scheme: string;
+        network: Network;
+        extra?: Record<string, unknown>;
+    }[];
+};
+
+interface ResourceServerExtension {
+    key: string;
+    enrichDeclaration?: (declaration: unknown, transportContext: unknown) => unknown;
+}
+
+type Network = `${string}:${string}`;
+type Money = string | number;
+type AssetAmount = {
+    asset: string;
+    amount: string;
+    extra?: Record<string, unknown>;
+};
+type Price = Money | AssetAmount;
+
+interface ResourceInfo {
+    url: string;
+    description: string;
+    mimeType: string;
+}
+type PaymentRequirements = {
+    scheme: string;
+    network: Network;
+    asset: string;
+    amount: string;
+    payTo: string;
+    maxTimeoutSeconds: number;
+    extra: Record<string, unknown>;
+};
+type PaymentRequired = {
+    x402Version: number;
+    error?: string;
+    resource: ResourceInfo;
+    accepts: PaymentRequirements[];
+    extensions?: Record<string, unknown>;
+};
+type PaymentPayload = {
+    x402Version: number;
+    resource: ResourceInfo;
+    accepted: PaymentRequirements;
+    payload: Record<string, unknown>;
+    extensions?: Record<string, unknown>;
+};
+
+type VerifyRequest = {
+    paymentPayload: PaymentPayload;
+    paymentRequirements: PaymentRequirements;
+};
+type VerifyResponse = {
+    isValid: boolean;
+    invalidReason?: string;
+    payer?: string;
+};
+type SettleRequest = {
+    paymentPayload: PaymentPayload;
+    paymentRequirements: PaymentRequirements;
+};
+type SettleResponse = {
+    success: boolean;
+    errorReason?: string;
+    payer?: string;
+    transaction: string;
+    network: Network;
+};
+type SupportedKind = {
+    x402Version: number;
+    scheme: string;
+    network: Network;
+    extra?: Record<string, unknown>;
+};
+type SupportedResponse = {
+    kinds: SupportedKind[];
+    extensions: string[];
+    signers: Record<string, string[]>;
+};
+/**
+ * Error thrown when payment verification fails.
+ */
+declare class VerifyError extends Error {
+    readonly invalidReason?: string;
+    readonly payer?: string;
+    readonly statusCode: number;
+    /**
+     * Creates a VerifyError from a failed verification response.
+     *
+     * @param statusCode - HTTP status code from the facilitator
+     * @param response - The verify response containing error details
+     */
+    constructor(statusCode: number, response: VerifyResponse);
+}
+/**
+ * Error thrown when payment settlement fails.
+ */
+declare class SettleError extends Error {
+    readonly errorReason?: string;
+    readonly payer?: string;
+    readonly transaction: string;
+    readonly network: Network;
+    readonly statusCode: number;
+    /**
+     * Creates a SettleError from a failed settlement response.
+     *
+     * @param statusCode - HTTP status code from the facilitator
+     * @param response - The settle response containing error details
+     */
+    constructor(statusCode: number, response: SettleResponse);
+}
+
+/**
+ * Money parser function that converts a numeric amount to an AssetAmount
+ * Receives the amount as a decimal number (e.g., 1.50 for $1.50)
+ * Returns null to indicate "cannot handle this amount", causing fallback to next parser
+ * Always returns a Promise for consistency - use async/await
+ *
+ * @param amount - The decimal amount (e.g., 1.50)
+ * @param network - The network identifier for context
+ * @returns AssetAmount or null to try next parser
+ */
+type MoneyParser = (amount: number, network: Network) => Promise<AssetAmount | null>;
+interface SchemeNetworkClient {
+    readonly scheme: string;
+    createPaymentPayload(x402Version: number, paymentRequirements: PaymentRequirements): Promise<Pick<PaymentPayload, "x402Version" | "payload">>;
+}
+interface SchemeNetworkFacilitator {
+    readonly scheme: string;
+    /**
+     * CAIP family pattern that this facilitator supports.
+     * Used to group signers by blockchain family in the supported response.
+     *
+     * @example
+     * // EVM facilitators
+     * readonly caipFamily = "eip155:*";
+     *
+     * @example
+     * // SVM facilitators
+     * readonly caipFamily = "solana:*";
+     */
+    readonly caipFamily: string;
+    /**
+     * Get mechanism-specific extra data needed for the supported kinds endpoint.
+     * This method is called when building the facilitator's supported response.
+     *
+     * @param network - The network identifier for context
+     * @returns Extra data object or undefined if no extra data is needed
+     *
+     * @example
+     * // EVM schemes return undefined (no extra data needed)
+     * getExtra(network: Network): undefined {
+     *   return undefined;
+     * }
+     *
+     * @example
+     * // SVM schemes return feePayer address
+     * getExtra(network: Network): Record<string, unknown> | undefined {
+     *   return { feePayer: this.signer.address };
+     * }
+     */
+    getExtra(network: Network): Record<string, unknown> | undefined;
+    /**
+     * Get signer addresses used by this facilitator for a given network.
+     * These are included in the supported response to help clients understand
+     * which addresses might sign/pay for transactions.
+     *
+     * Supports multiple addresses for load balancing, key rotation, and high availability.
+     *
+     * @param network - The network identifier
+     * @returns Array of signer addresses (wallet addresses, fee payer addresses, etc.)
+     *
+     * @example
+     * // EVM facilitator
+     * getSigners(network: string): string[] {
+     *   return [...this.signer.getAddresses()];
+     * }
+     *
+     * @example
+     * // SVM facilitator
+     * getSigners(network: string): string[] {
+     *   return [...this.signer.getAddresses()];
+     * }
+     */
+    getSigners(network: string): string[];
+    verify(payload: PaymentPayload, requirements: PaymentRequirements): Promise<VerifyResponse>;
+    settle(payload: PaymentPayload, requirements: PaymentRequirements): Promise<SettleResponse>;
+}
+interface SchemeNetworkServer {
+    readonly scheme: string;
+    /**
+     * Convert a user-friendly price to the scheme's specific amount and asset format
+     * Always returns a Promise for consistency
+     *
+     * @param price - User-friendly price (e.g., "$0.10", "0.10", { amount: "100000", asset: "USDC" })
+     * @param network - The network identifier for context
+     * @returns Promise that resolves to the converted amount, asset identifier, and any extra metadata
+     *
+     * @example
+     * // For EVM networks with USDC:
+     * await parsePrice("$0.10", "eip155:8453") => { amount: "100000", asset: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" }
+     *
+     * // For custom schemes:
+     * await parsePrice("10 points", "custom:network") => { amount: "10", asset: "points" }
+     */
+    parsePrice(price: Price, network: Network): Promise<AssetAmount>;
+    /**
+     * Build payment requirements for this scheme/network combination
+     *
+     * @param paymentRequirements - Base payment requirements with amount/asset already set
+     * @param supportedKind - The supported kind from facilitator's /supported endpoint
+     * @param supportedKind.x402Version - The x402 version
+     * @param supportedKind.scheme - The payment scheme
+     * @param supportedKind.network - The network identifier
+     * @param supportedKind.extra - Optional extra metadata
+     * @param facilitatorExtensions - Extensions supported by the facilitator
+     * @returns Enhanced payment requirements ready to be sent to clients
+     */
+    enhancePaymentRequirements(paymentRequirements: PaymentRequirements, supportedKind: {
+        x402Version: number;
+        scheme: string;
+        network: Network;
+        extra?: Record<string, unknown>;
+    }, facilitatorExtensions: string[]): Promise<PaymentRequirements>;
+}
+
+export { type AssetAmount as A, type Money as M, type Network as N, type PaymentPayload as P, type ResourceServerExtension as R, type SettleResponse as S, type VerifyResponse as V, type PaymentRequirements as a, type SchemeNetworkFacilitator as b, type PaymentRequired as c, type SchemeNetworkClient as d, type SupportedResponse as e, type SchemeNetworkServer as f, type SupportedKind as g, type Price as h, type PaymentRequirementsV1 as i, type PaymentRequiredV1 as j, type PaymentPayloadV1 as k, type VerifyRequestV1 as l, type SettleRequestV1 as m, type SettleResponseV1 as n, type SupportedResponseV1 as o, type VerifyRequest as p, type SettleRequest as q, VerifyError as r, SettleError as s, type MoneyParser as t };

package/lib/cjs/scheme-MoBRXFM8.d.ts

@@ -0,0 +1,29 @@
+import { SchemeNetworkClient, PaymentRequirements, PaymentPayload } from '@x402/core/types';
+import { C as ClientSvmSigner, a as ClientSvmConfig } from './signer-BMkbhFYE.js';
+
+/**
+ * SVM client implementation for the Exact payment scheme.
+ */
+declare class ExactSvmScheme implements SchemeNetworkClient {
+    private readonly signer;
+    private readonly config?;
+    readonly scheme = "exact";
+    /**
+     * Creates a new ExactSvmClient instance.
+     *
+     * @param signer - The SVM signer for client operations
+     * @param config - Optional configuration with custom RPC URL
+     * @returns ExactSvmClient instance
+     */
+    constructor(signer: ClientSvmSigner, config?: ClientSvmConfig | undefined);
+    /**
+     * Creates a payment payload for the Exact scheme.
+     *
+     * @param x402Version - The x402 protocol version
+     * @param paymentRequirements - The payment requirements
+     * @returns Promise resolving to a payment payload
+     */
+    createPaymentPayload(x402Version: number, paymentRequirements: PaymentRequirements): Promise<Pick<PaymentPayload, "x402Version" | "payload">>;
+}
+
+export { ExactSvmScheme as E };

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

@@ -0,0 +1,2 @@
+export { C as CompiledRoute, F as FacilitatorClient, o as FacilitatorConfig, H as HTTPAdapter, n as HTTPFacilitatorClient, c as HTTPProcessResult, a as HTTPRequestContext, b as HTTPResponseInstructions, P as PaywallConfig, d as PaywallProvider, k as ProcessSettleFailureResponse, i as ProcessSettleResultResponse, j as ProcessSettleSuccessResponse, q as ResourceConfig, r as ResourceInfo, R as RouteConfig, m as RouteConfigurationError, l as RouteValidationError, f as RoutesConfig, U as UnpaidResponseBody, h as UnpaidResponseResult, x as x402HTTPResourceServer, p as x402ResourceServer } from '../x402HTTPResourceServer-D1YtlH_r.js';
+import '../mechanisms-CzuGzYsS.js';