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

pub use proto::account::DecodedStorageSlotId as StorageSlotId;

use crate::decoded::VerificationError;
use crate::{Verify, proto};

#[cfg(test)]
mod tests;

impl Verify for StorageSlotId {
    type Verified = miden_protocol::account::StorageSlotId;
    type Error = core::convert::Infallible;
    fn verify(self) -> Result<Self::Verified, Self::Error> {
        Ok(Self::Verified::new(self.suffix, self.prefix))
    }
}

pub use proto::account::DecodedStorageMapEntry as StorageMapEntry;

impl Verify for StorageMapEntry {
    type Verified = (miden_protocol::account::StorageMapKey, miden_protocol::Word);
    type Error = core::convert::Infallible;
    fn verify(self) -> Result<Self::Verified, Self::Error> {
        Ok((miden_protocol::account::StorageMapKey::from_raw(self.key), self.value))
    }
}

pub use proto::account::account_storage_header::DecodedStorageSlot as AccountStorageHeaderStorageSlot;

impl Verify for AccountStorageHeaderStorageSlot {
    type Verified = miden_protocol::account::StorageSlotHeader;
    type Error = miden_protocol::errors::StorageSlotNameError;
    fn verify(self) -> Result<Self::Verified, Self::Error> {
        use miden_protocol::account::StorageSlotType;
        use proto::account::account_storage_header::storage_slot::DecodedContent;

        let name = miden_protocol::account::StorageSlotName::new(self.slot_name)?;
        let (slot_type, value) = match self.content {
            DecodedContent::Value(value) => (StorageSlotType::Value, value),
            DecodedContent::MapRoot(root) => (StorageSlotType::Map, root),
        };
        Ok(Self::Verified::new(name, slot_type, value))
    }
}

pub use proto::account::DecodedAccountStorageHeader as AccountStorageHeader;

impl Verify for AccountStorageHeader {
    type Verified = miden_protocol::account::AccountStorageHeader;
    type Error = VerificationError;
    fn verify(self) -> Result<Self::Verified, Self::Error> {
        let slots = self.slots.verify()?;
        Ok(Self::Verified::new(slots)?)
    }
}

pub use proto::account::DecodedStorageMap as StorageMap;

impl Verify for StorageMap {
    type Verified = miden_protocol::account::StorageMap;
    type Error = VerificationError;
    fn verify(self) -> Result<Self::Verified, Self::Error> {
        let entries = self.entries.verify_infallible();
        // The storage map constructor drops an entry with an empty value. Reject it here for a
        // clear error.
        if let Some((key, _)) = entries.iter().find(|(_, value)| value.is_empty()) {
            return Err(StorageMapEntryError::EmptyValue(*key).into());
        }
        Ok(Self::Verified::with_entries(entries)?)
    }
}

/// An invariant of a single map entry, distinct from the domain's `StorageMapError`.
#[derive(Debug, thiserror::Error)]
pub enum StorageMapEntryError {
    #[error("storage map entry {0} has an empty value")]
    EmptyValue(miden_protocol::account::StorageMapKey),
}

pub use proto::account::DecodedStorageSlot as StorageSlot;

impl Verify for StorageSlot {
    type Verified = miden_protocol::account::StorageSlot;
    type Error = VerificationError;
    fn verify(self) -> Result<Self::Verified, Self::Error> {
        use miden_protocol::account::StorageSlotContent;
        use proto::account::storage_slot::DecodedStorageSlotContent;

        let name = miden_protocol::account::StorageSlotName::new(self.slot_name)?;
        let content = match self.storage_slot_content {
            DecodedStorageSlotContent::Value(value) => StorageSlotContent::Value(value),
            DecodedStorageSlotContent::Map(map) => StorageSlotContent::Map(map.verify()?),
        };
        Ok(Self::Verified::new(name, content))
    }
}

pub use proto::account::DecodedAccountStorage as AccountStorage;

impl Verify for AccountStorage {
    type Verified = miden_protocol::account::AccountStorage;
    type Error = VerificationError;
    fn verify(self) -> Result<Self::Verified, Self::Error> {
        // Check the slot count before verifying the slots, so an oversized message is rejected
        // without first building a tree for each of its map slots.
        let num_slots = self.slots.as_slice().len();
        if num_slots > Self::Verified::MAX_NUM_STORAGE_SLOTS {
            return Err(miden_protocol::errors::AccountError::StorageTooManySlots(
                num_slots as u64,
            )
            .into());
        }
        Ok(Self::Verified::new(self.slots.verify()?)?)
    }
}