@faremeter/middleware 0.4.0 → 0.6.0

package/dist/src/common.d.ts

@@ -0,0 +1,52 @@
+import { type x402PaymentRequirements, type x402PaymentPayload } from "@faremeter/types/x402";
+export declare function findMatchingPaymentRequirements(accepts: x402PaymentRequirements[], payload: x402PaymentPayload): {
+    scheme: string;
+    network: string;
+    maxAmountRequired: string;
+    resource: string;
+    description: string;
+    mimeType: string;
+    payTo: string;
+    maxTimeoutSeconds: number;
+    asset: string;
+    outputSchema?: object;
+    extra?: object;
+} | undefined;
+export declare function gateGetPaymentRequiredResponse(res: Response): void;
+export type RelaxedRequirements = Partial<x402PaymentRequirements>;
+type getPaymentRequiredResponseArgs = {
+    facilitatorURL: string;
+    accepts: RelaxedRequirements[];
+    resource: string;
+};
+export declare function getPaymentRequiredResponse(args: getPaymentRequiredResponseArgs): Promise<{
+    x402Version: number;
+    accepts: {
+        scheme: string;
+        network: string;
+        maxAmountRequired: string;
+        resource: string;
+        description: string;
+        mimeType: string;
+        payTo: string;
+        maxTimeoutSeconds: number;
+        asset: string;
+        outputSchema?: object;
+        extra?: object;
+    }[];
+    error?: string;
+}>;
+type PossibleStatusCodes = 402;
+type PossibleJSONResponse = object;
+export type CommonMiddlewareArgs = {
+    facilitatorURL: string;
+    accepts: RelaxedRequirements[];
+};
+export type HandleMiddlewareRequestArgs<MiddlewareResponse = unknown> = CommonMiddlewareArgs & {
+    resource: string;
+    getHeader: (key: string) => string | undefined;
+    sendJSONResponse: (status: PossibleStatusCodes, obj: PossibleJSONResponse) => MiddlewareResponse;
+};
+export declare function handleMiddlewareRequest<MiddlewareResponse>(args: HandleMiddlewareRequestArgs<MiddlewareResponse>): Promise<MiddlewareResponse | undefined>;
+export {};
+//# sourceMappingURL=common.d.ts.map

package/dist/src/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/common.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EAKxB,MAAM,uBAAuB,CAAC;AAI/B,wBAAgB,+BAA+B,CAC7C,OAAO,EAAE,uBAAuB,EAAE,EAClC,OAAO,EAAE,kBAAkB;;;;;;;;;;;;cA6B5B;AAED,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,QAAQ,QAS3D;AAED,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;AAEnE,KAAK,8BAA8B,GAAG;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wBAAsB,0BAA0B,CAC9C,IAAI,EAAE,8BAA8B;;;;;;;;;;;;oBApCkC,CAAC;aAIhE,CAAC;;;GA8DT;AAED,KAAK,mBAAmB,GAAG,GAAG,CAAC;AAC/B,KAAK,oBAAoB,GAAG,MAAM,CAAC;AAEnC,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,mBAAmB,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,2BAA2B,CAAC,kBAAkB,GAAG,OAAO,IAClE,oBAAoB,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;IAC/C,gBAAgB,EAAE,CAChB,MAAM,EAAE,mBAAmB,EAC3B,GAAG,EAAE,oBAAoB,KACtB,kBAAkB,CAAC;CACzB,CAAC;AAEJ,wBAAsB,uBAAuB,CAAC,kBAAkB,EAC9D,IAAI,EAAE,2BAA2B,CAAC,kBAAkB,CAAC,2CA6DtD"}

package/dist/src/common.js

@@ -0,0 +1,96 @@
+import { isValidationError } from "@faremeter/types";
+import { x402PaymentRequiredResponse, x402PaymentHeaderToPayload, x402SettleRequest, x402SettleResponse, } from "@faremeter/types/x402";
+import { logger } from "./logger.js";
+export function findMatchingPaymentRequirements(accepts, payload) {
+    let possible;
+    if (payload.asset !== undefined) {
+        // Narrow based on the asset if available.
+        possible = accepts.filter((x) => x.network === payload.network &&
+            x.scheme === payload.scheme &&
+            x.asset === payload.asset);
+    }
+    else {
+        // Otherwise fall back to the behavior in coinbase/x402.
+        possible = accepts.filter((x) => x.network === payload.network && x.scheme === payload.scheme);
+    }
+    if (possible.length > 1) {
+        logger.warning(`found ${possible.length} ambiguous matching requirements for client payment: {*}`, payload);
+    }
+    // XXX - If there are more than one, this really should be an error.
+    // For now, err on the side of potential compatibility.
+    return possible[0];
+}
+export function gateGetPaymentRequiredResponse(res) {
+    if (res.status === 200) {
+        return;
+    }
+    const msg = `received a non success response to requirements request from facilitator: ${res.statusText} (${res.status})`;
+    logger.error(msg);
+    throw new Error(msg);
+}
+export async function getPaymentRequiredResponse(args) {
+    const accepts = args.accepts.map((x) => ({
+        ...x,
+        resource: x.resource ?? args.resource,
+    }));
+    const t = await fetch(`${args.facilitatorURL}/accepts`, {
+        method: "POST",
+        headers: {
+            Accept: "application/json",
+            "Content-Type": "application/json",
+        },
+        body: JSON.stringify({
+            x402Version: 1,
+            accepts,
+        }),
+    });
+    gateGetPaymentRequiredResponse(t);
+    const response = x402PaymentRequiredResponse(await t.json());
+    if (isValidationError(response)) {
+        throw new Error(`invalid payment requirements from facilitator: ${response.summary}`);
+    }
+    return response;
+}
+export async function handleMiddlewareRequest(args) {
+    // XXX - Temporarily request this every time.  This will be
+    // cached in future.
+    const paymentRequiredResponse = await getPaymentRequiredResponse(args);
+    const sendPaymentRequired = () => args.sendJSONResponse(402, paymentRequiredResponse);
+    const paymentHeader = args.getHeader("X-PAYMENT");
+    if (!paymentHeader) {
+        return sendPaymentRequired();
+    }
+    const payload = x402PaymentHeaderToPayload(paymentHeader);
+    if (isValidationError(payload)) {
+        logger.debug(`couldn't validate client payload: ${payload.summary}`);
+        return sendPaymentRequired();
+    }
+    const paymentRequirements = findMatchingPaymentRequirements(paymentRequiredResponse.accepts, payload);
+    if (!paymentRequirements) {
+        logger.warning(`couldn't find matching payment requirements for payload`, payload);
+        return sendPaymentRequired();
+    }
+    const settleRequest = {
+        x402Version: 1,
+        paymentHeader,
+        paymentRequirements,
+    };
+    const t = await fetch(`${args.facilitatorURL}/settle`, {
+        method: "POST",
+        headers: {
+            Accept: "application/json",
+            "Content-Type": "application/json",
+        },
+        body: JSON.stringify(settleRequest),
+    });
+    const settlementResponse = x402SettleResponse(await t.json());
+    if (isValidationError(settlementResponse)) {
+        const msg = `error getting response from facilitator for settlement: ${settlementResponse.summary}`;
+        logger.error(msg);
+        throw new Error(msg);
+    }
+    if (!settlementResponse.success) {
+        logger.warning("failed to settle payment: {error}", settlementResponse);
+        return sendPaymentRequired();
+    }
+}

package/dist/src/express.d.ts

@@ -1,9 +1,6 @@
-import { type RelaxedRequirements } from "./utils.js";
+import { type CommonMiddlewareArgs } from "./common.js";
 import type { NextFunction, Request, Response } from "express";
-type CreateMiddlewareArgs = {
-    accepts: RelaxedRequirements[];
-    facilitatorURL: string;
-};
-export declare function createMiddleware(args: CreateMiddlewareArgs): Promise<(req: Request, res: Response, next: NextFunction) => Promise<void>>;
+type createMiddlewareArgs = CommonMiddlewareArgs;
+export declare function createMiddleware(args: createMiddlewareArgs): Promise<(req: Request, res: Response, next: NextFunction) => Promise<void>>;
 export {};
 //# sourceMappingURL=express.d.ts.map

package/dist/src/express.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"express.d.ts","sourceRoot":"","sources":["../../src/express.ts"],"names":[],"mappings":"AAOA,OAAO,EAGL,KAAK,mBAAmB,EACzB,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE/D,KAAK,oBAAoB,GAAG;IAC1B,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC/B,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAuCF,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,iBAC5C,OAAO,OAAO,QAAQ,QAAQ,YAAY,oBAwD9D"}
+{"version":3,"file":"express.d.ts","sourceRoot":"","sources":["../../src/express.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,KAAK,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE/D,KAAK,oBAAoB,GAAG,oBAAoB,CAAC;AAEjD,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,iBAC5C,OAAO,OAAO,QAAQ,QAAQ,YAAY,oBAc9D"}

package/dist/src/express.js

@@ -1,70 +1,14 @@
-import { x402SettleRequest, x402SettleResponse, x402PaymentRequiredResponse, x402PaymentHeaderToPayload, isValidationError, } from "@faremeter/types";
-import { findMatchingPaymentRequirements, gateGetPaymentRequiredResponse, } from "./utils.js";
-async function getPaymentRequiredResponse(args, req) {
-    // XXX - This is tracking the behavior of coinbase/x402, but is
-    // probably too naive of a URL creator for the long run.
-    const resource = `${req.protocol}://${req.headers.host}${req.path}`;
-    const accepts = args.accepts.map((x) => ({
-        ...x,
-        resource: x.resource ?? resource,
-    }));
-    const t = await fetch(`${args.facilitatorURL}/accepts`, {
-        method: "POST",
-        headers: {
-            Accept: "application/json",
-            "Content-Type": "application/json",
-        },
-        body: JSON.stringify({
-            x402Version: 1,
-            accepts,
-        }),
-    });
-    gateGetPaymentRequiredResponse(t);
-    const response = x402PaymentRequiredResponse(await t.json());
-    if (isValidationError(response)) {
-        throw new Error(`invalid payment requirements from facilitator: ${response.summary}`);
-    }
-    return response;
-}
+import { handleMiddlewareRequest } from "./common.js";
 export async function createMiddleware(args) {
     return async (req, res, next) => {
-        // XXX - Temporarily request this every time.  This will be
-        // cached in future.
-        const paymentRequiredResponse = await getPaymentRequiredResponse(args, req);
-        const sendPaymentRequired = (res) => {
-            res.status(402).json(paymentRequiredResponse);
-        };
-        const paymentHeader = req.header("X-PAYMENT");
-        if (!paymentHeader) {
-            return sendPaymentRequired(res);
-        }
-        const payload = x402PaymentHeaderToPayload(paymentHeader);
-        if (isValidationError(payload)) {
-            return sendPaymentRequired(res);
-        }
-        const paymentRequirements = findMatchingPaymentRequirements(paymentRequiredResponse.accepts, payload);
-        if (!paymentRequirements) {
-            return sendPaymentRequired(res);
-        }
-        const settleRequest = {
-            x402Version: 1,
-            paymentHeader,
-            paymentRequirements,
-        };
-        const t = await fetch(`${args.facilitatorURL}/settle`, {
-            method: "POST",
-            headers: {
-                Accept: "application/json",
-                "Content-Type": "application/json",
-            },
-            body: JSON.stringify(settleRequest),
+        const response = await handleMiddlewareRequest({
+            ...args,
+            resource: `${req.protocol}://${req.headers.host}${req.path}`,
+            getHeader: (key) => req.header(key),
+            sendJSONResponse: (status, body) => res.status(status).json(body),
         });
-        const settlementResponse = x402SettleResponse(await t.json());
-        if (isValidationError(settlementResponse)) {
-            throw new Error(`error getting response from facilitator for settlement: ${settlementResponse.summary}`);
-        }
-        if (!settlementResponse.success) {
-            return sendPaymentRequired(res);
+        if (response) {
+            return;
         }
         next();
     };

package/dist/src/hono.d.ts

@@ -1,9 +1,6 @@
-import { type RelaxedRequirements } from "./utils.js";
+import { type CommonMiddlewareArgs } from "./common.js";
 import type { MiddlewareHandler } from "hono";
-type CreateMiddlewareArgs = {
-    accepts: RelaxedRequirements[];
-    facilitatorURL: string;
-};
+type CreateMiddlewareArgs = CommonMiddlewareArgs;
 export declare function createMiddleware(args: CreateMiddlewareArgs): Promise<MiddlewareHandler>;
 export {};
 //# sourceMappingURL=hono.d.ts.map

package/dist/src/hono.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hono.d.ts","sourceRoot":"","sources":["../../src/hono.ts"],"names":[],"mappings":"AAOA,OAAO,EAGL,KAAK,mBAAmB,EACzB,MAAM,SAAS,CAAC;AAEjB,OAAO,KAAK,EAAE,iBAAiB,EAAW,MAAM,MAAM,CAAC;AAEvD,KAAK,oBAAoB,GAAG;IAC1B,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC/B,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,oBAAoB,GACzB,OAAO,CAAC,iBAAiB,CAAC,CA4F5B"}
+{"version":3,"file":"hono.d.ts","sourceRoot":"","sources":["../../src/hono.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,KAAK,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AAE9C,KAAK,oBAAoB,GAAG,oBAAoB,CAAC;AAEjD,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,oBAAoB,GACzB,OAAO,CAAC,iBAAiB,CAAC,CAkB5B"}

package/dist/src/hono.js

@@ -1,68 +1,17 @@
-import { x402SettleRequest, x402SettleResponse, x402PaymentRequiredResponse, x402PaymentHeaderToPayload, isValidationError, } from "@faremeter/types";
-import { findMatchingPaymentRequirements, gateGetPaymentRequiredResponse, } from "./utils.js";
+import { handleMiddlewareRequest } from "./common.js";
 export async function createMiddleware(args) {
-    async function getPaymentRequiredResponse(args, c) {
-        const accepts = args.accepts.map((x) => ({
-            ...x,
-            resource: x.resource ?? c.req.url,
-        }));
-        const t = await fetch(`${args.facilitatorURL}/accepts`, {
-            method: "POST",
-            headers: {
-                Accept: "application/json",
-                "Content-Type": "application/json",
-            },
-            body: JSON.stringify({
-                x402Version: 1,
-                accepts,
-            }),
-        });
-        gateGetPaymentRequiredResponse(t);
-        const response = x402PaymentRequiredResponse(await t.json());
-        if (isValidationError(response)) {
-            throw new Error(`invalid payment requirements from facilitator: ${response.summary}`);
-        }
-        return response;
-    }
     return async (c, next) => {
-        // XXX - Temporarily request this every time.  This will be
-        // cached in future.
-        const paymentRequiredResponse = await getPaymentRequiredResponse(args, c);
-        const sendPaymentRequired = () => {
-            c.status(402);
-            return c.json(paymentRequiredResponse);
-        };
-        const paymentHeader = c.req.header("X-PAYMENT");
-        if (!paymentHeader) {
-            return sendPaymentRequired();
-        }
-        const payload = x402PaymentHeaderToPayload(paymentHeader);
-        if (isValidationError(payload)) {
-            return sendPaymentRequired();
-        }
-        const paymentRequirements = findMatchingPaymentRequirements(paymentRequiredResponse.accepts, payload);
-        if (!paymentRequirements) {
-            return sendPaymentRequired();
-        }
-        const settleRequest = {
-            x402Version: 1,
-            paymentHeader,
-            paymentRequirements,
-        };
-        const t = await fetch(`${args.facilitatorURL}/settle`, {
-            method: "POST",
-            headers: {
-                Accept: "application/json",
-                "Content-Type": "application/json",
+        const response = await handleMiddlewareRequest({
+            ...args,
+            resource: c.req.url,
+            getHeader: (key) => c.req.header(key),
+            sendJSONResponse: (status, body) => {
+                c.status(status);
+                return c.json(body);
             },
-            body: JSON.stringify(settleRequest),
         });
-        const settlementResponse = x402SettleResponse(await t.json());
-        if (isValidationError(settlementResponse)) {
-            throw new Error(`error getting response from facilitator for settlement: ${settlementResponse.summary}`);
-        }
-        if (!settlementResponse.success) {
-            return sendPaymentRequired();
+        if (response) {
+            return response;
         }
         await next();
     };

package/dist/src/index.d.ts

@@ -1,3 +1,4 @@
 export * as express from "./express.js";
 export * as hono from "./hono.js";
+export * as common from "./common.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC"}

package/dist/src/index.js

@@ -1,2 +1,3 @@
 export * as express from "./express.js";
 export * as hono from "./hono.js";
+export * as common from "./common.js";