Struct BlockStore 

pub struct BlockStore { /* private fields */ }

Implementations

impl BlockStore

pub fn bootstrap( store_dir: PathBuf, genesis_block: &GenesisBlock, ) -> Result<Self>

Creates a new BlockStore, creating the directory, inserting the genesis block data and initializing the proven tip file.

This does not create any parent directories, so it is expected that the caller has already created these.

Errors

Uses std::fs::create_dir and therefore has the same error conditions.

pub fn load(store_dir: PathBuf) -> Result<Self>

Loads an existing BlockStore.

A new BlockStore can be created using BlockStore::bootstrap.

A best effort is made to ensure the directory exists and is accessible, but will still run afoul of TOCTOU issues as these are impossible to rule out.

Errors

Returns an error if:

• the directory does not exist, or
• the directory is not accessible, or
• it is not a directory, or
• its format marker is missing or invalid

See also: std::fs::metadata.

pub async fn load_block( &self, block_num: BlockNumber, ) -> Result<Option<Vec<u8>>>

pub async fn save_block( &self, block_num: BlockNumber, data: &[u8], ) -> Result<()>

pub fn save_block_blocking( &self, block_num: BlockNumber, data: &[u8], ) -> Result<()>

pub async fn load_proof( &self, block_num: BlockNumber, ) -> Result<Option<Vec<u8>>>

pub async fn save_proving_inputs( &self, block_num: BlockNumber, data: &[u8], ) -> Result<()>

pub async fn load_proving_inputs( &self, block_num: BlockNumber, ) -> Result<Option<Vec<u8>>>

pub async fn delete_proving_inputs(&self, block_num: BlockNumber) -> Result<()>

pub async fn commit_proof( &self, block_num: BlockNumber, proof: &[u8], ) -> Result<()>

Saves the proof, advances the proven tip, and deletes the proving inputs.

Must be called in strictly ascending BlockNumber order: the proven tip file records the highest consecutive proven block, so committing out of order would leave a gap.

pub fn load_proven_tip(&self) -> Result<BlockNumber>

Reads the proven tip from disk and returns it.

pub fn display(&self) -> Display<'_>

Trait Implementations

impl Clone for BlockStore

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockStore

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

Formats the value using the given formatter.