artimonist 1.2.2

A tool for generating mnemonics and wallets.
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

/*!
 * # Reference
 *
 * [1] - Unicode characters
 *      <https://www.unicodepedia.com/>
 *
 * # Descriptions
 *
 * [1] - Animate Diagram secret data construction
 *      (diagram version == 2)  
 *      |--utf8 chars---|----n*7 bytes----|-1 byte-|  
 *      |Char1|Char2|...| n Frame Indices |CheckSum|  
 *      |------>>>------|-------<<<-------|--------|  
 *      frame order from right to left, until end frame.
 *      chars count = indices.count_ones() - n - 1
 *      chars order from left to right.
 *
 * [2] - Animate Diagram frame indices data construction
 *      0b0xxx_xxxx
 *      0b1xxx_xxxx
 *      0b0xxx_xxxx
 *      0b0xxx_xxxx
 *      0b0xxx_xxxx
 *      0b0xxx_xxxx
 *      0b0xxx_xxxx
 *      x bits indices char position in diagram.
 * [3] - Animate Diagram end frame indices data construction
 *      0b1xxx_xxxx
 *      0b1xxx_xxxx
 *      0b0xxx_xxxx
 *      0b0xxx_xxxx
 *      0b0xxx_xxxx
 *      0b0xxx_xxxx
 *      0b0xxx_xxxx
 *      x bits indices char position in diagram.
**/
use super::generic::{GenericDiagram, GenericResult};
use bitcoin::hashes::{sha256, Hash};

/// Animate Diagram
#[derive(Debug, Clone, PartialEq)]
pub struct AnimateDiagram(pub Vec<[[Option<char>; 7]; 7]>);

impl GenericDiagram<7, 7> for AnimateDiagram {
    type Item = char;

    fn to_bytes(&self) -> GenericResult<Vec<u8>> {
        let mut chars = Vec::new();
        let mut frames = Vec::new();
        self.0.iter().rev().for_each(|mx| {
            let mut indices = [0_u8; 7];
            (0..7).rev().for_each(|col| {
                (0..7).rev().for_each(|row| {
                    if let Some(ch) = mx[row][col] {
                        chars.push(ch);
                        indices[row] |= 1 << (6 - col);
                    }
                });
            });
            indices[1] |= 1 << 7; // version number of animate diagram
            frames.push(indices);
        });
        frames[0][0] |= 1 << 7; // end frame of animate diagram

        let str = chars.into_iter().collect::<String>();
        let mut secret = [str.as_bytes(), &frames.concat()].concat();
        let check = sha256::Hash::hash(&secret).as_byte_array()[0];
        secret.push(check);
        Ok(secret)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_animate() -> GenericResult<()> {
        let mut cube = vec![[[None; 7]; 7], [[Some('X'); 7]; 7], [[None; 7]; 7]];
        cube[0][3][3] = Some('X');
        cube[2][6][6] = Some('X');
        let diagram = AnimateDiagram(cube);

        let bytes = diagram.to_bytes()?;
        assert_eq!(
            &bytes[51..],
            [
                128, 128, 0, 0, 0, 0, 1, // end frame
                127, 255, 127, 127, 127, 127, 127, // frame 1
                0, 128, 0, 8, 0, 0, 0,  // frame 0
                24, // checksum
            ]
        );

        let master = diagram.bip32_master("123456".as_bytes())?;
        #[cfg(not(feature = "testnet"))]
        const MASTER: &str = "xprv9s21ZrQH143K3LZCYpVpieDdNgMkymbiawMFUAPysrTJJrkrVCpaFtEUXBpr32nVVeHjPtqRCqih7ptuiu5A34VHPPPZMZfqisJyV6jhCwU";
        #[cfg(feature = "testnet")]
        const MASTER: &str = "tprv8ZgxMBicQKsPe9njDPMKtHqcgomyDHdivVGNLapSMpwn6TVwUaAKmdbvSMzW3QAos5pWPzTBNCJVagSer7R6r7ksv2bs1vPtdy4Pvr2uKuZ";
        assert_eq!(master.to_string(), MASTER);
        Ok(())
    }
}