artimonist 0.9.1

A tool for generating mnemonics based on diagrams.
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

pub use super::{bits::BitOperation, password::Password, words::Language};
use bitcoin::{
    bip32::{ChainCode, ChildNumber, Xpriv},
    hashes::{hmac, sha256, sha512, Hash, HashEngine},
    hex::DisplayHex,
    key::Secp256k1,
    secp256k1::SecretKey,
    Address, CompressedPublicKey,
};
use std::str::FromStr;

/// BIP85 Derivation for Xpriv
///
/// Deterministic Entropy From BIP32 Keychains.
///
/// see: [BIP85 spec](https://bips.dev/85/)
///
/// # Examples
/// ```
/// use artimonist::{BIP85, Xpriv, Password};
/// # use std::str::FromStr;
///
/// let master = Xpriv::from_str("xprv9s21ZrQH143K2sW69WDMTge7PMoK1bfeMy3cpNJxfSkqpPsU7DeHZmth8Sw7DVV2AMbC4jR3fKKgDEPJNNvsqhgTfyZwmWj439MWXUW5U5K")?;
/// # #[cfg(not(feature = "test"))]
/// assert_eq!(master.bip85_wif(3)?.pk, "L43Bwws5GvHAtct3RqBg5A3JbJmoLrLGohLWDyizaXwh7ucSH6xd");
/// # #[cfg(not(feature = "test"))]
/// assert_eq!(master.bip85_xpriv(0)?, "xprv9s21ZrQH143K4AAZnirHuLg8Bq1Q8ozezrJjhyYhF2ZJqDC5qbs1XMCggai5xFrgabXtyyERCAS4k6tiKbe42PRYPP32BN9xgxPP1rv7tSv".to_owned());
/// # #[cfg(not(feature = "test"))]
/// assert_eq!(master.bip85_pwd(Password::Distinct, 28, 50)?, "1bJc8dXiPh#&q$qHR$SBNiPxKBfU");
/// # #[cfg(not(feature = "test"))]
/// assert_eq!(master.bip85_pwd(Password::Emoji, 20, 100)?, "⏰🍟☕👍🎁🍉🔑👍💪🚗🎈🎄🎄🏆🍦👽🐵🍕🔒🍦");
///
/// # Ok::<(), artimonist::Error>(())
/// ```
// # Reference
// [1] - [BIP85 spec](https://bips.dev/85/)
// [2] - [Ref impl](https://github.com/rikitau/rust-bip85)
//
#[allow(unused)]
pub trait Derivation {
    /// Mnemonic words  
    // Path format is: m/83696968'/39'/{language}'/{words}'/{index}'
    ///
    /// # Parameters
    ///   lang: Language in [0 ~ 9]  
    ///   count: words count in [12, 15, 18, 21, 24]  
    ///   index: 0 ~ 2^31  
    ///
    /// # Return
    ///   mnemonic words joined by ascii space
    fn bip85_mnemonic(&self, lang: Language, count: u32, index: u32) -> Bip85Result;

    /// mnemonic list of [24, 21, 18, 15, 12] words from one entropy  
    // Path format is: m/83696968'/39'/{language}'/24'/{index}'
    fn bip85_mnemonic_list(&self, lang: Language, index: u32) -> Bip85Result<[String; 5]>;

    /// HD-Seed WIF  
    // Path format is m/83696968'/2'/{index}'
    fn bip85_wif(&self, index: u32) -> Bip85Result<Wif>;

    /// XPRV  
    // Path format is m/83696968'/32'/{index}'
    fn bip85_xpriv(&self, index: u32) -> Bip85Result;

    /// PWD BASE64  
    // Path format is: m/83696968'/707764'/{pwd_len}'/{index}'
    /// 20 <= pwd_len <= 86
    fn bip85_pwd(&self, pwd_type: Password, pwd_len: usize, index: u32) -> Bip85Result;
}

/// BIP85 Derivation
fn bip85_derive(root: &Xpriv, path: &str) -> Bip85Result<[u8; 64]> {
    let secp = bitcoin::secp256k1::Secp256k1::new();
    let path = bitcoin::bip32::DerivationPath::from_str(path)?;
    let derived = root.derive_priv(&secp, &path)?;

    let mut hmac = hmac::HmacEngine::<sha512::Hash>::new("bip-entropy-from-k".as_bytes());
    hmac.input(&derived.private_key.secret_bytes());
    let data = hmac::Hmac::from_engine(hmac).to_byte_array();
    Ok(data)
}

impl Derivation for Xpriv {
    fn bip85_mnemonic(&self, lang: Language, count: u32, index: u32) -> Bip85Result {
        if !matches!(count, 12 | 15 | 18 | 21 | 24) {
            return Err(Bip85Error::InvalidParameter("count: 12, 15, 18, 21, 24"));
        }
        let (count, index) = (count as usize, index as usize);

        let data = {
            let path = format!("m/83696968'/39'/{}'/{count}'/{index}'", lang as u32);
            let entropy = bip85_derive(self, &path)?[..(count * 4 / 3)].to_vec(); // truncate
            let check = sha256::Hash::hash(&entropy).as_byte_array()[0];
            [entropy, vec![check]].concat()
        };

        Ok(data
            .bit_chunks(11)
            .take(count)
            .map(|i| lang.word_at(i as usize))
            .collect::<Vec<_>>()
            .join(" "))
    }

    fn bip85_mnemonic_list(&self, lang: Language, index: u32) -> Bip85Result<[String; 5]> {
        let path = format!("m/83696968'/39'/{}'/24'/{index}'", lang as u32); // use max len: 24
        let raw_entropy = bip85_derive(self, &path)?;
        Ok([24, 21, 18, 15, 12].map(|n| {
            let data = {
                let entropy = &raw_entropy[..(n * 4 / 3)]; // truncate
                let check = sha256::Hash::hash(entropy).as_byte_array()[0];
                [entropy, &[check]].concat()
            };
            // split to indices, map to words, join to string.
            data.bit_chunks(11)
                .take(n)
                .map(|i| lang.word_at(i as usize))
                .collect::<Vec<_>>()
                .join(" ")
        }))
    }

    fn bip85_wif(&self, index: u32) -> Bip85Result<Wif> {
        let path = format!("m/83696968'/2'/{index}'");
        let entropy = bip85_derive(self, &path)?;
        let priv_key = bitcoin::PrivateKey::from_slice(&entropy[..32], crate::NETWORK)?;
        let pub_key = CompressedPublicKey::from_private_key(&Secp256k1::default(), &priv_key)?;
        let addr = Address::p2shwpkh(&pub_key, crate::NETWORK);
        Ok(Wif {
            pk: priv_key.to_wif(),
            addr: addr.to_string(),
        })
    }

    fn bip85_xpriv(&self, index: u32) -> Bip85Result {
        let path = format!("m/83696968'/32'/{index}'");
        let entropy = bip85_derive(self, &path)?;
        let chain_code = ChainCode::from_hex(&entropy[..32].to_lower_hex_string())?;
        let xpriv = Xpriv {
            network: crate::NETWORK,
            depth: 0,
            parent_fingerprint: Default::default(),
            child_number: ChildNumber::Normal { index: 0 },
            private_key: SecretKey::from_slice(&entropy[32..])?,
            chain_code,
        };
        Ok(xpriv.to_string())
    }

    fn bip85_pwd(&self, password: Password, pwd_len: usize, index: u32) -> Bip85Result {
        if !(20..=86).contains(&pwd_len) {
            return Err(Bip85Error::InvalidParameter("20 <= pwd_len <= 86"));
        }
        let path = format!("m/83696968'/707764'/{pwd_len}'/{index}'");
        let entropy = bip85_derive(self, &path)?;

        Ok(entropy
            .bit_chunks(password.bits())
            .take(pwd_len)
            .map(|v| password.char_at(v as usize))
            .collect::<String>())
    }
}

pub type Bip85Error = crate::Error;
pub type Bip85Result<T = String> = Result<T, crate::Error>;

#[cfg(test)]
mod bip85_test {
    use super::*;
    use bitcoin::hex::DisplayHex;

    #[test]
    fn test_bip85_mnemonic() -> Bip85Result<()> {
        {
            // PATH m/83696968'/39'/0'/18'/0';
            const MASTER_KEY: &str = "xprv9s21ZrQH143K2LBWUUQRFXhucrQqBpKdRRxNVq2zBqsx8HVqFk2uYo8kmbaLLHRdqtQpUm98uKfu3vca1LqdGhUtyoFnCNkfmXRyPXLjbKb";
            const DERIVED_MNEMONIC: &str = "near account window bike charge season chef number sketch tomorrow excuse sniff circle vital hockey outdoor supply token";
            let master = bitcoin::bip32::Xpriv::from_str(MASTER_KEY)?;
            let mnemonic = master.bip85_mnemonic(Language::English, 18, 0)?;
            assert_eq!(mnemonic, DERIVED_MNEMONIC);
        }
        {
            // PATH: m/83696968'/39'/0'/24'/0'
            const MASTER_KEY: &str = "xprv9s21ZrQH143K2LBWUUQRFXhucrQqBpKdRRxNVq2zBqsx8HVqFk2uYo8kmbaLLHRdqtQpUm98uKfu3vca1LqdGhUtyoFnCNkfmXRyPXLjbKb";
            const DERIVED_MNEMONIC: &str = "puppy ocean match cereal symbol another shed magic wrap hammer bulb intact gadget divorce twin tonight reason outdoor destroy simple truth cigar social volcano";
            let master = bitcoin::bip32::Xpriv::from_str(MASTER_KEY)?;
            let mnemonics = master.bip85_mnemonic_list(Language::English, 0)?;
            assert_eq!(mnemonics[0], DERIVED_MNEMONIC);
        }

        Ok(())
    }

    #[cfg(not(feature = "test"))]
    #[test]
    fn test_bip85_wif() -> Bip85Result<()> {
        // PATH: m/83696968'/2'/0';
        const MASTER_KEY: &str = "xprv9s21ZrQH143K2LBWUUQRFXhucrQqBpKdRRxNVq2zBqsx8HVqFk2uYo8kmbaLLHRdqtQpUm98uKfu3vca1LqdGhUtyoFnCNkfmXRyPXLjbKb";
        const DERIVED_WIF: &str = "Kzyv4uF39d4Jrw2W7UryTHwZr1zQVNk4dAFyqE6BuMrMh1Za7uhp";
        let master = bitcoin::bip32::Xpriv::from_str(MASTER_KEY)?;
        let priv_key: String = master.bip85_wif(0)?.pk;
        assert_eq!(priv_key, DERIVED_WIF);
        Ok(())
    }

    #[cfg(not(feature = "test"))]
    #[test]
    fn test_bip85_xpriv() -> Bip85Result<()> {
        // PATH: m/83696968'/32'/0'
        const MASTER_KEY: &str = "xprv9s21ZrQH143K2LBWUUQRFXhucrQqBpKdRRxNVq2zBqsx8HVqFk2uYo8kmbaLLHRdqtQpUm98uKfu3vca1LqdGhUtyoFnCNkfmXRyPXLjbKb";
        const DERIVED_XPRV: &str = "xprv9s21ZrQH143K2srSbCSg4m4kLvPMzcWydgmKEnMmoZUurYuBuYG46c6P71UGXMzmriLzCCBvKQWBUv3vPB3m1SATMhp3uEjXHJ42jFg7myX";
        let master = bitcoin::bip32::Xpriv::from_str(MASTER_KEY)?;
        let xpriv = master.bip85_xpriv(0)?;
        assert_eq!(xpriv, DERIVED_XPRV);
        Ok(())
    }

    #[test]
    fn test_bip85_pwd() -> Bip85Result<()> {
        // PATH: m/83696968'/707764'/21'/0'
        const MASTER_KEY: &str = "xprv9s21ZrQH143K2LBWUUQRFXhucrQqBpKdRRxNVq2zBqsx8HVqFk2uYo8kmbaLLHRdqtQpUm98uKfu3vca1LqdGhUtyoFnCNkfmXRyPXLjbKb";
        const DERIVED_PWD: &str = "dKLoepugzdVJvdL56ogNV";
        let root = bitcoin::bip32::Xpriv::from_str(MASTER_KEY)?;
        let pwd = root.bip85_pwd(Password::Legacy, 21, 0)?;
        assert_eq!(pwd, DERIVED_PWD);
        Ok(())
    }

    /// test bip85 derivation
    /// # Reference
    ///   <https://bips.dev/85/>
    #[test]
    #[ignore = "pre test"]
    fn test_bip85_derivation() -> Result<(), bitcoin::bip32::Error> {
        const MASTER_BIP32_ROOT_KEY: &str = "xprv9s21ZrQH143K2LBWUUQRFXhucrQqBpKdRRxNVq2zBqsx8HVqFk2uYo8kmbaLLHRdqtQpUm98uKfu3vca1LqdGhUtyoFnCNkfmXRyPXLjbKb";
        const PATH: &str = "m/83696968'/0'/0'";
        const DERIVED_KEY: &str =
            "cca20ccb0e9a90feb0912870c3323b24874b0ca3d8018c4b96d0b97c0e82ded0";
        const DERIVED_ENTROPY: &str = "efecfbccffea313214232d29e71563d941229afb4338c21f9517c41aaa0d16f00b83d2a09ef747e7a64e8e2bd5a14869e693da66ce94ac2da570ab7ee48618f7";

        let secp = bitcoin::secp256k1::Secp256k1::new();
        let master = bitcoin::bip32::Xpriv::from_str(MASTER_BIP32_ROOT_KEY)?;
        let path = bitcoin::bip32::DerivationPath::from_str(PATH)?;
        let derived = master.derive_priv(&secp, &path)?;
        let derived_key = derived.private_key.secret_bytes().to_lower_hex_string();
        assert_eq!(derived_key, DERIVED_KEY);

        let mut hmac = hmac::HmacEngine::<sha512::Hash>::new("bip-entropy-from-k".as_bytes());
        hmac.input(&derived.private_key.secret_bytes());
        let data = hmac::Hmac::from_engine(hmac).to_byte_array();
        assert_eq!(data.to_lower_hex_string(), DERIVED_ENTROPY);

        Ok(())
    }

    /// test japanese mnemonic to seed
    /// # Reference
    ///   <https://iancoleman.io/bip39/#japanese>
    #[test]
    #[ignore = "pre test"]
    fn test_japanese_mnemonic_to_seed() {
        const JPAN_WORDS: &str = "すおどり　ひびく　はんこ　しはい　しみん　こたえる　しあわせ　たいいん　えいせい　こそだて　ひかく　とつにゅう　えんぜつ　うけつけ　せんよう";
        const BIP39_SEED: &str = "6059453e22e4fe02ddc75df607e53194d432e2838b20ae82a16f550f16e64869a9b0a3cda1dbadaf2febceceb5ec0fdf66fb0198306159411f3e2501de048ea7";

        let words = JPAN_WORDS.replace('　', " "); // replace to ascii space
        let salt = "mnemonic".as_bytes().to_vec();
        let mut output: [u8; 64] = [0; 64];
        pbkdf2::pbkdf2_hmac::<sha2::Sha512>(words.as_bytes(), &salt, u32::pow(2, 11), &mut output);
        assert_eq!(output.to_lower_hex_string(), BIP39_SEED);
    }
}

// use super::macros::{ImpDeref, ImpDisplay, ImpFrom, ImpPartialEq};

/// String wrapper for extra functions
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Wif {
    /// Private key
    pub pk: String,
    /// Address
    pub addr: String,
}