@puga-labs/x402-mantle-sdk 0.2.0 → 0.2.1

package/dist/index.cjs

@@ -20,8 +20,12 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  MANTLE_DEFAULTS: () => MANTLE_DEFAULTS,
+  createMantleClient: () => createMantleClient,
   createPaymentClient: () => createPaymentClient,
-  createPaymentMiddleware: () => createPaymentMiddleware
+  createPaymentMiddleware: () => createPaymentMiddleware,
+  mantlePaywall: () => mantlePaywall,
+  useMantleX402: () => useMantleX402
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -33,6 +37,15 @@ var MANTLE_MAINNET_USDC = {
   address: "0x09Bc4E0D864854c6aFB6eB9A9cdF58aC190D0dF9",
   decimals: 6
 };
+var MANTLE_DEFAULTS = {
+  NETWORK: "mantle-mainnet",
+  CHAIN_ID: 5e3,
+  USDC_ADDRESS: "0x09Bc4E0D864854c6aFB6eB9A9cdF58aC190D0dF9",
+  USDC_DECIMALS: 6,
+  CURRENCY: "USD",
+  SCHEME: "exact",
+  FACILITATOR_URL: (typeof process !== "undefined" ? process.env?.NEXT_PUBLIC_FACILITATOR_URL : void 0) || "http://localhost:8080"
+};
 function getDefaultAssetForNetwork(network) {
   switch (network) {
     case MANTLE_MAINNET_NETWORK_ID:
@@ -259,6 +272,30 @@ function createPaymentMiddleware(config) {
   };
 }
 
+// src/server/mantlePaywall.ts
+function mantlePaywall(opts) {
+  const { priceUsd, payTo, facilitatorUrl, telemetry, onPaymentSettled } = opts;
+  const priceUsdCents = Math.round(priceUsd * 100);
+  return (req, res, next) => {
+    const method = (req.method || "GET").toUpperCase();
+    const path = req.path || "/";
+    const routeKey = `${method} ${path}`;
+    const middleware = createPaymentMiddleware({
+      facilitatorUrl: facilitatorUrl || MANTLE_DEFAULTS.FACILITATOR_URL,
+      receiverAddress: payTo,
+      routes: {
+        [routeKey]: {
+          priceUsdCents,
+          network: MANTLE_DEFAULTS.NETWORK
+        }
+      },
+      telemetry,
+      onPaymentSettled
+    });
+    return middleware(req, res, next);
+  };
+}
+
 // src/shared/utils.ts
 function encodeJsonToBase64(value) {
   const json = JSON.stringify(value);
@@ -502,8 +539,62 @@ function createPaymentClient(config) {
     }
   };
 }
+
+// src/client/createMantleClient.ts
+function createMantleClient(config) {
+  const resourceUrl = config?.resourceUrl ?? (typeof window !== "undefined" ? window.location.origin : "");
+  const facilitatorUrl = config?.facilitatorUrl ?? (typeof process !== "undefined" ? process.env?.NEXT_PUBLIC_FACILITATOR_URL : void 0) ?? "http://localhost:8080";
+  return {
+    async post(url, body) {
+      const account = await config?.getAccount?.();
+      if (!account) {
+        throw new Error(
+          "Wallet not connected. Please connect your wallet first."
+        );
+      }
+      const provider = config?.getProvider?.();
+      if (!provider) {
+        throw new Error("Wallet provider not available");
+      }
+      const client = createPaymentClient({
+        resourceUrl,
+        facilitatorUrl,
+        provider,
+        userAddress: account,
+        projectKey: config?.projectKey
+      });
+      const result = await client.callWithPayment(url, {
+        method: "POST",
+        body
+      });
+      return result.response;
+    }
+  };
+}
+
+// src/client/react/useMantleX402.ts
+var import_wagmi = require("wagmi");
+function useMantleX402(opts) {
+  const { address, isConnected } = (0, import_wagmi.useAccount)();
+  const { data: walletClient } = (0, import_wagmi.useWalletClient)();
+  const client = createMantleClient({
+    facilitatorUrl: opts?.facilitatorUrl,
+    resourceUrl: opts?.resourceUrl,
+    projectKey: opts?.projectKey,
+    getAccount: () => {
+      if (!isConnected || !address) return void 0;
+      return address;
+    },
+    getProvider: () => walletClient
+  });
+  return client;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  MANTLE_DEFAULTS,
+  createMantleClient,
   createPaymentClient,
-  createPaymentMiddleware
+  createPaymentMiddleware,
+  mantlePaywall,
+  useMantleX402
 });

package/dist/index.d.cts

@@ -42,6 +42,20 @@ interface PaymentHeaderObject {
 /** Base64-encoded payment header, sent in X-PAYMENT. */
 type PaymentHeaderBase64 = string;
 
+/**
+ * Default values for Mantle mainnet x402 payments.
+ * These are used by the simplified API (mantlePaywall, createMantleClient).
+ */
+declare const MANTLE_DEFAULTS: {
+    readonly NETWORK: "mantle-mainnet";
+    readonly CHAIN_ID: 5000;
+    readonly USDC_ADDRESS: "0x09Bc4E0D864854c6aFB6eB9A9cdF58aC190D0dF9";
+    readonly USDC_DECIMALS: 6;
+    readonly CURRENCY: "USD";
+    readonly SCHEME: "exact";
+    readonly FACILITATOR_URL: string;
+};
+
 /** Unique key for a protected route, e.g. "GET /api/protected". */
 type RouteKey = string;
 /** Pricing config for a single route. */
@@ -113,9 +127,40 @@ interface PaymentMiddlewareConfig {
     /** Optional: Send usage telemetry for billing/analytics. */
     telemetry?: TelemetryConfig;
 }
+/**
+ * Minimal config for mantlePaywall() - simplified API for single-route protection.
+ * This is the "sweet path" for Mantle mainnet + USDC with sensible defaults.
+ */
+interface MinimalPaywallOptions {
+    /** Price in USD (e.g. 0.01 for 1 cent). */
+    priceUsd: number;
+    /** Recipient address (developer wallet). */
+    payTo: `0x${string}`;
+    /** Optional facilitator URL (defaults to localhost:8080 or NEXT_PUBLIC_FACILITATOR_URL). */
+    facilitatorUrl?: string;
+    /** Optional telemetry config. */
+    telemetry?: TelemetryConfig;
+    /** Optional payment settled hook. */
+    onPaymentSettled?: (entry: PaymentLogEntry) => void;
+}
 
 declare function createPaymentMiddleware(config: PaymentMiddlewareConfig): (req: Request, res: Response, next: NextFunction) => Promise<void>;
 
+/**
+ * Simplified wrapper for protecting a single route with x402 payments.
+ * Uses Mantle mainnet defaults (USDC, exact scheme, etc.).
+ *
+ * Usage:
+ * ```typescript
+ * const pay = mantlePaywall({ priceUsd: 0.01, payTo: "0x..." });
+ * export const POST = pay(async (req) => { ... });
+ * ```
+ *
+ * @param opts - Minimal configuration (price, payTo, optional facilitator/telemetry).
+ * @returns Express middleware function for single-route protection.
+ */
+declare function mantlePaywall(opts: MinimalPaywallOptions): (req: Request, res: Response, next: NextFunction) => Promise<void>;
+
 /** Config for the client-side payment helper. */
 interface PaymentClientConfig {
     /** Base URL of your protected resource server. */
@@ -161,4 +206,85 @@ interface PaymentClient {
  */
 declare function createPaymentClient(config: PaymentClientConfig): PaymentClient;
 
-export { type AssetConfig, type Authorization, type CallWithPaymentResult, type NetworkId, type PaymentClient, type PaymentClientConfig, type PaymentHeaderBase64, type PaymentHeaderObject, type PaymentHeaderPayload, type PaymentLogEntry, type PaymentMiddlewareConfig, type PaymentRequirements, type RouteKey, type RoutePricingConfig, type RoutesConfig, type TelemetryConfig, type TelemetryEvent, createPaymentClient, createPaymentMiddleware };
+/**
+ * Configuration for createMantleClient().
+ * All fields are optional - the client auto-detects sensible defaults.
+ */
+interface MantleClientConfig {
+    /** Optional facilitator URL (auto-detects from NEXT_PUBLIC_FACILITATOR_URL or defaults to localhost:8080). */
+    facilitatorUrl?: string;
+    /** Optional resource URL (defaults to current origin in browser, or empty string for relative paths). */
+    resourceUrl?: string;
+    /** Function to get user's wallet address (required for payments). */
+    getAccount?: () => Promise<string | undefined> | string | undefined;
+    /** Function to get wallet provider/client (e.g., viem WalletClient or window.ethereum). */
+    getProvider?: () => any;
+    /** Optional project key for hosted facilitator billing. */
+    projectKey?: string;
+}
+/**
+ * Simplified Mantle payment client interface.
+ * Provides a clean API for making paid POST requests.
+ */
+interface MantleClient {
+    /**
+     * Make a paid POST request to a protected endpoint.
+     * Automatically handles x402 flow (402 response, signing, payment, retry).
+     *
+     * @param url - API endpoint path (e.g., "/api/generate-image").
+     * @param body - Request body (will be JSON stringified).
+     * @returns Response data from the protected endpoint.
+     * @throws Error if wallet is not connected or payment fails.
+     */
+    post<TResp = any>(url: string, body?: any): Promise<TResp>;
+}
+/**
+ * Create a simplified Mantle payment client with auto-detected defaults.
+ *
+ * Usage:
+ * ```typescript
+ * const client = createMantleClient({
+ *   getAccount: () => account?.address,
+ *   getProvider: () => walletClient,
+ * });
+ *
+ * const data = await client.post("/api/generate", { prompt: "..." });
+ * ```
+ *
+ * @param config - Optional configuration (auto-detects facilitatorUrl and resourceUrl).
+ * @returns MantleClient instance with simplified post() method.
+ */
+declare function createMantleClient(config?: MantleClientConfig): MantleClient;
+
+/**
+ * Options for useMantleX402 React hook.
+ */
+interface UseMantleX402Options {
+    /** Optional facilitator URL (auto-detects from NEXT_PUBLIC_FACILITATOR_URL). */
+    facilitatorUrl?: string;
+    /** Optional resource URL (defaults to current origin). */
+    resourceUrl?: string;
+    /** Optional project key for hosted facilitator billing. */
+    projectKey?: string;
+}
+/**
+ * React hook for simplified Mantle x402 payments with wagmi integration.
+ *
+ * Automatically connects to the user's wallet via wagmi hooks and provides
+ * a clean API for making paid requests.
+ *
+ * Usage:
+ * ```typescript
+ * const { post } = useMantleX402();
+ *
+ * const data = await post("/api/generate-image", {
+ *   prompt: "A beautiful sunset"
+ * });
+ * ```
+ *
+ * @param opts - Optional configuration (facilitatorUrl, resourceUrl, projectKey).
+ * @returns MantleClient instance with post() method.
+ */
+declare function useMantleX402(opts?: UseMantleX402Options): MantleClient;
+
+export { type AssetConfig, type Authorization, type CallWithPaymentResult, MANTLE_DEFAULTS, type MantleClient, type MantleClientConfig, type MinimalPaywallOptions, type NetworkId, type PaymentClient, type PaymentClientConfig, type PaymentHeaderBase64, type PaymentHeaderObject, type PaymentHeaderPayload, type PaymentLogEntry, type PaymentMiddlewareConfig, type PaymentRequirements, type RouteKey, type RoutePricingConfig, type RoutesConfig, type TelemetryConfig, type TelemetryEvent, type UseMantleX402Options, createMantleClient, createPaymentClient, createPaymentMiddleware, mantlePaywall, useMantleX402 };

package/dist/index.d.ts

@@ -42,6 +42,20 @@ interface PaymentHeaderObject {
 /** Base64-encoded payment header, sent in X-PAYMENT. */
 type PaymentHeaderBase64 = string;
 
+/**
+ * Default values for Mantle mainnet x402 payments.
+ * These are used by the simplified API (mantlePaywall, createMantleClient).
+ */
+declare const MANTLE_DEFAULTS: {
+    readonly NETWORK: "mantle-mainnet";
+    readonly CHAIN_ID: 5000;
+    readonly USDC_ADDRESS: "0x09Bc4E0D864854c6aFB6eB9A9cdF58aC190D0dF9";
+    readonly USDC_DECIMALS: 6;
+    readonly CURRENCY: "USD";
+    readonly SCHEME: "exact";
+    readonly FACILITATOR_URL: string;
+};
+
 /** Unique key for a protected route, e.g. "GET /api/protected". */
 type RouteKey = string;
 /** Pricing config for a single route. */
@@ -113,9 +127,40 @@ interface PaymentMiddlewareConfig {
     /** Optional: Send usage telemetry for billing/analytics. */
     telemetry?: TelemetryConfig;
 }
+/**
+ * Minimal config for mantlePaywall() - simplified API for single-route protection.
+ * This is the "sweet path" for Mantle mainnet + USDC with sensible defaults.
+ */
+interface MinimalPaywallOptions {
+    /** Price in USD (e.g. 0.01 for 1 cent). */
+    priceUsd: number;
+    /** Recipient address (developer wallet). */
+    payTo: `0x${string}`;
+    /** Optional facilitator URL (defaults to localhost:8080 or NEXT_PUBLIC_FACILITATOR_URL). */
+    facilitatorUrl?: string;
+    /** Optional telemetry config. */
+    telemetry?: TelemetryConfig;
+    /** Optional payment settled hook. */
+    onPaymentSettled?: (entry: PaymentLogEntry) => void;
+}
 
 declare function createPaymentMiddleware(config: PaymentMiddlewareConfig): (req: Request, res: Response, next: NextFunction) => Promise<void>;
 
+/**
+ * Simplified wrapper for protecting a single route with x402 payments.
+ * Uses Mantle mainnet defaults (USDC, exact scheme, etc.).
+ *
+ * Usage:
+ * ```typescript
+ * const pay = mantlePaywall({ priceUsd: 0.01, payTo: "0x..." });
+ * export const POST = pay(async (req) => { ... });
+ * ```
+ *
+ * @param opts - Minimal configuration (price, payTo, optional facilitator/telemetry).
+ * @returns Express middleware function for single-route protection.
+ */
+declare function mantlePaywall(opts: MinimalPaywallOptions): (req: Request, res: Response, next: NextFunction) => Promise<void>;
+
 /** Config for the client-side payment helper. */
 interface PaymentClientConfig {
     /** Base URL of your protected resource server. */
@@ -161,4 +206,85 @@ interface PaymentClient {
  */
 declare function createPaymentClient(config: PaymentClientConfig): PaymentClient;
 
-export { type AssetConfig, type Authorization, type CallWithPaymentResult, type NetworkId, type PaymentClient, type PaymentClientConfig, type PaymentHeaderBase64, type PaymentHeaderObject, type PaymentHeaderPayload, type PaymentLogEntry, type PaymentMiddlewareConfig, type PaymentRequirements, type RouteKey, type RoutePricingConfig, type RoutesConfig, type TelemetryConfig, type TelemetryEvent, createPaymentClient, createPaymentMiddleware };
+/**
+ * Configuration for createMantleClient().
+ * All fields are optional - the client auto-detects sensible defaults.
+ */
+interface MantleClientConfig {
+    /** Optional facilitator URL (auto-detects from NEXT_PUBLIC_FACILITATOR_URL or defaults to localhost:8080). */
+    facilitatorUrl?: string;
+    /** Optional resource URL (defaults to current origin in browser, or empty string for relative paths). */
+    resourceUrl?: string;
+    /** Function to get user's wallet address (required for payments). */
+    getAccount?: () => Promise<string | undefined> | string | undefined;
+    /** Function to get wallet provider/client (e.g., viem WalletClient or window.ethereum). */
+    getProvider?: () => any;
+    /** Optional project key for hosted facilitator billing. */
+    projectKey?: string;
+}
+/**
+ * Simplified Mantle payment client interface.
+ * Provides a clean API for making paid POST requests.
+ */
+interface MantleClient {
+    /**
+     * Make a paid POST request to a protected endpoint.
+     * Automatically handles x402 flow (402 response, signing, payment, retry).
+     *
+     * @param url - API endpoint path (e.g., "/api/generate-image").
+     * @param body - Request body (will be JSON stringified).
+     * @returns Response data from the protected endpoint.
+     * @throws Error if wallet is not connected or payment fails.
+     */
+    post<TResp = any>(url: string, body?: any): Promise<TResp>;
+}
+/**
+ * Create a simplified Mantle payment client with auto-detected defaults.
+ *
+ * Usage:
+ * ```typescript
+ * const client = createMantleClient({
+ *   getAccount: () => account?.address,
+ *   getProvider: () => walletClient,
+ * });
+ *
+ * const data = await client.post("/api/generate", { prompt: "..." });
+ * ```
+ *
+ * @param config - Optional configuration (auto-detects facilitatorUrl and resourceUrl).
+ * @returns MantleClient instance with simplified post() method.
+ */
+declare function createMantleClient(config?: MantleClientConfig): MantleClient;
+
+/**
+ * Options for useMantleX402 React hook.
+ */
+interface UseMantleX402Options {
+    /** Optional facilitator URL (auto-detects from NEXT_PUBLIC_FACILITATOR_URL). */
+    facilitatorUrl?: string;
+    /** Optional resource URL (defaults to current origin). */
+    resourceUrl?: string;
+    /** Optional project key for hosted facilitator billing. */
+    projectKey?: string;
+}
+/**
+ * React hook for simplified Mantle x402 payments with wagmi integration.
+ *
+ * Automatically connects to the user's wallet via wagmi hooks and provides
+ * a clean API for making paid requests.
+ *
+ * Usage:
+ * ```typescript
+ * const { post } = useMantleX402();
+ *
+ * const data = await post("/api/generate-image", {
+ *   prompt: "A beautiful sunset"
+ * });
+ * ```
+ *
+ * @param opts - Optional configuration (facilitatorUrl, resourceUrl, projectKey).
+ * @returns MantleClient instance with post() method.
+ */
+declare function useMantleX402(opts?: UseMantleX402Options): MantleClient;
+
+export { type AssetConfig, type Authorization, type CallWithPaymentResult, MANTLE_DEFAULTS, type MantleClient, type MantleClientConfig, type MinimalPaywallOptions, type NetworkId, type PaymentClient, type PaymentClientConfig, type PaymentHeaderBase64, type PaymentHeaderObject, type PaymentHeaderPayload, type PaymentLogEntry, type PaymentMiddlewareConfig, type PaymentRequirements, type RouteKey, type RoutePricingConfig, type RoutesConfig, type TelemetryConfig, type TelemetryEvent, type UseMantleX402Options, createMantleClient, createPaymentClient, createPaymentMiddleware, mantlePaywall, useMantleX402 };

package/dist/index.js

@@ -13,6 +13,15 @@ var MANTLE_MAINNET_USDC = {
   address: "0x09Bc4E0D864854c6aFB6eB9A9cdF58aC190D0dF9",
   decimals: 6
 };
+var MANTLE_DEFAULTS = {
+  NETWORK: "mantle-mainnet",
+  CHAIN_ID: 5e3,
+  USDC_ADDRESS: "0x09Bc4E0D864854c6aFB6eB9A9cdF58aC190D0dF9",
+  USDC_DECIMALS: 6,
+  CURRENCY: "USD",
+  SCHEME: "exact",
+  FACILITATOR_URL: (typeof process !== "undefined" ? process.env?.NEXT_PUBLIC_FACILITATOR_URL : void 0) || "http://localhost:8080"
+};
 function getDefaultAssetForNetwork(network) {
   switch (network) {
     case MANTLE_MAINNET_NETWORK_ID:
@@ -239,6 +248,30 @@ function createPaymentMiddleware(config) {
   };
 }
 
+// src/server/mantlePaywall.ts
+function mantlePaywall(opts) {
+  const { priceUsd, payTo, facilitatorUrl, telemetry, onPaymentSettled } = opts;
+  const priceUsdCents = Math.round(priceUsd * 100);
+  return (req, res, next) => {
+    const method = (req.method || "GET").toUpperCase();
+    const path = req.path || "/";
+    const routeKey = `${method} ${path}`;
+    const middleware = createPaymentMiddleware({
+      facilitatorUrl: facilitatorUrl || MANTLE_DEFAULTS.FACILITATOR_URL,
+      receiverAddress: payTo,
+      routes: {
+        [routeKey]: {
+          priceUsdCents,
+          network: MANTLE_DEFAULTS.NETWORK
+        }
+      },
+      telemetry,
+      onPaymentSettled
+    });
+    return middleware(req, res, next);
+  };
+}
+
 // src/shared/utils.ts
 function encodeJsonToBase64(value) {
   const json = JSON.stringify(value);
@@ -482,7 +515,61 @@ function createPaymentClient(config) {
     }
   };
 }
+
+// src/client/createMantleClient.ts
+function createMantleClient(config) {
+  const resourceUrl = config?.resourceUrl ?? (typeof window !== "undefined" ? window.location.origin : "");
+  const facilitatorUrl = config?.facilitatorUrl ?? (typeof process !== "undefined" ? process.env?.NEXT_PUBLIC_FACILITATOR_URL : void 0) ?? "http://localhost:8080";
+  return {
+    async post(url, body) {
+      const account = await config?.getAccount?.();
+      if (!account) {
+        throw new Error(
+          "Wallet not connected. Please connect your wallet first."
+        );
+      }
+      const provider = config?.getProvider?.();
+      if (!provider) {
+        throw new Error("Wallet provider not available");
+      }
+      const client = createPaymentClient({
+        resourceUrl,
+        facilitatorUrl,
+        provider,
+        userAddress: account,
+        projectKey: config?.projectKey
+      });
+      const result = await client.callWithPayment(url, {
+        method: "POST",
+        body
+      });
+      return result.response;
+    }
+  };
+}
+
+// src/client/react/useMantleX402.ts
+import { useAccount, useWalletClient } from "wagmi";
+function useMantleX402(opts) {
+  const { address, isConnected } = useAccount();
+  const { data: walletClient } = useWalletClient();
+  const client = createMantleClient({
+    facilitatorUrl: opts?.facilitatorUrl,
+    resourceUrl: opts?.resourceUrl,
+    projectKey: opts?.projectKey,
+    getAccount: () => {
+      if (!isConnected || !address) return void 0;
+      return address;
+    },
+    getProvider: () => walletClient
+  });
+  return client;
+}
 export {
+  MANTLE_DEFAULTS,
+  createMantleClient,
   createPaymentClient,
-  createPaymentMiddleware
+  createPaymentMiddleware,
+  mantlePaywall,
+  useMantleX402
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@puga-labs/x402-mantle-sdk",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "x402 payments SDK for Mantle (USDC, gasless, facilitator-based)",
   "license": "MIT",
   "author": "Evgenii Pugachev <cyprus.pugamuga@gmail.com>",
@@ -46,7 +46,13 @@
     "test:watch": "vitest watch"
   },
   "peerDependencies": {
-    "ethers": "^6.0.0"
+    "ethers": "^6.0.0",
+    "wagmi": "^2.0.0"
+  },
+  "peerDependenciesMeta": {
+    "wagmi": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@eslint/js": "^9.17.0",
@@ -56,6 +62,7 @@
     "@typescript-eslint/parser": "^8.20.0",
     "@vitest/coverage-v8": "^4.0.15",
     "@vitest/ui": "^4.0.15",
+    "@wagmi/core": "^2.22.1",
     "eslint": "^9.17.0",
     "express": "^5.2.1",
     "globals": "^15.14.0",
@@ -63,6 +70,8 @@
     "rimraf": "^6.0.0",
     "tsup": "^8.0.0",
     "typescript": "^5.6.0",
-    "vitest": "^4.0.15"
+    "viem": "^2.41.2",
+    "vitest": "^4.0.15",
+    "wagmi": "^2.19.5"
   }
 }