rgb-lib 0.2.2

RGB wallet library
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

//! RGB wallet keys
//!
//! This module defines the [`Keys`] structure and its related functions.

use bdk::bitcoin::secp256k1::Secp256k1;
use bdk::bitcoin::Network as BdkNetwork;
use bdk::keys::bip39::{Language, Mnemonic, WordCount};
use bdk::keys::{DerivableKey, ExtendedKey, GeneratableKey};
use serde::{Deserialize, Serialize};

use crate::{BitcoinNetwork, Error};

/// A set of Bitcoin keys used by the wallet.
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Keys {
    /// Mnemonic phrase
    pub mnemonic: String,
    /// xPub corresponding to the mnemonic phrase
    pub xpub: String,
    /// Fingerprint of the xPub
    pub xpub_fingerprint: String,
}

/// Generate a set of [`Keys`] for the given Bitcoin network.
pub fn generate_keys(bitcoin_network: BitcoinNetwork) -> Keys {
    let bdk_network = BdkNetwork::from(bitcoin_network);
    let mnemonic = Mnemonic::generate((WordCount::Words12, Language::English))
        .expect("to be able to generate a new mnemonic");
    let xkey: ExtendedKey = mnemonic
        .clone()
        .into_extended_key()
        .expect("a valid key should have been provided");
    let xpub = &xkey.into_xpub(bdk_network, &Secp256k1::new());
    Keys {
        mnemonic: mnemonic.to_string(),
        xpub: xpub.clone().to_string(),
        xpub_fingerprint: xpub.fingerprint().to_string(),
    }
}

/// Recreate a set of [`Keys`] from the given mnemonic phrase.
pub fn restore_keys(bitcoin_network: BitcoinNetwork, mnemonic: String) -> Result<Keys, Error> {
    let bdk_network = BdkNetwork::from(bitcoin_network);
    let mnemonic = Mnemonic::parse_in(Language::English, mnemonic)?;
    let xkey: ExtendedKey = mnemonic
        .clone()
        .into_extended_key()
        .expect("a valid key should have been provided");
    let xpub = &xkey.into_xpub(bdk_network, &Secp256k1::new());
    Ok(Keys {
        mnemonic: mnemonic.to_string(),
        xpub: xpub.clone().to_string(),
        xpub_fingerprint: xpub.fingerprint().to_string(),
    })
}

#[cfg(test)]
mod test {
    use super::*;
    use bitcoin::bip32::ExtendedPubKey;
    use std::str::FromStr;

    #[test]
    fn generate_success() {
        let Keys {
            mnemonic,
            xpub,
            xpub_fingerprint,
        } = generate_keys(BitcoinNetwork::Regtest);

        assert!(Mnemonic::from_str(&mnemonic).is_ok());
        let pubkey = ExtendedPubKey::from_str(&xpub);
        assert!(pubkey.is_ok());
        assert_eq!(pubkey.unwrap().fingerprint().to_string(), xpub_fingerprint);
    }

    #[test]
    fn restore_success() {
        let network = BitcoinNetwork::Regtest;
        let Keys {
            mnemonic,
            xpub,
            xpub_fingerprint,
        } = generate_keys(network);

        let keys = restore_keys(network, mnemonic).unwrap();
        assert_eq!(keys.xpub, xpub);
        assert_eq!(keys.xpub_fingerprint, xpub_fingerprint);
    }
}