milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

base58: Remove key related errors 

The key related errors are incorrect because they are circular, we have
a base58 error variant in `key::Error` and two key error variants in
`base58::Error`.

Remove the key errors from the `base58::Error` type.
This commit is contained in:
Tobin C. Harding 2022-09-13 10:43:43 +10:00
parent bbf89dd5a4
commit f659a7aca3
1 changed files with 1 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
bitcoin/src/util/base58.rs
View File

@ -12,11 +12,7 @@ use crate::prelude::*;
use core::{fmt, str, iter, slice}; use core::{fmt, str, iter, slice};
use core::convert::TryInto; use core::convert::TryInto;
use bitcoin_internals::write_err; use crate::hashes::{sha256d, Hash};
use crate::hashes::{sha256d, Hash, hex};
use secp256k1;
use crate::util::key;
/// An error that might occur during base58 decoding /// An error that might occur during base58 decoding
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone)] #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone)]
@ -36,11 +32,6 @@ pub enum Error {
InvalidAddressVersion(u8), InvalidAddressVersion(u8),
/// Checked data was less than 4 bytes /// Checked data was less than 4 bytes
TooShort(usize), TooShort(usize),
/// Secp256k1 error while parsing a secret key
Secp256k1(secp256k1::Error),
/// Hex decoding error
// TODO: Remove this as part of crate-smashing, there should not be any key related errors in this module
Hex(hex::Error)
} }
impl fmt::Display for Error { impl fmt::Display for Error {
@ -52,8 +43,6 @@ impl fmt::Display for Error {
Error::InvalidExtendedKeyVersion(ref v) => write!(f, "extended key version {:#04x?} is invalid for this base58 type", v), Error::InvalidExtendedKeyVersion(ref v) => write!(f, "extended key version {:#04x?} is invalid for this base58 type", v),
Error::InvalidAddressVersion(ref v) => write!(f, "address version {} is invalid for this base58 type", v), Error::InvalidAddressVersion(ref v) => write!(f, "address version {} is invalid for this base58 type", v),
Error::TooShort(_) => write!(f, "base58ck data not even long enough for a checksum"), Error::TooShort(_) => write!(f, "base58ck data not even long enough for a checksum"),
Error::Secp256k1(ref e) => write_err!(f, "secp256k1 error while parsing secret key"; e),
Error::Hex(ref e) => write_err!(f, "hexadecimal decoding error"; e)
} }
} }
} }
@ -71,8 +60,6 @@ impl std::error::Error for Error {
| InvalidExtendedKeyVersion(_) | InvalidExtendedKeyVersion(_)
| InvalidAddressVersion(_) | InvalidAddressVersion(_)
| TooShort(_) => None, | TooShort(_) => None,
Secp256k1(e) => Some(e),
Hex(e) => Some(e),
} }
} }
} }
@ -265,18 +252,6 @@ pub fn check_encode_slice_to_fmt(fmt: &mut fmt::Formatter, data: &[u8]) -> fmt::
format_iter(fmt, iter) format_iter(fmt, iter)
} }
#[doc(hidden)]
impl From<key::Error> for Error {
fn from(e: key::Error) -> Self {
match e {
key::Error::Secp256k1(e) => Error::Secp256k1(e),
key::Error::Base58(e) => e,
key::Error::InvalidKeyPrefix(_) => Error::Secp256k1(secp256k1::Error::InvalidPublicKey),
key::Error::Hex(e) => Error::Hex(e)
}
}
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;