fix: handle neynar responses + add additional information

jest.config.js

@@ -3,5 +3,5 @@ module.exports = {
   transform: {
     '^.+\\.tsx?$': 'ts-jest',
   },
-  testMatch: ['**/?(*.)+(spec|test).ts'],
+  testMatch: ['**/?(*.)+(spec|test|integ).ts'],
 };

package.json

@@ -17,8 +17,9 @@
     "format": "prettier --log-level warn --write .",
     "format:check": "prettier --check .",
     "prebuild": "rimraf dist",
-    "test": "jest .",
-    "test:coverage": "jest . --coverage",
+    "test": "jest --testPathIgnorePatterns=\\.integ\\.",
+    "test:integration": "jest --testPathIgnorePatterns=\\.test\\.",
+    "test:coverage": "jest . --coverage ",
     "release:check": "changeset status --verbose --since=origin/main",
     "release:publish": "yarn install && yarn build && changeset publish",
     "release:version": "changeset version && yarn install --immutable"

src/core/getFrameAccountAddress.test.ts

@@ -1,6 +1,21 @@
 import { getFrameAccountAddress } from './getFrameAccountAddress';
 import { mockNeynarResponse } from './mock';
 
+const bulkUserLookupMock = jest.fn();
+jest.mock('../internal/neynar/neynarClient', () => {
+  return {
+    NeynarClient: jest.fn().mockImplementation(() => {
+      return {
+        user: {
+          bulkUserLookup: bulkUserLookupMock,
+          // other user functions can be mocked here
+        },
+        // other properties and methods of NeynarClient can be mocked here
+      };
+    }),
+  };
+});
+
 jest.mock('@farcaster/hub-nodejs', () => {
   return {
     getSSLHubRpcClient: jest.fn().mockReturnValue({
@@ -23,7 +38,7 @@ describe('getFrameAccountAddress', () => {
   it('should return the first verification for valid input', async () => {
     const fid = 1234;
     const addresses = ['0xaddr1'];
-    mockNeynarResponse(fid, addresses);
+    mockNeynarResponse(fid, addresses, bulkUserLookupMock);
 
     const response = await getFrameAccountAddress(fakeFrameData, fakeApiKey);
     expect(response).toEqual(addresses[0]);
@@ -32,7 +47,7 @@ describe('getFrameAccountAddress', () => {
   it('when the call from farcaster fails we should return undefined', async () => {
     const fid = 1234;
     const addresses = ['0xaddr1'];
-    const { validateMock } = mockNeynarResponse(fid, addresses);
+    const { validateMock } = mockNeynarResponse(fid, addresses, bulkUserLookupMock);
     validateMock.mockClear();
     validateMock.mockResolvedValue({
       isOk: () => {

src/core/getFrameAccountAddress.ts

@@ -1,4 +1,5 @@
 import { getFrameValidatedMessage } from './getFrameValidatedMessage';
+import { NeynarClient } from '../internal/neynar/neynarClient';
 
 type FidResponse = {
   verifications: string[];
@@ -26,16 +27,10 @@ async function getFrameAccountAddress(
   // Get the Farcaster ID from the message
   const farcasterID = validatedMessage?.data?.fid ?? 0;
   // Get the user verifications from the Farcaster Indexer
-  const options = {
-    method: 'GET',
-    url: `https://api.neynar.com/v2/farcaster/user/bulk?fids=${farcasterID}`,
-    headers: { accept: 'application/json', api_key: NEYNAR_API_KEY },
-  };
-  const resp = await fetch(options.url, { headers: options.headers });
-  const responseBody = await resp.json();
-  // Get the user verifications from the response
-  if (responseBody.users) {
-    const userVerifications = responseBody.users[0] as FidResponse;
+  const neynarClient = new NeynarClient();
+  const bulkUserLookupResponse = await neynarClient.user.bulkUserLookup([farcasterID]);
+  if (bulkUserLookupResponse?.users) {
+    const userVerifications = bulkUserLookupResponse?.users[0] as FidResponse;
     if (userVerifications.verifications) {
       return userVerifications.verifications[0];
     }

src/core/getFrameValidatedMessage.test.ts

@@ -1,6 +1,21 @@
 import { mockNeynarResponse } from './mock';
 import { getFrameValidatedMessage } from './getFrameValidatedMessage';
 
+const bulkUserLookupMock = jest.fn();
+jest.mock('../internal/neynar/neynarClient', () => {
+  return {
+    NeynarClient: jest.fn().mockImplementation(() => {
+      return {
+        user: {
+          bulkUserLookup: bulkUserLookupMock,
+          // other user functions can be mocked here
+        },
+        // other properties and methods of NeynarClient can be mocked here
+      };
+    }),
+  };
+});
+
 jest.mock('@farcaster/hub-nodejs', () => {
   return {
     getSSLHubRpcClient: jest.fn().mockReturnValue({
@@ -16,7 +31,7 @@ describe('getFrameValidatedMessage', () => {
   it('should return undefined if the message is invalid', async () => {
     const fid = 1234;
     const addresses = ['0xaddr1'];
-    const { validateMock } = mockNeynarResponse(fid, addresses);
+    const { validateMock } = mockNeynarResponse(fid, addresses, bulkUserLookupMock);
     validateMock.mockClear();
     validateMock.mockResolvedValue({
       isOk: () => {
@@ -32,7 +47,7 @@ describe('getFrameValidatedMessage', () => {
   it('should return the message if the message is valid', async () => {
     const fid = 1234;
     const addresses = ['0xaddr1'];
-    mockNeynarResponse(fid, addresses);
+    mockNeynarResponse(fid, addresses, bulkUserLookupMock);
     const fakeFrameData = {
       trustedData: {},
     };

src/core/mock.ts

@@ -14,14 +14,15 @@ export function buildFarcasterResponse(fid: number) {
   };
 }
 
-export function mockNeynarResponse(fid: number, addresses: string[]) {
+export function mockNeynarResponse(fid: number, addresses: string[], lookupMock: jest.Mock) {
   const neynarResponse = {
     users: [
       {
         verifications: addresses,
       },
     ],
   };
+  lookupMock.mockResolvedValue(neynarResponse);
 
   const getSSLHubRpcClientMock = require('@farcaster/hub-nodejs').getSSLHubRpcClient;
   const validateMock = getSSLHubRpcClientMock().validateMessage as jest.Mock;
@@ -33,12 +34,7 @@ export function mockNeynarResponse(fid: number, addresses: string[]) {
   });
 
   validateMock.mockResolvedValue(buildFarcasterResponse(fid));
-  // Mock the response from Neynar
-  global.fetch = jest.fn(() =>
-    Promise.resolve({
-      json: () => Promise.resolve(neynarResponse),
-    }),
-  ) as jest.Mock;
+
   return {
     validateMock,
   };

src/internal/neynar/exceptions/FetchError.ts

@@ -0,0 +1,6 @@
+export class FetchError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'FetchError';
+  }
+}

src/internal/neynar/neynar.integ.ts

@@ -0,0 +1,14 @@
+import { NeynarClient } from './neynarClient';
+
+describe('integration tests', () => {
+  const neynarClient = new NeynarClient();
+
+  it('bulk data lookup should find all users', async () => {
+    const fidsToLookup = [3, 194519]; // dwr and polak.eth fids
+    const response = await neynarClient.user.bulkUserLookup(fidsToLookup);
+    expect(response?.users.length).toEqual(2);
+    for (const user of response?.users!) {
+      expect(fidsToLookup).toContain(user.fid);
+    }
+  });
+});

src/internal/neynar/neynarClient.ts

@@ -0,0 +1,14 @@
+import { NeynarUserFunction } from './user/neynarUserFunctions';
+
+export class NeynarClient {
+  private apiKey;
+
+  public user: NeynarUserFunction;
+  constructor(apiKey = 'NEYNAR_API_DOCS') {
+    this.apiKey = apiKey;
+
+    // Import various function types at construction to have better readability and
+    // composability of our interfaces.
+    this.user = new NeynarUserFunction(apiKey);
+  }
+}

src/internal/neynar/user/neynarUserFunctions.test.ts

@@ -0,0 +1,33 @@
+import { NeynarClient } from '../neynarClient';
+import { FetchError } from '../exceptions/FetchError';
+
+describe('neynar user functions', () => {
+  let fetchMock = jest.fn();
+  let status = 200;
+
+  beforeEach(() => {
+    status = 200;
+    global.fetch = jest.fn(() =>
+      Promise.resolve({
+        status,
+        json: fetchMock,
+      }),
+    ) as jest.Mock;
+  });
+
+  it('should return fetch response correctly', async () => {
+    fetchMock.mockResolvedValue({
+      users: [{ fid: 1 }],
+    });
+    const client = new NeynarClient();
+    const resp = await client.user.bulkUserLookup([1]);
+    expect(resp?.users[0]?.fid).toEqual(1);
+  });
+
+  it('fails on a non-200', async () => {
+    status = 401;
+    const client = new NeynarClient();
+    const resp = client.user.bulkUserLookup([1]);
+    await expect(resp).rejects.toThrow(FetchError);
+  });
+});

src/internal/neynar/user/neynarUserFunctions.ts

@@ -0,0 +1,78 @@
+import { FetchError } from '../exceptions/FetchError';
+
+export interface NeynarUserModel {
+  fid: number;
+  custody_address: string;
+  username: string;
+  display_name: string;
+  pfp_url: string;
+  profile: {
+    bio: {
+      text: string;
+    };
+  };
+  follower_count: number;
+  verifications: string[];
+}
+export interface NeynarBulkUserLookupModel {
+  users: NeynarUserModel[];
+}
+
+export class NeynarUserFunction {
+  private apiKey;
+  constructor(apiKey = 'NEYNAR_API_DOCS') {
+    this.apiKey = apiKey;
+  }
+  async bulkUserLookup(farcasterIDs: number[]): Promise<NeynarBulkUserLookupModel | undefined> {
+    const options = {
+      method: 'GET',
+      url: `https://api.neynar.com/v2/farcaster/user/bulk?fids=${farcasterIDs.join(',')}`,
+      headers: { accept: 'application/json', api_key: this.apiKey },
+    };
+    const resp = await fetch(options.url, { headers: options.headers });
+    if (resp.status !== 200) {
+      throw new FetchError(`non-200 status returned from neynar : ${resp.status}`);
+    }
+    const responseBody = await resp.json();
+    return this.convertToNeynarResponseModel(responseBody);
+  }
+
+  private convertToNeynarResponseModel(data: any): NeynarBulkUserLookupModel | undefined {
+    if (!data) {
+      return;
+    }
+
+    const response: NeynarBulkUserLookupModel = {
+      users: [],
+    };
+
+    for (const user of data.users) {
+      const formattedUser = this.convertToNeynarUserModel(user);
+      if (formattedUser) {
+        response.users.push(formattedUser);
+      }
+    }
+    return response;
+  }
+
+  private convertToNeynarUserModel(data: any): NeynarUserModel | undefined {
+    if (!data) {
+      return;
+    }
+
+    return {
+      fid: data.fid ?? 0,
+      custody_address: data.custody_address ?? '',
+      username: data.username ?? '',
+      display_name: data.display_name ?? '',
+      pfp_url: data.pfp_url ?? '',
+      profile: {
+        bio: {
+          text: data.profile?.bio?.text ?? '',
+        },
+      },
+      follower_count: data.follower_count ?? 0,
+      verifications: Array.isArray(data.verifications) ? data.verifications : [],
+    };
+  }
+}