miden-lib 0.12.4

Standard library 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
42
43
44
45
46
47
48
49
50

use miden_objects::assembly::Library;
use miden_objects::assembly::diagnostics::NamedSource;
use miden_objects::utils::sync::LazyLock;

use crate::transaction::TransactionKernel;

const MOCK_UTIL_LIBRARY_CODE: &str = "
    use.miden::output_note

    # Inputs:  []
    # Outputs: [note_idx]
    export.create_random_note
        push.1.2.3.4           # = RECIPIENT
        push.1                 # = NoteExecutionHint::Always
        push.2                 # = NoteType::Private
        push.0                 # = aux
        push.0xc0000000        # = NoteTag::LocalAny
        # => [tag, aux, note_type, execution_hint, RECIPIENT, pad(8)]

        exec.output_note::create
        # => [note_idx]
    end

    # Inputs:  [ASSET]
    # Outputs: []
    export.create_random_note_with_asset
        exec.create_random_note
        # => [note_idx, ASSET]

        movdn.4
        # => [ASSET, note_idx]

        exec.output_note::add_asset
        # => []
    end
";

static MOCK_UTIL_LIBRARY: LazyLock<Library> = LazyLock::new(|| {
    let source = NamedSource::new("mock::util", MOCK_UTIL_LIBRARY_CODE);
    TransactionKernel::assembler()
        .assemble_library([source])
        .expect("mock util library should be valid")
});

/// Returns the mock test [`Library`] under the `mock::util` namespace.
///
/// This provides convenient wrappers for testing purposes.
pub fn mock_util_library() -> Library {
    MOCK_UTIL_LIBRARY.clone()
}