Crate slip_10

SLIP-10: Deterministic key generation

SLIP10 is a specification for implementing HD wallets. It aims at supporting many curves while being compatible with BIP32.

The implementation is based on generic-ec library that provides generic elliptic curve arithmetic. The crate is no_std and no_alloc friendly.

Curves support

Implementation currently does not support ed25519 curve. All other curves are supported: both secp256k1 and secp256r1. In fact, implementation may work with any curve, but only those are covered by the SLIP10 specs.

The crate also re-exports supported curves in supported_curves module (requires enabling a feature), but any other curve implementation will work with the crate.

Features

• std: enables std library support (mainly, it just implements Error trait for the error types)
• curve-secp256k1 and curve-secp256r1 add curve implementation into the crate supported_curves module

Examples

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

use slip_10::supported_curves::Secp256k1;

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

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

Modules

• errors
  When something goes wrong
• supported_curves
  Curves supported out of the box

Structs

• DerivedShift
  A shift that can be applied to parent key to obtain a child key
• ExtendedKeyPair
  Pair of extended secret and public keys
• ExtendedPublicKey
  Extended public key
• ExtendedSecretKey
  Extended secret key
• HardenedIndex
  Child index in range $2^{31} \le i < 2^{32}$ corresponing to a hardened wallet
• NonHardenedIndex
  Child index in range $0 \le i < 2^{31}$ corresponing to a non-hardened wallet

Enums

• ChildIndex
  Child index, whether hardened or not
• CurveType
  Curves supported by SLIP-10 spec

Constants

• H
  Beggining of hardened child indexes

Traits

• SupportedCurve
  Marker for a curve supported by SLIP10 specs and this library

Functions

• derive_child_key_pair
  Derives child key pair (extended secret key + public key) from parent key pair
• derive_child_key_pair_with_path
  Derives a child key pair with specified derivation path from parent key pair
• derive_child_public_key
  Derives child extended public key from parent extended public key
• derive_child_public_key_with_path
  Derives a child public key with specified derivation path
• derive_hardened_shift
  Derive a shift for hardened child
• derive_master_key
  Derives a master key from the seed
• derive_master_key_with_curve_tag
  Derives a master key from the seed and the curve tag as defined in SLIP10
• derive_public_shift
  Derives a shift for non-hardened child
• try_derive_child_key_pair_with_path
  Derives a child key pair with specified derivation path from parent key pair
• try_derive_child_public_key_with_path
  Derives a child public key with specified derivation path

Type Aliases

• ChainCode
  Chain code of extended key as defined in SLIP-10