0.2.0 • Published 1 year ago
@farcaster/protobufs v0.2.0
@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 |
| RPC | Types for gRPC APIs exposed by Hubs | docs |
| Gossip | Types for gossiping data between Hubs | |
| IdRegistryEvent | Types for representing on-chain activity | |
| NameRegistryEvent | Types for representing on-chain activity | |
| HubState | Types for for maintaining internal state |
Getting Started
Generate Bindings
Coming soon
Generate Docs
Documentation of gRPC endpoints is done manually, but protoc can be used to generate Message docs:
- Install protoc
- Download latest
protoc-gen-docbinary from the repo and place in this folder - On OS X, you may need to remove the binary from quaratine with
xattr -d com.apple.quarantine protoc-gen-doc - Run
protoc --plugin=protoc-gen-doc=./protoc-gen-doc --doc_out=. --doc_opt=markdown,message.md src/schemas/message.proto
The output should be merged with the existing documentation by hand because it makes some errors like not correctly documenting oneOf. It also organizes items alphabetically which makes it harder to parse.