Skip to main content

RocksDbStore

Struct RocksDbStore 

Source
pub struct RocksDbStore {
    db: DB,
}
Expand description

RocksDB-backed JMT store with bounded memory usage.

Three column families:

  • jmt_nodes: borsh(NodeKey) -> borsh(Node)
  • jmt_values: key_hash(32) || version(8 BE) -> raw value bytes (empty = tombstone)
  • jmt_stale: stale_since_version(8 BE) || borsh(NodeKey) -> ()

The values CF key layout enables seek_for_prev to efficiently find the latest value at or before a given version for a key hash.

Fields§

§db: DB

Implementations§

Source§

impl RocksDbStore

Source

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Source

pub fn write_tree_update_batch(&self, update: TreeUpdateBatch) -> Result<()>

Write a full TreeUpdateBatch atomically (nodes + values + stale indices).

Source

pub fn prune(&self, up_to_version: Version) -> Result<(usize, usize)>

Prune stale nodes up to (inclusive) the given version.

Value pruning is disabled by default until checkpoint compaction is implemented. A dormant key can have its latest live value at an old version, so deleting values by version alone can make the latest root impossible to prove. The non-default prune-values feature keeps the old experimental behavior available for research and benchmarks. Returns (nodes_pruned, values_pruned).

Source

fn prune_stale_nodes(&self, up_to_version: Version) -> Result<usize>

Source

fn prune_values(&self, up_to_version: Version) -> Result<usize>

Source

pub fn num_nodes(&self) -> Result<usize>

Source

pub fn num_values(&self) -> Result<usize>

Source

pub fn is_empty(&self) -> Result<bool>

Source

pub fn copy_latest_root_to_version(&self, to_version: Version) -> Result<bool>

Copy a JMT root node to a later version without changing tree contents.

JMT itself only writes a root node when a tree has updates. Runtime batches can still inherit an unchanged root, so checkpointing the root at the accepted version keeps exact-version startup verification cheap.

Source

pub fn latest_root_version(&self) -> Result<Option<Version>>

Source

fn latest_root_metadata(&self) -> Result<Option<(Version, Vec<u8>)>>

Source

pub fn compact_all(&self) -> Result<()>

Compact all commitment-store column families.

This rewrites RocksDB’s LSM files after pruning or large batch runs so deleted stale-node keys stop occupying disk. It does not change logical JMT contents or versioned values.

Source

fn count_cf(&self, cf_name: &str) -> Result<usize>

Trait Implementations§

Source§

impl TreeReader for RocksDbStore

Source§

fn get_node_option(&self, node_key: &NodeKey) -> Result<Option<Node>>

Gets node given a node key. Returns None if the node does not exist.
Source§

fn get_value_option( &self, max_version: Version, key_hash: KeyHash, ) -> Result<Option<OwnedValue>>

Gets a value by identifier, returning the newest value whose version is less than or equal to the specified version. Returns None if the value does not exist.
Source§

fn get_rightmost_leaf(&self) -> Result<Option<(NodeKey, LeafNode)>>

Gets the rightmost leaf. Note that this assumes we are in the process of restoring the tree and all nodes are at the same version.
§

fn get_node(&self, node_key: &NodeKey) -> Result<Node, Error>

Gets node given a node key. Returns error if the node does not exist.
§

fn get_value( &self, max_version: u64, key_hash: KeyHash, ) -> Result<Vec<u8>, Error>

Gets a value by identifier, returning the newest value whose version is less than or equal to the specified version. Returns an error if the value does not exist.
Source§

impl TreeWriter for RocksDbStore

Source§

fn write_node_batch(&self, node_batch: &NodeBatch) -> Result<()>

Writes a node batch into storage.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more