tychentropy 0.1.0-alpha.1

A crate to support bitceptron iso's physical entropy generation and assessment
Documentation
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
use std::{ops::BitXor, panic};

use bip39::Mnemonic;
use getset::Getters;
use rand::RngCore;
use ring::rand::{SecureRandom, SystemRandom};
use zeroize::{Zeroize, ZeroizeOnDrop};

use crate::utils::domain_utils::u64_to_binary;

use super::{
    mnemonics::MnemonicLength,
    process::{
        error::ProcessError,
        input::{new::TychentropyNewInput, NaturalDatum},
    },
    statistics::{
        statistical_tests_results::StatisticalTestsResults,
        uniform_random_test::UniformRandomDistStatisticalTest,
    },
};

#[derive(Debug, Zeroize, ZeroizeOnDrop, Getters, Clone)]
#[get = "pub with_prefix"]
pub struct Tychentropy {
    /// Range length of possible numbers that are to be drawn. Think of this as how many sides your dice has. It must have at least 2 to produce any entropy.
    range: u64,
    full_bits_in_each_datum: u32,
    target_entropy_bytes: u64,
    target_entropy_bits: u64,
    sequence: Vec<u64>,
    entropy_generating_sequence: Vec<u64>,
    generated_entropy_bits: u64,
    is_entropy_ready: bool,
    entropy_bit_string: String,
    entropy_bit_vector: Vec<u8>,
    entropy_bytes_vector: Vec<u8>,
    rng_entropy_bytes_vector: Vec<u8>,
    mixed_entropy_and_rng_bytes_vector: Vec<u8>,
    final_entropy_bytes_vector: Vec<u8>,
    statistical_test_results: StatisticalTestsResults,
    mnemonic_length: Option<MnemonicLength>,
    mnemonic: Option<Mnemonic>,
}

impl Default for Tychentropy {
    fn default() -> Self {
        Self::new(TychentropyNewInput::new(6, 32).unwrap())
    }
}

impl Tychentropy {
    pub fn new(input: TychentropyNewInput) -> Self {
        let range_len = *input.get_range_len();
        let full_bits_in_each_datum = range_len.ilog2();
        let target_entropy_bytes = *input.get_target_entropy_bytes();
        let target_entropy_bits = target_entropy_bytes * 8;
        let sequence = vec![];
        let entropy_generating_sequence = vec![];
        let generated_entropy_bits = 0;
        let is_entropy_ready = false;
        let entropy_bit_string = String::new();
        let entropy_bit_vector = vec![];
        let entropy_bytes_vector = vec![];
        let rng_entropy_bytes_vector = vec![];
        let mixed_entropy_and_rng_bytes_vector = vec![];
        let final_entropy_bytes_vector = vec![];
        let statistical_test_results = StatisticalTestsResults::default();
        let mnemonic_length = match *input.get_target_entropy_bytes() {
            16 => Some(MnemonicLength::Twelve),
            20 => Some(MnemonicLength::Fifteen),
            24 => Some(MnemonicLength::Eighteen),
            28 => Some(MnemonicLength::TwentyOne),
            32 => Some(MnemonicLength::TwentyFour),
            _ => None,
        };
        let mnemonic = None;
        Tychentropy {
            range: range_len,
            full_bits_in_each_datum,
            target_entropy_bytes,
            target_entropy_bits,
            sequence,
            entropy_generating_sequence,
            generated_entropy_bits,
            is_entropy_ready,
            entropy_bit_string,
            entropy_bit_vector,
            entropy_bytes_vector,
            rng_entropy_bytes_vector,
            mixed_entropy_and_rng_bytes_vector,
            final_entropy_bytes_vector,
            statistical_test_results,
            mnemonic_length,
            mnemonic,
        }
    }

    pub fn add_natural_datum(&mut self, datum: NaturalDatum) -> Result<(), ProcessError> {
        let datum_value = *datum.get_value();
        if self.is_entropy_ready {
            Err(ProcessError::EntropyAlreadyCreated)
        } else if datum_value > self.range {
            Err(ProcessError::NaturalDatumOutOfRange {
                value: datum_value,
                range: self.range,
            })
        } else {
            self.sequence.push(datum_value);
            let zero_indexed_datum_value = datum_value - 1;
            let cutoff_value = 2u64.pow(self.full_bits_in_each_datum);
            if zero_indexed_datum_value < cutoff_value {
                self.entropy_generating_sequence
                    .push(zero_indexed_datum_value);
                let zero_indexed_bit_string =
                    u64_to_binary(zero_indexed_datum_value, self.full_bits_in_each_datum)
                        .map_err(|err| err)
                        .unwrap();
                self.entropy_bit_string
                    .push_str(&zero_indexed_bit_string.clone());
                let zero_indexed_bit_vec = zero_indexed_bit_string
                    .chars()
                    .map(|c| c.to_string().parse::<u8>().unwrap())
                    .collect::<Vec<u8>>();
                self.entropy_bit_vector.extend(zero_indexed_bit_vec);
                self.generated_entropy_bits += self.full_bits_in_each_datum as u64;
                if self.generated_entropy_bits >= self.target_entropy_bits {
                    self.is_entropy_ready = true;
                    self.entropy_bit_string
                        .truncate(self.target_entropy_bits as usize);
                    self.entropy_bit_vector
                        .truncate(self.target_entropy_bits as usize);

                    let entropy_bytes_vector = self
                        .entropy_bit_vector
                        .chunks(8)
                        .map(|byte_sized_chunk| {
                            byte_sized_chunk
                                .iter()
                                .enumerate()
                                .fold(0, |acc, (index, bit)| acc + bit * 2u8.pow(index as u32))
                        })
                        .collect::<Vec<u8>>();
                    self.entropy_bytes_vector = entropy_bytes_vector.clone();
                    self.final_entropy_bytes_vector = entropy_bytes_vector;
                    self.perform_selected_statistical_tests();
                    self.generate_mnemonic();
                }
            }
            Ok(())
        }
    }

    pub fn mix_with_rng(&mut self) -> Result<(), ProcessError> {
        if !self.is_entropy_ready {
            Err(ProcessError::EntropyBitsAreNotReady {
                required_entropy_bits: self.target_entropy_bits,
                current_entropy_bits: self.generated_entropy_bits,
            })
        } else {
            let mut rand_rng = rand::thread_rng();
            let mut rand_rng_bytes = vec![0u8; self.target_entropy_bytes as usize];
            rand_rng.fill_bytes(&mut rand_rng_bytes);

            let mut ring_rng_bytes = vec![0u8; self.target_entropy_bytes as usize];
            let sys_random = SystemRandom::new();
            sys_random.fill(&mut ring_rng_bytes).unwrap();

            let mixed = rand_rng_bytes
                .iter()
                .zip(ring_rng_bytes.iter())
                .map(|(rand_byte, ring_byte)| rand_byte.bitxor(ring_byte))
                .collect();
            self.rng_entropy_bytes_vector = mixed;
            self.final_entropy_bytes_vector = self
                .entropy_bytes_vector
                .iter()
                .zip(self.rng_entropy_bytes_vector.iter())
                .map(|(data, rng)| data.bitxor(rng))
                .collect();
            self.perform_selected_statistical_tests();
            self.generate_mnemonic();
            Ok(())
        }
    }

    pub fn put_data_from_another_tychentropy(&mut self, other: Tychentropy) {
        self.range = other.range;
        self.full_bits_in_each_datum = other.full_bits_in_each_datum;
        self.target_entropy_bits = other.target_entropy_bits;
        self.target_entropy_bytes = other.target_entropy_bytes;
        self.sequence = other.sequence.clone();
        self.entropy_generating_sequence = other.entropy_generating_sequence.clone();
        self.generated_entropy_bits = other.generated_entropy_bits;
        self.is_entropy_ready = other.is_entropy_ready;
        self.entropy_bit_string = other.entropy_bit_string.clone();
        self.entropy_bit_vector = other.entropy_bit_vector.clone();
        self.entropy_bytes_vector = other.entropy_bytes_vector.clone();
        self.rng_entropy_bytes_vector = other.rng_entropy_bytes_vector.clone();
        self.mixed_entropy_and_rng_bytes_vector = other.mixed_entropy_and_rng_bytes_vector.clone();
        self.final_entropy_bytes_vector = other.final_entropy_bytes_vector.clone();
        self.mnemonic_length = other.mnemonic_length.clone();
        self.mnemonic = other.mnemonic.clone();
        self.statistical_test_results = other.statistical_test_results.clone();
    }

    pub fn reset_data(&mut self) {
        let input = TychentropyNewInput::new(self.range, self.target_entropy_bytes).unwrap();
        let new_tych_entropy = Tychentropy::new(input);
        self.put_data_from_another_tychentropy(new_tych_entropy);
    }

    pub fn generate_mnemonic(&mut self) {
        if self.is_entropy_ready && self.mnemonic_length.is_some() {
            self.mnemonic = Some(Mnemonic::from_entropy(&self.final_entropy_bytes_vector).unwrap())
        }
    }

    pub fn perform_selected_statistical_tests(&mut self) {
        let data = self.final_entropy_bytes_vector.clone();
        if !data.is_empty() {
            let results = panic::catch_unwind(|| {
                UniformRandomDistStatisticalTest::perform_selected_tests(&data)
            });
            match results {
                Ok(res) => self.statistical_test_results = res,
                Err(_) => {}
            }
        };
    }

    pub fn recover_original_entropy_bytes_after_mix(&mut self) {
        self.final_entropy_bytes_vector = self.entropy_bytes_vector.clone();
        self.mixed_entropy_and_rng_bytes_vector = vec![];
        self.rng_entropy_bytes_vector = vec![];
        self.perform_selected_statistical_tests();
        self.generate_mnemonic();
    }
}

#[cfg(test)]
mod test {
    use crate::utils::test_utils::{
        generate_pre_determined_series_of_data_till_entropy_is_full,
        generate_random_data_sequence_till_entropy_is_full,
    };

    use super::*;

    #[test]
    fn default_works_01() {
        let default = Tychentropy::default();
        assert_eq!(*default.get_range(), 6);
        assert_eq!(*default.get_target_entropy_bytes(), 32);
        assert_eq!(*default.get_target_entropy_bits(), 256);
        assert_eq!(*default.get_full_bits_in_each_datum(), 2);
    }

    #[test]
    fn new_works_in_normal_condition_01() {
        let range = 3;
        let num_bytes_of_target_entropy = 5;
        let input = TychentropyNewInput::new(range, num_bytes_of_target_entropy).unwrap();
        let tychentropy = Tychentropy::new(input);
        assert_eq!(tychentropy.range, 3);
        assert_eq!(tychentropy.full_bits_in_each_datum, 1);
        assert_eq!(tychentropy.target_entropy_bytes, 5);
        assert_eq!(tychentropy.target_entropy_bits, 40);
        assert_eq!(tychentropy.sequence, vec![]);
        assert_eq!(tychentropy.entropy_generating_sequence, vec![]);
        assert_eq!(tychentropy.generated_entropy_bits, 0);
        assert_eq!(tychentropy.is_entropy_ready, false);
        assert_eq!(tychentropy.entropy_bit_string, "");
        assert_eq!(tychentropy.entropy_bit_vector, vec![]);
        assert_eq!(tychentropy.entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.rng_entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.final_entropy_bytes_vector, vec![]);
    }

    #[test]
    fn add_datum_works_in_normal_condition_01() {
        let range = 6;
        let target_entropy_bytes = 1;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);
        let datum = NaturalDatum::new(range, 5).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        assert_eq!(tychentropy.range, 6);
        assert_eq!(tychentropy.full_bits_in_each_datum, 2);
        assert_eq!(tychentropy.target_entropy_bytes, 1);
        assert_eq!(tychentropy.target_entropy_bits, 8);
        assert_eq!(tychentropy.sequence, vec![5]);
        assert_eq!(tychentropy.entropy_generating_sequence, vec![]);
        assert_eq!(tychentropy.generated_entropy_bits, 0);
        assert_eq!(tychentropy.is_entropy_ready, false);
        assert_eq!(tychentropy.entropy_bit_string, "");
        assert_eq!(tychentropy.entropy_bit_vector, vec![]);
        assert_eq!(tychentropy.entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.rng_entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.final_entropy_bytes_vector, vec![]);
    }

    #[test]
    fn add_datum_works_in_normal_condition_02() {
        let range = 6;
        let target_entropy_bytes = 1;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);
        let datum = NaturalDatum::new(range, 4).unwrap();
        let _ = tychentropy.add_natural_datum(datum);

        assert_eq!(tychentropy.range, 6);
        assert_eq!(tychentropy.full_bits_in_each_datum, 2);
        assert_eq!(tychentropy.target_entropy_bytes, 1);
        assert_eq!(tychentropy.target_entropy_bits, 8);
        assert_eq!(tychentropy.sequence, vec![4]);
        assert_eq!(tychentropy.entropy_generating_sequence, vec![3]);
        assert_eq!(tychentropy.generated_entropy_bits, 2);
        assert_eq!(tychentropy.is_entropy_ready, false);
        assert_eq!(tychentropy.entropy_bit_string, "11");
        assert_eq!(tychentropy.entropy_bit_vector, vec![1, 1]);
        assert_eq!(tychentropy.entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.rng_entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.final_entropy_bytes_vector, vec![]);
    }

    #[test]
    fn add_datum_works_in_normal_condition_03() {
        let range = 6;
        let target_entropy_bytes = 1;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);
        let datum = NaturalDatum::new(range, 4).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        let datum = NaturalDatum::new(range, 3).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        assert_eq!(tychentropy.range, 6);
        assert_eq!(tychentropy.full_bits_in_each_datum, 2);
        assert_eq!(tychentropy.target_entropy_bytes, 1);
        assert_eq!(tychentropy.target_entropy_bits, 8);
        assert_eq!(tychentropy.sequence, vec![4, 3]);
        assert_eq!(tychentropy.entropy_generating_sequence, vec![3, 2]);
        assert_eq!(tychentropy.generated_entropy_bits, 4);
        assert_eq!(tychentropy.is_entropy_ready, false);
        assert_eq!(tychentropy.entropy_bit_string, "1110");
        assert_eq!(tychentropy.entropy_bit_vector, vec![1, 1, 1, 0]);
        assert_eq!(tychentropy.entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.rng_entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.final_entropy_bytes_vector, vec![]);
    }

    #[test]
    fn add_datum_works_in_normal_condition_04() {
        let range = 6;
        let target_entropy_bytes = 1;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);
        let datum = NaturalDatum::new(range, 4).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        let datum = NaturalDatum::new(range, 5).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        let datum = NaturalDatum::new(range, 3).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        let datum = NaturalDatum::new(range, 6).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        let datum = NaturalDatum::new(range, 2).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        assert_eq!(tychentropy.range, 6);
        assert_eq!(tychentropy.full_bits_in_each_datum, 2);
        assert_eq!(tychentropy.target_entropy_bytes, 1);
        assert_eq!(tychentropy.target_entropy_bits, 8);
        assert_eq!(tychentropy.sequence, vec![4, 5, 3, 6, 2]);
        assert_eq!(tychentropy.entropy_generating_sequence, vec![3, 2, 1]);
        assert_eq!(tychentropy.generated_entropy_bits, 6);
        assert_eq!(tychentropy.is_entropy_ready, false);
        assert_eq!(tychentropy.entropy_bit_string, "111001");
        assert_eq!(tychentropy.entropy_bit_vector, vec![1, 1, 1, 0, 0, 1]);
        assert_eq!(tychentropy.entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.rng_entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.final_entropy_bytes_vector, vec![]);
    }

    #[test]
    fn add_datum_works_in_normal_condition_05() {
        let range = 6;
        let target_entropy_bytes = 1;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);
        let datum = NaturalDatum::new(range, 4).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        let datum = NaturalDatum::new(range, 5).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        let datum = NaturalDatum::new(range, 3).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        let datum = NaturalDatum::new(range, 6).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        let datum = NaturalDatum::new(range, 2).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        let datum = NaturalDatum::new(range, 1).unwrap();
        tychentropy.add_natural_datum(datum).unwrap();

        assert_eq!(tychentropy.range, 6);
        assert_eq!(tychentropy.full_bits_in_each_datum, 2);
        assert_eq!(tychentropy.target_entropy_bytes, 1);
        assert_eq!(tychentropy.target_entropy_bits, 8);
        assert_eq!(tychentropy.sequence, vec![4, 5, 3, 6, 2, 1]);
        assert_eq!(tychentropy.entropy_generating_sequence, vec![3, 2, 1, 0]);
        assert_eq!(tychentropy.generated_entropy_bits, 8);
        assert_eq!(tychentropy.is_entropy_ready, true);
        assert_eq!(tychentropy.entropy_bit_string, "11100100");
        assert_eq!(tychentropy.entropy_bit_vector, vec![1, 1, 1, 0, 0, 1, 0, 0]);
        assert_eq!(tychentropy.entropy_bytes_vector.len(), 1);
        assert_eq!(tychentropy.rng_entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.final_entropy_bytes_vector.len(), 1);
    }

    #[test]
    fn add_datum_works_in_normal_condition_06() {
        let range = 6;
        let target_entropy_bytes = 1;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);

        generate_random_data_sequence_till_entropy_is_full(range, &mut tychentropy);

        assert_eq!(tychentropy.range, 6);
        assert_eq!(tychentropy.full_bits_in_each_datum, 2);
        assert_eq!(tychentropy.target_entropy_bytes, 1);
        assert_eq!(tychentropy.target_entropy_bits, 8);
        assert_eq!(tychentropy.entropy_generating_sequence.len(), 4);
        assert_eq!(tychentropy.generated_entropy_bits, 8);
        assert_eq!(tychentropy.is_entropy_ready, true);
        assert_eq!(tychentropy.entropy_bit_string.len(), 8);
        assert_eq!(tychentropy.entropy_bit_vector.len(), 8);
        assert_eq!(tychentropy.entropy_bytes_vector.len(), 1);
        assert_eq!(tychentropy.rng_entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.final_entropy_bytes_vector.len(), 1);
    }

    #[test]
    fn add_datum_works_in_normal_condition_07() {
        let range = 6;
        let target_entropy_bytes = 1;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);
        let sequence = vec![1, 4, 6, 2, 3, 4, 1, 4, 6, 4, 2];

        generate_pre_determined_series_of_data_till_entropy_is_full(
            range,
            sequence,
            &mut tychentropy,
        );

        assert_eq!(tychentropy.range, 6);
        assert_eq!(tychentropy.full_bits_in_each_datum, 2);
        assert_eq!(tychentropy.target_entropy_bytes, 1);
        assert_eq!(tychentropy.target_entropy_bits, 8);
        assert_eq!(tychentropy.sequence, vec![1, 4, 6, 2, 3]);
        assert_eq!(tychentropy.entropy_generating_sequence, vec![0, 3, 1, 2]);
        assert_eq!(tychentropy.generated_entropy_bits, 8);
        assert_eq!(tychentropy.is_entropy_ready, true);
        assert_eq!(tychentropy.entropy_bit_string, "00110110");
        assert_eq!(tychentropy.entropy_bit_vector, vec![0, 0, 1, 1, 0, 1, 1, 0]);
        assert_eq!(tychentropy.entropy_bytes_vector.len(), 1);
        assert_eq!(tychentropy.rng_entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.final_entropy_bytes_vector.len(), 1);
    }

    #[test]
    fn add_datum_works_in_normal_condition_08() {
        let range = 2048;
        let target_entropy_bytes = 1024;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);

        generate_random_data_sequence_till_entropy_is_full(range, &mut tychentropy);

        assert_eq!(tychentropy.range, 2048);
        assert_eq!(tychentropy.full_bits_in_each_datum, 11);
        assert_eq!(tychentropy.target_entropy_bytes, 1024);
        assert_eq!(tychentropy.target_entropy_bits, 8192);
        assert_eq!(tychentropy.generated_entropy_bits, 8195); // every datum has 11 bits and that's not a multiple of 8. Hence a bit of over doing here.
        assert_eq!(tychentropy.is_entropy_ready, true);
        assert_eq!(tychentropy.entropy_bit_string.len(), 8192);
        assert_eq!(tychentropy.entropy_bit_vector.len(), 8192);
        assert_eq!(tychentropy.entropy_bytes_vector.len(), 1024);
        assert_eq!(tychentropy.rng_entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.final_entropy_bytes_vector.len(), 1024);
    }

    #[test]
    fn add_datum_works_in_normal_condition_09() {
        let range = 632;
        let target_entropy_bytes = 893;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);

        generate_random_data_sequence_till_entropy_is_full(range, &mut tychentropy);

        assert_eq!(tychentropy.range, 632);
        assert_eq!(tychentropy.full_bits_in_each_datum, 9);
        assert_eq!(tychentropy.target_entropy_bytes, 893);
        assert_eq!(tychentropy.target_entropy_bits, 7144);
        assert_eq!(tychentropy.generated_entropy_bits, 7146); // every datum has 11 bits and that's not a multiple of 8. Hence a bit of over doing here.
        assert_eq!(tychentropy.is_entropy_ready, true);
        assert_eq!(tychentropy.entropy_bit_string.len(), 7144);
        assert_eq!(tychentropy.entropy_bit_vector.len(), 7144);
        assert_eq!(tychentropy.entropy_bytes_vector.len(), 893);
        assert_eq!(tychentropy.rng_entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.final_entropy_bytes_vector.len(), 893);
    }

    #[test]
    fn add_datum_emits_error_for_out_of_range_datum_01() {
        let range = 6;
        let target_entropy_bytes = 1;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);
        let datum = NaturalDatum::new(8, 7).unwrap();
        let result = tychentropy.add_natural_datum(datum);
        assert!(result.is_err());
        assert_eq!(
            result.err().unwrap(),
            ProcessError::NaturalDatumOutOfRange { value: 7, range: 6 }
        )
    }

    #[test]
    fn create_entropy_bytes_works_in_normal_condition_01() {
        let range = 6;
        let target_entropy_bytes = 1;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);
        let sequence = vec![1, 4, 6, 2, 3, 4, 1, 4, 6, 4, 2];

        generate_pre_determined_series_of_data_till_entropy_is_full(
            range,
            sequence,
            &mut tychentropy,
        );

        assert_eq!(tychentropy.range, 6);
        assert_eq!(tychentropy.full_bits_in_each_datum, 2);
        assert_eq!(tychentropy.target_entropy_bytes, 1);
        assert_eq!(tychentropy.target_entropy_bits, 8);
        assert_eq!(tychentropy.sequence, vec![1, 4, 6, 2, 3]);
        assert_eq!(tychentropy.entropy_generating_sequence, vec![0, 3, 1, 2]);
        assert_eq!(tychentropy.generated_entropy_bits, 8);
        assert_eq!(tychentropy.is_entropy_ready, true);
        assert_eq!(tychentropy.entropy_bit_string, "00110110");
        assert_eq!(tychentropy.entropy_bit_vector, vec![0, 0, 1, 1, 0, 1, 1, 0]);
        assert_eq!(tychentropy.entropy_bytes_vector, vec![108]);
        assert_eq!(tychentropy.rng_entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.final_entropy_bytes_vector, vec![108]);
    }

    #[test]
    fn mix_rng_and_data_entropy_works_in_normal_condition_01() {
        let range = 6;
        let target_entropy_bytes = 1;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);
        let sequence = vec![1, 4, 6, 2, 3, 4, 1, 4, 6, 4, 2];

        generate_pre_determined_series_of_data_till_entropy_is_full(
            range,
            sequence,
            &mut tychentropy,
        );

        tychentropy.mix_with_rng().unwrap();

        assert_eq!(tychentropy.range, 6);
        assert_eq!(tychentropy.full_bits_in_each_datum, 2);
        assert_eq!(tychentropy.target_entropy_bytes, 1);
        assert_eq!(tychentropy.target_entropy_bits, 8);
        assert_eq!(tychentropy.sequence, vec![1, 4, 6, 2, 3]);
        assert_eq!(tychentropy.entropy_generating_sequence, vec![0, 3, 1, 2]);
        assert_eq!(tychentropy.generated_entropy_bits, 8);
        assert_eq!(tychentropy.is_entropy_ready, true);
        assert_eq!(tychentropy.entropy_bit_string, "00110110");
        assert_eq!(tychentropy.entropy_bit_vector, vec![0, 0, 1, 1, 0, 1, 1, 0]);
        assert_eq!(tychentropy.entropy_bytes_vector, vec![108]);
        assert_eq!(tychentropy.rng_entropy_bytes_vector.len(), 1);
        assert_eq!(tychentropy.final_entropy_bytes_vector.len(), 1);
        assert_ne!(
            tychentropy.entropy_bytes_vector,
            tychentropy.rng_entropy_bytes_vector
        );
        assert_ne!(
            tychentropy.entropy_bytes_vector,
            tychentropy.final_entropy_bytes_vector
        );
        assert_ne!(
            tychentropy.rng_entropy_bytes_vector,
            tychentropy.final_entropy_bytes_vector
        );
    }

    #[test]
    fn mix_rng_and_data_entropy_works_in_normal_condition_02() {
        let range = 1024;
        let target_entropy_bytes = 32;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);

        generate_random_data_sequence_till_entropy_is_full(range, &mut tychentropy);

        tychentropy.mix_with_rng().unwrap();

        assert_eq!(tychentropy.entropy_bytes_vector.len(), 32);
        assert_eq!(tychentropy.rng_entropy_bytes_vector.len(), 32);
        assert_eq!(tychentropy.final_entropy_bytes_vector.len(), 32);
        assert_ne!(
            tychentropy.entropy_bytes_vector,
            tychentropy.rng_entropy_bytes_vector
        );
        assert_ne!(
            tychentropy.entropy_bytes_vector,
            tychentropy.final_entropy_bytes_vector
        );
        assert_ne!(
            tychentropy.rng_entropy_bytes_vector,
            tychentropy.final_entropy_bytes_vector
        );
    }

    #[test]
    fn mix_rng_and_data_entropy_emits_error_when_entropy_is_not_ready_01() {
        let range = 1024;
        let target_entropy_bytes = 32;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);

        let result = tychentropy.mix_with_rng();

        assert!(result.is_err());
        assert_eq!(
            result.err().unwrap(),
            ProcessError::EntropyBitsAreNotReady {
                required_entropy_bits: 256,
                current_entropy_bits: 0
            }
        )
    }

    #[test]
    fn put_data_from_another_tychentropy_works_01() {
        let range = 1024;
        let target_entropy_bytes = 32;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);

        let range = 32;
        let target_entropy_bytes = 42;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let tychentropy_rep = Tychentropy::new(input);

        tychentropy.put_data_from_another_tychentropy(tychentropy_rep);
        assert_eq!(tychentropy.range, 32);
        assert_eq!(tychentropy.full_bits_in_each_datum, 5);
        assert_eq!(tychentropy.target_entropy_bytes, 42);
        assert_eq!(tychentropy.target_entropy_bits, 336);
    }

    #[test]
    fn put_data_from_another_tychentropy_works_02() {
        let range = 8;
        let target_entropy_bytes = 3;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);
        let sequence = vec![1, 1, 1, 1, 1, 1, 1, 1];

        generate_pre_determined_series_of_data_till_entropy_is_full(
            range,
            sequence,
            &mut tychentropy,
        );

        tychentropy.mix_with_rng().unwrap();

        let range = 6;
        let target_entropy_bytes = 1;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy_rep = Tychentropy::new(input);
        let sequence = vec![1, 4, 6, 2, 3, 4, 1, 4, 6, 4, 2];

        generate_pre_determined_series_of_data_till_entropy_is_full(
            range,
            sequence,
            &mut tychentropy_rep,
        );

        tychentropy_rep.mix_with_rng().unwrap();

        tychentropy.put_data_from_another_tychentropy(tychentropy_rep);

        assert_eq!(tychentropy.range, 6);
        assert_eq!(tychentropy.full_bits_in_each_datum, 2);
        assert_eq!(tychentropy.target_entropy_bytes, 1);
        assert_eq!(tychentropy.target_entropy_bits, 8);
        assert_eq!(tychentropy.sequence, vec![1, 4, 6, 2, 3]);
        assert_eq!(tychentropy.entropy_generating_sequence, vec![0, 3, 1, 2]);
        assert_eq!(tychentropy.generated_entropy_bits, 8);
        assert_eq!(tychentropy.is_entropy_ready, true);
        assert_eq!(tychentropy.entropy_bit_string, "00110110");
        assert_eq!(tychentropy.entropy_bit_vector, vec![0, 0, 1, 1, 0, 1, 1, 0]);
        assert_eq!(tychentropy.entropy_bytes_vector, vec![108]);
        assert_eq!(tychentropy.rng_entropy_bytes_vector.len(), 1);
        assert_eq!(tychentropy.final_entropy_bytes_vector.len(), 1);
        assert_ne!(
            tychentropy.entropy_bytes_vector,
            tychentropy.rng_entropy_bytes_vector
        );
        assert_ne!(
            tychentropy.entropy_bytes_vector,
            tychentropy.final_entropy_bytes_vector
        );
        assert_ne!(
            tychentropy.rng_entropy_bytes_vector,
            tychentropy.final_entropy_bytes_vector
        );
    }

    #[test]
    fn reset_works_01() {
        let range = 6;
        let target_entropy_bytes = 1;
        let input = TychentropyNewInput::new(range, target_entropy_bytes).unwrap();
        let mut tychentropy = Tychentropy::new(input);
        let sequence = vec![1, 4, 6, 2, 3, 4, 1, 4, 6, 4, 2];

        generate_pre_determined_series_of_data_till_entropy_is_full(
            range,
            sequence,
            &mut tychentropy,
        );

        tychentropy.mix_with_rng().unwrap();

        tychentropy.reset_data();

        assert_eq!(tychentropy.range, 6);
        assert_eq!(tychentropy.full_bits_in_each_datum, 2);
        assert_eq!(tychentropy.target_entropy_bytes, 1);
        assert_eq!(tychentropy.target_entropy_bits, 8);
        assert_eq!(tychentropy.sequence, vec![]);
        assert_eq!(tychentropy.entropy_generating_sequence, vec![]);
        assert_eq!(tychentropy.generated_entropy_bits, 0);
        assert_eq!(tychentropy.is_entropy_ready, false);
        assert_eq!(tychentropy.entropy_bit_string, "");
        assert_eq!(tychentropy.entropy_bit_vector, vec![]);
        assert_eq!(tychentropy.entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.rng_entropy_bytes_vector, vec![]);
        assert_eq!(tychentropy.final_entropy_bytes_vector, vec![]);
    }
}