@farcaster/frame-node 0.0.9 → 0.0.11

package/dist/farcaster.d.ts

@@ -1,4 +1,4 @@
-import { VerifyAppKey } from "./types";
+import { type VerifyAppKey } from './types';
 export declare const signedKeyRequestAbi: readonly [{
     readonly components: readonly [{
         readonly name: "requestFid";

package/dist/farcaster.js

@@ -1,31 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createVerifyAppKeyWithHub = exports.signedKeyRequestAbi = void 0;
-const types_1 = require("./types");
-const zod_1 = require("zod");
 const ox_1 = require("ox");
+const zod_1 = require("zod");
+const types_1 = require("./types");
 exports.signedKeyRequestAbi = [
     {
         components: [
             {
-                name: "requestFid",
-                type: "uint256",
+                name: 'requestFid',
+                type: 'uint256',
             },
             {
-                name: "requestSigner",
-                type: "address",
+                name: 'requestSigner',
+                type: 'address',
             },
             {
-                name: "signature",
-                type: "bytes",
+                name: 'signature',
+                type: 'bytes',
             },
             {
-                name: "deadline",
-                type: "uint256",
+                name: 'deadline',
+                type: 'uint256',
             },
         ],
-        name: "SignedKeyRequest",
-        type: "tuple",
+        name: 'SignedKeyRequest',
+        type: 'tuple',
     },
 ];
 const hubResponseSchema = zod_1.z.object({
@@ -37,8 +37,8 @@ const hubResponseSchema = zod_1.z.object({
     })),
 });
 const createVerifyAppKeyWithHub = (hubUrl, requestOptions) => async (fid, appKey) => {
-    const url = new URL("/v1/onChainSignersByFid", hubUrl);
-    url.searchParams.append("fid", fid.toString());
+    const url = new URL('/v1/onChainSignersByFid', hubUrl);
+    url.searchParams.append('fid', fid.toString());
     const response = await fetch(url, requestOptions);
     if (response.status !== 200) {
         throw new types_1.BaseError(`Non-200 response received: ${await response.text()}`);
@@ -46,16 +46,16 @@ const createVerifyAppKeyWithHub = (hubUrl, requestOptions) => async (fid, appKey
     const responseJson = await response.json();
     const parsedResponse = hubResponseSchema.safeParse(responseJson);
     if (parsedResponse.error) {
-        throw new types_1.BaseError("Error parsing Hub response", parsedResponse.error);
+        throw new types_1.BaseError('Error parsing Hub response', parsedResponse.error);
     }
     const appKeyLower = appKey.toLowerCase();
     const signerEvent = parsedResponse.data.events.find((event) => event.signerEventBody.key.toLowerCase() === appKeyLower);
     if (!signerEvent) {
         return { valid: false };
     }
-    const decoded = ox_1.AbiParameters.decode(exports.signedKeyRequestAbi, Buffer.from(signerEvent.signerEventBody.metadata, "base64"));
+    const decoded = ox_1.AbiParameters.decode(exports.signedKeyRequestAbi, Buffer.from(signerEvent.signerEventBody.metadata, 'base64'));
     if (decoded.length !== 1) {
-        throw new types_1.BaseError("Error decoding metadata");
+        throw new types_1.BaseError('Error decoding metadata');
     }
     const appFid = Number(decoded[0].requestFid);
     return { valid: true, appFid };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-export * from "@farcaster/frame-core";
-export * from "./jfs";
-export * from "./neynar";
-export * from "./farcaster";
-export * from "./types";
-export * from "./webhook";
-export * from "./util";
+export * from '@farcaster/frame-core';
+export * from './jfs';
+export * from './neynar';
+export * from './farcaster';
+export * from './types';
+export * from './webhook';
+export * from './util';

package/dist/jfs.d.ts

@@ -1,5 +1,5 @@
-import { EncodedJsonFarcasterSignatureSchema } from "@farcaster/frame-core";
-import { BaseError, VerifyAppKey, VerifyJfsResult } from "./types";
+import { type EncodedJsonFarcasterSignatureSchema } from '@farcaster/frame-core';
+import { BaseError, type VerifyAppKey, type VerifyJfsResult } from './types';
 export declare namespace VerifyJsonFarcasterSignature {
     type ErrorType = InvalidJfsDataError | InvalidJfsAppKeyError | VerifyAppKeyError;
 }
@@ -15,7 +15,7 @@ export declare class VerifyAppKeyError<C extends Error | undefined = undefined>
 export declare function verifyJsonFarcasterSignature(data: unknown, verifyAppKey: VerifyAppKey): Promise<VerifyJfsResult>;
 export declare function createJsonFarcasterSignature({ fid, type, privateKey, payload, }: {
     fid: number;
-    type: "app_key";
+    type: 'app_key';
     privateKey: Uint8Array;
     payload: Uint8Array;
 }): EncodedJsonFarcasterSignatureSchema;

package/dist/jfs.js

@@ -8,15 +8,15 @@ const ed25519_1 = require("@noble/curves/ed25519");
 const types_1 = require("./types");
 const util_1 = require("./util");
 class InvalidJfsDataError extends types_1.BaseError {
-    name = "VerifyJsonFarcasterSignature.InvalidDataError";
+    name = 'VerifyJsonFarcasterSignature.InvalidDataError';
 }
 exports.InvalidJfsDataError = InvalidJfsDataError;
 class InvalidJfsAppKeyError extends types_1.BaseError {
-    name = "VerifyJsonFarcasterSignature.InvalidAppKeyError";
+    name = 'VerifyJsonFarcasterSignature.InvalidAppKeyError';
 }
 exports.InvalidJfsAppKeyError = InvalidJfsAppKeyError;
 class VerifyAppKeyError extends types_1.BaseError {
-    name = "VerifyJsonFarcasterSignature.VerifyAppKeyError";
+    name = 'VerifyJsonFarcasterSignature.VerifyAppKeyError';
 }
 exports.VerifyAppKeyError = VerifyAppKeyError;
 async function verifyJsonFarcasterSignature(data, verifyAppKey) {
@@ -25,23 +25,23 @@ async function verifyJsonFarcasterSignature(data, verifyAppKey) {
     //
     const body = frame_core_1.encodedJsonFarcasterSignatureSchema.safeParse(data);
     if (body.success === false) {
-        throw new InvalidJfsDataError("Error parsing data", body.error);
+        throw new InvalidJfsDataError('Error parsing data', body.error);
     }
     let headerData;
     try {
-        headerData = JSON.parse(Buffer.from(body.data.header, "base64url").toString("utf-8"));
+        headerData = JSON.parse(Buffer.from(body.data.header, 'base64url').toString('utf-8'));
     }
     catch (error) {
-        throw new InvalidJfsDataError("Error decoding and parsing header");
+        throw new InvalidJfsDataError('Error decoding and parsing header');
     }
     const header = frame_core_1.jsonFarcasterSignatureHeaderSchema.safeParse(headerData);
     if (header.success === false) {
-        throw new InvalidJfsDataError("Error parsing header", header.error);
+        throw new InvalidJfsDataError('Error parsing header', header.error);
     }
-    const payload = Buffer.from(body.data.payload, "base64url");
-    const signature = Buffer.from(body.data.signature, "base64url");
+    const payload = Buffer.from(body.data.payload, 'base64url');
+    const signature = Buffer.from(body.data.signature, 'base64url');
     if (signature.byteLength !== 64) {
-        throw new InvalidJfsDataError("Invalid signature length");
+        throw new InvalidJfsDataError('Invalid signature length');
     }
     //
     // Verify the signature
@@ -49,16 +49,16 @@ async function verifyJsonFarcasterSignature(data, verifyAppKey) {
     const fid = header.data.fid;
     const appKey = header.data.key;
     const appKeyBytes = (0, util_1.hexToBytes)(appKey);
-    const signedInput = new Uint8Array(Buffer.from(body.data.header + "." + body.data.payload));
+    const signedInput = new Uint8Array(Buffer.from(body.data.header + '.' + body.data.payload));
     let verifyResult;
     try {
         verifyResult = ed25519_1.ed25519.verify(signature, signedInput, appKeyBytes);
     }
     catch (e) {
-        throw new InvalidJfsDataError("Error checking signature", e instanceof Error ? e : undefined);
+        throw new InvalidJfsDataError('Error checking signature', e instanceof Error ? e : undefined);
     }
     if (!verifyResult) {
-        throw new InvalidJfsDataError("Invalid signature");
+        throw new InvalidJfsDataError('Invalid signature');
     }
     //
     // Verify that the app key belongs to the FID
@@ -68,21 +68,21 @@ async function verifyJsonFarcasterSignature(data, verifyAppKey) {
         appKeyResult = await verifyAppKey(fid, appKey);
     }
     catch (error) {
-        throw new VerifyAppKeyError("Error verifying app key", error instanceof Error ? error : undefined);
+        throw new VerifyAppKeyError('Error verifying app key', error instanceof Error ? error : undefined);
     }
     if (!appKeyResult.valid) {
-        throw new InvalidJfsAppKeyError("App key not valid for FID");
+        throw new InvalidJfsAppKeyError('App key not valid for FID');
     }
     return { fid, appFid: appKeyResult.appFid, payload };
 }
 function createJsonFarcasterSignature({ fid, type, privateKey, payload, }) {
     const publicKey = ed25519_1.ed25519.getPublicKey(privateKey);
     const header = { fid, type, key: (0, util_1.bytesToHex)(publicKey) };
-    const encodedHeader = Buffer.from(JSON.stringify(header)).toString("base64url");
-    const encodedPayload = Buffer.from(payload).toString("base64url");
-    const signatureInput = new Uint8Array(Buffer.from(encodedHeader + "." + encodedPayload, "utf-8"));
+    const encodedHeader = Buffer.from(JSON.stringify(header)).toString('base64url');
+    const encodedPayload = Buffer.from(payload).toString('base64url');
+    const signatureInput = new Uint8Array(Buffer.from(encodedHeader + '.' + encodedPayload, 'utf-8'));
     const signature = ed25519_1.ed25519.sign(signatureInput, privateKey);
-    const encodedSignature = Buffer.from(signature).toString("base64url");
+    const encodedSignature = Buffer.from(signature).toString('base64url');
     return {
         header: encodedHeader,
         payload: encodedPayload,

package/dist/neynar.d.ts

@@ -1,2 +1,2 @@
-import { VerifyAppKey } from "./types";
+import type { VerifyAppKey } from './types';
 export declare const verifyAppKeyWithNeynar: VerifyAppKey;

package/dist/neynar.js

@@ -2,14 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.verifyAppKeyWithNeynar = void 0;
 const farcaster_1 = require("./farcaster");
-const apiKey = process.env.NEYNAR_API_KEY || "";
+const apiKey = process.env.NEYNAR_API_KEY || '';
 const verifyAppKeyWithNeynar = async (fid, appKey) => {
     if (!apiKey) {
-        throw new Error("Environment variable NEYNAR_API_KEY needs to be set to use Neynar for app key verification");
+        throw new Error('Environment variable NEYNAR_API_KEY needs to be set to use Neynar for app key verification');
     }
-    const verifier = (0, farcaster_1.createVerifyAppKeyWithHub)("https://hub-api.neynar.com", {
+    const verifier = (0, farcaster_1.createVerifyAppKeyWithHub)('https://hub-api.neynar.com', {
         headers: {
-            "x-api-key": apiKey,
+            'x-api-key': apiKey,
         },
     });
     return verifier(fid, appKey);

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { FrameServerEvent } from "@farcaster/frame-core";
+import type { FrameServerEvent } from '@farcaster/frame-core';
 export type VerifyAppKeyResult = {
     valid: true;
     appFid: number;

package/dist/types.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseError = void 0;
 class BaseError extends Error {
-    name = "BaseError";
+    name = 'BaseError';
     cause;
     constructor(message, cause) {
         super(message);

package/dist/util.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.bytesToHex = bytesToHex;
 exports.hexToBytes = hexToBytes;
 function bytesToHex(bytes) {
-    return `0x${Buffer.from(bytes).toString("hex")}`;
+    return `0x${Buffer.from(bytes).toString('hex')}`;
 }
 function hexToBytes(hex) {
-    return Uint8Array.from(Buffer.from(hex.startsWith("0x") ? hex.slice(2) : hex, "hex"));
+    return Uint8Array.from(Buffer.from(hex.startsWith('0x') ? hex.slice(2) : hex, 'hex'));
 }

package/dist/webhook.d.ts

@@ -1,5 +1,5 @@
-import { VerifyJsonFarcasterSignature } from "./jfs";
-import { BaseError, ParseWebhookEventResult, VerifyAppKey } from "./types";
+import { type VerifyJsonFarcasterSignature } from './jfs';
+import { BaseError, type ParseWebhookEventResult, type VerifyAppKey } from './types';
 export declare namespace ParseWebhookEvent {
     type ErrorType = VerifyJsonFarcasterSignature.ErrorType | InvalidEventDataError;
 }

package/dist/webhook.js

@@ -6,7 +6,7 @@ const frame_core_1 = require("@farcaster/frame-core");
 const jfs_1 = require("./jfs");
 const types_1 = require("./types");
 class InvalidEventDataError extends types_1.BaseError {
-    name = "VerifyJsonFarcasterSignature.InvalidEventDataError";
+    name = 'VerifyJsonFarcasterSignature.InvalidEventDataError';
 }
 exports.InvalidEventDataError = InvalidEventDataError;
 async function parseWebhookEvent(rawData, verifyAppKey) {
@@ -14,14 +14,14 @@ async function parseWebhookEvent(rawData, verifyAppKey) {
     // Pase and validate event payload
     let payloadJson;
     try {
-        payloadJson = JSON.parse(Buffer.from(payload).toString("utf-8"));
+        payloadJson = JSON.parse(Buffer.from(payload).toString('utf-8'));
     }
     catch (error) {
-        throw new InvalidEventDataError("Error decoding and parsing payload", error instanceof Error ? error : undefined);
+        throw new InvalidEventDataError('Error decoding and parsing payload', error instanceof Error ? error : undefined);
     }
     const event = frame_core_1.serverEventSchema.safeParse(payloadJson);
     if (event.success === false) {
-        throw new InvalidEventDataError("Invalid event payload", event.error);
+        throw new InvalidEventDataError('Invalid event payload', event.error);
     }
     return { fid, appFid, event: event.data };
 }

package/esm/farcaster.d.ts

@@ -1,19 +1,29 @@
-import { VerifyAppKey } from "./types";
-export declare const signedKeyRequestAbi: readonly [{
-    readonly components: readonly [{
-        readonly name: "requestFid";
-        readonly type: "uint256";
-    }, {
-        readonly name: "requestSigner";
-        readonly type: "address";
-    }, {
-        readonly name: "signature";
-        readonly type: "bytes";
-    }, {
-        readonly name: "deadline";
-        readonly type: "uint256";
-    }];
-    readonly name: "SignedKeyRequest";
-    readonly type: "tuple";
-}];
-export declare const createVerifyAppKeyWithHub: (hubUrl: string, requestOptions?: RequestInit) => VerifyAppKey;
+import type { VerifyAppKey } from './types'
+export declare const signedKeyRequestAbi: readonly [
+  {
+    readonly components: readonly [
+      {
+        readonly name: 'requestFid'
+        readonly type: 'uint256'
+      },
+      {
+        readonly name: 'requestSigner'
+        readonly type: 'address'
+      },
+      {
+        readonly name: 'signature'
+        readonly type: 'bytes'
+      },
+      {
+        readonly name: 'deadline'
+        readonly type: 'uint256'
+      },
+    ]
+    readonly name: 'SignedKeyRequest'
+    readonly type: 'tuple'
+  },
+]
+export declare const createVerifyAppKeyWithHub: (
+  hubUrl: string,
+  requestOptions?: RequestInit,
+) => VerifyAppKey

package/esm/farcaster.js

@@ -1,59 +1,67 @@
-import { BaseError } from "./types";
-import { z } from "zod";
-import { AbiParameters } from "ox";
+import { AbiParameters } from 'ox'
+import { z } from 'zod'
+import { BaseError } from './types'
 export const signedKeyRequestAbi = [
-    {
-        components: [
-            {
-                name: "requestFid",
-                type: "uint256",
-            },
-            {
-                name: "requestSigner",
-                type: "address",
-            },
-            {
-                name: "signature",
-                type: "bytes",
-            },
-            {
-                name: "deadline",
-                type: "uint256",
-            },
-        ],
-        name: "SignedKeyRequest",
-        type: "tuple",
-    },
-];
+  {
+    components: [
+      {
+        name: 'requestFid',
+        type: 'uint256',
+      },
+      {
+        name: 'requestSigner',
+        type: 'address',
+      },
+      {
+        name: 'signature',
+        type: 'bytes',
+      },
+      {
+        name: 'deadline',
+        type: 'uint256',
+      },
+    ],
+    name: 'SignedKeyRequest',
+    type: 'tuple',
+  },
+]
 const hubResponseSchema = z.object({
-    events: z.array(z.object({
-        signerEventBody: z.object({
-            key: z.string(),
-            metadata: z.string(),
-        }),
-    })),
-});
-export const createVerifyAppKeyWithHub = (hubUrl, requestOptions) => async (fid, appKey) => {
-    const url = new URL("/v1/onChainSignersByFid", hubUrl);
-    url.searchParams.append("fid", fid.toString());
-    const response = await fetch(url, requestOptions);
+  events: z.array(
+    z.object({
+      signerEventBody: z.object({
+        key: z.string(),
+        metadata: z.string(),
+      }),
+    }),
+  ),
+})
+export const createVerifyAppKeyWithHub =
+  (hubUrl, requestOptions) => async (fid, appKey) => {
+    const url = new URL('/v1/onChainSignersByFid', hubUrl)
+    url.searchParams.append('fid', fid.toString())
+    const response = await fetch(url, requestOptions)
     if (response.status !== 200) {
-        throw new BaseError(`Non-200 response received: ${await response.text()}`);
+      throw new BaseError(`Non-200 response received: ${await response.text()}`)
     }
-    const responseJson = await response.json();
-    const parsedResponse = hubResponseSchema.safeParse(responseJson);
+    const responseJson = await response.json()
+    const parsedResponse = hubResponseSchema.safeParse(responseJson)
     if (parsedResponse.error) {
-        throw new BaseError("Error parsing Hub response", parsedResponse.error);
+      throw new BaseError('Error parsing Hub response', parsedResponse.error)
     }
-    const appKeyLower = appKey.toLowerCase();
-    const signerEvent = parsedResponse.data.events.find((event) => event.signerEventBody.key.toLowerCase() === appKeyLower);
+    const appKeyLower = appKey.toLowerCase()
+    const signerEvent = parsedResponse.data.events.find(
+      (event) => event.signerEventBody.key.toLowerCase() === appKeyLower,
+    )
     if (!signerEvent) {
-        return { valid: false };
+      return { valid: false }
     }
-    const decoded = AbiParameters.decode(signedKeyRequestAbi, Buffer.from(signerEvent.signerEventBody.metadata, "base64"));
+    const decoded = AbiParameters.decode(
+      signedKeyRequestAbi,
+      Buffer.from(signerEvent.signerEventBody.metadata, 'base64'),
+    )
     if (decoded.length !== 1) {
-        throw new BaseError("Error decoding metadata");
+      throw new BaseError('Error decoding metadata')
     }
-    const appFid = Number(decoded[0].requestFid);
-    return { valid: true, appFid };
-};
+    const appFid = Number(decoded[0].requestFid)
+    return { valid: true, appFid }
+  }

package/esm/index.d.ts

@@ -1,7 +1,7 @@
-export * from "@farcaster/frame-core";
-export * from "./jfs";
-export * from "./neynar";
-export * from "./farcaster";
-export * from "./types";
-export * from "./webhook";
-export * from "./util";
+export * from '@farcaster/frame-core'
+export * from './jfs'
+export * from './neynar'
+export * from './farcaster'
+export * from './types'
+export * from './webhook'
+export * from './util'

package/esm/index.js

@@ -1,7 +1,7 @@
-export * from "@farcaster/frame-core";
-export * from "./jfs";
-export * from "./neynar";
-export * from "./farcaster";
-export * from "./types";
-export * from "./webhook";
-export * from "./util";
+export * from '@farcaster/frame-core'
+export * from './jfs'
+export * from './neynar'
+export * from './farcaster'
+export * from './types'
+export * from './webhook'
+export * from './util'

package/esm/jfs.d.ts

@@ -1,21 +1,38 @@
-import { EncodedJsonFarcasterSignatureSchema } from "@farcaster/frame-core";
-import { BaseError, VerifyAppKey, VerifyJfsResult } from "./types";
+import type { EncodedJsonFarcasterSignatureSchema } from '@farcaster/frame-core'
+import { BaseError, type VerifyAppKey, type VerifyJfsResult } from './types'
 export declare namespace VerifyJsonFarcasterSignature {
-    type ErrorType = InvalidJfsDataError | InvalidJfsAppKeyError | VerifyAppKeyError;
+  type ErrorType =
+    | InvalidJfsDataError
+    | InvalidJfsAppKeyError
+    | VerifyAppKeyError
 }
-export declare class InvalidJfsDataError<C extends Error | undefined = undefined> extends BaseError<C> {
-    readonly name = "VerifyJsonFarcasterSignature.InvalidDataError";
+export declare class InvalidJfsDataError<
+  C extends Error | undefined = undefined,
+> extends BaseError<C> {
+  readonly name = 'VerifyJsonFarcasterSignature.InvalidDataError'
 }
-export declare class InvalidJfsAppKeyError<C extends Error | undefined = undefined> extends BaseError<C> {
-    readonly name = "VerifyJsonFarcasterSignature.InvalidAppKeyError";
+export declare class InvalidJfsAppKeyError<
+  C extends Error | undefined = undefined,
+> extends BaseError<C> {
+  readonly name = 'VerifyJsonFarcasterSignature.InvalidAppKeyError'
 }
-export declare class VerifyAppKeyError<C extends Error | undefined = undefined> extends BaseError<C> {
-    readonly name = "VerifyJsonFarcasterSignature.VerifyAppKeyError";
+export declare class VerifyAppKeyError<
+  C extends Error | undefined = undefined,
+> extends BaseError<C> {
+  readonly name = 'VerifyJsonFarcasterSignature.VerifyAppKeyError'
 }
-export declare function verifyJsonFarcasterSignature(data: unknown, verifyAppKey: VerifyAppKey): Promise<VerifyJfsResult>;
-export declare function createJsonFarcasterSignature({ fid, type, privateKey, payload, }: {
-    fid: number;
-    type: "app_key";
-    privateKey: Uint8Array;
-    payload: Uint8Array;
-}): EncodedJsonFarcasterSignatureSchema;
+export declare function verifyJsonFarcasterSignature(
+  data: unknown,
+  verifyAppKey: VerifyAppKey,
+): Promise<VerifyJfsResult>
+export declare function createJsonFarcasterSignature({
+  fid,
+  type,
+  privateKey,
+  payload,
+}: {
+  fid: number
+  type: 'app_key'
+  privateKey: Uint8Array
+  payload: Uint8Array
+}): EncodedJsonFarcasterSignatureSchema