Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
survived committed Dec 15, 2023
1 parent 87c96cc commit fb0fab9
Showing 1 changed file with 4 additions and 16 deletions.
20 changes: 4 additions & 16 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,7 @@
//! use slip10::supported_curves::Secp256k1;
//!
//! let seed = b"16-64 bytes of high entropy".as_slice();
//! let master_key = slip10::derive_master_key::<Secp256k1>(
//! slip10::CurveType::Secp256k1,
//! seed,
//! )?;
//! let master_key = slip10::derive_master_key::<Secp256k1>(seed)?;
//! let master_key_pair = slip10::ExtendedKeyPair::from(master_key);
//!
//! let derivation_path = [1 + slip10::H, 10];
Expand Down Expand Up @@ -79,10 +76,7 @@ type HmacSha512 = hmac::Hmac<sha2::Sha512>;
/// use slip10::supported_curves::Secp256k1;
///
/// # let seed = b"do not use this seed in prod :)".as_slice();
/// let master_key = slip10::derive_master_key::<Secp256k1>(
/// slip10::CurveType::Secp256k1,
/// seed,
/// )?;
/// let master_key = slip10::derive_master_key::<Secp256k1>(seed)?;
/// let master_key_pair = slip10::ExtendedKeyPair::from(master_key);
///
/// let hardened_child = slip10::derive_child_key_pair(
Expand Down Expand Up @@ -335,10 +329,7 @@ pub fn derive_master_key_with_curve_tag<E: Curve>(
/// use slip10::supported_curves::Secp256k1;
///
/// # let seed = b"do not use this seed :)".as_slice();
/// let master_key = slip10::derive_master_key::<Secp256k1>(
/// slip10::CurveType::Secp256k1,
/// seed,
/// )?;
/// let master_key = slip10::derive_master_key::<Secp256k1>(seed)?;
/// let master_key_pair = slip10::ExtendedKeyPair::from(master_key);
///
/// let derived_key = slip10::derive_child_key_pair(
Expand Down Expand Up @@ -375,10 +366,7 @@ pub fn derive_child_key_pair<E: Curve>(
/// use slip10::supported_curves::Secp256k1;
///
/// # let seed = b"do not use this seed :)".as_slice();
/// let master_key = slip10::derive_master_key::<Secp256k1>(
/// slip10::CurveType::Secp256k1,
/// seed,
/// )?;
/// let master_key = slip10::derive_master_key::<Secp256k1>(seed)?;
/// let master_public_key = slip10::ExtendedPublicKey::from(&master_key);
///
/// let derived_key = slip10::derive_child_public_key(
Expand Down

0 comments on commit fb0fab9

Please sign in to comment.