Default package

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc RebuildSyncTrie (Empty, Empty)

  rpc.proto:124

• rpc DeleteAllMessagesFromDb (Empty, Empty)

  rpc.proto:125

• rpc SubmitOnChainEvent (OnChainEvent, OnChainEvent)

  rpc.proto:127

• rpc SubmitMessage (Message, Message)

  rpc.proto:19

  Submit Methods

• rpc ValidateMessage (Message, ValidationResponse)

  rpc.proto:22

  Validation Methods

  message ValidationResponse

  request_response.proto:271

  • bool valid = 1

  • optional Message message = 2

• rpc Subscribe (SubscribeRequest, stream HubEvent)

  rpc.proto:26

  Event Methods @http-api: none

  message SubscribeRequest

  request_response.proto:11

  • repeated HubEventType event_types = 1

  • optional uint64 from_id = 2

  • optional uint64 total_shards = 3

  • optional uint64 shard_index = 4

• rpc GetEvent (EventRequest, HubEvent)

  rpc.proto:28

  @http-api: events

  message EventRequest

  request_response.proto:18

  • uint64 id = 1

• rpc GetCast (CastId, Message)

  rpc.proto:32

  Casts @http-api: castById

• rpc GetCastsByFid (FidRequest, MessagesResponse)

  rpc.proto:33

• rpc GetCastsByParent (CastsByParentRequest, MessagesResponse)

  rpc.proto:34

  message CastsByParentRequest

  request_response.proto:120

  • 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 GetCastsByMention (FidRequest, MessagesResponse)

  rpc.proto:35

• rpc GetReaction (ReactionRequest, Message)

  rpc.proto:39

  Reactions @http-api: reactionById

  message ReactionRequest

  request_response.proto:130

  • uint64 fid = 1

  • ReactionType reaction_type = 2

  • oneof target

    • CastId target_cast_id = 3

    • string target_url = 4

• rpc GetReactionsByFid (ReactionsByFidRequest, MessagesResponse)

  rpc.proto:40

  message ReactionsByFidRequest

  request_response.proto:139

  • uint64 fid = 1

  • optional ReactionType reaction_type = 2

  • optional uint32 page_size = 3

  • optional bytes page_token = 4

  • optional bool reverse = 5

• rpc GetReactionsByCast (ReactionsByTargetRequest, MessagesResponse)

  rpc.proto:41

  To be deprecated

• rpc GetReactionsByTarget (ReactionsByTargetRequest, MessagesResponse)

  rpc.proto:42

• rpc GetUserData (UserDataRequest, Message)

  rpc.proto:46

  User Data @http-api: none

  message UserDataRequest

  request_response.proto:158

  • uint64 fid = 1

  • UserDataType user_data_type = 2

• rpc GetUserDataByFid (FidRequest, MessagesResponse)

  rpc.proto:47

• rpc GetUsernameProof (UsernameProofRequest, UserNameProof)

  rpc.proto:51

  Username Proof @http-api: userNameProofByName

  message UsernameProofRequest

  request_response.proto:219

  • bytes name = 1

• rpc GetUserNameProofsByFid (FidRequest, UsernameProofsResponse)

  rpc.proto:52

  message UsernameProofsResponse

  request_response.proto:223

  • repeated UserNameProof proofs = 1

• rpc GetVerification (VerificationRequest, Message)

  rpc.proto:56

  Verifications @http-api: none

  message VerificationRequest

  request_response.proto:227

  • uint64 fid = 1

  • bytes address = 2

• rpc GetVerificationsByFid (FidRequest, MessagesResponse)

  rpc.proto:57

• rpc GetOnChainSigner (SignerRequest, OnChainEvent)

  rpc.proto:61

  OnChain Events @http-api: none

  message SignerRequest

  request_response.proto:232

  • uint64 fid = 1

  • bytes signer = 2

• rpc GetOnChainSignersByFid (FidRequest, OnChainEventResponse)

  rpc.proto:62

• rpc GetOnChainEvents (OnChainEventRequest, OnChainEventResponse)

  rpc.proto:64

  @http-api: none

• rpc GetIdRegistryOnChainEvent (FidRequest, OnChainEvent)

  rpc.proto:66

  @http-api: none

• rpc GetIdRegistryOnChainEventByAddress (IdRegistryEventByAddressRequest, OnChainEvent)

  rpc.proto:68

  @http-api: onChainIdRegistryEventByAddress

  message IdRegistryEventByAddressRequest

  request_response.proto:263

  • bytes address = 1

• rpc GetCurrentStorageLimitsByFid (FidRequest, StorageLimitsResponse)

  rpc.proto:70

  @http-api: storageLimitsByFid

  message StorageLimitsResponse

  request_response.proto:184

  • repeated StorageLimit limits = 1

  • uint32 units = 2

  • repeated StorageUnitDetails unit_details = 3

• rpc GetFids (FidsRequest, FidsResponse)

  rpc.proto:72

  message FidsRequest

  request_response.proto:104

  • optional uint32 page_size = 1

  • optional bytes page_token = 2

  • optional bool reverse = 3

  message FidsResponse

  request_response.proto:110

  • repeated uint64 fids = 1

  • optional bytes next_page_token = 2

• rpc GetLink (LinkRequest, Message)

  rpc.proto:76

  Links @http-api: linkById

  message LinkRequest

  request_response.proto:237

  • uint64 fid = 1

  • string link_type = 2

  • oneof target

    • uint64 target_fid = 3

• rpc GetLinksByFid (LinksByFidRequest, MessagesResponse)

  rpc.proto:77

  message LinksByFidRequest

  request_response.proto:245

  • 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:79

  @http-api: linksByTargetFid

  message LinksByTargetRequest

  request_response.proto:253

  • 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 GetAllCastMessagesByFid (FidTimestampRequest, MessagesResponse)

  rpc.proto:85

  Bulk Methods The Bulk methods don't have corresponding HTTP API endpoints because the regular endpoints can be used to get all the messages @http-api: none

• rpc GetAllReactionMessagesByFid (FidTimestampRequest, MessagesResponse)

  rpc.proto:87

  @http-api: none

• rpc GetAllVerificationMessagesByFid (FidTimestampRequest, MessagesResponse)

  rpc.proto:89

  @http-api: none

• rpc GetAllUserDataMessagesByFid (FidTimestampRequest, MessagesResponse)

  rpc.proto:91

  @http-api: none

• rpc GetAllLinkMessagesByFid (FidTimestampRequest, MessagesResponse)

  rpc.proto:93

  @http-api: none

• rpc GetLinkCompactStateMessageByFid (FidRequest, MessagesResponse)

  rpc.proto:95

  @http-api: none

• rpc SubmitBulkMessages (SubmitBulkMessagesRequest, SubmitBulkMessagesResponse)

  rpc.proto:97

  @http-api: none

  message SubmitBulkMessagesRequest

  request_response.proto:276

  • repeated Message messages = 1

  message SubmitBulkMessagesResponse

  request_response.proto:293

  • repeated BulkMessageResponse messages = 1

• rpc GetInfo (HubInfoRequest, HubInfoResponse)

  rpc.proto:100

  Sync Methods

• rpc GetCurrentPeers (Empty, ContactInfoResponse)

  rpc.proto:101

• rpc StopSync (Empty, SyncStatusResponse)

  rpc.proto:103

  @http-api: none

• rpc ForceSync (SyncStatusRequest, SyncStatusResponse)

  rpc.proto:106

  This is experimental, do not rely on this endpoint existing in the future @http-api: none

• rpc GetSyncStatus (SyncStatusRequest, SyncStatusResponse)

  rpc.proto:108

  @http-api: none

• rpc GetAllSyncIdsByPrefix (TrieNodePrefix, SyncIds)

  rpc.proto:110

  @http-api: none

• rpc GetAllMessagesBySyncIds (SyncIds, MessagesResponse)

  rpc.proto:112

  @http-api: none

• rpc GetSyncMetadataByPrefix (TrieNodePrefix, TrieNodeMetadataResponse)

  rpc.proto:114

  @http-api: none

• rpc GetSyncSnapshotByPrefix (TrieNodePrefix, TrieNodeSnapshotResponse)

  rpc.proto:116

  @http-api: none

• rpc StreamSync (stream StreamSyncRequest, stream StreamSyncResponse)

  rpc.proto:118

  @http-api: none

  message StreamSyncRequest

  request_response.proto:297

  • oneof request

    • HubInfoRequest get_info = 1

    • Empty get_current_peers = 2

    • Empty stop_sync = 3

    • SyncStatusRequest force_sync = 4

    • SyncStatusRequest get_sync_status = 5

    • TrieNodePrefix get_all_sync_ids_by_prefix = 6

    • SyncIds get_all_messages_by_sync_ids = 7

    • TrieNodePrefix get_sync_metadata_by_prefix = 8

    • TrieNodePrefix get_sync_snapshot_by_prefix = 9

    • OnChainEventRequest get_on_chain_events = 10

    • FidRequest get_on_chain_signers_by_fid = 11

  message StreamSyncResponse

  request_response.proto:319

  • oneof response

    • HubInfoResponse get_info = 1

    • ContactInfoResponse get_current_peers = 2

    • SyncStatusResponse stop_sync = 3

    • SyncStatusResponse force_sync = 4

    • SyncStatusResponse get_sync_status = 5

    • SyncIds get_all_sync_ids_by_prefix = 6

    • MessagesResponse get_all_messages_by_sync_ids = 7

    • TrieNodeMetadataResponse get_sync_metadata_by_prefix = 8

    • TrieNodeSnapshotResponse get_sync_snapshot_by_prefix = 9

    • OnChainEventResponse get_on_chain_events = 10

    • OnChainEventResponse get_on_chain_signers_by_fid = 11

    • StreamError error = 12

• rpc StreamFetch (stream StreamFetchRequest, stream StreamFetchResponse)

  rpc.proto:120

  @http-api: none

  message StreamFetchRequest

  request_response.proto:336

  • string idempotency_key = 1

  • oneof request

    • FidTimestampRequest cast_messages_by_fid = 2

    • FidTimestampRequest reaction_messages_by_fid = 3

    • FidTimestampRequest verification_messages_by_fid = 4

    • FidTimestampRequest user_data_messages_by_fid = 5

    • FidTimestampRequest link_messages_by_fid = 6

  message StreamFetchResponse

  request_response.proto:347

  • string idempotency_key = 1

  • oneof response

    • MessagesResponse messages = 2

    • StreamError error = 3

Used in: NetworkLatencyMessage

• bytes ping_origin_peer_id = 1

• bytes ack_origin_peer_id = 2

• uint64 ping_timestamp = 3

• uint64 ack_timestamp = 4

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

Used in: GossipMessage

• optional GossipAddressInfo gossip_address = 1

• optional GossipAddressInfo rpc_address = 2

• repeated string excluded_hashes = 3

• uint32 count = 4

• string hub_version = 5

• FarcasterNetwork network = 6

• string app_version = 7

• uint64 timestamp = 8

• optional ContactInfoContentBody body = 9

• bytes signature = 10

  Signature of the message digest

• bytes signer = 11

  Public key of the peer that originated the contact info

• optional bytes data_bytes = 12

  Optional alternative serialization used for signing

Used in: ContactInfoContent, ContactInfoResponse

• optional GossipAddressInfo gossip_address = 1

• optional GossipAddressInfo rpc_address = 2

• repeated string excluded_hashes = 3

• uint32 count = 4

• string hub_version = 5

• FarcasterNetwork network = 6

• string app_version = 7

• uint64 timestamp = 8

Used as response type in: HubService.GetCurrentPeers

Used as field type in: StreamSyncResponse

• repeated ContactInfoContentBody contacts = 1

Used in: HubInfoResponse

• uint64 num_messages = 1

• uint64 num_fid_events = 2

• uint64 num_fname_events = 3

• uint64 approx_size = 4

• bytes key = 1

• repeated uint32 childChars = 2

• uint32 items = 3

• bytes hash = 4

Used in: CastAddBody

• oneof embed

  • string url = 1

  • CastId cast_id = 2

Used as request type in: AdminService.DeleteAllMessagesFromDb, AdminService.RebuildSyncTrie, HubService.GetCurrentPeers, HubService.StopSync

Used as response type in: AdminService.DeleteAllMessagesFromDb, AdminService.RebuildSyncTrie

Used as field type in: StreamSyncRequest

(message has no fields)

* Farcaster network the message is intended for

Used in: ContactInfoContent, ContactInfoContentBody, 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 as request type in: HubService.GetCastsByFid, HubService.GetCastsByMention, HubService.GetCurrentStorageLimitsByFid, HubService.GetIdRegistryOnChainEvent, HubService.GetLinkCompactStateMessageByFid, HubService.GetOnChainSignersByFid, HubService.GetUserDataByFid, HubService.GetUserNameProofsByFid, HubService.GetVerificationsByFid

Used as field type in: StreamSyncRequest

• 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.GetAllLinkMessagesByFid, HubService.GetAllReactionMessagesByFid, HubService.GetAllUserDataMessagesByFid, HubService.GetAllVerificationMessagesByFid

Used as field type in: StreamFetchRequest

• 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

* 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

Used in: ContactInfoContent, ContactInfoContentBody

• string address = 1

• uint32 family = 2

• uint32 port = 3

• string dns_name = 4

• oneof content

  • Message message = 1

  • ContactInfoContent contact_info_content = 3

    Deprecated IdRegistryEvent id_registry_event = 2;

  • NetworkLatencyMessage network_latency_message = 7

  • MessageBundle message_bundle = 9

• repeated string topics = 4

• bytes peer_id = 5

• GossipVersion version = 6

• uint32 timestamp = 8

  Farcaster epoch timestamp in seconds when this message was first created

Used in: GossipMessage

• GOSSIP_VERSION_V1 = 0

• GOSSIP_VERSION_V1_1 = 1

* 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 as response type in: HubService.GetEvent, HubService.Subscribe

• 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

• 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

Used as request type in: HubService.GetInfo

Used as field type in: StreamSyncRequest

• bool db_stats = 1

Response Types for the Sync RPC Methods

Used as response type in: HubService.GetInfo

Used as field type in: StreamSyncResponse

• string version = 1

• bool is_syncing = 2

• string nickname = 3

• string root_hash = 4

• optional DbStats db_stats = 5

• string peerId = 6

• uint64 hub_operator_fid = 7

• uint64 last_fname_proof = 2

  uint32 last_eth_block = 1; // Deprecated

• uint64 last_l2_block = 3

• optional ValidateOrRevokeJobState validate_or_revoke_state = 5

  bool syncEvents = 4; // Deprecated

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

* 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

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

* 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, GossipMessage, MergeFailureBody, MergeMessageBody, MergeUserNameProofBody, MessageBundle, MessagesResponse, PruneMessageBody, RevokeMessageBody, SubmitBulkMessagesRequest, 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

Used in: GossipMessage

• bytes hash = 1

• repeated Message messages = 2

* 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

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

Used as response type in: HubService.GetAllCastMessagesByFid, HubService.GetAllLinkMessagesByFid, HubService.GetAllMessagesBySyncIds, 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

Used as field type in: StreamFetchResponse, StreamSyncResponse

• repeated Message messages = 1

• optional bytes next_page_token = 2

• bytes name = 1

Used in: GossipMessage

• oneof body

  • PingMessageBody ping_message = 2

  • AckMessageBody ack_message = 3

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

• 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

• uint32 tx_index = 13

• uint32 version = 14

Used as request type in: HubService.GetOnChainEvents

Used as field type in: StreamSyncRequest

• uint64 fid = 1

• OnChainEventType event_type = 2

• optional uint32 page_size = 3

• optional bytes page_token = 4

• optional bool reverse = 5

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

Used as field type in: StreamSyncResponse

• repeated OnChainEvent events = 1

• optional bytes next_page_token = 2

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

Used in: NetworkLatencyMessage

• bytes ping_origin_peer_id = 1

• uint64 ping_timestamp = 2

* 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

• uint64 fid = 1

Used in: HubEvent

• optional Message message = 1

• uint32 fid = 1

• bytes signer = 2

* 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

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

Used in: StorageUnitDetails

• UNIT_TYPE_LEGACY = 0

• UNIT_TYPE_2024 = 1

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

Used in: StreamFetchResponse, StreamSyncResponse

• string errCode = 1

• string message = 2

• string request = 3

Used as request type in: HubService.GetAllMessagesBySyncIds

Used as response type in: HubService.GetAllSyncIdsByPrefix

Used as field type in: StreamSyncRequest, StreamSyncResponse

• repeated bytes sync_ids = 1

Used in: SyncStatusResponse

• string peerId = 1

• string inSync = 2

• bool shouldSync = 3

• string divergencePrefix = 4

• int32 divergenceSecondsAgo = 5

• uint64 theirMessages = 6

• uint64 ourMessages = 7

• int64 lastBadSync = 8

• int64 score = 9

Used as request type in: HubService.ForceSync, HubService.GetSyncStatus

Used as field type in: StreamSyncRequest

• optional string peerId = 1

Used as response type in: HubService.ForceSync, HubService.GetSyncStatus, HubService.StopSync

Used as field type in: StreamSyncResponse

• bool is_syncing = 1

• repeated SyncStatus sync_status = 2

• bool engine_started = 3

Used as response type in: HubService.GetSyncMetadataByPrefix

Used as field type in: StreamSyncResponse

• bytes prefix = 1

• uint64 num_messages = 2

• string hash = 3

• repeated TrieNodeMetadataResponse children = 4

Used as request type in: HubService.GetAllSyncIdsByPrefix, HubService.GetSyncMetadataByPrefix, HubService.GetSyncSnapshotByPrefix

Used as field type in: StreamSyncRequest

• bytes prefix = 1

Used as response type in: HubService.GetSyncSnapshotByPrefix

Used as field type in: StreamSyncResponse

• bytes prefix = 1

• repeated string excluded_hashes = 2

• uint64 num_messages = 3

• string root_hash = 4

• bytes fname = 1

* 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 x

• USER_DATA_TYPE_GITHUB = 9

  Username of user on github

Used as response type in: HubService.GetUsernameProof

Used as field type in: 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

Used in: HubState

• uint32 last_job_timestamp = 1

  The (Farcaster time epoch) timestamp where the last job started

• uint32 last_fid = 2

  The last FID to complete successfully. If this is 0, then the last job finished successfully

* 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