@evvm/x402 0.0.1 → 0.1.3

package/src/lib/local-facilitator.ts

@@ -1,106 +0,0 @@
-import {
-  Core,
-  execute,
-  type HexString,
-  type IPayData,
-  type ISerializableSignedAction,
-  type ISigner,
-} from "@evvm/evvm-js";
-import { recoverMessageAddress } from "viem";
-import type { IFacilitator } from "../types";
-
-export class LocalFacilitator implements IFacilitator {
-  constructor(public signer: ISigner) {}
-
-  /**
-   * Reconstructs the signed message and recovers the signer from the signature provided
-   * to validate it. Asserts the nonce provided is valid.
-   * @returns true if the recovered address match signedAction.data.from; false otherwise
-   */
-  async verifyPaySignature(
-    signedAction: ISerializableSignedAction<IPayData>,
-  ): Promise<boolean> {
-    if (signedAction.functionName !== "pay")
-      throw new Error("verifyPaySignature can only verify core.pay signatures");
-
-    const core = new Core({
-      address: signedAction.contractAddress as HexString,
-      signer: this.signer,
-      chainId: signedAction.chainId,
-    });
-    // replicate signed message
-    const evvmId = await core.getEvvmID();
-    const hashPayload = core.buildHashPayload(signedAction.functionName, {
-      to_address: signedAction.data.to_address,
-      to_identity: signedAction.data.to_identity,
-      token: signedAction.data.token,
-      amount: signedAction.data.amount,
-      priorityFee: signedAction.data.priorityFee,
-    });
-
-    const message = core.buildMessageToSign(
-      evvmId,
-      signedAction.data.senderExecutor,
-      hashPayload,
-      signedAction.data.originExecutor,
-      signedAction.data.nonce,
-      signedAction.data.isAsyncExec,
-    );
-
-    // recover signer of the message
-    const address = await recoverMessageAddress({
-      message,
-      signature: signedAction.data.signature as HexString,
-    });
-
-    if (address !== signedAction.data.from) {
-      console.error("Couldn't recover address from signature");
-      return false;
-    }
-
-    // verify nonces are ok
-    if (signedAction.data.isAsyncExec) {
-      // async execution, assert nonce hasn't been used before
-      const used = await core.getIfUsedAsyncNonce(signedAction.data.nonce);
-      if (used) {
-        console.error("Invalid async nonce");
-        return false;
-      }
-    } else {
-      const nextExpectedNonce = await core.getNextCurrentSyncNonce();
-      if (nextExpectedNonce.toString() != signedAction.data.nonce.toString()) {
-        console.error("Invalid sync nonce");
-        return false;
-      }
-    }
-
-    // assert balances
-    const balance = await core.getBalance(
-      signedAction.data.from,
-      signedAction.data.token,
-    );
-    if (balance <= signedAction.data.amount) {
-      console.error("Insufficient balance");
-      return false;
-    }
-
-    return true;
-  }
-
-  /**
-   * Executes the evvm transaction.
-   * @returns tx hash
-   */
-  async settlePayment(
-    signedAction: ISerializableSignedAction<IPayData>,
-  ): Promise<HexString | null> {
-    try {
-      const txHash = await execute(this.signer, signedAction);
-      return txHash;
-    } catch (error) {
-      console.error("Failed to settle payment");
-      console.error(error);
-      return null;
-    }
-  }
-}

package/src/lib/parse-header.ts

@@ -1,29 +0,0 @@
-import {
-  PaymentPayloadV2Schema,
-  type PaymentPayloadV2,
-} from "@x402/core/schemas";
-
-/**
- * Parses the PAYMENT-SIGNATURE header into PaymentPayloadV2 from x402/core
- * @returns PaymentPayloadV2 if it's a valid payload, null otherwise
- */
-export const parseHeader = (
-  paymentSignatureHeader: string,
-): PaymentPayloadV2 | null => {
-  // decode header (it's a base64 encoded string)
-  const decodedString = Buffer.from(paymentSignatureHeader, "base64").toString(
-    "utf-8",
-  );
-
-  // assert it has the correct schema
-  let payload = null;
-  try {
-    payload = PaymentPayloadV2Schema.parse(JSON.parse(decodedString));
-  } catch (error) {
-    console.error("Failed to parse payment payload");
-    console.error(error);
-    return null;
-  }
-
-  return payload;
-};

package/src/lib/payment-responses.ts

@@ -1,64 +0,0 @@
-import { type SettleResponse } from "@x402/core/types";
-import { type PaymentRequirementsV2 } from "@x402/core/schemas";
-
-/**
- * Creates the 402 payment required response, with headers, amounts and
- * everything else needed, returns the actual response (this should go directly to
- * the user)
- */
-export const paymentRequiredResponse = (
-  offers: PaymentRequirementsV2[],
-): Response => {
-  const jsonString = JSON.stringify({ offers });
-  const base64Payload = Buffer.from(jsonString).toString("base64");
-
-  const headers = new Headers();
-  headers.set("PAYMENT-REQUIRED", base64Payload);
-  headers.set("Access-Control-Expose-Headers", "PAYMENT-REQUIRED"); // Vital for CORS
-  headers.set("Content-Type", "application/json");
-
-  console.log("Payment required");
-
-  return new Response("Payment Required", { headers, status: 402 });
-};
-
-/**
- * Returned when an invalid response is received
- */
-export const invalidPaymentResponse = (reason: string): Response => {
-  const settleResponse: SettleResponse = {
-    success: false,
-    errorMessage: "Invalid Payment",
-    errorReason: reason,
-    transaction: "",
-    network: ":",
-  };
-
-  const jsonString = JSON.stringify(settleResponse);
-  const base64Payload = Buffer.from(jsonString).toString("base64");
-
-  const headers = new Headers();
-  headers.set("PAYMENT-RESPONSE", base64Payload);
-
-  console.log("Payment invalid");
-  return new Response(`Payment Invalid: ${reason}`, { status: 400, headers });
-};
-
-// export const successfulPaymentResponse = (
-//   txHash: HexString,
-//   payload: IPaymentPayload,
-// ) => {
-//   const settleResponse: SettleResponse = {
-//     success: true,
-//     payer: payload.payload.data.from,
-//     transaction: txHash,
-//     network: payload.accepted.network as "${string}:${string}",
-//   };
-//
-//   const jsonString = JSON.stringify(settleResponse);
-//   const base64Payload = Buffer.from(jsonString).toString("base64");
-//   const headers = new Headers();
-//   headers.set("PAYMENT-REQUIRED", base64Payload);
-//
-//   return new Response("Payment Required", { headers, status: 402 });
-// };

package/src/middleware/express.ts

@@ -1,92 +0,0 @@
-import type {
-  NextFunction,
-  Request as ExpressRequest,
-  Response as ExpressResponse,
-} from "express";
-import type { IEvvmSchema, IFacilitator } from "../types";
-import {
-  invalidPaymentResponse,
-  parseHeader,
-  paymentRequiredResponse,
-} from "../lib";
-import {
-  getSerializableSignedActionSchema,
-  PayDataSchema,
-} from "@evvm/evvm-js";
-import type { SettleResponse } from "@x402/core/types";
-
-/**
- * This is used to parse Web API Response objects to express compatible
- * responses
- */
-const handleWebResponse = async (res: ExpressResponse, webRes: Response) => {
-  res.status(webRes.status);
-  webRes.headers.forEach((value, key) => {
-    res.setHeader(key, value);
-  });
-
-  const body = await webRes.text();
-  res.send(body);
-};
-
-/**
- * ExpressJS middleware that expects EVVM payments
- */
-export const requireEvvmPaymentExpress =
-  (facilitator: IFacilitator, offers: IEvvmSchema[]) =>
-  async (req: ExpressRequest, res: ExpressResponse, next: NextFunction) => {
-    // assert payment is present
-    const paymentHeader = req.header("PAYMENT-SIGNATURE");
-    // if not present, return payment required
-    if (!paymentHeader)
-      return handleWebResponse(res, paymentRequiredResponse(offers));
-
-    // if present, parse and validate it
-    const parsed = parseHeader(paymentHeader);
-    if (!parsed) {
-      return handleWebResponse(res, invalidPaymentResponse("Invalid payment"));
-    }
-
-    const { success, data: signedAction } = getSerializableSignedActionSchema(
-      PayDataSchema,
-    ).safeParse(parsed.payload);
-
-    if (!success) {
-      return handleWebResponse(
-        res,
-        invalidPaymentResponse("Not an evvm payment"),
-      );
-    }
-
-    // verify it
-    if (!(await facilitator.verifyPaySignature(signedAction))) {
-      return handleWebResponse(
-        res,
-        invalidPaymentResponse("Invalid signature"),
-      );
-    }
-
-    // settle it
-    const txHash = await facilitator.settlePayment(signedAction);
-
-    if (!txHash) {
-      return handleWebResponse(
-        res,
-        invalidPaymentResponse("Settlement failed"),
-      );
-    }
-
-    const settleResponse: SettleResponse = {
-      success: true,
-      payer: signedAction.data.from,
-      transaction: txHash,
-      network: parsed.accepted.network as `${string}:${string}`,
-    };
-
-    const jsonString = JSON.stringify(settleResponse);
-    const base64Payload = Buffer.from(jsonString).toString("base64");
-
-    res.setHeader("PAYMENT-RESPONSE", base64Payload);
-
-    next();
-  };

package/src/middleware/next.ts

@@ -1,79 +0,0 @@
-import type { NextRequest } from "next/server";
-import type { IEvvmSchema, IFacilitator } from "../types";
-import { invalidPaymentResponse, paymentRequiredResponse } from "../lib";
-import {
-  getSerializableSignedActionSchema,
-  PayDataSchema,
-} from "@evvm/evvm-js";
-import type { SettleResponse } from "@x402/core/types";
-import {
-  PaymentPayloadV2Schema,
-  type PaymentPayloadV2,
-} from "@x402/core/schemas";
-
-const parseHeaderEdge = (
-  paymentSignatureHeader: string,
-): PaymentPayloadV2 | null => {
-  const decodedString = atob(paymentSignatureHeader);
-
-  let payload = null;
-  try {
-    payload = PaymentPayloadV2Schema.parse(JSON.parse(decodedString));
-  } catch (error) {
-    console.error("Failed to parse payment payload");
-    console.error(error);
-    return null;
-  }
-
-  return payload;
-};
-
-/**
- * Creates a payment required middleware for nextjs
- */
-export const createEvvmMiddlewareNext =
-  (facilitator: IFacilitator, offers: IEvvmSchema[]) =>
-  async (req: NextRequest) => {
-    const paymentHeader = req.headers.get("PAYMENT-SIGNATURE");
-
-    if (!paymentHeader) {
-      return paymentRequiredResponse(offers);
-    }
-
-    const parsed = parseHeaderEdge(paymentHeader);
-    if (!parsed) {
-      return invalidPaymentResponse("Invalid payment");
-    }
-
-    const { success, data: signedAction } = getSerializableSignedActionSchema(
-      PayDataSchema,
-    ).safeParse(parsed.payload);
-
-    if (!success) {
-      return invalidPaymentResponse("Not an evvm payment");
-    }
-
-    if (!(await facilitator.verifyPaySignature(signedAction))) {
-      return invalidPaymentResponse("Invalid signature");
-    }
-
-    const txHash = await facilitator.settlePayment(signedAction);
-
-    if (!txHash) {
-      return invalidPaymentResponse("Settlement failed");
-    }
-
-    const settleResponse: SettleResponse = {
-      success: true,
-      payer: signedAction.data.from,
-      transaction: txHash,
-      network: parsed.accepted.network as `${string}:${string}`,
-    };
-
-    const jsonString = JSON.stringify(settleResponse);
-    const base64Payload = btoa(jsonString);
-
-    req.headers.set("PAYMENT-RESPONSE", base64Payload);
-  };
-
-export default createEvvmMiddlewareNext;

package/src/types/evvm-schema.type.ts

@@ -1,19 +0,0 @@
-import { type HexString } from "@evvm/evvm-js";
-import { type PaymentRequirements } from "@x402/core/types";
-
-export interface IEvvmSchema extends PaymentRequirements {
-  scheme: "evvm";
-  network: `eip155:${number}`;
-  amount: string;
-  asset: HexString;
-  payTo: string;
-  maxTimeoutSeconds: number;
-  /**
-   * Custom metadata for successful evvm signature construction
-   */
-  extra: {
-    coreContractAddress: HexString;
-    evvmId?: number;
-    originExecutor?: HexString;
-  };
-}

package/src/types/facilitator.type.ts

@@ -1,15 +0,0 @@
-import type {
-  HexString,
-  IPayData,
-  ISerializableSignedAction,
-} from "@evvm/evvm-js";
-
-export interface IFacilitator {
-  verifyPaySignature(
-    signedAction: ISerializableSignedAction<IPayData>,
-  ): Promise<boolean>;
-
-  settlePayment(
-    signedAction: ISerializableSignedAction<IPayData>,
-  ): Promise<HexString | null>;
-}

package/tsconfig.json

@@ -1,29 +0,0 @@
-{
-  "compilerOptions": {
-    // Environment setup & latest features
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
-  }
-}