Preplay Shreds

​

API

service Geyser {
  rpc SubscribeDeshred(stream SubscribeDeshredRequest) returns (stream SubscribeUpdateDeshred) {}
}

message SubscribeDeshredRequest {
  map<string, SubscribeRequestFilterDeshredTransactions> deshred_transactions = 1;
  optional SubscribeRequestPing ping = 2;
}

message SubscribeRequestFilterDeshredTransactions {
  optional bool vote = 1;
  repeated string account_include = 2;
  repeated string account_exclude = 3;
  repeated string account_required = 4;
}

message SubscribeUpdateDeshred {
  repeated string filters = 1;
  oneof update_oneof {
    SubscribeUpdateDeshredTransaction deshred_transaction = 2;
    SubscribeUpdatePing ping = 3;
    SubscribeUpdatePong pong = 4;
  }
  google.protobuf.Timestamp created_at = 5;
}

message SubscribeUpdateDeshredTransaction {
  SubscribeUpdateDeshredTransactionInfo transaction = 1;
  uint64 slot = 2;
}

message SubscribeUpdateDeshredTransactionInfo {
  bytes signature = 1;
  bool is_vote = 2;
  solana.storage.ConfirmedBlock.Transaction transaction = 3;
  repeated bytes loaded_writable_addresses = 4;
  repeated bytes loaded_readonly_addresses = 5;
  uint32 completed_data_set_starting_shred_index = 6;
  uint32 completed_data_set_ending_shred_index_exclusive = 7;
}

​

Filters

• account_include is empty, or the transaction uses at least one of its accounts;
• none of the account_exclude accounts appear in it;
• it uses every account in account_required.

• Vote transactions are never sent. Leave vote unset or set it to false; true is refused with INVALID_ARGUMENT.
• Up to 16 filters per stream and 1,024 accounts per list. Filter names are at most 64 bytes.
• Send a new request on the same stream at any time to replace the filters. A request with no filters stops delivery until you send new ones.
• slots and include_update_parent are not supported and are refused.

​

What you receive

• Signed transactions, in the order the leader recorded them: legacy, v0 and v1.
• Lookup-table addresses already resolved in loaded_writable_addresses and loaded_readonly_addresses. In the rare case a table cannot be resolved, both lists are empty while the message still lists its address_table_lookups, and a filter with account_exclude skips that transaction.
• No execution results. The transactions have not been executed yet, so there is no status, logs, fee or balance change. A transaction you see here can still fail, and the slot can still be skipped.

​

Staying connected

• The server sends a ping every 15 seconds. Reply with a request carrying ping so proxies between you and the service keep the connection open; the reply does not change your filters.
• Set the client’s maximum decoded message size to at least 64 MB.
• Read continuously. A client that falls behind the stream, or reads nothing for 10 seconds, is disconnected with DATA_LOSS. Narrow your filters if you cannot keep up with the full stream.
• Reconnect with exponential backoff when a stream ends. Nothing is replayed on reconnect; transactions broadcast while you were disconnected are not resent.
• UNAVAILABLE and RESOURCE_EXHAUSTED without an error code are temporary: retry with backoff. INVALID_ARGUMENT means a filter was rejected: fix the request.
• Do not retry on UNAUTHENTICATED, NOT_ENTITLED, IP_NOT_ALLOWED or QUOTA_EXCEEDED. See Errors.

​

Metering