Struct Storage

pub struct Storage {
    db: ScannerDb,
}

Store key info and results of the scan.

rocksdb allows concurrent writes through a shared reference, so clones of the scanner storage represent the same database instance. When the final clone is dropped, the database is closed.

Fields

db: ScannerDb

The underlying database.

rocksdb allows reads and writes via a shared reference, so this database object can be freely cloned. The last instance that is dropped will close the underlying database.

Implementations

impl Storage

pub fn sapling_result_for_index( &self, index: &SaplingScannedDatabaseIndex, ) -> Option<SaplingScannedResult>

Returns the result for a specific database index (key, block height, transaction index). Returns None if the result is missing or an empty marker for a birthday or progress height.

pub fn sapling_results_for_key_and_height( &self, sapling_key: &SaplingScanningKey, height: Height, ) -> BTreeMap<TransactionIndex, Option<SaplingScannedResult>>

Returns the results for a specific key and block height.

pub fn sapling_results_for_key( &self, sapling_key: &SaplingScanningKey, ) -> BTreeMap<Height, Vec<SaplingScannedResult>>

Returns all the results for a specific key, indexed by height.

pub fn sapling_keys_and_last_scanned_heights( &self, ) -> HashMap<SaplingScanningKey, Height>

Returns all the keys and their last scanned heights.

fn sapling_results_in_range( &self, range: impl RangeBounds<SaplingScannedDatabaseIndex>, ) -> BTreeMap<SaplingScannedDatabaseIndex, Option<SaplingScannedResult>>

Returns the Sapling indexes and results in the supplied range.

Convenience method for accessing raw data with the correct types.

pub(crate) fn sapling_tx_ids_cf(&self) -> SaplingTxIdsCf<'_>

Returns a typed handle to the sapling_tx_ids column family.

pub fn insert_sapling_results( &mut self, sapling_key: &SaplingScanningKey, height: Height, sapling_results: BTreeMap<TransactionIndex, SaplingScannedResult>, )

Inserts a batch of scanned sapling result for a key and height. If a result already exists for that key, height, and index, it is replaced.

pub(crate) fn insert_sapling_key( &mut self, sapling_key: &SaplingScanningKey, birthday_height: Option<Height>, )

Insert a sapling scanning key, and mark all heights before birthday_height so they won’t be scanned.

If a result already exists for the coinbase transaction at the height before the birthday, it is replaced with an empty result. This can happen if the user increases the birthday height.

TODO: ignore incorrect changes to birthday heights

pub fn delete_sapling_keys(&mut self, keys: Vec<SaplingScanningKey>)

Delete the sapling keys and their results, if they exist,

pub(crate) fn delete_sapling_results(&mut self, keys: Vec<SaplingScanningKey>)

Delete the results of sapling scanning keys, if they exist

impl Storage

pub(crate) fn new_db( config: &Config, network: &Network, read_only: bool, ) -> Self

Opens and returns an on-disk scanner results database instance for config and network. If there is no existing database, creates a new database on disk.

New keys in config are not inserted into the database.

pub(crate) fn new_with_debug( config: &Config, network: &Network, debug_skip_format_upgrades: bool, read_only: bool, ) -> Self

Returns an on-disk database instance with the supplied production and debug settings. If there is no existing database, creates a new database on disk.

New keys in config are not inserted into the database.

This method is intended for use in tests.

pub fn network(&self) -> Network

Returns the configured network for this database.

pub fn path(&self) -> &Path

Returns the Path where the files used by this database are located.

pub fn database_format_version_in_code() -> Version

The database format version in the running scanner code.

pub fn check_for_panics(&mut self)

Check for panics in code running in spawned threads. If a thread exited with a panic, resume that panic.

This method should be called regularly, so that panics are detected as soon as possible.

pub fn is_empty(&self) -> bool

Returns true if the database is empty.

impl Storage

pub fn new(config: &Config, network: &Network, read_only: bool) -> Self

Opens and returns the on-disk scanner results storage for config and network. If there is no existing storage, creates a new storage on disk.

Birthdays and scanner progress are marked by inserting an empty result for that height.

Performance / Hangs

This method can block while creating or reading database files, so it must be inside spawn_blocking() in async code.

pub fn add_sapling_key( &mut self, sapling_key: &SaplingScanningKey, birthday: impl Into<Option<Height>>, )

Add a sapling key to the storage.

Performance / Hangs

This method can block while writing database files, so it must be inside spawn_blocking() in async code.

pub fn sapling_keys_last_heights(&self) -> HashMap<SaplingScanningKey, Height>

Returns all the keys and their last scanned heights.

Performance / Hangs

This method can block while reading database files, so it must be inside spawn_blocking() in async code.

pub fn add_sapling_results( &mut self, sapling_key: &SaplingScanningKey, height: Height, sapling_results: BTreeMap<TransactionIndex, SaplingScannedResult>, )

Add the sapling results for height to the storage. The results can be any map of TransactionIndex to SaplingScannedResult.

All the results for the same height must be written at the same time, to avoid partial writes during shutdown.

Also adds empty progress tracking entries every INSERT_CONTROL_INTERVAL blocks if needed.

Performance / Hangs

This method can block while writing database files, so it must be inside spawn_blocking() in async code.

pub fn sapling_results( &self, sapling_key: &SaplingScanningKey, ) -> BTreeMap<Height, Vec<SaplingScannedResult>>

Returns all the results for a sapling key, for every scanned block height.

Performance / Hangs

This method can block while reading database files, so it must be inside spawn_blocking() in async code.

Trait Implementations

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.