Struct darkfi::blockchain::header_store::HeaderStore

pub struct HeaderStore {
    pub main: Tree,
    pub sync: Tree,
}

The HeaderStore is a structure representing all sled trees related to storing the blockchain’s blocks’s header information.

Fields

main: Tree

Main sled tree, storing all the blockchain’s blocks’ headers, where the key is the headers’ hash, and value is the serialized header.

sync: Tree

The sled tree storing all the node pending headers while syncing, where the key is the height number, and the value is the serialized header.

Implementations

impl HeaderStore

pub fn new(db: &Db) -> Result<Self>

Opens a new or existing HeaderStore on the given sled database.

pub fn insert(&self, headers: &[Header]) -> Result<Vec<HeaderHash>>

Insert a slice of Header into the store’s main tree.

pub fn insert_sync(&self, headers: &[Header]) -> Result<()>

Insert a slice of Header into the store’s sync tree.

pub fn insert_batch(&self, headers: &[Header]) -> (Batch, Vec<HeaderHash>)

Generate the sled batch corresponding to an insert to the main tree, so caller can handle the write operation. The header’s hash() function output is used as the key, while value is the serialized Header itself. On success, the function returns the header hashes in the same order, along with the corresponding operation batch.

pub fn insert_batch_sync(&self, headers: &[Header]) -> Batch

Generate the sled batch corresponding to an insert to the sync tree, so caller can handle the write operation. The header height is used as the key, while value is the serialized Header itself.

pub fn contains(&self, headerhash: &HeaderHash) -> Result<bool>

Check if the store’s main tree contains a given header hash.

pub fn get( &self, headerhashes: &[HeaderHash], strict: bool, ) -> Result<Vec<Option<Header>>>

Fetch given header hashes from the store’s main tree. The resulting vector contains Option, which is Some if the header was found in the store’s main tree, and otherwise it is None, if it has not. The second parameter is a boolean which tells the function to fail in case at least one header was not found.

pub fn get_all(&self) -> Result<Vec<(HeaderHash, Header)>>

Retrieve all headers from the store’s main tree in the form of a tuple (headerhash, header). Be careful as this will try to load everything in memory.

pub fn get_all_sync(&self) -> Result<Vec<(u32, Header)>>

Retrieve all headers from the store’s sync tree in the form of a tuple (height, header). Be careful as this will try to load everything in memory.

pub fn get_first_sync(&self) -> Result<Option<Header>>

Fetch the fisrt header in the store’s sync tree, based on the Ord implementation for Vec<u8>.

pub fn get_last_sync(&self) -> Result<Option<Header>>

Fetch the last header in the store’s sync tree, based on the Ord implementation for Vec<u8>.

pub fn get_after_sync(&self, height: u32, n: usize) -> Result<Vec<Header>>

Fetch n hashes after given height. In the iteration, if a header height is not found, the iteration stops and the function returns what it has found so far in the store’s sync tree.

pub fn len_sync(&self) -> usize

Retrieve store’s sync tree records count.

pub fn is_empty_sync(&self) -> bool

Check if store’s sync tree contains any records.

pub fn remove_sync(&self, heights: &[u32]) -> Result<()>

Remove a slice of u32 from the store’s sync tree.

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

Remove all records from the store’s sync tree.

pub fn remove_batch_sync(&self, heights: &[u32]) -> Batch

Generate the sled batch corresponding to a remove from the store’s sync tree, so caller can handle the write operation.

Trait Implementations

impl Clone for HeaderStore

fn clone(&self) -> HeaderStore

Returns a copy of the value.

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

Performs copy-assignment from source.