@wtflabs/x402 0.0.1-beta.0 → 0.0.1-beta.1

package/dist/esm/client/index.d.mts

@@ -0,0 +1,64 @@
+import { X as X402Config } from '../config-Dfuvno71.mjs';
+import { P as PaymentRequirements, p as UnsignedEip3009PaymentPayload } from '../x402Specs-CYq5tSY1.mjs';
+import { S as Signer, M as MultiNetworkSigner } from '../wallet-KorGgbAj.mjs';
+import { Address } from 'viem';
+import { N as Network } from '../network-FrFmmiyj.mjs';
+import 'zod';
+import '../wallet-SJKJpUgQ.mjs';
+import 'viem/chains';
+import '../wallet-BTqCm9Zp.mjs';
+import '@solana/kit';
+
+/**
+ * Creates a payment header based on the provided client and payment requirements.
+ *
+ * @param client - The signer wallet instance used to create the payment header
+ * @param x402Version - The version of the X402 protocol to use
+ * @param paymentRequirements - The payment requirements containing scheme and network information
+ * @param config - Optional configuration for X402 operations (e.g., custom RPC URLs)
+ * @returns A promise that resolves to the created payment header string
+ */
+declare function createPaymentHeader(client: Signer | MultiNetworkSigner, x402Version: number, paymentRequirements: PaymentRequirements, config?: X402Config): Promise<string>;
+
+/**
+ * Prepares a payment header with the given sender address and payment requirements.
+ *
+ * @param from - The sender's address from which the payment will be made
+ * @param x402Version - The version of the X402 protocol to use
+ * @param paymentRequirements - The payment requirements containing scheme and network information
+ * @returns An unsigned payment payload that can be used to create a payment header
+ */
+declare function preparePaymentHeader(from: Address, x402Version: number, paymentRequirements: PaymentRequirements): UnsignedEip3009PaymentPayload;
+
+/**
+ * Default selector for payment requirements.
+ * Default behavior is to select the first payment requirement that has a USDC asset.
+ * If no USDC payment requirement is found, the first payment requirement is selected.
+ *
+ * @param paymentRequirements - The payment requirements to select from.
+ * @param network - The network to check against. If not provided, the network will not be checked.
+ * @param scheme - The scheme to check against. If not provided, the scheme will not be checked.
+ * @returns The payment requirement that is the most appropriate for the user.
+ */
+declare function selectPaymentRequirements(paymentRequirements: PaymentRequirements[], network?: Network | Network[], scheme?: "exact"): PaymentRequirements;
+/**
+ * Selector for payment requirements.
+ *
+ * @param paymentRequirements - The payment requirements to select from.
+ * @param network - The network to check against. If not provided, the network will not be checked.
+ * @param scheme - The scheme to check against. If not provided, the scheme will not be checked.
+ * @returns The payment requirement that is the most appropriate for the user.
+ */
+type PaymentRequirementsSelector = (paymentRequirements: PaymentRequirements[], network?: Network | Network[], scheme?: "exact") => PaymentRequirements;
+
+/**
+ * Signs a payment header using the provided client and payment requirements.
+ *
+ * @param client - The signer wallet instance used to sign the payment header
+ * @param paymentRequirements - The payment requirements containing scheme and network information
+ * @param unsignedPaymentHeader - The unsigned payment payload to be signed
+ * @returns A promise that resolves to the encoded signed payment header string
+ */
+declare function signPaymentHeader(client: Signer | MultiNetworkSigner, paymentRequirements: PaymentRequirements, unsignedPaymentHeader: UnsignedEip3009PaymentPayload): Promise<string>;
+
+export { type PaymentRequirementsSelector, createPaymentHeader, preparePaymentHeader, selectPaymentRequirements, signPaymentHeader };

package/dist/esm/config-CFBSAuxW.d.mts

@@ -0,0 +1,10 @@
+import { Address } from 'viem';
+import { Address as Address$1 } from '@solana/kit';
+
+declare const config: Record<string, ChainConfig>;
+type ChainConfig = {
+    usdcAddress: Address | Address$1;
+    usdcName: string;
+};
+
+export { type ChainConfig as C, config as c };

package/dist/esm/config-Dfuvno71.d.mts

@@ -0,0 +1,19 @@
+/**
+ * Configuration options for Solana (SVM) RPC connections.
+ */
+interface SvmConfig {
+    /**
+     * Custom RPC URL for Solana connections.
+     * If not provided, defaults to public Solana RPC endpoints based on network.
+     */
+    rpcUrl?: string;
+}
+/**
+ * Configuration options for X402 client and facilitator operations.
+ */
+interface X402Config {
+    /** Configuration for Solana (SVM) operations */
+    svmConfig?: SvmConfig;
+}
+
+export type { SvmConfig as S, X402Config as X };

package/dist/esm/facilitator/index.d.mts

@@ -0,0 +1,42 @@
+import { X as X402Config } from '../config-Dfuvno71.mjs';
+import { C as ConnectedClient, S as Signer } from '../wallet-KorGgbAj.mjs';
+import { a as PaymentPayload, P as PaymentRequirements, J as VerifyResponse, S as SettleResponse } from '../x402Specs-CYq5tSY1.mjs';
+import { Transport, Chain, Account } from 'viem';
+import '../wallet-SJKJpUgQ.mjs';
+import 'viem/chains';
+import '../wallet-BTqCm9Zp.mjs';
+import '@solana/kit';
+import 'zod';
+
+/**
+ * Verifies a payment payload against the required payment details regardless of the scheme
+ * this function wraps all verify functions for each specific scheme
+ *
+ * @param client - The public client used for blockchain interactions
+ * @param payload - The signed payment payload containing transfer parameters and signature
+ * @param paymentRequirements - The payment requirements that the payload must satisfy
+ * @param config - Optional configuration for X402 operations (e.g., custom RPC URLs)
+ * @returns A ValidPaymentRequest indicating if the payment is valid and any invalidation reason
+ */
+declare function verify<transport extends Transport, chain extends Chain, account extends Account | undefined>(client: ConnectedClient | Signer, payload: PaymentPayload, paymentRequirements: PaymentRequirements, config?: X402Config): Promise<VerifyResponse>;
+/**
+ * Settles a payment payload against the required payment details regardless of the scheme
+ * this function wraps all settle functions for each specific scheme
+ *
+ * @param client - The signer wallet used for blockchain interactions
+ * @param payload - The signed payment payload containing transfer parameters and signature
+ * @param paymentRequirements - The payment requirements that the payload must satisfy
+ * @param config - Optional configuration for X402 operations (e.g., custom RPC URLs)
+ * @returns A SettleResponse indicating if the payment is settled and any settlement reason
+ */
+declare function settle<transport extends Transport, chain extends Chain>(client: Signer, payload: PaymentPayload, paymentRequirements: PaymentRequirements, config?: X402Config): Promise<SettleResponse>;
+type Supported = {
+    x402Version: number;
+    kind: {
+        scheme: string;
+        networkId: string;
+        extra: object;
+    }[];
+};
+
+export { type Supported, settle, verify };

package/dist/esm/index.d.mts

@@ -0,0 +1,16 @@
+export { PaymentRequirementsSelector, createPaymentHeader, preparePaymentHeader, selectPaymentRequirements, signPaymentHeader } from './client/index.mjs';
+export { Supported, settle, verify } from './facilitator/index.mjs';
+import './config-Dfuvno71.mjs';
+import './x402Specs-CYq5tSY1.mjs';
+import 'zod';
+import './wallet-KorGgbAj.mjs';
+import './wallet-SJKJpUgQ.mjs';
+import 'viem';
+import 'viem/chains';
+import './wallet-BTqCm9Zp.mjs';
+import '@solana/kit';
+import './network-FrFmmiyj.mjs';
+
+declare const x402Version = 1;
+
+export { x402Version };

package/dist/esm/middleware-BSjsPDKM.d.mts

@@ -0,0 +1,93 @@
+import { z } from 'zod';
+import { N as Network } from './network-FrFmmiyj.mjs';
+import { E as EvmSigner } from './wallet-SJKJpUgQ.mjs';
+import { a as PaymentPayload, P as PaymentRequirements, J as VerifyResponse, S as SettleResponse, X as SupportedPaymentKindsResponse, M as ListDiscoveryResourcesRequest, O as ListDiscoveryResourcesResponse, z as HTTPRequestStructure } from './x402Specs-CYq5tSY1.mjs';
+
+declare const moneySchema: z.ZodPipeline<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodNumber]>, z.ZodNumber>;
+type Money = z.input<typeof moneySchema>;
+
+type Resource = `${string}://${string}`;
+
+type CreateHeaders = () => Promise<{
+    verify: Record<string, string>;
+    settle: Record<string, string>;
+    supported: Record<string, string>;
+    list?: Record<string, string>;
+}>;
+/**
+ * Creates a facilitator client for interacting with the X402 payment facilitator service
+ *
+ * @param facilitator - The facilitator config to use. If not provided, the default facilitator will be used.
+ * @returns An object containing verify and settle functions for interacting with the facilitator
+ */
+declare function useFacilitator(facilitator?: FacilitatorConfig): {
+    verify: (payload: PaymentPayload, paymentRequirements: PaymentRequirements) => Promise<VerifyResponse>;
+    settle: (payload: PaymentPayload, paymentRequirements: PaymentRequirements) => Promise<SettleResponse>;
+    supported: () => Promise<SupportedPaymentKindsResponse>;
+    list: (config?: ListDiscoveryResourcesRequest) => Promise<ListDiscoveryResourcesResponse>;
+};
+declare const verify: (payload: PaymentPayload, paymentRequirements: PaymentRequirements) => Promise<VerifyResponse>;
+declare const settle: (payload: PaymentPayload, paymentRequirements: PaymentRequirements) => Promise<SettleResponse>;
+declare const supported: () => Promise<SupportedPaymentKindsResponse>;
+declare const list: (config?: ListDiscoveryResourcesRequest) => Promise<ListDiscoveryResourcesResponse>;
+
+type FacilitatorConfig = {
+    url: Resource;
+    createAuthHeaders?: CreateHeaders;
+};
+type PaywallConfig = {
+    cdpClientKey?: string;
+    appName?: string;
+    appLogo?: string;
+    sessionTokenEndpoint?: string;
+};
+type PaymentMiddlewareConfig = {
+    description?: string;
+    mimeType?: string;
+    maxTimeoutSeconds?: number;
+    inputSchema?: Omit<HTTPRequestStructure, "type" | "method">;
+    outputSchema?: object;
+    discoverable?: boolean;
+    customPaywallHtml?: string;
+    resource?: Resource;
+    errorMessages?: {
+        paymentRequired?: string;
+        invalidPayment?: string;
+        noMatchingRequirements?: string;
+        verificationFailed?: string;
+        settlementFailed?: string;
+    };
+};
+interface ERC20TokenAmount {
+    amount: string;
+    asset: {
+        address: `0x${string}`;
+        decimals: number;
+        eip712: {
+            name: string;
+            version: string;
+        };
+    };
+}
+interface SPLTokenAmount {
+    amount: string;
+    asset: {
+        address: string;
+        decimals: number;
+    };
+}
+type Price = Money | ERC20TokenAmount | SPLTokenAmount;
+interface RouteConfig {
+    price: Price;
+    network: Network;
+    config?: PaymentMiddlewareConfig;
+}
+type RoutesConfig = Record<string, Price | RouteConfig>;
+interface RoutePattern {
+    verb: string;
+    pattern: RegExp;
+    config: RouteConfig;
+}
+type Wallet = EvmSigner;
+
+export { type CreateHeaders as C, type ERC20TokenAmount as E, type FacilitatorConfig as F, type Money as M, type Price as P, type RoutesConfig as R, type SPLTokenAmount as S, type Wallet as W, type RoutePattern as a, type Resource as b, type PaywallConfig as c, type PaymentMiddlewareConfig as d, type RouteConfig as e, supported as f, list as l, moneySchema as m, settle as s, useFacilitator as u, verify as v };

package/dist/esm/network-FrFmmiyj.d.mts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+
+declare const NetworkSchema: z.ZodEnum<["base-sepolia", "base", "avalanche-fuji", "avalanche", "iotex", "solana-devnet", "solana", "sei", "sei-testnet", "polygon", "polygon-amoy", "peaq", "bsc", "bsc-testnet"]>;
+type Network = z.infer<typeof NetworkSchema>;
+declare const SupportedEVMNetworks: Network[];
+declare const EvmNetworkToChainId: Map<"base-sepolia" | "avalanche-fuji" | "base" | "avalanche" | "sei" | "sei-testnet" | "polygon" | "polygon-amoy" | "peaq" | "iotex" | "bsc" | "bsc-testnet" | "solana-devnet" | "solana", number>;
+declare const SupportedSVMNetworks: Network[];
+declare const SvmNetworkToChainId: Map<"base-sepolia" | "avalanche-fuji" | "base" | "avalanche" | "sei" | "sei-testnet" | "polygon" | "polygon-amoy" | "peaq" | "iotex" | "bsc" | "bsc-testnet" | "solana-devnet" | "solana", number>;
+declare const ChainIdToNetwork: Record<number, Network>;
+
+export { ChainIdToNetwork as C, EvmNetworkToChainId as E, type Network as N, SupportedEVMNetworks as S, NetworkSchema as a, SupportedSVMNetworks as b, SvmNetworkToChainId as c };

package/dist/esm/paywall/index.d.mts

@@ -0,0 +1,30 @@
+import { P as PaymentRequirements } from '../x402Specs-CYq5tSY1.mjs';
+import 'zod';
+
+interface PaywallOptions {
+    amount: number;
+    paymentRequirements: PaymentRequirements[];
+    currentUrl: string;
+    testnet: boolean;
+    cdpClientKey?: string;
+    appName?: string;
+    appLogo?: string;
+    sessionTokenEndpoint?: string;
+}
+/**
+ * Generates an HTML paywall page that allows users to pay for content access
+ *
+ * @param options - The options for generating the paywall
+ * @param options.amount - The amount to be paid in USD
+ * @param options.paymentRequirements - The payment requirements for the content
+ * @param options.currentUrl - The URL of the content being accessed
+ * @param options.testnet - Whether to use testnet or mainnet
+ * @param options.cdpClientKey - CDP client API key for OnchainKit
+ * @param options.appName - The name of the application to display in the wallet connection modal
+ * @param options.appLogo - The logo of the application to display in the wallet connection modal
+ * @param options.sessionTokenEndpoint - The API endpoint for generating session tokens for Onramp authentication
+ * @returns An HTML string containing the paywall page
+ */
+declare function getPaywallHtml({ amount, testnet, paymentRequirements, currentUrl, cdpClientKey, appName, appLogo, sessionTokenEndpoint, }: PaywallOptions): string;
+
+export { getPaywallHtml };

package/dist/esm/rpc-DyKXu0SX.d.mts

@@ -0,0 +1,35 @@
+import { RpcDevnet, SolanaRpcApiDevnet, RpcMainnet, SolanaRpcApiMainnet, RpcSubscriptionsFromTransport, SolanaRpcSubscriptionsApi, RpcSubscriptionsTransportFromClusterUrl, ClusterUrl } from '@solana/kit';
+import { N as Network } from './network-FrFmmiyj.mjs';
+
+/**
+ * Creates a Solana RPC client for the devnet network.
+ *
+ * @param url - Optional URL of the devnet network.
+ * @returns A Solana RPC client.
+ */
+declare function createDevnetRpcClient(url?: string): RpcDevnet<SolanaRpcApiDevnet>;
+/**
+ * Creates a Solana RPC client for the mainnet network.
+ *
+ * @param url - Optional URL of the mainnet network.
+ * @returns A Solana RPC client.
+ */
+declare function createMainnetRpcClient(url?: string): RpcMainnet<SolanaRpcApiMainnet>;
+/**
+ * Gets the RPC client for the given network.
+ *
+ * @param network - The network to get the RPC client for
+ * @param url - Optional URL of the network. If not provided, the default URL will be used.
+ * @returns The RPC client for the given network
+ */
+declare function getRpcClient(network: Network, url?: string): RpcDevnet<SolanaRpcApiDevnet> | RpcMainnet<SolanaRpcApiMainnet>;
+/**
+ * Gets the RPC subscriptions for the given network.
+ *
+ * @param network - The network to get the RPC subscriptions for
+ * @param url - Optional URL of the network. If not provided, the default URL will be used.
+ * @returns The RPC subscriptions for the given network
+ */
+declare function getRpcSubscriptions(network: Network, url?: string): RpcSubscriptionsFromTransport<SolanaRpcSubscriptionsApi, RpcSubscriptionsTransportFromClusterUrl<ClusterUrl>>;
+
+export { createMainnetRpcClient as a, getRpcSubscriptions as b, createDevnetRpcClient as c, getRpcClient as g };