@farcaster/frame-node 0.0.0-canary-20250430150627

package/src/types.ts

@@ -0,0 +1,32 @@
+import type { FrameServerEvent } from '@farcaster/frame-core'
+
+export type VerifyAppKeyResult =
+  | { valid: true; appFid: number }
+  | { valid: false }
+
+export type VerifyAppKey = (
+  fid: number,
+  appKey: string,
+) => Promise<VerifyAppKeyResult>
+
+export type VerifyJfsResult = {
+  fid: number
+  appFid: number
+  payload: Uint8Array
+}
+
+export type ParseWebhookEventResult = {
+  fid: number
+  appFid: number
+  event: FrameServerEvent
+}
+
+export class BaseError<C extends Error | undefined = undefined> extends Error {
+  override name = 'BaseError'
+  cause: C
+
+  constructor(message: string, cause?: C) {
+    super(message)
+    this.cause = cause as any
+  }
+}

package/src/util.ts

@@ -0,0 +1,9 @@
+export function bytesToHex(bytes: Uint8Array): string {
+  return `0x${Buffer.from(bytes).toString('hex')}`
+}
+
+export function hexToBytes(hex: string): Uint8Array {
+  return Uint8Array.from(
+    Buffer.from(hex.startsWith('0x') ? hex.slice(2) : hex, 'hex'),
+  )
+}

package/src/webhook.ts

@@ -0,0 +1,50 @@
+import { serverEventSchema } from '@farcaster/frame-core'
+import {
+  type VerifyJsonFarcasterSignature,
+  verifyJsonFarcasterSignature,
+} from './jfs'
+import {
+  BaseError,
+  type ParseWebhookEventResult,
+  type VerifyAppKey,
+} from './types'
+
+export declare namespace ParseWebhookEvent {
+  type ErrorType =
+    | VerifyJsonFarcasterSignature.ErrorType
+    | InvalidEventDataError
+}
+
+export class InvalidEventDataError<
+  C extends Error | undefined = undefined,
+> extends BaseError<C> {
+  override readonly name = 'VerifyJsonFarcasterSignature.InvalidEventDataError'
+}
+
+export async function parseWebhookEvent(
+  rawData: unknown,
+  verifyAppKey: VerifyAppKey,
+): Promise<ParseWebhookEventResult> {
+  const { fid, appFid, payload } = await verifyJsonFarcasterSignature(
+    rawData,
+    verifyAppKey,
+  )
+
+  // Pase and validate event payload
+  let payloadJson: any
+  try {
+    payloadJson = JSON.parse(Buffer.from(payload).toString('utf-8'))
+  } catch (error: unknown) {
+    throw new InvalidEventDataError(
+      'Error decoding and parsing payload',
+      error instanceof Error ? error : undefined,
+    )
+  }
+
+  const event = serverEventSchema.safeParse(payloadJson)
+  if (event.success === false) {
+    throw new InvalidEventDataError('Invalid event payload', event.error)
+  }
+
+  return { fid, appFid, event: event.data }
+}