neptune-mutator-set 0.14.0

The mutator set, a privacy-preserving cryptographic accumulator invented by the Neptune team. Paper: https://eprint.iacr.org/2023/1208 Article: https://neptune.cash/articles/mutator-sets
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
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
use std::collections::HashMap;
use std::collections::HashSet;
use std::error::Error;
use std::fmt;
use std::ops::IndexMut;

#[cfg(any(test, feature = "arbitrary-impls"))]
use arbitrary::Arbitrary;
use get_size2::GetSize;
use itertools::Itertools;
use serde::Deserialize;
use serde::Serialize;
use tasm_lib::prelude::Tip5;
use tasm_lib::structure::tasm_object::TasmObject;
use tasm_lib::twenty_first::math::bfield_codec::BFieldCodec;
use tasm_lib::twenty_first::tip5::digest::Digest;
use tasm_lib::twenty_first::util_types::mmr;
use tasm_lib::twenty_first::util_types::mmr::mmr_accumulator::MmrAccumulator;
use tasm_lib::twenty_first::util_types::mmr::mmr_membership_proof::MmrMembershipProof;
use tasm_lib::twenty_first::util_types::mmr::mmr_trait::LeafMutation;
use tasm_lib::twenty_first::util_types::mmr::mmr_trait::Mmr;

use super::addition_record::AdditionRecord;
use super::commit;
use super::mutator_set_accumulator::MutatorSetAccumulator;
use super::removal_record::absolute_index_set::AbsoluteIndexSet;
use super::removal_record::chunk_dictionary::ChunkDictionary;
use super::removal_record::RemovalRecord;
use super::shared::get_batch_mutation_argument_for_removal_record;
use super::shared::prepare_authenticated_batch_modification_for_removal_record_reversion;
use super::shared::BATCH_SIZE;
use super::shared::CHUNK_SIZE;

impl Error for MembershipProofError {}

impl fmt::Display for MembershipProofError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:?}", self)
    }
}

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum MembershipProofError {
    AlreadyExistingChunk(u64),
    MissingChunkOnUpdateFromAdd(u64),
}

// In order to store this structure in the database, it needs to be serializable.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, GetSize, BFieldCodec, TasmObject)]
#[cfg_attr(any(test, feature = "arbitrary-impls"), derive(Arbitrary))]
pub struct MsMembershipProof {
    pub sender_randomness: Digest,
    pub receiver_preimage: Digest,
    pub auth_path_aocl: MmrMembershipProof,
    pub aocl_leaf_index: u64,
    pub target_chunks: ChunkDictionary,
}

impl MsMembershipProof {
    pub fn addition_record(&self, item: Digest) -> AdditionRecord {
        commit(item, self.sender_randomness, self.receiver_preimage.hash())
    }

    /// Compute the indices that will be added to the SWBF if this item is removed.
    pub fn compute_indices(&self, item: Digest) -> AbsoluteIndexSet {
        AbsoluteIndexSet::compute(
            item,
            self.sender_randomness,
            self.receiver_preimage,
            self.aocl_leaf_index,
        )
    }

    /// Update a list of membership proofs in anticipation of an addition. If successful,
    /// return (wrapped in an Ok) a vector of all indices of updated membership proofs.
    pub fn batch_update_from_addition(
        membership_proofs: &mut [&mut Self],
        own_items: &[Digest],
        mutator_set: &MutatorSetAccumulator,
        addition_record: &AdditionRecord,
    ) -> Result<Vec<usize>, Box<dyn Error>> {
        assert!(
            membership_proofs
                .iter()
                .all(|mp| mp.aocl_leaf_index < mutator_set.aocl.num_leafs()),
            "No AOCL data index can point outside of provided mutator set. aocl leaf count: {}; mp leaf indices: {}",
            mutator_set.aocl.num_leafs(),
            membership_proofs.iter().map(|x| x.aocl_leaf_index.to_string()).join(",")
        );
        assert_eq!(
            membership_proofs.len(),
            own_items.len(),
            "Function must be called with same number of membership proofs and items. Got {} items and {} membership proofs", own_items.len(), membership_proofs.len()
        );

        debug_assert!(membership_proofs
            .iter()
            .all(|msmp| msmp
                .target_chunks
                .iter()
                .all(|(chunk_index, (mmr_mp, chunk))| mmr_mp.verify(
                    *chunk_index,
                    Tip5::hash(chunk),
                    &mutator_set.swbf_inactive.peaks(),
                    mutator_set.swbf_inactive.num_leafs()
                ))));

        let new_item_index = mutator_set.aocl.num_leafs();

        // Update AOCL MMR membership proofs
        let leaf_indices = membership_proofs
            .iter()
            .map(|msmp| msmp.aocl_leaf_index)
            .collect_vec();
        let indices_for_mps_updated_from_append = MmrMembershipProof::batch_update_from_append(
            &mut membership_proofs
                .iter_mut()
                .map(|msmp| &mut msmp.auth_path_aocl)
                .collect::<Vec<_>>(),
            &leaf_indices,
            new_item_index,
            addition_record.canonical_commitment,
            &mutator_set.aocl.peaks(),
        );

        // if window does not slide, we are done
        if !MutatorSetAccumulator::window_slides(new_item_index) {
            return Ok(indices_for_mps_updated_from_append);
        }

        let new_item_index2 = mutator_set.aocl.num_leafs();

        // window does slide
        let next_batch_index = new_item_index2 / u64::from(BATCH_SIZE);
        let current_batch_index = next_batch_index - 1;
        assert_eq!(
            current_batch_index,
            mutator_set.swbf_inactive.num_leafs(),
            "Number of SWBF MMR leafs must match current batch index"
        );
        let new_chunk = mutator_set.swbf_active.slid_chunk();
        let new_chunk_digest: Digest = Tip5::hash(&new_chunk);

        // Insert the new chunk digest into the accumulator-version of the
        // SWBF MMR to get its authentication path. It's important to convert the MMR
        // to an MMR Accumulator here, since we don't want to drag around or clone
        // a whole archival MMR for this operation, as the archival MMR can be in the
        // size of gigabytes, whereas the MMR accumulator should be in the size of
        // kilobytes.
        let mut updated_mmra: MmrAccumulator = mutator_set.swbf_inactive.to_accumulator();
        let new_chunk_auth_path: MmrMembershipProof = updated_mmra.append(new_chunk_digest);

        // Collect all indices for all membership proofs that are being updated
        // Notice that this is a *very* expensive operation if the indices are
        // not already known. I.e., the `None` case below is very expensive.
        let mut chunk_index_to_mp_index: HashMap<u64, Vec<usize>> = HashMap::new();
        membership_proofs
            .iter()
            .zip(own_items.iter())
            .enumerate()
            .for_each(|(i, (mp, &item))| {
                let absolute_indices = AbsoluteIndexSet::compute(
                    item,
                    mp.sender_randomness,
                    mp.receiver_preimage,
                    mp.aocl_leaf_index,
                );
                for chunk_index in absolute_indices
                    .to_array()
                    .iter()
                    .map(|x| (*x / u128::from(CHUNK_SIZE)) as u64)
                    .unique()
                {
                    chunk_index_to_mp_index
                        .entry(chunk_index)
                        .or_default()
                        .push(i)
                }
            });

        // Find the indices of the mutator set membership proofs whose
        // `target_chunks` field needs a new dictionary entry for the slid chunk.
        let indices_for_mps_with_new_chunk_dictionary_entry: Vec<usize> =
            match chunk_index_to_mp_index.get(&current_batch_index) {
                Some(vals) => vals.clone(),
                None => vec![],
            };

        // Find the membership proofs that have dictionary entry MMR membership proofs that need
        // to be updated because of the window sliding. We just
        let mut mps_for_batch_append: HashSet<usize> = HashSet::new();
        for (chunk_index, mp_indices) in chunk_index_to_mp_index {
            if chunk_index < current_batch_index {
                for mp_index in mp_indices {
                    mps_for_batch_append.insert(mp_index);
                }
            }
        }

        // Perform the updates

        // First insert the new entry into the chunk dictionary for the membership
        // proofs that need it.
        for i in &indices_for_mps_with_new_chunk_dictionary_entry {
            membership_proofs.index_mut(*i).target_chunks.insert(
                current_batch_index,
                (new_chunk_auth_path.clone(), new_chunk.clone()),
            );
        }

        // Collect those MMR membership proofs for chunks whose authentication
        // path might need to be updated due to the insertion of a new leaf in the
        // SWBF MMR.
        // This is a bit ugly and a bit slower than it could be. To prevent this
        // for-loop, you probably could collect the `Vec<&mut mp>` in the code above,
        // instead of just collecting the indices into the membership proof vector.
        // It is, however, quite acceptable that many of the MMR membership proofs are
        // repeated since the MMR `batch_update_from_append` handles this optimally.
        // So relegating that bookkeeping to this function instead would not be more
        // efficient.
        let mut mmr_membership_proofs_for_append: Vec<
            &mut mmr::mmr_membership_proof::MmrMembershipProof,
        > = vec![];

        // The `mmr_mp_index_to_ms_mp_index` variable remembers
        // which MMR membership proofs that map to MS membership proofs. This is
        // required to return the indices of the MS membership proofs that have been updated
        // by this function call.
        let mut mmr_mp_index_to_ms_mp_index = vec![];
        let mut mmr_membership_indices = vec![];
        for (i, mp) in membership_proofs.iter_mut().enumerate() {
            if mps_for_batch_append.contains(&i) {
                for (chunk_index, (mmr_mp, _chunk)) in mp.target_chunks.iter_mut() {
                    if *chunk_index != current_batch_index {
                        mmr_membership_proofs_for_append.push(mmr_mp);
                        mmr_membership_indices.push(*chunk_index);
                        mmr_mp_index_to_ms_mp_index.push(i as u64);
                    }
                }
            }
        }

        let indices_for_modified_paths =
            mmr::mmr_membership_proof::MmrMembershipProof::batch_update_from_append(
                &mut mmr_membership_proofs_for_append,
                &mmr_membership_indices,
                mutator_set.swbf_inactive.num_leafs(),
                new_chunk_digest,
                &mutator_set.swbf_inactive.peaks(),
            );

        let mut indices_for_mps_with_updated_swbf_auth_paths = vec![];
        for j in indices_for_modified_paths {
            indices_for_mps_with_updated_swbf_auth_paths
                .push(mmr_mp_index_to_ms_mp_index[j] as usize);
        }

        // Gather the indices the are returned. These indices indicate which membership
        // proofs that have been mutated.
        let mut all_mutated_mp_indices = [
            indices_for_mps_updated_from_append,
            indices_for_mps_with_updated_swbf_auth_paths,
            indices_for_mps_with_new_chunk_dictionary_entry,
        ]
        .concat();
        all_mutated_mp_indices.sort_unstable();
        all_mutated_mp_indices.dedup();

        Ok(all_mutated_mp_indices)
    }

    /// Update a membership proof in anticipation of an addition to the set and
    /// return, wrapped in a `Result`, whether something was updated.
    pub fn update_from_addition(
        &mut self,
        own_item: Digest,
        mutator_set: &MutatorSetAccumulator,
        addition_record: &AdditionRecord,
    ) -> Result<bool, Box<dyn Error>> {
        assert!(self.aocl_leaf_index < mutator_set.aocl.num_leafs());
        let new_item_aocl_index = mutator_set.aocl.num_leafs();

        // Update AOCL MMR membership proof
        let aocl_mp_updated = self.auth_path_aocl.update_from_append(
            self.aocl_leaf_index,
            mutator_set.aocl.num_leafs(),
            addition_record.canonical_commitment,
            &mutator_set.aocl.peaks(),
        );

        // if window does not slide, we are done
        if !MutatorSetAccumulator::window_slides(new_item_aocl_index) {
            return Ok(aocl_mp_updated);
        }

        // window does slide
        let new_chunk = mutator_set.swbf_active.slid_chunk();
        let new_chunk_digest: Digest = Tip5::hash(&new_chunk);

        // Get Bloom filter indices by recalculating them.
        let all_indices = AbsoluteIndexSet::compute(
            own_item,
            self.sender_randomness,
            self.receiver_preimage,
            self.aocl_leaf_index,
        )
        .to_array();
        let chunk_indices_set: HashSet<u64> = all_indices
            .map(|bi| (bi / u128::from(CHUNK_SIZE)) as u64)
            .into_iter()
            .collect::<HashSet<u64>>();

        // Insert the new SWBF leaf into a duplicate of the SWBFI MMRA to get
        // the new leaf's authentication path.
        let mut swbfi_mmra: MmrAccumulator = mutator_set.swbf_inactive.to_accumulator();
        let new_leaf_index = swbfi_mmra.num_leafs();
        let new_auth_path: mmr::mmr_membership_proof::MmrMembershipProof =
            swbfi_mmra.append(new_chunk_digest);

        let mut swbf_chunk_dictionary_updated = false;
        let batch_index = new_item_aocl_index / u64::from(BATCH_SIZE);
        let old_window_start_batch_index = batch_index - 1;

        // Sanity check: assert that the new SWBFI leaf index agrees with the
        // batch index of the old window. If these disagree, then the mutator
        // set accumulator is in an inconsistent state.
        assert_eq!(
            new_leaf_index, old_window_start_batch_index,
            "corrupt mutator set accumulator"
        );
        'outer: for chunk_index in chunk_indices_set {
            // Update for indices that are in the inactive part of the SWBF.
            // Here the MMR membership proofs of the chunks must be updated.
            if chunk_index < old_window_start_batch_index {
                let mp = match self.target_chunks.get_mut(&chunk_index) {
                    // If this record is not found, the MembershipProof is in a broken
                    // state.
                    None => {
                        return Err(Box::new(MembershipProofError::MissingChunkOnUpdateFromAdd(
                            chunk_index,
                        )))
                    }
                    Some((m, _chnk)) => m,
                };
                let swbf_chunk_dict_updated_local: bool = mp.update_from_append(
                    chunk_index,
                    mutator_set.swbf_inactive.num_leafs(),
                    new_chunk_digest,
                    &mutator_set.swbf_inactive.peaks(),
                );
                swbf_chunk_dictionary_updated =
                    swbf_chunk_dictionary_updated || swbf_chunk_dict_updated_local;

                continue 'outer;
            }

            // if index is in the part that is becoming inactive, add a dictionary entry
            if chunk_index == new_leaf_index {
                if self.target_chunks.contains_key(&chunk_index) {
                    return Err(Box::new(MembershipProofError::AlreadyExistingChunk(
                        chunk_index,
                    )));
                }

                // add dictionary entry
                self.target_chunks
                    .insert(chunk_index, (new_auth_path.clone(), new_chunk.clone()));
                swbf_chunk_dictionary_updated = true;
            }

            // If `chunk_index` refers to indices that are still in the active window, do nothing.
        }

        Ok(swbf_chunk_dictionary_updated || aocl_mp_updated)
    }

    /// Resets a membership proof to its state prior to updating it
    /// with one or many addition records, given only
    /// the state of the mutator set kernel prior to adding them.
    pub fn revert_update_from_batch_addition(
        &mut self,
        previous_mutator_set: &MutatorSetAccumulator,
    ) {
        // calculate AOCL MMR MP length
        let previous_leaf_count = previous_mutator_set.aocl.num_leafs();
        assert!(
            previous_leaf_count > self.aocl_leaf_index,
            "Cannot revert a membership proof for an item to back its state before the item was added to the mutator set."
        );
        let aocl_discrepancies = self.aocl_leaf_index ^ previous_leaf_count;
        let aocl_mt_height = u128::from(aocl_discrepancies).ilog2();

        // trim to length
        while self.auth_path_aocl.authentication_path.len() > aocl_mt_height as usize {
            self.auth_path_aocl.authentication_path.pop();
        }

        // remove chunks from unslid windows
        let swbfi_leaf_count = previous_mutator_set.swbf_inactive.num_leafs();
        self.target_chunks.retain(|(k, _v)| *k < swbfi_leaf_count);

        // iterate over all retained chunk authentication paths
        for (k, (mp, _chnk)) in self.target_chunks.iter_mut() {
            // calculate length
            let chunk_discrepancies = swbfi_leaf_count ^ *k;
            let chunk_mt_height = u128::from(chunk_discrepancies).ilog2();

            // trim to length
            while mp.authentication_path.len() > chunk_mt_height as usize {
                mp.authentication_path.pop();
            }
        }
    }

    /// Update multiple membership proofs from one remove operation. Returns the indices of the membership proofs
    /// that have been mutated.
    pub fn batch_update_from_remove(
        membership_proofs: &mut [&mut Self],
        removal_record: &RemovalRecord,
    ) -> Result<Vec<usize>, Box<dyn Error>> {
        // Set all chunk values to the new values and calculate the mutation argument
        // for the batch updating of the MMR membership proofs.
        let mut chunk_dictionaries: Vec<&mut ChunkDictionary> = membership_proofs
            .iter_mut()
            .map(|mp| &mut mp.target_chunks)
            .collect();
        let (mutated_chunks_by_mp_indices, mutation_argument) =
            get_batch_mutation_argument_for_removal_record(removal_record, &mut chunk_dictionaries);

        // Collect all the MMR membership proofs from the chunk dictionaries.
        // Also keep track of which MS membership proof they came from, so the
        // function can report back which MS membership proofs that have been
        // mutated.
        // The chunk values contained in the MS membership proof's chunk dictionary has already
        // been updated by the `get_batch_mutation_argument_for_removal_record` function.
        let mut own_mmr_mps: Vec<&mut mmr::mmr_membership_proof::MmrMembershipProof> = vec![];
        let mut leaf_indices = vec![];
        let mut mmr_mp_index_to_input_index: Vec<usize> = vec![];
        for (i, chunk_dict) in chunk_dictionaries.iter_mut().enumerate() {
            for (chunk_index, (mp, _)) in chunk_dict.iter_mut() {
                own_mmr_mps.push(mp);
                leaf_indices.push(*chunk_index);
                mmr_mp_index_to_input_index.push(i);
            }
        }

        // Perform the batch mutation of the MMR membership proofs
        let mutated_mmr_mps =
            mmr::mmr_membership_proof::MmrMembershipProof::batch_update_from_batch_leaf_mutation(
                &mut own_mmr_mps,
                &leaf_indices,
                mutation_argument
                    .iter()
                    .map(|(i, p, l)| LeafMutation::new(*i, *l, p.clone()))
                    .collect_vec(),
            );

        // Keep track of which MS membership proofs that were mutated. This is all those membership
        // proofs which have a mutated chunk
        let mut ret: Vec<usize> = mutated_chunks_by_mp_indices.into_iter().collect();
        for index in mutated_mmr_mps {
            ret.push(mmr_mp_index_to_input_index[index]);
        }
        ret.sort_unstable();
        ret.dedup();

        Ok(ret)
    }

    pub fn update_from_remove(&mut self, removal_record: &RemovalRecord) -> bool {
        // Removing items does not slide the active window. We only
        // need to take into account new indices in the sparse Bloom
        // filter, and only in the inactive part. Specifically: we
        // need to update the chunks and their membership proofs.

        // Set all chunk values to the new values and calculate the mutation argument
        // for the batch updating of the MMR membership proofs.
        let mut chunk_dictionaries = vec![&mut self.target_chunks];
        let (mutated_chunk_dictionary_index, mutation_argument) =
            get_batch_mutation_argument_for_removal_record(removal_record, &mut chunk_dictionaries);

        // update membership proofs
        // Note that *all* membership proofs must be updated. It's not sufficient to update
        // those whose leaf has changed, since an authentication path changes if *any* leaf
        // in the same Merkle tree (under the same MMR peak) changes.
        // It would be sufficient to only update the membership proofs that live in the Merkle
        // trees that have been updated, but it probably will not give a measurable speedup
        // since this change would not reduce the amount of hashing needed
        let chunk_mmr_lis = self
            .target_chunks
            .iter()
            .map(|(chunk_index, (_, _))| *chunk_index)
            .collect_vec();
        let mut chunk_mmr_mps: Vec<&mut mmr::mmr_membership_proof::MmrMembershipProof> = self
            .target_chunks
            .iter_mut()
            .map(|(_, (mmr_mp, _))| mmr_mp)
            .collect();

        let mutated_mmr_mp_indices: Vec<usize> =
            mmr::mmr_membership_proof::MmrMembershipProof::batch_update_from_batch_leaf_mutation(
                &mut chunk_mmr_mps,
                &chunk_mmr_lis,
                mutation_argument
                    .iter()
                    .map(|(i, p, l)| LeafMutation::new(*i, *l, p.clone()))
                    .collect_vec(),
            );

        !mutated_mmr_mp_indices.is_empty() || !mutated_chunk_dictionary_index.is_empty()
    }

    /// Reverts a membership proof to its state prior to updating it
    /// with a removal record.
    ///
    /// Returns `true` iff the membership proof changed.
    pub fn revert_update_from_remove(&mut self, removal_record: &RemovalRecord) -> bool {
        // The logic here is essentially the same as in
        // `update_from_remove` but with the new and old chunks
        // swapped.

        // Set all chunk values to the old values and prepare
        // for batch updating of the MMR membership proofs.
        let mut chunk_dictionaries = vec![&mut self.target_chunks];
        let (mutated_chunk_dictionary_index, batch_membership) =
            prepare_authenticated_batch_modification_for_removal_record_reversion(
                removal_record,
                &mut chunk_dictionaries,
            );

        // update MMR membership proofs
        // Note that *all* MMR membership proofs must be updated. It's not sufficient to update
        // those whose leaf has changed, since an authentication path changes if *any* leaf
        // in the same Merkle tree (under the same MMR peak) changes.
        let chunk_mmr_lis = self
            .target_chunks
            .iter()
            .map(|(leaf_index, (_, _))| *leaf_index)
            .collect_vec();
        let mut chunk_mmr_mps: Vec<&mut mmr::mmr_membership_proof::MmrMembershipProof> = self
            .target_chunks
            .iter_mut()
            .map(|(_, (mmr_mp, _))| mmr_mp)
            .collect();

        let mutated_mmr_mp_indices: Vec<usize> =
            mmr::mmr_membership_proof::MmrMembershipProof::batch_update_from_batch_leaf_mutation(
                &mut chunk_mmr_mps,
                &chunk_mmr_lis,
                batch_membership
                    .iter()
                    .map(|(i, p, l)| LeafMutation::new(*i, *l, p.clone()))
                    .collect_vec(),
            );

        !mutated_mmr_mp_indices.is_empty() || !mutated_chunk_dictionary_index.is_empty()
    }
}

#[cfg(test)]
#[cfg_attr(coverage_nightly, coverage(off))]
pub mod tests {
    use itertools::Either;
    use itertools::Itertools;
    use macro_rules_attr::apply;
    use proptest::collection;
    use proptest::prelude::any;
    use proptest::prelude::*;
    use proptest_arbitrary_interop::arb;
    use rand::random;
    use rand::rngs::StdRng;
    use rand::seq::IndexedRandom;
    use rand::Rng;
    use rand::RngCore;
    use rand::SeedableRng;
    use tasm_lib::twenty_first::math::other::random_elements;
    use tasm_lib::twenty_first::util_types::mmr::mmr_membership_proof::MmrMembershipProof;

    use super::*;
    use crate::active_window::ActiveWindow;
    use crate::commit;
    use crate::removal_record::chunk::Chunk;
    use crate::test_shared::empty_rusty_mutator_set;
    use crate::test_shared::mock_item_and_randomnesses;
    use crate::test_utils::shared_tokio_runtime;

    const N: usize = 100;

    #[test]
    fn mp_equality_test() {
        let mut rng = rand::rng();

        let (_item, sender_randomness, receiver_preimage) = mock_item_and_randomnesses();

        let base_mp = MsMembershipProof {
            sender_randomness,
            receiver_preimage,
            auth_path_aocl: MmrMembershipProof::new(vec![]),
            aocl_leaf_index: 0,
            target_chunks: ChunkDictionary::default(),
        };

        let mp_with_different_leaf_index = MsMembershipProof {
            sender_randomness,
            receiver_preimage,
            auth_path_aocl: MmrMembershipProof::new(vec![]),
            aocl_leaf_index: 100073,
            target_chunks: ChunkDictionary::default(),
        };

        let mp_with_different_sender_randomness = MsMembershipProof {
            sender_randomness: rng.random(),
            receiver_preimage,
            auth_path_aocl: MmrMembershipProof::new(vec![]),
            aocl_leaf_index: 0,
            target_chunks: ChunkDictionary::default(),
        };

        let mp_with_different_receiver_preimage = MsMembershipProof {
            receiver_preimage: rng.random(),
            sender_randomness,
            auth_path_aocl: MmrMembershipProof::new(vec![]),
            aocl_leaf_index: 0,
            target_chunks: ChunkDictionary::default(),
        };

        // Verify that a different data index (a different auth path) is a different MP
        assert_ne!(mp_with_different_leaf_index, base_mp);

        // Verify that different sender randomness is a different MP
        assert_ne!(mp_with_different_sender_randomness, base_mp);

        // Verify that different receiver preimage is a different MP
        assert_ne!(mp_with_different_receiver_preimage, base_mp);

        // Test that a different chunk dictionary results in a different MP
        // For this test to be performed, we first need an MMR membership proof and a chunk.

        // Construct an MMR with 7 leafs
        let mmr_digests = random_elements::<Digest>(7);
        let mut mmra: MmrAccumulator = MmrAccumulator::new_from_leafs(mmr_digests);

        // Get an MMR membership proof by adding the 8th leaf
        let zero_chunk = Chunk::empty_chunk();
        let mmr_mp = mmra.append(Tip5::hash(&zero_chunk));

        // Verify that the MMR membership proof has the expected length of 3 (sanity check)
        assert_eq!(3, mmr_mp.authentication_path.len());

        // Create a new mutator set membership proof with a non-empty chunk dictionary
        // and verify that it is considered a different membership proof
        let mut mp_mutated: MsMembershipProof = base_mp.clone();
        mp_mutated.target_chunks.insert(0, (mmr_mp, zero_chunk));
        assert_ne!(mp_mutated, base_mp);
    }

    #[test]
    fn serialization_test() {
        // This test belongs here since the serialization for `Option<[T; $len]>` is implemented
        // in this code base as a macro. So this is basically a test of that macro.
        let accumulator: MutatorSetAccumulator = MutatorSetAccumulator::default();
        for _ in 0..10 {
            let (item, sender_randomness, receiver_preimage) = mock_item_and_randomnesses();

            let mp = accumulator.prove(item, sender_randomness, receiver_preimage);

            let json: String = serde_json::to_string(&mp).unwrap();
            let mp_again = serde_json::from_str::<MsMembershipProof>(&json).unwrap();

            assert_eq!(mp_again.target_chunks, mp.target_chunks);
            assert_eq!(mp_again, mp);
        }
    }

    #[test_strategy::proptest(async = "tokio")]
    async fn revert_update_from_remove_test(
        #[strategy(0..N)] own_index: usize,
        #[strategy(collection::vec(arb::<Digest>(), N))] mut item_vec: Vec<Digest>,
        #[strategy(collection::vec(arb::<Digest>(), N))] mut sender_randomness_vec: Vec<Digest>,
        #[strategy(collection::vec(arb::<Digest>(), N))] mut receiver_preimage_vec: Vec<Digest>,
        #[strategy(collection::vec(any::<bool>(), N))] mut condition: Vec<bool>,
        #[any] cutoff_rand: usize,
    ) {
        let mut own_membership_proof = None;
        let mut own_item = None;

        // set up mutator set
        let mut rms = empty_rusty_mutator_set().await;
        let archival_mutator_set = rms.ams_mut();
        let mut membership_proofs: Vec<(Digest, MsMembershipProof)> = vec![];

        // add items
        for i in 0..N {
            let item: Digest = item_vec.pop().unwrap();
            let sender_randomness: Digest = sender_randomness_vec.pop().unwrap();
            let receiver_preimage: Digest = receiver_preimage_vec.pop().unwrap();
            let addition_record = commit(item, sender_randomness, receiver_preimage.hash());

            for (oi, mp) in &mut membership_proofs {
                mp.update_from_addition(
                    *oi,
                    &archival_mutator_set.accumulator().await,
                    &addition_record,
                )
                .expect("Could not update membership proof from addition.");
            }

            let membership_proof = archival_mutator_set
                .prove(item, sender_randomness, receiver_preimage)
                .await;
            if i == own_index {
                own_membership_proof = Some(membership_proof);
                own_item = Some(item);
            } else {
                membership_proofs.push((item, membership_proof));
                if i > own_index {
                    own_membership_proof
                        .as_mut()
                        .unwrap()
                        .update_from_addition(
                            own_item.unwrap(),
                            &archival_mutator_set.accumulator().await,
                            &addition_record,
                        )
                        .expect("Could not update membership proof from addition record.");
                }
            }

            archival_mutator_set.add(&addition_record).await;
        }

        // assert that own mp is valid
        assert!(
            archival_mutator_set
                .verify(own_item.unwrap(), own_membership_proof.as_ref().unwrap())
                .await
        );

        // Assert that all other mps are valid
        for (itm, mp) in &membership_proofs {
            assert!(archival_mutator_set.verify(*itm, mp).await);
        }

        // generate some removal records
        let mut removal_records = vec![];
        for (item, membership_proof) in membership_proofs {
            if condition.pop().unwrap() {
                let removal_record = archival_mutator_set.drop(item, &membership_proof).await;
                removal_records.push(removal_record);
            }
        }
        let cutoff_point = 1 + (cutoff_rand % (removal_records.len() - 1));
        let mut membership_proof_snapshot = None;

        // apply removal records
        for i in 0..removal_records.len() {
            let (immutable_records, mutable_records) = removal_records.split_at_mut(i + 1);
            let applied_removal_record = immutable_records.last().unwrap();

            RemovalRecord::batch_update_from_remove(
                &mut mutable_records.iter_mut().collect::<Vec<_>>(),
                applied_removal_record,
            );

            own_membership_proof
                .as_mut()
                .unwrap()
                .update_from_remove(applied_removal_record);

            archival_mutator_set.remove(applied_removal_record).await;

            if i + 1 == cutoff_point {
                membership_proof_snapshot = Some(own_membership_proof.as_ref().unwrap().clone());
            }
        }

        // assert valid
        assert!(
            archival_mutator_set
                .verify(own_item.unwrap(), own_membership_proof.as_ref().unwrap())
                .await
        );

        // revert some removal records
        let mut reversions = removal_records[cutoff_point..].to_vec();
        reversions.reverse();
        for revert_removal_record in &reversions {
            own_membership_proof
                .as_mut()
                .unwrap()
                .revert_update_from_remove(revert_removal_record);

            archival_mutator_set
                .revert_remove(revert_removal_record)
                .await;

            // keep other removal records up-to-date?
            // - nah, we don't need them for anything anymore
        }

        // assert valid
        assert!(
            archival_mutator_set
                .verify(own_item.unwrap(), own_membership_proof.as_ref().unwrap())
                .await
        );

        // assert same as snapshot before application-and-reversion
        assert_eq!(
            own_membership_proof.unwrap(),
            membership_proof_snapshot.unwrap()
        );
    }

    #[apply(shared_tokio_runtime)]
    async fn revert_update_single_remove_test() {
        let mut rms = empty_rusty_mutator_set().await;
        let ams = rms.ams_mut();
        let mut mps = vec![];
        let mut items = vec![];
        let mut addition_records = vec![];
        let ms_size = 30;
        for _ in 0..ms_size {
            let item: Digest = random();
            let sender_randomness: Digest = random();
            let receiver_preimage: Digest = random();
            let addition_record = commit(item, sender_randomness, receiver_preimage.hash());
            MsMembershipProof::batch_update_from_addition(
                &mut mps.iter_mut().collect_vec(),
                &items,
                &ams.accumulator().await,
                &addition_record,
            )
            .unwrap();
            mps.push(ams.prove(item, sender_randomness, receiver_preimage).await);
            items.push(item);
            ams.add(&addition_record).await;
            addition_records.push(addition_record);
        }

        // Verify that all MPs are valid
        for i in 0..ms_size {
            assert!(ams.verify(items[i], &mps[i]).await);
        }

        // Remove all `ms_size` elements from the MS
        let mut removal_records = vec![];
        for i in 0..ms_size {
            let removal_record = ams.drop(items[i], &mps[i]).await;
            ams.remove(&removal_record).await;
            MsMembershipProof::batch_update_from_remove(
                &mut mps.iter_mut().collect_vec(),
                &removal_record,
            )
            .unwrap();
            removal_records.push(removal_record);

            // Verify that the rest of the MPs are still valid
            for j in 0..ms_size {
                if j > i {
                    assert!(ams.verify(items[j], &mps[j]).await);
                } else {
                    assert!(!ams.verify(items[j], &mps[j]).await);
                }
            }
        }

        // Verify that all MPs are invalid since their items were removed
        for i in 0..ms_size {
            assert!(!ams.verify(items[i], &mps[i]).await);
        }

        // Revert all removals in opposite order and verify that the MPs become valid again
        for i in (0..ms_size).rev() {
            ams.revert_remove(&removal_records[i]).await;
            for mp in mps.iter_mut().take(ms_size) {
                mp.revert_update_from_remove(&removal_records[i]);
            }
            for j in 0..ms_size {
                if j < i {
                    assert!(!ams.verify(items[j], &mps[j]).await);
                } else {
                    assert!(ams.verify(items[j], &mps[j]).await);
                }
            }
        }

        // Verify all MPs after reverting all removals
        for i in 0..ms_size {
            ams.verify(items[i], &mps[i]).await;
        }
    }

    #[apply(shared_tokio_runtime)]
    async fn revert_update_single_addition_test() {
        for j in 2..30 {
            let mut rms = empty_rusty_mutator_set().await;
            let ams = rms.ams_mut();

            // Add `j` items to MSA
            let mut mps = vec![];
            let mut items = vec![];
            let mut addition_records = vec![];
            for _ in 0..j {
                let item: Digest = random();
                let sender_randomness: Digest = random();
                let receiver_preimage: Digest = random();
                let addition_record = commit(item, sender_randomness, receiver_preimage.hash());
                MsMembershipProof::batch_update_from_addition(
                    &mut mps.iter_mut().collect_vec(),
                    &items,
                    &ams.accumulator().await,
                    &addition_record,
                )
                .unwrap();
                mps.push(ams.prove(item, sender_randomness, receiver_preimage).await);
                items.push(item);
                ams.add(&addition_record).await;
                addition_records.push(addition_record);
            }

            // Revert all adds but the first one, and keep the 1st MP updated
            for i in (1..j).rev() {
                ams.revert_add(&addition_records[i]).await;
                mps[0].revert_update_from_batch_addition(&ams.accumulator().await);
                assert!(
                    ams.verify(items[0], &mps[0]).await,
                    "MP should be valid after reversion"
                );
                if i != 1 {
                    // We also check the 2nd MP for good measure, as long as its item is still in the MS
                    mps[1].revert_update_from_batch_addition(&ams.accumulator().await);
                    assert!(
                        ams.verify(items[1], &mps[1]).await,
                        "MP should be valid after reversion"
                    );
                }
            }
        }
    }

    #[apply(shared_tokio_runtime)]
    async fn revert_update_from_addition_batches_test() {
        let mut msa: MutatorSetAccumulator = MutatorSetAccumulator::default();

        let mut rng = rand::rng();
        for _ in 0..10 {
            let init_size = rng.random_range(0..200);
            let first_batch_size = rng.random_range(0..200);
            let last_batch_size = rng.random_range(0..200);

            // Add `init_size` items to MSA
            for _ in 0..init_size {
                let item: Digest = random();
                let sender_randomness: Digest = random();
                let receiver_preimage: Digest = random();
                let addition_record = commit(item, sender_randomness, receiver_preimage.hash());
                msa.add(&addition_record);
            }

            // Add own item with associated membership proof that we want to keep updated
            let own_item: Digest = random();
            let own_sender_randomness: Digest = random();
            let own_receiver_preimage: Digest = random();
            let own_addition_record = commit(
                own_item,
                own_sender_randomness,
                own_receiver_preimage.hash(),
            );
            let mut own_mp = msa.prove(own_item, own_sender_randomness, own_receiver_preimage);
            msa.add(&own_addition_record);
            let msa_after_own_add = msa.clone();

            // Apply 1st batch of additions
            for _ in 0..first_batch_size {
                let item: Digest = random();
                let sender_randomness: Digest = random();
                let receiver_preimage: Digest = random();
                let addition_record = commit(item, sender_randomness, receiver_preimage.hash());
                own_mp
                    .update_from_addition(own_item, &msa, &addition_record)
                    .unwrap();
                msa.add(&addition_record);
                assert!(
                    msa.verify(own_item, &own_mp),
                    "Own mp must be valid after update"
                );
            }

            let msa_after_first_batch = msa.clone();

            // Apply 2nd batch of additions
            for _ in 0..last_batch_size {
                let item: Digest = random();
                let sender_randomness: Digest = random();
                let receiver_preimage: Digest = random();
                let addition_record = commit(item, sender_randomness, receiver_preimage.hash());
                own_mp
                    .update_from_addition(own_item, &msa, &addition_record)
                    .unwrap();
                msa.add(&addition_record);
                assert!(
                    msa.verify(own_item, &own_mp),
                    "Own mp must be valid after update"
                );
            }

            // revert last batch
            own_mp.revert_update_from_batch_addition(&msa_after_first_batch);
            assert!(msa_after_first_batch.verify(own_item, &own_mp));

            // revert first batch
            own_mp.revert_update_from_batch_addition(&msa_after_own_add);
            assert!(msa_after_own_add.verify(own_item, &own_mp));
        }
    }

    #[apply(shared_tokio_runtime)]
    async fn revert_update_from_addition_test() {
        let mut rng = rand::rng();
        let n = rng.next_u32() as usize % 100 + 1;
        // let n = 55;

        let own_index = rng.next_u32() as usize % n;
        // let own_index = 8;
        let mut own_membership_proof = None;
        let mut own_item = None;

        // set up mutator set
        let mut rms = empty_rusty_mutator_set().await;
        let archival_mutator_set = rms.ams_mut();

        // add items
        let mut addition_records = vec![];
        for i in 0..n {
            let item: Digest = random();
            let sender_randomness: Digest = random();
            let receiver_preimage: Digest = random();
            let addition_record = commit(item, sender_randomness, receiver_preimage.hash());
            addition_records.push(addition_record);

            let membership_proof = archival_mutator_set
                .prove(item, sender_randomness, receiver_preimage)
                .await;
            match i.cmp(&own_index) {
                std::cmp::Ordering::Less => {}
                std::cmp::Ordering::Equal => {
                    own_membership_proof = Some(membership_proof);
                    own_item = Some(item);
                }
                std::cmp::Ordering::Greater => {
                    assert!(
                        archival_mutator_set
                            .verify(own_item.unwrap(), own_membership_proof.as_ref().unwrap())
                            .await
                    );
                    assert!(archival_mutator_set
                        .accumulator()
                        .await
                        .verify(own_item.unwrap(), own_membership_proof.as_ref().unwrap()));
                    own_membership_proof
                        .as_mut()
                        .unwrap()
                        .update_from_addition(
                            own_item.unwrap(),
                            &archival_mutator_set.accumulator().await,
                            &addition_record,
                        )
                        .expect("Could not update membership proof from addition record.");
                }
            }

            let mutator_set_before = archival_mutator_set.accumulator().await;
            archival_mutator_set.add(&addition_record).await;

            if i > own_index {
                let own_item = own_item.as_ref().unwrap().to_owned();
                assert!(
                    archival_mutator_set
                        .verify(own_item, own_membership_proof.as_ref().unwrap(),)
                        .await
                );

                let mut memproof = own_membership_proof.as_ref().unwrap().clone();

                assert!(archival_mutator_set.verify(own_item, &memproof,).await);

                memproof.revert_update_from_batch_addition(&mutator_set_before);

                assert!(mutator_set_before.verify(own_item, &memproof));
                // assert!(previous_mutator_set.set_commitment.verify(own_item, self));
            }
        }

        // revert additions
        let (_petrified, revertible) = addition_records.split_at(own_index + 1);
        for addition_record in revertible.iter().rev() {
            archival_mutator_set.revert_add(addition_record).await;
            own_membership_proof
                .as_mut()
                .unwrap()
                .revert_update_from_batch_addition(&archival_mutator_set.accumulator().await);

            assert!(
                archival_mutator_set
                    .verify(own_item.unwrap(), own_membership_proof.as_ref().unwrap())
                    .await
            );
        }
    }

    #[apply(shared_tokio_runtime)]
    async fn revert_updates_mixed_test() {
        let mut rng_seeder = rand::rng();
        let error_tuple: (usize, u32) = (
            10 + rng_seeder.next_u32() as usize % 100,
            rng_seeder.next_u32(),
        );
        let n = error_tuple.0;
        let seed_integer = error_tuple.1;
        let margin = n / 5;
        println!("*********************** seed: {seed_integer} ***********************");
        let seed = seed_integer.to_be_bytes();
        let mut seed_as_bytes = [0u8; 32];
        for i in 0..32 {
            seed_as_bytes[i] = seed[i % 4];
        }

        let mut rng = StdRng::from_seed(seed_as_bytes);

        let mut rms = empty_rusty_mutator_set().await;
        let archival_mutator_set = rms.ams_mut();

        let own_index = rng.next_u32() as usize % 10;
        let mut own_item = Digest::default();
        let mut track_index = 0;

        let mut rates = HashMap::<String, f64>::new();
        rates.insert("additions".to_owned(), 0.7);
        rates.insert("removals".to_owned(), 0.95);

        let mut tracked_items_and_membership_proofs: Vec<(Digest, MsMembershipProof)> = vec![];
        let mut removed_items_and_membership_proofs: Vec<(Digest, MsMembershipProof, usize)> =
            vec![];
        let mut records: Vec<Either<AdditionRecord, RemovalRecord>> = vec![];

        for i in 0..2000 {
            let sample: f64 = rng.random();

            // addition
            if sample <= rates["additions"] || i == own_index {
                println!(
                    "{i}. (set size {}) addition",
                    tracked_items_and_membership_proofs.len()
                );

                // generate item and randomness
                let item: Digest = rng.random();
                let sender_randomness: Digest = rng.random();
                let receiver_preimage: Digest = rng.random();

                // generate addition record
                let addition_record = commit(item, sender_randomness, receiver_preimage.hash());

                // record membership proof
                let membership_proof = archival_mutator_set
                    .prove(item, sender_randomness, receiver_preimage)
                    .await;

                // update existing membership proof
                for (it, mp) in &mut tracked_items_and_membership_proofs {
                    mp.update_from_addition(
                        *it,
                        &archival_mutator_set.accumulator().await,
                        &addition_record,
                    )
                    .expect("Could not update membership proof from addition.");
                }

                // apply record
                archival_mutator_set.add(&addition_record).await;

                // record record
                records.push(Either::Left(addition_record));

                // if own record, set iamp index and own item
                if i == own_index {
                    track_index = tracked_items_and_membership_proofs.len();
                    own_item = item;
                    println!("own item index: {track_index}");
                }

                // record item, membership proof pair
                tracked_items_and_membership_proofs.push((item, membership_proof));

                // if too many items are in the mutator set, revise rates
                if tracked_items_and_membership_proofs.len() > n + margin && i > n {
                    *rates.get_mut("additions").unwrap() = 0.3;
                    *rates.get_mut("removals").unwrap() = 0.8;
                }
            }
            // removal
            else if sample > rates["additions"]
                && sample <= rates["removals"]
                && tracked_items_and_membership_proofs.len() > 1
            {
                println!(
                    "{i}. (set size {}) removal",
                    tracked_items_and_membership_proofs.len()
                );

                // sample index of item and membership proof to remove,
                // but not the index of the own item
                let mut index = track_index;
                while index == track_index {
                    index = rng.next_u32() as usize % tracked_items_and_membership_proofs.len()
                }

                // remove the indicated item and membership proof from the track list
                let (item, membership_proof) = tracked_items_and_membership_proofs.remove(index);
                if track_index > index {
                    track_index -= 1;
                }

                // generate a removal record
                let removal_record = archival_mutator_set.drop(item, &membership_proof).await;

                // update the other membership proofs with the removal record
                for (_, mp) in &mut tracked_items_and_membership_proofs {
                    mp.update_from_remove(&removal_record);
                }

                // don't lose track of the removed item
                assert!(
                    archival_mutator_set.verify(item, &membership_proof).await,
                    "track index: {track_index}\nitem index: {index}",
                );
                removed_items_and_membership_proofs.push((item, membership_proof.clone(), index));

                // remove the item from the mutator set
                archival_mutator_set.remove(&removal_record).await;

                // record record
                records.push(Either::Right(removal_record));

                // if there are too few items in the mutator set, revise rates
                if tracked_items_and_membership_proofs.len() < n - margin && i > n {
                    *rates.get_mut("additions").unwrap() = 0.5;
                    *rates.get_mut("removals").unwrap() = 0.8;
                }
            }
            // reversion
            else if tracked_items_and_membership_proofs.len() > 1 {
                // sample reversion depth
                let max_reversions = tracked_items_and_membership_proofs.len() - track_index;
                if max_reversions > 0 {
                    let num_reversions = rng.next_u32() as usize % max_reversions;
                    if num_reversions > 0 {
                        let set_size_was = tracked_items_and_membership_proofs.len();

                        // test if all records to be reverted are additions
                        let mut all_reversions_are_additions = true;
                        for j in 0..num_reversions {
                            if !matches!(records[records.len() - 1 - j], Either::Left(_)) {
                                all_reversions_are_additions = false;
                            }
                        }

                        // if they are, revert via batch
                        if all_reversions_are_additions && num_reversions > 1 {
                            println!(
                                "{i}. (set size {}) reversion [{}]",
                                tracked_items_and_membership_proofs.len(),
                                vec!["a"; num_reversions].join("")
                            );
                            for _ in 0..num_reversions {
                                if let Some(Either::Left(addition_record)) = records.pop() {
                                    archival_mutator_set.revert_add(&addition_record).await;
                                }
                                tracked_items_and_membership_proofs.pop();
                            }
                            for (_, mp) in &mut tracked_items_and_membership_proofs {
                                mp.revert_update_from_batch_addition(
                                    &archival_mutator_set.accumulator().await,
                                );
                            }
                        }
                        // otherwise, revert individually
                        else {
                            let mut records_abbreviation = "".to_string();
                            for _ in 0..num_reversions {
                                if let Some(record) = records.pop() {
                                    match record {
                                        Either::Left(addition_record) => {
                                            records_abbreviation =
                                                format!("{records_abbreviation}a");

                                            // revert update to mutator set
                                            archival_mutator_set.revert_add(&addition_record).await;
                                            tracked_items_and_membership_proofs.pop();
                                            for (_, mp) in &mut tracked_items_and_membership_proofs
                                            {
                                                mp.revert_update_from_batch_addition(
                                                    &archival_mutator_set.accumulator().await,
                                                );
                                            }
                                        }
                                        Either::Right(removal_record) => {
                                            let mut _report_index = 0;

                                            // start reverting removal record
                                            records_abbreviation =
                                                format!("{records_abbreviation}r");

                                            // revert update to mutator set
                                            archival_mutator_set
                                                .revert_remove(&removal_record)
                                                .await;

                                            // assert valid proofs
                                            for (_, mp) in &mut tracked_items_and_membership_proofs
                                            {
                                                mp.revert_update_from_remove(&removal_record);
                                            }

                                            match removed_items_and_membership_proofs.pop() {
                                                Some((item, membership_proof, index)) => {
                                                    assert!(
                                                        archival_mutator_set
                                                            .verify(item, &membership_proof)
                                                            .await
                                                    );
                                                    tracked_items_and_membership_proofs
                                                        .insert(index, (item, membership_proof));
                                                    _report_index = index;
                                                    if index <= track_index {
                                                        track_index += 1;
                                                    }
                                                }
                                                None => {
                                                    panic!("No entries in removed_items_and_membership_proofs to pop!");
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                            println!(
                                "{i}. (set size {}) reversion ({})",
                                set_size_was, records_abbreviation
                            );
                        }
                    }
                }
            }

            if i > own_index {
                assert_eq!(own_item, tracked_items_and_membership_proofs[track_index].0);
                assert!(
                    archival_mutator_set
                        .verify(
                            own_item,
                            &tracked_items_and_membership_proofs[track_index].1
                        )
                        .await,
                    "seed: {seed_integer} / n: {n}",
                );
            }
        }
    }

    proptest::proptest! {
        #![proptest_config(ProptestConfig {
            cases: 100, .. ProptestConfig::default()
          })]
        #[test]
        fn test_decode_mutator_set_membership_proof(msmp in crate::strategies::msmembershipproof()) {
            let encoded = msmp.encode();
            let decoded: MsMembershipProof = *MsMembershipProof::decode(&encoded).unwrap();
            assert_eq!(msmp, decoded);
        }
    }

    #[test]
    fn batch_updates_on_small_mmr() {
        let mut rng = rand::rng();

        for remove_share in [0.01, 0.1, 0.4, 0.7, 0.99, 1.0] {
            let mut msa = MutatorSetAccumulator::default();
            let mut msmps = vec![];
            let mut items = vec![];
            let mut removed = vec![];
            for j in 0usize..usize::try_from(25 * BATCH_SIZE).unwrap() {
                println!("{j}");
                let item: Digest = rng.random();
                let sender_randomness: Digest = rng.random();
                let receiver_preimage: Digest = rng.random();
                let msmp = msa.prove(item, sender_randomness, receiver_preimage);
                let addition_record = commit(item, sender_randomness, receiver_preimage.hash());
                MsMembershipProof::batch_update_from_addition(
                    &mut msmps.iter_mut().collect_vec(),
                    &items,
                    &msa,
                    &addition_record,
                )
                .unwrap();
                msa.add(&addition_record);
                msmps.push(msmp);
                items.push(item);

                if rng.random_bool(remove_share) {
                    let not_removed = (0..=j).filter(|i| !removed.contains(i)).collect_vec();
                    let remove = *not_removed.choose(&mut rng).unwrap();
                    let remove_item = items[remove];
                    let remove_msmp = &msmps[remove];
                    let removal_record = msa.drop(remove_item, remove_msmp);
                    MsMembershipProof::batch_update_from_remove(
                        &mut msmps.iter_mut().collect_vec(),
                        &removal_record,
                    )
                    .unwrap();
                    assert!(msa.can_remove(&removal_record));
                    msa.remove(&removal_record);
                    removed.push(remove);
                }
            }

            for ((j, msmp), item) in msmps.into_iter().enumerate().zip(items) {
                if removed.contains(&j) {
                    assert!(
                        !msa.verify(item, &msmp),
                        "index {j} must fail to verify since it was removed."
                    );
                } else {
                    assert!(
                        msa.verify(item, &msmp),
                        "index {j} must verify since it was never removed."
                    );
                }
            }
        }
    }

    #[test]
    #[should_panic(expected = "corrupt mutator set accumulator")]
    fn update_from_addition_fails_for_inconsistent_mutator_set_accumulator() {
        let mut rng = rand::rng();
        let aocl_leaf_count = 42966841942012423_u64;
        let aocl_peaks = (0..aocl_leaf_count.count_ones())
            .map(|_| rng.random::<Digest>())
            .collect_vec();
        let swbfi_leaf_count = (aocl_leaf_count / u64::from(BATCH_SIZE)) + 1;
        let swbfi_peaks = (0..swbfi_leaf_count.count_ones())
            .map(|_| rng.random::<Digest>())
            .collect_vec();
        let swbf_active = ActiveWindow::new();

        // Note that we are bypassing the mutator set accumulator constructor,
        // which guarantees that the leaf counts are in sync.
        let mut mutator_set_accumulator = MutatorSetAccumulator {
            aocl: MmrAccumulator::init(aocl_peaks, aocl_leaf_count),
            swbf_inactive: MmrAccumulator::init(swbfi_peaks, swbfi_leaf_count),
            swbf_active,
        };

        let (own_item, sender_randomness, receiver_preimage) =
            rng.random::<(Digest, Digest, Digest)>();
        let own_addition_record = commit(own_item, sender_randomness, receiver_preimage.hash());
        let mut msmp =
            mutator_set_accumulator.prove(own_item, sender_randomness, receiver_preimage);
        mutator_set_accumulator.add(&own_addition_record);

        // aocl leaf count is now 42966841942012424_u64

        let other_addition_record = AdditionRecord::new(rng.random::<Digest>());

        msmp.update_from_addition(own_item, &mutator_set_accumulator, &other_addition_record)
            .expect("update from add should always work");
    }
}