artimonist 2.0.1

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

/*! BIP85 Password characters
 *
 */

/// Password encode type
#[allow(unused)]
#[derive(Debug, Default, PartialEq, Eq, Clone, Copy)]
pub enum Password {
    /// Standard Base64 characters
    Legacy, // legacy Base64
    /// Base58 add 6 common symbols
    #[default]
    Distinct, // "@#$%&*" + Base58
    /// Emoji password
    Emoji, // emoji characters
    /// Mixture Distinct and Emoji
    Mixture, // "@#$%&*" + Base58 + Emoji
}

impl Password {
    /// Get password character by index  
    /// 0 <= index < 64, Mixture: 0 <= index < 128  
    /// # Panics  
    /// Mixture: if index >= 128, panic, bits() == 7  
    /// Others: if index >= 64, panic, bits() == 6  
    #[inline]
    pub(crate) fn char_at(&self, index: usize) -> char {
        match &self {
            Password::Legacy => char::from_u32(LEGACY_BYTES[index] as u32).unwrap(),
            Password::Distinct => char::from_u32(DISTINCT_BYTES[index] as u32).unwrap(),
            Password::Emoji => EMOJI_CHARS[index],
            Password::Mixture => match index & 0b0100_0000 {
                0 => char::from_u32(DISTINCT_BYTES[index] as u32).unwrap(),
                _ => EMOJI_CHARS[index >> 1],
            },
        }
    }

    #[inline]
    pub(crate) fn bits(&self) -> usize {
        match &self {
            Password::Mixture => 7,
            _ => 6,
        }
    }
}

const LEGACY_BYTES: &[u8; 64] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";

const DISTINCT_BYTES: &[u8; 64] =
    b"@#$%&*123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";

const EMOJI_CHARS: &[char; 64] = &[
    // U+1F60A, U+1F60D, U+1F61B, U+1F62D, U+1F60E, U+1F47D, U+1F480, U+1F47B,
    '😊', '😍', '😛', '😭', '😎', '👽', '💀', '👻',
    // U+270B, U+1F44C, U+1F449, U+1F44D, U+2764, U+1F48B, U+1F64F, U+1F4AA,
    '✋', '👌', '👉', '👍', '❤', '💋', '🙏', '💪',
    // U+1F435, U+1F436, U+1F434, U+1F437, U+1F414, U+1F438, U+1F40D, U+1F42C,
    '🐵', '🐶', '🐴', '🐷', '🐔', '🐸', '🐍', '🐬',
    // U+1F337, U+1F33B, U+1F331, U+1F334, U+1F335, U+1F340, U+1F344, U+1F352,
    '🌻', '🌷', '🌱', '🌴', '🌵', '🍀', '🍄', '🍒',
    // U+1F354, U+1F35F, U+1F355, U+1F366, U+1F37A, U+1F349, U+1F34C, U+1F34E,
    '🍔', '🍟', '🍕', '🍦', '🍺', '🍉', '🍌', '🍎',
    // U+1F3E0, U+23F0, U+1F512, U+2615, U+1F697, U+1F6B2, U+2708, U+1F680,
    '🏠', '⏰', '💊', '☕', '🚗', '🚲', '✈', '🚀',
    // U+2600, U+1F319, U+2B50, U+26A1, U+2614, U+1F308, U+1F525, U+1F4A7,
    '☀', '🌙', '⭐', '⚡', '☔', '🌈', '🔥', '💧',
    // U+1F384, U+1F381, U+1F388, U+1F389, U+1F514, U+1F3C6, U+1F511, U+1F48A,
    '🎄', '🎁', '🎈', '🎉', '🔔', '🏆', '🔒', '🔑',
];

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

    #[test]
    fn test_password() {
        let password = Password::Legacy;
        assert_eq!(password.char_at(0), 'A');
        assert_eq!(password.char_at(63), '/');
        let password = Password::Distinct;
        assert_eq!(password.char_at(0), '@');
        assert_eq!(password.char_at(63), 'z');
        let password = Password::Emoji;
        assert_eq!(password.char_at(0), '😊');
        assert_eq!(password.char_at(63), '🔑');
        let pwd = Password::Mixture;
        assert_eq!(pwd.bits(), 7);
        assert_eq!(
            [pwd.char_at(0), pwd.char_at(33), pwd.char_at(55)],
            ['@', 'U', 'r']
        );
        assert_eq!(
            [pwd.char_at(65), pwd.char_at(77), pwd.char_at(121)],
            ['🍔', '🍌', '🔔']
        );
    }
}