Struct clarity_repl::repl::datastore::Datastore

pub struct Datastore { /* private fields */ }

Implementations

impl Datastore

pub fn new() -> Self

pub fn advance_chain_tip(&mut self, count: u32) -> u32

impl Datastore

pub fn open( path_str: &str, miner_tip: Option<&StacksBlockId> ) -> Result<Datastore>

pub fn as_analysis_db(&mut self) -> AnalysisDatabase<'_>

pub fn begin(&mut self, current: &StacksBlockId, next: &StacksBlockId)

begin, commit, rollback a save point identified by key this is used to clean up any data from aborted blocks (NOT aborted transactions that is handled by the clarity vm directly). The block header hash is used for identifying savepoints. this cannot be used to rollback to arbitrary prior block hash, because that blockhash would already have committed and no longer exist in the save point stack. this is a “lower-level” rollback than the roll backs performed in ClarityDatabase or AnalysisDatabase – this is done at the backing store level.

pub fn rollback(&mut self)

pub fn commit_mined_block(&mut self, will_move_to: &StacksBlockId)

pub fn commit_to(&mut self, final_bhh: &StacksBlockId)

pub fn get_chain_tip(&self) -> &StacksBlockId

pub fn set_chain_tip(&mut self, bhh: &StacksBlockId)

pub fn put(&mut self, key: &str, value: &str)

pub fn make_contract_hash_key(contract: &QualifiedContractIdentifier) -> String

Trait Implementations

impl ClarityBackingStore for Datastore

fn get(&mut self, key: &str) -> Option<String>

fetch K-V out of the committed datastore

fn set_block_hash(&mut self, bhh: StacksBlockId) -> Result<StacksBlockId>

change the current MARF context to service reads from a different chain_tip used to implement time-shifted evaluation. returns the previous block header hash on success

fn get_current_block_height(&mut self) -> u32

this function returns the current block height, as viewed by this marfed-kv structure, i.e., it changes on time-shifted evaluation. the open_chain_tip functions always return data about the chain tip that is currently open for writing.

fn make_contract_commitment( &mut self, contract_hash: Sha512Trunc256Sum ) -> String

The contract commitment is the hash of the contract, plus the block height in which the contract was initialized.

fn put_all(&mut self, items: Vec<(String, String)>)

put K-V data into the committed datastore

fn has_entry(&mut self, key: &str) -> bool

fn get_block_at_height(&mut self, height: u32) -> Option<StacksBlockId>

Is None if block_height >= the “currently” under construction Stacks block height.

fn get_open_chain_tip_height(&mut self) -> u32

fn get_open_chain_tip(&mut self) -> StacksBlockId

fn insert_metadata( &mut self, contract: &QualifiedContractIdentifier, key: &str, value: &str )

fn get_metadata( &mut self, contract: &QualifiedContractIdentifier, key: &str ) -> Result<Option<String>>

fn get_with_proof(&mut self, key: &str) -> Option<(String, Vec<u8>)>

fetch K-V out of the committed datastore, along with the byte representation of the Merkle proof for that key-value pair

fn get_contract_hash( &mut self, _contract: &QualifiedContractIdentifier ) -> Result<(StacksBlockId, Sha512Trunc256Sum)>

This function is used to obtain a committed contract hash, and the block header hash of the block in which the contract was initialized. This data is used to store contract metadata in the side store.

fn get_metadata_manual( &mut self, _at_height: u32, _contract: &QualifiedContractIdentifier, _key: &str ) -> Result<Option<String>>

fn get_side_store(&mut self) -> &Connection

fn get_cc_special_cases_handler( &self ) -> Option<&'static dyn Fn(&mut GlobalContext<'_, '_>, Option<&PrincipalData>, Option<&PrincipalData>, &QualifiedContractIdentifier, &str, &[Value], &Value) -> Result<(), Error>>

fn put_all_metadata( &mut self, items: Vec<((QualifiedContractIdentifier, String), String)> )

impl Clone for Datastore

fn clone(&self) -> Datastore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Datastore

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

Formats the value using the given formatter.

impl Default for Datastore

fn default() -> Self

Returns the “default value” for a type.