4 releases

0.6.0 Dec 5, 2024
0.5.1 Oct 17, 2024
0.5.0 Oct 15, 2024

#11 in #bip-32

Download history 254/week @ 2024-10-12 126/week @ 2024-10-19 134/week @ 2024-10-26 238/week @ 2024-11-02 230/week @ 2024-11-09 607/week @ 2024-11-16 386/week @ 2024-11-23 532/week @ 2024-11-30 412/week @ 2024-12-07 95/week @ 2024-12-14 10/week @ 2024-12-21 17/week @ 2024-12-28

685 downloads per month
Used in 4 crates

MIT/Apache

61KB
729 lines

License Docs Crates io Discord

HD wallets derivation

This crate supports the following HD derivations:

  • SLIP10 (compatible with BIP32), see Slip10
  • Non-standard Edwards derivation for ed25519 curve

To perform HD derivation, use HdWallet trait.

Example: SLIP10 derivation

Derive a master key from the seed, and then derive a child key m/1H/10:

use hd_wallet::{slip10, curves::Secp256k1};

let seed = b"16-64 bytes of high entropy".as_slice();
let master_key = slip10::derive_master_key::<Secp256k1>(seed)?;
let master_key_pair = hd_wallet::ExtendedKeyPair::from(master_key);

let child_key_pair = slip10::derive_child_key_pair_with_path(
    &master_key_pair,
    [1 + hd_wallet::H, 10],
);

Example: via HdWallet trait

HdWallet trait generalizes HD derivation algorithm, you can use it with generics:

use hd_wallet::{Slip10, curves::Secp256r1};

fn derive_using_generic_algo<E: generic_ec::Curve, Hd: hd_wallet::HdWallet<E>>(
    master_key: hd_wallet::ExtendedKeyPair<E>,
) -> hd_wallet::ExtendedKeyPair<E>
{
    Hd::derive_child_key_pair_with_path(
        &master_key,
        [1 + hd_wallet::H, 10],
    )
}

// Use it with any HD derivation:
let seed = b"16-64 bytes of high entropy".as_slice();
let master_key = hd_wallet::slip10::derive_master_key(seed)?;
let master_key_pair = hd_wallet::ExtendedKeyPair::from(master_key);
let child_key = derive_using_generic_algo::<Secp256r1, Slip10>(master_key_pair);

Features

  • curve-secp256k1, curve-secp256r1, curve-ed25519, curve-stark add curve implementation into the crate curves module
  • all-curves adds all curves listed above
  • slip10, edwards, stark add slip10, edwards, and stark HD derivations respectively
  • serde adds serde::{Serialize, Deserialize} traits implementation to the types in the library

Join us in Discord!

Feel free to reach out to us in Discord!

Dependencies

~1.3–3.5MB
~65K SLoC