Struct clarity_repl::clarity::clarity::ClarityInstance

pub struct ClarityInstance { /* fields omitted */ }

A high-level interface for interacting with the Clarity VM.

ClarityInstance takes ownership of a MARF + Sqlite store used for it’s data operations. The ClarityInstance defines a begin_block(bhh, bhh, bhh) -> ClarityBlockConnection function. ClarityBlockConnections are used for executing transactions within the context of a single block. Only one ClarityBlockConnection may be open at a time (enforced by the borrow checker) and ClarityBlockConnections must be commit_blocked or rollback_blocked before discarding begining the next connection (enforced by runtime panics).

Implementations

impl ClarityInstance

pub fn new(
    mainnet: bool,
    datastore: Datastore,
    block_limit: ExecutionCost
) -> ClarityInstance

pub fn begin_block<'a>(
    &'a mut self,
    current: &StacksBlockId,
    next: &StacksBlockId,
    header_db: &'a dyn HeadersDB
) -> ClarityBlockConnection<'a>

pub fn read_only_connection<'a>(
    &'a mut self,
    at_block: &StacksBlockId,
    header_db: &'a dyn HeadersDB
) -> ClarityReadOnlyConnection<'a>

pub fn eval_read_only(
    &mut self,
    at_block: &StacksBlockId,
    header_db: &dyn HeadersDB,
    contract: &QualifiedContractIdentifier,
    program: &str
) -> Result<Value, Error>

pub fn destroy(self) -> Datastore