keyfork-derive-util: cleanup types

keyfork-derive-util/src/error.rs

@@ -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<T, E = Error> = std::result::Result<T, E>;

keyfork-derive-util/src/extended_key/private_key.rs

@@ -27,8 +27,8 @@ pub enum Error {
     Derivation,
 }
 
-pub type Result<T, E = Error> = std::result::Result<T, E>;
-pub type ChainCode = [u8; 32];
+type Result<T, E = Error> = std::result::Result<T, E>;
+type ChainCode = [u8; 32];
 type HmacSha512 = Hmac<Sha512>;
 
 /// Extended private keys derived using BIP-0032.
@@ -56,7 +56,7 @@ impl<K> ExtendedPrivateKey<K>
 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

keyfork-derive-util/src/extended_key/public_key.rs

@@ -26,8 +26,8 @@ pub enum Error {
     Derivation,
 }
 
-pub type Result<T, E = Error> = std::result::Result<T, E>;
-pub type ChainCode = [u8; 32];
+type Result<T, E = Error> = std::result::Result<T, E>;
+type ChainCode = [u8; 32];
 type HmacSha512 = Hmac<Sha512>;
 
 /// Extended public keys derived using BIP-0032.

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<T, E = Error> = std::result::Result<T, E>;
+type Result<T, E = Error> = std::result::Result<T, E>;
 
 /// Index for a given extended private key.
 #[derive(Serialize, Deserialize, Clone, Debug)]

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,

keyfork-derive-util/src/path.rs

@@ -19,7 +19,7 @@ pub enum Error {
     UnknownPathPrefix,
 }
 
-pub type Result<T, E = Error> = std::result::Result<T, E>;
+type Result<T, E = Error> = std::result::Result<T, E>;
 
 const PREFIX: &str = "m";
 

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 {

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 {