mirror of
https://github.com/farcasterxyz/hub-monorepo.git
synced 2026-01-10 05:38:07 -05:00
db3404403c
## Why is this change needed? Describe why this issue should be fixed and link to any relevant design docs, issues or other relevant items. ## Merge Checklist _Choose all relevant options below by adding an `x` now or at any time before submitting for review_ - [ ] PR title adheres to the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard - [ ] PR has a [changeset](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#35-adding-changesets) - [ ] 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 focuses on correcting a typo in the comment of the `syncEngine.test.ts` file and ensuring that the test expectations regarding the synchronization functionality are clearly articulated. ### Detailed summary - Corrected the typo in the comment from "becuase" to "because". - Confirmed that the `result.successCount` is expected to equal `1`. - Verified that `oldSnapshot.excludedHashes` does not equal the excluded hashes from the new snapshot. - Checked that the `shouldSync` status from `syncEngine.syncStatus` is truthy. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
Hubble Monorepo
This monorepo contains Hubble, a Farcaster Hub implementation, and other packages used to communicate with Hubble.
Getting Started
See CONTRIBUTING.md to set up your developer environment and learn about how to contribute.
Code Organization
The repository is a monorepo with a primary application in the /apps/ folder that imports several packages /packages/. It is written primarily in Typescript and uses Yarn to orchestrate tasks and TurboRepo as its build system. Some performance intensive code is written in Rust and compiled with Cargo.
Applications
| App Name | Description |
|---|---|
| @farcaster/hubble | A Farcaster Hub implementation |
To run Hubble, please see the Hubble docs.
Packages
| Package Name | Description |
|---|---|
| @farcaster/shuttle | A package that streams Hubble events to Postgres |
| @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 |