Struct StateDB

pub struct StateDB { /* private fields */ }

A typed wrapper around the db for storing rollup state. Internally, this is roughly just an Arc<SchemaDB>.

StateDB implements several convenience functions for state storage - notably the TreeReader and TreeWriter traits.

Implementations

impl StateDB

pub fn with_path(path: impl AsRef<Path>) -> Result<Self, Error>

Open a StateDB (backed by RocksDB) at the specified path. The returned instance will be at the path {path}/state-db.

pub fn put_preimage( &self, key_hash: KeyHash, key: &Vec<u8>, ) -> Result<(), Error>

Put the preimage of a hashed key into the database. Note that the preimage is not checked for correctness, since the DB is unaware of the hash function used by the JMT.

pub fn get_value_option_by_key( &self, version: Version, key: &Vec<u8>, ) -> Result<Option<OwnedValue>>

Get an optional value from the database, given a version and a key hash.

pub fn inc_next_version(&self)

Increment the next_version counter by 1.

pub fn get_next_version(&self) -> Version

Get the current value of the next_version counter

Trait Implementations

impl Clone for StateDB

fn clone(&self) -> StateDB

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateDB

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

Formats the value using the given formatter.

impl TreeReader for StateDB

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.

fn get_value_option( &self, 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.

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.

impl TreeWriter for StateDB

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

Writes a node batch into storage.