10 releases

0.8.7 Aug 23, 2023
0.8.3 Mar 15, 2023
0.7.0 Jul 6, 2022
0.6.0 Dec 20, 2021
0.2.2 Apr 4, 2021

#762 in Magic Beans

Download history 37796/week @ 2023-12-05 34700/week @ 2023-12-12 31635/week @ 2023-12-19 19196/week @ 2023-12-26 32344/week @ 2024-01-02 40941/week @ 2024-01-09 45218/week @ 2024-01-16 47154/week @ 2024-01-23 57107/week @ 2024-01-30 49136/week @ 2024-02-06 47932/week @ 2024-02-13 45804/week @ 2024-02-20 42069/week @ 2024-02-27 40805/week @ 2024-03-05 43257/week @ 2024-03-12 36971/week @ 2024-03-19

171,706 downloads per month
Used in 195 crates (7 directly)

MIT/Apache

83KB
2K SLoC

coins-bip32

This is an implementation of BIP32. It uses k256 and re-exports several of its traits and types.

It can be used to build wallets and applications for Bitcoin and Ethereum.

Building

$ cargo build
$ cargo build --target wasm32-unknown-unknown

Run tests (make sure to run with all feature combinations):

$ cargo test

Run bench marks

$ cargo bench
$ cargo bench --no-default-features

lib.rs:

This crate provides a basic implementation of BIP32, BIP49, and BIP84. It can be easily adapted to support other networks, using the paramaterizable encoder.

Typically, users will want to use the MainnetEncoder, DerivedXPub, DerivedXPriv types, which are available at the crate root. If key derivations are unknown, use the XPub and XPriv objects instead. These may be deserialized using a network-specific Encoder from the enc module.

Useful traits will need to be imported from the enc or model modules. We also provide a prelude module with everything you need to get started.

Warnings:

  • This crate is NOT designed to be used in adversarial environments.
  • This crate has NOT had a comprehensive security review.

Usage

use coins_bip32::prelude::*;

let digest = coins_core::Hash256::default();

let xpriv_str = "xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi".to_owned();

let xpriv: XPriv = xpriv_str.parse().unwrap();

let child_xpriv = xpriv.derive_child(33)?;
let (sig, _recovery_id): (Signature, RecoveryId) = child_xpriv.sign_digest(digest.clone());

// Signing key types are associated with verifying key types. You can always derive a pubkey
let child_xpub = child_xpriv.verify_key();
child_xpub.verify_digest(digest.clone(), &sig)?;

MainnetEncoder::xpub_to_base58(&child_xpub)?;

Dependencies

~5MB
~87K SLoC