mirror of
https://github.com/farcasterxyz/hub-monorepo.git
synced 2026-01-14 15:47:57 -05:00
59bcfe7fba
## Motivation - Reduce network bandwidth with gossip improvements - Support experimental sync APIs (note: may be removed or significantly altered in the future) ## Change Summary - Update p2p gossip to reduce unnecessary contact updates - Add experimental sync control APIs ## 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) - [x] PR includes [documentation](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#32-writing-docs) if necessary. - [x] All [commits have been signed](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#22-signing-commits) ## Additional Context If this is a relatively large or complex change, provide more details here that will help reviewers <!-- start pr-codex --> --- ## PR-Codex overview This PR updates versions and adds endpoints for sync control in `hub-web` and `hub-nodejs`, and includes various improvements and fixes in the `hubble` app. ### Detailed summary - Updated `hub-web` version to 0.8.12 - Updated `hub-nodejs` version to 0.11.19 - Added endpoints for sync control - Improved gossip contact info frequency in `hubble` app - Added experimental HTTP APIs for sync control in `hubble` app > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
Hubble Monorepo
This monorepo contains Hubble, an official Farcaster Hub implementation, and other packages used to communicate with Hubble.
Getting Started
- To run Hubble, see the Hubble docs.
- To use Hubble, see the hub-nodejs docs.
- To use the HTTP API to read Hubble data, see the HTTP API docs
Packages
| Package Name | Description |
|---|---|
| @farcaster/hubble | A Farcaster Hub implementation |
| @farcaster/hub-nodejs | A Node.js client library for Hubble |
| @farcaster/hub-web | A Browser client library for Hubble |
| @farcaster/core | Shared code between all packages |
Contributing
Please see CONTRIBUTING.md