@ch4p/plugin-x402 0.1.4

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025-2026 ch4p contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.ts

@@ -0,0 +1,303 @@
+import { IncomingMessage, ServerResponse } from 'node:http';
+import { ITool, JSONSchema7, ValidationResult, ToolContext, ToolResult } from '@ch4p/core';
+
+/**
+ * x402 Payment Required protocol types.
+ *
+ * Based on the x402 open standard for HTTP micropayments.
+ * Reference: https://www.x402.org
+ */
+/**
+ * Payment requirement describing what is needed to access a resource.
+ * Returned as part of the 402 Payment Required response body.
+ */
+interface X402PaymentRequirements {
+    /** Always "exact" — pay exactly this amount. */
+    scheme: 'exact';
+    /** Network identifier (e.g. "base", "base-sepolia", "ethereum"). */
+    network: string;
+    /** Amount in the asset's smallest unit (e.g. "1000000" = 1 USDC at 6 decimals). */
+    maxAmountRequired: string;
+    /** The URL path being protected (e.g. "/api/data"). */
+    resource: string;
+    /** Human-readable payment description shown to the payer. */
+    description: string;
+    /** MIME type of the gated resource (e.g. "application/json"). */
+    mimeType: string;
+    /** Wallet address that receives the payment. */
+    payTo: string;
+    /** Seconds before the payment authorization expires. */
+    maxTimeoutSeconds: number;
+    /** ERC-20 token contract address (zero address "0x0" for native ETH). */
+    asset: string;
+    /** Scheme-specific extra data. */
+    extra: Record<string, unknown>;
+}
+/**
+ * Body of an HTTP 402 Payment Required response.
+ */
+interface X402Response {
+    x402Version: 1;
+    error: 'X402';
+    accepts: X402PaymentRequirements[];
+}
+/**
+ * EIP-3009 transferWithAuthorization parameters.
+ * Embedded inside X402PaymentPayload.payload.
+ */
+interface X402PaymentAuthorization {
+    /** Payer wallet address. */
+    from: string;
+    /** Recipient wallet address (must match payTo). */
+    to: string;
+    /** Transfer amount in the asset's smallest unit. */
+    value: string;
+    /** Unix timestamp (seconds) after which the auth is valid. Use "0" for immediate. */
+    validAfter: string;
+    /** Unix timestamp (seconds) before which the auth must be submitted. */
+    validBefore: string;
+    /** Random 32-byte nonce (0x hex) to prevent replay attacks. */
+    nonce: string;
+}
+/**
+ * Payment proof sent in the X-PAYMENT HTTP header (base64-encoded JSON).
+ */
+interface X402PaymentPayload {
+    x402Version: 1;
+    scheme: 'exact';
+    network: string;
+    payload: {
+        /** EIP-712 signature over the EIP-3009 authorization struct. */
+        signature: string;
+        authorization: X402PaymentAuthorization;
+    };
+}
+/**
+ * Server-side x402 protection configuration.
+ */
+interface X402ServerConfig {
+    /** Wallet address that receives payments. */
+    payTo: string;
+    /**
+     * Payment amount in the asset's smallest unit.
+     * Example: "1000000" = 1 USDC (6 decimals).
+     */
+    amount: string;
+    /**
+     * ERC-20 token contract address.
+     * Defaults to USDC on Base (0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913).
+     */
+    asset?: string;
+    /**
+     * Network identifier.
+     * Defaults to "base".
+     */
+    network?: string;
+    /** Human-readable description shown in the 402 response. */
+    description?: string;
+    /**
+     * URL paths to gate. Supports trailing "/*" wildcard suffix.
+     * Examples: "/sessions", "/webhooks/*", "/*" (all paths).
+     * Default: all paths except /health, /.well-known/agent.json, and /pair.
+     */
+    protectedPaths?: string[];
+    /** Seconds before a payment authorization expires. Default: 300. */
+    maxTimeoutSeconds?: number;
+    /**
+     * Optional payment verifier. Called with the decoded payment and the
+     * active requirements after the X-PAYMENT header passes structural
+     * validation. Return true to grant access, false to re-issue 402.
+     *
+     * If omitted, structural validity of the X-PAYMENT header is sufficient.
+     * For production deployments, provide an on-chain verifier that calls
+     * transferWithAuthorization on the ERC-20 asset contract.
+     */
+    verifyPayment?: (payment: X402PaymentPayload, requirements: X402PaymentRequirements) => Promise<boolean>;
+}
+/**
+ * Client-side wallet configuration for signing x402 payment authorizations.
+ * Set `x402.client.privateKey` (or `${X402_PRIVATE_KEY}` env substitution)
+ * in ~/.ch4p/config.json to enable live on-chain payments.
+ */
+interface X402ClientConfig {
+    /**
+     * 0x-prefixed hex private key used to sign EIP-712 payment authorizations.
+     * Supports env-var substitution: `"${X402_PRIVATE_KEY}"`.
+     *
+     * ⚠️  Never commit a real private key to source control.
+     */
+    privateKey?: string;
+    /**
+     * ERC-20 token contract address.
+     * Default: USDC on Base mainnet (0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913).
+     */
+    tokenAddress?: string;
+    /**
+     * EIP-712 domain chain ID.
+     * Default: 8453 (Base mainnet).
+     */
+    chainId?: number;
+    /**
+     * EIP-712 domain token name.
+     * Default: "USD Coin".
+     */
+    tokenName?: string;
+    /**
+     * EIP-712 domain token version.
+     * Default: "2".
+     */
+    tokenVersion?: string;
+}
+/**
+ * Top-level x402 plugin configuration (added to ~/.ch4p/config.json).
+ */
+interface X402Config {
+    /** Whether x402 payment enforcement is active. Default: false. */
+    enabled?: boolean;
+    /** Server-side: protect gateway endpoints with payment requirements. */
+    server?: X402ServerConfig;
+    /** Client-side: wallet config for signing payment authorizations. */
+    client?: X402ClientConfig;
+}
+
+/**
+ * x402 gateway middleware — server-side payment enforcement.
+ *
+ * Call createX402Middleware(config) to obtain a pre-handler compatible with
+ * GatewayServer's `preHandler` option. For each incoming request the handler:
+ *
+ *   1. Skips system paths (/health, /.well-known/agent.json, /pair).
+ *   2. Skips paths not matched by `protectedPaths`.
+ *   3. If no X-PAYMENT header: responds 402 with payment requirements and
+ *      returns true (request handled, no further routing).
+ *   4. If X-PAYMENT header present: structurally validates the decoded
+ *      payload and, if a verifyPayment callback is configured, calls it.
+ *      - Invalid or rejected: sends 402 and returns true.
+ *      - Valid: tags `req._x402Authenticated = true` and returns false
+ *        so the request proceeds through normal routing with pairing auth
+ *        bypassed (GatewayServer.checkAuth respects this flag).
+ */
+
+/**
+ * Returns true if urlPath matches the protection pattern.
+ *
+ * Pattern rules:
+ *   - "*" or "/**": matches every path
+ *   - "/foo/*": prefix match — matches /foo and /foo/bar/baz
+ *   - "/foo": exact match only
+ */
+declare function pathMatches(urlPath: string, pattern: string): boolean;
+/**
+ * Decode and structurally validate the X-PAYMENT header value.
+ * Returns null on any parse or structure failure.
+ */
+declare function decodePaymentHeader(header: string): X402PaymentPayload | null;
+type X402PreHandler = (req: IncomingMessage, res: ServerResponse) => Promise<boolean>;
+/**
+ * Create an x402 middleware pre-handler for GatewayServer.
+ *
+ * Returns null when x402 is disabled or no server config is provided.
+ *
+ * @param config x402 plugin configuration
+ * @returns Pre-handler function, or null if x402 is not enabled.
+ */
+declare function createX402Middleware(config: X402Config): X402PreHandler | null;
+
+/**
+ * X402PayTool — agent tool for paying x402-gated resources.
+ *
+ * When an HTTP request returns 402 Payment Required with an x402 response
+ * body, the agent uses this tool to construct the X-PAYMENT header value
+ * required to retry the request with proof of payment.
+ *
+ * The tool produces a structurally correct EIP-3009 payment payload.
+ * Actual signing (EIP-712 transferWithAuthorization) is delegated to an
+ * optional `x402Signer` callback in the tool context. Without a signer,
+ * the payload includes a placeholder signature clearly marked as unsigned
+ * — suitable for development and testing.
+ */
+
+/**
+ * Extended ToolContext for x402 payment operations.
+ *
+ * x402Signer and agentWalletAddress are now part of the base ToolContext
+ * in @ch4p/core, so this is a plain alias kept for backward compatibility.
+ */
+type X402ToolContext = ToolContext;
+declare class X402PayTool implements ITool {
+    readonly name = "x402_pay";
+    readonly description: string;
+    readonly weight: "lightweight";
+    readonly parameters: JSONSchema7;
+    validate(args: unknown): ValidationResult;
+    execute(args: unknown, context: ToolContext): Promise<ToolResult>;
+}
+
+/**
+ * EIP-712 signer for x402 EIP-3009 transferWithAuthorization.
+ *
+ * Provides a ready-to-use signer factory for the `x402Signer` callback in
+ * X402ToolContext.  Uses ethers.js v6 `Wallet.signTypedData()` to produce a
+ * standards-compliant EIP-712 signature over the `TransferWithAuthorization`
+ * struct defined in USDC (ERC-20 + EIP-3009).
+ *
+ * Quick start:
+ *
+ * ```ts
+ * import { createEIP712Signer, walletAddress } from '@ch4p/plugin-x402';
+ *
+ * const signer = createEIP712Signer(process.env.X402_PRIVATE_KEY!);
+ * const agentWallet = walletAddress(process.env.X402_PRIVATE_KEY!);
+ * ```
+ */
+
+/**
+ * USDC contract addresses and EIP-712 domain parameters for supported networks.
+ * Import `KNOWN_TOKENS` when you need to look up token details by network name.
+ */
+declare const KNOWN_TOKENS: {
+    readonly base: {
+        readonly address: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913";
+        readonly chainId: 8453;
+        readonly name: "USD Coin";
+        readonly version: "2";
+    };
+    readonly 'base-sepolia': {
+        readonly address: "0x036CbD53842c5426634e7929541eC2318f3dCF7e";
+        readonly chainId: 84532;
+        readonly name: "USD Coin";
+        readonly version: "2";
+    };
+};
+interface EIP712SignerOpts {
+    /**
+     * EIP-712 domain chain ID.
+     * Default: 8453 (Base mainnet).
+     */
+    chainId?: number;
+    /**
+     * ERC-20 contract address whose `TransferWithAuthorization` is signed.
+     * Default: USDC on Base mainnet.
+     */
+    tokenAddress?: string;
+    /**
+     * Token name for the EIP-712 domain separator.
+     * Default: "USD Coin".
+     */
+    tokenName?: string;
+    /**
+     * Token version for the EIP-712 domain separator.
+     * Default: "2".
+     */
+    tokenVersion?: string;
+}
+declare function createEIP712Signer(privateKey: string, opts?: EIP712SignerOpts): (authorization: X402PaymentAuthorization) => Promise<string>;
+/**
+ * Derive the checksummed Ethereum address from a private key.
+ * Use this to populate `agentWalletAddress` in `toolContextExtensions`.
+ *
+ * @param privateKey  0x-prefixed hex private key.
+ */
+declare function walletAddress(privateKey: string): string;
+
+export { type EIP712SignerOpts, KNOWN_TOKENS, type X402ClientConfig, type X402Config, X402PayTool, type X402PaymentAuthorization, type X402PaymentPayload, type X402PaymentRequirements, type X402PreHandler, type X402Response, type X402ServerConfig, type X402ToolContext, createEIP712Signer, createX402Middleware, decodePaymentHeader, pathMatches, walletAddress };