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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
use super::{
    AdviceInputs, AdviceProvider, AdviceSource, BTreeMap, ExecutionError, Felt, IntoBytes,
    MerklePath, MerkleSet, NodeIndex, StarkField, Vec, Word,
};

// MEMORY ADVICE PROVIDER
// ================================================================================================

/// An in-memory `[AdviceProvider]` implementation to support program execution.
///
/// Uses `[BTreeMap]` as backend.
#[derive(Debug, Clone, Default)]
pub struct MemAdviceProvider {
    step: u32,
    tape: Vec<Felt>,
    values: BTreeMap<[u8; 32], Vec<Felt>>,
    sets: BTreeMap<[u8; 32], MerkleSet>,
}

impl From<AdviceInputs> for MemAdviceProvider {
    fn from(inputs: AdviceInputs) -> Self {
        let (mut tape, values, sets) = inputs.into_parts();
        tape.reverse();
        Self {
            step: 0,
            tape,
            values,
            sets,
        }
    }
}

impl AdviceProvider for MemAdviceProvider {
    // ADVICE TAPE
    // --------------------------------------------------------------------------------------------

    fn read_tape(&mut self) -> Result<Felt, ExecutionError> {
        self.tape.pop().ok_or(ExecutionError::AdviceTapeReadFailed(self.step))
    }

    fn read_tape_w(&mut self) -> Result<Word, ExecutionError> {
        if self.tape.len() < 4 {
            return Err(ExecutionError::AdviceTapeReadFailed(self.step));
        }

        let idx = self.tape.len() - 4;
        let result = [self.tape[idx + 3], self.tape[idx + 2], self.tape[idx + 1], self.tape[idx]];

        self.tape.truncate(idx);

        Ok(result)
    }

    fn read_tape_dw(&mut self) -> Result<[Word; 2], ExecutionError> {
        let word0 = self.read_tape_w()?;
        let word1 = self.read_tape_w()?;

        Ok([word0, word1])
    }

    fn write_tape(&mut self, source: AdviceSource) -> Result<(), ExecutionError> {
        match source {
            AdviceSource::Value(value) => {
                self.tape.push(value);
                Ok(())
            }

            AdviceSource::Map { key } => {
                let values = self
                    .values
                    .get(&key.into_bytes())
                    .ok_or(ExecutionError::AdviceKeyNotFound(key))?;
                self.tape.extend(values.iter().rev());
                Ok(())
            }
        }
    }

    fn insert_into_map(&mut self, key: Word, values: Vec<Felt>) -> Result<(), ExecutionError> {
        match self.values.insert(key.into_bytes(), values) {
            None => Ok(()),
            Some(_) => Err(ExecutionError::DuplicateAdviceKey(key)),
        }
    }

    // ADVISE SETS
    // --------------------------------------------------------------------------------------------

    fn get_tree_node(&self, root: Word, depth: Felt, index: Felt) -> Result<Word, ExecutionError> {
        // look up the merkle set and return an error if none is found
        let merkle_set = self
            .sets
            .get(&root.into_bytes())
            .ok_or_else(|| ExecutionError::MerkleSetNotFound(root.into_bytes()))?;

        // get the tree node from the merkle set based on depth and index
        let index = NodeIndex::from_elements(&depth, &index)
            .map_err(ExecutionError::MerkleSetLookupFailed)?;
        let node = merkle_set.get_node(index).map_err(ExecutionError::MerkleSetLookupFailed)?;

        Ok(node)
    }

    fn get_merkle_path(
        &self,
        root: Word,
        depth: Felt,
        index: Felt,
    ) -> Result<MerklePath, ExecutionError> {
        // look up the merkle set and return an error if none is found
        let merkle_set = self
            .sets
            .get(&root.into_bytes())
            .ok_or_else(|| ExecutionError::MerkleSetNotFound(root.into_bytes()))?;

        // get the Merkle path from the merkle set based on depth and index
        let index = NodeIndex::from_elements(&depth, &index)
            .map_err(ExecutionError::MerkleSetLookupFailed)?;
        let path = merkle_set.get_path(index).map_err(ExecutionError::MerkleSetLookupFailed)?;

        Ok(path)
    }

    fn update_merkle_leaf(
        &mut self,
        root: Word,
        index: Felt,
        leaf_value: Word,
        update_in_copy: bool,
    ) -> Result<MerklePath, ExecutionError> {
        // look up the merkle set and return error if none is found. if we are updating a copy,
        // clone the merkle set; otherwise remove it from the map because the root will change,
        // and we'll re-insert the set later under a different root.
        let mut merkle_set = if update_in_copy {
            // look up the merkle set and return an error if none is found
            self.sets
                .get(&root.into_bytes())
                .ok_or_else(|| ExecutionError::MerkleSetNotFound(root.into_bytes()))?
                .clone()
        } else {
            self.sets
                .remove(&root.into_bytes())
                .ok_or_else(|| ExecutionError::MerkleSetNotFound(root.into_bytes()))?
        };

        // get the Merkle path from the merkle set for the leaf at the specified index
        let index = NodeIndex::new(merkle_set.depth(), index.as_int());
        let path = merkle_set.get_path(index).map_err(ExecutionError::MerkleSetLookupFailed)?;

        // update the merkle set and re-insert it into the map
        merkle_set
            .update_leaf(index.value(), leaf_value)
            .map_err(ExecutionError::MerkleSetLookupFailed)?;
        self.sets.insert(merkle_set.root().into_bytes(), merkle_set);

        Ok(path)
    }

    // CONTEXT MANAGEMENT
    // --------------------------------------------------------------------------------------------

    fn advance_clock(&mut self) {
        self.step += 1;
    }
}

#[cfg(test)]
impl MemAdviceProvider {
    // ADVISE SETS
    // --------------------------------------------------------------------------------------------

    /// Returns true if the merkle set with the specified root is present in this advice provider.
    pub fn has_merkle_set(&self, root: Word) -> bool {
        self.sets.contains_key(&root.into_bytes())
    }
}