miden-protocol 0.16.0-alpha.4

Core components of the Miden protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

use alloc::sync::Arc;

use miden_mast_package::debug_info::PackageDebugInfo;
use miden_mast_package::{Package, PackageDebugInfoError};
use miden_processor::LoadedMastForest;

use crate::MastForest;

// Temporary bridge while package debug loading is split between protocol and VM APIs. These helpers
// should move to miden-vm once the VM owns package-backed host libraries and debug info loading.

/// Returns package-owned debug info when it can be decoded from trusted package sections.
pub fn package_debug_info(package: &Package) -> Option<Arc<PackageDebugInfo>> {
    match package.debug_info() {
        Ok(debug_info) => debug_info.map(Arc::new),
        Err(PackageDebugInfoError::UntrustedSections) => None,
        Err(_) => None,
    }
}

/// Builds a loaded MAST forest from a MAST forest and package-owned debug info.
pub fn loaded_mast_forest(
    mast: Arc<MastForest>,
    package_debug_info: Option<Arc<PackageDebugInfo>>,
) -> LoadedMastForest {
    match package_debug_info {
        Some(package_debug_info) => {
            LoadedMastForest::with_package_debug_info(mast, Ok(Some((*package_debug_info).clone())))
        },
        None => LoadedMastForest::new(mast),
    }
}

/// Builds a loaded MAST forest from a package, including package-owned debug info when trusted.
pub fn loaded_mast_forest_from_package(package: &Package) -> LoadedMastForest {
    loaded_mast_forest(package.mast_forest().clone(), package_debug_info(package))
}