@armory-sh/client-ethers 0.2.12 → 0.2.14

package/dist/index.d.ts

@@ -1,63 +1,41 @@
-import { X402PaymentRequirementsV1, PaymentRequirementsV2, Address, X402PaymentPayloadV1, PaymentPayloadV2, CustomToken } from '@armory-sh/base';
-export { Address, BalanceOfParams, CAIP2ChainId, CAIPAssetId, EIP712_TYPES, ERC20_ABI, Extensions, NETWORKS, NetworkConfig, PayToV2, PaymentPayload, PaymentPayloadV1, PaymentPayloadV2, PaymentRequirements, PaymentRequirementsV1, PaymentRequirementsV2, SettlementResponse, SettlementResponseV1, SettlementResponseV2, Signature, TransferWithAuthorizationParams, V1_HEADERS, V2_HEADERS, createEIP712Domain, createTransferWithAuthorization, decodePayment, decodePaymentV1, decodePaymentV2, decodeSettlementLegacy, decodeSettlementV1, decodeSettlementV2, detectPaymentVersion, encodePaymentV1, encodePaymentV2, encodeSettlementV1, encodeSettlementV2, getMainnets, getNetworkByChainId, getNetworkConfig, getPaymentHeaderName as getPaymentHeaderNameBase, getPaymentRequiredHeaderName, getPaymentResponseHeaderName, getPaymentVersion, getRequirementsVersion, getSettlementVersion, getTestnets, getTxHash, isCAIP2ChainId, isCAIPAssetId, isPaymentV1, isPaymentV2, isSettlementSuccessful, isSettlementV1, isSettlementV2, isV1, isV2, isX402V1PaymentRequired, isX402V1Requirements, isX402V2PaymentRequired, safeBase64Decode, validateTransferWithAuthorization } from '@armory-sh/base';
+import { PaymentRequirementsV2, Address, PaymentPayloadV2, CustomToken } from '@armory-sh/base';
+export { Address, BalanceOfParams, CAIP2ChainId, CAIPAssetId, EIP712_TYPES, ERC20_ABI, Extensions, NETWORKS, NetworkConfig, PayToV2, PaymentPayload, PaymentPayloadV2, PaymentRequirements, PaymentRequirementsV2, SettlementResponse, SettlementResponseV2, Signature, TransferWithAuthorizationParams, V2_HEADERS, createEIP712Domain, createTransferWithAuthorization, decodePayment, decodePaymentV2, decodeSettlementV2, detectPaymentVersion, encodePaymentV2, encodeSettlementV2, getMainnets, getNetworkByChainId, getNetworkConfig, getTestnets, getTxHash, isCAIP2ChainId, isCAIPAssetId, isPaymentV2, isSettlementSuccessful, isSettlementV2, isX402V2PaymentRequired, safeBase64Decode, validateTransferWithAuthorization } from '@armory-sh/base';
 import { Signer, Provider } from 'ethers';
 export { Provider, Signer } from 'ethers';
 
 /**
- * X402 Protocol Implementation for Ethers Client
+ * X402 Protocol Implementation for Ethers Client (V2 Only)
  *
- * Handles parsing x402 V1 and V2 PAYMENT-REQUIRED headers
- * and generating x402 V1 and V2 PAYMENT-SIGNATURE payloads
+ * Handles parsing x402 V2 PAYMENT-REQUIRED headers
+ * and generating x402 V2 PAYMENT-SIGNATURE payloads
  */
 
 /**
  * Detect x402 protocol version from response headers
+ * V2-only: Always returns 2
  */
-declare function detectX402Version(response: Response): 1 | 2;
+declare function detectX402Version(_response: Response): 2;
 /**
- * Parsed payment requirements with version info
+ * Get payment header name for protocol version
  */
+declare function getPaymentHeaderName(_version: 2): string;
 interface ParsedPaymentRequirements {
-    version: 1 | 2;
-    requirements: X402PaymentRequirementsV1 | PaymentRequirementsV2;
+    version: 2;
+    requirements: PaymentRequirementsV2;
 }
 /**
  * Parse x402 PAYMENT-REQUIRED header from response
- * Automatically detects V1 or V2 format
+ * V2 only
  */
 declare function parsePaymentRequired(response: Response): ParsedPaymentRequirements;
 /**
- * Create x402 V1 payment payload
+ * Create x402 payment payload (V2-only wrapper)
  */
-declare function createX402V1Payment(signer: Signer, requirements: X402PaymentRequirementsV1, fromAddress: Address, nonce: `0x${string}`, validBefore: number, domainName?: string, domainVersion?: string): Promise<X402PaymentPayloadV1>;
-/**
- * Create x402 V2 payment payload
- */
-declare function createX402V2Payment(signer: Signer, requirements: PaymentRequirementsV2, fromAddress: Address, nonce: `0x${string}`, validBefore: number, domainName?: string, domainVersion?: string): Promise<PaymentPayloadV2>;
-/**
- * Create x402 payment payload (auto-detects version)
- */
-declare function createX402Payment(signer: Signer, parsed: ParsedPaymentRequirements, fromAddress: Address, nonce?: `0x${string}`, validBefore?: number, domainName?: string, domainVersion?: string): Promise<X402PaymentPayloadV1 | PaymentPayloadV2>;
+declare function createX402Payment(signer: Signer, parsed: ParsedPaymentRequirements, fromAddress: Address, nonce?: `0x${string}`, validBefore?: number, domainName?: string, domainVersion?: string): Promise<PaymentPayloadV2>;
 /**
  * Encode x402 payment payload to Base64 for transport
  */
-declare function encodeX402Payment(payload: X402PaymentPayloadV1 | PaymentPayloadV2): string;
-/**
- * Get the correct header name for payment based on version
- */
-declare function getPaymentHeaderName(version: 1 | 2): string;
-/**
- * @deprecated Use createX402Payment instead
- */
-declare function createPaymentPayload(requirements: unknown, signer: Signer, from: string): Promise<[string, string]>;
-/**
- * @deprecated Use parsePaymentRequired instead
- */
-declare function parsePaymentRequirements(response: Response): Promise<unknown>;
-/**
- * @deprecated Use detectX402Version instead
- */
-declare function detectProtocolVersion(requirements: unknown): 1 | 2;
+declare function encodeX402Payment(payload: PaymentPayloadV2): string;
 
 declare class X402ClientError extends Error {
     readonly cause?: unknown;
@@ -168,4 +146,56 @@ declare function recoverEIP3009Signer(params: TransferWithAuthorizationParams, s
     s: string;
 }, domain: EIP712Domain): Promise<`0x${string}`>;
 
-export { AuthorizationError, type ClientConfig, type ParsedPaymentRequirements, PaymentError, ProviderRequiredError, SignerRequiredError, SigningError, type X402ClientConfig, X402ClientError, type X402RequestInit, type X402Transport, type X402TransportConfig, createPaymentPayload, createX402Payment, createX402Transport, createX402V1Payment, createX402V2Payment, detectProtocolVersion, detectX402Version, encodeX402Payment, getPaymentHeaderName, parsePaymentRequired, parsePaymentRequirements, recoverEIP3009Signer, signEIP3009, signEIP3009WithDomain, signPayment };
+/**
+ * X402 Client Factory for Ethers
+ *
+ * Creates a configured client instance for making X-402 payments
+ */
+
+/**
+ * X402 Client instance
+ * Provides a high-level API for making X-402 authenticated requests
+ */
+interface X402Client {
+    /**
+     * Make a GET request
+     */
+    get(url: string, init?: X402RequestInit): Promise<Response>;
+    /**
+     * Make a POST request
+     */
+    post(url: string, body?: unknown, init?: X402RequestInit): Promise<Response>;
+    /**
+     * Make a PUT request
+     */
+    put(url: string, body?: unknown, init?: X402RequestInit): Promise<Response>;
+    /**
+     * Make a DELETE request
+     */
+    del(url: string, init?: X402RequestInit): Promise<Response>;
+    /**
+     * Make a PATCH request
+     */
+    patch(url: string, body?: unknown, init?: X402RequestInit): Promise<Response>;
+    /**
+     * Set the signer for payment signing
+     */
+    setSigner(signer: Signer): void;
+    /**
+     * Get the current signer
+     */
+    getSigner(): Signer | undefined;
+}
+
+/**
+ * Create an X402 client
+ *
+ * @param config - Client configuration
+ * @returns Configured X402 client
+ */
+declare function createX402Client(config: X402ClientConfig & SignerClientConfig & {
+    signer: Signer;
+}): X402Client;
+declare function createX402Client(config: X402ClientConfig & ProviderClientConfig): X402Client;
+
+export { AuthorizationError, type ClientConfig, type ParsedPaymentRequirements, PaymentError, ProviderRequiredError, SignerRequiredError, SigningError, type X402Client, type X402ClientConfig, X402ClientError, type X402RequestInit, type X402Transport, type X402TransportConfig, createX402Client, createX402Payment, createX402Transport, detectX402Version, encodeX402Payment, getPaymentHeaderName, parsePaymentRequired, recoverEIP3009Signer, signEIP3009, signEIP3009WithDomain, signPayment };

package/dist/index.js

@@ -1,15 +1,6 @@
 // src/index.ts
 import {
-  V1_HEADERS as V1_HEADERS3,
   V2_HEADERS as V2_HEADERS3,
-  isV1,
-  isV2,
-  getPaymentVersion,
-  getRequirementsVersion,
-  getSettlementVersion,
-  getPaymentHeaderName as getPaymentHeaderName2,
-  getPaymentResponseHeaderName,
-  getPaymentRequiredHeaderName,
   isSettlementSuccessful as isSettlementSuccessful2,
   getTxHash,
   NETWORKS,
@@ -18,41 +9,28 @@ import {
   getMainnets,
   getTestnets,
   ERC20_ABI,
-  encodePaymentV1,
-  decodePaymentV1,
-  encodeSettlementV1,
-  decodeSettlementV1,
   encodePaymentV2,
   decodePaymentV2,
   encodeSettlementV2,
-  decodeSettlementV2,
+  decodeSettlementV2 as decodeSettlementV22,
   detectPaymentVersion,
   decodePayment,
-  decodeSettlementLegacy as decodeSettlementLegacy2,
-  isPaymentV1,
   isPaymentV2,
-  isSettlementV1,
   isSettlementV2,
-  isX402V1PaymentRequired as isX402V1PaymentRequired2,
   isX402V2PaymentRequired as isX402V2PaymentRequired2,
-  isX402V1Requirements as isX402V1Requirements2,
   EIP712_TYPES as EIP712_TYPES2,
   createEIP712Domain as createEIP712Domain3,
   createTransferWithAuthorization as createTransferWithAuthorization2,
   validateTransferWithAuthorization,
   isCAIP2ChainId,
   isCAIPAssetId,
-  safeBase64Decode as safeBase64Decode2
+  safeBase64Decode
 } from "@armory-sh/base";
 
 // src/protocol.ts
 import {
-  V1_HEADERS,
   V2_HEADERS,
-  safeBase64Decode,
-  isX402V1PaymentRequired,
   isX402V2PaymentRequired,
-  isX402V1Requirements,
   getNetworkByChainId,
   getNetworkConfig,
   createEIP712Domain as createEIP712Domain2,
@@ -173,71 +151,32 @@ async function recoverEIP3009Signer(params, signature, domain) {
 }
 
 // src/protocol.ts
-function detectX402Version(response) {
-  const v2Header = response.headers.get(V2_HEADERS.PAYMENT_REQUIRED);
-  if (v2Header) {
-    try {
-      const parsed = JSON.parse(v2Header);
-      if (parsed.x402Version === 2) return 2;
-    } catch {
-    }
-  }
-  const v1Header = response.headers.get(V1_HEADERS.PAYMENT_REQUIRED);
-  if (v1Header) {
-    try {
-      const decoded = safeBase64Decode(v1Header);
-      const parsed = JSON.parse(decoded);
-      if (parsed.x402Version === 1) return 1;
-      return 1;
-    } catch {
-    }
-  }
+function detectX402Version(_response) {
   return 2;
 }
+function getPaymentHeaderName(_version) {
+  return V2_HEADERS.PAYMENT_SIGNATURE;
+}
 function parsePaymentRequired(response) {
-  const version = detectX402Version(response);
-  if (version === 2) {
-    const v2Header = response.headers.get(V2_HEADERS.PAYMENT_REQUIRED);
-    if (!v2Header) {
-      throw new PaymentError("No PAYMENT-REQUIRED header found in 402 response");
-    }
-    try {
-      const parsed = JSON.parse(v2Header);
-      if (!isX402V2PaymentRequired(parsed)) {
-        throw new PaymentError("Invalid x402 V2 payment required format");
-      }
-      if (!parsed.accepts || parsed.accepts.length === 0) {
-        throw new PaymentError("No payment requirements found in accepts array");
-      }
-      return {
-        version: 2,
-        requirements: parsed.accepts[0]
-      };
-    } catch (error) {
-      if (error instanceof PaymentError) throw error;
-      throw new PaymentError(`Failed to parse V2 PAYMENT-REQUIRED header: ${error}`);
-    }
-  }
-  const v1Header = response.headers.get(V1_HEADERS.PAYMENT_REQUIRED);
-  if (!v1Header) {
-    throw new PaymentError("No X-PAYMENT-REQUIRED header found in 402 response");
+  const v2Header = response.headers.get(V2_HEADERS.PAYMENT_REQUIRED);
+  if (!v2Header) {
+    throw new PaymentError("No PAYMENT-REQUIRED header found in V2 response");
   }
   try {
-    const decoded = safeBase64Decode(v1Header);
-    const parsed = JSON.parse(decoded);
-    if (!isX402V1PaymentRequired(parsed)) {
-      throw new PaymentError("Invalid x402 V1 payment required format");
+    const parsed = JSON.parse(v2Header);
+    if (!isX402V2PaymentRequired(parsed)) {
+      throw new PaymentError("Invalid x402 V2 payment required format");
     }
     if (!parsed.accepts || parsed.accepts.length === 0) {
       throw new PaymentError("No payment requirements found in accepts array");
     }
     return {
-      version: 1,
+      version: 2,
       requirements: parsed.accepts[0]
     };
   } catch (error) {
     if (error instanceof PaymentError) throw error;
-    throw new PaymentError(`Failed to parse V1 PAYMENT-REQUIRED header: ${error}`);
+    throw new PaymentError(`Failed to parse V2 PAYMENT-REQUIRED header: ${error}`);
   }
 }
 function toAtomicUnits(amount) {
@@ -253,56 +192,10 @@ function extractChainId(network) {
   }
   throw new PaymentError(`Unsupported network: ${network}`);
 }
-function getNetworkSlug(network) {
-  if (network.startsWith("eip155:")) {
-    const chainId = parseInt(network.split(":")[1], 10);
-    const net = getNetworkByChainId(chainId);
-    if (!net) {
-      throw new PaymentError(`No network config found for chainId: ${chainId}`);
-    }
-    return normalizeNetworkName(net.name);
-  }
-  return normalizeNetworkName(network);
-}
 function createNonce() {
   const now = Math.floor(Date.now() / 1e3);
   return `0x${(now * 1e3).toString(16).padStart(64, "0")}`;
 }
-async function createX402V1Payment(signer, requirements, fromAddress, nonce, validBefore, domainName, domainVersion) {
-  const network = getNetworkSlug(requirements.network);
-  const contractAddress = requirements.asset;
-  const chainId = extractChainId(requirements.network);
-  const domain = createEIP712Domain2(chainId, contractAddress);
-  const customDomain = domainName || domainVersion ? { ...domain, name: domainName ?? domain.name, version: domainVersion ?? domain.version } : domain;
-  const authorization = {
-    from: fromAddress,
-    to: requirements.payTo,
-    value: toAtomicUnits(requirements.maxAmountRequired),
-    validAfter: "0",
-    validBefore: validBefore.toString(),
-    nonce
-  };
-  const authParams = {
-    from: authorization.from,
-    to: authorization.to,
-    value: BigInt(authorization.value),
-    validAfter: BigInt(authorization.validAfter),
-    validBefore: BigInt(authorization.validBefore),
-    nonce: BigInt(authorization.nonce)
-  };
-  const signature = await signEIP3009(signer, authParams, customDomain);
-  const combinedSignature = `0x${signature.r.slice(2)}${signature.s.slice(2)}${signature.v.toString(16).padStart(2, "0")}`;
-  const payload = {
-    signature: combinedSignature,
-    authorization
-  };
-  return {
-    x402Version: 1,
-    scheme: "exact",
-    network,
-    payload
-  };
-}
 async function createX402V2Payment(signer, requirements, fromAddress, nonce, validBefore, domainName, domainVersion) {
   const contractAddress = requirements.asset;
   const chainId = extractChainId(requirements.network);
@@ -332,24 +225,14 @@ async function createX402V2Payment(signer, requirements, fromAddress, nonce, val
   };
   return {
     x402Version: 2,
-    accepted: requirements,
+    scheme: requirements.scheme,
+    network: requirements.network,
     payload
   };
 }
 async function createX402Payment(signer, parsed, fromAddress, nonce, validBefore, domainName, domainVersion) {
   const effectiveNonce = nonce ?? createNonce();
   const effectiveValidBefore = validBefore ?? Math.floor(Date.now() / 1e3) + 3600;
-  if (parsed.version === 1) {
-    return createX402V1Payment(
-      signer,
-      parsed.requirements,
-      fromAddress,
-      effectiveNonce,
-      effectiveValidBefore,
-      domainName,
-      domainVersion
-    );
-  }
   return createX402V2Payment(
     signer,
     parsed.requirements,
@@ -363,34 +246,11 @@ async function createX402Payment(signer, parsed, fromAddress, nonce, validBefore
 function encodeX402Payment(payload) {
   return Buffer.from(JSON.stringify(payload)).toString("base64");
 }
-function getPaymentHeaderName(version) {
-  return version === 1 ? V1_HEADERS.PAYMENT : V2_HEADERS.PAYMENT_SIGNATURE;
-}
-async function createPaymentPayload(requirements, signer, from) {
-  const parsed = isX402V1Requirements(requirements) ? { version: 1, requirements } : { version: 2, requirements };
-  const payload = await createX402Payment(signer, parsed, from);
-  const encoded = encodeX402Payment(payload);
-  return [encoded, getPaymentHeaderName(parsed.version)];
-}
-async function parsePaymentRequirements(response) {
-  const parsed = parsePaymentRequired(response);
-  return parsed.requirements;
-}
-function detectProtocolVersion(requirements) {
-  if (typeof requirements === "object" && requirements !== null) {
-    if ("x402Version" in requirements && requirements.x402Version === 2) {
-      return 2;
-    }
-    if ("chainId" in requirements && "assetId" in requirements && !("contractAddress" in requirements)) {
-      return 2;
-    }
-  }
-  return 1;
-}
 
 // src/transport.ts
 import {
-  decodeSettlementLegacy
+  decodeSettlementV2,
+  V2_HEADERS as V2_HEADERS2
 } from "@armory-sh/base";
 var defaultConfig = {
   baseURL: "",
@@ -442,7 +302,7 @@ var handlePaymentRequired = async (state, response) => {
       },
       state.config.timeout
     );
-    const settlement = decodeSettlementLegacy(paymentResponse.headers);
+    const settlement = decodeSettlementV2(paymentResponse.headers.get(V2_HEADERS2.PAYMENT_RESPONSE) || "");
     return { success: true, settlement };
   } catch (error) {
     return { success: false, error: error instanceof Error ? error : new Error(String(error)) };
@@ -502,6 +362,38 @@ var createX402Transport = (config) => {
     getSigner: () => state.signer
   };
 };
+
+// src/client.ts
+function createX402Client(config) {
+  const transport = createX402Transport(void 0);
+  if ("signer" in config && config.signer) {
+    transport.setSigner(config.signer);
+  } else if ("provider" in config && config.provider) {
+    const provider = config.provider;
+    if (provider.getSigner) {
+      try {
+        const signer = provider.getSigner();
+        if (signer) {
+          transport.setSigner(signer);
+        }
+      } catch {
+      }
+    }
+  } else {
+    throw new SignerRequiredError(
+      "Either 'signer' or 'provider' with getSigner() must be provided"
+    );
+  }
+  return {
+    get: (url, init) => transport.get(url, init),
+    post: (url, body, init) => transport.post(url, body, init),
+    put: (url, body, init) => transport.put(url, body, init),
+    del: (url, init) => transport.del(url, init),
+    patch: (url, body, init) => transport.patch(url, body, init),
+    setSigner: (signer) => transport.setSigner(signer),
+    getSigner: () => transport.getSigner()
+  };
+}
 export {
   AuthorizationError,
   EIP712_TYPES2 as EIP712_TYPES,
@@ -511,58 +403,36 @@ export {
   ProviderRequiredError,
   SignerRequiredError,
   SigningError,
-  V1_HEADERS3 as V1_HEADERS,
   V2_HEADERS3 as V2_HEADERS,
   X402ClientError,
   createEIP712Domain3 as createEIP712Domain,
-  createPaymentPayload,
   createTransferWithAuthorization2 as createTransferWithAuthorization,
+  createX402Client,
   createX402Payment,
   createX402Transport,
-  createX402V1Payment,
-  createX402V2Payment,
   decodePayment,
-  decodePaymentV1,
   decodePaymentV2,
-  decodeSettlementLegacy2 as decodeSettlementLegacy,
-  decodeSettlementV1,
-  decodeSettlementV2,
+  decodeSettlementV22 as decodeSettlementV2,
   detectPaymentVersion,
-  detectProtocolVersion,
   detectX402Version,
-  encodePaymentV1,
   encodePaymentV2,
-  encodeSettlementV1,
   encodeSettlementV2,
   encodeX402Payment,
   getMainnets,
   getNetworkByChainId2 as getNetworkByChainId,
   getNetworkConfig2 as getNetworkConfig,
   getPaymentHeaderName,
-  getPaymentHeaderName2 as getPaymentHeaderNameBase,
-  getPaymentRequiredHeaderName,
-  getPaymentResponseHeaderName,
-  getPaymentVersion,
-  getRequirementsVersion,
-  getSettlementVersion,
   getTestnets,
   getTxHash,
   isCAIP2ChainId,
   isCAIPAssetId,
-  isPaymentV1,
   isPaymentV2,
   isSettlementSuccessful2 as isSettlementSuccessful,
-  isSettlementV1,
   isSettlementV2,
-  isV1,
-  isV2,
-  isX402V1PaymentRequired2 as isX402V1PaymentRequired,
-  isX402V1Requirements2 as isX402V1Requirements,
   isX402V2PaymentRequired2 as isX402V2PaymentRequired,
   parsePaymentRequired,
-  parsePaymentRequirements,
   recoverEIP3009Signer,
-  safeBase64Decode2 as safeBase64Decode,
+  safeBase64Decode,
   signEIP3009,
   signEIP3009WithDomain,
   signPayment,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@armory-sh/client-ethers",
-  "version": "0.2.12",
+  "version": "0.2.14",
   "license": "MIT",
   "author": "Sawyer Cutler <sawyer@dirtroad.dev>",
   "type": "module",
@@ -27,7 +27,7 @@
     "directory": "packages/client-ethers"
   },
   "dependencies": {
-    "@armory-sh/base": "^0.2.12",
+    "@armory-sh/base": "^0.2.14",
     "ethers": "6.16.0"
   },
   "devDependencies": {
@@ -35,7 +35,7 @@
     "bun-types": "latest"
   },
   "scripts": {
-    "build": "tsup",
+    "build": "rm -rf dist && tsup",
     "test": "bun test",
     "example": "bun run examples/"
   }