brucexc / go-farcaster

Farcaster Go Client

This is the Golang implementation for Farcaster client based on the official v2 API documentation.

Inspired by Rust and Python client implementations. Coauthored by GitHub Copilot and ChatGPT. 🙏

Installation

go get github.com/ertan/go-farcaster

Usage

apiUrl := "https://api.warpcast.com"
mnemonic := "Farcaster mnemonic"
providerWs := "Optional: Goerli endpoint"
fc := farcaster.NewFarcasterClient(apiUrl, mnemonic, providerWs)
casts, _, err := fc.Casts.GetRecentCasts(10)

You can find other examples under examples/ directory.

Development

In order to test the examples you need to set the following environment variables in .env file in the repo's root directory.

FARCASTER_API_URL    = "https://api.warpcast.xyz"
FARCASTER_MNEMONIC   = "your mnemonic"
ETHEREUM_PROVIDER_WS = "your Goerli endpoint"

Registry is built based on the event logs to get fid <> fname <> address mappings. If ETHEREUM_PROVIDER_WS variable isn't set, you can still use the API. Mnemonic is required for authorization to access most of the API endpoints. However, it's not required by the client as some endpoints are open to public.

Examples

Some examples to test the client are:

go run examples/casts/casts_example.go

go run examples/reactions/reactions_example.go

go run examples/users/users_example.go

Future Work

• Tests! There are currently no unit tests for the client, just examples. 😅
• Missing comments on exported functions and structs.