x402

# x402 Skill Provides tools for interacting with x402 paid API endpoints, sending inbox messages, scaffolding new x402 API projects, and exploring OpenRouter AI models. Payment flows are handled automatically using the configured wallet. ## Usage ``` bun run x402/x402.ts <subcommand> [options] ``` ## Subcommands ### list-endpoints List known x402 API endpoint sources with descriptions and usage examples. ``` bun run x402/x402.ts list-endpoints ``` Output: ```json { "network": "mainnet", "defaultApiUrl": "https://x402.biwas.xyz", "sources": [ { "name": "x402.biwas.xyz", "url": "https://x402.biwas.xyz", "description": "DeFi analytics, market data, wallet analysis, Zest/ALEX protocols", "categories": ["defi", "market", "wallet", "analytics"], "example": { "path": "/api/pools/trending", "method": "GET" } } ], "usage": { "probe": "...", "execute": "..." } } ``` ### probe-endpoint Probe an x402 API endpoint to discover its cost WITHOUT making payment. ``` bun run x402/x402.ts probe-endpoint --method GET --path /api/pools/trending bun run x402/x402.ts probe-endpoint --method GET --url https://stx402.com/ai/dad-joke bun run x402/x402.ts probe-endpoint --method POST --url https://x402.aibtc.com/inference/openrouter/chat --data '{"messages":[{"role":"user","content":"hello"}]}' ``` Options: - `--method` (optional) — HTTP method (default: GET) - `--url` (optional) — Full endpoint URL. Takes precedence over `--path`. - `--path` (optional) — API endpoint path. Required if `--url` not provided. - `--api-url` (optional) — API base URL (default: configured API_URL) - `--params` (optional) — Query parameters as JSON object - `--data` (optional) — Request body for POST/PUT as JSON object Output (free endpoint): ```json { "type": "free", "endpoint": "GET https://x402.biwas.xyz/api/public", "message": "This endpoint is free (no payment required)", "response": { ... } } ``` Output (paid endpoint): ```json { "type": "payment_required", "endpoint": "GET https://x402.biwas.xyz/api/pools/trending", "message": "This endpoint costs 0.001 STX. Use execute-endpoint --auto-approve to pay and execute.", "payment": { "amount": "1000", "asset": "STX", "recipient": "SP...", "network": "mainnet" } } ``` ### execute-endpoint Execute an x402 API endpoint. By default probes first and shows cost for paid endpoints. Use `--auto-approve` to pay immediately. ``` bun run x402/x402.ts execute-endpoint --method GET --path /api/pools/trending --auto-approve bun run x402/x402.ts execute-endpoint --method GET --url https://stx402.com/ai/dad-joke --auto-approve bun run x402/x402.ts execute-endpoint --method POST --url https://x402.aibtc.com/inference/openrouter/chat --data '{"messages":[{"role":"user","content":"hello"}]}' --auto-approve ``` Options: - `--method` (optional) — HTTP method (default: GET) - `--url` (optional) — Full endpoint URL. Takes precedence over `--path`. - `--path` (optional) — API endpoint path. Required if `--url` not provided. - `--api-url` (optional) — API base URL (default: configured API_URL) - `--params` (optional) — Query parameters as JSON object - `--data` (optional) — Request body for POST/PUT as JSON object - `--auto-approve` (flag) — Skip cost probe and execute immediately, paying if required Output: ```json { "endpoint": "GET https://x402.biwas.xyz/api/pools/trending", "response": { ... }, "payment": { "status": "queued", "terminalReason": null, "action": "poll", "guidance": "Payment is still in flight. Keep polling this paymentId and do not rebuild or re-sign.", "paymentId": "relay_pay_123", "checkUrl": "https://relay.example/rpc/payment-check/relay_pay_123", "txid": null } } ``` Notes: - `payment` is only included when canonical payment metadata is actually known. - The client-side `payment-identifier` extension is an idempotency key for relay dedup, not caller-facing canonical `paymentId`. ### send-inbox-message Send a paid x402 message to another agent's inbox on aibtc.com. Uses sponsored transactions (no STX gas fees). Requires an unlocked wallet with sBTC balance. ``` bun run x402/x402.ts send-inbox-message \ --recipient-btc-address bc1q... \ --recipient-stx-address SP... \ --content "Hello from the agent!" ``` Options: - `--recipient-btc-address` (required) — Recipient's Bitcoin address (bc1...) - `--recipient-stx-address` (required) — Recipient's Stacks address (SP...) - `--content` (required) — Message content (max 500 characters) Output: ```json { "success": false, "message": "Payment is still in flight. Keep polling the same paymentId; do not rebuild or re-sign.", "recipient": { "btcAddress": "bc1q...", "stxAddress": "SP..." }, "contentLength": 22, "inbox": { ... }, "payment": { "amount": "1000 sats sBTC", "status": "queued", "terminalReason": null, "action": "poll", "paymentId": "pay_123", "checkUrl": "https://aibtc.com/rpc/payment-check/pay_123", "txid": null } } ``` Notes: - Caller-facing payment states collapse legacy `submitted` to `queued`. - `send-inbox-message` reports caller-facing `success: true` only after confirmed delivery. Internally, the retry helper's `success` flag only means the workflow completed without throwing; `messageDelivered` is the delivery confirmation bit. - When payment is still in flight, keep polling the same `payment.paymentId`. Use `payment.checkUrl` only when the server returns a canonical hint; do not assume every x402 endpoint exposes a local `/api/payment-status/:paymentId` route. `x402-api` remains an immediate pay-per-call exception and does not create a generic local polling contract. - `terminalReason` is the normalized terminal signal when a payment reaches a terminal state. ### scaffold-endpoint Create a complete x402 paid API project as a Cloudflare Worker. Generates a new project folder with Hono.js app, x402 payment middleware, wrangler.jsonc config, and README. ``` bun run x402/x402.ts scaffold-endpoint \ --output-dir /path/to/projects \ --project-name my-x402-api \ --endpoints '[{"path":"/api/data","method":"GET","description":"Get premium data","amount":"0.001","tokenType":"STX"}]' ``` Options: - `--output-dir` (required) — Directory where the project folder will be created - `--project-name` (required) — Project name (lowercase with hyphens) - `--endpoints` (required) — JSON array of endpoint configs - `--recipient-address` (optional) — Stacks address to receive payments (uses active wallet if omitted) - `--network` (optional) — Network for payments (default: mainnet) - `--relay-url` (optional) — Custom relay URL (default: https://x402-relay.aibtc.com) Endpoint config fields: - `path` — Endpoint path (e.g., `/api/data`) - `method` — HTTP method (GET or POST) - `description` — Endpoint description - `amount` — Payment amount (e.g., `"0.001"`) - `tokenType` — Payment token (STX, sBTC, or USDCx) - `tier` (optional) — Pricing tier: simple, standard, ai, heavy_ai, storage_read, storage_write ### scaffold-ai-endpoint Create a complete x402 paid AI API project with OpenRouter integration as a Cloudflare Worker. ``` bun run x402/x402.ts scaffold-ai-endpoint \ --output-dir /path/to/projects \ --project-name my-ai-api \ --endpoints '[{"path":"/api/chat","description":"AI chat","amount":"0.003","tokenType":"STX","aiType":"chat"}]' ``` Options: - `--output-dir` (required) — Directory where the project folder will be created - `--project-name` (required) — Project name (lowercase with hyphens) - `--endpoints` (required) — JSON array of AI endpoint configs - `--recipient-address` (optional) — Stacks address to receive payments (uses active wallet if omitted) - `--network` (optional) — Network for payments (default: mainnet) - `--relay-url` (optional) — Custom relay URL - `--default-model` (optional) — Default OpenRouter model (default: anthropic/claude-3-haiku) AI Endpoint config fields: - `path`, `description`, `amount`, `tokenType` — same as regular endpoints - `aiType` — Type of AI operation: chat, completion, summarize, translate, custom - `model` (optional) — OpenRouter model override - `systemPrompt` (optional) — Custom system prompt ### openrouter-guide Get OpenRouter integration examples and code patterns for implementing AI features. ``` bun run x402/x402.ts openrouter-guide [--environment all] [--feature all] ``` Options: - `--environment` (optional) — Target environment (nodejs, cloudflare-worker, browser, all) - `--feature` (optional) — Specific feature (chat, completion, streaming, function-calling, all) ### openrouter-models List popular OpenRouter models with capabilities and context lengths. ``` bun run x402/x402.ts openrouter-models [--category all] ``` Options: - `--category` (optional) — Filter by category: fast, quality, cheap, code, long-context, all (default: all) Output: ```json { "category": "all", "count": 13, "models": [ { "id": "anthropic/claude-3.5-haiku", "name": "Claude 3.5 Haiku", "category": ["fast", "cheap"], "contextLength": 200000, "bestFor": "Fast responses, simple tasks, cost-effective" } ], "recommendation": "Start with claude-3.5-haiku or gpt-4o-mini for most tasks." } ``` ## Payment mode `execute-endpoint` builds the payment transaction according to `X402_PAYMENT_MODE`: | Mode | Transaction | Wallet needs | Use when | |------|-------------|--------------|----------| | `sponsored` (default) | Sponsored, fee 0 — the server or the aibtc relay co-signs and pays gas | sBTC or STX for the price only | The endpoint settles through the aibtc sponsor relay | | `direct` | Standard transfer signed by the wallet alone, fee paid by the wallet | Price **plus** STX for gas (≤ 0.1 STX for sBTC, ≤ 0.003 STX for STX, clamped) | The endpoint verifies and broadcasts payments itself and answers sponsored bytes with `422 sponsored_unsupported` | ```bash X402_PAYMENT_MODE=direct NETWORK=mainnet bun run x402/x402.ts execute-endpoint --url https://api.example.com/paid --auto-approve ``` Direct mode is fail-closed: it signs only native STX or the canonical sBTC token for the active network, refuses amounts above `X402_MAX_SATS_PER_PAYMENT` (default 10000) / `X402_MAX_USTX_PER_PAYMENT` (default 1000000), caps the fee at `X402_MAX_FEE_USTX` (default 100000; a cap below the per-type minimum fee is refused, not rounded up), rejects challenge terms that are not byte-exact (padded amounts, addresses or asset ids, an unparseable chain id, a non-positive `maxTimeoutSeconds`), and refuses to pay if the mempool fee, nonce or balance cannot be read from the Stacks API. All of these settings are parsed when the client is created, so a typo fails before any 402 is answered. Two persisted rails sit below the per-payment caps, because callers create a client per invocation and a retry after an ambiguous failure would otherwise pay twice: - **Duplicate guard** — an identical request (method, URL, params, body, payer, payTo, amount, asset) is refused with the earlier `txid` instead of signed again while the earlier payment's outcome is unknown: the paid request failed or timed out after it was sent, the process crashed mid-flight, the canonical status reported a failure, or the earlier call is still in flight. The record is written before the signed bytes are sent and expires after `X402_DEDUP_TTL_SECONDS` (default 900). Once the server answers the paid request with a 2xx, the record is cleared, so repeat purchases of the same endpoint (polling a price feed, say) are paid normally. If the paid request never reached the server (DNS failure, connection refused, TLS verification failure), the record and the ledger entry are both released, because nothing was sent. State: `~/.aibtc/x402-dedup.json` (digests and txids only; override with `X402_DEDUP_STATE_FILE`).