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
38
39
40
41

use alloc::vec;

use miden_core::mast::MastNode;
pub use miden_core::utils::*;
pub use miden_crypto::utils::{HexParseError, bytes_to_hex_string, hex_to_bytes};
pub use miden_utils_sync as sync;

use crate::Word;
use crate::assembly::mast::{ExternalNodeBuilder, MastForest, MastNodeId};
use crate::vm::AdviceMap;

pub mod serde {
    pub use miden_crypto::utils::{
        BudgetedReader,
        ByteReader,
        ByteWriter,
        Deserializable,
        DeserializationError,
        Serializable,
        SliceReader,
    };
}

pub mod strings;

pub(crate) use strings::ShortCapitalString;

/// Creates a minimal [MastForest] containing only an external node referencing the given digest.
///
/// This is useful for creating lightweight references to procedures without copying entire
/// libraries. The external reference will be resolved at runtime, assuming the source library
/// is loaded into the VM's MastForestStore.
pub(crate) fn create_external_node_forest(digest: Word) -> (MastForest, MastNodeId) {
    let mut nodes: IndexVec<MastNodeId, MastNode> = IndexVec::new();
    let node_id = nodes
        .push(ExternalNodeBuilder::new(digest).build().into())
        .expect("adding external node to empty forest should not fail");
    let mast = MastForest::from_raw_parts(nodes, vec![node_id], AdviceMap::default())
        .expect("single external node forest should be well-formed");
    (mast, node_id)
}