okx-facilitator

Utilities for building X402 facilitator experiences on top of OKX's X Layer network. The package bundles request signing helpers, auth header utilities, and a drop-in HTML paywall tailored to OKX assets.

Features

• OKX-specific facilitator client for creating, verifying, and settling payments.
• Custom paywall HTML generator that renders a responsive checkout surface with wallet connection, network guards, and inline error messaging.
• Chain metadata helpers that pre-fill X Layer token information.

Generating the Paywall

import { getOkxPaywallHtml } from "okx-facilitator";

const html = getOkxPaywallHtml({
  amount: 1.25,
  currentUrl: "https://example.com/protected",
  paymentRequirements,
  network: "x-layer",
  assetAddress: "0x0000000000000000000000000000000000000000",
  assetName: "USDC",
  cdpClientKey,
  appName: "My App",
  appLogo: "https://example.com/logo.png",
  sessionTokenEndpoint: "https://example.com/api/session",
});

The returned string is a complete HTML document. Serve it directly in your facilitator when the requester needs to complete an x402 payment. The embedded script handles:

• Fetching payment requirements from currentUrl.
• Connecting to an EVM wallet (via window.ethereum) and prompting the user to sign an authorization.
• Switching to the correct X Layer network and checking balances for the required token.
• Emitting the X-PAYMENT header after a successful signature and redirecting back to the protected page.

Testing

pnpm test --filter okx-facilitator runs the unit tests that cover facilitator client behaviour and paywall generation.

License

MIT

A project by Nuwa AI with ❤️