## Why is this change needed?
Release new shuttle version
## 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
- [ ] 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 focuses on updating the version of the `@farcaster/shuttle`
package from `0.7.3` to `0.7.4`, including a fix related to stream
monitoring.
### Detailed summary
- Updated version in `packages/shuttle/package.json` from `0.7.3` to
`0.7.4`.
- Added a new entry in `CHANGELOG.md` for version `0.7.4`:
- Fix: use shard id from event in stream monitoring.
- Deleted the `.changeset/giant-masks-deny.md` file.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
If we subscribe to all shards in a single event stream, using a shard
index that's provided by the user at initialization doesn't work.
## 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 focuses on enhancing the `EventStreamMonitor` class by
incorporating `shardId` into various methods to improve event streaming
and monitoring capabilities.
### Detailed summary
- Updated `streamKey` to include `shardId`.
- Modified `blockCountsKey`, `currentBlockNumberKey`, and
`currentBlockTimestampKey` to accept `shardId`.
- Adjusted `setBlockCounts`, `blockCompleted`, and `onEventProcessed`
methods to use `shardId`.
- Changed Redis key retrievals to utilize `shardId`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Release new shuttle version to fix event stream monitoring
## 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
- [ ] 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 focuses on updating the version of the `@farcaster/shuttle`
package from `0.7.2` to `0.7.3` and includes a changelog entry for the
new patch version that addresses a specific fix in event stream
monitoring.
### Detailed summary
- Updated `version` of `@farcaster/shuttle` from `0.7.2` to `0.7.3` in
`packages/shuttle/package.json`.
- Added changelog entry for version `0.7.3`:
- Fixed issue to maintain counts only for expected events in event
stream monitoring.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
We're producing a lot of errors with 0 missing events due to this bug.
## 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 focuses on improving event stream monitoring by ensuring that
only counts for expected events are maintained, thereby optimizing the
handling of event data.
### Detailed summary
- Modified the `setBlockCounts` method in the `eventStream.ts` file.
- Changed the way event counts are retrieved: now checks if the count is
`undefined` before setting it in Redis.
- Removed the default count of `0`, ensuring only relevant counts are
stored.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Release new version of shuttle.
## 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
- [ ] 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 focuses on updating the version of the `@farcaster/shuttle`
package from `0.7.1` to `0.7.2`, including a new patch change that adds
a custom Redis key prefix for monitoring.
### Detailed summary
- Updated `version` in `packages/shuttle/package.json` from `0.7.1` to
`0.7.2`
- Added a new entry in `CHANGELOG.md` for version `0.7.2`:
- Patch Change: `3cd6a779`: fix: add custom redis key prefix for
monitoring
- Removed the `.changeset/spicy-chairs-judge.md` file.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
If clients split up streams beyond host/shard, the keys in redis need a
special prefix to remain unique per stream.
## 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 custom Redis key prefix for monitoring in the
`EventStreamMonitor` class, enhancing key management for event streams.
### Detailed summary
- Added a new property `redisPrefix: string;` in the
`EventStreamMonitor` class.
- Updated the constructor to accept `redisPrefix: string`.
- Modified the `streamKey` method to use the new `redisPrefix` for
generating keys.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Release new packages to pick up event stream observability updates.
## 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
- [ ] 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 focuses on updating versions and changelogs for several packages
within the `farcaster` project, along with adding new features and fixes
related to event stream monitoring.
### Detailed summary
- Updated `@farcaster/core` version from `0.18.0` to `0.18.1`.
- Added monitoring for event stream based on snapchain block numbers.
- Updated `@farcaster/hub-web` version from `0.11.0` to `0.11.1`.
- Updated `@farcaster/hub-nodejs` version from `0.15.0` to `0.15.1`.
- Updated `@farcaster/shuttle` version from `0.7.0` to `0.7.1`.
- Updated dependencies across multiple packages to reflect new versions.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Track event stream stats by both shard and host since streams are per
host.
## 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 enhances the `EventStreamMonitor` and `HubEventStreamConsumer`
classes to track event stream statistics by `host`, improving monitoring
capabilities for events processed in a distributed environment.
### Detailed summary
- Added a new `host` property to `EventStreamMonitor`.
- Updated the constructor of `EventStreamMonitor` to accept `host` as a
parameter.
- Modified methods to use `streamKey()` for generating keys.
- Enhanced statistics tracking by including `host` in metrics.
- Adjusted `HubEventStreamConsumer` to call `onEventProcessed` with
`hubEvt`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Detect when there are missed events using the `BlockConfirmed` event.
## 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 focuses on enhancing the event stream monitoring capabilities by
introducing new types and methods to track block events, including event
counts by type, and updating the related structures across multiple
packages.
### Detailed summary
- Introduced `eventCountsByType` in `BlockConfirmedBody`.
- Added `BlockConfirmedBody_EventCountsByTypeEntry` interface.
- Modified `createBaseBlockConfirmedBody` to initialize
`eventCountsByType`.
- Updated serialization and deserialization logic for
`BlockConfirmedBody` to handle `eventCountsByType`.
- Created `EventStreamMonitor` class to manage event counts and monitor
block events.
- Integrated `EventStreamMonitor` into `HubEventStreamConsumer`.
- Enhanced error handling and logging for missed events and old events
in the event stream.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Release new versions of all packages.
## 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 focuses on updating the versions of various packages in the
`@farcaster` ecosystem, along with minor changes and enhancements
related to client library generation and type guards.
### Detailed summary
- Updated `@farcaster/core` version from `0.17.1` to `0.18.0`.
- Updated `@farcaster/hub-web` version from `0.10.0` to `0.11.0`.
- Updated `@farcaster/shuttle` version from `0.6.18` to `0.7.0`.
- Updated `@farcaster/hub-nodejs` version from `0.14.1` to `0.15.0`.
- Added changelog entries for versions `0.18.0`, `0.11.0`, `0.15.0`, and
`0.7.0`.
- Included minor changes for client library generation and type guards
for `BlockConfirmed` event.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
This eliminates the need to keep 2 sets of protos in sync with one
another. Generated files should be backwards compatible because we've
kept the protos in sync so far.
Some material updates
- Snapchain doesn't have the bulk streaming rpcs we used for
reconciliation in hubs. Deleted all the shuttle code that depends on
these rpcs
- In the Snapchain protos, admin rpcs are specified in a different
proto. This caused some small amount of churn.
- The admin rpcs in snapchain do not mirror the admin rpcs on hubs.
## 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 focuses on removing outdated `.proto` files and updating the
generation of client libraries from new `snapchain` protobufs. It also
introduces type guards for the `BlockConfirmed` event and modifies
various message structures in the codebase.
### Detailed summary
- Deleted outdated `.proto` files in `protobufs/schemas`.
- Updated `package.json` scripts to generate clients from `snapchain`
instead of local schemas.
- Added type guards for `BlockConfirmed` events in `typeguards.ts`.
- Modified message structures to include `BlockConfirmedBody`.
- Updated comments for clarity in `message.ts`.
- Refactored `MessageReconciliation` class to remove streaming logic.
- Introduced new methods for handling on-chain events in `admin_rpc.ts`.
> The following files were skipped due to too many changes:
`packages/hub-web/src/generated/hub_event.ts`,
`packages/hub-nodejs/src/generated/hub_event.ts`,
`packages/core/src/protobufs/generated/hub_event.ts`,
`packages/hub-web/src/generated/rpc.ts`,
`packages/core/src/protobufs/generated/gossip.ts`,
`packages/hub-nodejs/src/generated/rpc.ts`,
`packages/hub-web/src/generated/blocks.ts`,
`packages/hub-nodejs/src/generated/blocks.ts`,
`packages/core/src/protobufs/generated/blocks.ts`,
`packages/hub-web/src/generated/request_response.ts`,
`packages/hub-nodejs/src/generated/request_response.ts`,
`packages/core/src/protobufs/generated/request_response.ts`
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Shuttle was ignoring the should validate flag when reconciling link
compact state messages
## 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 focuses on updating the version of the `@farcaster/shuttle`
package and making a modification in the `hubEventProcessor.ts` file to
include a new parameter in a function call, enhancing the validation of
messages.
### Detailed summary
- Updated `version` in `package.json` from `0.6.17` to `0.6.18`.
- Added a new entry in `CHANGELOG.md` for version `0.6.18`, noting a fix
for respecting validate messages flag.
- Modified the function call in `hubEventProcessor.ts` to include
`shouldValidate` as an additional argument in
`MessageProcessor.deleteDifferenceMessages`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Release client and shuttle some snapchain bug fixes
## 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 focuses on updating the versions of various packages and fixing
issues related to event timestamp calculations and type guards in the
`@farcaster/core` and `@farcaster/hub-nodejs` packages.
### Detailed summary
- Updated `@farcaster/core` version from `0.17.0` to `0.17.1`.
- Updated `@farcaster/hub-nodejs` version from `0.14.0` to `0.14.1`.
- Updated `@farcaster/shuttle` version from `0.6.16` to `0.6.17`.
- Fixed event timestamp calculation for snapchain.
- Added type guards for `TierPurchase` on-chain event.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
The typeguard for the new tier purchase event is required for processing
these events cleanly out of the event stream.
## 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.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on enhancing type safety by adding type guards for the
`TierPurchaseOnChainEvent`, ensuring that the event structure is
validated correctly.
### Detailed summary
- Updated `TierPurchaseOnChainEvent` type in
`packages/core/src/protobufs/types.ts` to include specific properties.
- Introduced `isTierPurchaseOnChainEvent` type guard in
`packages/core/src/protobufs/typeguards.ts` to validate `OnChainEvent`
instances.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Deprecate existing event timestamp functions that rely on event id, and
add a new one that fetch it from the itself itself.
## 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 focuses on updating the event timestamp handling in the
`shuttle` and `core` packages. It replaces the deprecated
`extractEventTimestamp` function with `extractTimestampFromEvent`, which
aligns with the new event structure using timestamps instead of event
IDs.
### Detailed summary
- Changed function name from `extractEventTimestamp` to
`extractTimestampFromEvent` in `hubSubscriber.ts` and `eventStream.ts`.
- Updated calls to `extractEventTimestamp` to use
`extractTimestampFromEvent`.
- Marked `extractEventTimestamp` as deprecated in `time.ts` with a note
on using event timestamps.
- Added a new implementation for `extractTimestampFromEvent` in
`time.ts`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Release client library for snapchain 0.3
## 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 focuses on updating the versions of various `@farcaster`
packages, enhancing features related to the snapchain 0.3 protocol, and
adjusting dependencies.
### Detailed summary
- Deleted `.changeset/thick-radios-end.md`
- Updated `@farcaster/hub-nodejs` to version `0.14.0`
- Updated `@farcaster/core` to version `0.17.0`
- Updated `@farcaster/hub-web` to version `0.10.0`
- Updated version numbers in `package.json` files for `@farcaster/core`,
`@farcaster/hub-web`, `@farcaster/shuttle`, and `@farcaster/hub-nodejs`
- Added support for snapchain 0.3 protocol features in `CHANGELOG.md`
files
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Fixes the previous release.
## 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
- [ ] 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.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR introduces new user data types, expands username validation, and
adds tier-related functionalities across multiple files. It enhances the
handling of usernames, addresses, and event types while improving
validations and error handling.
### Detailed summary
- Added `USERNAME_TYPE_BASENAME` to `UserNameType` enums.
- Introduced `BANNER`, `USER_DATA_PRIMARY_ADDRESS_ETHEREUM`, and
`USER_DATA_PRIMARY_ADDRESS_SOLANA` to `UserDataType` enums.
- Updated `CastType` enum to include `TEN_K_CAST`.
- Modified username validation to support `USERNAME_TYPE_BASENAME`.
- Enhanced user data validation for Ethereum and Solana addresses.
- Updated maximum username length from 20 to 25 characters.
- Changed embed limit from 2 to 4 in validations.
- Added `TierType` enum with `None` and `Pro` values.
- Introduced `TierPurchaseBody` interface for tier purchases.
- Added handling for `EVENT_TYPE_TIER_PURCHASE` in `OnChainEventType`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
---------
Co-authored-by: Sanjay Raveendran <sanjayprabhu@gmail.com>
## Why is this change needed?
Release hub-nodejs and core
## 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 updating the version of the `@farcaster/core` and
`@farcaster/hub-nodejs` packages, along with their changelogs and
dependencies.
### Detailed summary
- Deleted `CHANGELOG.md` for `afraid-impalas-kiss`.
- Added version `0.13.6` for `@farcaster/hub-nodejs` with updated
dependencies.
- Added version `0.16.5` for `@farcaster/core` with a change to bring
protos to parity with Snapchain.
- Updated `version` in `package.json` for both packages.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
The new proto definitions need to be exposed via the client library to
build on new features.
## 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.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on updating the protocol buffers in the client library
to align with the Snapchain implementation. It introduces new message
types, enums, and fields to enhance functionality, particularly around
tier management and user data handling.
### Detailed summary
- Added `USERNAME_TYPE_BASENAME` to `username_proof.proto`.
- Introduced `TierDetails` message and `tier_subscriptions` field in
`StorageLimitsResponse`.
- Updated error message date in `time.test.ts` to 01/01/2021.
- Added new user data types: `USER_DATA_TYPE_BANNER`,
`USER_DATA_PRIMARY_ADDRESS_ETHEREUM`, and
`USER_DATA_PRIMARY_ADDRESS_SOLANA`.
- Introduced `TEN_K_CAST` enum in `message.proto`.
- Added `EVENT_TYPE_TIER_PURCHASE` in `onchain_event.proto`.
- Created `TierPurchaseBody` message with relevant fields.
- Updated `OnChainEvent` to include `tierPurchaseEventBody`.
- Added methods for handling `TierType` in JSON conversions.
- Enhanced `StorageLimitsResponse` to include `tierSubscriptions`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
from beginning - from the beginning
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on improving the logging message in the
`hubSubscriber.ts` file for clarity.
### Detailed summary
- Updated the warning log message from `"No last hub event ID found,
starting from beginning"` to `"No last hub event ID found, starting from
the beginning"` for better readability.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## 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 adds a new section to the `packages/core/README.md` file to
introduce the `@farcaster/core` package, which includes shared
hub-related methods and classes.
### Detailed summary
- Added a new header `# @farcaster/core` to the
`packages/core/README.md`.
- Included a description stating that the package contains shared
hub-related methods and classes.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
In the code, the epoch is set to January 1, 2021, but there's a typo in
the error message referencing “01/01/2022” instead of “01/01/2021”.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR updates the error message in the `toFarcasterTime` function to
reflect a change in the acceptable time range, adjusting the Farcaster
epoch date from "01/01/2022" to "01/01/2021".
### Detailed summary
- Updated the error message in the `toFarcasterTime` function.
- Changed the date in the message from "01/01/2022" to "01/01/2021" to
specify the new Farcaster epoch threshold.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
Co-authored-by: comfsrt <155266597+comfsrt@users.noreply.github.com>
## Why is this change needed?
The typeguard was incorrect.
## Merge Checklist
- [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 focuses on fixing the type guard `isMergeFailureHubEvent` to
correctly identify `MergeFailureHubEvent` instances in the codebase.
### Detailed summary
- Updated the return type of `isMergeFailureHubEvent` to correctly
reflect `types.MergeFailureHubEvent`.
- Introduced the `MergeFailureHubEvent` type in `types.ts`, which
includes the `mergeFailure` property.
- Ensured the type guard checks for the `MERGE_FAILURE` event type.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Release hub-nodejs version
## 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 focuses on updating version numbers and dependencies across
several packages in the `@farcaster` ecosystem, specifically enhancing
compatibility and adding features related to snapchain fields.
### Detailed summary
- Updated `@farcaster/core` version from `0.16.2` to `0.16.3`.
- Updated `@farcaster/hub-web` version from `0.9.6` to `0.9.7`.
- Updated `@farcaster/shuttle` version from `0.6.14` to `0.6.15`.
- Updated `@farcaster/hub-nodejs` version from `0.13.3` to `0.13.4`.
- Added snapchain fields to hub event and improved data compatibility in
changelogs for multiple packages.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
- Add new fields from snapchain to hubble protos and libraries so
shuttle can access them
- Update shuttle to use getInfo for max fid
- Populate data and databytes for convenience (snapchain updated to
prioritize dataBytes https://github.com/farcasterxyz/snapchain/pull/454)
## 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 new fields related to `snapchain` events, enhances
compatibility by populating additional data, and modifies existing event
structures to include `block_number`, `shard_index`, and `timestamp`. It
also updates documentation for clarity.
### Detailed summary
- Added `block_number`, `shard_index`, and `timestamp` fields to various
stores and event structures.
- Introduced `MergeFailureBody` to handle merge failures with `message`,
`code`, and `reason`.
- Updated comments and documentation to reflect changes in event types.
- Enhanced `HubEventArgs` to omit additional fields for better
compatibility.
- Modified `makeMessageWithSignature` to use `dataBytes` for
serialization differences.
- Updated event type handling in generated files to include
`MERGE_FAILURE`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Release 0.19.3
## 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 focuses on updating the versions of various packages within the
Farcaster project, specifically enhancing dependencies and making minor
version increments to ensure compatibility and improvements.
### Detailed summary
- Updated `@farcaster/core` from `0.16.1` to `0.16.2`.
- Updated `@farcaster/hub-nodejs` from `0.13.2` to `0.13.3`.
- Updated `@farcaster/hubble` from `1.19.2` to `1.19.3`.
- Added changelog entries for versions `0.16.2`, `0.13.3`, and `1.19.3`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Social usernames (twitter, github) have support for removals by setting
the value to empty string. The validator in core erroneously marks this
as an invalid message.
## 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 focuses on enhancing username validation for social media
platforms by allowing users to remove their usernames. It also updates
tests related to version expiry.
### Detailed summary
- Added support for removing social usernames in `validations.ts` for
`TWITTER` and `GITHUB`.
- Updated validation logic to check if the username value is not an
empty string before validation.
- Removed a test block in `versions.test.ts` related to version expiry
checks.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Release hub-nodejs 0.13.1
## 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 focuses on updating the version of the `@farcaster/hub-nodejs`
package from `0.13.0` to `0.13.1` and includes a changelog entry for the
patch changes made.
### Detailed summary
- Deleted the file `.changeset/nasty-eagles-grin.md`.
- Updated `CHANGELOG.md` to include version `0.13.1` with a patch change
for snapchain error codes.
- Updated `packages/hub-nodejs/package.json` version from `0.13.0` to
`0.13.1`.
- Updated `apps/hubble/package.json` to reflect the new version
`^0.13.1` for `@farcaster/hub-nodejs`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Snapchain sends the error codes back using a different header name. Read
that as well.
## 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 focuses on improving error handling in the `hub-nodejs` package
by ensuring that error codes from the snapchain are correctly passed
through to the `HubError`.
### Detailed summary
- Updated error handling in `packages/hub-nodejs/src/client.ts`.
- Modified the way `HubError` is instantiated to use `hubErrorCode`,
which retrieves error codes from both `err.metadata.get("errCode")` and
`err.metadata.get("x-err-code")`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Release snapchain updates
## 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 focuses on updating package versions and changelogs across
multiple modules in the `@farcaster` ecosystem, including new features
and dependency updates.
### Detailed summary
- Updated `@farcaster/core` version from `0.15.6` to `0.16.0`.
- Updated `@farcaster/hub-nodejs` version from `0.10.x` to `0.13.0`.
- Updated `@farcaster/hub-web` version from `0.9.5` to `0.9.6`.
- Updated `@farcaster/shuttle` version from `0.6.13` to `0.6.14`.
- Updated `@farcaster/hubble` version from `1.19.1` to `1.19.2`.
- Added changelog entries for each module reflecting the updates.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Update builders to use dataBytes so messages work with snapchain
## 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 focuses on updating the package versions and modifying various
`HUB_URL` configurations to support the `snapchain` functionality,
alongside some validation and message handling improvements.
### Detailed summary
- Updated package versions for `@farcaster/hub-nodejs` and
`@farcaster/core` to minor.
- Changed `HUB_URL` in multiple examples to point to
`juno.farcaster.xyz:3383`.
- Enhanced validation by checking both `message.data` and
`message.dataBytes`.
- Updated message creation to use `dataBytes` for `snapchain`
compatibility.
- Adjusted signature handling to use `_unsafeUnwrap()`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
Release shuttle v0.6.13
## 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.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR updates the version of the `@farcaster/shuttle` package from
`0.6.12` to `0.6.13`, adds a new feature related to environment
variables for `shuttle`, and removes an outdated changelog file.
### Detailed summary
- Updated `@farcaster/shuttle` version from `0.6.12` to `0.6.13` in
`package.json`.
- Added a new feature: environment variables for consuming from
`snapchain` in the changelog.
- Deleted the `.changeset/wild-rabbits-tap.md` file.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
For subscribing to the snapchain cluster, it's useful to have a longer
subscribe rpc timeout given there isn't consistent activity on the
cluster and it's required to use the standard (non-streaming) bulk rpcs.
This feature adds config via envvars for these parameters.
## 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.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on adding environment variables to the `shuttle`
application for configuration, particularly for streaming RPCs and
timeout settings.
### Detailed summary
- Introduced `USE_STREAMING_RPCS_FOR_BACKFILL` and
`SUBSCRIBE_RPC_TIMEOUT` environment variables in `env.ts`.
- Modified the `constructor` in `MessageReconciliation` to accept a new
parameter `useStreamingRpcs`.
- Updated `establishStream` method call to conditionally execute based
on `useStreamingRpcs`.
- Adjusted the instantiation of `MessageReconciliation` in
`reconcileFids` to include `USE_STREAMING_RPCS_FOR_BACKFILL`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Typo was breaking tests.
## Merge Checklist
- [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)
- [ ] 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 updating the use of `Factories.Ed25519PPublicKey` to
`Factories.Ed25519PublicKey` in test files to ensure consistency and
correctness in the handling of public key types.
### Detailed summary
- In `apps/hubble/src/storage/db/message.test.ts`, changed
`Factories.Ed25519PPublicKey.build()` to
`Factories.Ed25519PublicKey.build()` in a test case.
- In `packages/core/src/validations.test.ts`, updated
`Factories.Ed25519PPublicKey.build()` to
`Factories.Ed25519PublicKey.build()` in two instances where a message is
created for validation testing.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
Replaced the outdated Twitter URL (twitter) with the updated x.com
format (x) to align with the platform's rebranding.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR updates references from "twitter" to "x" across multiple files
to reflect the rebranding of Twitter to X.
### Detailed summary
- Updated `CHANGELOG.md` to change "twitter" to "x".
- In `message.ts` files (both `hub-nodejs` and `core`), modified the
comment for `TWITTER` from "Username of user on twitter" to "Username of
user on x".
- In `message.proto`, changed the comment for `USER_DATA_TYPE_TWITTER`
from "Username of user on twitter" to "Username of user on x".
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
**This PR includes the following changes:**
1. Fixed typographical error in comment: changed `the` to `to`
2. Improved variable naming consistency for better code readability
3. Increased timeouts in `nightwatch` config to resolve test failures
**Changes made:**
- Fixed comment wording in `hubEventProcessor.ts`
- Updated variable names for consistency in
`validateOrRevokeMessagesJob.ts`
- Increased timeouts and retry attempts in `nightwatch` configuration
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on correcting typos in comments and variable names
related to time allocation in the `pruneMessagesJob.ts` and
`validateOrRevokeMessagesJob.ts` files, ensuring clarity and consistency
in the code.
### Detailed summary
- Corrected the comment in `hubEventProcessor.ts` from "consider" to "to
consider".
- Changed variable name `allotedTimeMs` to `allottedTimeMs` in:
- `pruneMessagesJob.ts`
- `validateOrRevokeMessagesJob.ts`
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
Corrected the numbering for accuracy and consistency.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR updates the example number in the documentation comment of the
`index.ts` file within the `packages/hub-nodejs/examples/write-data`
directory.
### Detailed summary
- Changed the example number from 7 to 8 in the documentation comment.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
The error handling in the userdata fetch block assumes the error object
always has a `response` property, which isn't guaranteed. This can cause
crashes if the error is unrelated to an HTTP request (e.g., network
issues or code errors).
I've updated the `console.error` statement to safely handle cases where
`e.response` is undefined. Now it logs either the response data or the
error message, preventing potential runtime errors.
## 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.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR improves error handling in the
`packages/hub-web/examples/profile/index.ts` file by making the error
logging more robust. It adds a fallback to log the error message if the
response data is not available.
### Detailed summary
- Updated the error logging in the `catch` block.
- Changed `console.error` to log `e.response?.data` or fallback to
`e.message` if `e.response.data` is undefined.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
I noticed a typo in the class name `Ed25519PPublicKey` where an extra
"P" was added. This doesn't align with the correct naming convention
used in the codebase, particularly with the `Ed25519PublicKeyFactory`
defined earlier. I've corrected the name to `Ed25519PublicKey` to ensure
consistency and accuracy.
## Merge Checklist
- [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.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on correcting a naming inconsistency in the
`packages/core/src/factories.ts` file by updating the key from
`Ed25519PPublicKey` to `Ed25519PublicKey`.
### Detailed summary
- Changed the key name from `Ed25519PPublicKey` to `Ed25519PublicKey` in
the export list.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
## Why is this change needed?
Fix some typos
## Changes:
- Fixed typo: `Rasied` to `Raised` in `syncHealth.ts`.
- Corrected `reuslt` to `result` in `userDataStore.ts`.
- Changed `doesnt` to `doesn't` in `merkleTrie.test.ts`.
- Fixed `propogate` to `propagate` in `logger.ts` and `hubble.ts`.
- Corrected `Wether` to `Whether` in `validateOrRevokeMessagesJob.ts`
and `hubble.ts`.
- Fixed `trucated` to `truncated` in `main.rs`.
- Changed `cound` to `count` in `multiPeerSyncEngine.test.ts`.
- Corrected `succeds` to `succeeds` in `index.test.ts`.
## 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.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on correcting typos and improving comments throughout
the codebase for better clarity and readability.
### Detailed summary
- Fixed typo: `Rasied` to `Raised` in `syncHealth.ts`.
- Corrected `reuslt` to `result` in `userDataStore.ts`.
- Changed `doesnt` to `doesn't` in `merkleTrie.test.ts`.
- Fixed `propogate` to `propagate` in `logger.ts` and `hubble.ts`.
- Corrected `Wether` to `Whether` in `validateOrRevokeMessagesJob.ts`
and `hubble.ts`.
- Fixed `trucated` to `truncated` in `main.rs`.
- Changed `cound` to `count` in `multiPeerSyncEngine.test.ts`.
- Corrected `succeds` to `succeeds` in `index.test.ts`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
Changes:
- Removed duplicate "Snapshots Options" section from CLI documentation
as it already exists in the main options list.
Before (appears twice):
Snapshots Options:
--enable-snapshot-to-s3 Enable daily snapshots to be uploaded to S3.
(default: disabled)
--s3-snapshot-bucket <bucket> The S3 bucket to upload snapshots to
--disable-snapshot-sync Disable syncing from snapshots. (default:
enabled)
File changed: apps/hubble/www/docs/docs/cli.md
Screenshot needed:
I reviewed the entire repository, no more typos found in docs.
Hope this helps streamline the project!
Best regards,
Bilogweb3
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on correcting a typo in the variable name from
`castWithEmojiLinkAttachmnent` to `castWithEmojiLinkAttachment` in the
`packages/hub-nodejs/examples/write-data/index.ts` file, ensuring
consistency and clarity in the code.
### Detailed summary
- Changed variable name from `castWithEmojiLinkAttachmnent` to
`castWithEmojiLinkAttachment` for consistency.
- Updated the corresponding push to `castResults` to reflect the
corrected variable name.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
I reviewed the entire repository, no more typos found in docs.
Hope this helps streamline the project!
Best regards,
Bilogweb3
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on renaming a public key factory in the codebase for
clarity and consistency.
### Detailed summary
- Renamed `Ed25519PPublicKeyFactory` to `Ed25519PublicKeyFactory` in
`packages/core/src/factories.ts`.
- Updated references to the factory in the `SignerEventBodyFactory` and
`Factories` export to match the new name.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
Changes made:
typos - types ( Correcting a typo to the intended word)
LocalACcount - LocalAccount (Fixing the capitalization error to match
the proper format)
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on correcting typos in test descriptions and
documentation related to the `getStoreLimit` function and the
`Eip712Signer` class.
### Detailed summary
- Changed the test description from "multiple unit typos" to "multiple
unit types" in `packages/core/src/limits.test.ts`.
- Corrected "LocalACcount" to "LocalAccount" in
`packages/hub-nodejs/docs/signers/ViemLocalEip712Signer.md`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
# Fix Typos in Documentation and Tests
## Summary
This pull request addresses minor typos in the following files:
1. `apps/hubble/src/test/e2e/gossipNetworkBundle.test.ts`
2. `packages/hub-nodejs/docs/signers/EthersV5Eip712Signer.md`
## Changes Made
### 1. `gossipNetworkBundle.test.ts`
- Fixed a typo in the comment:
- From: "beacuse"
- To: "because"
### 2. `EthersV5Eip712Signer.md`
- Fixed a typo in the comment:
- From: "can't erro"
- To: "can't error"
## Testing
These changes only affect comments and do not impact the functionality
of the code. No new tests were added as the code logic remains
unchanged.
## Checklist
- [x] Followed the [contributing guidelines](link-to-guidelines).
- [x] Verified changes locally.
- [x] Added clear descriptions and comments.
---
Thank you for reviewing this PR! Let me know if there’s anything else to
address.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on correcting minor typographical errors in comments
within the documentation and test files related to the
`EthersV5Eip712Signer` and `gossipNetworkBundle`.
### Detailed summary
- Fixed a typo in the comment for `blockHashBytes` in
`packages/hub-nodejs/docs/signers/EthersV5Eip712Signer.md`.
- Corrected a typo in the comment regarding invalid bundle gossiping in
`apps/hubble/src/test/e2e/gossipNetworkBundle.test.ts`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
# Fix Typo in CHANGELOG.md
## Summary of Changes
- Corrected a typo: "endoint" to "endpoint" in the
`packages/core/CHANGELOG.md` file.
---
## Additional Notes
This is a minor documentation update and does not affect the
functionality of the project.
Please review and merge at your convenience. Thank you! 😊
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on a fix in the `http` endpoint's response behavior,
ensuring it returns a "not found" status instead of an internal database
error.
### Detailed summary
- Fixed the `http` endpoint to return "not found" instead of an internal
database error.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
Duplicate "if" in error message description.
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on improving documentation clarity and correcting a
comment in the codebase.
### Detailed summary
- Updated the wording in `monitoring.md` to change "writeable" to
"writable".
- Corrected a comment in `errors.ts` by removing the redundant "if" in
"if if error message".
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
Changes in packages/hub-nodejs/docs/Events.md:
1. Fixed IdRegistryEvent type reference:
- Old: [`NameRegistryEventType`]()
- New: [`IdRegistryEventType`](#idregistryeventtype)
2. Fixed NameRegistryEventType enum value:
- Changed NAME_REGISTRY_EVENT_TYPE_RENEW from 1 to 2
Why:
- Corrects incorrect type reference for proper documentation linking
- Fixes duplicate enum value to maintain proper enumeration consistency
<!-- start pr-codex -->
---
## PR-Codex overview
This PR updates the documentation for events related to the Farcaster
network, specifically changing event types and correcting the associated
values in the `NameRegistryEvent` section.
### Detailed summary
- Changed the type of event from `NameRegistryEventType` to
`IdRegistryEventType`.
- Updated the value for `NAME_REGISTRY_EVENT_TYPE_RENEW` from `1` to
`2`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`
<!-- end pr-codex -->
