Crate hdpath

Common structures and utilities to operate HD Path defined by Bitcoin's BIP-32 standard.

The main specification for the Hierarchical Deterministic Wallets is BIP-32, and HD Path is a part of it which specifies the format for the hierarchy path.

The crate doesn't try to implement Key Derivation specification, but instead implements all common functionality for creating, parsing and displaying an HD Path, especially standard paths defined by BIP-44 and related.

The common structure, defined by BIP-43, is m/purpose'/coin_type'/account'/change/address_index, for example m/44'/0'/0'/0/0

All supported standards:

• BIP-32
• BIP-43
• BIP-44
• BIP-49
• BIP-84

Examples

Basic usage

use hdpath::StandardHDPath;

let hdpath = StandardHDPath::try_from("m/44'/0'/0'/0/0").unwrap();
//prints "m/44'/0'/0'/0/0"
println!("{:?}", hdpath);

//prints "0", which is account id
println!("{:?}", hdpath.account());

//prints: "purpose: Pubkey, coin: 0, account: 0, change: 0, index: 0"
println!("purpose: {:?}, coin: {}, account: {}, change: {}, index: {}",
   hdpath.purpose(),
   hdpath.coin_type(),
   hdpath.account(),
   hdpath.change(),
   hdpath.index())

Create from values

use hdpath::{StandardHDPath, Purpose};

let hdpath = StandardHDPath::new(Purpose::Witness, 0, 1, 0, 101);
//prints "m/84'/0'/1'/0/101"
println!("{:?}", hdpath);

Verify before create

Please note that values for HD Path are limited to 2^31-1 because the highest bit is reserved for marking a hardened value. Therefore, if you're getting individual values from some user input, you should verify the value before passing to ::new. Otherwise the constructor may fail with panic if an invalid value was passed.

use hdpath::{StandardHDPath, PathValue, Purpose};

fn user_path(index: u32) -> Result<StandardHDPath, ()> {
  let user_id = 1234 as u32;
  if PathValue::is_ok(index) {
     Ok(StandardHDPath::new(Purpose::Witness, 0, user_id, 0, index))
  } else {
     Err(())
  }
}

Structs

CustomHDPath	A custom HD Path, that can be any length and contain any Hardened and non-Hardened values in any order. Direct implementation for BIP-32
StandardHDPath	Standard HD Path for BIP-44, BIP-49, BIP-84 and similar. For path as m/purpose'/coin_type'/account'/change/address_index, like m/44'/0'/0'/0/0.

Enums

Error
PathValue
Purpose	The purpose number, a first number in HD Path, which is supposed to be reference actual format. Supposed to be a hardened value See BIP-43