miden-objects 0.17.0-rc.6

Canonical Protobuf representations for Miden protocol objects
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

use alloc::string::ToString;
use alloc::vec;

use assert_matches::assert_matches;
use miden_protocol::Word;

use crate::{DecodeMessage, Verify, proto};

#[test]
fn storage_slot_id_verifies() {
    let decoded = proto::account::StorageSlotId {
        suffix: Some(miden_protocol::Felt::ONE.into()),
        prefix: Some(miden_protocol::Felt::ZERO.into()),
    }
    .decode_fields()
    .unwrap();
    assert_eq!(decoded.verify().unwrap().suffix(), miden_protocol::Felt::ONE);
}

#[test]
fn storage_map_entry_verifies() {
    let decoded = proto::account::StorageMapEntry {
        key: Some(Word::empty().into()),
        value: Some(Word::empty().into()),
    }
    .decode_fields()
    .unwrap();
    assert_eq!(decoded.verify().unwrap().1, Word::empty());
}

#[test]
fn account_storage_header_slot_defers_name_validation() {
    let wire = proto::account::account_storage_header::StorageSlot {
        slot_name: "".into(),
        content: Some(proto::account::account_storage_header::storage_slot::Content::MapRoot(
            Word::empty().into(),
        )),
    };
    let decoded = wire.decode_fields().unwrap();
    assert!(matches!(
        decoded.verify(),
        Err(miden_protocol::errors::StorageSlotNameError::TooShort)
    ));
}

#[test]
fn storage_header_defers_duplicate_validation() {
    let slot = proto::account::account_storage_header::StorageSlot {
        slot_name: miden_protocol::account::StorageSlotName::mock(1).as_str().into(),
        content: Some(proto::account::account_storage_header::storage_slot::Content::Value(
            Word::empty().into(),
        )),
    };
    let decoded = proto::account::AccountStorageHeader { slots: vec![slot.clone(), slot] }
        .decode_fields()
        .unwrap();
    assert!(decoded.verify().is_err());
}

#[test]
fn storage_header_verification_reports_the_invalid_slot_index() {
    let slot = proto::account::account_storage_header::StorageSlot {
        slot_name: miden_protocol::account::StorageSlotName::mock(1).as_str().into(),
        content: Some(proto::account::account_storage_header::storage_slot::Content::Value(
            Word::empty().into(),
        )),
    };
    let invalid = proto::account::account_storage_header::StorageSlot {
        slot_name: "".into(),
        ..slot.clone()
    };
    let error = proto::account::AccountStorageHeader { slots: vec![slot, invalid] }
        .decode_fields()
        .unwrap()
        .verify()
        .unwrap_err();

    assert!(error.to_string().starts_with("slots[1]:"), "{error}");
    assert!(matches!(
        crate::test_utils::error_source::<miden_protocol::errors::StorageSlotNameError>(&error),
        Some(miden_protocol::errors::StorageSlotNameError::TooShort)
    ));
}

/// Returns a wire storage slot with the mock name at `index` and an empty value.
fn value_slot(index: usize) -> proto::account::StorageSlot {
    proto::account::StorageSlot {
        slot_name: miden_protocol::account::StorageSlotName::mock(index).as_str().into(),
        storage_slot_content: Some(proto::account::storage_slot::StorageSlotContent::Value(
            Word::empty().into(),
        )),
    }
}

#[test]
fn account_storage_rejects_duplicate_slot_names() {
    let slot = value_slot(1);
    let error = proto::account::AccountStorage { slots: vec![slot.clone(), slot] }
        .decode_fields()
        .unwrap()
        .verify()
        .unwrap_err();

    assert_matches!(
        crate::test_utils::error_source::<miden_protocol::errors::AccountError>(&error),
        Some(miden_protocol::errors::AccountError::DuplicateStorageSlotName(_))
    );
}

#[test]
fn account_storage_rejects_more_slots_than_the_maximum() {
    let num_slots = miden_protocol::account::AccountStorage::MAX_NUM_STORAGE_SLOTS + 1;
    let slots = (0..num_slots).map(value_slot).collect();
    let error = proto::account::AccountStorage { slots }
        .decode_fields()
        .unwrap()
        .verify()
        .unwrap_err();

    assert_matches!(
        crate::test_utils::error_source::<miden_protocol::errors::AccountError>(&error),
        Some(miden_protocol::errors::AccountError::StorageTooManySlots(count))
            if *count == num_slots as u64
    );
}

#[test]
fn storage_map_rejects_an_empty_value() {
    let key = miden_protocol::account::StorageMapKey::from_raw(Word::from([1_u32, 2, 3, 4]));
    let entry = proto::account::StorageMapEntry {
        key: Some(Word::from(key).into()),
        value: Some(Word::empty().into()),
    };
    let error = proto::account::StorageMap { entries: vec![entry] }
        .decode_fields()
        .unwrap()
        .verify()
        .unwrap_err();

    assert_matches!(
        crate::test_utils::error_source::<crate::decoded::account::StorageMapEntryError>(&error),
        Some(crate::decoded::account::StorageMapEntryError::EmptyValue(empty)) if *empty == key
    );
}