miden-core-lib 0.23.1

Miden VM core library
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
105
106
107
108
109
110
111
112
113
114
115
116
117

extern crate alloc;

/// Instantiates a test with Miden core library included.
#[macro_export]
macro_rules! build_test {
    ($($params:tt)+) => {{
        let core_lib = miden_core_lib::CoreLibrary::default();
        miden_utils_testing::build_test_by_mode!(false, $($params)+)
            .with_library(core_lib.library().clone())
            .with_event_handlers(core_lib.handlers())
    }}
}

/// Instantiates a test in debug mode with Miden core library included.
#[macro_export]
macro_rules! build_debug_test {
    ($($params:tt)+) => {{
        let core_lib = miden_core_lib::CoreLibrary::default();
        miden_utils_testing::build_test_by_mode!(true, $($params)+)
            .with_library(core_lib.library().clone())
            .with_event_handlers(core_lib.handlers())
    }}
}

/// Asserts that executing the test fails with a FailedAssertion containing the expected message.
#[macro_export]
macro_rules! expect_assert_error_message {
    ($test:expr $(,)?) => {
        ::miden_utils_testing::expect_exec_error_matches!(
            $test,
            ::miden_processor::ExecutionError::OperationError {
                err: ::miden_processor::operation::OperationError::FailedAssertion {
                    err_msg,
                    ..
                },
                ..
            }
            if err_msg.as_deref().map(|msg| msg.len() > 5).unwrap_or(false)
        );
    };
    ($test:expr, $min_len:expr $(,)?) => {
        ::miden_utils_testing::expect_exec_error_matches!(
            $test,
            ::miden_processor::ExecutionError::OperationError {
                err: ::miden_processor::operation::OperationError::FailedAssertion {
                    err_msg,
                    ..
                },
                ..
            }
            if err_msg.as_deref().map(|msg| msg.len() > $min_len).unwrap_or(false)
        );
    };
    ($test:expr, contains $needle:expr $(,)?) => {
        ::miden_utils_testing::expect_exec_error_matches!(
            $test,
            ::miden_processor::ExecutionError::OperationError {
                err: ::miden_processor::operation::OperationError::FailedAssertion {
                    err_msg,
                    ..
                },
                ..
            }
            if err_msg
                .as_deref()
                .map(|msg| msg.len() > 5 && msg.contains($needle))
                .unwrap_or(false)
        );
    };
}

#[test]
fn core_library_does_not_export_precompile_impl_helpers() {
    use miden_assembly::Path;
    use miden_core_lib::CoreLibrary;

    let core_lib = CoreLibrary::default();
    let library = core_lib.library();

    let public_paths = [
        "::miden::core::crypto::hashes::keccak256::hash_bytes",
        "::miden::core::crypto::hashes::sha512::hash_bytes",
        "::miden::core::crypto::dsa::ecdsa_k256_keccak::verify_prehash",
        "::miden::core::crypto::dsa::eddsa_ed25519::verify_prehash",
    ];
    for path in public_paths {
        assert!(
            library.get_procedure_root_by_path(Path::new(path)).is_some(),
            "expected public wrapper to be exported: {path}",
        );
    }

    let internal_paths = [
        "::miden::core::crypto::hashes::keccak256::hash_bytes_impl",
        "::miden::core::crypto::hashes::sha512::hash_bytes_impl",
        "::miden::core::crypto::dsa::ecdsa_k256_keccak::verify_prehash_impl",
        "::miden::core::crypto::dsa::eddsa_ed25519::verify_prehash_impl",
    ];
    for path in internal_paths {
        assert!(
            library.get_procedure_root_by_path(Path::new(path)).is_none(),
            "internal precompile helper must not be exported: {path}",
        );
    }
}

mod collections;
mod crypto;
mod helpers;
mod mast_forest_merge;
mod math;
mod mem;
mod stark_asserts;
mod sys;
mod word;

mod stark;