mirror of https://github.com/farcasterxyz/hub-monorepo.git synced 2026-01-27 22:18:00 -05:00

Files

Sanjay 1fcfd49517 fix: last block bugs with events providers (#1243 )

* fix: last block bugs with events providers

* Remove usages of name registry worker

* Better defaults for OP constants

* Fix tests

* Add changeset

2023-08-14 13:32:45 -07:00

docs

feat: Storage RPC (#1211 )

2023-08-03 17:10:25 -07:00

schemas

fix: last block bugs with events providers (#1243 )

2023-08-14 13:32:45 -07:00

README.md

docs(hubble): update api, event and message docs (#1148 )

2023-07-15 22:38:55 -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,docs.md -I schemas schemas/*.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.