@puga-labs/x402-mantle-sdk 0.3.10 → 0.4.0

package/README.md

@@ -0,0 +1,488 @@
+# @puga-labs/x402-mantle-sdk
+
+[![npm version](https://img.shields.io/npm/v/@puga-labs/x402-mantle-sdk.svg)](https://www.npmjs.com/package/@puga-labs/x402-mantle-sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+SDK for x402 payments on Mantle blockchain. Protect your APIs with USDC payments using a simple middleware.
+
+## Installation
+
+```bash
+npm install @puga-labs/x402-mantle-sdk
+```
+
+## Features
+
+- React hooks (`useMantleX402`, `useEthersWallet`)
+- Vanilla JS client (`createMantleClient`)
+- Server middleware for Express, Next.js, Hono, Cloudflare Workers, Deno
+- Full TypeScript support
+- Automatic payment flow handling
+- Analytics & telemetry integration
+
+---
+
+## Client-Side Usage
+
+### React (Recommended)
+
+```tsx
+import { useMantleX402 } from '@puga-labs/x402-mantle-sdk/react';
+
+function PaymentButton() {
+  const { postWithPayment } = useMantleX402({
+    facilitatorUrl: 'https://facilitator.x402mantlesdk.xyz'
+  });
+
+  const handlePay = async () => {
+    try {
+      const { response, txHash } = await postWithPayment('/api/generate', {
+        prompt: 'Hello world'
+      });
+
+      console.log('Result:', response);
+      console.log('Transaction:', txHash);
+    } catch (error) {
+      console.error('Payment failed:', error);
+    }
+  };
+
+  return <button onClick={handlePay}>Generate ($0.01)</button>;
+}
+```
+
+### Wallet Hook
+
+Separate hook for wallet management:
+
+```tsx
+import { useEthersWallet } from '@puga-labs/x402-mantle-sdk/react';
+
+function WalletConnect() {
+  const {
+    address,
+    isConnected,
+    chainId,
+    connect,
+    disconnect,
+    error
+  } = useEthersWallet({ autoConnect: false });
+
+  if (isConnected) {
+    return (
+      <div>
+        <p>Connected: {address}</p>
+        <p>Chain ID: {chainId}</p>
+        <button onClick={disconnect}>Disconnect</button>
+      </div>
+    );
+  }
+
+  return <button onClick={connect}>Connect Wallet</button>;
+}
+```
+
+### Vanilla JavaScript
+
+```typescript
+import { createMantleClient } from '@puga-labs/x402-mantle-sdk/client';
+
+// Create client
+const client = createMantleClient({
+  facilitatorUrl: 'https://facilitator.x402mantlesdk.xyz',
+  resourceUrl: 'https://your-api.com',
+  getProvider: () => window.ethereum,
+  getAccount: () => userAddress
+});
+
+// Make paid request
+const { response, txHash } = await client.postWithPayment('/api/generate', {
+  prompt: 'Hello world'
+});
+```
+
+### Low-Level Payment Client
+
+For full control over the payment flow:
+
+```typescript
+import { createPaymentClient } from '@puga-labs/x402-mantle-sdk/client';
+
+const paymentClient = createPaymentClient({
+  resourceUrl: 'https://your-api.com',
+  facilitatorUrl: 'https://facilitator.x402mantlesdk.xyz',
+  provider: window.ethereum,
+  userAddress: '0x...' // Optional
+});
+
+const result = await paymentClient.callWithPayment('/api/endpoint', {
+  data: 'payload'
+});
+```
+
+---
+
+## Server-Side Usage
+
+### Express.js
+
+```typescript
+import express from 'express';
+import { mantlePaywall } from '@puga-labs/x402-mantle-sdk/server/express';
+
+const app = express();
+app.use(express.json());
+
+// Create paywall middleware
+const pay = mantlePaywall({
+  priceUsd: 0.01,
+  payTo: '0xYourWalletAddress',
+  facilitatorUrl: 'https://facilitator.x402mantlesdk.xyz'
+});
+
+// Protected route
+app.post('/api/generate', pay, async (req, res) => {
+  const { prompt } = req.body;
+  // Your logic here - only runs after payment
+  res.json({ result: 'Generated content' });
+});
+
+// Unprotected route
+app.get('/api/health', (req, res) => {
+  res.json({ status: 'ok' });
+});
+
+app.listen(3000);
+```
+
+### Next.js (App Router)
+
+```typescript
+// app/api/generate/route.ts
+import { mantlePaywall } from '@puga-labs/x402-mantle-sdk/server/nextjs';
+import { NextRequest, NextResponse } from 'next/server';
+
+const pay = mantlePaywall({
+  priceUsd: 0.01,
+  payTo: '0xYourWalletAddress',
+  facilitatorUrl: 'https://facilitator.x402mantlesdk.xyz'
+});
+
+export const POST = pay(async (req: NextRequest) => {
+  const { prompt } = await req.json();
+  // Your logic here
+  return NextResponse.json({ result: 'Generated content' });
+});
+```
+
+### Hono
+
+```typescript
+import { Hono } from 'hono';
+import { mantlePaywall } from '@puga-labs/x402-mantle-sdk/server/web';
+
+const app = new Hono();
+
+const pay = mantlePaywall({
+  priceUsd: 0.01,
+  payTo: '0xYourWalletAddress',
+  facilitatorUrl: 'https://facilitator.x402mantlesdk.xyz'
+});
+
+app.post('/api/generate', pay(async (c) => {
+  const { prompt } = await c.req.json();
+  return c.json({ result: 'Generated content' });
+}));
+
+export default app;
+```
+
+### Cloudflare Workers
+
+```typescript
+import { mantlePaywall } from '@puga-labs/x402-mantle-sdk/server/web';
+
+const pay = mantlePaywall({
+  priceUsd: 0.01,
+  payTo: '0xYourWalletAddress',
+  facilitatorUrl: 'https://facilitator.x402mantlesdk.xyz'
+});
+
+export default {
+  async fetch(request: Request): Promise<Response> {
+    if (request.method === 'POST') {
+      return pay(async (req) => {
+        const body = await req.json();
+        return new Response(JSON.stringify({ result: 'success' }), {
+          headers: { 'Content-Type': 'application/json' }
+        });
+      })(request);
+    }
+    return new Response('Method not allowed', { status: 405 });
+  }
+};
+```
+
+### Deno
+
+```typescript
+import { mantlePaywall } from '@puga-labs/x402-mantle-sdk/server/web';
+
+const pay = mantlePaywall({
+  priceUsd: 0.01,
+  payTo: '0xYourWalletAddress',
+  facilitatorUrl: 'https://facilitator.x402mantlesdk.xyz'
+});
+
+Deno.serve(pay(async (req) => {
+  const body = await req.json();
+  return new Response(JSON.stringify({ result: 'success' }), {
+    headers: { 'Content-Type': 'application/json' }
+  });
+}));
+```
+
+---
+
+## Configuration
+
+### Client Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `facilitatorUrl` | `string` | From 402 response | Facilitator service URL (auto-detected from backend) |
+| `resourceUrl` | `string` | `window.location.origin` | Your API base URL |
+| `projectKey` | `string` | From 402 response | Project key (auto-detected from backend) |
+| `getProvider` | `() => EIP1193Provider` | - | Function returning wallet provider |
+| `getAccount` | `() => string` | - | Function returning user address |
+
+**Note:** Both `facilitatorUrl` and `projectKey` are automatically passed from your backend via 402 responses, so clients typically don't need to configure them.
+
+### Server Options (mantlePaywall)
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `priceUsd` | `number` | Yes | Price in USD (e.g., `0.01` for 1 cent) |
+| `payTo` | `string` | Yes | Your wallet address to receive payments |
+| `facilitatorUrl` | `string` | No | Facilitator URL (default: localhost:8080) |
+| `projectKey` | `string` | No | Project key from dashboard (for hosted facilitator + analytics) |
+| `facilitatorSecret` | `string` | For self-hosted | Shared secret with your facilitator (required for self-hosted) |
+| `network` | `string` | No | Network ID (default: `mantle-mainnet`) |
+| `onPaymentSettled` | `function` | No | Callback when payment is verified |
+| `telemetry` | `object` | No | Analytics configuration (auto-uses projectKey if not set) |
+
+---
+
+## Hosted vs Self-Hosted Facilitator
+
+### Hosted Facilitator (Recommended)
+
+Use our managed facilitator service:
+
+```typescript
+const pay = mantlePaywall({
+  priceUsd: 0.01,
+  payTo: '0xYourWallet',
+  facilitatorUrl: 'https://facilitator.x402mantlesdk.xyz',
+  projectKey: 'pk_xxx' // Get from dashboard (used for billing + analytics)
+});
+```
+
+Get your project key from [Dashboard](https://x402mantlesdk.xyz/dashboard).
+
+**Note:** `projectKey` is automatically passed to clients via 402 responses, so they don't need to configure it separately.
+
+### Self-Hosted Facilitator
+
+Run your own facilitator for full control and cost savings:
+
+```typescript
+const pay = mantlePaywall({
+  priceUsd: 0.01,
+  payTo: '0xYourWallet',
+  facilitatorUrl: 'https://your-facilitator.com',
+  // REQUIRED: Must match FACILITATOR_SECRET in your facilitator's .env
+  facilitatorSecret: process.env.FACILITATOR_SECRET
+});
+```
+
+The `facilitatorSecret` is **required** for self-hosted facilitators to prevent unauthorized usage of your facilitator by third parties.
+
+Create a facilitator with:
+```bash
+npx create-mantle-facilitator my-facilitator
+```
+
+After setup, copy `FACILITATOR_SECRET` from the generated `.env` file to your backend's environment variables.
+
+---
+
+## Analytics & Telemetry
+
+Track payments with built-in analytics:
+
+```typescript
+const pay = mantlePaywall({
+  priceUsd: 0.01,
+  payTo: '0x...',
+  facilitatorUrl: 'https://facilitator.x402mantlesdk.xyz',
+  projectKey: 'pk_xxx',  // Get from dashboard - used for both billing AND analytics
+
+  // Optional: Advanced telemetry config
+  telemetry: {
+    debug: true  // Enable console logging (projectKey auto-derived from above)
+  },
+
+  // Callback on each successful payment
+  onPaymentSettled: (entry) => {
+    console.log('Payment received!');
+    console.log('Amount:', entry.valueAtomic);
+    console.log('From:', entry.from);
+    console.log('To:', entry.to);
+    console.log('TxHash:', entry.txHash);
+    console.log('Route:', entry.route);
+  }
+});
+```
+
+### PaymentLogEntry Fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `id` | `string` | Unique payment identifier (nonce) |
+| `from` | `string` | Payer's wallet address |
+| `to` | `string` | Recipient's wallet address |
+| `valueAtomic` | `string` | Amount in atomic units |
+| `network` | `string` | Network ID |
+| `asset` | `string` | Token contract address |
+| `route` | `string` | API route (e.g., `POST /api/generate`) |
+| `txHash` | `string` | Blockchain transaction hash |
+| `timestamp` | `number` | Unix timestamp (ms) |
+
+---
+
+## TypeScript Types
+
+```typescript
+import type {
+  // Shared types
+  PaymentRequirements,
+  Authorization,
+  PaymentHeaderObject,
+  NetworkId,
+
+  // Client types
+  MantleClient,
+  MantleClientConfig,
+  PaymentClient,
+  PaymentClientConfig,
+  CallWithPaymentResult,
+
+  // Server types
+  PaymentLogEntry,
+  TelemetryConfig,
+  MinimalPaywallOptions,
+
+  // React types
+  UseMantleX402Options,
+  UseEthersWalletOptions,
+  UseEthersWalletReturn
+} from '@puga-labs/x402-mantle-sdk';
+```
+
+---
+
+## Import Paths
+
+```typescript
+// Main exports (types + constants)
+import { MANTLE_DEFAULTS } from '@puga-labs/x402-mantle-sdk';
+
+// Client
+import { createMantleClient, createPaymentClient } from '@puga-labs/x402-mantle-sdk/client';
+
+// React hooks
+import { useMantleX402, useEthersWallet } from '@puga-labs/x402-mantle-sdk/react';
+
+// Server - Express
+import { mantlePaywall } from '@puga-labs/x402-mantle-sdk/server/express';
+
+// Server - Next.js
+import { mantlePaywall } from '@puga-labs/x402-mantle-sdk/server/nextjs';
+
+// Server - Web Standards (Hono, CF Workers, Deno)
+import { mantlePaywall } from '@puga-labs/x402-mantle-sdk/server/web';
+```
+
+---
+
+## Network Configuration
+
+| Network | Chain ID | USDC Address | Decimals |
+|---------|----------|--------------|----------|
+| Mantle Mainnet | 5000 | `0x09Bc4E0D864854c6aFB6eB9A9cdF58aC190D0dF9` | 6 |
+
+### Price Conversion
+
+- `priceUsd: 0.01` = 1 cent = 10,000 atomic units
+- Formula: `atomicUnits = priceUsd * 10^6`
+
+---
+
+## Error Handling
+
+### Client-Side Errors
+
+```typescript
+try {
+  const { response, txHash } = await postWithPayment('/api/generate', data);
+} catch (error) {
+  if (error.code === 4001) {
+    // User rejected the transaction
+    console.log('User cancelled');
+  } else if (error.code === -32603) {
+    // Internal error (insufficient funds, etc.)
+    console.log('Transaction failed:', error.message);
+  } else {
+    // Network or facilitator error
+    console.log('Error:', error.message);
+  }
+}
+```
+
+### Server-Side Error Responses
+
+```typescript
+// 402 Payment Required
+{
+  "error": "Payment Required",
+  "paymentRequirements": {
+    "scheme": "exact",
+    "network": "mantle-mainnet",
+    "asset": "0x09Bc4E0D...",
+    "maxAmountRequired": "10000",
+    "payTo": "0x...",
+    "price": "$0.01",
+    "currency": "USD"
+  }
+}
+
+// 400 Invalid Payment
+{
+  "error": "Invalid payment",
+  "invalidReason": "Payment amount too low"
+}
+```
+
+---
+
+## Links
+
+- [Full Documentation](https://x402mantlesdk.xyz/docs)
+- [Dashboard](https://x402mantlesdk.xyz/dashboard)
+- [GitHub](https://github.com/puga-labs/x402-mantle-sdk)
+- [Facilitator Kit](../create-mantle-facilitator)
+
+## License
+
+MIT

package/dist/chunk-2IGT3ZXX.js

@@ -0,0 +1,179 @@
+import {
+  createMantleClient
+} from "./chunk-RVPI6FMV.js";
+
+// src/client/react/useEthersWallet.ts
+import { useState, useEffect, useCallback } from "react";
+import { ethers } from "ethers";
+function useEthersWallet(options) {
+  const [address, setAddress] = useState(void 0);
+  const [isConnected, setIsConnected] = useState(false);
+  const [provider, setProvider] = useState(
+    void 0
+  );
+  const [chainId, setChainId] = useState(void 0);
+  const [error, setError] = useState(void 0);
+  const setProviderAndChain = useCallback(async () => {
+    if (typeof window === "undefined" || !window.ethereum) return;
+    const browserProvider = new ethers.BrowserProvider(
+      window.ethereum
+    );
+    setProvider(browserProvider);
+    const network = await browserProvider.getNetwork();
+    setChainId(Number(network.chainId));
+  }, []);
+  const hydrateFromPermissions = useCallback(async () => {
+    if (typeof window === "undefined" || !window.ethereum) return;
+    try {
+      const accounts = await window.ethereum.request({
+        method: "eth_accounts"
+      });
+      if (accounts && accounts.length > 0) {
+        const userAddress = accounts[0];
+        setAddress(userAddress);
+        setIsConnected(true);
+        await setProviderAndChain();
+      }
+    } catch (err) {
+      console.warn("[useEthersWallet] Failed to hydrate from permissions:", err);
+    }
+  }, [setProviderAndChain]);
+  const connect = useCallback(async () => {
+    try {
+      setError(void 0);
+      if (typeof window === "undefined" || !window.ethereum) {
+        throw new Error(
+          "No Ethereum wallet detected. Please install MetaMask or another wallet."
+        );
+      }
+      const browserProvider = new ethers.BrowserProvider(
+        window.ethereum
+      );
+      setProvider(browserProvider);
+      const accounts = await window.ethereum.request({
+        method: "eth_requestAccounts"
+      });
+      if (!accounts || accounts.length === 0) {
+        throw new Error("No accounts returned from wallet");
+      }
+      const userAddress = accounts[0];
+      setAddress(userAddress);
+      setIsConnected(true);
+      const network = await browserProvider.getNetwork();
+      setChainId(Number(network.chainId));
+    } catch (err) {
+      const errorObj = err instanceof Error ? err : new Error(String(err));
+      setError(errorObj);
+      setIsConnected(false);
+      setAddress(void 0);
+      setChainId(void 0);
+      throw errorObj;
+    }
+  }, []);
+  const disconnect = useCallback(() => {
+    setAddress(void 0);
+    setIsConnected(false);
+    setChainId(void 0);
+    setError(void 0);
+  }, []);
+  useEffect(() => {
+    if (typeof window === "undefined" || !window.ethereum) return;
+    const ethereum = window.ethereum;
+    const handleAccountsChanged = (accounts) => {
+      const accountsArray = accounts;
+      if (!accountsArray || accountsArray.length === 0) {
+        disconnect();
+      } else {
+        setAddress(accountsArray[0]);
+        setIsConnected(true);
+        void setProviderAndChain();
+      }
+    };
+    if (ethereum.on) {
+      ethereum.on("accountsChanged", handleAccountsChanged);
+    }
+    return () => {
+      if (ethereum.removeListener) {
+        ethereum.removeListener("accountsChanged", handleAccountsChanged);
+      }
+    };
+  }, [disconnect, setProviderAndChain]);
+  useEffect(() => {
+    if (typeof window === "undefined" || !window.ethereum) return;
+    const ethereum = window.ethereum;
+    const handleConnect = () => {
+      void hydrateFromPermissions();
+    };
+    if (ethereum.on) {
+      ethereum.on("connect", handleConnect);
+    }
+    return () => {
+      if (ethereum.removeListener) {
+        ethereum.removeListener("connect", handleConnect);
+      }
+    };
+  }, [hydrateFromPermissions]);
+  useEffect(() => {
+    if (typeof window === "undefined" || !window.ethereum) return;
+    const ethereum = window.ethereum;
+    const handleChainChanged = (chainIdHex) => {
+      const newChainId = parseInt(chainIdHex, 16);
+      setChainId(newChainId);
+    };
+    if (ethereum.on) {
+      ethereum.on("chainChanged", handleChainChanged);
+    }
+    return () => {
+      if (ethereum.removeListener) {
+        ethereum.removeListener("chainChanged", handleChainChanged);
+      }
+    };
+  }, []);
+  useEffect(() => {
+    void hydrateFromPermissions();
+  }, [hydrateFromPermissions]);
+  useEffect(() => {
+    if (options?.autoConnect) {
+      connect().catch((err) => {
+        console.warn("[useEthersWallet] Auto-connect failed:", err);
+      });
+    }
+  }, [options?.autoConnect, connect]);
+  return {
+    address,
+    isConnected,
+    provider,
+    chainId,
+    connect,
+    disconnect,
+    error
+  };
+}
+
+// src/client/react/useMantleX402.ts
+function useMantleX402(opts) {
+  const { address, isConnected } = useEthersWallet({
+    autoConnect: opts?.autoConnect ?? false
+  });
+  const client = createMantleClient({
+    facilitatorUrl: opts?.facilitatorUrl,
+    resourceUrl: opts?.resourceUrl,
+    projectKey: opts?.projectKey,
+    getAccount: () => {
+      if (!isConnected || !address) return void 0;
+      return address;
+    },
+    getProvider: () => {
+      if (typeof window !== "undefined" && window.ethereum) {
+        return window.ethereum;
+      }
+      return void 0;
+    }
+  });
+  return client;
+}
+
+export {
+  useEthersWallet,
+  useMantleX402
+};