mirror of
https://github.com/farcasterxyz/hub-monorepo.git
synced 2026-04-18 03:00:22 -04:00
This is required to decentralize user location. ## Merge Checklist _Choose all relevant options below by adding an `x` now or at any time before submitting for review_ - [x] PR title adheres to the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard - [x] PR has a [changeset](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#35-adding-changesets) - [x] PR has been tagged with a change label(s) (i.e. documentation, feature, bugfix, or chore) - [ ] PR includes [documentation](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#32-writing-docs) if necessary. <!-- start pr-codex --> --- ## PR-Codex overview This PR introduces a new feature to add user location data to the protocol, including validation for latitude and longitude, and updates across several files to support this functionality. ### Detailed summary - Added `USER_DATA_TYPE_LOCATION` to `protobufs/schemas/message.proto`. - Updated `userDataTypeFromJSON` and `userDataTypeToJSON` functions to handle location type. - Implemented location handling in `packages/hub-web`, `packages/hub-nodejs`, and `packages/core`. - Created validation functions for latitude and longitude. - Added tests for user location data handling in `apps/hubble/src/rpc/test/userDataService.test.ts` and `packages/core/src/validations.test.ts`. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
@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 |
| OnChainEvent | Types for Farcaster onchain events | docs |
| HubEvent | Types for hub events | docs |
| RPC | Types for gRPC APIs exposed by Hubs | docs |
| Gossip | Types for gossiping data between Hubs | |
| HubState | Types for for maintaining internal state |
Getting Started
Compiling Protobufs
If you make changes to the protobufs, you will need to run yarn protoc in the following directories to compile and generate the JS files
packages/corepackages/hub-nodejspackages/hub-web
Generate Bindings
Coming soon
Docs
Docs for the protobufs is under ../apps/hubble/www/docs/docs