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
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

use super::{Bip39Error, Mnemonic};
use bitcoin::bip32::Xpriv;
use std::str::FromStr;

type Result<T> = std::result::Result<T, Bip39Error>;

/// BIP39 Derivation for Xpriv
///
/// Create bip32 master key from mnemonic words list.
///
/// see: [BIP39 spec](https://bips.dev/39/)
///
/// # Examples
/// ```
/// use artimonist::{BIP39, Xpriv};
///
/// let mnemonic = "lake album jump occur hedgehog fantasy drama sauce oyster velvet gadget control behave hamster begin";
/// let xprv = mnemonic.mnemonic_to_master("๐ŸŒฑ")?;
/// # #[cfg(not(feature = "testnet"))]
/// assert_eq!(xprv.to_string(), "xprv9s21ZrQH143K36NWXJp6dEYdnu27DM1GdQB7jxTtmXZDk4Bs65ZuHTV92tN5Dp42VPEnkAMknGM2FbStkEFUmH8g7AbPVi7jZNQgKMrAZYJ");
///
/// # Ok::<(), artimonist::Error>(())
/// ```
/// # Reference
/// [1] - [BIP39 spec](https://bips.dev/39/)
/// [2] - [Ref website](https://iancoleman.io/bip39/)
pub trait Bip39 {
    /// Convert a mnemonic phrase to a master key.
    fn mnemonic_to_master(&self, salt: &str) -> Result<Xpriv>;
}

impl<T> Bip39 for T
where
    T: AsRef<str>,
{
    #[inline]
    fn mnemonic_to_master(&self, salt: &str) -> Result<Xpriv> {
        Mnemonic::from_str(self.as_ref())?.to_master(salt)
    }
}

#[cfg(test)]
mod bip39_test_english {
    use super::*;
    #[test]
    fn test_bip39() -> Result<()> {
        #[cfg(not(feature = "testnet"))]
        const TEST_DATA: &[[&str; 3]] = &[[
            "theme rain hollow final expire proud detect wife hotel taxi witness strategy park head forest",
            "๐Ÿ”๐ŸŸ๐ŸŒญ๐Ÿ•",
            "xprv9s21ZrQH143K2k5PPw697AeKWWdeQueM2JCKu8bsmF7M7dDmPGHecHJJNGeujWTJ97Fy9PfobsgZfxhcpWaYyAauFMxcy4fo3x7JNnbYQyD",
        ]];
        #[cfg(feature = "testnet")]
        const TEST_DATA: &[[&str; 3]] = &[[
            "theme rain hollow final expire proud detect wife hotel taxi witness strategy park head forest",
            "๐Ÿ”๐ŸŸ๐ŸŒญ๐Ÿ•",
            "tprv8ZgxMBicQKsPdZJv4VweGpGJpe3reRgMMr7SmZ2LFDbpuDxrNddQ82fkHSpZjsqcWYnk9VHZmEGN8pFMwivVnDrVn1AvdRPqy3ripW55kfq",
        ]];
        for x in TEST_DATA {
            let xpriv = x[0].mnemonic_to_master(x[1])?;
            assert_eq!(xpriv.to_string(), x[2]);
        }
        Ok(())
    }
}

#[cfg(not(feature = "testnet"))]
#[cfg(test)]
mod bip39_test_multilingual {
    use super::*;

    /// # Reference
    ///     <https://iancoleman.io/bip39>
    #[test]
    fn test_bip39() -> Result<()> {
        const TEST_DATA: &[[&str; 3]] = &[
            [
                "solda osso frasco encontro donzela oficina colono vidraria fruteira sinal visto sacola mirtilo flamingo ereto",
                "",
                "xprv9s21ZrQH143K2KFS6iHoFXZC9Y5AWVKwxZis4GMRkQeaTFHiNRTkrjCsnBZ46s7VNihoMapH64FE93ZbzZ28Ld2oiHh6FYQx4eA8jEisYsc",
            ],
            [
                "ๅฒ— ่ทจ ๅ›ฐ ๅ€’ ่€ƒ ้‚ฆ ่ฐƒ ๆ™’ ๆ…ข ๅญŸ ็•… ๅŸ‹ ้ปŽ ๅฅ ็šฎ",
                "้ปŽๅฅ็šฎ",
                "xprv9s21ZrQH143K2SwhdXXWCKa3Sj3mw6123eUe4osWEbHavCv7FDqgFChzfedPDmgnHm9qnQrdveb8sVrywNxxBYCXTdaeNyxRRmhF4q33ovb",
            ],
            [
                "แ„แ…ณแ†ฏแ„…แ…ฅแ†ธ แ„Œแ…กแ†จแ„€แ…ก แ„‰แ…ฉแ„‰แ…ฅแ†ฏ แ„‡แ…ฎแ„Œแ…ฉแ†จ แ„‡แ…งแ†ฏแ„ƒแ…ฉ แ„‹แ…ตแ†ฏแ„Œแ…ฅแ†ผ แ„†แ…ฉแ„€แ…ณแ†ท แ„’แ…ชแ†จแ„Œแ…กแ†ผ แ„‰แ…ฉแ„’แ…งแ†ผ แ„แ…ฉแ†ทแ„‘แ…ณแ†ฏแ„…แ…ฆแ†จแ„‰แ…ณ แ„’แ…ฌแ„‡แ…ฉแ†จ แ„Žแ…ฉแ†บแ„‡แ…ฎแ†ฏ แ„‹แ…ฑแ„‰แ…ฅแ†ผ แ„‰แ…ฅแ†ผแ„‡แ…งแ†ฏ แ„‡แ…ตแ„‡แ…กแ„…แ…กแ†ท",
                "๐Ÿ˜Ž",
                "xprv9s21ZrQH143K43d7XRnapkCsoE2bLUJfA57hYseNpDaJxf5rpuhHgHjSXNMGMpaGYNNZfxxBzv1e2kW5CSy7p1rddfWYXtvYhgC6MPfHd9Z",
            ],
            [
                "theme rain hollow final expire proud detect wife hotel taxi witness strategy park head forest",
                "๐Ÿ”๐ŸŸ๐ŸŒญ๐Ÿ•",
                "xprv9s21ZrQH143K2k5PPw697AeKWWdeQueM2JCKu8bsmF7M7dDmPGHecHJJNGeujWTJ97Fy9PfobsgZfxhcpWaYyAauFMxcy4fo3x7JNnbYQyD",
            ],
        ];
        for x in TEST_DATA {
            let xpriv = x[0].mnemonic_to_master(x[1])?;
            assert_eq!(xpriv.to_string(), x[2]);
        }

        const INVALID_CHECKSUM: &[&str] = &[
            "solda osso frasco encontro donzela oficina colono vidraria fruteira sinal visto sacola mirtilo flamingo final",
            "theme rain hollow sinal expire proud detect wife hotel taxi witness strategy park head forest",
            "ๅฒ— ่ทจ ๅ›ฐ ๅ€’ ่€ƒ ้‚ฆ ่ฐƒ ๆ™’ ๆ…ข ๅญŸ ็•… ๅฅ ๅŸ‹ ้ปŽ ็šฎ",
        ];
        for x in INVALID_CHECKSUM {
            let r = x.mnemonic_to_master("");
            assert!(matches!(r, Err(Bip39Error::InvalidChecksum)));
        }

        const INVALID_LENGTH: &[&str] = &[
            " ่ทจ ๅ›ฐ ๅ€’ ่€ƒ ้‚ฆ ่ฐƒ ๆ™’ ๆ…ข ๅญŸ ็•… ๅฅ ๅŸ‹ ้ปŽ ็šฎ",
            "theme rain hollow sinal expire proud detect wife hotel taxi witness",
        ];
        for x in INVALID_LENGTH {
            let r = x.mnemonic_to_master("");
            assert!(matches!(r, Err(Bip39Error::InvalidSize)));
        }
        Ok(())
    }
}