fix JFS import error -- ERR_REQUIRE_ESM

Author: lyoshenka

.changeset/clever-moments-end.md

@@ -0,0 +1,5 @@
+---
+"@farcaster/snap": patch
+---
+
+fix ESM loading bug

apps/emulator/src/app/api/snap/route.ts

@@ -1,4 +1,4 @@
-import { encodePayload } from "@farcaster/jfs";
+import * as jfs from "@farcaster/jfs";
 import { NextRequest, NextResponse } from "next/server";
 import type { SnapPayload } from "@farcaster/snap";
 import {
@@ -165,7 +165,7 @@ export async function POST(request: NextRequest) {
 
   const jfsEnvelope = {
     header: "dev",
-    payload: encodePayload(payload),
+    payload: jfs.encodePayload(payload),
     signature: "dev",
   };
   const postBody = JSON.stringify(jfsEnvelope);

pkgs/hono/tests/registerSnapHandler.test.ts

@@ -2,7 +2,7 @@ import { describe, expect, it } from "vitest";
 import { Hono } from "hono";
 import { registerSnapHandler } from "../src/index";
 import { buildSnapAlternateLinkHeader } from "../src/payloadToResponse";
-import { encodePayload } from "@farcaster/jfs";
+import { encodePayload } from "@farcaster/snap/server";
 import {
   MEDIA_TYPE,
   DEFAULT_THEME_ACCENT,

pkgs/snap/src/server/index.ts

@@ -1,4 +1,4 @@
-export { verifyJFSRequestBody, decodePayload } from "./verify";
+export { verifyJFSRequestBody, decodePayload, encodePayload } from "./verify";
 export {
   DEFAULT_SNAP_HUB_HTTP_BASE_URL,
   getActiveEd25519SignerKeysFromHubHttp,

pkgs/snap/src/server/verify.ts

@@ -1,9 +1,4 @@
-import {
-  compact,
-  decode,
-  decodePayload as jfsDecodePayload,
-  verify as jfsVerify,
-} from "@farcaster/jfs";
+import * as jfs from "@farcaster/jfs"; // must be imported like this to avoid ERR_REQUIRE_ESM error
 import { hexToBytes, type Hex } from "viem";
 import {
   DEFAULT_SNAP_HUB_HTTP_BASE_URL,
@@ -31,7 +26,7 @@ export async function verifyJFSRequestBody<TPayload>(
 > {
   let compactJfs: string;
   try {
-    compactJfs = compact({
+    compactJfs = jfs.compact({
       header: requestBody.header,
       payload: requestBody.payload,
       signature: requestBody.signature,
@@ -43,9 +38,9 @@ export async function verifyJFSRequestBody<TPayload>(
     };
   }
 
-  let decoded: ReturnType<typeof decode<TPayload>>;
+  let decoded: ReturnType<typeof jfs.decode<TPayload>>;
   try {
-    decoded = decode<TPayload>(compactJfs);
+    decoded = jfs.decode<TPayload>(compactJfs);
   } catch (error) {
     return {
       valid: false,
@@ -54,7 +49,7 @@ export async function verifyJFSRequestBody<TPayload>(
   }
 
   try {
-    await jfsVerify({ data: compactJfs, strict: true, keyTypes: ["app_key"] });
+    await jfs.verify({ data: compactJfs, strict: true, keyTypes: ["app_key"] });
   } catch (error) {
     return {
       valid: false,
@@ -111,7 +106,11 @@ export async function verifyJFSRequestBody<TPayload>(
 }
 
 export function decodePayload<TPayload>(payload: string): TPayload {
-  return jfsDecodePayload<TPayload>(payload);
+  return jfs.decodePayload<TPayload>(payload);
+}
+
+export function encodePayload<TPayload>(payload: TPayload): string {
+  return jfs.encodePayload(payload);
 }
 
 function bytesEqual(a: Uint8Array, b: Uint8Array): boolean {

pkgs/snap/tests/parseRequest.test.ts

@@ -1,7 +1,6 @@
 import { describe, expect, it } from "vitest";
-import { parseRequest } from "../src/server";
+import { parseRequest, encodePayload, decodePayload } from "../src/server";
 import { type SnapPayload } from "../src/schemas";
-import { decodePayload, encodePayload } from "@farcaster/jfs";
 
 describe("parseRequest", () => {
   function postBody(overrides: Record<string, unknown> = {}) {