mirror of
https://github.com/farcasterxyz/hub-monorepo.git
synced 2026-01-14 07:38:04 -05:00
@farcaster/protobufs
Specifications for API's and data formats used in Hubble, including both Farcaster protocol types and Hubble specific types.
| Schema | Type Description | Docs |
|---|---|---|
| Message | Types for Farcaster deltas | docs |
| OnChainEvent | Types for Farcaster onchain events | docs |
| HubEvent | Types for hub events | docs |
| RPC | Types for gRPC APIs exposed by Hubs | docs |
| Gossip | Types for gossiping data between Hubs | |
| HubState | Types for for maintaining internal state |
Getting Started
Compiling Protobufs
If you make changes to the protobufs, you will need to run yarn protoc in the following directories to compile and generate the JS files
packages/corepackages/hub-nodejspackages/hub-web
Generate Bindings
Coming soon
Docs
Docs for the protobufs is under ../apps/hubble/www/docs/docs