Struct RpcStoreReadStore 

pub struct RpcStoreReadStore { /* private fields */ }

Read store backed by the embedded sui_rpc_store indexer.

Like RestReadStore it serves the sui-rpc-api trait stack, but it additionally exposes the index surface (which RestReadStore no longer does). This wrapper composes two backends:

• Raw chain data — objects, transactions, effects, events, checkpoints, committees, and child-object resolution — is served from the validator’s perpetual / checkpoint stores (RocksDbStore), exactly like RestReadStore. The embedded rpc-store does not duplicate this data.
• The index surface (RpcIndexes) — owner / type / balance / coin / package-version listings, epoch info, and the ledger-history bitmaps — is served from the RpcStoreReader.

The object/state available range is the intersection of the two backends’ ranges (max of their lower bounds): a consistent read at checkpoint C needs both the object bytes (perpetual store) and the index rows (rpc-store) at C. Ledger-history-specific availability (bounded by the history backfill watermark) is exposed separately.

Implementations

impl RpcStoreReadStore

pub fn new( state: Arc<AuthorityState>, rocks: RocksDbStore, reader: RpcStoreReader, ) -> Self

Trait Implementations

impl BackingPackageStore for RpcStoreReadStore

fn get_package_object( &self, _package_id: &ObjectID, ) -> SuiResult<Option<PackageObject>>

impl ObjectStore for RpcStoreReadStore

fn get_object(&self, object_id: &ObjectID) -> Option<Object>

fn get_object_by_key( &self, object_id: &ObjectID, version: SequenceNumber, ) -> Option<Object>

fn multi_get_objects_by_key( &self, object_keys: &[ObjectKey], ) -> Vec<Option<Object>>

fn multi_get_objects(&self, object_ids: &[ObjectID]) -> Vec<Option<Object>>

impl ReadStore for RpcStoreReadStore

fn get_committee(&self, epoch: EpochId) -> Option<Arc<Committee>>

fn get_latest_checkpoint(&self) -> Result<VerifiedCheckpoint>

Get the latest available checkpoint. This is the latest executed checkpoint.

fn get_highest_verified_checkpoint(&self) -> Result<VerifiedCheckpoint>

Get the highest verified checkpint. This is the highest checkpoint summary that has been verified, generally by state-sync. Only the checkpoint header is guaranteed to be present in the store.

fn get_highest_synced_checkpoint(&self) -> Result<VerifiedCheckpoint>

Get the highest synced checkpint. This is the highest checkpoint that has been synced from state-synce. The checkpoint header, contents, transactions, and effects of this checkpoint are guaranteed to be present in the store

fn get_lowest_available_checkpoint(&self) -> Result<CheckpointSequenceNumber>

Lowest available checkpoint for which transaction and checkpoint data can be requested.

fn get_checkpoint_by_digest( &self, digest: &CheckpointDigest, ) -> Option<VerifiedCheckpoint>

fn get_checkpoint_by_sequence_number( &self, sequence_number: CheckpointSequenceNumber, ) -> Option<VerifiedCheckpoint>

fn multi_get_checkpoint_by_sequence_number( &self, sequence_numbers: &[CheckpointSequenceNumber], ) -> Vec<Option<VerifiedCheckpoint>>

fn get_checkpoint_contents_by_digest( &self, digest: &CheckpointContentsDigest, ) -> Option<CheckpointContents>

fn get_checkpoint_contents_by_sequence_number( &self, sequence_number: CheckpointSequenceNumber, ) -> Option<CheckpointContents>

fn get_transaction( &self, digest: &TransactionDigest, ) -> Option<Arc<VerifiedTransaction>>

fn multi_get_transactions( &self, digests: &[TransactionDigest], ) -> Vec<Option<Arc<VerifiedTransaction>>>

fn get_transaction_effects( &self, digest: &TransactionDigest, ) -> Option<TransactionEffects>

fn multi_get_transaction_effects( &self, digests: &[TransactionDigest], ) -> Vec<Option<TransactionEffects>>

fn get_events(&self, digest: &TransactionDigest) -> Option<TransactionEvents>

fn multi_get_events( &self, digests: &[TransactionDigest], ) -> Vec<Option<TransactionEvents>>

fn get_full_checkpoint_contents( &self, sequence_number: Option<CheckpointSequenceNumber>, digest: &CheckpointContentsDigest, ) -> Option<VersionedFullCheckpointContents>

Get a “full” checkpoint for purposes of state-sync “full” checkpoints include: header, contents, transactions, effects. sequence_number is optional since we can always query it using the digest. However if it is provided, we can avoid an extra db lookup.

fn get_unchanged_loaded_runtime_objects( &self, digest: &TransactionDigest, ) -> Option<Vec<ObjectKey>>

fn multi_get_unchanged_loaded_runtime_objects( &self, digests: &[TransactionDigest], ) -> Vec<Option<Vec<ObjectKey>>>

fn get_transaction_checkpoint( &self, digest: &TransactionDigest, ) -> Option<CheckpointSequenceNumber>

fn get_latest_checkpoint_sequence_number(&self) -> Result<u64, Error>

Get the latest available checkpoint sequence number. This is the sequence number of the latest executed checkpoint.

fn get_latest_epoch_id(&self) -> Result<u64, Error>

Get the epoch of the latest checkpoint

fn get_checkpoint_data( &self, checkpoint: VerifiedEnvelope<CheckpointSummary, AuthorityQuorumSignInfo<true>>, checkpoint_contents: CheckpointContents, ) -> Result<Checkpoint, Error>

impl RpcIndexes for RpcStoreReadStore

fn get_epoch_info(&self, epoch: EpochId) -> Result<Option<EpochInfo>>

fn owned_objects_iter( &self, owner: SuiAddress, object_type: Option<StructTag>, cursor: Option<OwnedObjectInfo>, ) -> Result<Box<dyn Iterator<Item = Result<OwnedObjectInfo, TypedStoreError>> + '_>>

fn dynamic_field_iter( &self, parent: ObjectID, cursor: Option<DynamicFieldKey>, ) -> Result<Box<dyn Iterator<Item = Result<DynamicFieldKey, TypedStoreError>> + '_>>

Iterate the dynamic fields owned by parent. Dynamic-field objects live in the same owned-object index as address-owned objects (under the object-owner key, sorted by (type, object id)), so the DynamicFieldKey cursor carries the field’s type alongside its id – the full sort position – letting the scan seek straight to it, as in owned_objects_iter.

fn get_coin_info(&self, coin_type: &StructTag) -> Result<Option<CoinInfo>>

fn get_balance( &self, owner: &SuiAddress, coin_type: &StructTag, ) -> Result<Option<BalanceInfo>>

fn balance_iter( &self, owner: &SuiAddress, cursor: Option<(SuiAddress, StructTag)>, ) -> Result<BalanceIterator<'_>>

fn package_versions_iter( &self, original_id: ObjectID, cursor: Option<u64>, ) -> Result<Box<dyn Iterator<Item = Result<(u64, ObjectID), TypedStoreError>> + '_>>

fn get_highest_indexed_checkpoint_seq_number( &self, ) -> Result<Option<CheckpointSequenceNumber>>

fn get_highest_live_indexed_checkpoint_seq_number( &self, ) -> Result<Option<CheckpointSequenceNumber>>

The highest checkpoint the live-object cohort – the indexes derivable from the live object set (owned objects, types, and balances) – has committed, or None if it has not committed any checkpoint yet.

fn ledger_tx_seq_digest(&self, tx_seq: u64) -> Result<Option<LedgerTxSeqDigest>>

fn ledger_tx_seq_digest_multi_get( &self, tx_seqs: &[u64], ) -> Result<Vec<Option<LedgerTxSeqDigest>>>

fn ledger_tx_seq_digest_iter( &self, start: u64, end_exclusive: u64, descending: bool, ) -> Result<LedgerTxSeqDigestIterator<'_>>

fn transaction_bitmap_bucket_iter( &self, dimension_key: Vec<u8>, start_bucket: u64, end_bucket_exclusive: u64, descending: bool, ) -> Result<LedgerBitmapBucketIterator<'_>>

fn event_bitmap_bucket_iter( &self, dimension_key: Vec<u8>, start_bucket: u64, end_bucket_exclusive: u64, descending: bool, ) -> Result<LedgerBitmapBucketIterator<'_>>

impl RpcStateReader for RpcStoreReadStore

fn get_lowest_available_checkpoint_objects( &self, ) -> Result<CheckpointSequenceNumber>

Lowest available checkpoint for which object data can be requested.

fn get_chain_identifier(&self) -> Result<ChainIdentifier>

fn indexes(&self) -> Option<&dyn RpcIndexes>

fn get_highest_executed_checkpoint_seq_number( &self, ) -> Result<CheckpointSequenceNumber>

The sequence number of the highest executed checkpoint, independent of how far any embedded index has caught up.

fn get_struct_layout_with_overlay( &self, struct_tag: &StructTag, overlay: &ObjectSet, ) -> Result<Option<MoveTypeLayout>>

fn get_type_layout( &self, type_tag: &TypeTag, ) -> Result<Option<MoveTypeLayout>, Error>

fn get_struct_layout( &self, struct_tag: &StructTag, ) -> Result<Option<MoveTypeLayout>, Error>

impl RuntimeObjectResolver for RpcStoreReadStore

fn read_child_object( &self, parent: &ObjectID, child: &ObjectID, child_version_upper_bound: SequenceNumber, ) -> SuiResult<Option<Object>>

child must have an ObjectOwner ownership equal to owner.

fn get_object_received_at_version( &self, _owner: &ObjectID, _receiving_object_id: &ObjectID, _receive_object_at_version: SequenceNumber, _epoch_id: EpochId, ) -> SuiResult<Option<Object>>

receiving_object_id must have an AddressOwner ownership equal to owner. get_object_received_at_version must be the exact version at which the object will be received, and it cannot have been previously received at that version. NB: An object not existing at that version, and not having valid access to the object will be treated exactly the same and Ok(None) must be returned.

fn get_package_at_version( &self, package_id: &ObjectID, package_version: SequenceNumber, ) -> Option<MovePackage>

Get’s the package at the given version. Returns Some(package) only if the package_id is a MovePackage with the given package_version. Returns None in all other cases.