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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
//! Merk tree ops

#[cfg(feature = "full")]
use std::{
    collections::{BTreeSet, LinkedList},
    fmt,
};

#[cfg(feature = "full")]
use grovedb_costs::{
    cost_return_on_error, cost_return_on_error_no_add,
    storage_cost::{
        key_value_cost::KeyValueStorageCost,
        removal::{StorageRemovedBytes, StorageRemovedBytes::BasicStorageRemoval},
        StorageCost,
    },
    CostContext, CostResult, CostsExt, OperationCost,
};
use grovedb_version::version::GroveVersion;
#[cfg(feature = "full")]
use integer_encoding::VarInt;
#[cfg(feature = "full")]
use Op::*;

#[cfg(feature = "full")]
use super::{Fetch, Link, TreeNode, Walker};
#[cfg(feature = "full")]
use crate::{error::Error, tree::tree_feature_type::TreeFeatureType, CryptoHash, HASH_LENGTH_U32};
use crate::{
    merk::KeyUpdates,
    tree::kv::{ValueDefinedCostType, ValueDefinedCostType::SpecializedValueDefinedCost},
};

#[cfg(feature = "full")]
/// An operation to be applied to a key in the store.
#[derive(PartialEq, Clone, Eq)]
pub enum Op {
    /// Insert or Update an element into the Merk tree
    Put(Vec<u8>, TreeFeatureType),
    /// Insert or Update an element that is encoded with a special
    /// cost into the Merk tree. This is ideal for sum items where
    /// we want sizes to always be fixed
    PutWithSpecializedCost(Vec<u8>, u32, TreeFeatureType),
    /// `Combined references` include the value in the node hash
    /// because the value is independent of the reference hash
    /// In GroveDB this is used for references
    PutCombinedReference(Vec<u8>, CryptoHash, TreeFeatureType),
    /// `Layered references` include the value in the node hash
    /// because the value is independent of the reference hash
    /// In GroveDB this is used for trees
    /// A layered reference does not pay for the tree's value,
    /// instead providing a cost for the value
    PutLayeredReference(Vec<u8>, u32, CryptoHash, TreeFeatureType),
    /// Replacing a layered reference is slightly more efficient
    /// than putting it as the replace operation will not modify the size
    /// hence there is no need to calculate a difference in
    /// costs
    ReplaceLayeredReference(Vec<u8>, u32, CryptoHash, TreeFeatureType),
    /// Delete an element from the Merk tree
    Delete,
    /// Delete an element from the Merk tree knowing the previous value
    /// costs
    DeleteMaybeSpecialized,
    /// Delete a layered element from the Merk tree, currently the
    /// only layered elements are GroveDB subtrees. A layered
    /// element uses a different calculation for its costs
    DeleteLayered,
    /// Very close to DeleteLayered. A sum layered
    /// element uses a different calculation for its costs.
    DeleteLayeredMaybeSpecialized,
}

#[cfg(feature = "full")]
impl fmt::Debug for Op {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        writeln!(
            f,
            "{}",
            match self {
                Put(value, _) => format!("Put({value:?})"),
                PutWithSpecializedCost(value, cost, feature_type) => format!(
                    "Put Specialized Cost({value:?}) with cost ({cost:?}) for ({feature_type:?})"
                ),
                PutCombinedReference(value, referenced_value, feature_type) => format!(
                    "Put Combined Reference({value:?}) for ({referenced_value:?}). \
                     ({feature_type:?})"
                ),
                PutLayeredReference(value, cost, referenced_value, feature_type) => format!(
                    "Put Layered Reference({value:?}) with cost ({cost:?}) for \
                     ({referenced_value:?}). ({feature_type:?})"
                ),
                ReplaceLayeredReference(value, cost, referenced_value, feature_type) => format!(
                    "Replace Layered Reference({value:?}) with cost ({cost:?}) for \
                     ({referenced_value:?}). ({feature_type:?})"
                ),
                Delete => "Delete".to_string(),
                DeleteLayered => "Delete Layered".to_string(),
                DeleteMaybeSpecialized => "Delete Maybe Specialized".to_string(),
                DeleteLayeredMaybeSpecialized => "Delete Layered Maybe Specialized".to_string(),
            }
        )
    }
}

/// A single `(key, operation)` pair.
pub type BatchEntry<K> = (K, Op);

/// A single `(key, operation, cost)` triple.
pub type AuxBatchEntry<K> = (K, Op, Option<KeyValueStorageCost>);

/// A mapping of keys and operations. Keys should be sorted and unique.
pub type MerkBatch<K> = [BatchEntry<K>];

/// A mapping of keys and operations with potential costs. Keys should be sorted
/// and unique.
pub type AuxMerkBatch<K> = [AuxBatchEntry<K>];

#[cfg(feature = "full")]
/// A source of data which panics when called. Useful when creating a store
/// which always keeps the state in memory.
#[derive(Clone)]
pub struct PanicSource {}

#[cfg(feature = "full")]
impl Fetch for PanicSource {
    fn fetch(
        &self,
        _link: &Link,
        _value_defined_cost_fn: Option<
            &impl Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
        >,
        _grove_version: &GroveVersion,
    ) -> CostResult<TreeNode, Error> {
        unreachable!("'fetch' should not have been called")
    }
}

#[cfg(feature = "full")]
impl<S> Walker<S>
where
    S: Fetch + Sized + Clone,
{
    /// Applies a batch of operations, possibly creating a new tree if
    /// `maybe_tree` is `None`. This is similar to `Walker<S>::apply`, but does
    /// not require a non-empty tree.
    ///
    /// Keys in batch must be sorted and unique.
    pub fn apply_to<K: AsRef<[u8]>, C, V, T, U, R>(
        maybe_tree: Option<Self>,
        batch: &MerkBatch<K>,
        source: S,
        old_tree_cost: &C,
        value_defined_cost_fn: Option<&V>,
        get_temp_new_value_with_old_flags: &T,
        update_tree_value_based_on_costs: &mut U,
        section_removal_bytes: &mut R,
        grove_version: &GroveVersion,
    ) -> CostContext<Result<(Option<TreeNode>, KeyUpdates), Error>>
    where
        C: Fn(&Vec<u8>, &Vec<u8>) -> Result<u32, Error>,
        V: Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
        T: Fn(&Vec<u8>, &Vec<u8>) -> Result<Option<Vec<u8>>, Error>,
        U: FnMut(
            &StorageCost,
            &Vec<u8>,
            &mut Vec<u8>,
        ) -> Result<(bool, Option<ValueDefinedCostType>), Error>,
        R: FnMut(&Vec<u8>, u32, u32) -> Result<(StorageRemovedBytes, StorageRemovedBytes), Error>,
    {
        let mut cost = OperationCost::default();

        let (maybe_walker, key_updates) = if batch.is_empty() {
            (
                maybe_tree,
                KeyUpdates::new(
                    BTreeSet::default(),
                    BTreeSet::default(),
                    LinkedList::default(),
                    None,
                ),
            )
        } else {
            match maybe_tree {
                None => {
                    return Self::build(
                        batch,
                        source,
                        old_tree_cost,
                        value_defined_cost_fn,
                        get_temp_new_value_with_old_flags,
                        update_tree_value_based_on_costs,
                        section_removal_bytes,
                        grove_version,
                    )
                    .map_ok(|tree| {
                        let new_keys: BTreeSet<Vec<u8>> = batch
                            .iter()
                            .map(|batch_entry| batch_entry.0.as_ref().to_vec())
                            .collect();
                        (
                            tree,
                            KeyUpdates::new(
                                new_keys,
                                BTreeSet::default(),
                                LinkedList::default(),
                                None,
                            ),
                        )
                    })
                }
                Some(tree) => {
                    cost_return_on_error!(
                        &mut cost,
                        tree.apply_sorted(
                            batch,
                            old_tree_cost,
                            value_defined_cost_fn,
                            get_temp_new_value_with_old_flags,
                            update_tree_value_based_on_costs,
                            section_removal_bytes,
                            grove_version
                        )
                    )
                }
            }
        };

        let maybe_tree = maybe_walker.map(|walker| walker.into_inner());
        Ok((maybe_tree, key_updates)).wrap_with_cost(cost)
    }

    /// Builds a `Tree` from a batch of operations.
    ///
    /// Keys in batch must be sorted and unique.
    fn build<K: AsRef<[u8]>, C, V, T, U, R>(
        batch: &MerkBatch<K>,
        source: S,
        old_tree_cost: &C,
        value_defined_cost_fn: Option<&V>,
        get_temp_new_value_with_old_flags: &T,
        update_tree_value_based_on_costs: &mut U,
        section_removal_bytes: &mut R,
        grove_version: &GroveVersion,
    ) -> CostResult<Option<TreeNode>, Error>
    where
        C: Fn(&Vec<u8>, &Vec<u8>) -> Result<u32, Error>,
        V: Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
        T: Fn(&Vec<u8>, &Vec<u8>) -> Result<Option<Vec<u8>>, Error>,
        U: FnMut(
            &StorageCost,
            &Vec<u8>,
            &mut Vec<u8>,
        ) -> Result<(bool, Option<ValueDefinedCostType>), Error>,
        R: FnMut(&Vec<u8>, u32, u32) -> Result<(StorageRemovedBytes, StorageRemovedBytes), Error>,
    {
        let mut cost = OperationCost::default();

        if batch.is_empty() {
            return Ok(None).wrap_with_cost(cost);
        }

        let mid_index = batch.len() / 2;
        let (mid_key, mid_op) = &batch[mid_index];
        let (mid_value, mid_feature_type) = match mid_op {
            Delete | DeleteLayered | DeleteLayeredMaybeSpecialized | DeleteMaybeSpecialized => {
                let left_batch = &batch[..mid_index];
                let right_batch = &batch[mid_index + 1..];

                let maybe_tree = cost_return_on_error!(
                    &mut cost,
                    Self::build(
                        left_batch,
                        source.clone(),
                        old_tree_cost,
                        value_defined_cost_fn,
                        get_temp_new_value_with_old_flags,
                        update_tree_value_based_on_costs,
                        section_removal_bytes,
                        grove_version
                    )
                )
                .map(|tree| Self::new(tree, source.clone()));
                let maybe_tree = match maybe_tree {
                    Some(tree) => {
                        cost_return_on_error!(
                            &mut cost,
                            tree.apply_sorted(
                                right_batch,
                                old_tree_cost,
                                value_defined_cost_fn,
                                get_temp_new_value_with_old_flags,
                                update_tree_value_based_on_costs,
                                section_removal_bytes,
                                grove_version
                            )
                        )
                        .0
                    }
                    None => cost_return_on_error!(
                        &mut cost,
                        Self::build(
                            right_batch,
                            source.clone(),
                            old_tree_cost,
                            value_defined_cost_fn,
                            get_temp_new_value_with_old_flags,
                            update_tree_value_based_on_costs,
                            section_removal_bytes,
                            grove_version
                        )
                    )
                    .map(|tree| Self::new(tree, source.clone())),
                };
                return Ok(maybe_tree.map(|tree| tree.into())).wrap_with_cost(cost);
            }
            Put(value, feature_type)
            | PutWithSpecializedCost(value, .., feature_type)
            | PutCombinedReference(value, .., feature_type)
            | PutLayeredReference(value, .., feature_type)
            | ReplaceLayeredReference(value, .., feature_type) => (value.to_vec(), feature_type),
        };

        // TODO: take from batch so we don't have to clone

        let mid_tree = match mid_op {
            Put(..) => TreeNode::new(
                mid_key.as_ref().to_vec(),
                mid_value.to_vec(),
                None,
                mid_feature_type.to_owned(),
            )
            .unwrap_add_cost(&mut cost),
            PutWithSpecializedCost(_, value_cost, _) => TreeNode::new(
                mid_key.as_ref().to_vec(),
                mid_value.to_vec(),
                Some(SpecializedValueDefinedCost(*value_cost)),
                mid_feature_type.to_owned(),
            )
            .unwrap_add_cost(&mut cost),
            PutCombinedReference(_, referenced_value, _) => TreeNode::new_with_combined_value_hash(
                mid_key.as_ref().to_vec(),
                mid_value,
                referenced_value.to_owned(),
                mid_feature_type.to_owned(),
            )
            .unwrap_add_cost(&mut cost),
            PutLayeredReference(_, value_cost, referenced_value, _)
            | ReplaceLayeredReference(_, value_cost, referenced_value, _) => {
                TreeNode::new_with_layered_value_hash(
                    mid_key.as_ref().to_vec(),
                    mid_value,
                    *value_cost,
                    referenced_value.to_owned(),
                    mid_feature_type.to_owned(),
                )
                .unwrap_add_cost(&mut cost)
            }
            Delete | DeleteLayered | DeleteLayeredMaybeSpecialized | DeleteMaybeSpecialized => {
                unreachable!("cannot get here, should return at the top")
            }
        };
        let mid_walker = Walker::new(mid_tree, PanicSource {});

        // use walker, ignore deleted_keys since it should be empty
        Ok(cost_return_on_error!(
            &mut cost,
            mid_walker.recurse(
                batch,
                mid_index,
                true,
                KeyUpdates::new(
                    BTreeSet::default(),
                    BTreeSet::default(),
                    LinkedList::default(),
                    None
                ),
                old_tree_cost,
                value_defined_cost_fn,
                get_temp_new_value_with_old_flags,
                update_tree_value_based_on_costs,
                section_removal_bytes,
                grove_version,
            )
        )
        .0
        .map(|w| w.into_inner()))
        .wrap_with_cost(cost)
    }

    pub(crate) fn apply_sorted_without_costs<K: AsRef<[u8]>>(
        self,
        batch: &MerkBatch<K>,
        grove_version: &GroveVersion,
    ) -> CostResult<(Option<Self>, KeyUpdates), Error> {
        self.apply_sorted(
            batch,
            &|_, _| Ok(0),
            None::<&fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>>,
            &|_, _| Ok(None),
            &mut |_, _, _| Ok((false, None)),
            &mut |_flags, key_bytes_to_remove, value_bytes_to_remove| {
                Ok((
                    BasicStorageRemoval(key_bytes_to_remove),
                    BasicStorageRemoval(value_bytes_to_remove),
                ))
            },
            grove_version,
        )
    }

    /// Applies a batch of operations to an existing tree. This is similar to
    /// `Walker<S>::apply`_to, but requires a populated tree.
    ///
    /// Keys in batch must be sorted and unique.
    fn apply_sorted<K: AsRef<[u8]>, C, V, T, U, R>(
        self,
        batch: &MerkBatch<K>,
        old_specialized_cost: &C,
        value_defined_cost_fn: Option<&V>,
        get_temp_new_value_with_old_flags: &T,
        update_tree_value_based_on_costs: &mut U,
        section_removal_bytes: &mut R,
        grove_version: &GroveVersion,
    ) -> CostResult<(Option<Self>, KeyUpdates), Error>
    where
        C: Fn(&Vec<u8>, &Vec<u8>) -> Result<u32, Error>,
        V: Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
        T: Fn(&Vec<u8>, &Vec<u8>) -> Result<Option<Vec<u8>>, Error>,
        U: FnMut(
            &StorageCost,
            &Vec<u8>,
            &mut Vec<u8>,
        ) -> Result<(bool, Option<ValueDefinedCostType>), Error>,
        R: FnMut(&Vec<u8>, u32, u32) -> Result<(StorageRemovedBytes, StorageRemovedBytes), Error>,
    {
        let mut cost = OperationCost::default();

        let key_vec = self.tree().key().to_vec();
        // binary search to see if this node's key is in the batch, and to split
        // into left and right batches
        let search = batch.binary_search_by(|(key, _op)| key.as_ref().cmp(&key_vec));

        let tree = if let Ok(index) = search {
            let (_, op) = &batch[index];

            // a key matches this node's key, apply op to this node
            match op {
                // TODO: take vec from batch so we don't need to clone
                Put(value, feature_type) => {
                    cost_return_on_error!(
                        &mut cost,
                        self.put_value(
                            value.to_vec(),
                            feature_type.to_owned(),
                            old_specialized_cost,
                            get_temp_new_value_with_old_flags,
                            update_tree_value_based_on_costs,
                            section_removal_bytes,
                        )
                    )
                }

                PutWithSpecializedCost(value, value_cost, feature_type) => {
                    cost_return_on_error!(
                        &mut cost,
                        self.put_value_with_fixed_cost(
                            value.to_vec(),
                            *value_cost,
                            feature_type.to_owned(),
                            old_specialized_cost,
                            get_temp_new_value_with_old_flags,
                            update_tree_value_based_on_costs,
                            section_removal_bytes
                        )
                    )
                }
                PutCombinedReference(value, referenced_value, feature_type) => {
                    cost_return_on_error!(
                        &mut cost,
                        self.put_value_and_reference_value_hash(
                            value.to_vec(),
                            referenced_value.to_owned(),
                            feature_type.to_owned(),
                            old_specialized_cost,
                            get_temp_new_value_with_old_flags,
                            update_tree_value_based_on_costs,
                            section_removal_bytes,
                        )
                    )
                }
                PutLayeredReference(value, value_cost, referenced_value, feature_type)
                | ReplaceLayeredReference(value, value_cost, referenced_value, feature_type) => {
                    cost_return_on_error!(
                        &mut cost,
                        self.put_value_with_reference_value_hash_and_value_cost(
                            value.to_vec(),
                            referenced_value.to_owned(),
                            *value_cost,
                            feature_type.to_owned(),
                            old_specialized_cost,
                            get_temp_new_value_with_old_flags,
                            update_tree_value_based_on_costs,
                            section_removal_bytes,
                        )
                    )
                }
                Delete | DeleteLayered | DeleteLayeredMaybeSpecialized | DeleteMaybeSpecialized => {
                    let source = self.clone_source();

                    let (r_key_cost, r_value_cost) = {
                        let value = self.tree().value_ref();

                        let old_cost = match &batch[index].1 {
                            Delete => self.tree().inner.kv.value_byte_cost_size(),
                            DeleteLayered | DeleteLayeredMaybeSpecialized => {
                                cost_return_on_error_no_add!(
                                    &cost,
                                    old_specialized_cost(&key_vec, value)
                                )
                            }
                            DeleteMaybeSpecialized => {
                                cost_return_on_error_no_add!(
                                    &cost,
                                    old_specialized_cost(&key_vec, value)
                                )
                            }
                            _ => 0, // can't get here anyway
                        };

                        let key_len = key_vec.len() as u32;

                        let prefixed_key_len = HASH_LENGTH_U32 + key_len;
                        let total_key_len =
                            prefixed_key_len + prefixed_key_len.required_space() as u32;
                        let value = self.tree().value_ref();
                        cost_return_on_error_no_add!(
                            &cost,
                            section_removal_bytes(value, total_key_len, old_cost)
                        )
                    };
                    let deletion_cost = KeyValueStorageCost {
                        key_storage_cost: StorageCost {
                            added_bytes: 0,
                            replaced_bytes: 0,
                            removed_bytes: r_key_cost,
                        },
                        value_storage_cost: StorageCost {
                            added_bytes: 0,
                            replaced_bytes: 0,
                            removed_bytes: r_value_cost,
                        },
                        new_node: false,
                        needs_value_verification: false,
                    };

                    let maybe_tree_walker = cost_return_on_error!(
                        &mut cost,
                        self.remove(value_defined_cost_fn, grove_version)
                    );

                    // If there are no more batch updates to the left this means that the index is 0
                    // There would be no key updates to the left of this part of the tree.

                    let (maybe_tree_walker, mut key_updates) = if index == 0 {
                        (
                            maybe_tree_walker,
                            KeyUpdates::new(
                                BTreeSet::default(),
                                BTreeSet::default(),
                                LinkedList::default(),
                                None,
                            ),
                        )
                    } else {
                        match maybe_tree_walker {
                            None => {
                                let new_tree_node = cost_return_on_error!(
                                    &mut cost,
                                    Self::build(
                                        &batch[..index],
                                        source.clone(),
                                        old_specialized_cost,
                                        value_defined_cost_fn,
                                        get_temp_new_value_with_old_flags,
                                        update_tree_value_based_on_costs,
                                        section_removal_bytes,
                                        grove_version,
                                    )
                                );
                                let new_keys: BTreeSet<Vec<u8>> = batch[..index]
                                    .iter()
                                    .map(|batch_entry| batch_entry.0.as_ref().to_vec())
                                    .collect();
                                (
                                    new_tree_node.map(|tree| Self::new(tree, source.clone())),
                                    KeyUpdates::new(
                                        new_keys,
                                        BTreeSet::default(),
                                        LinkedList::default(),
                                        None,
                                    ),
                                )
                            }
                            Some(tree) => {
                                cost_return_on_error!(
                                    &mut cost,
                                    tree.apply_sorted(
                                        &batch[..index],
                                        old_specialized_cost,
                                        value_defined_cost_fn,
                                        get_temp_new_value_with_old_flags,
                                        update_tree_value_based_on_costs,
                                        section_removal_bytes,
                                        grove_version
                                    )
                                )
                            }
                        }
                    };

                    // We not have a new top tree node, and a set of batch operations to the right
                    // of the node

                    let (maybe_tree_walker, mut key_updates_right) = if index == batch.len() - 1 {
                        (
                            maybe_tree_walker,
                            KeyUpdates::new(
                                BTreeSet::default(),
                                BTreeSet::default(),
                                LinkedList::default(),
                                None,
                            ),
                        )
                    } else {
                        match maybe_tree_walker {
                            None => {
                                let new_tree_node = cost_return_on_error!(
                                    &mut cost,
                                    Self::build(
                                        &batch[index + 1..],
                                        source.clone(),
                                        old_specialized_cost,
                                        value_defined_cost_fn,
                                        get_temp_new_value_with_old_flags,
                                        update_tree_value_based_on_costs,
                                        section_removal_bytes,
                                        grove_version,
                                    )
                                );
                                let new_keys: BTreeSet<Vec<u8>> = batch[index + 1..]
                                    .iter()
                                    .map(|batch_entry| batch_entry.0.as_ref().to_vec())
                                    .collect();
                                (
                                    new_tree_node.map(|tree| Self::new(tree, source)),
                                    KeyUpdates::new(
                                        new_keys,
                                        BTreeSet::default(),
                                        LinkedList::default(),
                                        None,
                                    ),
                                )
                            }
                            Some(tree) => {
                                cost_return_on_error!(
                                    &mut cost,
                                    tree.apply_sorted(
                                        &batch[index + 1..],
                                        old_specialized_cost,
                                        value_defined_cost_fn,
                                        get_temp_new_value_with_old_flags,
                                        update_tree_value_based_on_costs,
                                        section_removal_bytes,
                                        grove_version
                                    )
                                )
                            }
                        }
                    };

                    key_updates.new_keys.append(&mut key_updates_right.new_keys);
                    key_updates
                        .updated_keys
                        .append(&mut key_updates_right.updated_keys);
                    key_updates
                        .deleted_keys
                        .append(&mut key_updates_right.deleted_keys);
                    key_updates
                        .deleted_keys
                        .push_back((key_vec.clone(), deletion_cost));
                    key_updates.updated_root_key_from = Some(key_vec);

                    return Ok((maybe_tree_walker, key_updates)).wrap_with_cost(cost);
                }
            }
        } else {
            self
        };

        let (mid, exclusive) = match search {
            Ok(index) => (index, true),
            Err(index) => (index, false),
        };

        let mut updated_keys = BTreeSet::new();
        let mut new_keys = BTreeSet::new();
        if exclusive {
            updated_keys.insert(key_vec);
        } else {
            new_keys.insert(key_vec);
        }

        tree.recurse(
            batch,
            mid,
            exclusive,
            KeyUpdates::new(new_keys, updated_keys, LinkedList::default(), None),
            old_specialized_cost,
            value_defined_cost_fn,
            get_temp_new_value_with_old_flags,
            update_tree_value_based_on_costs,
            section_removal_bytes,
            grove_version,
        )
        .add_cost(cost)
    }

    /// Recursively applies operations to the tree's children (if there are any
    /// operations for them).
    ///
    /// This recursion executes serially in the same thread, but in the future
    /// will be dispatched to workers in other threads.
    fn recurse<K: AsRef<[u8]>, C, V, T, U, R>(
        self,
        batch: &MerkBatch<K>,
        mid: usize,
        exclusive: bool,
        mut key_updates: KeyUpdates,
        old_tree_cost: &C,
        value_defined_cost_fn: Option<&V>,
        get_temp_new_value_with_old_flags: &T,
        update_tree_value_based_on_costs: &mut U,
        section_removal_bytes: &mut R,
        grove_version: &GroveVersion,
    ) -> CostResult<(Option<Self>, KeyUpdates), Error>
    where
        C: Fn(&Vec<u8>, &Vec<u8>) -> Result<u32, Error>,
        T: Fn(&Vec<u8>, &Vec<u8>) -> Result<Option<Vec<u8>>, Error>,
        U: FnMut(
            &StorageCost,
            &Vec<u8>,
            &mut Vec<u8>,
        ) -> Result<(bool, Option<ValueDefinedCostType>), Error>,
        V: Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
        R: FnMut(&Vec<u8>, u32, u32) -> Result<(StorageRemovedBytes, StorageRemovedBytes), Error>,
    {
        let mut cost = OperationCost::default();

        let left_batch = &batch[..mid];
        let right_batch = if exclusive {
            &batch[mid + 1..]
        } else {
            &batch[mid..]
        };

        let old_root_key = self.tree().key().to_vec();

        let tree = if !left_batch.is_empty() {
            let source = self.clone_source();
            cost_return_on_error!(
                &mut cost,
                self.walk(
                    true,
                    |maybe_left| {
                        Self::apply_to(
                            maybe_left,
                            left_batch,
                            source,
                            old_tree_cost,
                            value_defined_cost_fn,
                            get_temp_new_value_with_old_flags,
                            update_tree_value_based_on_costs,
                            section_removal_bytes,
                            grove_version,
                        )
                        .map_ok(|(maybe_left, mut key_updates_left)| {
                            key_updates.new_keys.append(&mut key_updates_left.new_keys);
                            key_updates
                                .updated_keys
                                .append(&mut key_updates_left.updated_keys);
                            key_updates
                                .deleted_keys
                                .append(&mut key_updates_left.deleted_keys);
                            maybe_left
                        })
                    },
                    value_defined_cost_fn,
                    grove_version,
                )
            )
        } else {
            self
        };

        let tree = if !right_batch.is_empty() {
            let source = tree.clone_source();
            cost_return_on_error!(
                &mut cost,
                tree.walk(
                    false,
                    |maybe_right| {
                        Self::apply_to(
                            maybe_right,
                            right_batch,
                            source,
                            old_tree_cost,
                            value_defined_cost_fn,
                            get_temp_new_value_with_old_flags,
                            update_tree_value_based_on_costs,
                            section_removal_bytes,
                            grove_version,
                        )
                        .map_ok(|(maybe_right, mut key_updates_right)| {
                            key_updates.new_keys.append(&mut key_updates_right.new_keys);
                            key_updates
                                .updated_keys
                                .append(&mut key_updates_right.updated_keys);
                            key_updates
                                .deleted_keys
                                .append(&mut key_updates_right.deleted_keys);
                            maybe_right
                        })
                    },
                    value_defined_cost_fn,
                    grove_version
                )
            )
        } else {
            tree
        };

        let tree = cost_return_on_error!(
            &mut cost,
            tree.maybe_balance(value_defined_cost_fn, grove_version)
        );

        let new_root_key = tree.tree().key();

        let updated_from = if !old_root_key.eq(new_root_key) {
            Some(old_root_key)
        } else {
            None
        };
        key_updates.updated_root_key_from = updated_from;

        Ok((Some(tree), key_updates)).wrap_with_cost(cost)
    }

    /// Gets the wrapped tree's balance factor.
    #[inline]
    fn balance_factor(&self) -> i8 {
        self.tree().balance_factor()
    }

    /// Checks if the tree is unbalanced and if so, applies AVL tree rotation(s)
    /// to re-balance the tree and its subtrees. Returns the root node of the
    /// balanced tree after applying the rotations.
    fn maybe_balance<V>(
        self,
        value_defined_cost_fn: Option<&V>,
        grove_version: &GroveVersion,
    ) -> CostResult<Self, Error>
    where
        V: Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
    {
        let mut cost = OperationCost::default();

        let balance_factor = self.balance_factor();
        if balance_factor.abs() <= 1 {
            return Ok(self).wrap_with_cost(cost);
        }

        let left = balance_factor < 0;

        // maybe do a double rotation
        let tree = if left == (self.tree().link(left).unwrap().balance_factor() > 0) {
            cost_return_on_error!(
                &mut cost,
                self.walk_expect(
                    left,
                    |child| child
                        .rotate(!left, value_defined_cost_fn, grove_version)
                        .map_ok(Some),
                    value_defined_cost_fn,
                    grove_version,
                )
            )
        } else {
            self
        };

        let rotate = tree
            .rotate(left, value_defined_cost_fn, grove_version)
            .unwrap_add_cost(&mut cost);
        rotate.wrap_with_cost(cost)
    }

    /// Applies an AVL tree rotation, a constant-time operation which only needs
    /// to swap pointers in order to re-balance a tree.
    fn rotate<V>(
        self,
        left: bool,
        value_defined_cost_fn: Option<&V>,
        grove_version: &GroveVersion,
    ) -> CostResult<Self, Error>
    where
        V: Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
    {
        let mut cost = OperationCost::default();

        let (tree, child) = cost_return_on_error!(
            &mut cost,
            self.detach_expect(left, value_defined_cost_fn, grove_version)
        );
        let (child, maybe_grandchild) = cost_return_on_error!(
            &mut cost,
            child.detach(!left, value_defined_cost_fn, grove_version)
        );

        // attach grandchild to self
        tree.attach(left, maybe_grandchild)
            .maybe_balance(value_defined_cost_fn, grove_version)
            .flat_map_ok(|tree| {
                // attach self to child, return child
                child
                    .attach(!left, Some(tree))
                    .maybe_balance(value_defined_cost_fn, grove_version)
            })
            .add_cost(cost)
    }

    /// Removes the root node from the tree. Rearranges and re-balances
    /// descendants (if any) in order to maintain a valid tree.
    pub fn remove<V>(
        self,
        value_defined_cost_fn: Option<&V>,
        grove_version: &GroveVersion,
    ) -> CostResult<Option<Self>, Error>
    where
        V: Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
    {
        let mut cost = OperationCost::default();

        let tree = self.tree();
        let has_left = tree.link(true).is_some();
        let has_right = tree.link(false).is_some();
        let left = tree.child_height(true) > tree.child_height(false);

        let maybe_tree = if has_left && has_right {
            // two children, promote edge of taller child
            let (tree, tall_child) = cost_return_on_error!(
                &mut cost,
                self.detach_expect(left, value_defined_cost_fn, grove_version)
            );
            let (_, short_child) = cost_return_on_error!(
                &mut cost,
                tree.detach_expect(!left, value_defined_cost_fn, grove_version)
            );
            let promoted = cost_return_on_error!(
                &mut cost,
                tall_child.promote_edge(!left, short_child, value_defined_cost_fn, grove_version)
            );
            Some(promoted)
        } else if has_left || has_right {
            // single child, promote it
            Some(
                cost_return_on_error!(
                    &mut cost,
                    self.detach_expect(left, value_defined_cost_fn, grove_version)
                )
                .1,
            )
        } else {
            // no child
            None
        };

        Ok(maybe_tree).wrap_with_cost(cost)
    }

    /// Traverses to find the tree's edge on the given side, removes it, and
    /// reattaches it at the top in order to fill in a gap when removing a root
    /// node from a tree with both left and right children. Attaches `attach` on
    /// the opposite side. Returns the promoted node.
    fn promote_edge<V>(
        self,
        left: bool,
        attach: Self,
        value_defined_cost_fn: Option<&V>,
        grove_version: &GroveVersion,
    ) -> CostResult<Self, Error>
    where
        V: Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
    {
        self.remove_edge(left, value_defined_cost_fn, grove_version)
            .flat_map_ok(|(edge, maybe_child)| {
                edge.attach(!left, maybe_child)
                    .attach(left, Some(attach))
                    .maybe_balance(value_defined_cost_fn, grove_version)
            })
    }

    /// Traverses to the tree's edge on the given side and detaches it
    /// (reattaching its child, if any, to its former parent). Return value is
    /// `(edge, maybe_updated_tree)`.
    fn remove_edge<V>(
        self,
        left: bool,
        value_defined_cost_fn: Option<&V>,
        grove_version: &GroveVersion,
    ) -> CostResult<(Self, Option<Self>), Error>
    where
        V: Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,
    {
        let mut cost = OperationCost::default();

        if self.tree().link(left).is_some() {
            // this node is not the edge, recurse
            let (tree, child) = cost_return_on_error!(
                &mut cost,
                self.detach_expect(left, value_defined_cost_fn, grove_version)
            );
            let (edge, maybe_child) = cost_return_on_error!(
                &mut cost,
                child.remove_edge(left, value_defined_cost_fn, grove_version)
            );
            tree.attach(left, maybe_child)
                .maybe_balance(value_defined_cost_fn, grove_version)
                .map_ok(|tree| (edge, Some(tree)))
                .add_cost(cost)
        } else {
            // this node is the edge, detach its child if present
            self.detach(!left, value_defined_cost_fn, grove_version)
        }
    }
}

#[cfg(feature = "full")]
#[cfg(test)]
mod test {
    use super::*;
    use crate::{
        test_utils::{apply_memonly, assert_tree_invariants, del_entry, make_tree_seq, seq_key},
        tree::{tree_feature_type::TreeFeatureType::BasicMerkNode, *},
    };

    #[test]
    fn simple_insert() {
        let grove_version = GroveVersion::latest();
        let batch = [(b"foo2".to_vec(), Put(b"bar2".to_vec(), BasicMerkNode))];
        let tree = TreeNode::new(b"foo".to_vec(), b"bar".to_vec(), None, BasicMerkNode).unwrap();
        let (maybe_walker, key_updates) = Walker::new(tree, PanicSource {})
            .apply_sorted_without_costs(&batch, grove_version)
            .unwrap()
            .expect("apply errored");
        let walker = maybe_walker.expect("should be Some");
        assert_eq!(walker.tree().key(), b"foo");
        assert_eq!(walker.into_inner().child(false).unwrap().key(), b"foo2");
        assert!(key_updates.updated_keys.is_empty());
        assert!(key_updates.deleted_keys.is_empty());
        assert_eq!(key_updates.new_keys.len(), 2)
    }

    #[test]
    fn simple_update() {
        let grove_version = GroveVersion::latest();
        let batch = [(b"foo".to_vec(), Put(b"bar2".to_vec(), BasicMerkNode))];
        let tree = TreeNode::new(b"foo".to_vec(), b"bar".to_vec(), None, BasicMerkNode).unwrap();
        let (maybe_walker, key_updates) = Walker::new(tree, PanicSource {})
            .apply_sorted_without_costs(&batch, grove_version)
            .unwrap()
            .expect("apply errored");
        let walker = maybe_walker.expect("should be Some");
        assert_eq!(walker.tree().key(), b"foo");
        assert_eq!(walker.tree().value_as_slice(), b"bar2");
        assert!(walker.tree().link(true).is_none());
        assert!(walker.tree().link(false).is_none());
        assert!(!key_updates.updated_keys.is_empty());
        assert!(key_updates.deleted_keys.is_empty());
    }

    #[test]
    fn simple_delete() {
        let grove_version = GroveVersion::latest();
        let batch = [(b"foo2".to_vec(), Delete)];
        let tree = TreeNode::from_fields(
            b"foo".to_vec(),
            b"bar".to_vec(),
            [123; 32],
            None,
            Some(Link::Loaded {
                hash: [123; 32],
                sum: None,
                child_heights: (0, 0),
                tree: TreeNode::new(b"foo2".to_vec(), b"bar2".to_vec(), None, BasicMerkNode)
                    .unwrap(),
            }),
            BasicMerkNode,
        )
        .unwrap();
        let (maybe_walker, key_updates) = Walker::new(tree, PanicSource {})
            .apply_sorted_without_costs(&batch, grove_version)
            .unwrap()
            .expect("apply errored");
        let walker = maybe_walker.expect("should be Some");
        assert_eq!(walker.tree().key(), b"foo");
        assert_eq!(walker.tree().value_as_slice(), b"bar");
        assert!(walker.tree().link(true).is_none());
        assert!(walker.tree().link(false).is_none());
        assert!(key_updates.updated_keys.is_empty());
        assert_eq!(key_updates.deleted_keys.len(), 1);
        assert_eq!(
            key_updates.deleted_keys.front().unwrap().0.as_slice(),
            b"foo2"
        );
    }

    #[test]
    fn delete_non_existent() {
        let grove_version = GroveVersion::latest();
        let batch = [(b"foo2".to_vec(), Delete)];
        let tree = TreeNode::new(b"foo".to_vec(), b"bar".to_vec(), None, BasicMerkNode).unwrap();
        Walker::new(tree, PanicSource {})
            .apply_sorted_without_costs(&batch, grove_version)
            .unwrap()
            .unwrap();
    }

    #[test]
    fn delete_only_node() {
        let grove_version = GroveVersion::latest();
        let batch = [(b"foo".to_vec(), Delete)];
        let tree = TreeNode::new(b"foo".to_vec(), b"bar".to_vec(), None, BasicMerkNode).unwrap();
        let (maybe_walker, key_updates) = Walker::new(tree, PanicSource {})
            .apply_sorted_without_costs(&batch, grove_version)
            .unwrap()
            .expect("apply errored");
        assert!(maybe_walker.is_none());
        assert!(key_updates.updated_keys.is_empty());
        assert_eq!(key_updates.deleted_keys.len(), 1);
        assert_eq!(
            key_updates.deleted_keys.front().unwrap().0.as_slice(),
            b"foo"
        );
    }

    #[test]
    fn delete_deep() {
        let grove_version = GroveVersion::latest();
        let tree = make_tree_seq(50, grove_version);
        let batch = [del_entry(5)];
        let (maybe_walker, key_updates) = Walker::new(tree, PanicSource {})
            .apply_sorted_without_costs(&batch, grove_version)
            .unwrap()
            .expect("apply errored");
        maybe_walker.expect("should be Some");
        assert!(key_updates.updated_keys.is_empty());
        assert_eq!(key_updates.deleted_keys.len(), 1);
        assert_eq!(
            key_updates.deleted_keys.front().unwrap().0.as_slice(),
            seq_key(5)
        );
    }

    #[test]
    fn delete_recursive() {
        let grove_version = GroveVersion::latest();
        let tree = make_tree_seq(50, grove_version);
        let batch = [del_entry(29), del_entry(34)];
        let (maybe_walker, mut key_updates) = Walker::new(tree, PanicSource {})
            .apply_sorted_without_costs(&batch, grove_version)
            .unwrap()
            .expect("apply errored");
        maybe_walker.expect("should be Some");
        assert!(key_updates.updated_keys.is_empty());
        assert_eq!(key_updates.deleted_keys.len(), 2);
        assert_eq!(
            key_updates.deleted_keys.pop_front().unwrap().0.as_slice(),
            seq_key(29)
        );
        assert_eq!(
            key_updates.deleted_keys.pop_front().unwrap().0.as_slice(),
            seq_key(34)
        );
    }

    #[test]
    fn delete_recursive_2() {
        let grove_version = GroveVersion::latest();
        let tree = make_tree_seq(10, grove_version);
        let batch = [del_entry(7), del_entry(9)];
        let (maybe_walker, key_updates) = Walker::new(tree, PanicSource {})
            .apply_sorted_without_costs(&batch, grove_version)
            .unwrap()
            .expect("apply errored");
        maybe_walker.expect("should be Some");
        let mut deleted_keys: Vec<&Vec<u8>> =
            key_updates.deleted_keys.iter().map(|(v, _)| v).collect();
        deleted_keys.sort();
        assert!(key_updates.updated_keys.is_empty());
        assert_eq!(deleted_keys, vec![&seq_key(7), &seq_key(9)]);
    }

    #[test]
    fn apply_empty_none() {
        let grove_version = GroveVersion::latest();
        let (maybe_tree, key_updates) = Walker::<PanicSource>::apply_to::<Vec<u8>, _, _, _, _, _>(
            None,
            &[],
            PanicSource {},
            &|_, _| Ok(0),
            None::<&fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>>,
            &|_, _| Ok(None),
            &mut |_, _, _| Ok((false, None)),
            &mut |_flags, key_bytes_to_remove, value_bytes_to_remove| {
                Ok((
                    BasicStorageRemoval(key_bytes_to_remove),
                    BasicStorageRemoval(value_bytes_to_remove),
                ))
            },
            grove_version,
        )
        .unwrap()
        .expect("apply_to failed");
        assert!(maybe_tree.is_none());
        assert!(key_updates.updated_keys.is_empty());
        assert!(key_updates.deleted_keys.is_empty());
    }

    #[test]
    fn insert_empty_single() {
        let grove_version = GroveVersion::latest();
        let batch = vec![(vec![0], Put(vec![1], BasicMerkNode))];
        let (maybe_tree, key_updates) = Walker::<PanicSource>::apply_to(
            None,
            &batch,
            PanicSource {},
            &|_, _| Ok(0),
            None::<&fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>>,
            &|_, _| Ok(None),
            &mut |_, _, _| Ok((false, None)),
            &mut |_flags, key_bytes_to_remove, value_bytes_to_remove| {
                Ok((
                    BasicStorageRemoval(key_bytes_to_remove),
                    BasicStorageRemoval(value_bytes_to_remove),
                ))
            },
            grove_version,
        )
        .unwrap()
        .expect("apply_to failed");
        let tree = maybe_tree.expect("expected tree");
        assert_eq!(tree.key(), &[0]);
        assert_eq!(tree.value_as_slice(), &[1]);
        assert_tree_invariants(&tree);
        assert!(key_updates.updated_keys.is_empty());
        assert!(key_updates.deleted_keys.is_empty());
    }

    #[test]
    fn insert_updated_single() {
        let grove_version = GroveVersion::latest();
        let batch = vec![(vec![0], Put(vec![1], BasicMerkNode))];
        let (maybe_tree, key_updates) = Walker::<PanicSource>::apply_to(
            None,
            &batch,
            PanicSource {},
            &|_, _| Ok(0),
            None::<&fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>>,
            &|_, _| Ok(None),
            &mut |_, _, _| Ok((false, None)),
            &mut |_flags, key_bytes_to_remove, value_bytes_to_remove| {
                Ok((
                    BasicStorageRemoval(key_bytes_to_remove),
                    BasicStorageRemoval(value_bytes_to_remove),
                ))
            },
            grove_version,
        )
        .unwrap()
        .expect("apply_to failed");
        assert!(key_updates.updated_keys.is_empty());
        assert!(key_updates.deleted_keys.is_empty());

        let maybe_walker = maybe_tree.map(|tree| Walker::<PanicSource>::new(tree, PanicSource {}));
        let batch = vec![
            (vec![0], Put(vec![2], BasicMerkNode)),
            (vec![1], Put(vec![2], BasicMerkNode)),
        ];
        let (maybe_tree, key_updates) = Walker::<PanicSource>::apply_to(
            maybe_walker,
            &batch,
            PanicSource {},
            &|_, _| Ok(0),
            None::<&fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>>,
            &|_, _| Ok(None),
            &mut |_, _, _| Ok((false, None)),
            &mut |_flags, key_bytes_to_remove, value_bytes_to_remove| {
                Ok((
                    BasicStorageRemoval(key_bytes_to_remove),
                    BasicStorageRemoval(value_bytes_to_remove),
                ))
            },
            grove_version,
        )
        .unwrap()
        .expect("apply_to failed");
        let tree = maybe_tree.expect("expected tree");
        assert_eq!(tree.key(), &[0]);
        assert_eq!(tree.value_as_slice(), &[2]);
        assert_eq!(key_updates.updated_keys.len(), 1);
        assert!(key_updates.deleted_keys.is_empty());
    }

    #[test]
    fn insert_updated_multiple() {
        let grove_version = GroveVersion::latest();
        let batch = vec![
            (vec![0], Put(vec![1], BasicMerkNode)),
            (vec![1], Put(vec![2], BasicMerkNode)),
            (vec![2], Put(vec![3], BasicMerkNode)),
        ];
        let (maybe_tree, key_updates) = Walker::<PanicSource>::apply_to(
            None,
            &batch,
            PanicSource {},
            &|_, _| Ok(0),
            None::<&fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>>,
            &|_, _| Ok(None),
            &mut |_, _, _| Ok((false, None)),
            &mut |_flags, key_bytes_to_remove, value_bytes_to_remove| {
                Ok((
                    BasicStorageRemoval(key_bytes_to_remove),
                    BasicStorageRemoval(value_bytes_to_remove),
                ))
            },
            grove_version,
        )
        .unwrap()
        .expect("apply_to failed");
        assert!(key_updates.updated_keys.is_empty());
        assert!(key_updates.deleted_keys.is_empty());

        let maybe_walker = maybe_tree.map(|tree| Walker::<PanicSource>::new(tree, PanicSource {}));
        let batch = vec![
            (vec![0], Put(vec![5], BasicMerkNode)),
            (vec![1], Put(vec![8], BasicMerkNode)),
            (vec![2], Delete),
        ];
        let (maybe_tree, key_updates) = Walker::<PanicSource>::apply_to(
            maybe_walker,
            &batch,
            PanicSource {},
            &|_, _| Ok(0),
            None::<&fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>>,
            &|_, _| Ok(None),
            &mut |_, _, _| Ok((false, None)),
            &mut |_flags, key_bytes_to_remove, value_bytes_to_remove| {
                Ok((
                    BasicStorageRemoval(key_bytes_to_remove),
                    BasicStorageRemoval(value_bytes_to_remove),
                ))
            },
            grove_version,
        )
        .unwrap()
        .expect("apply_to failed");
        let tree = maybe_tree.expect("expected tree");
        assert_eq!(tree.key(), &[1]);
        assert_eq!(tree.value_as_slice(), &[8]);
        assert_eq!(key_updates.updated_keys.len(), 2);
        assert_eq!(key_updates.updated_keys, BTreeSet::from([vec![0], vec![1]]));
        assert_eq!(key_updates.deleted_keys.len(), 1);
    }

    #[test]
    fn insert_root_single() {
        let grove_version = GroveVersion::latest();
        let tree = TreeNode::new(vec![5], vec![123], None, BasicMerkNode).unwrap();
        let batch = vec![(vec![6], Put(vec![123], BasicMerkNode))];
        let tree = apply_memonly(tree, &batch, grove_version);
        assert_eq!(tree.key(), &[5]);
        assert!(tree.child(true).is_none());
        assert_eq!(tree.child(false).expect("expected child").key(), &[6]);
    }

    #[test]
    fn insert_root_double() {
        let grove_version = GroveVersion::latest();
        let tree = TreeNode::new(vec![5], vec![123], None, BasicMerkNode).unwrap();
        let batch = vec![
            (vec![4], Put(vec![123], BasicMerkNode)),
            (vec![6], Put(vec![123], BasicMerkNode)),
        ];
        let tree = apply_memonly(tree, &batch, grove_version);
        assert_eq!(tree.key(), &[5]);
        assert_eq!(tree.child(true).expect("expected child").key(), &[4]);
        assert_eq!(tree.child(false).expect("expected child").key(), &[6]);
    }

    #[test]
    fn insert_rebalance() {
        let grove_version = GroveVersion::latest();
        let tree = TreeNode::new(vec![5], vec![123], None, BasicMerkNode).unwrap();

        let batch = vec![(vec![6], Put(vec![123], BasicMerkNode))];
        let tree = apply_memonly(tree, &batch, grove_version);

        let batch = vec![(vec![7], Put(vec![123], BasicMerkNode))];
        let tree = apply_memonly(tree, &batch, grove_version);

        assert_eq!(tree.key(), &[6]);
        assert_eq!(tree.child(true).expect("expected child").key(), &[5]);
        assert_eq!(tree.child(false).expect("expected child").key(), &[7]);
    }

    #[test]
    fn insert_100_sequential() {
        let grove_version = GroveVersion::latest();
        let mut tree = TreeNode::new(vec![0], vec![123], None, BasicMerkNode).unwrap();

        for i in 0..100 {
            let batch = vec![(vec![i + 1], Put(vec![123], BasicMerkNode))];
            tree = apply_memonly(tree, &batch, grove_version);
        }

        assert_eq!(tree.key(), &[63]);
        assert_eq!(tree.child(true).expect("expected child").key(), &[31]);
        assert_eq!(tree.child(false).expect("expected child").key(), &[79]);
    }
}