-
Notifications
You must be signed in to change notification settings - Fork 620
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Split the address error code out into a separate module
Split the error code out of `address/mod.rs` and into `address/error.rs`. Code move only, no changes other than to imports/exports etc. to make it build.
- Loading branch information
Showing
2 changed files
with
126 additions
and
115 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
use core::fmt; | ||
|
||
use internals::write_err; | ||
|
||
use crate::address::{Address, NetworkUnchecked}; | ||
use crate::blockdata::script::{witness_program, witness_version}; | ||
use crate::prelude::String; | ||
use crate::{base58, Network}; | ||
|
||
/// Address error. | ||
#[derive(Debug, Clone, PartialEq, Eq)] | ||
#[non_exhaustive] | ||
pub enum Error { | ||
/// Base58 encoding error. | ||
Base58(base58::Error), | ||
/// Bech32 encoding error. | ||
Bech32(bech32::Error), | ||
/// The bech32 payload was empty. | ||
EmptyBech32Payload, | ||
/// The wrong checksum algorithm was used. See BIP-0350. | ||
InvalidBech32Variant { | ||
/// Bech32 variant that is required by the used Witness version. | ||
expected: bech32::Variant, | ||
/// The actual Bech32 variant encoded in the address representation. | ||
found: bech32::Variant, | ||
}, | ||
/// A witness version construction error. | ||
WitnessVersion(witness_version::TryFromError), | ||
/// A witness program error. | ||
WitnessProgram(witness_program::Error), | ||
/// An uncompressed pubkey was used where it is not allowed. | ||
UncompressedPubkey, | ||
/// Address size more than 520 bytes is not allowed. | ||
ExcessiveScriptSize, | ||
/// Script is not a p2pkh, p2sh or witness program. | ||
UnrecognizedScript, | ||
/// Address type is either invalid or not supported in rust-bitcoin. | ||
UnknownAddressType(String), | ||
/// Address's network differs from required one. | ||
NetworkValidation { | ||
/// Network that was required. | ||
required: Network, | ||
/// Network on which the address was found to be valid. | ||
found: Network, | ||
/// The address itself | ||
address: Address<NetworkUnchecked>, | ||
}, | ||
} | ||
|
||
impl fmt::Display for Error { | ||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | ||
match *self { | ||
Error::Base58(ref e) => write_err!(f, "base58 address encoding error"; e), | ||
Error::Bech32(ref e) => write_err!(f, "bech32 address encoding error"; e), | ||
Error::EmptyBech32Payload => write!(f, "the bech32 payload was empty"), | ||
Error::InvalidBech32Variant { expected, found } => write!( | ||
f, | ||
"invalid bech32 checksum variant found {:?} when {:?} was expected", | ||
found, expected | ||
), | ||
Error::WitnessVersion(ref e) => write_err!(f, "witness version construction error"; e), | ||
Error::WitnessProgram(ref e) => write_err!(f, "witness program error"; e), | ||
Error::UncompressedPubkey => | ||
write!(f, "an uncompressed pubkey was used where it is not allowed"), | ||
Error::ExcessiveScriptSize => write!(f, "script size exceed 520 bytes"), | ||
Error::UnrecognizedScript => | ||
write!(f, "script is not a p2pkh, p2sh or witness program"), | ||
Error::UnknownAddressType(ref s) => write!( | ||
f, | ||
"unknown address type: '{}' is either invalid or not supported in rust-bitcoin", | ||
s | ||
), | ||
Error::NetworkValidation { required, found, ref address } => { | ||
write!(f, "address ")?; | ||
address.fmt_internal(f)?; // Using fmt_internal in order to remove the "Address<NetworkUnchecked>(..)" wrapper | ||
write!( | ||
f, | ||
" belongs to network {} which is different from required {}", | ||
found, required | ||
) | ||
} | ||
} | ||
} | ||
} | ||
|
||
#[cfg(feature = "std")] | ||
impl std::error::Error for Error { | ||
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { | ||
use self::Error::*; | ||
|
||
match self { | ||
Base58(e) => Some(e), | ||
Bech32(e) => Some(e), | ||
WitnessVersion(e) => Some(e), | ||
WitnessProgram(e) => Some(e), | ||
EmptyBech32Payload | ||
| InvalidBech32Variant { .. } | ||
| UncompressedPubkey | ||
| ExcessiveScriptSize | ||
| UnrecognizedScript | ||
| UnknownAddressType(_) | ||
| NetworkValidation { .. } => None, | ||
} | ||
} | ||
} | ||
|
||
impl From<base58::Error> for Error { | ||
fn from(e: base58::Error) -> Error { Error::Base58(e) } | ||
} | ||
|
||
impl From<bech32::Error> for Error { | ||
fn from(e: bech32::Error) -> Error { Error::Bech32(e) } | ||
} | ||
|
||
impl From<witness_version::TryFromError> for Error { | ||
fn from(e: witness_version::TryFromError) -> Error { Error::WitnessVersion(e) } | ||
} | ||
|
||
impl From<witness_program::Error> for Error { | ||
fn from(e: witness_program::Error) -> Error { Error::WitnessProgram(e) } | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters