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

Files

Aditi Srinivasan 7e742a8dbb chore: bring protos to parity with Snapchain for client library (#2591 )

## 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 -->

2025-06-06 13:57:31 -04:00

schemas

chore: bring protos to parity with Snapchain for client library (#2591 )

2025-06-06 13:57:31 -04:00

README.md

fix: Update broken links protobufs README.md (#2478 )

2025-01-27 13:48:01 -08: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
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 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/core
packages/hub-nodejs
packages/hub-web

Generate Bindings

Coming soon

Docs

Docs for the protobufs are under ../apps/hubble/www/docs/docs