diff --git a/keyfork-derive-util/src/error.rs b/keyfork-derive-util/src/error.rs deleted file mode 100644 index 78272d8..0000000 --- a/keyfork-derive-util/src/error.rs +++ /dev/null @@ -1,15 +0,0 @@ -use thiserror::Error; - -#[derive(Error, Debug)] -pub enum Error { - #[error("Index is too large, must be less than 0x80000000: {0}")] - IndexTooLarge(u32), - - #[error("Unable to parse integer for index")] - IntParseError(#[from] std::num::ParseIntError), - - #[error("Unable to parse path due to bad path prefix")] - UnknownPathPrefix, -} - -pub type Result = std::result::Result; diff --git a/keyfork-derive-util/src/extended_key/private_key.rs b/keyfork-derive-util/src/extended_key/private_key.rs index 0314683..19b0b6a 100644 --- a/keyfork-derive-util/src/extended_key/private_key.rs +++ b/keyfork-derive-util/src/extended_key/private_key.rs @@ -27,8 +27,8 @@ pub enum Error { Derivation, } -pub type Result = std::result::Result; -pub type ChainCode = [u8; 32]; +type Result = std::result::Result; +type ChainCode = [u8; 32]; type HmacSha512 = Hmac; /// Extended private keys derived using BIP-0032. @@ -56,7 +56,7 @@ impl ExtendedPrivateKey where K: PrivateKey + Clone, { - /// Generate a new [`ExtendedPublicKey`] from a seed, ideally from a 12-word or 24-word + /// Generate a new [`ExtendedPrivateKey`] from a seed, ideally from a 12-word or 24-word /// mnemonic, but may take 16-byte seeds. /// /// # Panics diff --git a/keyfork-derive-util/src/extended_key/public_key.rs b/keyfork-derive-util/src/extended_key/public_key.rs index 340bc0a..f593d6f 100644 --- a/keyfork-derive-util/src/extended_key/public_key.rs +++ b/keyfork-derive-util/src/extended_key/public_key.rs @@ -26,8 +26,8 @@ pub enum Error { Derivation, } -pub type Result = std::result::Result; -pub type ChainCode = [u8; 32]; +type Result = std::result::Result; +type ChainCode = [u8; 32]; type HmacSha512 = Hmac; /// Extended public keys derived using BIP-0032. diff --git a/keyfork-derive-util/src/index.rs b/keyfork-derive-util/src/index.rs index 17d793c..29fbee0 100644 --- a/keyfork-derive-util/src/index.rs +++ b/keyfork-derive-util/src/index.rs @@ -1,17 +1,19 @@ use serde::{Deserialize, Serialize}; use thiserror::Error; -/// Errors associated with creating a [`DerivableIndex`]. +/// Errors associated with creating a [`DerivationIndex`]. #[derive(Error, Debug)] pub enum Error { + /// The index was too large and should be less than 2^31. #[error("Index is too large, must be less than 0x80000000: {0}")] IndexTooLarge(u32), + /// An integer could not be parsed from the string. #[error("Unable to parse integer for index")] IntParseError(#[from] std::num::ParseIntError), } -pub type Result = std::result::Result; +type Result = std::result::Result; /// Index for a given extended private key. #[derive(Serialize, Deserialize, Clone, Debug)] diff --git a/keyfork-derive-util/src/lib.rs b/keyfork-derive-util/src/lib.rs index a8eb7c7..e6fa6cf 100644 --- a/keyfork-derive-util/src/lib.rs +++ b/keyfork-derive-util/src/lib.rs @@ -2,7 +2,6 @@ //! BIP-0032 derivation utilities. -pub mod error; pub mod extended_key; pub mod index; pub mod path; @@ -13,7 +12,6 @@ pub mod public_key; mod tests; pub use crate::{ - error::{Error, Result}, extended_key::{private_key::ExtendedPrivateKey, public_key::ExtendedPublicKey}, index::DerivationIndex, path::DerivationPath, diff --git a/keyfork-derive-util/src/path.rs b/keyfork-derive-util/src/path.rs index 856a50a..bb524cd 100644 --- a/keyfork-derive-util/src/path.rs +++ b/keyfork-derive-util/src/path.rs @@ -19,7 +19,7 @@ pub enum Error { UnknownPathPrefix, } -pub type Result = std::result::Result; +type Result = std::result::Result; const PREFIX: &str = "m"; diff --git a/keyfork-derive-util/src/private_key.rs b/keyfork-derive-util/src/private_key.rs index 669c200..c9efd89 100644 --- a/keyfork-derive-util/src/private_key.rs +++ b/keyfork-derive-util/src/private_key.rs @@ -2,7 +2,7 @@ use crate::PublicKey; use thiserror::Error; -pub type PrivateKeyBytes = [u8; 32]; +pub(crate) type PrivateKeyBytes = [u8; 32]; /// Functions required to use an `ExtendedPrivateKey`. pub trait PrivateKey: Sized { diff --git a/keyfork-derive-util/src/public_key.rs b/keyfork-derive-util/src/public_key.rs index a062a24..9475438 100644 --- a/keyfork-derive-util/src/public_key.rs +++ b/keyfork-derive-util/src/public_key.rs @@ -5,7 +5,7 @@ use ripemd::Ripemd160; use sha2::Sha256; use thiserror::Error; -pub type PublicKeyBytes = [u8; 33]; +pub(crate) type PublicKeyBytes = [u8; 33]; /// Functions required to use an `ExtendedPublicKey`. pub trait PublicKey: Sized {