Struct Blockchain 

pub struct Blockchain {
    pub sled_db: Db,
    pub headers: HeaderStore,
    pub blocks: BlockStore,
    pub transactions: TxStore,
    pub contracts: ContractStore,
}

Structure holding all sled trees that define the concept of Blockchain.

Fields

sled_db: Db

Main pointer to the sled db connection

headers: HeaderStore

Headers sled tree

blocks: BlockStore

Blocks sled tree

transactions: TxStore

Transactions related sled trees

contracts: ContractStore

Contracts related sled trees

Implementations

impl Blockchain

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

Instantiate a new Blockchain with the given sled database.

pub fn add_block(&self, block: &BlockInfo) -> Result<HeaderHash>

Insert a given BlockInfo into the blockchain database. This functions wraps all the logic of separating the block into specific data that can be fed into the different trees of the database. Upon success, the functions returns the block hash that were given and appended to the ledger.

pub fn has_block(&self, block: &BlockInfo) -> Result<bool>

Check if the given BlockInfo is in the database and all trees.

pub fn get_blocks_by_hash( &self, hashes: &[HeaderHash], ) -> Result<Vec<BlockInfo>>

Retrieve BlockInfos by given hashes. Fails if any of them is not found.

fn get_blocks_infos(&self, blocks: &[Block]) -> Result<Vec<BlockInfo>>

Retrieve all BlockInfo for given slice of Block. Fails if any of them is not found

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

Retrieve BlockInfos by given heights. Does not fail if any of them are not found.

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

Retrieve Headers by given hashes. Fails if any of them is not found.

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

Retrieve Headers by given heights. Fails if any of them is not found.

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

Retrieve n headers before given block height.

pub fn len(&self) -> usize

Retrieve stored blocks count

pub fn txs_len(&self) -> usize

Retrieve stored txs count

pub fn is_empty(&self) -> bool

Check if blockchain contains any blocks

pub fn genesis(&self) -> Result<(u32, HeaderHash)>

Retrieve genesis (first) block height and hash.

pub fn genesis_block(&self) -> Result<BlockInfo>

Retrieve genesis (first) block info.

pub fn last(&self) -> Result<(u32, HeaderHash)>

Retrieve the last block height and hash.

pub fn last_header(&self) -> Result<Header>

Retrieve the last block header.

pub fn last_block(&self) -> Result<BlockInfo>

Retrieve the last block info.

pub fn last_block_difficulty(&self) -> Result<BlockDifficulty>

Retrieve the last block difficulty. If the tree is empty, returns BlockDifficulty::genesis difficulty.

pub fn has_height(&self, height: u32) -> Result<bool>

Check if block order for the given height is in the database.

pub fn add_pending_txs( &self, txs: &[Transaction], ) -> Result<Vec<TransactionHash>>

Insert a given slice of pending transactions into the blockchain database. On success, the function returns the transaction hashes in the same order as the input transactions.

pub fn get_pending_txs(&self) -> Result<Vec<Transaction>>

Retrieve all transactions from the pending tx store. Be careful as this will try to load everything in memory.

pub fn remove_pending_txs(&self, txs: &[Transaction]) -> Result<()>

Remove a given slice of pending transactions from the blockchain database.

pub fn remove_pending_txs_hashes(&self, txs: &[TransactionHash]) -> Result<()>

Remove a given slice of pending transactions hashes from the blockchain database.

fn atomic_write(&self, trees: &[Tree], batches: &[Batch]) -> Result<()>

Auxiliary function to write to multiple trees completely atomic.

pub fn get_all(&self) -> Result<Vec<BlockInfo>>

Retrieve all blocks contained in the blockchain in order. Be careful as this will try to load everything in memory.

pub fn get_by_range(&self, start: u32, end: u32) -> Result<Vec<BlockInfo>>

Retrieve BlockInfos by given heights range.

pub fn get_last_n(&self, n: usize) -> Result<Vec<BlockInfo>>

Retrieve last ‘N’ BlockInfos from the blockchain.

pub fn reset_to_height(&self, height: u32) -> Result<()>

Auxiliary function to reset the blockchain and consensus state to the provided block height.

pub fn get_state_monotree(&self) -> Result<Monotree<MemoryDb>>

Generate a Monotree(SMT) containing all contracts states roots, along with the wasm bincodes monotree root.

Note: native contracts zkas tree and wasm bincodes are excluded.

pub fn get_randomx_vm_keys( &self, key_change_height: &u32, key_change_delay: &u32, height: Option<u32>, ) -> Result<(HeaderHash, HeaderHash)>

Grab the RandomX VM current and next key, based on provided key changing height and delay. Optionally, a height can be provided to get the keys before it.

NOTE: the height calculation logic is verified using test:

Trait Implementations

impl Clone for Blockchain

fn clone(&self) -> Blockchain

Returns a duplicate of the value.

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

Performs copy-assignment from source.