miden-base-sys 0.14.0

Miden rollup Rust bingings and MASM 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

//! Bindings for Miden protocol
//!
//! # Word Field Ordering
//!
//! The Miden protocol MASM procedures expect and/or return Word on the stack with the least
//! significant felt on top of the stack.
//!
//! - In Rust: Word fields are stored as [e0, e1, e2, e3]
//! - In MASM procedures: These are pushed/popped from the stack in reverse order [e3, e2, e1, e0]

pub mod active_account;
pub mod active_note;
pub mod faucet;
pub mod input_note;
pub mod native_account;
pub mod note;
pub mod output_note;
pub mod storage;
pub mod tx;
mod types;

pub use miden_field_repr::{FromFeltRepr, ToFeltRepr};
pub use types::*;

/// Maximum number of attachments per note, defined by the protocol MASM source at
/// `asm/kernels/transaction-core/src/output_note.masm`.
const MAX_ATTACHMENTS_PER_NOTE: usize = 4;

/// Maximum words per attachment, defined by the protocol MASM source at
/// `asm/protocol_utils/src/note.masm`.
const MAX_ATTACHMENT_WORDS: usize = 256;

/// Asserts that a note attachment count is within the protocol limit.
fn assert_attachment_count(num_attachments: usize) {
    assert!(
        num_attachments <= MAX_ATTACHMENTS_PER_NOTE,
        "note cannot contain more than {MAX_ATTACHMENTS_PER_NOTE} attachments"
    );
}

/// Asserts that an attachment word count is within the protocol limit.
fn assert_attachment_word_count(num_words: usize) {
    assert!(
        num_words <= MAX_ATTACHMENT_WORDS,
        "note attachment cannot contain more than {MAX_ATTACHMENT_WORDS} words"
    );
}