@relai-fi/x402 0.5.39 → 0.6.0-rc.0

package/dist/server-CyfEHW9D.d.cts

@@ -1,312 +0,0 @@
-import { a as RelaiNetwork } from './types-Y9ni5XwY.cjs';
-
-interface PluginContext {
-    /** Network for this endpoint */
-    network: RelaiNetwork;
-    /** Price in USD */
-    price: number;
-    /** Request path */
-    path: string;
-    /** HTTP method */
-    method: string;
-}
-interface PluginResult {
-    /** If true, skip payment and serve content for free */
-    skip?: boolean;
-    /** Extra response headers to set */
-    headers?: Record<string, string>;
-    /** Metadata attached to req.pluginMeta */
-    meta?: Record<string, unknown>;
-}
-interface RelaiPlugin {
-    /** Unique plugin name */
-    name: string;
-    /**
-     * Called before the 402 payment check.
-     * Return { skip: true } to bypass payment entirely.
-     */
-    beforePaymentCheck?(req: any, ctx: PluginContext): Promise<PluginResult>;
-    /**
-     * Called after a successful payment settlement.
-     * Use for analytics, logging, webhooks, etc.
-     */
-    afterSettled?(req: any, result: SettleResult, ctx: PluginContext): Promise<void>;
-    /**
-     * Called once when the Relai instance initializes (server start).
-     * Use to sync config to RelAI backend or validate credentials.
-     */
-    onInit?(): Promise<void>;
-    /**
-     * Called before sending the 402 response. Allows plugins to add
-     * extensions or modify the response body (e.g. bridge info).
-     */
-    enrich402Response?(response: any, ctx: PluginContext): any;
-}
-interface FreeTierPluginConfig {
-    /** Service key (sk_live_...) for syncing with RelAI backend. If omitted, runs in local in-memory mode. */
-    serviceKey?: string;
-    /** Max free calls per buyer per period */
-    perBuyerLimit: number;
-    /** Reset period for per-buyer counters */
-    resetPeriod?: 'none' | 'daily' | 'monthly';
-    /** Optional global cap across all buyers */
-    globalCap?: number;
-    /** Specific paths to apply free tier to (default: '*' = all) */
-    paths?: string[];
-    /** Override RelAI API base URL (default: https://api.relai.fi) */
-    baseUrl?: string;
-    /** Cache TTL in ms for check results (default: 5000) */
-    cacheTtlMs?: number;
-}
-/**
- * Free Tier plugin - gives buyers a number of free API calls
- * before requiring payment.
- *
- * State is stored in the RelAI backend, keyed by your service key.
- * Config can be set here (SDK-side) or overridden in the relai.fi dashboard.
- *
- * @example
- * ```typescript
- * import Relai from '@relai-fi/x402/server';
- * import { freeTier } from '@relai-fi/x402/plugins';
- *
- * const relai = new Relai({
- *   network: 'base',
- *   plugins: [
- *     freeTier({
- *       serviceKey: process.env.RELAI_SERVICE_KEY!,
- *       perBuyerLimit: 10,
- *       resetPeriod: 'daily',
- *     }),
- *   ],
- * });
- *
- * app.get('/api/data', relai.protect({
- *   payTo: '0xYourWallet',
- *   price: 0.01,
- * }), (req, res) => {
- *   res.json({ data: 'paid content' });
- * });
- * ```
- */
-interface BridgePluginConfig {
-    /** Service key (sk_live_...) for tracking bridge usage per API owner */
-    serviceKey?: string;
-    /** RelAI API base URL (default: https://api.relai.fi) */
-    baseUrl?: string;
-    /** Override settle endpoint (auto-discovered from /bridge/info if not set) */
-    settleEndpoint?: string;
-    /** Override supported source chains (auto-discovered if not set) */
-    supportedSourceChains?: string[];
-    /** Override supported source assets (auto-discovered if not set) */
-    supportedSourceAssets?: string[];
-    /** Override bridge payTo map: { [caip2]: address } */
-    payTo?: Record<string, string>;
-    /** Override Solana fee payer address (auto-discovered if not set) */
-    feePayerSvm?: string;
-    /** Override payment facilitator URL */
-    paymentFacilitator?: string;
-    /** Bridge fee in basis points (default: auto-discovered) */
-    feeBps?: number;
-}
-/**
- * Bridge plugin - enables cross-chain payments via the RelAI bridge.
- *
- * When a buyer's wallet is on a different chain than the merchant accepts,
- * the client SDK can automatically route the payment through the bridge.
- * This plugin adds `extensions.bridge` to the 402 response with all the
- * info the client needs to execute a cross-chain payment.
- *
- * @example
- * ```typescript
- * import Relai from '@relai-fi/x402/server';
- * import { bridge } from '@relai-fi/x402/plugins';
- *
- * const relai = new Relai({
- *   network: 'skale-base',
- *   plugins: [
- *     bridge(), // auto-discovers from https://api.relai.fi
- *   ],
- * });
- *
- * // Buyer on Solana can now pay for a SKALE endpoint
- * app.get('/api/data', relai.protect({
- *   payTo: '0xYourWallet',
- *   price: 0.05,
- * }), (req, res) => {
- *   res.json({ data: 'paid content' });
- * });
- * ```
- */
-declare function bridge(config?: BridgePluginConfig): RelaiPlugin;
-/**
- * Extended plugin interface with data export for free tier.
- */
-interface FreeTierPlugin extends RelaiPlugin {
-    /** Export all in-memory usage data (local mode only). Returns null when using cloud mode. */
-    getUsageData(): FreeTierUsageExport | null;
-    /** Whether plugin is running in local (in-memory) or cloud (RelAI backend) mode. */
-    readonly mode: 'local' | 'cloud';
-}
-interface FreeTierUsageExport {
-    mode: 'local';
-    config: {
-        perBuyerLimit: number;
-        resetPeriod: string;
-        globalCap: number | null;
-        paths: string[];
-    };
-    /** Per-buyer usage entries */
-    usage: Array<{
-        buyerId: string;
-        path: string;
-        count: number;
-        periodStart: string;
-        lastCall: string;
-    }>;
-    globalCount: number;
-    exportedAt: string;
-}
-declare function freeTier(config: FreeTierPluginConfig): FreeTierPlugin;
-
-interface RelaiServerConfig {
-    /** Network to accept payments on */
-    network: RelaiNetwork;
-    /** RelAI facilitator URL (default: https://facilitator.x402.fi) */
-    facilitatorUrl?: string;
-    /** Plugins to extend protect() behavior (e.g. freeTier, rateLimit) */
-    plugins?: RelaiPlugin[];
-}
-type DynamicPrice = number | ((req: any) => number | Promise<number>);
-type RelaiIntegritasFlow = 'single' | 'dual';
-interface RelaiIntegritasOptions {
-    /** Enable Integritas by default for this endpoint */
-    enabled?: boolean;
-    /** Default flow when Integritas is enabled */
-    flow?: RelaiIntegritasFlow;
-}
-interface ProtectOptions {
-    /** Price in USD (e.g., 0.01 for 1 cent) */
-    price: DynamicPrice;
-    /** Optional token asset address for networks supporting multiple tokens */
-    asset?: string;
-    /** Wallet address to receive payments, or stripePayTo() for Stripe settlement */
-    payTo: string | StripePayTo;
-    /** Description shown to payer */
-    description?: string;
-    /** MIME type of the response (default: application/json) */
-    mimeType?: string;
-    /** Maximum timeout in seconds (default: 60) */
-    maxTimeoutSeconds?: number;
-    /** Integritas options (or simple boolean enable flag) */
-    integritas?: boolean | RelaiIntegritasOptions;
-    /** Override network for this endpoint */
-    network?: RelaiNetwork;
-    /** Override feePayer address (Solana only) — bypasses facilitator /supported fetch */
-    feePayer?: string;
-    /** Custom validation after payment is settled */
-    customRules?: (req: any) => boolean | Promise<boolean>;
-    /** Callback when 402 is returned (no payment provided) */
-    onPaymentRequired?: (req: any, info: {
-        price: number;
-        network: RelaiNetwork;
-    }) => void;
-    /** Callback when payment is settled successfully */
-    onPaymentSettled?: (req: any, result: SettleResult) => void;
-    /** Callback on error */
-    onError?: (req: any, error: unknown) => void;
-}
-interface SettleResult {
-    success: boolean;
-    transaction?: string;
-    payer?: string;
-    network?: string;
-    splitTransfers?: Record<string, unknown>;
-    integritasFeePaid?: boolean;
-    provenance?: Record<string, unknown>;
-    integritas?: Record<string, unknown>;
-    error?: string;
-    errorReason?: string;
-}
-interface PaymentInfo {
-    verified: boolean;
-    transactionId?: string;
-    payer?: string;
-    network: RelaiNetwork;
-    amount: number;
-}
-/** Config returned by stripePayTo() - used by protect() to create Stripe deposit addresses */
-interface StripePayTo {
-    readonly __brand: 'stripePayTo';
-    readonly secretKey: string;
-    /** Stripe crypto deposits network (default: 'base') */
-    readonly stripeNetwork: string;
-}
-/**
- * Create a Stripe pay-to configuration for x402 payments.
- * Payments settle as USD in your Stripe Dashboard - no crypto knowledge required.
- *
- * Stripe creates a fresh PaymentIntent + deposit address per request.
- * Network is auto-set to Base (Stripe settles USDC on Base).
- *
- * @example
- * ```typescript
- * import Relai, { stripePayTo } from '@relai-fi/x402/server';
- *
- * const relai = new Relai({ network: 'base' });
- *
- * app.get('/api/data', relai.protect({
- *   price: 0.01,
- *   payTo: stripePayTo(process.env.STRIPE_SECRET_KEY!),
- * }), (req, res) => {
- *   res.json({ data: 'paid content' });
- * });
- * ```
- */
-declare function stripePayTo(stripeSecretKey: string, options?: {
-    network?: string;
-}): StripePayTo;
-/**
- * Server-side SDK for protecting Express endpoints with x402 micropayments.
- * Settles payments through the RelAI facilitator (zero gas fees for users).
- *
- * Supports: Solana, Base, Avalanche, SKALE Base, SKALE Base Sepolia, SKALE BITE, Polygon, and Ethereum.
- *
- * @example
- * ```typescript
- * import Relai from '@relai-fi/x402/server';
- *
- * const relai = new Relai({ network: 'base' });
- *
- * app.get('/api/data', relai.protect({
- *   payTo: '0xYourWallet',
- *   price: 0.01,  // $0.01 USDC
- * }), (req, res) => {
- *   res.json({ data: 'Protected content', payment: req.payment });
- * });
- * ```
- */
-declare class Relai {
-    private network;
-    private facilitatorUrl;
-    private feePayerCache;
-    private plugins;
-    private pluginInitPromise;
-    constructor(config: RelaiServerConfig);
-    private runPluginInit;
-    /**
-     * Get feePayer address for a network (cached)
-     */
-    private getFeePayer;
-    /**
-     * Express middleware to protect an endpoint with x402 micropayments.
-     *
-     * Flow:
-     * 1. No payment header → returns 402 with payment requirements
-     * 2. Payment header present → calls RelAI facilitator `/settle`
-     * 3. Settlement success → sets `PAYMENT-RESPONSE` header, attaches `req.payment`, calls `next()`
-     */
-    protect(options: ProtectOptions): (req: any, res: any, next: any) => Promise<any>;
-}
-
-export { type BridgePluginConfig as B, type DynamicPrice as D, type FreeTierPluginConfig as F, type ProtectOptions as P, Relai as R, type SettleResult as S, type RelaiServerConfig as a, type PaymentInfo as b, type StripePayTo as c, type RelaiIntegritasFlow as d, type RelaiIntegritasOptions as e, type RelaiPlugin as f, type PluginContext as g, type PluginResult as h, bridge as i, type FreeTierPlugin as j, type FreeTierUsageExport as k, freeTier as l, stripePayTo as s };