rialo-s-system-interface 0.4.1

// Copyright (c) Subzero Labs, Inc.
// SPDX-License-Identifier: Apache-2.0
// This file is either (a) original to Subzero Labs, Inc. or (b) derived from the Anza codebase and modified by Subzero Labs, Inc.

use num_traits::{FromPrimitive, ToPrimitive};
use rialo_s_decode_error::DecodeError;

// Use strum when testing to ensure our FromPrimitive
// impl is exhaustive
#[cfg_attr(test, derive(strum_macros::FromRepr, strum_macros::EnumIter))]
#[cfg_attr(
    feature = "serde",
    derive(serde_derive::Deserialize, serde_derive::Serialize)
)]
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum SystemError {
    /// An account with the same address already exists.
    AccountAlreadyInUse,
    /// Account does not have enough RLO to perform the operation.
    ResultWithNegativeKelvins,
    /// Cannot assign account to this program id.
    InvalidProgramId,
    /// Cannot allocate account data of this length.
    InvalidAccountDataLength,
    /// Length of requested seed is too long.
    MaxSeedLengthExceeded,
    /// Provided address does not match addressed derived from seed.
    AddressWithSeedMismatch,
    /// Advancing stored nonce requires a populated RecentBlockhashes sysvar.
    NonceNoRecentBlockhashes,
    /// Stored nonce is still in recent_blockhashes.
    NonceBlockhashNotExpired,
    /// Specified nonce does not match stored nonce.
    NonceUnexpectedBlockhashValue,
}

impl FromPrimitive for SystemError {
    #[inline]
    fn from_i64(n: i64) -> Option<Self> {
        if n == Self::AccountAlreadyInUse as i64 {
            Some(Self::AccountAlreadyInUse)
        } else if n == Self::ResultWithNegativeKelvins as i64 {
            Some(Self::ResultWithNegativeKelvins)
        } else if n == Self::InvalidProgramId as i64 {
            Some(Self::InvalidProgramId)
        } else if n == Self::InvalidAccountDataLength as i64 {
            Some(Self::InvalidAccountDataLength)
        } else if n == Self::MaxSeedLengthExceeded as i64 {
            Some(Self::MaxSeedLengthExceeded)
        } else if n == Self::AddressWithSeedMismatch as i64 {
            Some(Self::AddressWithSeedMismatch)
        } else if n == Self::NonceNoRecentBlockhashes as i64 {
            Some(Self::NonceNoRecentBlockhashes)
        } else if n == Self::NonceBlockhashNotExpired as i64 {
            Some(Self::NonceBlockhashNotExpired)
        } else if n == Self::NonceUnexpectedBlockhashValue as i64 {
            Some(Self::NonceUnexpectedBlockhashValue)
        } else {
            None
        }
    }
    #[inline]
    fn from_u64(n: u64) -> Option<Self> {
        Self::from_i64(n as i64)
    }
}

impl ToPrimitive for SystemError {
    #[inline]
    fn to_i64(&self) -> Option<i64> {
        Some(match *self {
            Self::AccountAlreadyInUse => Self::AccountAlreadyInUse as i64,
            Self::ResultWithNegativeKelvins => Self::ResultWithNegativeKelvins as i64,
            Self::InvalidProgramId => Self::InvalidProgramId as i64,
            Self::InvalidAccountDataLength => Self::InvalidAccountDataLength as i64,
            Self::MaxSeedLengthExceeded => Self::MaxSeedLengthExceeded as i64,
            Self::AddressWithSeedMismatch => Self::AddressWithSeedMismatch as i64,
            Self::NonceNoRecentBlockhashes => Self::NonceNoRecentBlockhashes as i64,
            Self::NonceBlockhashNotExpired => Self::NonceBlockhashNotExpired as i64,
            Self::NonceUnexpectedBlockhashValue => Self::NonceUnexpectedBlockhashValue as i64,
        })
    }
    #[inline]
    fn to_u64(&self) -> Option<u64> {
        self.to_i64().map(|x| x as u64)
    }
}

impl std::error::Error for SystemError {}

impl core::fmt::Display for SystemError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            SystemError::AccountAlreadyInUse => {
                f.write_str("an account with the same address already exists")
            }
            SystemError::ResultWithNegativeKelvins => {
                f.write_str("account does not have enough RLO to perform the operation")
            }
            SystemError::InvalidProgramId => {
                f.write_str("cannot assign account to this program id")
            }
            SystemError::InvalidAccountDataLength => {
                f.write_str("cannot allocate account data of this length")
            }
            SystemError::MaxSeedLengthExceeded => {
                f.write_str("length of requested seed is too long")
            }
            SystemError::AddressWithSeedMismatch => {
                f.write_str("provided address does not match addressed derived from seed")
            }
            SystemError::NonceNoRecentBlockhashes => {
                f.write_str("advancing stored nonce requires a populated RecentBlockhashes sysvar")
            }
            SystemError::NonceBlockhashNotExpired => {
                f.write_str("stored nonce is still in recent_blockhashes")
            }
            SystemError::NonceUnexpectedBlockhashValue => {
                f.write_str("specified nonce does not match stored nonce")
            }
        }
    }
}

impl<T> DecodeError<T> for SystemError {
    fn type_of() -> &'static str {
        "SystemError"
    }
}

impl From<u64> for SystemError {
    fn from(error: u64) -> Self {
        match error {
            0 => SystemError::AccountAlreadyInUse,
            1 => SystemError::ResultWithNegativeKelvins,
            2 => SystemError::InvalidProgramId,
            3 => SystemError::InvalidAccountDataLength,
            4 => SystemError::MaxSeedLengthExceeded,
            5 => SystemError::AddressWithSeedMismatch,
            6 => SystemError::NonceNoRecentBlockhashes,
            7 => SystemError::NonceBlockhashNotExpired,
            8 => SystemError::NonceUnexpectedBlockhashValue,
            _ => panic!("Unsupported SystemError"),
        }
    }
}

#[cfg(test)]
mod tests {
    use num_traits::FromPrimitive;
    use strum::IntoEnumIterator;

    use super::SystemError;

    #[test]
    fn test_system_error_from_primitive_exhaustive() {
        for variant in SystemError::iter() {
            let variant_i64 = variant.clone() as i64;
            assert_eq!(
                SystemError::from_repr(variant_i64 as usize),
                SystemError::from_i64(variant_i64)
            );
            assert_eq!(SystemError::from(variant_i64 as u64), variant);
        }
    }
}