miden_tx/prover/
mast_store.rs

1use alloc::collections::BTreeMap;
2use alloc::sync::Arc;
3
4use miden_lib::transaction::TransactionKernel;
5use miden_lib::{MidenLib, StdLibrary};
6use miden_objects::Word;
7use miden_objects::account::AccountCode;
8use miden_objects::assembly::mast::MastForest;
9use miden_objects::utils::sync::RwLock;
10use miden_processor::MastForestStore;
11
12// TRANSACTION MAST STORE
13// ================================================================================================
14
15/// A store for the code available during transaction execution.
16///
17/// Transaction MAST store contains a map between procedure MAST roots and [MastForest]s containing
18/// MASTs for these procedures. The VM will request [MastForest]s from the store when it encounters
19/// a procedure which it doesn't have the code for. Thus, to execute a program which makes
20/// references to external procedures, the store must be loaded with [MastForest]s containing these
21/// procedures.
22pub struct TransactionMastStore {
23    mast_forests: RwLock<BTreeMap<Word, Arc<MastForest>>>,
24}
25
26#[allow(clippy::new_without_default)]
27impl TransactionMastStore {
28    /// Returns a new [TransactionMastStore] instantiated with the default libraries.
29    ///
30    /// The default libraries include:
31    /// - Miden standard library (miden-stdlib).
32    /// - Miden protocol library (miden-lib).
33    /// - Transaction kernel.
34    pub fn new() -> Self {
35        let mast_forests = RwLock::new(BTreeMap::new());
36        let store = Self { mast_forests };
37
38        // load transaction kernel MAST forest
39        let kernels_forest = TransactionKernel::kernel().mast_forest().clone();
40        store.insert(kernels_forest);
41
42        // load miden-stdlib MAST forest
43        let miden_stdlib_forest = StdLibrary::default().mast_forest().clone();
44        store.insert(miden_stdlib_forest);
45
46        // load miden lib MAST forest
47        let miden_lib_forest = MidenLib::default().mast_forest().clone();
48        store.insert(miden_lib_forest);
49
50        store
51    }
52
53    /// Registers all procedures of the provided [MastForest] with this store.
54    pub fn insert(&self, mast_forest: Arc<MastForest>) {
55        let mut mast_forests = self.mast_forests.write();
56
57        // only register procedures that are local to this forest
58        for proc_digest in mast_forest.local_procedure_digests() {
59            mast_forests.insert(proc_digest, mast_forest.clone());
60        }
61    }
62
63    /// Loads the provided account code into this store.
64    pub fn load_account_code(&self, code: &AccountCode) {
65        self.insert(code.mast().clone());
66    }
67}
68
69// MAST FOREST STORE IMPLEMENTATION
70// ================================================================================================
71
72impl MastForestStore for TransactionMastStore {
73    fn get(&self, procedure_root: &Word) -> Option<Arc<MastForest>> {
74        self.mast_forests.read().get(procedure_root).cloned()
75    }
76}
miden_tx/prover/mast_store.rs

miden_tx/prover/
mast_store.rs
