@openfacilitator/sdk 0.2.0 → 0.5.0

package/dist/index.mjs

@@ -293,6 +293,422 @@ function getMainnets() {
 function getTestnets() {
   return NETWORKS.filter((n) => n.testnet);
 }
+
+// src/claims.ts
+async function reportFailure(params) {
+  const {
+    facilitatorUrl,
+    apiKey,
+    originalTxHash,
+    userWallet,
+    amount,
+    asset,
+    network,
+    reason
+  } = params;
+  const baseUrl = facilitatorUrl.replace(/\/$/, "");
+  try {
+    const response = await fetch(`${baseUrl}/claims/report-failure`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        "X-Server-Api-Key": apiKey
+      },
+      body: JSON.stringify({
+        originalTxHash,
+        userWallet,
+        amount,
+        asset,
+        network,
+        reason
+      })
+    });
+    const data = await response.json();
+    if (!response.ok) {
+      return {
+        success: false,
+        error: data.error || `HTTP ${response.status}`
+      };
+    }
+    return data;
+  } catch (error) {
+    return {
+      success: false,
+      error: error instanceof Error ? error.message : "Unknown error"
+    };
+  }
+}
+async function getClaimable(params) {
+  const { facilitatorUrl, wallet, facilitator } = params;
+  const baseUrl = facilitatorUrl.replace(/\/$/, "");
+  const queryParams = new URLSearchParams({ wallet });
+  if (facilitator) {
+    queryParams.set("facilitator", facilitator);
+  }
+  const response = await fetch(`${baseUrl}/api/claims?${queryParams.toString()}`);
+  const data = await response.json();
+  if (!response.ok) {
+    throw new Error(data.error || `HTTP ${response.status}`);
+  }
+  return data;
+}
+async function getClaimHistory(params) {
+  const { facilitatorUrl, wallet, facilitator } = params;
+  const baseUrl = facilitatorUrl.replace(/\/$/, "");
+  const queryParams = new URLSearchParams({ wallet });
+  if (facilitator) {
+    queryParams.set("facilitator", facilitator);
+  }
+  const response = await fetch(`${baseUrl}/api/claims/history?${queryParams.toString()}`);
+  const data = await response.json();
+  if (!response.ok) {
+    throw new Error(data.error || `HTTP ${response.status}`);
+  }
+  return data;
+}
+async function executeClaim(params) {
+  const { facilitatorUrl, claimId, signature } = params;
+  const baseUrl = facilitatorUrl.replace(/\/$/, "");
+  try {
+    const response = await fetch(`${baseUrl}/api/claims/${claimId}/execute`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify({ signature })
+    });
+    const data = await response.json();
+    if (!response.ok) {
+      return {
+        success: false,
+        error: data.error || `HTTP ${response.status}`
+      };
+    }
+    return data;
+  } catch (error) {
+    return {
+      success: false,
+      error: error instanceof Error ? error.message : "Unknown error"
+    };
+  }
+}
+
+// src/middleware.ts
+function withRefundProtection(config, handler) {
+  return async (context) => {
+    try {
+      return await handler(context);
+    } catch (error) {
+      const err = error instanceof Error ? error : new Error(String(error));
+      if (config.shouldReport && !config.shouldReport(err)) {
+        throw error;
+      }
+      try {
+        const result = await reportFailure({
+          facilitatorUrl: config.facilitatorUrl,
+          apiKey: config.apiKey,
+          originalTxHash: context.transactionHash,
+          userWallet: context.userWallet,
+          amount: context.amount,
+          asset: context.asset,
+          network: context.network,
+          reason: err.message
+        });
+        if (config.onReport) {
+          config.onReport(result.claimId, err);
+        }
+      } catch (reportError) {
+        if (config.onReportError) {
+          config.onReportError(
+            reportError instanceof Error ? reportError : new Error(String(reportError)),
+            err
+          );
+        }
+      }
+      throw error;
+    }
+  };
+}
+function createRefundMiddleware(config) {
+  return async (req, res, next) => {
+    const originalNext = next;
+    const paymentContext = res.locals?.paymentContext || req.paymentContext;
+    if (!paymentContext) {
+      return originalNext();
+    }
+    const wrappedNext = async (error) => {
+      if (error) {
+        const err = error instanceof Error ? error : new Error(String(error));
+        if (!config.shouldReport || config.shouldReport(err)) {
+          try {
+            const result = await reportFailure({
+              facilitatorUrl: config.facilitatorUrl,
+              apiKey: config.apiKey,
+              originalTxHash: paymentContext.transactionHash,
+              userWallet: paymentContext.userWallet,
+              amount: paymentContext.amount,
+              asset: paymentContext.asset,
+              network: paymentContext.network,
+              reason: err.message
+            });
+            if (config.onReport) {
+              config.onReport(result.claimId, err);
+            }
+          } catch (reportError) {
+            if (config.onReportError) {
+              config.onReportError(
+                reportError instanceof Error ? reportError : new Error(String(reportError)),
+                err
+              );
+            }
+          }
+        }
+      }
+      originalNext(error);
+    };
+    next = wrappedNext;
+    originalNext();
+  };
+}
+function honoRefundMiddleware(config) {
+  return async (c, next) => {
+    const paymentContext = config.getPaymentContext(c);
+    if (!paymentContext) {
+      return next();
+    }
+    try {
+      await next();
+    } catch (error) {
+      const err = error instanceof Error ? error : new Error(String(error));
+      if (!config.shouldReport || config.shouldReport(err)) {
+        try {
+          const result = await reportFailure({
+            facilitatorUrl: config.facilitatorUrl,
+            apiKey: config.apiKey,
+            originalTxHash: paymentContext.transactionHash,
+            userWallet: paymentContext.userWallet,
+            amount: paymentContext.amount,
+            asset: paymentContext.asset,
+            network: paymentContext.network,
+            reason: err.message
+          });
+          if (config.onReport) {
+            config.onReport(result.claimId, err);
+          }
+        } catch (reportError) {
+          if (config.onReportError) {
+            config.onReportError(
+              reportError instanceof Error ? reportError : new Error(String(reportError)),
+              err
+            );
+          }
+        }
+      }
+      throw error;
+    }
+  };
+}
+function createPaymentContext(settleResponse, paymentPayload) {
+  return {
+    transactionHash: settleResponse.transaction,
+    userWallet: settleResponse.payer,
+    amount: paymentPayload.payload.authorization.amount,
+    asset: paymentPayload.payload.authorization.asset,
+    network: settleResponse.network
+  };
+}
+function createPaymentMiddleware(config) {
+  const facilitator = typeof config.facilitator === "string" ? new OpenFacilitator({ url: config.facilitator }) : config.facilitator;
+  return async (req, res, next) => {
+    try {
+      const requirements = await config.getRequirements(req);
+      const paymentHeader = req.headers["x-payment"];
+      const paymentString = Array.isArray(paymentHeader) ? paymentHeader[0] : paymentHeader;
+      if (!paymentString) {
+        if (config.on402) {
+          await config.on402(req, res, requirements);
+        } else {
+          const extra = {
+            ...requirements.extra
+          };
+          if (config.refundProtection) {
+            extra.supportsRefunds = true;
+          }
+          res.status(402).json({
+            error: "Payment Required",
+            accepts: [{
+              scheme: requirements.scheme,
+              network: requirements.network,
+              maxAmountRequired: requirements.maxAmountRequired,
+              asset: requirements.asset,
+              payTo: requirements.payTo,
+              resource: requirements.resource || req.url,
+              description: requirements.description,
+              ...Object.keys(extra).length > 0 ? { extra } : {}
+            }]
+          });
+        }
+        return;
+      }
+      let paymentPayload;
+      try {
+        paymentPayload = JSON.parse(paymentString);
+        if (!isPaymentPayload(paymentPayload)) {
+          throw new Error("Invalid payment payload structure");
+        }
+      } catch {
+        res.status(400).json({ error: "Invalid X-PAYMENT header" });
+        return;
+      }
+      const verifyResult = await facilitator.verify(paymentPayload, requirements);
+      if (!verifyResult.isValid) {
+        res.status(402).json({
+          error: "Payment verification failed",
+          reason: verifyResult.invalidReason
+        });
+        return;
+      }
+      const settleResult = await facilitator.settle(paymentPayload, requirements);
+      if (!settleResult.success) {
+        res.status(402).json({
+          error: "Payment settlement failed",
+          reason: settleResult.errorReason
+        });
+        return;
+      }
+      const paymentContext = createPaymentContext(settleResult, paymentPayload);
+      req.paymentContext = paymentContext;
+      if (res.locals) {
+        res.locals.paymentContext = paymentContext;
+      }
+      if (config.refundProtection) {
+        const originalNext = next;
+        const refundConfig = config.refundProtection;
+        next = async (error) => {
+          if (error) {
+            const err = error instanceof Error ? error : new Error(String(error));
+            if (!refundConfig.shouldReport || refundConfig.shouldReport(err)) {
+              try {
+                const result = await reportFailure({
+                  facilitatorUrl: refundConfig.facilitatorUrl,
+                  apiKey: refundConfig.apiKey,
+                  originalTxHash: paymentContext.transactionHash,
+                  userWallet: paymentContext.userWallet,
+                  amount: paymentContext.amount,
+                  asset: paymentContext.asset,
+                  network: paymentContext.network,
+                  reason: err.message
+                });
+                if (refundConfig.onReport) {
+                  refundConfig.onReport(result.claimId, err);
+                }
+              } catch (reportError) {
+                if (refundConfig.onReportError) {
+                  refundConfig.onReportError(
+                    reportError instanceof Error ? reportError : new Error(String(reportError)),
+                    err
+                  );
+                }
+              }
+            }
+          }
+          originalNext(error);
+        };
+      }
+      next();
+    } catch (error) {
+      next(error);
+    }
+  };
+}
+function honoPaymentMiddleware(config) {
+  const facilitator = typeof config.facilitator === "string" ? new OpenFacilitator({ url: config.facilitator }) : config.facilitator;
+  return async (c, next) => {
+    const requirements = await config.getRequirements(c);
+    const paymentString = c.req.header("x-payment");
+    if (!paymentString) {
+      const extra = {
+        ...requirements.extra
+      };
+      if (config.refundProtection) {
+        extra.supportsRefunds = true;
+      }
+      return c.json({
+        error: "Payment Required",
+        accepts: [{
+          scheme: requirements.scheme,
+          network: requirements.network,
+          maxAmountRequired: requirements.maxAmountRequired,
+          asset: requirements.asset,
+          payTo: requirements.payTo,
+          resource: requirements.resource || c.req.url,
+          description: requirements.description,
+          ...Object.keys(extra).length > 0 ? { extra } : {}
+        }]
+      }, 402);
+    }
+    let paymentPayload;
+    try {
+      paymentPayload = JSON.parse(paymentString);
+      if (!isPaymentPayload(paymentPayload)) {
+        throw new Error("Invalid payment payload structure");
+      }
+    } catch {
+      return c.json({ error: "Invalid X-PAYMENT header" }, 400);
+    }
+    const verifyResult = await facilitator.verify(paymentPayload, requirements);
+    if (!verifyResult.isValid) {
+      return c.json({
+        error: "Payment verification failed",
+        reason: verifyResult.invalidReason
+      }, 402);
+    }
+    const settleResult = await facilitator.settle(paymentPayload, requirements);
+    if (!settleResult.success) {
+      return c.json({
+        error: "Payment settlement failed",
+        reason: settleResult.errorReason
+      }, 402);
+    }
+    const paymentContext = createPaymentContext(settleResult, paymentPayload);
+    c.set("paymentContext", paymentContext);
+    if (config.refundProtection) {
+      const refundConfig = config.refundProtection;
+      try {
+        await next();
+      } catch (error) {
+        const err = error instanceof Error ? error : new Error(String(error));
+        if (!refundConfig.shouldReport || refundConfig.shouldReport(err)) {
+          try {
+            const result = await reportFailure({
+              facilitatorUrl: refundConfig.facilitatorUrl,
+              apiKey: refundConfig.apiKey,
+              originalTxHash: paymentContext.transactionHash,
+              userWallet: paymentContext.userWallet,
+              amount: paymentContext.amount,
+              asset: paymentContext.asset,
+              network: paymentContext.network,
+              reason: err.message
+            });
+            if (refundConfig.onReport) {
+              refundConfig.onReport(result.claimId, err);
+            }
+          } catch (reportError) {
+            if (refundConfig.onReportError) {
+              refundConfig.onReportError(
+                reportError instanceof Error ? reportError : new Error(String(reportError)),
+                err
+              );
+            }
+          }
+        }
+        throw error;
+      }
+    } else {
+      await next();
+    }
+  };
+}
 export {
   ConfigurationError,
   FacilitatorError,
@@ -302,12 +718,22 @@ export {
   SettlementError,
   VerificationError,
   createDefaultFacilitator,
+  createPaymentContext,
+  createPaymentMiddleware,
+  createRefundMiddleware,
+  executeClaim,
+  getClaimHistory,
+  getClaimable,
   getMainnets,
   getNetwork,
   getNetworkType,
   getTestnets,
+  honoPaymentMiddleware,
+  honoRefundMiddleware,
   isPaymentPayload,
   isValidNetwork,
+  reportFailure,
   toV1NetworkId,
-  toV2NetworkId
+  toV2NetworkId,
+  withRefundProtection
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfacilitator/sdk",
-  "version": "0.2.0",
+  "version": "0.5.0",
   "description": "TypeScript SDK for x402 payment facilitation",
   "main": "dist/index.js",
   "module": "dist/index.mjs",