diff --git a/Cargo.toml b/Cargo.toml index 04c4a83..187135b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,7 +3,7 @@ name = "hd-wallet" version = "0.5.0" edition = "2021" license = "MIT OR Apache-2.0" -description = "HD deteministic wallets derivation" +description = "HD wallets derivation" repository = "https://github.com/dfns/slip-10" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/src/lib.rs b/src/lib.rs index 6ac3815..4dfebc6 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -320,8 +320,6 @@ impl<'de, E: Curve> serde::Deserialize<'de> for ExtendedKeyPair { pub trait HdWallet: DeriveShift { /// Derives child extended public key from parent extended public key /// - /// Returns error if child key is not defined for given child index - /// /// ### Example /// Derive a master public key m/1 /// ```rust @@ -346,8 +344,6 @@ pub trait HdWallet: DeriveShift { /// Derives child key pair (extended secret key + public key) from parent key pair /// - /// Returns error if child key is not defined for given child index - /// /// ### Example /// Derive child key m/1H from master key /// ```rust @@ -389,8 +385,7 @@ pub trait HdWallet: DeriveShift { /// yields an error, it's propagated to the caller. /// /// Returns: - /// * `Ok(Ok(child_key_pair))` if derivation was successful - /// * `Ok(Err(derive_err))` if child key is not defined for given path + /// * `Ok(child_key_pair)` if derivation was successful /// * `Err(index_err)` if path contained `Err(index_err)` /// /// ### Example @@ -426,8 +421,6 @@ pub trait HdWallet: DeriveShift { /// /// If derivation path is empty, `parent_key` is returned /// - /// Returns error if child key is not defined for given child index - /// /// ### Example /// Derive a child key with path m/1/10/1H /// ```rust @@ -462,8 +455,7 @@ pub trait HdWallet: DeriveShift { /// yields an error, it's propagated to the caller. /// /// Returns: - /// * `Ok(Ok(child_pk))` if derivation was successful - /// * `Ok(Err(derive_err))` if child key is not defined for given path + /// * `Ok(child_pk)` if derivation was successful /// * `Err(index_err)` if path contained `Err(index_err)` /// /// ### Example @@ -499,8 +491,6 @@ pub trait HdWallet: DeriveShift { /// /// If derivation path is empty, `parent_public_key` is returned /// - /// Returns error if child key is not defined for given child index - /// /// ### Example /// Derive a child key with path m/1/10 /// ```rust