Struct KvChainStore

pub struct KvChainStore<'a> { /* private fields */ }

Available on crate feature kv-chainstore only.

As for now we use a KV (key/value) database to store the chain data. This struct provides a way to interact with the chain data stored in the KV store. It uses buckets to store and retrieve data concerning headers, indexes, and metadata.

It temporarily caches headers and indexes using a HashMap, which are later persisted.

Implementations

impl<'a> KvChainStore<'a>

pub fn new(datadir: String) -> Result<KvChainStore<'a>, Error>

Creates a new KvChainStore instance in the specified directory path.

Trait Implementations

impl ChainStore for KvChainStore<'_>

fn check_integrity(&self) -> Result<(), Self::Error>

For this ChainStore, since sled already checks integrity implicitly, this is a no-op.

fn load_roots_for_block( &mut self, height: u32, ) -> Result<Option<Vec<u8>>, Self::Error>

Loads the utreexo roots for a given block.

fn save_roots_for_block( &mut self, roots: Vec<u8>, height: u32, ) -> Result<(), Self::Error>

Saves the utreexo roots for a given block.

fn load_height(&self) -> Result<Option<BestChain>, Self::Error>

Loads the best chain data from the metadata bucket.

fn save_height(&mut self, height: &BestChain) -> Result<(), Self::Error>

Saves the best chain data to the metadata bucket.

fn get_header( &self, block_hash: &BlockHash, ) -> Result<Option<DiskBlockHeader>, Self::Error>

Gets the block header using the provided block hash. If it is on cache, it returns it directly, otherwise it fetches it from the database.

fn flush(&mut self) -> Result<(), Self::Error>

Flushes the cache to the database.

fn save_header(&mut self, header: &DiskBlockHeader) -> Result<(), Self::Error>

Saves a header to the database.

fn get_block_hash(&self, height: u32) -> Result<Option<BlockHash>, Self::Error>

Gets a block hash from the database using the provided height. If it’s not found in the cache, it will be fetched from the database.

fn update_block_index( &mut self, height: u32, hash: BlockHash, ) -> Result<(), Self::Error>

Updates the block index with the provided height and hash.

type Error = Error

fn get_header_by_height( &self, height: u32, ) -> Result<Option<DiskBlockHeader>, Self::Error>

Get a block header by its height in our database.