Struct cnidarium::Snapshot

pub struct Snapshot(/* private fields */);

A snapshot of the underlying storage at a specific state version, suitable for read-only access by multiple threads, e.g., RPC calls.

Snapshots are cheap to create and clone. Internally, they’re implemented as a wrapper around a RocksDB snapshot with a pinned JMT version number for the snapshot.

Implementations

impl Snapshot

pub fn version(&self) -> Version

pub async fn get_with_proof( &self, key: Vec<u8> ) -> Result<(Option<Vec<u8>>, MerkleProof)>

Returns some value corresponding to the key, along with an ICS23 existence proof up to the current JMT root hash. If the key is not present, returns None and a non-existence proof.

pub fn prefix_version(&self, prefix: &str) -> Result<Option<Version>>

pub async fn prefix_root_hash(&self, prefix: &str) -> Result<RootHash>

Returns the root hash of the subtree corresponding to the given prefix. If the prefix is empty, the root hash of the main tree is returned.

Errors

Returns an error if the supplied prefix does not correspond to a known substore.

pub async fn root_hash(&self) -> Result<RootHash>

Trait Implementations

impl Clone for Snapshot

fn clone(&self) -> Snapshot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Snapshot

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl StateRead for Snapshot

fn get_raw(&self, key: &str) -> Self::GetRawFut

Fetch a key from the JMT.

fn nonverifiable_get_raw(&self, key: &[u8]) -> Self::GetRawFut

Fetch a key from nonverifiable storage.

fn prefix_raw(&self, prefix: &str) -> Self::PrefixRawStream

Returns a stream of all key-value pairs with the given prefix.

fn nonverifiable_prefix_raw( &self, prefix: &[u8] ) -> Self::NonconsensusPrefixRawStream

Returns a stream of all key-value pairs with the given prefix, from nonverifiable storage.

fn nonverifiable_range_raw( &self, prefix: Option<&[u8]>, range: impl RangeBounds<Vec<u8>> ) -> Result<Self::NonconsensusRangeRawStream>

Returns a stream of all key-value pairs with the given prefix, and range from nonverifiable storage. TODO(erwan): For now this method only supports range queries over the main store.

type GetRawFut = SnapshotFuture

type PrefixRawStream = ReceiverStream<Result<(String, Vec<u8>), Error>>

type PrefixKeysStream = ReceiverStream<Result<String, Error>>

type NonconsensusPrefixRawStream = ReceiverStream<Result<(Vec<u8>, Vec<u8>), Error>>

type NonconsensusRangeRawStream = ReceiverStream<Result<(Vec<u8>, Vec<u8>), Error>>

fn prefix_keys(&self, prefix: &str) -> Self::PrefixKeysStream

Retrieve all keys (but not values) matching a prefix from the verifiable key-value store.

fn object_get<T: Any + Send + Sync + Clone>(&self, _key: &str) -> Option<T>

Gets an object from the ephemeral key-object store.

fn object_type(&self, _key: &str) -> Option<TypeId>

Gets the [TypeId] of the object stored at key in the ephemeral key-object store, if any is present.