solana/programs/vote/src/vote_error.rs

105 lines
2.8 KiB
Rust

//! Vote program errors
use {
log::*,
num_derive::{FromPrimitive, ToPrimitive},
solana_sdk::decode_error::DecodeError,
thiserror::Error,
};
/// Reasons the vote might have had an error
#[derive(Error, Debug, Clone, PartialEq, Eq, FromPrimitive, ToPrimitive)]
pub enum VoteError {
#[error("vote already recorded or not in slot hashes history")]
VoteTooOld,
#[error("vote slots do not match bank history")]
SlotsMismatch,
#[error("vote hash does not match bank hash")]
SlotHashMismatch,
#[error("vote has no slots, invalid")]
EmptySlots,
#[error("vote timestamp not recent")]
TimestampTooOld,
#[error("authorized voter has already been changed this epoch")]
TooSoonToReauthorize,
// TODO: figure out how to migrate these new errors
#[error("Old state had vote which should not have been popped off by vote in new state")]
LockoutConflict,
#[error("Proposed state had earlier slot which should have been popped off by later vote")]
NewVoteStateLockoutMismatch,
#[error("Vote slots are not ordered")]
SlotsNotOrdered,
#[error("Confirmations are not ordered")]
ConfirmationsNotOrdered,
#[error("Zero confirmations")]
ZeroConfirmations,
#[error("Confirmation exceeds limit")]
ConfirmationTooLarge,
#[error("Root rolled back")]
RootRollBack,
#[error("Confirmations for same vote were smaller in new proposed state")]
ConfirmationRollBack,
#[error("New state contained a vote slot smaller than the root")]
SlotSmallerThanRoot,
#[error("New state contained too many votes")]
TooManyVotes,
#[error("every slot in the vote was older than the SlotHashes history")]
VotesTooOldAllFiltered,
#[error("Proposed root is not in slot hashes")]
RootOnDifferentFork,
}
impl<E> DecodeError<E> for VoteError {
fn type_of() -> &'static str {
"VoteError"
}
}
#[cfg(test)]
mod tests {
use {super::*, solana_sdk::instruction::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())
)
}
}