miden-testing 0.14.3

Miden protocol testing tools
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

#[cfg(test)]
use miden_processor::DefaultHost;
use miden_processor::advice::AdviceInputs;
use miden_processor::{ExecutionOutput, FastProcessor, Host, Program, StackInputs};
#[cfg(test)]
use miden_protocol::assembly::Assembler;

use crate::ExecError;

// CODE EXECUTOR
// ================================================================================================

/// Helper for executing arbitrary code within arbitrary hosts.
pub(crate) struct CodeExecutor<H> {
    host: H,
    stack_inputs: Option<StackInputs>,
    advice_inputs: AdviceInputs,
}

impl<H: Host> CodeExecutor<H> {
    // CONSTRUCTOR
    // --------------------------------------------------------------------------------------------
    pub(crate) fn new(host: H) -> Self {
        Self {
            host,
            stack_inputs: None,
            advice_inputs: AdviceInputs::default(),
        }
    }

    pub fn extend_advice_inputs(mut self, advice_inputs: AdviceInputs) -> Self {
        self.advice_inputs.extend(advice_inputs);
        self
    }

    pub fn stack_inputs(mut self, stack_inputs: StackInputs) -> Self {
        self.stack_inputs = Some(stack_inputs);
        self
    }

    /// Compiles and runs the desired code in the host and returns the [`Process`] state.
    #[cfg(test)]
    pub async fn run(self, code: &str) -> Result<ExecutionOutput, ExecError> {
        use alloc::borrow::ToOwned;
        use alloc::sync::Arc;

        use miden_protocol::assembly::debuginfo::{SourceLanguage, Uri};
        use miden_protocol::assembly::{DefaultSourceManager, SourceManagerSync};
        use miden_standards::code_builder::CodeBuilder;

        let source_manager: Arc<dyn SourceManagerSync> = Arc::new(DefaultSourceManager::default());
        let assembler: Assembler = CodeBuilder::with_kernel_library(source_manager.clone()).into();

        // Virtual file name should be unique.
        let virtual_source_file =
            source_manager.load(SourceLanguage::Masm, Uri::new("_user_code"), code.to_owned());
        let program = assembler.assemble_program(virtual_source_file).unwrap();

        self.execute_program(program).await
    }

    /// Executes the provided [`Program`] and returns the [`Process`] state.
    ///
    /// To improve the error message quality, convert the returned [`ExecutionError`] into a
    /// [`Report`](miden_protocol::assembly::diagnostics::Report).
    pub async fn execute_program(mut self, program: Program) -> Result<ExecutionOutput, ExecError> {
        let stack_inputs = self.stack_inputs.unwrap_or_default();

        let processor = FastProcessor::new(stack_inputs)
            .with_advice(self.advice_inputs)
            .with_debugging(true);

        let execution_output =
            processor.execute(&program, &mut self.host).await.map_err(ExecError::new)?;

        Ok(execution_output)
    }
}

#[cfg(test)]
impl CodeExecutor<DefaultHost> {
    pub fn with_default_host() -> Self {
        use miden_core_lib::CoreLibrary;
        use miden_protocol::ProtocolLib;
        use miden_protocol::transaction::TransactionKernel;
        use miden_standards::StandardsLib;

        let mut host = DefaultHost::default();

        let core_lib = CoreLibrary::default();
        host.load_library(core_lib.mast_forest()).unwrap();

        let standards_lib = StandardsLib::default();
        host.load_library(standards_lib.mast_forest()).unwrap();

        let protocol_lib = ProtocolLib::default();
        host.load_library(protocol_lib.mast_forest()).unwrap();

        let kernel_lib = TransactionKernel::library();
        host.load_library(kernel_lib.mast_forest()).unwrap();

        CodeExecutor::new(host)
    }
}