Struct RpcStoreReader 

pub struct RpcStoreReader<R: Reader = Db> { /* private fields */ }

Adapter exposing RpcStoreSchema through the sui-rpc-api reader-trait stack.

Construct one of two ways:

• RpcStoreReader::new binds to tip reads (R = Db). Use this for callers that want the latest committed state.
• RpcStoreReader::at_snapshot takes a captured [Snapshot] and returns a RpcStoreReader<Snapshot> whose every read returns the state at that snapshot. Use this for “show me state at checkpoint X” requests.

RpcStoreReader holds an Arc<RpcStoreSchema<R>> so trait impls can hand a &self to any of the inherent read helpers already defined on the schema. The wrapper itself is Clone (cheap, Arc-backed) so it can be handed to sui-rpc-api::StateReader::new(Arc::new(reader)).

Implementations

impl<R: Reader + Send + Sync> RpcStoreReader<R>

pub fn resolve_struct_layout( &self, struct_tag: &StructTag, overlay: &ObjectSet, ) -> StorageResult<Option<MoveTypeLayout>>

Resolve the [MoveTypeLayout] for a given [StructTag], optionally seeded with extra objects in overlay.

Returns Ok(None) when the store doesn’t have enough context to build an executor (no checkpoints observed yet, no chain id recorded). Surfaces resolver failures as StorageError::custom.

impl<R: Reader> RpcStoreReader<R>

pub fn new(db: Db, schema: Arc<RpcStoreSchema<R>>) -> Self

Bind the adapter to an existing RpcStoreSchema.

db must be the same [Db] the schema was opened against. Holding both separately is cheap (each is Arc-backed) and avoids a schema.epochs.reader().db() style detour inside hot read paths.

pub fn db(&self) -> &Db

Borrow the underlying [Db] handle. Used by trait impls that read directly from the framework CFs (chain id, pipeline watermarks) rather than going through the typed user schema.

pub fn schema(&self) -> &RpcStoreSchema<R>

Borrow the typed schema this adapter is bound to. Trait impls reach through this to call any of the inherent read helpers RpcStoreSchema exposes per-CF.

impl RpcStoreReader<Db>

pub fn at_snapshot(&self, snap: &Snapshot) -> RpcStoreReader<Snapshot>

Re-project this reader against a captured [Snapshot].

The returned RpcStoreReader<Snapshot> reads every CF through the snapshot’s ReadOptions, so reads are consistent with the point in time at which the snapshot was taken (rather than the tip). The original tip reader is unaffected.

Trait Implementations

impl<R: Reader + Send + Sync> ChildObjectResolver for RpcStoreReader<R>

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.

impl<R: Reader> Clone for RpcStoreReader<R>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: Reader + Send + Sync> ObjectStore for RpcStoreReader<R>

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

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

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

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

impl<R: Reader + Send + Sync> ReadStore for RpcStoreReader<R>

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

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

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

fn get_highest_verified_checkpoint(&self) -> StorageResult<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) -> StorageResult<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, ) -> StorageResult<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 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, tx_digest: &TransactionDigest, ) -> Option<Arc<VerifiedTransaction>>

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

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

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

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

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_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 multi_get_transactions( &self, tx_digests: &[TransactionDigest], ) -> Vec<Option<Arc<VerifiedEnvelope<SenderSignedData, EmptySignInfo>>>>

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

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

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

impl<R: Reader + Send + Sync> RpcIndexes for RpcStoreReader<R>

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<R: Reader + Send + Sync> RpcStateReader for RpcStoreReader<R>

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

Lowest available checkpoint for which object data can be requested.

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

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

fn get_struct_layout_with_overlay( &self, struct_tag: &StructTag, overlay: &ObjectSet, ) -> StorageResult<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>