Refactoring error variants: removing unused; better names & inner types

dr-orlovsky · dr-orlovsky · commit 15545a55c579 · 2021-06-27T18:59:24.000+02:00
diff --git a/src/util/bip32.rs b/src/util/bip32.rs
@@ -427,7 +427,7 @@ pub enum Error {
     /// A pk->pk derivation was attempted on a hardened key
     CannotDeriveFromHardenedKey,
     /// A secp256k1 error occurred
-    Ecdsa(secp256k1::Error), // TODO: This is not necessary ECDSA error and should be renamed
+    Secp256k1(secp256k1::Error),
     /// A child number was provided that was out of range
     InvalidChildNumber(u32),
     /// Invalid childnumber format.
@@ -446,7 +446,7 @@ impl fmt::Display for Error {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match *self {
             Error::CannotDeriveFromHardenedKey => f.write_str("cannot derive hardened key from public key"),
-            Error::Ecdsa(ref e) => fmt::Display::fmt(e, f),
+            Error::Secp256k1(ref e) => fmt::Display::fmt(e, f),
             Error::InvalidChildNumber(ref n) => write!(f, "child number {} is invalid (not within [0, 2^31 - 1])", n),
             Error::InvalidChildNumberFormat => f.write_str("invalid child number format"),
             Error::InvalidDerivationPathFormat => f.write_str("invalid derivation path format"),
@@ -459,7 +459,7 @@ impl fmt::Display for Error {
 
 impl error::Error for Error {
     fn cause(&self) -> Option<&dyn error::Error> {
-       if let Error::Ecdsa(ref e) = *self {
+       if let Error::Secp256k1(ref e) = *self {
            Some(e)
        } else {
            None
@@ -471,13 +471,13 @@ impl From<key::Error> for Error {
     fn from(err: key::Error) -> Self {
         match err {
             key::Error::Base58(e) => Error::Base58(e),
-            key::Error::Secp256k1(e) => Error::Ecdsa(e),
+            key::Error::Secp256k1(e) => Error::Secp256k1(e),
         }
     }
 }
 
 impl From<secp256k1::Error> for Error {
-    fn from(e: secp256k1::Error) -> Error { Error::Ecdsa(e) }
+    fn from(e: secp256k1::Error) -> Error { Error::Secp256k1(e) }
 }
 
 impl From<base58::Error> for Error {
diff --git a/src/util/psbt/error.rs b/src/util/psbt/error.rs
@@ -20,6 +20,7 @@ use consensus::encode;
 use util::psbt::raw;
 
 use hashes;
+use util::bip32::ExtendedPubKey;
 
 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
 /// Enum for marking psbt hash error
@@ -72,8 +73,9 @@ pub enum Error {
         /// Hash value
         hash: Box<[u8]>,
     },
-    /// Data inconsistency/conflicting data during merge procedure
-    MergeConflict(String),
+    /// Conflicting data during merge procedure:
+    /// global extended public key has inconsistent key sources
+    MergeInconsistentKeySources(ExtendedPubKey),
     /// Serialization error in bitcoin consensus-encoded structures
     ConsensusEncoding,
 }
@@ -99,7 +101,7 @@ impl fmt::Display for Error {
                 // directly using debug forms of psbthash enums
                 write!(f, "Preimage {:?} does not match {:?} hash {:?}", preimage, hash_type, hash )
             }
-            Error::MergeConflict(ref s) => { write!(f, "Merge conflict: {}", s) }
+            Error::MergeInconsistentKeySources(ref s) => { write!(f, "merge conflict: {}", s) }
             Error::ConsensusEncoding => f.write_str("bitcoin consensus or BIP-174 encoding error"),
         }
     }
diff --git a/src/util/psbt/map/global.rs b/src/util/psbt/map/global.rs
@@ -213,9 +213,7 @@ impl Map for Global {
                         entry.insert((fingerprint1, derivation1));
                         continue
                     }
-                    return Err(psbt::Error::MergeConflict(format!(
-                        "global xpub {} has inconsistent key sources", xpub
-                    ).to_owned()));
+                    return Err(psbt::Error::MergeInconsistentKeySources(xpub));
                 }
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -213,9 +213,7 @@ impl Map for Global {`
`213`	`213`	`entry.insert((fingerprint1, derivation1));`
`214`	`214`	`continue`
`215`	`215`	`}`
`216`		`- return Err(psbt::Error::MergeConflict(format!(`
`217`		`- "global xpub {} has inconsistent key sources", xpub`
`218`		`- ).to_owned()));`
	`216`	`+ return Err(psbt::Error::MergeInconsistentKeySources(xpub));`
`219`	`217`	`}`
`220`	`218`	`}`
`221`	`219`	`}`