diff --git a/lib/utils/neynar-client.js b/lib/utils/neynar-client.js index 1f9207dbe..d9d47ac56 100644 --- a/lib/utils/neynar-client.js +++ b/lib/utils/neynar-client.js @@ -1,360 +1,344 @@ // @flow import invariant from 'invariant'; import { getMessageForException } from './errors.js'; -import type { - NeynarChannel, - NeynarUser, - NeynarUserWithViewerContext, -} from '../types/farcaster-types.js'; - -type FetchFollowersResponse = { - +result: { - +users: $ReadOnlyArray, - +next: { - +cursor: ?string, +import type { NeynarChannel, NeynarUser } from '../types/farcaster-types.js'; + +type FetchRelevantFollowersResponse = { + +all_relevant_followers_dehydrated: $ReadOnlyArray<{ + +user: { + +fid: number, + ... }, - }, + ... + }>, + ... }; type FetchFarcasterChannelsResponse = { +channels: $ReadOnlyArray, +next: { +cursor: ?string, }, }; type FetchFarcasterChannelByNameResponse = { +channels: $ReadOnlyArray, }; type FetchUsersResponse = { +users: $ReadOnlyArray, }; type FetchFarcasterChannelInfoResponse = { +channel: NeynarChannel, }; export type FarcasterUser = { +username: string, +pfpURL: string, }; const neynarBaseURL = 'https://api.neynar.com/'; const neynarURLs = { '1': `${neynarBaseURL}v1/farcaster/`, '2': `${neynarBaseURL}v2/farcaster/`, }; function getNeynarURL( apiVersion: string, apiCall: string, params: { [string]: string }, ): string { const neynarURL = neynarURLs[apiVersion]; invariant( neynarURL, `could not find Neynar URL for apiVersion ${apiVersion}`, ); return `${neynarURL}${apiCall}?${new URLSearchParams(params).toString()}`; } -const fetchFollowerLimit = 150; const fetchFollowedChannelsLimit = 100; const fetchChannelsLimit = 50; class NeynarClient { apiKey: string; constructor(apiKey: string) { this.apiKey = apiKey; } // We're using the term "friend" for a bidirectional follow async fetchFriendFIDs(fid: string): Promise { - const fids = []; - let paginationCursor = null; - - do { - const params: { [string]: string } = { - fid, - viewerFid: fid, - limit: fetchFollowerLimit.toString(), - ...(paginationCursor ? { cursor: paginationCursor } : null), - }; - - const url = getNeynarURL('1', 'followers', params); - - try { - const response = await fetch(url, { - method: 'GET', - headers: { - Accept: 'application/json', - api_key: this.apiKey, - }, - }); + const params: { [string]: string } = { + target_fid: fid, + viewer_fid: fid, + }; - const json: FetchFollowersResponse = await response.json(); - const { users } = json.result; + const url = getNeynarURL('2', 'followers/relevant', params); - for (const user of users) { - if (user.viewerContext.following) { - fids.push(user.fid.toString()); - } - } + try { + const response = await fetch(url, { + method: 'GET', + headers: { + Accept: 'application/json', + api_key: this.apiKey, + }, + }); - paginationCursor = json.result.next.cursor; - } catch (error) { - console.log( - 'Failed to fetch friend FIDs:', - getMessageForException(error) ?? 'unknown', - ); - throw error; - } - } while (paginationCursor); + const json: FetchRelevantFollowersResponse = await response.json(); + const { all_relevant_followers_dehydrated } = json; - return fids; + return all_relevant_followers_dehydrated.map(follower => + follower.user.fid.toString(), + ); + } catch (error) { + console.log( + 'Failed to fetch friend FIDs:', + getMessageForException(error) ?? 'unknown', + ); + throw error; + } } async fetchFollowedFarcasterChannelsWithFilter( fid: string, filterFn: (channel: NeynarChannel) => boolean, ): Promise { const farcasterChannels = []; let paginationCursor = null; do { const params: { [string]: string } = { fid, limit: fetchFollowedChannelsLimit.toString(), ...(paginationCursor ? { cursor: paginationCursor } : null), }; const url = getNeynarURL('2', 'user/channels', params); try { const response = await fetch(url, { method: 'GET', headers: { Accept: 'application/json', api_key: this.apiKey, }, }); const json: FetchFarcasterChannelsResponse = await response.json(); const { channels, next } = json; channels.forEach(channel => { if (filterFn(channel)) { farcasterChannels.push(channel); } }); paginationCursor = next.cursor; } catch (error) { console.log( 'Failed to fetch followed Farcaster channels:', getMessageForException(error) ?? 'unknown', ); throw error; } } while (paginationCursor); return farcasterChannels; } fetchFollowedFarcasterChannels(fid: string): Promise { return this.fetchFollowedFarcasterChannelsWithFilter(fid, () => true); } fetchLedFarcasterChannels(fid: string): Promise { return this.fetchFollowedFarcasterChannelsWithFilter( fid, channel => channel.lead.fid === parseInt(fid), ); } async fetchFarcasterChannelByName( channelName: string, ): Promise { const params: { [string]: string } = { q: channelName, }; const url = getNeynarURL('2', 'channel/search', params); try { const response = await fetch(url, { method: 'GET', headers: { Accept: 'application/json', api_key: this.apiKey, }, }); const json: FetchFarcasterChannelByNameResponse = await response.json(); const { channels } = json; for (const channel of channels) { if (channel.name.toLowerCase() === channelName.toLowerCase()) { return channel; } } return null; } catch (error) { console.log( 'Failed to search Farcaster channel by name:', getMessageForException(error) ?? 'unknown', ); throw error; } } async getFarcasterUsers( fids: $ReadOnlyArray, ): Promise> { const fidsLeft = [...fids]; const results: Array = []; do { // Neynar API allows querying 100 at a time const batch = fidsLeft.splice(0, 100); const url = getNeynarURL('2', 'user/bulk', { fids: batch.join(',') }); try { const response = await fetch(url, { method: 'GET', headers: { Accept: 'application/json', api_key: this.apiKey, }, }); const json: FetchUsersResponse = await response.json(); const { users } = json; const neynarUserMap = new Map(); for (const neynarUser of users) { neynarUserMap.set(neynarUser.fid, neynarUser); } for (const fid of batch) { const neynarUser = neynarUserMap.get(parseInt(fid)); results.push( neynarUser ? { username: neynarUser.username, pfpURL: neynarUser.pfp_url } : null, ); } } catch (error) { console.log( 'Failed to fetch Farcaster usernames:', getMessageForException(error) ?? 'unknown', ); throw error; } } while (fidsLeft.length > 0); return results; } async getAllChannels(): Promise> { const farcasterChannels = []; let paginationCursor = null; do { const params: { [string]: string } = { limit: fetchChannelsLimit.toString(), ...(paginationCursor ? { cursor: paginationCursor } : null), }; const url = getNeynarURL('2', 'channel/list', params); try { const response = await fetch(url, { method: 'GET', headers: { Accept: 'application/json', api_key: this.apiKey, }, }); const json: FetchFarcasterChannelsResponse = await response.json(); const { channels, next } = json; channels.forEach(channel => { farcasterChannels.push(channel); }); paginationCursor = next.cursor; } catch (error) { console.log( 'Failed to fetch all Farcaster channels:', getMessageForException(error) ?? 'unknown', ); throw error; } } while (paginationCursor); return farcasterChannels; } async fetchFarcasterChannelInfo( channelID: string, viewerFID: string, ): Promise { const params: { [string]: string } = { id: channelID, type: 'id', viewer_fid: viewerFID, }; const url = getNeynarURL('2', 'channel', params); try { const response = await fetch(url, { method: 'GET', headers: { Accept: 'application/json', api_key: this.apiKey, }, }); const json: FetchFarcasterChannelInfoResponse = await response.json(); return json.channel; } catch (error) { console.log( 'Failed to fetch Farcaster channel info:', getMessageForException(error) ?? 'unknown', ); throw error; } } async checkIfCurrentUserFIDIsValid(fid: string): Promise { const url = getNeynarURL('2', 'user/bulk', { fids: fid }); try { const response = await fetch(url, { method: 'GET', headers: { Accept: 'application/json', api_key: this.apiKey, }, }); return response.ok; } catch (error) { console.log( 'Failed to check if current user FID is valid:', getMessageForException(error) ?? 'unknown', ); throw error; } } } export { NeynarClient };