Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 1.8 KB

README.md

File metadata and controls

62 lines (41 loc) · 1.8 KB

Farcaster Indexer

Index all profiles and casts on the Farcaster protocol using Merkle Manufactory APIs. Powers Searchcaster, Fardrop and others.

Soon, both profiles and casts will read from Farcaster Hubs instead of client APIs.

How to run locally

Create a new Supabase project via CLI. This will create all the tables for you.

supabase init

Rename .env.example to .env and configure your variables.

cp .env.example .env

If you don't have a Merkle auth token yet, set the FC_MNEMONIC environment variable to your Farcaster recovery phrase and run the following command to generate a token.

yarn install
yarn run auth

Seed your database with protocol data. This will take ~5-10 minutes for profiles and casts (default), or ~30 minutes for everything (include the --verifications flag).

yarn run seed
# or
yarn run seed --verifications

The Merkle APIs don't include a registration timestamp for users. For new registrations, we get the timestamp by watching events on the ID Registry contract. If you were running the previous version of this indexer, you can migrate this data. Otherwise you can skip this step.

yarn run migrate

Run the indexer

yarn start

How to deploy

Create a Supabase account and empty project. Connect to the CLI using your Postgres connection string under Project Settings > Database.

supabase db remote set postgres://postgres:[YOUR-PASSWORD]@db.xxxxxxxxxxxxxxxxxxxx.supabase.co:5432/postgres

Push your database schema

supabase db push

I recommend hosting the indexer on Railway.