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

Files

Cassandra Heart 2391c3a5e3 feat: storage registry support (#1052 )

This PR adds support for storage events and includes the following changes:

Adds support for storage events in the protobufs
Updates the server to handle rent registry events
Updates the logger to include rent registry and storage admin registry events
Adds CLI option for L2 RPC URL
Adds methods to submit rent registry and storage admin registry events in the mock hub
Updates the sync engine to use L2 events provider

2023-07-12 18:43:41 -05:00

docs

Rename UserDataType.FNAME to USERNAME (#1108 )

2023-07-11 17:16:53 -07:00

schemas

feat: storage registry support (#1052 )

2023-07-12 18:43:41 -05: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.