miden_core/advice/
map.rs

1use alloc::{
2    boxed::Box,
3    collections::{BTreeMap, btree_map::IntoIter},
4    vec::Vec,
5};
6
7use miden_crypto::{Felt, utils::collections::KvMap};
8
9use crate::{
10    crypto::hash::RpoDigest,
11    utils::{ByteReader, ByteWriter, Deserializable, DeserializationError, Serializable},
12};
13
14// ADVICE MAP
15// ================================================================================================
16
17/// Defines a set of non-deterministic (advice) inputs which the VM can access by their keys.
18///
19/// Each key maps to one or more field element. To access the elements, the VM can move the values
20/// associated with a given key onto the advice stack using `adv.push_mapval` instruction. The VM
21/// can also insert new values into the advice map during execution.
22#[derive(Debug, Clone, Default, PartialEq, Eq)]
23pub struct AdviceMap(BTreeMap<RpoDigest, Vec<Felt>>);
24
25impl AdviceMap {
26    /// Creates a new advice map.
27    pub fn new() -> Self {
28        Self(BTreeMap::<RpoDigest, Vec<Felt>>::new())
29    }
30
31    /// Returns the values associated with given key.
32    pub fn get(&self, key: &RpoDigest) -> Option<&[Felt]> {
33        self.0.get(key).map(|v| v.as_slice())
34    }
35
36    /// Inserts a key value pair in the advice map and returns the inserted value.
37    pub fn insert(&mut self, key: RpoDigest, value: Vec<Felt>) -> Option<Vec<Felt>> {
38        self.0.insert(key, value)
39    }
40
41    /// Removes the value associated with the key and returns the removed element.
42    pub fn remove(&mut self, key: &RpoDigest) -> Option<Vec<Felt>> {
43        self.0.remove(key)
44    }
45
46    /// Returns the number of key value pairs in the advice map.
47    pub fn len(&self) -> usize {
48        self.0.len()
49    }
50
51    /// Returns true if the advice map is empty.
52    pub fn is_empty(&self) -> bool {
53        self.0.is_empty()
54    }
55}
56
57impl From<BTreeMap<RpoDigest, Vec<Felt>>> for AdviceMap {
58    fn from(value: BTreeMap<RpoDigest, Vec<Felt>>) -> Self {
59        Self(value)
60    }
61}
62
63impl IntoIterator for AdviceMap {
64    type Item = (RpoDigest, Vec<Felt>);
65    type IntoIter = IntoIter<RpoDigest, Vec<Felt>>;
66
67    fn into_iter(self) -> Self::IntoIter {
68        self.0.into_iter()
69    }
70}
71
72impl FromIterator<(RpoDigest, Vec<Felt>)> for AdviceMap {
73    fn from_iter<T: IntoIterator<Item = (RpoDigest, Vec<Felt>)>>(iter: T) -> Self {
74        iter.into_iter().collect::<BTreeMap<RpoDigest, Vec<Felt>>>().into()
75    }
76}
77
78impl KvMap<RpoDigest, Vec<Felt>> for AdviceMap {
79    fn get(&self, key: &RpoDigest) -> Option<&Vec<Felt>> {
80        self.0.get(key)
81    }
82
83    fn contains_key(&self, key: &RpoDigest) -> bool {
84        self.0.contains_key(key)
85    }
86
87    fn len(&self) -> usize {
88        self.len()
89    }
90
91    fn insert(&mut self, key: RpoDigest, value: Vec<Felt>) -> Option<Vec<Felt>> {
92        self.insert(key, value)
93    }
94
95    fn remove(&mut self, key: &RpoDigest) -> Option<Vec<Felt>> {
96        self.remove(key)
97    }
98
99    fn iter(&self) -> Box<dyn Iterator<Item = (&RpoDigest, &Vec<Felt>)> + '_> {
100        Box::new(self.0.iter())
101    }
102}
103
104impl Extend<(RpoDigest, Vec<Felt>)> for AdviceMap {
105    fn extend<T: IntoIterator<Item = (RpoDigest, Vec<Felt>)>>(&mut self, iter: T) {
106        self.0.extend(iter)
107    }
108}
109
110impl Serializable for AdviceMap {
111    fn write_into<W: ByteWriter>(&self, target: &mut W) {
112        target.write_usize(self.0.len());
113        for (key, values) in self.0.iter() {
114            target.write((key, values));
115        }
116    }
117}
118
119impl Deserializable for AdviceMap {
120    fn read_from<R: ByteReader>(source: &mut R) -> Result<Self, DeserializationError> {
121        let mut map = BTreeMap::new();
122        let count = source.read_usize()?;
123        for _ in 0..count {
124            let (key, values) = source.read()?;
125            map.insert(key, values);
126        }
127        Ok(Self(map))
128    }
129}
130
131#[cfg(test)]
132mod tests {
133    use super::*;
134
135    #[test]
136    fn test_advice_map_serialization() {
137        let mut map1 = AdviceMap::new();
138        map1.insert(RpoDigest::default(), vec![Felt::from(1u32), Felt::from(2u32)]);
139
140        let bytes = map1.to_bytes();
141
142        let map2 = AdviceMap::read_from_bytes(&bytes).unwrap();
143
144        assert_eq!(map1, map2);
145    }
146}
miden_core/advice/map.rs

miden_core/advice/
map.rs
