mirror of https://github.com/farcasterxyz/hub-monorepo.git synced 2026-01-30 07:28:01 -05:00

Files

Sanjay 421c385453 feat: Add sync stats to getInfo call (#916 )

* refactor: Rename sync events flag for clarity

* feat: Add sync statuts to HubInfo RPC call

* feat: Add sync stats to getInfo rpc call

* re-patch hub-web to use default export as before

* changeset

2023-04-25 10:40:59 -07:00

docs

feat: merge protobufs and utils into core package (#818 )

2023-04-04 19:21:30 -07:00

schemas

feat: Add sync stats to getInfo call (#916 )

2023-04-25 10:40:59 -07:00

README.md

feat: merge protobufs and utils into core package (#818 )

2023-04-04 19:21:30 -07:00

README.md

@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-doc binary 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 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.