Struct cnidarium::Storage

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

A handle for a storage instance, backed by RocksDB.

The handle is cheaply clonable; all clones share the same backing data store.

Implementations

impl Storage

pub async fn load(path: PathBuf, default_prefixes: Vec<String>) -> Result<Self>

Loads a storage instance from the given path, initializing it if necessary.

pub async fn init(path: PathBuf, prefixes: Vec<String>) -> Result<Self>

Initializes a new storage instance at the given path. Takes a list of default prefixes to initialize the storage configuration with. Here is a high-level overview of the initialization process:

1. Create a new RocksDB instance at the given path.
2. Read the prefix list and create a [SubstoreConfig] for each prefix.
3. Create a new [MultistoreConfig] from supplied prefixes.
4. Initialize the substore cache with the latest version of each substore.
5. Spawn a dispatcher task that forwards new snapshots to subscribers.

pub fn latest_version(&self) -> Version

Returns the latest version (block height) of the tree recorded by the Storage.

If the tree is empty and has not been initialized, returns u64::MAX.

pub fn subscribe(&self) -> Receiver<Snapshot>

Returns a [watch::Receiver] that can be used to subscribe to new state versions.

pub fn subscribe_changes(&self) -> Receiver<(Version, Arc<Cache>)>

Returns a [watch::Receiver] that can be used to subscribe to state changes.

pub fn latest_snapshot(&self) -> Snapshot

Returns a new Snapshot on top of the latest version of the tree.

pub fn snapshot(&self, version: Version) -> Option<Snapshot>

Fetches the Snapshot corresponding to the supplied jmt::Version from the [SnapshotCache]. Returns None if no match was found.

pub async fn prepare_commit( &self, delta: StateDelta<Snapshot> ) -> Result<StagedWriteBatch>

Prepares a commit for the provided StateDelta, returning a StagedWriteBatch. The batch can be committed to the database using the Storage::commit_batch method.

pub async fn commit(&self, delta: StateDelta<Snapshot>) -> Result<RootHash>

Commits the provided StateDelta to persistent storage as the latest version of the chain state.

pub fn commit_batch(&self, batch: StagedWriteBatch) -> Result<RootHash>

Commits the supplied StagedWriteBatch to persistent storage.

Migrations

In the case of chain state migrations we need to commit the new state without incrementing the version. If perform_migration is true the snapshot will not be written to the snapshot cache, and no subscribers will be notified. Substore versions will not be updated.

pub async fn commit_in_place( &self, delta: StateDelta<Snapshot> ) -> Result<RootHash>

Available on crate feature migration only.

Commit the provided StateDelta to persistent storage without increasing the version of the chain state, and skips the snapshot cache update.

pub async fn release(self)

Shuts down the database and the dispatcher task, and waits for all resources to be reclaimed. Panics if there are still outstanding references to the Inner storage.

Trait Implementations

impl AsRef<Storage> for TempStorage

fn as_ref(&self) -> &Storage

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Storage

fn clone(&self) -> Storage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Storage

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

Formats the value using the given formatter.