package solana.geyser

Get desktop application:
View/edit binary Protocol Buffers messages

The following __must__ be assumed: - Clients may receive data for slots out of order. - Clients may receive account updates for a given slot out of order.

• rpc GetHeartbeatInterval (EmptyRequest, GetHeartbeatIntervalResponse)

  geyser.proto:192

  Invoke to get the expected heartbeat interval.

  message EmptyRequest

  geyser.proto:112

  (message has no fields)

  message GetHeartbeatIntervalResponse

  geyser.proto:160

  • uint64 heartbeat_interval_ms = 1

• rpc SubscribeAccountUpdates (SubscribeAccountUpdatesRequest, stream TimestampedAccountUpdate)

  geyser.proto:197

  Subscribes to account updates in the accounts database; additionally pings clients with empty heartbeats. Upon initially connecting the client can expect a `highest_write_slot` set in the http headers. Subscribe to account updates

  message SubscribeAccountUpdatesRequest

  geyser.proto:147

  • repeated bytes accounts = 1

• rpc SubscribeBlockUpdates (SubscribeBlockUpdatesRequest, stream TimestampedBlockUpdate)

  geyser.proto:215

  Subscribes to block updates.

  message SubscribeBlockUpdatesRequest

  geyser.proto:102

  (message has no fields)

  message TimestampedBlockUpdate

  geyser.proto:124

  • optional google.protobuf.Timestamp ts = 1

    Time at which the message was generated

  • optional BlockUpdate block_update = 2

    Block contents

• rpc SubscribePartialAccountUpdates (SubscribePartialAccountUpdatesRequest, stream MaybePartialAccountUpdate)

  geyser.proto:205

  Functions similarly to `SubscribeAccountUpdates`, but consumes less bandwidth. Returns the highest slot seen thus far in the http headers named `highest-write-slot`.

  message SubscribePartialAccountUpdatesRequest

  geyser.proto:155

  • bool skip_vote_accounts = 1

    If true, will not stream vote account updates.

  message MaybePartialAccountUpdate

  geyser.proto:104

  • oneof msg

    • PartialAccountUpdate partial_account_update = 1

    • Heartbeat hb = 2

• rpc SubscribeProgramUpdates (SubscribeProgramsUpdatesRequest, stream TimestampedAccountUpdate)

  geyser.proto:201

  Subscribes to updates given a list of program IDs. When an account update comes in that's owned by a provided program id, one will receive an update

  message SubscribeProgramsUpdatesRequest

  geyser.proto:151

  • repeated bytes programs = 1

• rpc SubscribeSlotEntryUpdates (SubscribeSlotEntryUpdateRequest, stream TimestampedSlotEntryUpdate)

  geyser.proto:219

  Subscribes to entry updates. Returns the highest slot seen thus far and the entry index corresponding to the tick

  message SubscribeSlotEntryUpdateRequest

  geyser.proto:185

  (message has no fields)

  message TimestampedSlotEntryUpdate

  geyser.proto:176

  • uint32 ts = 1

    Time at which the message was generated Send relative timestamp in micros using u32 to reduce overhead. Provides ~71 mins of accuracy between sender and receiver See [compact_timestamp::to_system_time]

  • optional SlotEntryUpdate entry_update = 2

    SlotEntryUpdate update

• rpc SubscribeSlotUpdates (SubscribeSlotUpdateRequest, stream TimestampedSlotUpdate)

  geyser.proto:209

  Subscribes to slot updates. Returns the highest slot seen thus far in the http headers named `highest-write-slot`.

  message SubscribeSlotUpdateRequest

  geyser.proto:145

  (message has no fields)

  message TimestampedSlotUpdate

  geyser.proto:86

  • optional google.protobuf.Timestamp ts = 1

    Time at which the message was generated

  • optional SlotUpdate slot_update = 2

    Slot update

• rpc SubscribeTransactionUpdates (SubscribeTransactionUpdatesRequest, stream TimestampedTransactionUpdate)

  geyser.proto:212

  Subscribes to transaction updates.

  message SubscribeTransactionUpdatesRequest

  geyser.proto:100

  (message has no fields)

  message TimestampedTransactionUpdate

  geyser.proto:139

  • optional google.protobuf.Timestamp ts = 1

  • optional TransactionUpdate transaction = 2

Used in: TimestampedAccountUpdate

• uint64 slot = 1

  Slot this update occurred.

• bytes pubkey = 2

  Account's pubkey.

• uint64 lamports = 3

  Account's lamports post update.

• bytes owner = 4

  Account's owner.

• bool is_executable = 5

  Flags whether an account is executable.

• uint64 rent_epoch = 6

  The epoch at which this account will next owe rent.

• bytes data = 7

  Account's data post update.

• uint64 seq = 8

  A monotonically increasing number specifying the order of this update. Can be used to determine what the latest update for an account was at a given slot, assuming there were multiple updates.

• bool is_startup = 9

  Flags whether this update was streamed as part of startup i.e. not a real-time update.

• optional string tx_signature = 10

  Transaction signature that caused this update.

• uint32 replica_version = 11

  AccountReplica version.

Used in: TimestampedBlockUpdate

• uint64 slot = 1

• string blockhash = 2

• repeated storage.ConfirmedBlock.Reward rewards = 3

• optional google.protobuf.Timestamp block_time = 4

• optional uint64 block_height = 5

• optional uint64 executed_transaction_count = 6

• optional uint64 entry_count = 7

Used in: MaybePartialAccountUpdate

(message has no fields)

Used in: MaybePartialAccountUpdate

• uint64 slot = 1

  Slot this update occurred.

• bytes pubkey = 2

  Account's pubkey.

• bytes owner = 3

  Account's owner.

• bool is_startup = 4

  Flags whether this update was streamed as part of startup, hence not a realtime update.

• uint64 seq = 5

  A monotonically increasing number specifying the order of this update. Can be used to determine what the latest update for an account was at a given slot, assuming there were multiple updates.

• optional string tx_signature = 6

  Transaction signature that caused this update.

• uint32 replica_version = 7

  AccountReplica version.

/ Modelled based off of https://github.com/solana-labs/solana/blob/v2.0/geyser-plugin-interface/src/geyser_plugin_interface.rs#L210 / If more details are needed can extend this structure.

Used in: TimestampedSlotEntryUpdate

• uint64 slot = 1

  The slot number of the block containing this Entry

• uint64 index = 2

  The Entry's index in the block

• uint64 executed_transaction_count = 3

  The number of executed transactions in the Entry If this number is zero, we can assume its a tick entry

Used in: TimestampedSlotUpdate

• uint64 slot = 1

• optional uint64 parent_slot = 2

• SlotUpdateStatus status = 3

Used in: SlotUpdate

• CONFIRMED = 0

• PROCESSED = 1

• ROOTED = 2

• FIRST_SHRED_RECEIVED = 3

• COMPLETED = 4

• CREATED_BANK = 5

• DEAD = 6

Used as response type in: Geyser.SubscribeAccountUpdates, Geyser.SubscribeProgramUpdates

• optional google.protobuf.Timestamp ts = 1

  Time at which the message was generated

• optional AccountUpdate account_update = 2

  Account update

Used in: TimestampedTransactionUpdate

• uint64 slot = 1

• string signature = 2

• bool is_vote = 3

• uint64 tx_idx = 4

• optional storage.ConfirmedBlock.ConfirmedTransaction tx = 5