@farcaster/frame-node 0.0.18 → 0.0.21

package/README.md

@@ -1,19 +1,17 @@
-# Frame Backend (Node) SDK
+# @farcaster/frame-node
 
-Provides utility methods for the backend of V2 frames:
+Utility methods for Mini App backends
+
+## Installation
+
+```bash
+pnpm add @farcaster/frame-node
+```
+
+## Documentation
 
 - `parseWebhookEvent`: parses and verifies webhook events, using a `VerifyAppKey` method
 - `verifyJsonFarcasterSignature`: verifies a [JSON Farcaster Signature](https://github.com/farcasterxyz/protocol/discussions/208) payload, using a `VerifyAppKey` method
 - `createJsonFarcasterSignature`: creates a [JSON Farcaster Signature](https://github.com/farcasterxyz/protocol/discussions/208) payload
 
 For signature verification, you need to pass in a `VerifyAppKey` method that verifies that an app key is valid for an FID. You can use the included `verifyAppKeyWithNeynar` which uses [Neynar](https://neynar.com) and requires the `NEYNAR_API_KEY` environment variable to be defined.
-
-Not yet stable. [Learn more](https://github.com/farcasterxyz/frames/wiki/frames-v2-developer-playground-preview).
-
-## Install
-
-Install using your favorite manager:
-
-```
-npm install @farcaster/frame-node
-```

package/dist/farcaster.js

@@ -1,7 +1,40 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createVerifyAppKeyWithHub = exports.signedKeyRequestAbi = void 0;
-const ox_1 = require("ox");
+const AbiParameters = __importStar(require("ox/AbiParameters"));
 const zod_1 = require("zod");
 const types_1 = require("./types");
 exports.signedKeyRequestAbi = [
@@ -53,7 +86,7 @@ const createVerifyAppKeyWithHub = (hubUrl, requestOptions) => async (fid, appKey
     if (!signerEvent) {
         return { valid: false };
     }
-    const decoded = ox_1.AbiParameters.decode(exports.signedKeyRequestAbi, Buffer.from(signerEvent.signerEventBody.metadata, 'base64'));
+    const decoded = AbiParameters.decode(exports.signedKeyRequestAbi, Buffer.from(signerEvent.signerEventBody.metadata, 'base64'));
     if (decoded.length !== 1) {
         throw new types_1.BaseError('Error decoding metadata');
     }

package/esm/farcaster.d.ts

@@ -1,29 +1,19 @@
-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
+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,67 +1,59 @@
-import { AbiParameters } from 'ox'
-import { z } from 'zod'
-import { BaseError } from './types'
+import * as AbiParameters from 'ox/AbiParameters';
+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,38 +1,21 @@
-import type { EncodedJsonFarcasterSignatureSchema } from '@farcaster/frame-core'
-import { BaseError, type VerifyAppKey, type 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;

package/esm/jfs.js

@@ -1,102 +1,83 @@
-import {
-  encodedJsonFarcasterSignatureSchema,
-  jsonFarcasterSignatureHeaderSchema,
-} from '@farcaster/frame-core'
-import { ed25519 } from '@noble/curves/ed25519'
-import { BaseError } from './types'
-import { bytesToHex, hexToBytes } from './util'
+import { encodedJsonFarcasterSignatureSchema, jsonFarcasterSignatureHeaderSchema, } from '@farcaster/frame-core';
+import { ed25519 } from '@noble/curves/ed25519';
+import { BaseError, } from './types';
+import { bytesToHex, hexToBytes } from './util';
 export class InvalidJfsDataError extends BaseError {
-  name = 'VerifyJsonFarcasterSignature.InvalidDataError'
+    name = 'VerifyJsonFarcasterSignature.InvalidDataError';
 }
 export class InvalidJfsAppKeyError extends BaseError {
-  name = 'VerifyJsonFarcasterSignature.InvalidAppKeyError'
+    name = 'VerifyJsonFarcasterSignature.InvalidAppKeyError';
 }
 export class VerifyAppKeyError extends BaseError {
-  name = 'VerifyJsonFarcasterSignature.VerifyAppKeyError'
+    name = 'VerifyJsonFarcasterSignature.VerifyAppKeyError';
 }
 export async function verifyJsonFarcasterSignature(data, verifyAppKey) {
-  //
-  // Parse, decode and validate data
-  //
-  const body = encodedJsonFarcasterSignatureSchema.safeParse(data)
-  if (body.success === false) {
-    throw new InvalidJfsDataError('Error parsing data', body.error)
-  }
-  let headerData
-  try {
-    headerData = JSON.parse(
-      Buffer.from(body.data.header, 'base64url').toString('utf-8'),
-    )
-  } catch (error) {
-    throw new InvalidJfsDataError('Error decoding and parsing header')
-  }
-  const header = jsonFarcasterSignatureHeaderSchema.safeParse(headerData)
-  if (header.success === false) {
-    throw new InvalidJfsDataError('Error parsing header', header.error)
-  }
-  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')
-  }
-  //
-  // Verify the signature
-  //
-  const fid = header.data.fid
-  const appKey = header.data.key
-  const appKeyBytes = hexToBytes(appKey)
-  const signedInput = new Uint8Array(
-    Buffer.from(body.data.header + '.' + body.data.payload),
-  )
-  let verifyResult
-  try {
-    verifyResult = ed25519.verify(signature, signedInput, appKeyBytes)
-  } catch (e) {
-    throw new InvalidJfsDataError(
-      'Error checking signature',
-      e instanceof Error ? e : undefined,
-    )
-  }
-  if (!verifyResult) {
-    throw new InvalidJfsDataError('Invalid signature')
-  }
-  //
-  // Verify that the app key belongs to the FID
-  //
-  let appKeyResult
-  try {
-    appKeyResult = await verifyAppKey(fid, appKey)
-  } catch (error) {
-    throw new VerifyAppKeyError(
-      'Error verifying app key',
-      error instanceof Error ? error : undefined,
-    )
-  }
-  if (!appKeyResult.valid) {
-    throw new InvalidJfsAppKeyError('App key not valid for FID')
-  }
-  return { fid, appFid: appKeyResult.appFid, payload }
+    //
+    // Parse, decode and validate data
+    //
+    const body = encodedJsonFarcasterSignatureSchema.safeParse(data);
+    if (body.success === false) {
+        throw new InvalidJfsDataError('Error parsing data', body.error);
+    }
+    let headerData;
+    try {
+        headerData = JSON.parse(Buffer.from(body.data.header, 'base64url').toString('utf-8'));
+    }
+    catch (error) {
+        throw new InvalidJfsDataError('Error decoding and parsing header');
+    }
+    const header = jsonFarcasterSignatureHeaderSchema.safeParse(headerData);
+    if (header.success === false) {
+        throw new InvalidJfsDataError('Error parsing header', header.error);
+    }
+    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');
+    }
+    //
+    // Verify the signature
+    //
+    const fid = header.data.fid;
+    const appKey = header.data.key;
+    const appKeyBytes = hexToBytes(appKey);
+    const signedInput = new Uint8Array(Buffer.from(body.data.header + '.' + body.data.payload));
+    let verifyResult;
+    try {
+        verifyResult = ed25519.verify(signature, signedInput, appKeyBytes);
+    }
+    catch (e) {
+        throw new InvalidJfsDataError('Error checking signature', e instanceof Error ? e : undefined);
+    }
+    if (!verifyResult) {
+        throw new InvalidJfsDataError('Invalid signature');
+    }
+    //
+    // Verify that the app key belongs to the FID
+    //
+    let appKeyResult;
+    try {
+        appKeyResult = await verifyAppKey(fid, appKey);
+    }
+    catch (error) {
+        throw new VerifyAppKeyError('Error verifying app key', error instanceof Error ? error : undefined);
+    }
+    if (!appKeyResult.valid) {
+        throw new InvalidJfsAppKeyError('App key not valid for FID');
+    }
+    return { fid, appFid: appKeyResult.appFid, payload };
 }
-export function createJsonFarcasterSignature({
-  fid,
-  type,
-  privateKey,
-  payload,
-}) {
-  const publicKey = ed25519.getPublicKey(privateKey)
-  const header = { fid, type, key: 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 signature = ed25519.sign(signatureInput, privateKey)
-  const encodedSignature = Buffer.from(signature).toString('base64url')
-  return {
-    header: encodedHeader,
-    payload: encodedPayload,
-    signature: encodedSignature,
-  }
+export function createJsonFarcasterSignature({ fid, type, privateKey, payload, }) {
+    const publicKey = ed25519.getPublicKey(privateKey);
+    const header = { fid, type, key: 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 signature = ed25519.sign(signatureInput, privateKey);
+    const encodedSignature = Buffer.from(signature).toString('base64url');
+    return {
+        header: encodedHeader,
+        payload: encodedPayload,
+        signature: encodedSignature,
+    };
 }

package/esm/neynar.d.ts

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

package/esm/neynar.js

@@ -1,15 +1,13 @@
-import { createVerifyAppKeyWithHub } from './farcaster'
-const apiKey = process.env.NEYNAR_API_KEY || ''
+import { createVerifyAppKeyWithHub } from './farcaster';
+const apiKey = process.env.NEYNAR_API_KEY || '';
 export 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',
-    )
-  }
-  const verifier = createVerifyAppKeyWithHub('https://hub-api.neynar.com', {
-    headers: {
-      'x-api-key': apiKey,
-    },
-  })
-  return verifier(fid, appKey)
-}
+    if (!apiKey) {
+        throw new Error('Environment variable NEYNAR_API_KEY needs to be set to use Neynar for app key verification');
+    }
+    const verifier = createVerifyAppKeyWithHub('https://hub-api.neynar.com', {
+        headers: {
+            'x-api-key': apiKey,
+        },
+    });
+    return verifier(fid, appKey);
+};