anychain_kms/bip32/
mod.rs

1mod child_number;
2mod derivation_path;
3mod error;
4mod extended_key;
5mod prefix;
6mod private_key;
7mod public_key;
8
9pub use child_number::ChildNumber;
10pub use error::{Error, Result};
11pub use extended_key::{
12    attrs::ExtendedKeyAttrs, extended_private_key::ExtendedPrivateKey,
13    extended_public_key::ExtendedPublicKey, ExtendedKey,
14};
15pub use extended_key::{
16    extended_private_key::{XprvEd25519, XprvSecp256k1},
17    extended_public_key::{XpubEd25519, XpubSecp256k1},
18};
19pub use prefix::Prefix;
20pub use private_key::PrivateKey;
21pub use public_key::PublicKey;
22
23pub use derivation_path::DerivationPath;
24
25/// Chain code: extension for both private and public keys which provides an
26/// additional 256-bits of entropy.
27pub type ChainCode = [u8; KEY_SIZE];
28
29/// Derivation depth.
30pub type Depth = u8;
31
32/// BIP32 key fingerprints.
33pub type KeyFingerprint = [u8; 4];
34
35/// BIP32 "versions": integer representation of the key prefix.
36pub type Version = u32;
37
38/// HMAC with SHA-512
39pub type HmacSha512 = hmac::Hmac<sha2::Sha512>;
40
41pub const KEY_SIZE: usize = 32;
42
43#[cfg(test)]
44mod test_mod {
45    use super::*;
46
47    pub(crate) struct TestVector {
48        pub seed: &'static str,
49        pub ckd: [(&'static str, &'static str, &'static str); 6],
50    }
51
52    // bip32 standard test vectors
53    const VECTORS :[TestVector;1] = [
54        TestVector{
55            seed: "000102030405060708090a0b0c0d0e0f",
56            ckd: [
57                (
58                    "m",
59                    "xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi",
60                    "xpub661MyMwAqRbcFtXgS5sYJABqqG9YLmC4Q1Rdap9gSE8NqtwybGhePY2gZ29ESFjqJoCu1Rupje8YtGqsefD265TMg7usUDFdp6W1EGMcet8"
61                ),
62                (
63                    "m/0'",
64                    "xprv9uHRZZhk6KAJC1avXpDAp4MDc3sQKNxDiPvvkX8Br5ngLNv1TxvUxt4cV1rGL5hj6KCesnDYUhd7oWgT11eZG7XnxHrnYeSvkzY7d2bhkJ7",
65                    "xpub68Gmy5EdvgibQVfPdqkBBCHxA5htiqg55crXYuXoQRKfDBFA1WEjWgP6LHhwBZeNK1VTsfTFUHCdrfp1bgwQ9xv5ski8PX9rL2dZXvgGDnw"
66                ),
67                (
68                    "m/0'/1",
69                    "xprv9wTYmMFdV23N2TdNG573QoEsfRrWKQgWeibmLntzniatZvR9BmLnvSxqu53Kw1UmYPxLgboyZQaXwTCg8MSY3H2EU4pWcQDnRnrVA1xe8fs",
70                    "xpub6ASuArnXKPbfEwhqN6e3mwBcDTgzisQN1wXN9BJcM47sSikHjJf3UFHKkNAWbWMiGj7Wf5uMash7SyYq527Hqck2AxYysAA7xmALppuCkwQ"
71                ),
72                (
73                    "m/0'/1/2'",
74                    "xprv9z4pot5VBttmtdRTWfWQmoH1taj2axGVzFqSb8C9xaxKymcFzXBDptWmT7FwuEzG3ryjH4ktypQSAewRiNMjANTtpgP4mLTj34bhnZX7UiM",
75                    "xpub6D4BDPcP2GT577Vvch3R8wDkScZWzQzMMUm3PWbmWvVJrZwQY4VUNgqFJPMM3No2dFDFGTsxxpG5uJh7n7epu4trkrX7x7DogT5Uv6fcLW5"
76                ),
77                (
78                    "m/0'/1/2'/2",
79                    "xprvA2JDeKCSNNZky6uBCviVfJSKyQ1mDYahRjijr5idH2WwLsEd4Hsb2Tyh8RfQMuPh7f7RtyzTtdrbdqqsunu5Mm3wDvUAKRHSC34sJ7in334",
80                    "xpub6FHa3pjLCk84BayeJxFW2SP4XRrFd1JYnxeLeU8EqN3vDfZmbqBqaGJAyiLjTAwm6ZLRQUMv1ZACTj37sR62cfN7fe5JnJ7dh8zL4fiyLHV"
81                ),
82                (
83                    "m/0'/1/2'/2/1000000000",
84                    "xprvA41z7zogVVwxVSgdKUHDy1SKmdb533PjDz7J6N6mV6uS3ze1ai8FHa8kmHScGpWmj4WggLyQjgPie1rFSruoUihUZREPSL39UNdE3BBDu76",
85                    "xpub6H1LXWLaKsWFhvm6RVpEL9P4KfRZSW7abD2ttkWP3SSQvnyA8FSVqNTEcYFgJS2UaFcxupHiYkro49S8yGasTvXEYBVPamhGW6cFJodrTHy"
86                )
87            ]
88        }
89    ];
90
91    #[test]
92    pub fn test_vectors() {
93        VECTORS.iter().for_each(|vector| {
94            let seed = hex::decode(vector.seed).unwrap();
95            vector.ckd.iter().for_each(|item| {
96                let path: DerivationPath = item.0.parse().unwrap();
97                let xprv = XprvSecp256k1::new_from_path(seed.clone(), &path).unwrap();
98                let xpub = xprv.public_key();
99                assert_eq!(item.1, xprv.to_string(Prefix::XPRV).as_str());
100                assert_eq!(item.2, xpub.to_string(Prefix::XPUB).as_str());
101            })
102        })
103    }
104}