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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
//! Merk tree encoding

#[cfg(feature = "full")]
use ed::{Decode, Encode};
#[cfg(feature = "full")]
use grovedb_costs::{
    cost_return_on_error, cost_return_on_error_no_add, CostResult, CostsExt, OperationCost,
};
#[cfg(feature = "full")]
use grovedb_storage::StorageContext;
use grovedb_version::version::GroveVersion;

#[cfg(feature = "full")]
use super::TreeNode;
use crate::tree::kv::ValueDefinedCostType;
#[cfg(feature = "full")]
use crate::{
    error::{Error, Error::EdError},
    tree::TreeNodeInner,
    Error::StorageError,
};

#[cfg(feature = "full")]
impl TreeNode {
    /// Decode given bytes and set as Tree fields. Set key to value of given
    /// key.
    pub fn decode_raw(
        bytes: &[u8],
        key: Vec<u8>,
        value_defined_cost_fn: Option<
            impl Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
        >,
        grove_version: &GroveVersion,
    ) -> Result<Self, Error> {
        TreeNode::decode(key, bytes, value_defined_cost_fn, grove_version).map_err(EdError)
    }

    /// Get value from storage given key.
    pub(crate) fn get<'db, S, K>(
        storage: &S,
        key: K,
        value_defined_cost_fn: Option<
            impl Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
        >,
        grove_version: &GroveVersion,
    ) -> CostResult<Option<Self>, Error>
    where
        S: StorageContext<'db>,
        K: AsRef<[u8]>,
    {
        let mut cost = OperationCost::default();
        let tree_bytes = cost_return_on_error!(&mut cost, storage.get(&key).map_err(StorageError));

        let tree_opt = cost_return_on_error_no_add!(
            &cost,
            tree_bytes
                .map(|x| TreeNode::decode_raw(
                    &x,
                    key.as_ref().to_vec(),
                    value_defined_cost_fn,
                    grove_version
                ))
                .transpose()
        );

        Ok(tree_opt).wrap_with_cost(cost)
    }
}

#[cfg(feature = "full")]
impl TreeNode {
    #[inline]
    /// Encode
    pub fn encode(&self) -> Vec<u8> {
        // operation is infallible so it's ok to unwrap
        Encode::encode(&self.inner).unwrap()
    }

    #[inline]
    /// Encode to destination writer
    pub fn encode_into(&self, dest: &mut Vec<u8>) {
        // operation is infallible so it's ok to unwrap
        Encode::encode_into(&self.inner, dest).unwrap()
    }

    #[inline]
    /// Return length of encoding
    pub fn encoding_length(&self) -> usize {
        // operation is infallible so it's ok to unwrap
        Encode::encoding_length(&self.inner).unwrap()
    }

    #[inline]
    /// Get the cost (byte length) of the value including parent to child
    /// reference (or hook)
    pub fn value_encoding_length_with_parent_to_child_reference(&self) -> u32 {
        // in the case of a grovedb tree the value cost is fixed
        if let Some(value_cost) = &self.inner.kv.value_defined_cost {
            self.inner.kv.predefined_value_byte_cost_size(value_cost)
        } else {
            self.inner.kv.value_byte_cost_size()
        }
    }

    #[inline]
    /// Decode bytes from reader, set as Tree fields and set key to given key
    pub fn decode_into(
        &mut self,
        key: Vec<u8>,
        input: &[u8],
        value_defined_cost_fn: Option<
            impl Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
        >,
        grove_version: &GroveVersion,
    ) -> ed::Result<()> {
        let mut tree_inner: TreeNodeInner = Decode::decode(input)?;
        tree_inner.kv.key = key;
        if let Some(value_defined_cost_fn) = value_defined_cost_fn {
            tree_inner.kv.value_defined_cost =
                value_defined_cost_fn(tree_inner.kv.value.as_slice(), grove_version);
        }
        self.inner = Box::new(tree_inner);
        Ok(())
    }

    #[inline]
    /// Decode input and set as Tree fields. Set the key as the given key.
    pub fn decode(
        key: Vec<u8>,
        input: &[u8],
        value_defined_cost_fn: Option<
            impl Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
        >,
        grove_version: &GroveVersion,
    ) -> ed::Result<Self> {
        let mut tree_inner: TreeNodeInner = Decode::decode(input)?;
        tree_inner.kv.key = key;
        if let Some(value_defined_cost_fn) = value_defined_cost_fn {
            tree_inner.kv.value_defined_cost =
                value_defined_cost_fn(tree_inner.kv.value.as_slice(), grove_version);
        }
        Ok(TreeNode::new_with_tree_inner(tree_inner))
    }
}

#[cfg(feature = "full")]
#[cfg(test)]
mod tests {
    use super::{super::Link, *};
    use crate::TreeFeatureType::{BasicMerkNode, SummedMerkNode};

    #[test]
    fn encode_leaf_tree() {
        let tree =
            TreeNode::from_fields(vec![0], vec![1], [55; 32], None, None, BasicMerkNode).unwrap();
        assert_eq!(tree.encoding_length(), 68);
        assert_eq!(
            tree.value_encoding_length_with_parent_to_child_reference(),
            104
        );
        assert_eq!(
            tree.encode(),
            vec![
                0, 0, 0, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55,
                55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 32, 34, 236, 157, 87, 27,
                167, 116, 207, 158, 131, 208, 25, 73, 98, 245, 209, 227, 170, 26, 72, 212, 134,
                166, 126, 39, 98, 166, 199, 149, 144, 21, 1
            ]
        );
    }

    #[test]
    #[should_panic]
    fn encode_modified_tree() {
        let tree = TreeNode::from_fields(
            vec![0],
            vec![1],
            [55; 32],
            Some(Link::Modified {
                pending_writes: 1,
                child_heights: (123, 124),
                tree: TreeNode::new(vec![2], vec![3], None, BasicMerkNode).unwrap(),
            }),
            None,
            BasicMerkNode,
        )
        .unwrap();
        tree.encode();
    }

    #[test]
    fn encode_loaded_tree() {
        let tree = TreeNode::from_fields(
            vec![0],
            vec![1],
            [55; 32],
            Some(Link::Loaded {
                hash: [66; 32],
                sum: None,
                child_heights: (123, 124),
                tree: TreeNode::new(vec![2], vec![3], None, BasicMerkNode).unwrap(),
            }),
            None,
            BasicMerkNode,
        )
        .unwrap();
        assert_eq!(
            tree.encode(),
            vec![
                1, 1, 2, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66,
                66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 123, 124, 0, 0, 0, 55, 55,
                55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55,
                55, 55, 55, 55, 55, 55, 55, 55, 55, 32, 34, 236, 157, 87, 27, 167, 116, 207, 158,
                131, 208, 25, 73, 98, 245, 209, 227, 170, 26, 72, 212, 134, 166, 126, 39, 98, 166,
                199, 149, 144, 21, 1
            ]
        );
    }

    #[test]
    fn encode_uncommitted_tree() {
        let tree = TreeNode::from_fields(
            vec![0],
            vec![1],
            [55; 32],
            Some(Link::Uncommitted {
                hash: [66; 32],
                sum: Some(10),
                child_heights: (123, 124),
                tree: TreeNode::new(vec![2], vec![3], None, BasicMerkNode).unwrap(),
            }),
            None,
            SummedMerkNode(5),
        )
        .unwrap();
        assert_eq!(
            tree.encode(),
            vec![
                1, 1, 2, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66,
                66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 123, 124, 1, 20, 0, 1, 10,
                55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55,
                55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 32, 34, 236, 157, 87, 27, 167, 116,
                207, 158, 131, 208, 25, 73, 98, 245, 209, 227, 170, 26, 72, 212, 134, 166, 126, 39,
                98, 166, 199, 149, 144, 21, 1
            ]
        );
    }

    #[test]
    fn encode_reference_tree() {
        let tree = TreeNode::from_fields(
            vec![0],
            vec![1],
            [55; 32],
            Some(Link::Reference {
                hash: [66; 32],
                sum: None,
                child_heights: (123, 124),
                key: vec![2],
            }),
            None,
            BasicMerkNode,
        )
        .unwrap();
        assert_eq!(
            tree.encoding_length(), /* this does not have the key encoded, just value and
                                     * left/right */
            105
        );
        assert_eq!(
            tree.value_encoding_length_with_parent_to_child_reference(),
            104 // This is 1 less, because the right "Option" byte was not paid for
        );
        assert_eq!(
            tree.encode(),
            vec![
                1, 1, 2, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66,
                66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 123, 124, 0, 0, 0, 55, 55,
                55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55,
                55, 55, 55, 55, 55, 55, 55, 55, 55, 32, 34, 236, 157, 87, 27, 167, 116, 207, 158,
                131, 208, 25, 73, 98, 245, 209, 227, 170, 26, 72, 212, 134, 166, 126, 39, 98, 166,
                199, 149, 144, 21, 1
            ]
        );
    }

    #[test]
    fn decode_leaf_tree() {
        let grove_version = GroveVersion::latest();
        let bytes = vec![
            0, 0, 0, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55,
            55, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 32, 34, 236, 157, 87, 27, 167, 116, 207, 158,
            131, 208, 25, 73, 98, 245, 209, 227, 170, 26, 72, 212, 134, 166, 126, 39, 98, 166, 199,
            149, 144, 21, 1,
        ];
        let tree = TreeNode::decode(
            vec![0],
            bytes.as_slice(),
            None::<&fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>>,
            grove_version,
        )
        .expect("should decode correctly");
        assert_eq!(tree.key(), &[0]);
        assert_eq!(tree.value_as_slice(), &[1]);
        assert_eq!(tree.inner.kv.feature_type, BasicMerkNode);
    }

    #[test]
    fn decode_reference_tree() {
        let grove_version = GroveVersion::latest();
        let bytes = vec![
            1, 1, 2, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66,
            66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 66, 123, 124, 0, 0, 0, 55, 55, 55, 55,
            55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55, 55,
            55, 55, 55, 55, 55, 55, 32, 34, 236, 157, 87, 27, 167, 116, 207, 158, 131, 208, 25, 73,
            98, 245, 209, 227, 170, 26, 72, 212, 134, 166, 126, 39, 98, 166, 199, 149, 144, 21, 1,
        ];
        let tree = TreeNode::decode(
            vec![0],
            bytes.as_slice(),
            None::<&fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>>,
            grove_version,
        )
        .expect("should decode correctly");
        assert_eq!(tree.key(), &[0]);
        assert_eq!(tree.value_as_slice(), &[1]);
        if let Some(Link::Reference {
            key,
            child_heights,
            hash,
            sum: _,
        }) = tree.link(true)
        {
            assert_eq!(*key, [2]);
            assert_eq!(*child_heights, (123u8, 124u8));
            assert_eq!(*hash, [66u8; 32]);
        } else {
            panic!("Expected Link::Reference");
        }
    }

    #[test]
    fn decode_invalid_bytes_as_tree() {
        let grove_version = GroveVersion::latest();
        let bytes = vec![2, 3, 4, 5];
        let tree = TreeNode::decode(
            vec![0],
            bytes.as_slice(),
            None::<&fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>>,
            grove_version,
        );
        assert!(tree.is_err());
    }
}