mirror of https://github.com/farcasterxyz/hub-monorepo.git synced 2026-04-18 03:00:22 -04:00

Files

Varun Srinivasan 57c540d520 chore: release new version of packages (#761 )

* chore: changelog bump to app/hubble to prep for release

* chore: don't minor bump hubble and protobufs for client changes

* chore: bump versions for publishing

2023-03-26 18:17:47 -07:00

docs

docs(hub-nodejs): improve docs based on feedback (#664 )

2023-03-16 21:25:25 -07:00

src

docs: Use SSL or Insecure clients in examples (#754 )

2023-03-25 13:20:07 -07:00

.eslintrc.cjs

feat: add protobufs schema and migrate utils to new @farcaster/protoutils package (#447 )

2023-01-23 23:08:57 -05:00

CHANGELOG.md

chore: release new version of packages (#761 )

2023-03-26 18:17:47 -07:00

package.json

chore: release new version of packages (#761 )

2023-03-26 18:17:47 -07:00

README.md

docs: update READMEs to match latest behavior (#601 )

2023-02-22 20:36:52 -08:00

tsconfig.json

feat: add protobufs schema and migrate utils to new @farcaster/protoutils package (#447 )

2023-01-23 23:08:57 -05:00

tsup.config.ts

chore: bump versions (#484 )

2023-01-30 21:02:51 -05: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 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.