monad-revm 0.7.0

//! Contains the [`MonadHardfork`] type and its implementation.
use core::{fmt, str::FromStr};
use revm::primitives::hardfork::{SpecId, UnknownHardfork};

/// Monad mainnet chain ID.
pub const MONAD_MAINNET_CHAIN_ID: u64 = 143;
/// Monad testnet chain ID.
pub const MONAD_TESTNET_CHAIN_ID: u64 = 10143;

/// Monad hardfork identifier.
///
/// Variants are ordered by activation order. Lower discriminant = earlier hardfork.
#[repr(u8)]
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, PartialOrd, Ord, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum MonadHardfork {
    /// Monad launch hardfork (based on Prague).
    MonadEight = 100,
    /// MIP-3, MIP-4, MIP-5
    MonadNine = 101,
    /// MIP-8 page-ified storage state.
    #[default]
    MonadTen = 102,
    /// Next development spec
    MonadNext = 103,
}

impl MonadHardfork {
    /// Returns the underlying Ethereum [`SpecId`] this Monad hardfork is built upon.
    ///
    /// Used internally to:
    /// - Get the base instruction table (before Monad gas overrides)
    /// - Get the base precompiles (before Monad gas overrides)
    /// - Check Ethereum feature availability (e.g., blob support)
    ///
    /// Note: This returns the *foundation* spec, not an equivalence.
    /// Future Monad hardforks may add features beyond the base Ethereum spec.
    pub const fn into_eth_spec(self) -> SpecId {
        match self {
            Self::MonadEight => SpecId::PRAGUE,
            Self::MonadNine | Self::MonadTen | Self::MonadNext => SpecId::OSAKA,
        }
    }

    /// Returns `true` if `self` is enabled when the active spec is `other`.
    ///
    /// A hardfork is enabled when its discriminant is ≤ the active spec's discriminant,
    /// i.e. it was activated at the same time or earlier.
    pub const fn is_enabled_in(self, other: Self) -> bool {
        self as u8 <= other as u8
    }

    /// Returns the active Monad hardfork at the given timestamp for the specified chain.
    pub const fn from_chain_and_timestamp(chain_id: u64, timestamp: u64) -> Option<Self> {
        match chain_id {
            MONAD_MAINNET_CHAIN_ID => Some(Self::from_mainnet_timestamp(timestamp)),
            MONAD_TESTNET_CHAIN_ID => Some(Self::from_testnet_timestamp(timestamp)),
            _ => None,
        }
    }

    /// Retrieves the activation timestamp for this hardfork on mainnet.
    pub const fn mainnet_activation_timestamp(&self) -> Option<u64> {
        match self {
            Self::MonadEight => Some(1_763_649_000),
            Self::MonadNine => Some(1_773_930_600),
            Self::MonadTen => Some(1_788_359_400),
            Self::MonadNext => None,
        }
    }

    /// Retrieves the activation timestamp for this hardfork on testnet.
    pub const fn testnet_activation_timestamp(&self) -> Option<u64> {
        match self {
            Self::MonadEight => Some(1_763_562_600),
            Self::MonadNine => Some(1_773_153_000),
            Self::MonadTen => Some(1_786_545_000),
            Self::MonadNext => None,
        }
    }

    const fn from_mainnet_timestamp(timestamp: u64) -> Self {
        if timestamp >= 1_788_359_400 {
            Self::MonadTen
        } else {
            Self::from_timestamp(timestamp, 1_773_930_600)
        }
    }

    const fn from_testnet_timestamp(timestamp: u64) -> Self {
        if timestamp >= 1_786_545_000 {
            Self::MonadTen
        } else {
            Self::from_timestamp(timestamp, 1_773_153_000)
        }
    }

    const fn from_timestamp(timestamp: u64, monad_nine_timestamp: u64) -> Self {
        if timestamp >= monad_nine_timestamp {
            Self::MonadNine
        } else {
            // Older Monad revisions are represented as MonadEight in monad-revm.
            Self::MonadEight
        }
    }
}

impl From<MonadHardfork> for SpecId {
    fn from(spec: MonadHardfork) -> Self {
        spec.into_eth_spec()
    }
}

impl FromStr for MonadHardfork {
    type Err = UnknownHardfork;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            s if s.eq_ignore_ascii_case(name::MONAD_EIGHT) => Ok(Self::MonadEight),
            s if s.eq_ignore_ascii_case(name::MONAD_NINE) => Ok(Self::MonadNine),
            s if s.eq_ignore_ascii_case(name::MONAD_TEN) => Ok(Self::MonadTen),
            s if s.eq_ignore_ascii_case(name::MONAD_NEXT) => Ok(Self::MonadNext),
            _ => Err(UnknownHardfork),
        }
    }
}

impl From<MonadHardfork> for &'static str {
    fn from(spec_id: MonadHardfork) -> Self {
        match spec_id {
            MonadHardfork::MonadEight => name::MONAD_EIGHT,
            MonadHardfork::MonadNine => name::MONAD_NINE,
            MonadHardfork::MonadTen => name::MONAD_TEN,
            MonadHardfork::MonadNext => name::MONAD_NEXT,
        }
    }
}

impl fmt::Display for MonadHardfork {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let name: &'static str = (*self).into();
        f.write_str(name)
    }
}

/// String identifiers for Monad hardforks
pub mod name {
    /// Mainnet launch spec name.
    pub const MONAD_EIGHT: &str = "MonadEight";
    /// MIP-3, MIP-4 and MIP-5 spec name.
    pub const MONAD_NINE: &str = "MonadNine";
    /// MIP-8 spec name.
    pub const MONAD_TEN: &str = "MonadTen";
    /// Development spec name.
    pub const MONAD_NEXT: &str = "MonadNext";
}

#[cfg(test)]
mod tests {
    use super::*;
    use alloc::string::ToString;

    #[test]
    fn test_monad_hardfork_default() {
        assert_eq!(MonadHardfork::default(), MonadHardfork::MonadTen);
    }

    #[test]
    fn test_monad_hardfork_type() {
        let spec: MonadHardfork = MonadHardfork::MonadNine;
        assert_eq!(spec, MonadHardfork::MonadNine);
        assert_eq!(spec.into_eth_spec(), SpecId::OSAKA);
    }

    #[test]
    fn test_monad_hardfork_into_eth_spec() {
        assert_eq!(MonadHardfork::MonadEight.into_eth_spec(), SpecId::PRAGUE);
        assert_eq!(MonadHardfork::MonadNine.into_eth_spec(), SpecId::OSAKA);
        assert_eq!(MonadHardfork::MonadTen.into_eth_spec(), SpecId::OSAKA);
        assert_eq!(MonadHardfork::MonadNext.into_eth_spec(), SpecId::OSAKA);
    }

    #[test]
    fn test_monad_hardfork_from_str() {
        assert_eq!("MonadEight".parse::<MonadHardfork>().unwrap(), MonadHardfork::MonadEight);
        assert_eq!("monadeight".parse::<MonadHardfork>().unwrap(), MonadHardfork::MonadEight);
        assert_eq!("MonadNine".parse::<MonadHardfork>().unwrap(), MonadHardfork::MonadNine);
        assert_eq!("monadnine".parse::<MonadHardfork>().unwrap(), MonadHardfork::MonadNine);
        assert_eq!("MonadTen".parse::<MonadHardfork>().unwrap(), MonadHardfork::MonadTen);
        assert_eq!("monadten".parse::<MonadHardfork>().unwrap(), MonadHardfork::MonadTen);
        assert_eq!("MonadNext".parse::<MonadHardfork>().unwrap(), MonadHardfork::MonadNext);
        assert_eq!("monadnext".parse::<MonadHardfork>().unwrap(), MonadHardfork::MonadNext);
    }

    #[test]
    fn test_monad_hardfork_from_str_unknown() {
        assert!("Unknown".parse::<MonadHardfork>().is_err());
    }

    #[test]
    fn test_monad_hardfork_into_str() {
        let name: &'static str = MonadHardfork::MonadEight.into();
        assert_eq!(name, "MonadEight");
        let name: &'static str = MonadHardfork::MonadNine.into();
        assert_eq!(name, "MonadNine");
    }

    #[test]
    fn test_monad_hardfork_display() {
        assert_eq!(MonadHardfork::MonadEight.to_string(), "MonadEight");
        assert_eq!(MonadHardfork::MonadNine.to_string(), "MonadNine");
        assert_eq!(MonadHardfork::MonadTen.to_string(), "MonadTen");
        assert_eq!(MonadHardfork::MonadNext.to_string(), "MonadNext");
    }

    #[test]
    fn test_monad_hardfork_is_enabled_in() {
        // MonadEight is enabled in every spec
        assert!(MonadHardfork::MonadEight.is_enabled_in(MonadHardfork::MonadEight));
        assert!(MonadHardfork::MonadEight.is_enabled_in(MonadHardfork::MonadNine));
        assert!(MonadHardfork::MonadEight.is_enabled_in(MonadHardfork::MonadTen));
        assert!(MonadHardfork::MonadEight.is_enabled_in(MonadHardfork::MonadNext));

        // MonadNine is NOT enabled in MonadEight
        assert!(!MonadHardfork::MonadNine.is_enabled_in(MonadHardfork::MonadEight));
        // MonadNine IS enabled in MonadNine and later specs
        assert!(MonadHardfork::MonadNine.is_enabled_in(MonadHardfork::MonadNine));
        assert!(MonadHardfork::MonadNine.is_enabled_in(MonadHardfork::MonadTen));
        assert!(MonadHardfork::MonadNine.is_enabled_in(MonadHardfork::MonadNext));

        // MonadTen is only enabled in MonadTen and later specs
        assert!(!MonadHardfork::MonadTen.is_enabled_in(MonadHardfork::MonadEight));
        assert!(!MonadHardfork::MonadTen.is_enabled_in(MonadHardfork::MonadNine));
        assert!(MonadHardfork::MonadTen.is_enabled_in(MonadHardfork::MonadTen));
        assert!(MonadHardfork::MonadTen.is_enabled_in(MonadHardfork::MonadNext));

        // MonadNext is only enabled in MonadNext.
        assert!(!MonadHardfork::MonadNext.is_enabled_in(MonadHardfork::MonadEight));
        assert!(!MonadHardfork::MonadNext.is_enabled_in(MonadHardfork::MonadNine));
        assert!(!MonadHardfork::MonadNext.is_enabled_in(MonadHardfork::MonadTen));
        assert!(MonadHardfork::MonadNext.is_enabled_in(MonadHardfork::MonadNext));
    }

    #[test]
    fn test_monad_hardfork_ordering() {
        assert!(MonadHardfork::MonadEight < MonadHardfork::MonadNine);
        assert!(MonadHardfork::MonadNine < MonadHardfork::MonadTen);
        assert!(MonadHardfork::MonadTen < MonadHardfork::MonadNext);
    }

    #[test]
    fn test_monad_hardfork_from_impl() {
        let spec_id: SpecId = MonadHardfork::MonadEight.into();
        assert_eq!(spec_id, SpecId::PRAGUE);
        let spec_id: SpecId = MonadHardfork::MonadNine.into();
        assert_eq!(spec_id, SpecId::OSAKA);
        let spec_id: SpecId = MonadHardfork::MonadTen.into();
        assert_eq!(spec_id, SpecId::OSAKA);
    }

    #[test]
    fn test_monad_hardfork_activation_timestamps() {
        assert_eq!(MonadHardfork::MonadEight.mainnet_activation_timestamp(), Some(1_763_649_000));
        assert_eq!(MonadHardfork::MonadNine.mainnet_activation_timestamp(), Some(1_773_930_600));
        assert_eq!(MonadHardfork::MonadTen.mainnet_activation_timestamp(), Some(1_788_359_400));
        assert_eq!(MonadHardfork::MonadNext.mainnet_activation_timestamp(), None);

        assert_eq!(MonadHardfork::MonadEight.testnet_activation_timestamp(), Some(1_763_562_600));
        assert_eq!(MonadHardfork::MonadNine.testnet_activation_timestamp(), Some(1_773_153_000));
        assert_eq!(MonadHardfork::MonadTen.testnet_activation_timestamp(), Some(1_786_545_000));
        assert_eq!(MonadHardfork::MonadNext.testnet_activation_timestamp(), None);
    }

    #[test]
    fn test_monad_hardfork_from_chain_and_timestamp() {
        assert_eq!(
            MonadHardfork::from_chain_and_timestamp(MONAD_MAINNET_CHAIN_ID, 1_763_648_999),
            Some(MonadHardfork::MonadEight)
        );
        assert_eq!(
            MonadHardfork::from_chain_and_timestamp(MONAD_MAINNET_CHAIN_ID, 1_773_930_599),
            Some(MonadHardfork::MonadEight)
        );
        assert_eq!(
            MonadHardfork::from_chain_and_timestamp(MONAD_MAINNET_CHAIN_ID, 1_773_930_600),
            Some(MonadHardfork::MonadNine)
        );
        assert_eq!(
            MonadHardfork::from_chain_and_timestamp(MONAD_MAINNET_CHAIN_ID, 1_788_359_399),
            Some(MonadHardfork::MonadNine)
        );
        assert_eq!(
            MonadHardfork::from_chain_and_timestamp(MONAD_MAINNET_CHAIN_ID, 1_788_359_400),
            Some(MonadHardfork::MonadTen)
        );
        assert_eq!(
            MonadHardfork::from_chain_and_timestamp(MONAD_TESTNET_CHAIN_ID, 1_773_152_999),
            Some(MonadHardfork::MonadEight)
        );
        assert_eq!(
            MonadHardfork::from_chain_and_timestamp(MONAD_TESTNET_CHAIN_ID, 1_773_153_000),
            Some(MonadHardfork::MonadNine)
        );
        assert_eq!(
            MonadHardfork::from_chain_and_timestamp(MONAD_TESTNET_CHAIN_ID, 1_786_544_999),
            Some(MonadHardfork::MonadNine)
        );
        assert_eq!(
            MonadHardfork::from_chain_and_timestamp(MONAD_TESTNET_CHAIN_ID, 1_786_545_000),
            Some(MonadHardfork::MonadTen)
        );
        assert_eq!(MonadHardfork::from_chain_and_timestamp(1, 1_773_153_000), None);
    }
}