Note

The project is under active development.

Ethereum Follow Protocol API

A native Ethereum protocol for following and tagging Ethereum accounts.

Important links

• Documentation: docs.ethfollow.xyz/api

Getting started with development

Prerequisites

• Bun runtime
• Cloudflare Wrangler CLI
• Ethereum Follow Protocol Indexer

Setup

Assuming you have an indexer running and postgres database setup, follow these steps to get started with development:

0. Ensure development tools are up to date

   bun upgrade

   bun add --global wrangler@latest

1. Clone the repository (I'm using cli.github.com)

   gh repo clone ethereumfollowprotocol/api

2. Install dependencies

   bun install

3. Setup environment variables

   cp .dev.vars.example .dev.vars

   [!NOTE] .dev.vars is Cloudflare Workers' equivalent of .env (learn more). Check .dev.vars for required variables and how to get them.

4. Start development server and make requests

   bun dev

   Make a request to the health endpoint to check if server is running

   curl 'http://localhost:8787/v1/health'   
   # should return 'ok'

   Make a request to the postgres health endpoint to check if the database is connected

   curl 'http://localhost:8787/v1/postgres-health'
   # should return 'ok'

Wrangler

Wrangler is a CLI tool through which you interact with Cloudflare Workers runtime and Cloudflare Platform. It is used to:

• run the development server,
• publish the API to Cloudflare Workers,
• CRUD KV namespaces, R2 Buckets, D1 Database, and a number of other CF platform resources,

See a list of all Wrangler commands here.

---

TODO: Continue documentation

---

Follow @ethfollowpr on 𝕏 for updates and join the Discord to get involved.