lwk_common 0.17.0

Liquid Wallet Kit - Common utilities
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

use elements_miniscript::elements::bitcoin::bip32::{DerivationPath, Fingerprint, Xpub};
use std::str::FromStr;
use thiserror::Error;

/// The error type returned by keyorigin_xpub_from_str
#[derive(Error, Debug)]
#[error("Invalid key origin xpub \"{0}\", expected [fingerprint/path]xpub")]
pub struct InvalidKeyOriginXpub(String);

// TODO: cleanup this fn
/// Parse a keyorigin xpub from a string
///
/// Example: "[73c5da0a/84h/1h/0h]tpub..."
pub fn keyorigin_xpub_from_str(
    s: &str,
) -> Result<(Option<(Fingerprint, DerivationPath)>, Xpub), InvalidKeyOriginXpub> {
    let parts: Vec<_> = s.split('[').collect();
    if parts.len() == 1 {
        let xpub = Xpub::from_str(s).map_err(|e| InvalidKeyOriginXpub(e.to_string()))?;
        return Ok((None, xpub));
    }
    if parts.len() != 2 {
        return Err(InvalidKeyOriginXpub("unexpected format".to_string()));
    }
    if !parts[0].is_empty() {
        return Err(InvalidKeyOriginXpub("unexpected format".to_string()));
    }
    let s = parts[1];

    let parts: Vec<_> = s.split(']').collect();
    if parts.len() != 2 {
        return Err(InvalidKeyOriginXpub("unexpected format".to_string()));
    }
    let keyorigin = parts[0];
    let xpub = parts[1];

    if keyorigin.len() < 9 {
        return Err(InvalidKeyOriginXpub("unexpected format".to_string()));
    }
    let fingerprint = &keyorigin[0..8];
    if &keyorigin[8..9] != "/" {
        return Err(InvalidKeyOriginXpub("unexpected format".to_string()));
    }
    let path = format!("m/{}", &keyorigin[9..]);

    let fingerprint =
        Fingerprint::from_str(fingerprint).map_err(|e| InvalidKeyOriginXpub(e.to_string()))?;
    let path = DerivationPath::from_str(&path).map_err(|e| InvalidKeyOriginXpub(e.to_string()))?;
    let xpub = Xpub::from_str(xpub).map_err(|e| InvalidKeyOriginXpub(e.to_string()))?;
    Ok((Some((fingerprint, path)), xpub))
}

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

    #[test]
    fn test_keyoriginxpub() {
        let fingerprint = "11a345ad";
        let path = "84h/1h/0h";
        let xpub = "tpubDCTUqRMrF2GHZ6pi5FcamdyGZ3oDJtQMH4y5Hyh8Uu7CQ3Zymbh1hpM84aXyJhgBhuh6WcUpKteMeYdyYfVUDRrsz8FUeRdoaaSRKkyMx6Y";

        let s = &format!("[{fingerprint}/{path}]{xpub}");
        keyorigin_xpub_from_str(s).unwrap();
        keyorigin_xpub_from_str(xpub).unwrap();

        for s in [
            &format!("{fingerprint}/{path}]{xpub}"),
            &format!("[[{fingerprint}/{path}]{xpub}"),
            &format!("x[{fingerprint}/{path}]{xpub}"),
            &format!("[{fingerprint}/{path}]]{xpub}"),
            &format!("[{fingerprint}]{xpub}"),
            &format!("[{fingerprint}-{path}]{xpub}"),
            &format!("[x1a345ad/{path}]{xpub}"),
            &format!("[{fingerprint}/x/{path}]{xpub}"),
            &format!("[{fingerprint}/{path}]1{xpub}"),
        ] {
            keyorigin_xpub_from_str(s).expect_err("test");
        }
    }
}