/hub

Primary LanguageTypeScriptMIT LicenseMIT

Farcaster Hub

The Hub is an implementation of a Farcaster Hub defined in the protocol specification. The repository is a monorepo with an executable hub application and shared packages.

Package Name Description
@farcaster/hub An executable Farcaster Hub
@farcaster/flatbuffers Flatbuffer schemas and generated files for types
@farcaster/utils Shared methods and classes
@farcaster/grpc Hub gRPC definitions and client implementation
@farcaster/js Methods and types to easily build messages and interact with a hub via gRPC

Getting Started

To run an instance of the hub, follow the steps to set up your environment and then follow the instructions in @farcaster/hub's README.

Contributing

Please see CONTRIBUTING.md