Struct darkfi::blockchain::contract_store::ContractStore

pub struct ContractStore {
    pub wasm: Tree,
    pub state: Tree,
}

The ContractStore is a structure representing all sled trees related to storing the blockchain’s contracts information.

Fields

wasm: Tree

The sled tree storing the wasm bincode for deployed contracts. The layout looks like this:

 tree: "_wasm_bincode"
  key: ContractId
value: Vec<u8>

state: Tree

The sled tree storing the pointers to contracts’ databases. See the rustdoc for the impl functions for more info. The layout looks like this:

 tree: "_contracts"
  key: ContractId
value: Vec<blake3(ContractId || tree_name)>

These values get mutated with init() and remove().

Implementations

impl ContractStore

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

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

pub fn get(&self, contract_id: ContractId) -> Result<Vec<u8>>

Fetches the bincode for a given ContractId from the store’s wasm tree. Returns an error if the bincode is not found.

pub fn lookup( &self, db: &Db, contract_id: &ContractId, tree_name: &str, ) -> Result<Tree>

Do a lookup of an existing contract state. In order to succeed, the state must have been previously initialized with init(). If the state has been found, a handle to it will be returned. Otherwise, we return an error.

pub fn remove( &self, db: &Db, contract_id: &ContractId, tree_name: &str, ) -> Result<()>

Attempt to remove an existing contract state. In order to succeed, the state must have been previously initialized with init(). If the state has been found, its contents in the tree will be cleared, and the pointer will be removed from the main ContractStateStore. If anything is not found as initialized, an error is returned. NOTE: this function is not used right now, we keep it for future proofing, and its obviously untested.

pub fn get_zkas( &self, db: &Db, contract_id: &ContractId, zkas_ns: &str, ) -> Result<(ZkBinary, VerifyingKey)>

Abstraction function for fetching a ZkBinary and its respective VerifyingKey from a contract’s zkas sled tree.

pub fn get_all_wasm(&self) -> Result<Vec<(ContractId, Vec<u8>)>>

Retrieve all wasm bincodes from the store’s wasm tree in the form of a tuple (contract_id, bincode). Be careful as this will try to load everything in memory.

pub fn get_all_states(&self) -> Result<Vec<(ContractId, Vec<Hash>)>>

Retrieve all contract states from the store’s state tree in the form of a tuple (contract_id, state_hashes). Be careful as this will try to load everything in memory.

Trait Implementations

impl Clone for ContractStore

fn clone(&self) -> ContractStore

Returns a copy of the value.

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

Performs copy-assignment from source.