Struct RpcIndexStore 

pub struct RpcIndexStore { /* private fields */ }

Implementations

impl RpcIndexStore

pub async fn new( dir: &Path, authority_store: &AuthorityStore, checkpoint_store: &CheckpointStore, epoch_store: &AuthorityPerEpochStore, package_store: &Arc<dyn BackingPackageStore + Send + Sync>, rpc_config: RpcConfig, ) -> Self

pub async fn new_with_options( dir: &Path, authority_store: &AuthorityStore, checkpoint_store: &CheckpointStore, epoch_store: &AuthorityPerEpochStore, package_store: &Arc<dyn BackingPackageStore + Send + Sync>, index_options: IndexStoreOptions, rpc_config: RpcConfig, ) -> Self

pub fn new_without_init(dir: &Path) -> Self

pub fn prune( &self, pruned_checkpoint_watermark: u64, pruned_tx_seq_exclusive: u64, ) -> Result<(), TypedStoreError>

pub fn index_checkpoint(&self, checkpoint: &Checkpoint)

Index a checkpoint and stage the index updated in pending_updates.

Updates will not be committed to the database until commit_update_for_checkpoint is called.

pub fn commit_update_for_checkpoint( &self, checkpoint: u64, ) -> Result<(), StorageError>

Commits the pending updates for the provided checkpoint number.

Invariants:

• index_checkpoint must have been called for the provided checkpoint
• Callers of this function must ensure that it is called for each checkpoint in sequential order. This will panic if the provided checkpoint does not match the expected next checkpoint to commit.

Forward updates are gated on Watermark::Indexed, the source of truth for index coverage: only the next contiguous checkpoint (watermark + 1, or 0 when nothing is indexed yet) is written, and its batch advances the watermark. A checkpoint at or below the watermark is already reflected in the index, so its batch is dropped rather than re-applied – this is what prevents double-counting after a bulk restore. The restore stamps the watermark at the checkpoint the live object set reflects (highest_committed), but the checkpoint executor resumes from the separately-bumped highest_executed, which can lag; without this drop it would re-apply the (highest_executed, highest_committed] checkpoints the restore already captured, double-counting additive indexes like balances. A checkpoint above watermark + 1 is a gap that would leave a hole in the index, so it panics.

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

pub fn owner_iter( &self, owner: SuiAddress, object_type: Option<StructTag>, cursor: Option<OwnerIndexKey>, ) -> Result<impl Iterator<Item = Result<(OwnerIndexKey, OwnerIndexInfo), TypedStoreError>> + '_, TypedStoreError>

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

pub fn get_coin_info( &self, coin_type: &StructTag, ) -> Result<Option<CoinIndexInfo>, TypedStoreError>

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

pub fn balance_iter( &self, owner: SuiAddress, cursor: Option<BalanceKey>, ) -> Result<impl Iterator<Item = Result<(BalanceKey, BalanceIndexInfo), TypedStoreError>> + '_, TypedStoreError>

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

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

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

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

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

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

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