2 unstable releases

0.2.0 May 15, 2023
0.1.0 Apr 20, 2023

#1 in #walletd


Used in 4 crates

MIT/Apache

75KB
1K SLoC

WalletD HD Key

walletd_hd_key is a Rust library implementation of the BIP-32 standard's hierarchical deterministic (HD) key generation.

More information about this crate can be found in the crate documentation.

High level features

This library supports key generation using the following BIPs (Bitcoin Improvement Proposal).

  • BIP32 - Hierarchical Deterministic Wallets
  • BIP44 - Multi-Account Hierarchy for Deterministic Wallets
  • BIP49 - Derivation scheme for P2WPKH-nested-in-P2SH based accounts
  • BIP84 - Derivation scheme for P2WPKH based accounts

Usage example

See the crate documentation usage examples.

Safety

This crate uses #![forbid(unsafe_code)] to ensure everything is implemented in 100% safe Rust.

Minimum supported Rust version

hd_key's MSRV is 1.60.

Examples

The examples folder contains various examples of how to use hd_key. The docs also provide lots of code snippets and examples.

Getting Help

In the hd_key's repo we also have a number of examples showing how to put everything together. You're also welcome to open a discussion with your question.

Contributing

🎈 Thanks for your help improving the project! We are so happy to have you! We have a contributing guide to help you get involved in the hd_key project.

License

Licensed under the Apache license, Version 2.0 or the MIT license, at your option. Files in the project may not be copied, modified, or distributed except according to those terms.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in hd_key by you, shall be licensed as MIT, without any additional terms or conditions.

Dependencies

~8MB
~107K SLoC