Default package

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc RetryFnameEvents (RetryFnameRequest, Empty)

  admin_rpc.proto:40

  message RetryFnameRequest

  admin_rpc.proto:20

  • oneof kind

    • uint64 fid = 1

    • string fname = 2

• rpc RetryOnchainEvents (RetryOnchainEventsRequest, Empty)

  admin_rpc.proto:39

  message RetryOnchainEventsRequest

  admin_rpc.proto:13

  • oneof kind

    • uint64 fid = 1

    • RetryBlockNumberRange block_range = 2

• rpc RunOnchainEventsMigration (RunOnchainEventsMigrationRequest, Empty)

  admin_rpc.proto:41

  message RunOnchainEventsMigrationRequest

  admin_rpc.proto:31

  • uint64 shard_id = 1

• rpc SubmitOnChainEvent (OnChainEvent, OnChainEvent)

  admin_rpc.proto:36

• rpc SubmitUserNameProof (UserNameProof, UserNameProof)

  admin_rpc.proto:37

• rpc UploadSnapshot (UploadSnapshotRequest, Empty)

  admin_rpc.proto:38

  message UploadSnapshotRequest

  admin_rpc.proto:27

  • repeated uint32 shard_indexes = 1

• rpc GetAllCastMessagesByFid (FidTimestampRequest, MessagesResponse)

  rpc.proto:86

  Bulk Methods

• rpc GetAllLendStorageMessagesByFid (FidTimestampRequest, MessagesResponse)

  rpc.proto:91

• rpc GetAllLinkMessagesByFid (FidTimestampRequest, MessagesResponse)

  rpc.proto:90

• rpc GetAllReactionMessagesByFid (FidTimestampRequest, MessagesResponse)

  rpc.proto:87

• rpc GetAllUserDataMessagesByFid (FidTimestampRequest, MessagesResponse)

  rpc.proto:89

• rpc GetAllVerificationMessagesByFid (FidTimestampRequest, MessagesResponse)

  rpc.proto:88

• rpc GetBlocks (BlocksRequest, stream Block)

  rpc.proto:19

  Block API

  message BlocksRequest

  request_response.proto:10

  • uint64 start_block_number = 2

  • optional uint64 stop_block_number = 3

• rpc GetCast (CastId, Message)

  rpc.proto:38

  Casts

• rpc GetCastsByFid (FidRequest, MessagesResponse)

  rpc.proto:39

• rpc GetCastsByMention (FidRequest, MessagesResponse)

  rpc.proto:41

• rpc GetCastsByParent (CastsByParentRequest, MessagesResponse)

  rpc.proto:40

  message CastsByParentRequest

  request_response.proto:102

  • oneof parent

    • CastId parent_cast_id = 1

    • string parent_url = 5

  • optional uint32 page_size = 2

  • optional bytes page_token = 3

  • optional bool reverse = 4

• rpc GetConnectedPeers (GetConnectedPeersRequest, GetConnectedPeersResponse)

  rpc.proto:24

  message GetConnectedPeersRequest

  request_response.proto:397

  (message has no fields)

  message GetConnectedPeersResponse

  request_response.proto:400

  • repeated ContactInfoBody contacts = 1

  • repeated ConnectedPeer peers = 2

    Unified, source-tagged view of connected peers. Includes peers we have no collected ContactInfoBody for (e.g. validators) as CONTACT_SOURCE_DERIVED entries built from the live connection — kept distinct from collected data.

• rpc GetCurrentStorageLimitsByFid (FidRequest, StorageLimitsResponse)

  rpc.proto:76

  message StorageLimitsResponse

  request_response.proto:163

  • repeated StorageLimit limits = 1

  • uint32 units = 2

  • repeated StorageUnitDetails unit_details = 3

  • repeated TierDetails tier_subscriptions = 4

• rpc GetEvent (EventRequest, HubEvent)

  rpc.proto:33

  message EventRequest

  request_response.proto:64

  • uint64 id = 1

  • uint32 shard_index = 5

• rpc GetEvents (EventsRequest, EventsResponse)

  rpc.proto:34

  message EventsRequest

  request_response.proto:363

  • uint64 start_id = 1

  • optional uint32 shard_index = 2

  • optional uint64 stop_id = 3

  • optional uint32 page_size = 4

  • optional bytes page_token = 5

  • optional bool reverse = 6

  message EventsResponse

  request_response.proto:372

  • repeated HubEvent events = 1

  • optional bytes next_page_token = 2

• rpc GetFidAddressType (FidAddressTypeRequest, FidAddressTypeResponse)

  rpc.proto:77

  message FidAddressTypeRequest

  request_response.proto:377

  • uint64 fid = 1

  • bytes address = 2

  message FidAddressTypeResponse

  request_response.proto:382

  • bool is_custody = 1

  • bool is_auth = 2

  • bool is_verified = 3

• rpc GetFids (FidsRequest, FidsResponse)

  rpc.proto:23

  message FidsRequest

  request_response.proto:85

  • optional uint32 page_size = 1

  • optional bytes page_token = 2

  • optional bool reverse = 3

  • uint32 shard_id = 4

  message FidsResponse

  request_response.proto:92

  • repeated uint64 fids = 1

  • optional bytes next_page_token = 2

• rpc GetIdRegistryOnChainEvent (FidRequest, OnChainEvent)

  rpc.proto:74

• rpc GetIdRegistryOnChainEventByAddress (IdRegistryEventByAddressRequest, OnChainEvent)

  rpc.proto:75

  message IdRegistryEventByAddressRequest

  request_response.proto:326

  • bytes address = 1

• rpc GetInfo (GetInfoRequest, GetInfoResponse)

  rpc.proto:22

  message GetInfoRequest

  request_response.proto:51

  (message has no fields)

  message GetInfoResponse

  request_response.proto:55

  Response Types for the Sync RPC Methods

  • string version = 1

  • optional DbStats db_stats = 5

  • string peerId = 6

  • uint32 num_shards = 8

  • repeated ShardInfo shard_infos = 9

  • uint64 next_engine_version_timestamp = 10

• rpc GetLink (LinkRequest, Message)

  rpc.proto:80

  Links

  message LinkRequest

  request_response.proto:300

  • uint64 fid = 1

  • string link_type = 2

  • oneof target

    • uint64 target_fid = 3

• rpc GetLinkCompactStateMessageByFid (FidRequest, MessagesResponse)

  rpc.proto:83

• rpc GetLinksByFid (LinksByFidRequest, MessagesResponse)

  rpc.proto:81

  message LinksByFidRequest

  request_response.proto:308

  • uint64 fid = 1

  • optional string link_type = 2

  • optional uint32 page_size = 3

  • optional bytes page_token = 4

  • optional bool reverse = 5

• rpc GetLinksByTarget (LinksByTargetRequest, MessagesResponse)

  rpc.proto:82

  message LinksByTargetRequest

  request_response.proto:316

  • oneof target

    • uint64 target_fid = 1

  • optional string link_type = 2

  • optional uint32 page_size = 3

  • optional bytes page_token = 4

  • optional bool reverse = 5

• rpc GetMeshTopology (GetMeshViewRequest, MeshTopology)

  rpc.proto:29

  Network-wide topology: centralized crawl of connected validators over the gossip port, aggregating each validator's local mesh view. Admin-gated.

  message MeshTopology

  request_response.proto:495

  Network-wide topology assembled by the centralized crawl over the gossip port. `nodes` is one MeshView per responding validator (including self).

  • repeated MeshView nodes = 1

  • repeated UnreachableNode unreachable = 2

  • uint64 generated_at = 3

    unix millis

• rpc GetMeshView (GetMeshViewRequest, MeshView)

  rpc.proto:26

  Mesh health & topology: this node's local view of the gossip mesh. Admin-gated.

• rpc GetOnChainEvents (OnChainEventRequest, OnChainEventResponse)

  rpc.proto:73

  message OnChainEventRequest

  request_response.proto:145

  • uint64 fid = 1

  • OnChainEventType event_type = 2

  • optional uint32 page_size = 3

  • optional bytes page_token = 4

  • optional bool reverse = 5

• rpc GetOnChainSigner (SignerRequest, OnChainEvent)

  rpc.proto:64

  OnChain Events DEPRECATED in favor of GetSigner (unified). Returns on-chain signer events only — gasless / off-chain keys are not surfaced through this RPC.

• rpc GetOnChainSignersByFid (FidRequest, OnChainEventResponse)

  rpc.proto:67

  DEPRECATED in favor of GetSignersByFid (unified). Returns on-chain signer events only — gasless / off-chain keys are not surfaced through this RPC.

• rpc GetReaction (ReactionRequest, Message)

  rpc.proto:44

  Reactions

  message ReactionRequest

  request_response.proto:112

  • uint64 fid = 1

  • ReactionType reaction_type = 2

  • oneof target

    • CastId target_cast_id = 3

    • string target_url = 4

• rpc GetReactionsByCast (ReactionsByTargetRequest, MessagesResponse)

  rpc.proto:46

  To be deprecated

• rpc GetReactionsByFid (ReactionsByFidRequest, MessagesResponse)

  rpc.proto:45

  message ReactionsByFidRequest

  request_response.proto:121

  • uint64 fid = 1

  • optional ReactionType reaction_type = 2

  • optional uint32 page_size = 3

  • optional bytes page_token = 4

  • optional bool reverse = 5

• rpc GetReactionsByTarget (ReactionsByTargetRequest, MessagesResponse)

  rpc.proto:47

• rpc GetShardChunks (ShardChunksRequest, ShardChunksResponse)

  rpc.proto:20

  message ShardChunksRequest

  request_response.proto:17

  • uint32 shard_id = 1

  • uint64 start_block_number = 2

  • optional uint64 stop_block_number = 3

  message ShardChunksResponse

  request_response.proto:23

  • repeated ShardChunk shard_chunks = 1

• rpc GetSigner (SignerRequest, SignerResponse)

  rpc.proto:70

  Unified signer surface — returns both on-chain and off-chain (gasless) keys.

  message SignerResponse

  request_response.proto:256

  • optional Signer signer = 1

• rpc GetSignersByFid (SignersByFidRequest, SignersByFidResponse)

  rpc.proto:71

  message SignersByFidRequest

  request_response.proto:264

  Request for GetSignersByFid. Mirrors `FidRequest` but adds an optional list of `requester_fids` so callers can fetch the current app-nonce for one or more requesters alongside the signer list. Used in lieu of `FidRequest` so the shared message stays lean.

  • uint64 fid = 1

  • optional uint32 page_size = 2

  • optional bytes page_token = 3

  • optional bool reverse = 4

  • repeated uint64 requester_fids = 5

    FIDs (verified `requestFid` from SignedKeyRequestMetadata) whose current app-nonce should be included in the response. The response's `requester_fid_nonces` list carries one entry per FID supplied here, in the same order. Empty list ⇒ no app nonces in the response.

  message SignersByFidResponse

  request_response.proto:276

  • repeated Signer signers = 1

  • optional bytes next_page_token = 2

  • uint32 gasless_signer_count = 3

    Total count of currently-active gasless (off-chain) keys for this FID. Populated from the O(1) per-FID counter maintained alongside the gasless key store, so it stays cheap regardless of the page size.

  • uint32 gasless_signer_limit = 4

    Per-FID cap on active gasless keys (NEYN-10579). Lets clients show "X/Y delegations" without hardcoding the limit on their side.

  • uint32 current_user_nonce = 5

    Current value of the user-nonce counter for this FID, i.e. the highest nonce ever accepted on KEY_ADD or custody-signed KEY_REMOVE for the user. The next valid user-nonce is strictly greater than this value. Returns 0 when no gasless activity has occurred for this FID yet, matching the merge-time validation rule that treats a missing counter as 0.

  • map<uint64, uint32> requester_fid_nonces = 6

    Current app-nonce counter, keyed by requester FID. Contains one entry per FID supplied in `request.requester_fids`; missing counters are surfaced as 0 so clients can read the map directly without falling back to defaults. The next valid self-revocation nonce for a given requester is strictly greater than the value here.

• rpc GetTrieMetadataByPrefix (TrieNodeMetadataRequest, TrieNodeMetadataResponse)

  rpc.proto:93

  message TrieNodeMetadataRequest

  request_response.proto:351

  • uint32 shard_id = 1

  • bytes prefix = 2

  message TrieNodeMetadataResponse

  request_response.proto:356

  • bytes prefix = 1

  • uint64 num_messages = 2

  • string hash = 3

  • repeated TrieNodeMetadataResponse children = 4

• rpc GetUserData (UserDataRequest, Message)

  rpc.proto:50

  User Data

  message UserDataRequest

  request_response.proto:140

  • uint64 fid = 1

  • UserDataType user_data_type = 2

• rpc GetUserDataByFid (FidRequest, MessagesResponse)

  rpc.proto:51

• rpc GetUserNameProofsByFid (FidRequest, UsernameProofsResponse)

  rpc.proto:55

  message UsernameProofsResponse

  request_response.proto:202

  • repeated UserNameProof proofs = 1

• rpc GetUsernameProof (UsernameProofRequest, UserNameProof)

  rpc.proto:54

  Username Proof

  message UsernameProofRequest

  request_response.proto:198

  • bytes name = 1

• rpc GetVerification (VerificationRequest, Message)

  rpc.proto:58

  Verifications

  message VerificationRequest

  request_response.proto:211

  • uint64 fid = 1

  • bytes address = 2

• rpc GetVerificationsByFid (FidRequest, MessagesResponse)

  rpc.proto:59

• rpc SubmitBulkMessages (SubmitBulkMessagesRequest, SubmitBulkMessagesResponse)

  rpc.proto:13

  message SubmitBulkMessagesRequest

  request_response.proto:330

  • repeated Message messages = 1

  message SubmitBulkMessagesResponse

  request_response.proto:347

  • repeated BulkMessageResponse messages = 1

• rpc SubmitMessage (Message, Message)

  rpc.proto:12

  Write API

• rpc Subscribe (SubscribeRequest, stream HubEvent)

  rpc.proto:32

  Events

  message SubscribeRequest

  request_response.proto:27

  • repeated HubEventType event_types = 1

  • optional uint64 from_id = 2

  • optional uint32 shard_index = 4

    optional uint32 total_shards = 3; // Not required for snapchain

• rpc ValidateMessage (Message, ValidationResponse)

  rpc.proto:16

  Validation Methods

  message ValidationResponse

  request_response.proto:206

  • bool valid = 1

  • optional Message message = 2

• rpc GetShardSnapshotMetadata (GetShardSnapshotMetadataRequest, GetShardSnapshotMetadataResponse)

  replication.proto:8

  message GetShardSnapshotMetadataRequest

  replication.proto:13

  • uint32 shard_id = 1

  message GetShardSnapshotMetadataResponse

  replication.proto:26

  • repeated ShardSnapshotMetadata snapshots = 1

• rpc GetShardTransactions (GetShardTransactionsRequest, GetShardTransactionsResponse)

  replication.proto:9

  message GetShardTransactionsRequest

  replication.proto:30

  • uint32 shard_id = 1

    Shard + height of the snapshot. Only those combinations returned from the `GetShardSnapshotMetadata` are valid

  • uint64 height = 2

  • uint32 trie_virtual_shard = 3

    The trie prefix to iterate under. Only leaf node keys under this sub tree will be returned.

  • optional string page_token = 4

    If NONE, then start from the left-most leaf node under the prefix

  message GetShardTransactionsResponse

  replication.proto:43

  • repeated ShardTrieEntryWithMessage trie_messages = 1

    List of trie keys and its associated message

  • repeated FidAccountRootHash fid_account_roots = 2

    For each (unique) FID that was sent in `messages` above, that FID's account root hash in the trie.

  • optional string next_page_token = 3

    If this is None, all entries under the prefix have been returned

Used as response type in: HubService.GetBlocks

Used as field type in: DecidedValue, FullProposal, ShardSnapshotMetadata

• optional BlockHeader header = 1

• bytes hash = 2

• optional ShardWitness shard_witness = 3

• optional Commits commits = 4

• repeated Transaction transactions = 5

• repeated BlockEvent events = 6

Used in: HubEvent

• uint64 block_number = 1

• uint32 shard_index = 2

• uint64 timestamp = 3

• bytes block_hash = 4

• uint64 total_events = 5

• map<int32, uint64> event_counts_by_type = 6

• uint64 max_block_event_seqnum = 7

Used in: Block, ValidatorMessage

• bytes hash = 1

• optional BlockEventData data = 2

Used in: BlockEvent

• uint64 seqnum = 1

• BlockEventType type = 2

• uint64 block_number = 3

• uint64 event_index = 4

• uint64 block_timestamp = 5

• oneof body

  • HeartbeatEventBody heartbeat_event_body = 6

  • MergeMessageEventBody merge_message_event_body = 7

Used in: BlockEventData

• BLOCK_EVENT_TYPE_HEARTBEAT = 0

• BLOCK_EVENT_TYPE_MERGE_MESSAGE = 1

Block types

Used in: Block

• optional Height height = 1

• uint64 timestamp = 2

• uint32 version = 3

• FarcasterNetwork chain_id = 4

• bytes shard_witnesses_hash = 5

• bytes parent_hash = 6

• bytes state_root = 7

• bytes events_hash = 8

Used in: SubmitBulkMessagesResponse

• oneof response

  • Message message = 1

  • MessageError message_error = 2

* Adds a new Cast

Used in: MessageData

• repeated string embeds_deprecated = 1

  URLs to be embedded in the cast

• repeated uint64 mentions = 2

  Fids mentioned in the cast

• oneof parent

  • CastId parent_cast_id = 3

    Parent cast of the cast

  • string parent_url = 7

    Parent URL

• string text = 4

  Text of the cast

• repeated uint32 mentions_positions = 5

  Positions of the mentions in the text

• repeated Embed embeds = 6

  URLs or cast ids to be embedded in the cast

• CastType type = 8

  Type of cast

* Identifier used to look up a Cast

Used as request type in: HubService.GetCast

Used as field type in: CastAddBody, CastsByParentRequest, Embed, FrameActionBody, ReactionBody, ReactionRequest, ReactionsByTargetRequest

• uint64 fid = 1

  Fid of the user who created the cast

• bytes hash = 2

  Hash of the cast

* Removes an existing Cast

Used in: MessageData

• bytes target_hash = 1

  Hash of the cast to remove

* Type of cast

Used in: CastAddBody

• CAST = 0

• LONG_CAST = 1

• TEN_K_CAST = 2

Used in: Commits

• bytes signer = 1

• bytes signature = 2

Used in: Block, ShardChunk, SyncValueResponse

• optional Height height = 1

• int64 round = 2

• optional ShardHash value = 3

• repeated CommitSignature signatures = 4

Used in: GetConnectedPeersResponse

• ContactSource source = 1

• optional ContactInfoBody contact_info = 2

  set only when source == COLLECTED

• bytes peer_id = 3

  always present (esp. for DERIVED)

• string observed_address = 4

  set for DERIVED: the live-connection address

Used in: GossipMessage

• oneof consensus_message

  • Vote vote = 1

  • Proposal proposal = 2

• bytes signature = 3

Used in: GossipMessage

• optional ContactInfoBody body = 1

Used in: ConnectedPeer, ContactInfo, GetConnectedPeersResponse, MeshPeer

• string gossip_address = 1

• bytes peer_id = 2

• string snapchain_version = 3

• FarcasterNetwork network = 4

• uint64 timestamp = 5

• string announce_rpc_address = 6

Where a peer's address/contact data came from. Keeps internally-derived (observed) data from being conflated with peer-attested gossip data.

Used in: ConnectedPeer, MeshPeer

• CONTACT_SOURCE_UNKNOWN = 0

• CONTACT_SOURCE_COLLECTED = 1

  real ContactInfoBody received over the contact-info topic

• CONTACT_SOURCE_DERIVED = 2

  internal: PeerId + observed connection address only

• bool outdatedHash = 1

Used in: GetInfoResponse

• uint64 num_messages = 1

• uint64 num_fid_registrations = 2

• uint64 approx_size = 4

• bytes key = 1

• repeated uint32 childChars = 2

• uint32 items = 3

• map<uint32, bytes> childHashes = 4

Used in: ReadNodeMessage

• oneof value

  • Block block = 2

  • ShardChunk shard = 3

Used in: CastAddBody

• oneof embed

  • string url = 1

  • CastId cast_id = 2

Used as response type in: AdminService.RetryFnameEvents, AdminService.RetryOnchainEvents, AdminService.RunOnchainEventsMigration, AdminService.UploadSnapshot

(message has no fields)

* Farcaster network the message is intended for

Used in: BlockHeader, ContactInfoBody, MeshSelf, MessageData

• FARCASTER_NETWORK_NONE = 0

• FARCASTER_NETWORK_MAINNET = 1

  Public primary network

• FARCASTER_NETWORK_TESTNET = 2

  Public test network

• FARCASTER_NETWORK_DEVNET = 3

  Private test network

Used in: GetShardTransactionsResponse

• uint64 fid = 1

• bytes account_root_hash = 2

• uint64 num_messages = 3

Used as request type in: HubService.GetCastsByFid, HubService.GetCastsByMention, HubService.GetCurrentStorageLimitsByFid, HubService.GetIdRegistryOnChainEvent, HubService.GetLinkCompactStateMessageByFid, HubService.GetOnChainSignersByFid, HubService.GetUserDataByFid, HubService.GetUserNameProofsByFid, HubService.GetVerificationsByFid

• uint64 fid = 1

• optional uint32 page_size = 2

• optional bytes page_token = 3

• optional bool reverse = 4

Used as request type in: HubService.GetAllCastMessagesByFid, HubService.GetAllLendStorageMessagesByFid, HubService.GetAllLinkMessagesByFid, HubService.GetAllReactionMessagesByFid, HubService.GetAllUserDataMessagesByFid, HubService.GetAllVerificationMessagesByFid

• uint64 fid = 1

• optional uint32 page_size = 2

• optional bytes page_token = 3

• optional bool reverse = 4

• optional uint64 start_timestamp = 5

• optional uint64 stop_timestamp = 6

• uint64 last_fname_proof = 3

Fname transfers

Used in: ShardTrieEntryWithMessage, ValidatorMessage

• uint64 id = 1

• uint64 from_fid = 2

• optional UserNameProof proof = 4

* A Farcaster Frame action

Used in: MessageData

• bytes url = 1

  URL of the Frame triggering the action

• uint32 button_index = 2

  The index of the button pressed (1-4)

• optional CastId cast_id = 3

  The cast which contained the frame url

• bytes input_text = 4

  Text input from the user, if present

• bytes state = 5

  Serialized frame state value

• bytes transaction_id = 6

  Chain-specific transaction ID for tx actions

• bytes address = 7

  Chain-specific address for tx actions

TODO: This probably needs a signature? Should we use ConsensusMessage?

Used in: GossipMessage

• optional Height height = 1

• int64 round = 2

• bytes proposer = 3

• oneof proposed_value

  • Block block = 4

  • ShardChunk shard = 5

Used as request type in: HubService.GetMeshTopology, HubService.GetMeshView

• bool validators_only = 1

  default true (applied by the handler)

• uint32 ttl = 2

  Reserved for the recursive crawl; ignored by the local view, kept so the wire format doesn't break when a propagating crawl is added later.

• repeated bytes visited_peer_ids = 3

• oneof gossip_message

  • ConsensusMessage consensus = 1

  • FullProposal full_proposal = 2

  • MempoolMessage mempool_message = 3

  • StatusMessage status = 4

  • ReadNodeMessage read_node_message = 5

  • ContactInfo contact_info_message = 6

Used in: MeshPeer

• string topic = 1

• double msgs_per_sec = 2

• double bytes_per_sec = 3

• uint64 total_msgs = 4

• uint64 total_bytes = 5

* Type of hashing scheme used to produce a digest of MessageData

Used in: Message

• HASH_SCHEME_NONE = 0

• HASH_SCHEME_BLAKE3 = 1

  Default scheme for hashing MessageData

Used in: BlockEventData

(message has no fields)

Used in: BlockHeader, Commits, FullProposal, Proposal, ShardChunkWitness, ShardHeader, StatusMessage, SyncValueRequest, SyncValueResponse, SyncVoteSetRequest, SyncVoteSetResponse, Vote

• uint32 shard_index = 1

• uint64 block_number = 2

Used as response type in: HubService.GetEvent, HubService.Subscribe

Used as field type in: EventsResponse

• HubEventType type = 1

• uint64 id = 2

• oneof body

  • MergeMessageBody merge_message_body = 3

  • PruneMessageBody prune_message_body = 4

  • RevokeMessageBody revoke_message_body = 5

  • MergeUserNameProofBody merge_username_proof_body = 8

    Deprecated MergeIdRegistryEventBody merge_id_registry_event_body = 6; MergeNameRegistryEventBody merge_name_registry_event_body = 7;

  • MergeOnChainEventBody merge_on_chain_event_body = 11

    Deprecated MergeRentRegistryEventBody merge_rent_registry_event_body = 9; MergeStorageAdminRegistryEventBody merge_storage_admin_registry_event_body = 10;

  • MergeFailureBody merge_failure = 13

  • BlockConfirmedBody block_confirmed_body = 16

• uint64 block_number = 12

• uint32 shard_index = 14

• uint64 timestamp = 15

Used in: HubEvent, SubscribeRequest

• HUB_EVENT_TYPE_NONE = 0

• HUB_EVENT_TYPE_MERGE_MESSAGE = 1

• HUB_EVENT_TYPE_PRUNE_MESSAGE = 2

• HUB_EVENT_TYPE_REVOKE_MESSAGE = 3

• HUB_EVENT_TYPE_MERGE_USERNAME_PROOF = 6

  Deprecated HUB_EVENT_TYPE_MERGE_ID_REGISTRY_EVENT = 4; HUB_EVENT_TYPE_MERGE_NAME_REGISTRY_EVENT = 5;

• HUB_EVENT_TYPE_MERGE_ON_CHAIN_EVENT = 9

  Deprecated HUB_EVENT_TYPE_MERGE_RENT_REGISTRY_EVENT = 7; HUB_EVENT_TYPE_MERGE_STORAGE_ADMIN_REGISTRY_EVENT = 8;

• HUB_EVENT_TYPE_MERGE_FAILURE = 10

• HUB_EVENT_TYPE_BLOCK_CONFIRMED = 11

Used in: OnChainEvent

• bytes to = 1

• IdRegisterEventType event_type = 2

• bytes from = 3

• bytes recovery_address = 4

Used in: IdRegisterEventBody

• ID_REGISTER_EVENT_TYPE_NONE = 0

• ID_REGISTER_EVENT_TYPE_REGISTER = 1

• ID_REGISTER_EVENT_TYPE_TRANSFER = 2

• ID_REGISTER_EVENT_TYPE_CHANGE_RECOVERY = 3

* Registers an Ed25519 key for an FID via custody-authenticated message

Used in: MessageData

• bytes key = 1

  Ed25519 public key (32 bytes)

• uint32 key_type = 2

  1 = Ed25519

• bytes custody_signature = 3

  EIP-712 signature from custody address

• uint32 deadline = 4

  Farcaster epoch timestamp after which the custody signature is invalid

• uint32 nonce = 5

  Monotonically increasing per-FID user nonce

• bytes metadata = 6

  ABI-encoded SignedKeyRequestMetadata

• uint32 metadata_type = 7

  Must be 1 (SignedKeyRequest)

• bytes registration_tx_hash = 8

  Optional: tx hash of the FID registration transaction

• repeated int32 scopes = 9

  Allowed MessageType values; required and non-empty

• uint32 ttl = 10

  Seconds; must be > 0. Sliding expiry window; max enforced at validation.

* Revokes an Ed25519 key via custody signature or self-revocation

Used in: MessageData

• bytes key = 1

  Ed25519 public key to remove

• bytes signature = 2

  EIP-712 (custody) or Ed25519 (self-revocation) signature

• uint32 signature_type = 3

  1 = custody (EIP-712), 2 = self (Ed25519)

• uint32 deadline = 4

  Farcaster epoch timestamp after which the signature is invalid

• uint32 nonce = 5

  Monotonically increasing nonce (user nonce for custody, app nonce for self)

Used in: MessageData

• uint64 to_fid = 1

• uint64 num_units = 2

• StorageUnitType unit_type = 3

* Adds or removes a Link

Used in: MessageData

• string type = 1

  Type of link, <= 8 characters

• optional uint32 displayTimestamp = 2

  User-defined timestamp that preserves original timestamp when message.data.timestamp needs to be updated for compaction

• oneof target

  • uint64 target_fid = 3

    The fid the link relates to

* A Compaction message for the Link Store

Used in: MessageData

• string type = 1

  Type of link, <= 8 characters

• repeated uint64 target_fids = 2

Gossip related messages

Used in: GossipMessage

• oneof mempool_message

  • Message user_message = 1

Used in: HubEvent

• optional Message message = 1

• string code = 2

• string reason = 3

Used in: HubEvent

• optional Message message = 1

• repeated Message deleted_messages = 2

Used in: BlockEventData

• optional Message message = 1

Used in: HubEvent

• optional OnChainEvent on_chain_event = 1

Used in: HubEvent

• optional UserNameProof username_proof = 1

• optional UserNameProof deleted_username_proof = 2

• optional Message username_proof_message = 3

• optional Message deleted_username_proof_message = 4

Used in: MeshPeer

• MESH_NODE_TYPE_UNKNOWN = 0

• MESH_NODE_TYPE_VALIDATOR = 1

• MESH_NODE_TYPE_NON_VALIDATOR = 2

Used in: MeshView

• bytes peer_id = 1

• MeshNodeType node_type = 2

• optional bytes consensus_public_key = 3

  set iff PeerId matched a validator-set entry

• bool connected = 4

• bool direct_peer = 5

• ContactSource contact_source = 6

  COLLECTED vs DERIVED — never conflate the two

• optional ContactInfoBody contact_info = 7

  set only when contact_source == COLLECTED

• string observed_address = 8

  internal: live-connection addr; not a self-announced IP

• repeated TopicMembership topics = 9

• repeated GossipRate gossip_rates = 10

Used in: MeshView

• bytes peer_id = 1

• bytes consensus_public_key = 2

  node identity key (always present)

• bool is_validator = 3

  key is in the validator set at current height

• string gossip_address = 4

• string rpc_address = 5

• string snapchain_version = 6

• FarcasterNetwork network = 7

• repeated string subscribed_topics = 8

• uint32 consensus_mesh_size = 9

• uint64 current_height = 10

Used as response type in: HubService.GetMeshView

Used as field type in: MeshTopology

• optional MeshSelf local = 1

  The responding node. Named `local` (not `self`) to avoid the Rust keyword.

• repeated MeshPeer peers = 2

• uint64 generated_at = 3

  unix millis

* A Message is a delta operation on the Farcaster network. The message protobuf is an envelope that wraps a MessageData object and contains a hash and signature which can verify its authenticity.

Used as request type in: HubService.SubmitMessage, HubService.ValidateMessage

Used as response type in: HubService.GetCast, HubService.GetLink, HubService.GetReaction, HubService.GetUserData, HubService.GetVerification, HubService.SubmitMessage

Used as field type in: BulkMessageResponse, MempoolMessage, MergeFailureBody, MergeMessageBody, MergeMessageEventBody, MergeUserNameProofBody, MessagesResponse, PruneMessageBody, RevokeMessageBody, ShardTrieEntryWithMessage, SubmitBulkMessagesRequest, Transaction, ValidationResponse

• optional MessageData data = 1

  Contents of the message

• bytes hash = 2

  Hash digest of data

• HashScheme hash_scheme = 3

  Hash scheme that produced the hash digest

• bytes signature = 4

  Signature of the hash digest

• SignatureScheme signature_scheme = 5

  Signature scheme that produced the signature

• bytes signer = 6

  Public key or address of the key pair that produced the signature

• optional bytes data_bytes = 7

  MessageData serialized to bytes if using protobuf serialization other than ts-proto

* A MessageData object contains properties common to all messages and wraps a body object which contains properties specific to the MessageType.

Used in: Message

• MessageType type = 1

  Type of message contained in the body

• uint64 fid = 2

  Farcaster ID of the user producing the message

• uint32 timestamp = 3

  Farcaster epoch timestamp in seconds

• FarcasterNetwork network = 4

  Farcaster network the message is intended for

• oneof body

  • CastAddBody cast_add_body = 5

  • CastRemoveBody cast_remove_body = 6

  • ReactionBody reaction_body = 7

  • VerificationAddAddressBody verification_add_address_body = 9

  • VerificationRemoveBody verification_remove_body = 10

  • UserDataBody user_data_body = 12

    SignerAddBody signer_add_body = 11; // Deprecated

  • LinkBody link_body = 14

    SignerRemoveBody signer_remove_body = 13; // Deprecated

  • UserNameProof username_proof_body = 15

  • FrameActionBody frame_action_body = 16

  • LinkCompactStateBody link_compact_state_body = 17

    Compaction messages

  • LendStorageBody lend_storage_body = 18

  • KeyAddBody key_add_body = 19

  • KeyRemoveBody key_remove_body = 20

Used in: BulkMessageResponse

• bytes hash = 1

• string errCode = 2

• string message = 3

* Type of the MessageBody

Used in: MessageData

• MESSAGE_TYPE_NONE = 0

• MESSAGE_TYPE_CAST_ADD = 1

  Add a new Cast

• MESSAGE_TYPE_CAST_REMOVE = 2

  Remove an existing Cast

• MESSAGE_TYPE_REACTION_ADD = 3

  Add a Reaction to a Cast

• MESSAGE_TYPE_REACTION_REMOVE = 4

  Remove a Reaction from a Cast

• MESSAGE_TYPE_LINK_ADD = 5

  Add a new Link

• MESSAGE_TYPE_LINK_REMOVE = 6

  Remove an existing Link

• MESSAGE_TYPE_VERIFICATION_ADD_ETH_ADDRESS = 7

  Add a Verification of an Ethereum Address

• MESSAGE_TYPE_VERIFICATION_REMOVE = 8

  Remove a Verification

• MESSAGE_TYPE_USER_DATA_ADD = 11

  Deprecated MESSAGE_TYPE_SIGNER_ADD = 9; // Add a new Ed25519 key pair that signs messages for a user MESSAGE_TYPE_SIGNER_REMOVE = 10; // Remove an Ed25519 key pair that signs messages for a user

  Add metadata about a user

• MESSAGE_TYPE_USERNAME_PROOF = 12

  Add or replace a username proof

• MESSAGE_TYPE_FRAME_ACTION = 13

  A Farcaster Frame action

• MESSAGE_TYPE_LINK_COMPACT_STATE = 14

  Link Compaction State Message

• MESSAGE_TYPE_LEND_STORAGE = 15

• MESSAGE_TYPE_KEY_ADD = 16

  Register an Ed25519 key via custody-authenticated message

• MESSAGE_TYPE_KEY_REMOVE = 17

  Revoke an Ed25519 key via custody signature or self-revocation

Used as response type in: HubService.GetAllCastMessagesByFid, HubService.GetAllLendStorageMessagesByFid, HubService.GetAllLinkMessagesByFid, HubService.GetAllReactionMessagesByFid, HubService.GetAllUserDataMessagesByFid, HubService.GetAllVerificationMessagesByFid, HubService.GetCastsByFid, HubService.GetCastsByMention, HubService.GetCastsByParent, HubService.GetLinkCompactStateMessageByFid, HubService.GetLinksByFid, HubService.GetLinksByTarget, HubService.GetReactionsByCast, HubService.GetReactionsByFid, HubService.GetReactionsByTarget, HubService.GetUserDataByFid, HubService.GetVerificationsByFid

• repeated Message messages = 1

• optional bytes next_page_token = 2

Used as request type in: AdminService.SubmitOnChainEvent

Used as response type in: AdminService.SubmitOnChainEvent, HubService.GetIdRegistryOnChainEvent, HubService.GetIdRegistryOnChainEventByAddress, HubService.GetOnChainSigner

Used as field type in: MergeOnChainEventBody, OnChainEventResponse, ShardTrieEntryWithMessage, Signer, ValidatorMessage

• OnChainEventType type = 1

• uint32 chain_id = 2

• uint32 block_number = 3

• bytes block_hash = 4

• uint64 block_timestamp = 5

• bytes transaction_hash = 6

• uint32 log_index = 7

• uint64 fid = 8

• oneof body

  • SignerEventBody signer_event_body = 9

  • SignerMigratedEventBody signer_migrated_event_body = 10

  • IdRegisterEventBody id_register_event_body = 11

  • StorageRentEventBody storage_rent_event_body = 12

  • TierPurchaseBody tier_purchase_event_body = 15

• uint32 tx_index = 13

• uint32 version = 14

Used as response type in: HubService.GetOnChainEvents, HubService.GetOnChainSignersByFid

• repeated OnChainEvent events = 1

• optional bytes next_page_token = 2

• uint64 last_l2_block = 3

Used in: OnChainEvent, OnChainEventRequest

• EVENT_TYPE_NONE = 0

• EVENT_TYPE_SIGNER = 1

• EVENT_TYPE_SIGNER_MIGRATED = 2

• EVENT_TYPE_ID_REGISTER = 3

• EVENT_TYPE_STORAGE_RENT = 4

• EVENT_TYPE_TIER_PURCHASE = 5

Used in: ConsensusMessage

• optional Height height = 1

• int64 round = 2

• int64 pol_round = 3

• bytes proposer = 4

• optional ShardHash value = 5

  repeated Transaction transactions = 4; // Transactions for the shard level proposals (submitted by shard leader) repeated ShardHeader shard_headers = 5; // shard headers for the block level proposal (submitted by the block leader)

* Type of Protocol to disambiguate verification addresses

Used in: VerificationAddAddressBody, VerificationRemoveBody

• PROTOCOL_ETHEREUM = 0

• PROTOCOL_SOLANA = 1

Used in: HubEvent

• optional Message message = 1

* Adds or removes a Reaction from a Cast

Used in: MessageData

• ReactionType type = 1

  Type of reaction

• oneof target

  • CastId target_cast_id = 2

    CastId of the Cast to react to

  • string target_url = 3

    URL to react to

* Type of Reaction

Used in: ReactionBody, ReactionRequest, ReactionsByFidRequest, ReactionsByTargetRequest

• REACTION_TYPE_NONE = 0

• REACTION_TYPE_LIKE = 1

  Like the target cast

• REACTION_TYPE_RECAST = 2

  Share target cast to the user's audience

Used as request type in: HubService.GetReactionsByCast, HubService.GetReactionsByTarget

• oneof target

  • CastId target_cast_id = 1

  • string target_url = 6

• optional ReactionType reaction_type = 2

• optional uint32 page_size = 3

• optional bytes page_token = 4

• optional bool reverse = 5

Used in: GossipMessage

• oneof read_node_message

  • DecidedValue decided_value = 1

• uint32 shard_id = 1

• uint64 height = 2

• uint32 virtual_trie_shard = 3

• optional string next_page_token = 4

• uint32 last_response = 5

  These fields are used by the client to store the progress in the DB

  The WorkUnitResponse from the last pass

• optional uint64 last_fid = 6

  The last FID processed (to continue from last pass)

Used in: RetryOnchainEventsRequest

• uint64 start_block_number = 1

• uint64 stop_block_number = 2

Used in: HubEvent

• optional Message message = 1

Used in: DecidedValue, FullProposal, ShardChunksResponse, ShardSnapshotMetadata

• optional ShardHeader header = 1

• bytes hash = 2

• repeated Transaction transactions = 3

• optional Commits commits = 4

Used in: ShardWitness

• optional Height height = 1

• bytes shard_root = 2

• bytes shard_hash = 3

Uniquely identifies a hash within a shard

Used in: Commits, Proposal, Vote

• uint32 shard_index = 1

• bytes hash = 2

Used in: ShardChunk

• optional Height height = 1

• uint64 timestamp = 2

• bytes parent_hash = 3

• bytes shard_root = 4

  State root for the shard after applying the transactions for the height

Used in: GetInfoResponse

• uint32 shard_id = 1

• uint64 max_height = 2

• uint64 num_messages = 3

• uint64 num_fid_registrations = 4

• uint64 approx_size = 5

• uint64 block_delay = 6

• uint64 mempool_size = 7

• uint64 num_onchain_events = 8

Used in: GetShardSnapshotMetadataResponse

• uint32 shard_id = 1

• uint64 height = 2

• uint64 timestamp = 3

• optional ShardChunk shard_chunk = 5

• optional Block block = 6

• uint64 num_items = 7

Used in: GetShardTransactionsResponse

• bytes trie_key = 1

  The trie key of the leaf node.

• oneof trie_message

  This should always be present, will be None only if a trie key's message was not found in the DB, which should be never happen..

  • Message user_message = 2

  • OnChainEvent on_chain_event = 3

  • FnameTransfer fname_transfer = 4

Used in: Block

• repeated ShardChunkWitness shard_chunk_witnesses = 1

* Type of signature scheme used to sign the Message hash

Used in: Message

• SIGNATURE_SCHEME_NONE = 0

• SIGNATURE_SCHEME_ED25519 = 1

  Ed25519 signature (default)

• SIGNATURE_SCHEME_EIP712 = 2

  ECDSA signature using EIP-712 scheme

Unified per-key record. Optional fields are populated only when carried by the underlying source (on-chain signer event vs. gasless KEY_ADD record).

Used in: SignerResponse, SignersByFidResponse

• SignerSource source = 1

• bytes key = 2

  32-byte Ed25519 public key

• uint32 key_type = 3

  1 = Ed25519

• uint64 fid = 4

• optional uint64 added_at = 5

  Common metadata. All timestamps are Unix epoch seconds regardless of source; off-chain values that natively live in Farcaster time (MessageData.timestamp, gasless last-used tracking) are converted at the RPC boundary so clients can compare/compute across sources without an epoch table.

  Unix epoch seconds

• optional uint64 last_used_at = 6

  Unix epoch seconds; off-chain only

• optional uint32 ttl = 7

  duration in seconds; off-chain only

• optional uint64 expires_at = 8

  Unix epoch seconds; computed as last_used_at + ttl when ttl > 0

• repeated int32 scopes = 9

  Off-chain–only fields

  mirrors KeyAddBody.scopes (raw MessageType ints)

• optional uint64 request_fid = 10

  verified requestFid from SignedKeyRequestMetadata

• optional uint32 nonce = 11

  user nonce on the originating KEY_ADD

• optional OnChainEvent onchain_event = 12

  On-chain–only payload — original event for callers that need raw fields (block_hash, transaction_hash, log_index, metadata bytes, etc.).

Used in: OnChainEvent

• bytes key = 1

• uint32 key_type = 2

• SignerEventType event_type = 3

• bytes metadata = 4

• uint32 metadata_type = 5

Used in: SignerEventBody

• SIGNER_EVENT_TYPE_NONE = 0

• SIGNER_EVENT_TYPE_ADD = 1

• SIGNER_EVENT_TYPE_REMOVE = 2

• SIGNER_EVENT_TYPE_ADMIN_RESET = 3

Used in: OnChainEvent

• uint32 migratedAt = 1

Used as request type in: HubService.GetOnChainSigner, HubService.GetSigner

• uint64 fid = 1

• bytes signer = 2

Source of a signer record returned by GetSigner / GetSignersByFid.

Used in: Signer

• SIGNER_SOURCE_NONE = 0

• SIGNER_SOURCE_ONCHAIN = 1

• SIGNER_SOURCE_OFFCHAIN = 2

  gasless / KEY_ADD

Used in: GossipMessage

• bytes peer_id = 1

• optional Height height = 2

• optional Height min_height = 3

Used in: StorageLimitsResponse

• StoreType store_type = 1

• string name = 2

• uint64 limit = 3

• uint64 used = 4

• uint64 earliestTimestamp = 5

• bytes earliestHash = 6

Used in: OnChainEvent

• bytes payer = 1

• uint32 units = 2

• uint32 expiry = 3

Used in: StorageLimitsResponse

• StorageUnitType unit_type = 1

• uint32 unit_size = 2

• uint32 purchased_unit_size = 3

• uint32 lent_unit_size = 4

• uint32 borrowed_unit_size = 5

Used in: LendStorageBody, StorageUnitDetails

• UNIT_TYPE_LEGACY = 0

• UNIT_TYPE_2024 = 1

• UNIT_TYPE_2025 = 2

Used in: StorageLimit

• STORE_TYPE_NONE = 0

• STORE_TYPE_CASTS = 1

• STORE_TYPE_LINKS = 2

• STORE_TYPE_REACTIONS = 3

• STORE_TYPE_USER_DATA = 4

• STORE_TYPE_VERIFICATIONS = 5

• STORE_TYPE_USERNAME_PROOFS = 6

• STORE_TYPE_STORAGE_LENDS = 7

• oneof sync_request

  • SyncValueRequest value = 1

  • SyncVoteSetRequest vote_set = 2

• oneof sync_response

  • SyncValueResponse value = 1

  • SyncVoteSetResponse vote_set = 2

Used in: SyncRequest

• optional Height height = 1

Used in: SyncResponse

• optional Height height = 1

• bytes full_value = 2

• optional Commits commits = 3

Used in: SyncRequest

• optional Height height = 1

• int64 round = 2

Used in: SyncResponse

• optional Height height = 1

• int64 round = 2

• repeated Vote votes = 3

• repeated bytes signatures = 4

Used in: StorageLimitsResponse

• TierType tier_type = 1

• uint64 expires_at = 2

Used in: OnChainEvent

• TierType tier_type = 1

• uint64 for_days = 2

• bytes payer = 3

Used in: TierDetails, TierPurchaseBody

• None = 0

• Pro = 1

Used in: MeshPeer

• string topic = 1

• bool subscribed = 2

• bool in_mesh = 3

  peer is in OUR gossipsub mesh for this topic

Used in: Block, ShardChunk

• uint64 fid = 1

• repeated Message user_messages = 2

• repeated ValidatorMessage system_messages = 3

• bytes account_root = 4

  State root for the account after applying the transaction for the fid

A validator that the crawl could not query directly. The crawl is connected-only: validators the serving node has no live connection to, or that did not respond in time, are surfaced here rather than dropped.

Used in: MeshTopology

• bytes peer_id = 1

• bytes consensus_public_key = 2

  set when the missing node is a known validator

• string reason = 3

  "not_connected" | "timeout" | "error: …"

* Adds metadata about a user

Used in: MessageData

• UserDataType type = 1

  Type of metadata

• string value = 2

  Value of the metadata

* Type of UserData

Used in: UserDataBody, UserDataRequest

• USER_DATA_TYPE_NONE = 0

• USER_DATA_TYPE_PFP = 1

  Profile Picture for the user

• USER_DATA_TYPE_DISPLAY = 2

  Display Name for the user

• USER_DATA_TYPE_BIO = 3

  Bio for the user

• USER_DATA_TYPE_URL = 5

  URL of the user

• USER_DATA_TYPE_USERNAME = 6

  Preferred Name for the user

• USER_DATA_TYPE_LOCATION = 7

  Current location for the user

• USER_DATA_TYPE_TWITTER = 8

  Username of user on twitter

• USER_DATA_TYPE_GITHUB = 9

  Username of user on github

• USER_DATA_TYPE_BANNER = 10

  Banner image for the user

• USER_DATA_PRIMARY_ADDRESS_ETHEREUM = 11

  Primary address for the user on Ethereum

• USER_DATA_PRIMARY_ADDRESS_SOLANA = 12

  Primary address for the user on Solana

• USER_DATA_TYPE_PROFILE_TOKEN = 13

  Profile token in CAIP-19 format

• USER_DATA_TYPE_LIVE_AT = 14

  URL of the user's live activity

Used as request type in: AdminService.SubmitUserNameProof

Used as response type in: AdminService.SubmitUserNameProof, HubService.GetUsernameProof

Used as field type in: FnameTransfer, MergeUserNameProofBody, MessageData, UsernameProofsResponse

• uint64 timestamp = 1

• bytes name = 2

• bytes owner = 3

• bytes signature = 4

• uint64 fid = 5

• UserNameType type = 6

Used in: UserNameProof

• USERNAME_TYPE_NONE = 0

• USERNAME_TYPE_FNAME = 1

• USERNAME_TYPE_ENS_L1 = 2

• USERNAME_TYPE_BASENAME = 3

Used in: ValidatorSet

• uint64 fid = 1

• bytes signer = 2

• string rpc_address = 3

• uint32 shard_index = 4

• uint64 current_height = 5

Validator initiated prunes/revokes etc

Used in: Transaction

• optional OnChainEvent on_chain_event = 1

• optional FnameTransfer fname_transfer = 2

• optional BlockEvent block_event = 3

• repeated Validator validators = 1

* Adds a Verification of ownership of an Address based on Protocol

Used in: MessageData

• bytes address = 1

  Address being verified for a given Protocol

• bytes claim_signature = 2

  Signature produced by the user's address for a given Protocol

• bytes block_hash = 3

  Hash of the latest Ethereum block when the signature was produced

• uint32 verification_type = 4

  Type of verification. 0 = EOA, 1 = contract

• uint32 chain_id = 5

  0 for EOA verifications, 1 or 10 for contract verifications

• Protocol protocol = 7

  Protocol of the Verification

* Removes a Verification of a given protocol

Used in: MessageData

• bytes address = 1

  Address of the Verification to remove

• Protocol protocol = 2

  Protocol of the Verification to remove

Used in: ConsensusMessage, SyncVoteSetResponse

• VoteType type = 1

• optional Height height = 2

• int64 round = 3

• optional ShardHash value = 4

• bytes voter = 5

Consensus messages

Used in: Vote

• PREVOTE = 0

• PRECOMMIT = 1