@openfacilitator/sdk 0.6.2 → 0.7.0

package/LICENSE

@@ -0,0 +1,191 @@
+                                 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 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 those 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 2024 OpenFacilitator 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.mts

@@ -7,15 +7,14 @@ interface FacilitatorConfig {
     headers?: Record<string, string>;
 }
 /**
- * Payment payload for verification/settlement
- * Supports both x402 v1 and v2 formats
+ * Payment payload for x402 version 1. Uses flat structure with scheme/network at top level.
  */
-interface PaymentPayload {
-    /** x402 version (1 or 2) */
-    x402Version: 1 | 2;
+interface PaymentPayloadV1 {
+    /** x402 version 1 */
+    x402Version: 1;
     /** Payment scheme (e.g., "exact") */
     scheme: string;
-    /** Network identifier - v1: "base", v2: "eip155:8453" */
+    /** Network identifier - v1 format (e.g., "base", "solana") */
     network: string;
     /** Payment details */
     payload: {
@@ -25,6 +24,48 @@ interface PaymentPayload {
         authorization: PaymentAuthorization;
     };
 }
+/**
+ * Payment payload for x402 version 2. Uses nested `accepted` structure per @x402/core spec.
+ */
+interface PaymentPayloadV2 {
+    /** x402 version 2 */
+    x402Version: 2;
+    /** Optional resource being paid for */
+    resource?: {
+        /** Resource URL */
+        url: string;
+        /** Human-readable description */
+        description?: string;
+        /** MIME type of resource */
+        mimeType?: string;
+    };
+    /** Accepted payment requirements (contains scheme, network, amount, etc.) */
+    accepted: {
+        /** Payment scheme (e.g., "exact") */
+        scheme: string;
+        /** Network identifier - CAIP-2 format (e.g., "eip155:8453") */
+        network: string;
+        /** Token/asset address */
+        asset: string;
+        /** Amount in base units */
+        amount: string;
+        /** Recipient address */
+        payTo: string;
+        /** Maximum timeout in seconds */
+        maxTimeoutSeconds: number;
+        /** Extra data */
+        extra?: Record<string, unknown>;
+    };
+    /** Payment details (signature, authorization, etc.) */
+    payload: Record<string, unknown>;
+    /** Optional extensions */
+    extensions?: Record<string, unknown>;
+}
+/**
+ * Payment payload union - supports both x402 v1 and v2 formats.
+ * Use x402Version to discriminate between versions.
+ */
+type PaymentPayload = PaymentPayloadV1 | PaymentPayloadV2;
 interface PaymentAuthorization {
     /** Sender address */
     from: string;
@@ -44,10 +85,9 @@ interface PaymentAuthorization {
     [key: string]: unknown;
 }
 /**
- * Payment requirements from the server/resource
- * Used for validation during verify/settle
+ * Payment requirements for x402 version 1. Uses maxAmountRequired field.
  */
-interface PaymentRequirements {
+interface PaymentRequirementsV1 {
     /** Payment scheme (e.g., "exact") */
     scheme: string;
     /** Network identifier */
@@ -71,6 +111,31 @@ interface PaymentRequirements {
     /** Extra data */
     extra?: Record<string, unknown>;
 }
+/**
+ * Payment requirements for x402 version 2.
+ * Uses 'amount' instead of 'maxAmountRequired' and has stricter required fields.
+ */
+interface PaymentRequirementsV2 {
+    /** Payment scheme (e.g., "exact") */
+    scheme: string;
+    /** Network identifier - v2 CAIP-2 format */
+    network: string;
+    /** Amount required in base units */
+    amount: string;
+    /** Token/asset address */
+    asset: string;
+    /** Recipient address */
+    payTo: string;
+    /** Maximum timeout in seconds */
+    maxTimeoutSeconds: number;
+    /** Extra data */
+    extra: Record<string, unknown>;
+}
+/**
+ * Payment requirements union - supports both v1 and v2 formats.
+ * V1 uses maxAmountRequired, V2 uses amount.
+ */
+type PaymentRequirements = PaymentRequirementsV1 | PaymentRequirementsV2;
 interface VerifyResponse {
     /** Whether the payment is valid */
     isValid: boolean;
@@ -256,6 +321,65 @@ declare function getTestnets(): NetworkInfo[];
  * Type guard for checking if value is a valid payment payload
  */
 declare function isPaymentPayload(value: unknown): value is PaymentPayload;
+/**
+ * Type guard for PaymentPayloadV1 (x402 version 1).
+ * Narrows PaymentPayload to v1 format with flat structure.
+ */
+declare function isPaymentPayloadV1(value: unknown): value is PaymentPayloadV1;
+/**
+ * Type guard for PaymentPayloadV2 (x402 version 2).
+ * Narrows PaymentPayload to v2 format with nested `accepted` structure.
+ */
+declare function isPaymentPayloadV2(value: unknown): value is PaymentPayloadV2;
+/**
+ * Type guard for PaymentRequirementsV1.
+ * V1 requirements have maxAmountRequired field.
+ */
+declare function isPaymentRequirementsV1(value: unknown): value is PaymentRequirementsV1;
+/**
+ * Type guard for PaymentRequirementsV2.
+ * V2 requirements have amount but NOT maxAmountRequired.
+ */
+declare function isPaymentRequirementsV2(value: unknown): value is PaymentRequirementsV2;
+/**
+ * Extract scheme and network from PaymentPayload (version-agnostic).
+ * v1 has these at top level, v2 has them nested in `accepted`.
+ */
+declare function getSchemeNetwork(payload: PaymentPayload): {
+    scheme: string;
+    network: string;
+};
+/**
+ * Get x402 version from PaymentPayload.
+ * Returns literal type 1 | 2 for exhaustiveness checking in switch statements.
+ */
+declare function getVersion(payload: PaymentPayload): 1 | 2;
+/**
+ * Safely extract x402 version from an unknown payment object.
+ * Provides backward compatibility for pre-versioning payloads.
+ *
+ * - Returns 1 if x402Version is undefined/missing (backward compatibility)
+ * - Returns 1 or 2 for valid versions
+ * - Throws descriptive error for unsupported versions
+ *
+ * Use this at method entry points to validate version before processing.
+ * For type-safe access after validation, use getVersion() instead.
+ */
+declare function getVersionSafe(payment: unknown): 1 | 2;
+/**
+ * Exhaustiveness check for discriminated unions.
+ * TypeScript will error at compile time if not all union members are handled.
+ *
+ * @example
+ * function handlePayload(payload: PaymentPayload) {
+ *   switch (payload.x402Version) {
+ *     case 1: return handleV1(payload);
+ *     case 2: return handleV2(payload);
+ *     default: return assertNever(payload);
+ *   }
+ * }
+ */
+declare function assertNever(value: never, message?: string): never;
 
 /**
  * Claims module for reporting failures and managing refunds
@@ -516,13 +640,10 @@ declare function createPaymentContext(settleResponse: {
     transaction: string;
     payer: string;
     network: string;
-}, paymentPayload: {
-    payload: {
-        authorization: {
-            amount: string;
-            asset: string;
-        };
-    };
+}, paymentPayload: Record<string, unknown>, requirements?: {
+    maxAmountRequired?: string;
+    amount?: string;
+    asset?: string;
 }): PaymentContext;
 interface PaymentMiddlewareConfig {
     /** Facilitator instance or URL */
@@ -623,4 +744,4 @@ declare function honoPaymentMiddleware(config: HonoPaymentConfig): (c: HonoConte
     json: (body: unknown, status?: number) => Response;
 }, next: () => Promise<void>) => Promise<Response | undefined>;
 
-export { type ClaimHistoryItem, type ClaimableItem, ConfigurationError, type ExecuteClaimParams, type ExecuteClaimResponse, type FacilitatorConfig, FacilitatorError, type GetClaimHistoryResponse, type GetClaimableParams, type GetClaimableResponse, type HonoPaymentConfig, type HonoRefundConfig, NETWORKS, NetworkError, type NetworkInfo, type NetworkType, OpenFacilitator, type PaymentAuthorization, type PaymentContext, type PaymentKind, type PaymentMiddlewareConfig, type PaymentPayload, type PaymentRequest, type PaymentRequirements, type RefundProtectionConfig, type ReportFailureParams, type ReportFailureResponse, type SettleResponse, SettlementError, type SupportedResponse, VerificationError, type VerifyResponse, createDefaultFacilitator, createPaymentContext, createPaymentMiddleware, createRefundMiddleware, executeClaim, getClaimHistory, getClaimable, getMainnets, getNetwork, getNetworkType, getTestnets, honoPaymentMiddleware, honoRefundMiddleware, isPaymentPayload, isValidNetwork, reportFailure, toV1NetworkId, toV2NetworkId, withRefundProtection };
+export { type ClaimHistoryItem, type ClaimableItem, ConfigurationError, type ExecuteClaimParams, type ExecuteClaimResponse, type FacilitatorConfig, FacilitatorError, type GetClaimHistoryResponse, type GetClaimableParams, type GetClaimableResponse, type HonoPaymentConfig, type HonoRefundConfig, NETWORKS, NetworkError, type NetworkInfo, type NetworkType, OpenFacilitator, type PaymentAuthorization, type PaymentContext, type PaymentKind, type PaymentMiddlewareConfig, type PaymentPayload, type PaymentPayloadV1, type PaymentPayloadV2, type PaymentRequest, type PaymentRequirements, type PaymentRequirementsV1, type PaymentRequirementsV2, type RefundProtectionConfig, type ReportFailureParams, type ReportFailureResponse, type SettleResponse, SettlementError, type SupportedResponse, VerificationError, type VerifyResponse, assertNever, createDefaultFacilitator, createPaymentContext, createPaymentMiddleware, createRefundMiddleware, executeClaim, getClaimHistory, getClaimable, getMainnets, getNetwork, getNetworkType, getSchemeNetwork, getTestnets, getVersion, getVersionSafe, honoPaymentMiddleware, honoRefundMiddleware, isPaymentPayload, isPaymentPayloadV1, isPaymentPayloadV2, isPaymentRequirementsV1, isPaymentRequirementsV2, isValidNetwork, reportFailure, toV1NetworkId, toV2NetworkId, withRefundProtection };

package/dist/index.d.ts

@@ -7,15 +7,14 @@ interface FacilitatorConfig {
     headers?: Record<string, string>;
 }
 /**
- * Payment payload for verification/settlement
- * Supports both x402 v1 and v2 formats
+ * Payment payload for x402 version 1. Uses flat structure with scheme/network at top level.
  */
-interface PaymentPayload {
-    /** x402 version (1 or 2) */
-    x402Version: 1 | 2;
+interface PaymentPayloadV1 {
+    /** x402 version 1 */
+    x402Version: 1;
     /** Payment scheme (e.g., "exact") */
     scheme: string;
-    /** Network identifier - v1: "base", v2: "eip155:8453" */
+    /** Network identifier - v1 format (e.g., "base", "solana") */
     network: string;
     /** Payment details */
     payload: {
@@ -25,6 +24,48 @@ interface PaymentPayload {
         authorization: PaymentAuthorization;
     };
 }
+/**
+ * Payment payload for x402 version 2. Uses nested `accepted` structure per @x402/core spec.
+ */
+interface PaymentPayloadV2 {
+    /** x402 version 2 */
+    x402Version: 2;
+    /** Optional resource being paid for */
+    resource?: {
+        /** Resource URL */
+        url: string;
+        /** Human-readable description */
+        description?: string;
+        /** MIME type of resource */
+        mimeType?: string;
+    };
+    /** Accepted payment requirements (contains scheme, network, amount, etc.) */
+    accepted: {
+        /** Payment scheme (e.g., "exact") */
+        scheme: string;
+        /** Network identifier - CAIP-2 format (e.g., "eip155:8453") */
+        network: string;
+        /** Token/asset address */
+        asset: string;
+        /** Amount in base units */
+        amount: string;
+        /** Recipient address */
+        payTo: string;
+        /** Maximum timeout in seconds */
+        maxTimeoutSeconds: number;
+        /** Extra data */
+        extra?: Record<string, unknown>;
+    };
+    /** Payment details (signature, authorization, etc.) */
+    payload: Record<string, unknown>;
+    /** Optional extensions */
+    extensions?: Record<string, unknown>;
+}
+/**
+ * Payment payload union - supports both x402 v1 and v2 formats.
+ * Use x402Version to discriminate between versions.
+ */
+type PaymentPayload = PaymentPayloadV1 | PaymentPayloadV2;
 interface PaymentAuthorization {
     /** Sender address */
     from: string;
@@ -44,10 +85,9 @@ interface PaymentAuthorization {
     [key: string]: unknown;
 }
 /**
- * Payment requirements from the server/resource
- * Used for validation during verify/settle
+ * Payment requirements for x402 version 1. Uses maxAmountRequired field.
  */
-interface PaymentRequirements {
+interface PaymentRequirementsV1 {
     /** Payment scheme (e.g., "exact") */
     scheme: string;
     /** Network identifier */
@@ -71,6 +111,31 @@ interface PaymentRequirements {
     /** Extra data */
     extra?: Record<string, unknown>;
 }
+/**
+ * Payment requirements for x402 version 2.
+ * Uses 'amount' instead of 'maxAmountRequired' and has stricter required fields.
+ */
+interface PaymentRequirementsV2 {
+    /** Payment scheme (e.g., "exact") */
+    scheme: string;
+    /** Network identifier - v2 CAIP-2 format */
+    network: string;
+    /** Amount required in base units */
+    amount: string;
+    /** Token/asset address */
+    asset: string;
+    /** Recipient address */
+    payTo: string;
+    /** Maximum timeout in seconds */
+    maxTimeoutSeconds: number;
+    /** Extra data */
+    extra: Record<string, unknown>;
+}
+/**
+ * Payment requirements union - supports both v1 and v2 formats.
+ * V1 uses maxAmountRequired, V2 uses amount.
+ */
+type PaymentRequirements = PaymentRequirementsV1 | PaymentRequirementsV2;
 interface VerifyResponse {
     /** Whether the payment is valid */
     isValid: boolean;
@@ -256,6 +321,65 @@ declare function getTestnets(): NetworkInfo[];
  * Type guard for checking if value is a valid payment payload
  */
 declare function isPaymentPayload(value: unknown): value is PaymentPayload;
+/**
+ * Type guard for PaymentPayloadV1 (x402 version 1).
+ * Narrows PaymentPayload to v1 format with flat structure.
+ */
+declare function isPaymentPayloadV1(value: unknown): value is PaymentPayloadV1;
+/**
+ * Type guard for PaymentPayloadV2 (x402 version 2).
+ * Narrows PaymentPayload to v2 format with nested `accepted` structure.
+ */
+declare function isPaymentPayloadV2(value: unknown): value is PaymentPayloadV2;
+/**
+ * Type guard for PaymentRequirementsV1.
+ * V1 requirements have maxAmountRequired field.
+ */
+declare function isPaymentRequirementsV1(value: unknown): value is PaymentRequirementsV1;
+/**
+ * Type guard for PaymentRequirementsV2.
+ * V2 requirements have amount but NOT maxAmountRequired.
+ */
+declare function isPaymentRequirementsV2(value: unknown): value is PaymentRequirementsV2;
+/**
+ * Extract scheme and network from PaymentPayload (version-agnostic).
+ * v1 has these at top level, v2 has them nested in `accepted`.
+ */
+declare function getSchemeNetwork(payload: PaymentPayload): {
+    scheme: string;
+    network: string;
+};
+/**
+ * Get x402 version from PaymentPayload.
+ * Returns literal type 1 | 2 for exhaustiveness checking in switch statements.
+ */
+declare function getVersion(payload: PaymentPayload): 1 | 2;
+/**
+ * Safely extract x402 version from an unknown payment object.
+ * Provides backward compatibility for pre-versioning payloads.
+ *
+ * - Returns 1 if x402Version is undefined/missing (backward compatibility)
+ * - Returns 1 or 2 for valid versions
+ * - Throws descriptive error for unsupported versions
+ *
+ * Use this at method entry points to validate version before processing.
+ * For type-safe access after validation, use getVersion() instead.
+ */
+declare function getVersionSafe(payment: unknown): 1 | 2;
+/**
+ * Exhaustiveness check for discriminated unions.
+ * TypeScript will error at compile time if not all union members are handled.
+ *
+ * @example
+ * function handlePayload(payload: PaymentPayload) {
+ *   switch (payload.x402Version) {
+ *     case 1: return handleV1(payload);
+ *     case 2: return handleV2(payload);
+ *     default: return assertNever(payload);
+ *   }
+ * }
+ */
+declare function assertNever(value: never, message?: string): never;
 
 /**
  * Claims module for reporting failures and managing refunds
@@ -516,13 +640,10 @@ declare function createPaymentContext(settleResponse: {
     transaction: string;
     payer: string;
     network: string;
-}, paymentPayload: {
-    payload: {
-        authorization: {
-            amount: string;
-            asset: string;
-        };
-    };
+}, paymentPayload: Record<string, unknown>, requirements?: {
+    maxAmountRequired?: string;
+    amount?: string;
+    asset?: string;
 }): PaymentContext;
 interface PaymentMiddlewareConfig {
     /** Facilitator instance or URL */
@@ -623,4 +744,4 @@ declare function honoPaymentMiddleware(config: HonoPaymentConfig): (c: HonoConte
     json: (body: unknown, status?: number) => Response;
 }, next: () => Promise<void>) => Promise<Response | undefined>;
 
-export { type ClaimHistoryItem, type ClaimableItem, ConfigurationError, type ExecuteClaimParams, type ExecuteClaimResponse, type FacilitatorConfig, FacilitatorError, type GetClaimHistoryResponse, type GetClaimableParams, type GetClaimableResponse, type HonoPaymentConfig, type HonoRefundConfig, NETWORKS, NetworkError, type NetworkInfo, type NetworkType, OpenFacilitator, type PaymentAuthorization, type PaymentContext, type PaymentKind, type PaymentMiddlewareConfig, type PaymentPayload, type PaymentRequest, type PaymentRequirements, type RefundProtectionConfig, type ReportFailureParams, type ReportFailureResponse, type SettleResponse, SettlementError, type SupportedResponse, VerificationError, type VerifyResponse, createDefaultFacilitator, createPaymentContext, createPaymentMiddleware, createRefundMiddleware, executeClaim, getClaimHistory, getClaimable, getMainnets, getNetwork, getNetworkType, getTestnets, honoPaymentMiddleware, honoRefundMiddleware, isPaymentPayload, isValidNetwork, reportFailure, toV1NetworkId, toV2NetworkId, withRefundProtection };
+export { type ClaimHistoryItem, type ClaimableItem, ConfigurationError, type ExecuteClaimParams, type ExecuteClaimResponse, type FacilitatorConfig, FacilitatorError, type GetClaimHistoryResponse, type GetClaimableParams, type GetClaimableResponse, type HonoPaymentConfig, type HonoRefundConfig, NETWORKS, NetworkError, type NetworkInfo, type NetworkType, OpenFacilitator, type PaymentAuthorization, type PaymentContext, type PaymentKind, type PaymentMiddlewareConfig, type PaymentPayload, type PaymentPayloadV1, type PaymentPayloadV2, type PaymentRequest, type PaymentRequirements, type PaymentRequirementsV1, type PaymentRequirementsV2, type RefundProtectionConfig, type ReportFailureParams, type ReportFailureResponse, type SettleResponse, SettlementError, type SupportedResponse, VerificationError, type VerifyResponse, assertNever, createDefaultFacilitator, createPaymentContext, createPaymentMiddleware, createRefundMiddleware, executeClaim, getClaimHistory, getClaimable, getMainnets, getNetwork, getNetworkType, getSchemeNetwork, getTestnets, getVersion, getVersionSafe, honoPaymentMiddleware, honoRefundMiddleware, isPaymentPayload, isPaymentPayloadV1, isPaymentPayloadV2, isPaymentRequirementsV1, isPaymentRequirementsV2, isValidNetwork, reportFailure, toV1NetworkId, toV2NetworkId, withRefundProtection };

package/dist/index.js

@@ -27,6 +27,7 @@ __export(index_exports, {
   OpenFacilitator: () => OpenFacilitator,
   SettlementError: () => SettlementError,
   VerificationError: () => VerificationError,
+  assertNever: () => assertNever,
   createDefaultFacilitator: () => createDefaultFacilitator,
   createPaymentContext: () => createPaymentContext,
   createPaymentMiddleware: () => createPaymentMiddleware,
@@ -37,10 +38,17 @@ __export(index_exports, {
   getMainnets: () => getMainnets,
   getNetwork: () => getNetwork,
   getNetworkType: () => getNetworkType,
+  getSchemeNetwork: () => getSchemeNetwork,
   getTestnets: () => getTestnets,
+  getVersion: () => getVersion,
+  getVersionSafe: () => getVersionSafe,
   honoPaymentMiddleware: () => honoPaymentMiddleware,
   honoRefundMiddleware: () => honoRefundMiddleware,
   isPaymentPayload: () => isPaymentPayload,
+  isPaymentPayloadV1: () => isPaymentPayloadV1,
+  isPaymentPayloadV2: () => isPaymentPayloadV2,
+  isPaymentRequirementsV1: () => isPaymentRequirementsV1,
+  isPaymentRequirementsV2: () => isPaymentRequirementsV2,
   isValidNetwork: () => isValidNetwork,
   reportFailure: () => reportFailure,
   toV1NetworkId: () => toV1NetworkId,
@@ -94,7 +102,66 @@ function buildUrl(baseUrl, path) {
 function isPaymentPayload(value) {
   if (!value || typeof value !== "object") return false;
   const obj = value;
-  return (obj.x402Version === 1 || obj.x402Version === 2) && typeof obj.scheme === "string" && typeof obj.network === "string" && obj.payload !== void 0;
+  if (obj.x402Version === 1) {
+    return typeof obj.scheme === "string" && typeof obj.network === "string" && obj.payload !== void 0;
+  } else if (obj.x402Version === 2) {
+    const accepted = obj.accepted;
+    return accepted !== void 0 && typeof accepted === "object" && typeof accepted.scheme === "string" && typeof accepted.network === "string" && obj.payload !== void 0;
+  }
+  return false;
+}
+function isPaymentPayloadV1(value) {
+  if (!value || typeof value !== "object") return false;
+  const obj = value;
+  return obj.x402Version === 1 && typeof obj.scheme === "string" && typeof obj.network === "string" && obj.payload !== void 0 && typeof obj.payload === "object";
+}
+function isPaymentPayloadV2(value) {
+  if (!value || typeof value !== "object") return false;
+  const obj = value;
+  if (obj.x402Version !== 2) return false;
+  const accepted = obj.accepted;
+  return accepted !== void 0 && typeof accepted === "object" && typeof accepted.scheme === "string" && typeof accepted.network === "string" && typeof accepted.asset === "string" && typeof accepted.amount === "string" && typeof accepted.payTo === "string" && typeof accepted.maxTimeoutSeconds === "number" && obj.payload !== void 0;
+}
+function isPaymentRequirementsV1(value) {
+  if (!value || typeof value !== "object") return false;
+  return "maxAmountRequired" in value;
+}
+function isPaymentRequirementsV2(value) {
+  if (!value || typeof value !== "object") return false;
+  return "amount" in value && !("maxAmountRequired" in value);
+}
+function getSchemeNetwork(payload) {
+  if (payload.x402Version === 1) {
+    return {
+      scheme: payload.scheme,
+      network: payload.network
+    };
+  } else {
+    return {
+      scheme: payload.accepted.scheme,
+      network: payload.accepted.network
+    };
+  }
+}
+function getVersion(payload) {
+  return payload.x402Version;
+}
+function getVersionSafe(payment) {
+  if (!payment || typeof payment !== "object") {
+    return 1;
+  }
+  const obj = payment;
+  const version = obj.x402Version;
+  if (version === void 0) return 1;
+  if (version === 1 || version === 2) return version;
+  throw new Error(
+    `Unsupported x402 version: ${version}. SDK supports versions 1 and 2.`
+  );
+}
+function assertNever(value, message) {
+  throw new Error(
+    message ?? `Unhandled discriminated union member: ${JSON.stringify(value)}`
+  );
 }
 
 // src/client.ts
@@ -124,8 +191,9 @@ var OpenFacilitator = class {
    */
   async verify(payment, requirements) {
     try {
+      const version = getVersionSafe(payment);
       const body = {
-        x402Version: payment.x402Version,
+        x402Version: version,
         paymentPayload: payment,
         paymentRequirements: requirements
       };
@@ -149,8 +217,9 @@ var OpenFacilitator = class {
    */
   async settle(payment, requirements) {
     try {
+      const version = getVersionSafe(payment);
       const body = {
-        x402Version: payment.x402Version,
+        x402Version: version,
         paymentPayload: payment,
         paymentRequirements: requirements
       };
@@ -559,12 +628,16 @@ function honoRefundMiddleware(config) {
     }
   };
 }
-function createPaymentContext(settleResponse, paymentPayload) {
+function createPaymentContext(settleResponse, paymentPayload, requirements) {
+  const payload = paymentPayload.payload;
+  const authorization = payload?.authorization;
+  const amount = authorization?.amount || payload?.amount || requirements?.amount || requirements?.maxAmountRequired || "0";
+  const asset = authorization?.asset || payload?.asset || requirements?.asset || "";
   return {
     transactionHash: settleResponse.transaction,
     userWallet: settleResponse.payer,
-    amount: paymentPayload.payload.authorization.amount,
-    asset: paymentPayload.payload.authorization.asset,
+    amount,
+    asset,
     network: settleResponse.network
   };
 }
@@ -587,16 +660,28 @@ function createPaymentMiddleware(config) {
             if (config.refundProtection) {
               extra.supportsRefunds = true;
             }
-            return {
-              scheme: requirements2.scheme,
-              network: requirements2.network,
-              maxAmountRequired: requirements2.maxAmountRequired,
-              asset: requirements2.asset,
-              payTo: requirements2.payTo,
-              resource: requirements2.resource || req.url,
-              description: requirements2.description,
-              ...Object.keys(extra).length > 0 ? { extra } : {}
-            };
+            if ("maxAmountRequired" in requirements2) {
+              return {
+                scheme: requirements2.scheme,
+                network: requirements2.network,
+                maxAmountRequired: requirements2.maxAmountRequired,
+                asset: requirements2.asset,
+                payTo: requirements2.payTo,
+                resource: requirements2.resource || req.url,
+                description: requirements2.description,
+                ...Object.keys(extra).length > 0 ? { extra } : {}
+              };
+            } else {
+              return {
+                scheme: requirements2.scheme,
+                network: requirements2.network,
+                amount: requirements2.amount,
+                asset: requirements2.asset,
+                payTo: requirements2.payTo,
+                maxTimeoutSeconds: requirements2.maxTimeoutSeconds,
+                extra: { ...extra, ...requirements2.extra }
+              };
+            }
           });
           res.status(402).json({
             x402Version: 2,
@@ -635,7 +720,7 @@ function createPaymentMiddleware(config) {
         });
         return;
       }
-      const paymentContext = createPaymentContext(settleResult, paymentPayload);
+      const paymentContext = createPaymentContext(settleResult, paymentPayload, requirements);
       req.paymentContext = paymentContext;
       if (res.locals) {
         res.locals.paymentContext = paymentContext;
@@ -694,16 +779,28 @@ function honoPaymentMiddleware(config) {
         if (config.refundProtection) {
           extra.supportsRefunds = true;
         }
-        return {
-          scheme: requirements2.scheme,
-          network: requirements2.network,
-          maxAmountRequired: requirements2.maxAmountRequired,
-          asset: requirements2.asset,
-          payTo: requirements2.payTo,
-          resource: requirements2.resource || c.req.url,
-          description: requirements2.description,
-          ...Object.keys(extra).length > 0 ? { extra } : {}
-        };
+        if ("maxAmountRequired" in requirements2) {
+          return {
+            scheme: requirements2.scheme,
+            network: requirements2.network,
+            maxAmountRequired: requirements2.maxAmountRequired,
+            asset: requirements2.asset,
+            payTo: requirements2.payTo,
+            resource: requirements2.resource || c.req.url,
+            description: requirements2.description,
+            ...Object.keys(extra).length > 0 ? { extra } : {}
+          };
+        } else {
+          return {
+            scheme: requirements2.scheme,
+            network: requirements2.network,
+            amount: requirements2.amount,
+            asset: requirements2.asset,
+            payTo: requirements2.payTo,
+            maxTimeoutSeconds: requirements2.maxTimeoutSeconds,
+            extra: { ...extra, ...requirements2.extra }
+          };
+        }
       });
       return c.json({
         x402Version: 2,
@@ -737,7 +834,7 @@ function honoPaymentMiddleware(config) {
         reason: settleResult.errorReason
       }, 402);
     }
-    const paymentContext = createPaymentContext(settleResult, paymentPayload);
+    const paymentContext = createPaymentContext(settleResult, paymentPayload, requirements);
     c.set("paymentContext", paymentContext);
     if (config.refundProtection) {
       const refundConfig = config.refundProtection;
@@ -785,6 +882,7 @@ function honoPaymentMiddleware(config) {
   OpenFacilitator,
   SettlementError,
   VerificationError,
+  assertNever,
   createDefaultFacilitator,
   createPaymentContext,
   createPaymentMiddleware,
@@ -795,10 +893,17 @@ function honoPaymentMiddleware(config) {
   getMainnets,
   getNetwork,
   getNetworkType,
+  getSchemeNetwork,
   getTestnets,
+  getVersion,
+  getVersionSafe,
   honoPaymentMiddleware,
   honoRefundMiddleware,
   isPaymentPayload,
+  isPaymentPayloadV1,
+  isPaymentPayloadV2,
+  isPaymentRequirementsV1,
+  isPaymentRequirementsV2,
   isValidNetwork,
   reportFailure,
   toV1NetworkId,

package/dist/index.mjs

@@ -43,7 +43,66 @@ function buildUrl(baseUrl, path) {
 function isPaymentPayload(value) {
   if (!value || typeof value !== "object") return false;
   const obj = value;
-  return (obj.x402Version === 1 || obj.x402Version === 2) && typeof obj.scheme === "string" && typeof obj.network === "string" && obj.payload !== void 0;
+  if (obj.x402Version === 1) {
+    return typeof obj.scheme === "string" && typeof obj.network === "string" && obj.payload !== void 0;
+  } else if (obj.x402Version === 2) {
+    const accepted = obj.accepted;
+    return accepted !== void 0 && typeof accepted === "object" && typeof accepted.scheme === "string" && typeof accepted.network === "string" && obj.payload !== void 0;
+  }
+  return false;
+}
+function isPaymentPayloadV1(value) {
+  if (!value || typeof value !== "object") return false;
+  const obj = value;
+  return obj.x402Version === 1 && typeof obj.scheme === "string" && typeof obj.network === "string" && obj.payload !== void 0 && typeof obj.payload === "object";
+}
+function isPaymentPayloadV2(value) {
+  if (!value || typeof value !== "object") return false;
+  const obj = value;
+  if (obj.x402Version !== 2) return false;
+  const accepted = obj.accepted;
+  return accepted !== void 0 && typeof accepted === "object" && typeof accepted.scheme === "string" && typeof accepted.network === "string" && typeof accepted.asset === "string" && typeof accepted.amount === "string" && typeof accepted.payTo === "string" && typeof accepted.maxTimeoutSeconds === "number" && obj.payload !== void 0;
+}
+function isPaymentRequirementsV1(value) {
+  if (!value || typeof value !== "object") return false;
+  return "maxAmountRequired" in value;
+}
+function isPaymentRequirementsV2(value) {
+  if (!value || typeof value !== "object") return false;
+  return "amount" in value && !("maxAmountRequired" in value);
+}
+function getSchemeNetwork(payload) {
+  if (payload.x402Version === 1) {
+    return {
+      scheme: payload.scheme,
+      network: payload.network
+    };
+  } else {
+    return {
+      scheme: payload.accepted.scheme,
+      network: payload.accepted.network
+    };
+  }
+}
+function getVersion(payload) {
+  return payload.x402Version;
+}
+function getVersionSafe(payment) {
+  if (!payment || typeof payment !== "object") {
+    return 1;
+  }
+  const obj = payment;
+  const version = obj.x402Version;
+  if (version === void 0) return 1;
+  if (version === 1 || version === 2) return version;
+  throw new Error(
+    `Unsupported x402 version: ${version}. SDK supports versions 1 and 2.`
+  );
+}
+function assertNever(value, message) {
+  throw new Error(
+    message ?? `Unhandled discriminated union member: ${JSON.stringify(value)}`
+  );
 }
 
 // src/client.ts
@@ -73,8 +132,9 @@ var OpenFacilitator = class {
    */
   async verify(payment, requirements) {
     try {
+      const version = getVersionSafe(payment);
       const body = {
-        x402Version: payment.x402Version,
+        x402Version: version,
         paymentPayload: payment,
         paymentRequirements: requirements
       };
@@ -98,8 +158,9 @@ var OpenFacilitator = class {
    */
   async settle(payment, requirements) {
     try {
+      const version = getVersionSafe(payment);
       const body = {
-        x402Version: payment.x402Version,
+        x402Version: version,
         paymentPayload: payment,
         paymentRequirements: requirements
       };
@@ -508,12 +569,16 @@ function honoRefundMiddleware(config) {
     }
   };
 }
-function createPaymentContext(settleResponse, paymentPayload) {
+function createPaymentContext(settleResponse, paymentPayload, requirements) {
+  const payload = paymentPayload.payload;
+  const authorization = payload?.authorization;
+  const amount = authorization?.amount || payload?.amount || requirements?.amount || requirements?.maxAmountRequired || "0";
+  const asset = authorization?.asset || payload?.asset || requirements?.asset || "";
   return {
     transactionHash: settleResponse.transaction,
     userWallet: settleResponse.payer,
-    amount: paymentPayload.payload.authorization.amount,
-    asset: paymentPayload.payload.authorization.asset,
+    amount,
+    asset,
     network: settleResponse.network
   };
 }
@@ -536,16 +601,28 @@ function createPaymentMiddleware(config) {
             if (config.refundProtection) {
               extra.supportsRefunds = true;
             }
-            return {
-              scheme: requirements2.scheme,
-              network: requirements2.network,
-              maxAmountRequired: requirements2.maxAmountRequired,
-              asset: requirements2.asset,
-              payTo: requirements2.payTo,
-              resource: requirements2.resource || req.url,
-              description: requirements2.description,
-              ...Object.keys(extra).length > 0 ? { extra } : {}
-            };
+            if ("maxAmountRequired" in requirements2) {
+              return {
+                scheme: requirements2.scheme,
+                network: requirements2.network,
+                maxAmountRequired: requirements2.maxAmountRequired,
+                asset: requirements2.asset,
+                payTo: requirements2.payTo,
+                resource: requirements2.resource || req.url,
+                description: requirements2.description,
+                ...Object.keys(extra).length > 0 ? { extra } : {}
+              };
+            } else {
+              return {
+                scheme: requirements2.scheme,
+                network: requirements2.network,
+                amount: requirements2.amount,
+                asset: requirements2.asset,
+                payTo: requirements2.payTo,
+                maxTimeoutSeconds: requirements2.maxTimeoutSeconds,
+                extra: { ...extra, ...requirements2.extra }
+              };
+            }
           });
           res.status(402).json({
             x402Version: 2,
@@ -584,7 +661,7 @@ function createPaymentMiddleware(config) {
         });
         return;
       }
-      const paymentContext = createPaymentContext(settleResult, paymentPayload);
+      const paymentContext = createPaymentContext(settleResult, paymentPayload, requirements);
       req.paymentContext = paymentContext;
       if (res.locals) {
         res.locals.paymentContext = paymentContext;
@@ -643,16 +720,28 @@ function honoPaymentMiddleware(config) {
         if (config.refundProtection) {
           extra.supportsRefunds = true;
         }
-        return {
-          scheme: requirements2.scheme,
-          network: requirements2.network,
-          maxAmountRequired: requirements2.maxAmountRequired,
-          asset: requirements2.asset,
-          payTo: requirements2.payTo,
-          resource: requirements2.resource || c.req.url,
-          description: requirements2.description,
-          ...Object.keys(extra).length > 0 ? { extra } : {}
-        };
+        if ("maxAmountRequired" in requirements2) {
+          return {
+            scheme: requirements2.scheme,
+            network: requirements2.network,
+            maxAmountRequired: requirements2.maxAmountRequired,
+            asset: requirements2.asset,
+            payTo: requirements2.payTo,
+            resource: requirements2.resource || c.req.url,
+            description: requirements2.description,
+            ...Object.keys(extra).length > 0 ? { extra } : {}
+          };
+        } else {
+          return {
+            scheme: requirements2.scheme,
+            network: requirements2.network,
+            amount: requirements2.amount,
+            asset: requirements2.asset,
+            payTo: requirements2.payTo,
+            maxTimeoutSeconds: requirements2.maxTimeoutSeconds,
+            extra: { ...extra, ...requirements2.extra }
+          };
+        }
       });
       return c.json({
         x402Version: 2,
@@ -686,7 +775,7 @@ function honoPaymentMiddleware(config) {
         reason: settleResult.errorReason
       }, 402);
     }
-    const paymentContext = createPaymentContext(settleResult, paymentPayload);
+    const paymentContext = createPaymentContext(settleResult, paymentPayload, requirements);
     c.set("paymentContext", paymentContext);
     if (config.refundProtection) {
       const refundConfig = config.refundProtection;
@@ -733,6 +822,7 @@ export {
   OpenFacilitator,
   SettlementError,
   VerificationError,
+  assertNever,
   createDefaultFacilitator,
   createPaymentContext,
   createPaymentMiddleware,
@@ -743,10 +833,17 @@ export {
   getMainnets,
   getNetwork,
   getNetworkType,
+  getSchemeNetwork,
   getTestnets,
+  getVersion,
+  getVersionSafe,
   honoPaymentMiddleware,
   honoRefundMiddleware,
   isPaymentPayload,
+  isPaymentPayloadV1,
+  isPaymentPayloadV2,
+  isPaymentRequirementsV1,
+  isPaymentRequirementsV2,
   isValidNetwork,
   reportFailure,
   toV1NetworkId,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfacilitator/sdk",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "description": "TypeScript SDK for x402 payment facilitation",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -8,13 +8,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts",
-    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
-    "test": "vitest",
-    "lint": "eslint src/",
-    "clean": "rm -rf dist"
-  },
   "keywords": [
     "x402",
     "payments",
@@ -37,5 +30,12 @@
   },
   "engines": {
     "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "test": "vitest",
+    "lint": "tsc --noEmit",
+    "clean": "rm -rf dist"
   }
-}
+}