deprecate DecodeError and stop using it

Author: kevinheavey

Cargo.lock

@@ -21,6 +21,7 @@ use num_traits::FromPrimitive;
 /// [`ProgramError`]: https://docs.rs/solana-program-error/latest/solana_program_error/enum.ProgramError.html
 /// [`ProgramError::Custom`]: https://docs.rs/solana-program-error/latest/solana_program_error/enum.ProgramError.html#variant.Custom
 /// [`ToPrimitive`]: num_traits::ToPrimitive
+#[deprecated(since = "2.3.0", note = "Use `num_traits::FromPrimitive` instead")]
 pub trait DecodeError<E> {
     fn decode_custom_error_to_enum(custom: u32) -> Option<E>
     where
@@ -32,6 +33,7 @@ pub trait DecodeError<E> {
 }
 
 #[cfg(test)]
+#[allow(deprecated)]
 mod tests {
     use {super::*, num_derive::FromPrimitive};
 

decode-error/src/lib.rs

@@ -11,7 +11,6 @@ edition = { workspace = true }
 
 [dependencies]
 num-traits = { workspace = true }
-solana-decode-error = { workspace = true }
 
 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]

precompile-error/Cargo.toml

@@ -1,5 +1,5 @@
 /// Precompile errors
-use {core::fmt, solana_decode_error::DecodeError};
+use core::fmt;
 
 /// Precompile errors
 #[derive(Debug, Clone, PartialEq, Eq)]
@@ -68,9 +68,3 @@ impl fmt::Display for PrecompileError {
         }
     }
 }
-
-impl<T> DecodeError<T> for PrecompileError {
-    fn type_of() -> &'static str {
-        "PrecompileError"
-    }
-}

precompile-error/src/lib.rs

@@ -14,7 +14,6 @@ borsh = { workspace = true, optional = true }
 num-traits = { workspace = true }
 serde = { workspace = true, optional = true }
 serde_derive = { workspace = true, optional = true }
-solana-decode-error = { workspace = true }
 solana-instruction = { workspace = true, default-features = false, features = [
     "std",
 ] }

program-error/Cargo.toml

@@ -9,7 +9,6 @@ use serde_derive::{Deserialize, Serialize};
 use {
     core::fmt,
     num_traits::FromPrimitive,
-    solana_decode_error::DecodeError,
     solana_instruction::error::{
         InstructionError, ACCOUNT_ALREADY_INITIALIZED, ACCOUNT_BORROW_FAILED,
         ACCOUNT_DATA_TOO_SMALL, ACCOUNT_NOT_RENT_EXEMPT, ARITHMETIC_OVERFLOW, BORSH_IO_ERROR,
@@ -129,18 +128,18 @@ impl fmt::Display for ProgramError {
 pub trait PrintProgramError {
     fn print<E>(&self)
     where
-        E: 'static + std::error::Error + DecodeError<E> + PrintProgramError + FromPrimitive;
+        E: 'static + std::error::Error + PrintProgramError + FromPrimitive;
 }
 
 #[allow(deprecated)]
 impl PrintProgramError for ProgramError {
     fn print<E>(&self)
     where
-        E: 'static + std::error::Error + DecodeError<E> + PrintProgramError + FromPrimitive,
+        E: 'static + std::error::Error + PrintProgramError + FromPrimitive,
     {
         match self {
             Self::Custom(error) => {
-                if let Some(custom_error) = E::decode_custom_error_to_enum(*error) {
+                if let Some(custom_error) = E::from_u32(*error) {
                     custom_error.print::<E>();
                 } else {
                     msg!("Error: Unknown");

program-error/src/lib.rs

@@ -22,7 +22,6 @@ rand = { workspace = true, optional = true }
 serde = { workspace = true, optional = true }
 serde_derive = { workspace = true, optional = true }
 solana-atomic-u64 = { workspace = true }
-solana-decode-error = { workspace = true }
 solana-frozen-abi = { workspace = true, optional = true, features = [
     "frozen-abi",
 ] }

pubkey/Cargo.toml

@@ -29,7 +29,6 @@ use {
         str::{from_utf8, FromStr},
     },
     num_traits::{FromPrimitive, ToPrimitive},
-    solana_decode_error::DecodeError,
 };
 #[cfg(target_arch = "wasm32")]
 use {
@@ -119,11 +118,6 @@ impl fmt::Display for PubkeyError {
     }
 }
 
-impl<T> DecodeError<T> for PubkeyError {
-    fn type_of() -> &'static str {
-        "PubkeyError"
-    }
-}
 impl From<u64> for PubkeyError {
     fn from(error: u64) -> Self {
         match error {
@@ -378,12 +372,6 @@ impl From<Infallible> for ParsePubkeyError {
     }
 }
 
-impl<T> DecodeError<T> for ParsePubkeyError {
-    fn type_of() -> &'static str {
-        "ParsePubkeyError"
-    }
-}
-
 impl FromStr for Pubkey {
     type Err = ParsePubkeyError;
 

pubkey/src/lib.rs

@@ -17,7 +17,6 @@ num-traits = { workspace = true }
 serde = { workspace = true, optional = true }
 serde_derive = { workspace = true, optional = true }
 solana-clock = { workspace = true }
-solana-decode-error = { workspace = true }
 solana-frozen-abi = { workspace = true, features = [
     "frozen-abi",
 ], optional = true }

vote-interface/Cargo.toml

@@ -3,7 +3,6 @@
 use {
     core::fmt,
     num_derive::{FromPrimitive, ToPrimitive},
-    solana_decode_error::DecodeError,
 };
 
 /// Reasons the vote might have had an error
@@ -72,40 +71,3 @@ impl fmt::Display for VoteError {
         })
     }
 }
-
-impl<E> DecodeError<E> for VoteError {
-    fn type_of() -> &'static str {
-        "VoteError"
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    use {super::*, solana_instruction::error::InstructionError};
-
-    #[test]
-    fn test_custom_error_decode() {
-        use num_traits::FromPrimitive;
-        fn pretty_err<T>(err: InstructionError) -> String
-        where
-            T: 'static + std::error::Error + DecodeError<T> + FromPrimitive,
-        {
-            if let InstructionError::Custom(code) = err {
-                let specific_error: T = T::decode_custom_error_to_enum(code).unwrap();
-                format!(
-                    "{:?}: {}::{:?} - {}",
-                    err,
-                    T::type_of(),
-                    specific_error,
-                    specific_error,
-                )
-            } else {
-                "".to_string()
-            }
-        }
-        assert_eq!(
-            "Custom(0): VoteError::VoteTooOld - vote already recorded or not in slot hashes history",
-            pretty_err::<VoteError>(VoteError::VoteTooOld.into())
-        )
-    }
-}