clarity 1.7.0

extern crate clarity;
extern crate num256;
extern crate num_traits;
extern crate serde_json;
use std::{cmp::Ordering, collections::HashMap, fmt::Display, str::FromStr};

use clarity::{utils::hex_str_to_bytes, Address, Signature, Transaction, Uint256};
use num_traits::Zero;

pub fn default_gas_limit() -> String {
    "21000".to_owned()
}

pub fn default_chain_id() -> String {
    "1".to_owned()
}

#[derive(Deserialize, Debug, Clone)]
#[serde(untagged)]
pub enum TestFillerTransaction {
    EIP2930 {
        #[serde(rename = "chainId", default = "default_chain_id")]
        chain_id: String,
        #[serde(rename = "accessList")]
        access_list: Vec<ListEntry>,
        data: String,
        #[serde(rename = "gasLimit", default = "default_gas_limit")]
        gas_limit: String,
        #[serde(rename = "gasPrice")]
        gas_price: String,
        nonce: String,
        to: String,
        #[serde(default = "String::new")]
        value: String,
        v: String,
        r: String,
        s: String,
    },
    EIP1559 {
        #[serde(rename = "chainId", default = "default_chain_id")]
        chain_id: String,
        #[serde(rename = "accessList")]
        access_list: Vec<ListEntry>,
        data: String,
        #[serde(rename = "gasLimit", default = "default_gas_limit")]
        gas_limit: String,
        #[serde(rename = "maxFeePerGas")]
        max_fee_per_gas: String,
        #[serde(rename = "maxPriorityFeePerGas")]
        max_priority_fee_per_gas: String,
        nonce: String,
        to: String,
        #[serde(default = "String::new")]
        value: String,
        v: String,
        r: String,
        s: String,
    },
    // do not move this to the top, or all eip2930 tx will parse as legacytx
    // because it will be tried first has all the same fields except the access list
    Legacy {
        data: String,
        #[serde(rename = "gasLimit", default = "default_gas_limit")]
        gas_limit: String,
        #[serde(rename = "gasPrice")]
        gas_price: String,
        nonce: String,
        to: String,
        #[serde(default = "String::new")]
        value: String,
        v: String,
        r: String,
        s: String,
    },
}

fn decode_v(v: String) -> bool {
    let parsed: Result<u8, _> = v.parse();
    match (hex_str_to_bytes(&v), parsed) {
        (Ok(v), _) => v[0] == 1,
        (_, Ok(v)) => v == 1,
        (_, _) => panic!("Invalid v {}", v),
    }
}

#[derive(Deserialize, Debug, Clone)]
pub struct ListEntry {
    address: String,
    #[serde(rename = "storageKeys")]
    storage_keys: Vec<String>,
}
pub fn parse_filler_num(value: String) -> Uint256 {
    let value = match value.strip_prefix("0x:bigint ") {
        Some(v) => v,
        None => &value,
    };
    match (value.parse(), hex_str_to_bytes(value)) {
        (Ok(v), _) => v,
        (_, Ok(bytes)) => Uint256::from_be_bytes(&bytes),
        (Err(_), Err(_)) => panic!("Invalid value for filler tx"),
    }
}
pub fn parse_data(data: &str) -> Vec<u8> {
    // data comes in the format "raw: 0xABCD"
    hex_str_to_bytes(match data.strip_prefix(":raw ") {
        Some(v) => v,
        None => data,
    })
    .expect("Unable to parse data")
}
pub fn parse_access_list(list: Vec<ListEntry>) -> Vec<(Address, Vec<Uint256>)> {
    let mut out = Vec::new();
    for item in list {
        let mut storage_addrs = Vec::new();
        let address = item.address.parse().unwrap();
        for i in item.storage_keys {
            storage_addrs.push(i.parse().unwrap())
        }
        out.push((address, storage_addrs))
    }
    out
}

impl TryInto<Transaction> for TestFillerTransaction {
    type Error = clarity::Error;

    fn try_into(self) -> Result<Transaction, Self::Error> {
        match self {
            TestFillerTransaction::Legacy {
                data,
                gas_limit,
                gas_price,
                nonce,
                to,
                value,
                v,
                r,
                s,
            } => Ok(Transaction::Legacy {
                nonce: nonce.parse().unwrap_or_else(|_| Uint256::zero()),
                gas_price: gas_price.parse().unwrap_or_else(|_| Uint256::zero()),
                gas_limit: gas_limit.parse().expect("Unable to parse gas_limit"),
                to: to.parse()?,
                value: parse_filler_num(value),
                data: parse_data(&data),
                signature: Some(Signature::new_legacy(
                    v.parse().unwrap(),
                    r.parse().unwrap(),
                    s.parse().unwrap(),
                )),
            }),
            TestFillerTransaction::EIP2930 {
                access_list,
                chain_id,
                data,
                gas_limit,
                gas_price,
                nonce,
                to,
                value,
                v,
                r,
                s,
            } => Ok(Transaction::Eip2930 {
                nonce: nonce.parse().unwrap_or_else(|_| Uint256::zero()),
                gas_price: gas_price.parse().unwrap_or_else(|_| Uint256::zero()),
                gas_limit: gas_limit.parse().expect("Unable to parse gas_limit"),
                to: to.parse()?,
                value: parse_filler_num(value),
                data: parse_data(&data),
                signature: Some(Signature::new(
                    decode_v(v),
                    r.parse().unwrap(),
                    s.parse().unwrap(),
                )),
                access_list: parse_access_list(access_list),
                chain_id: chain_id.parse().unwrap_or_else(|_| Uint256::zero()),
            }),
            TestFillerTransaction::EIP1559 {
                chain_id,
                access_list,
                data,
                gas_limit,
                max_fee_per_gas,
                max_priority_fee_per_gas,
                nonce,
                to,
                value,
                v,
                r,
                s,
            } => Ok(Transaction::Eip1559 {
                chain_id: chain_id.parse().unwrap_or_else(|_| Uint256::zero()),
                nonce: nonce.parse().unwrap_or_else(|_| Uint256::zero()),
                max_priority_fee_per_gas: parse_filler_num(max_priority_fee_per_gas),
                max_fee_per_gas: parse_filler_num(max_fee_per_gas),
                gas_limit: gas_limit.parse().expect("Unable to parse gas_limit"),
                to: to.parse()?,
                value: parse_filler_num(value),
                data: parse_data(&data),
                signature: Some(Signature::new(
                    decode_v(v),
                    r.parse().unwrap(),
                    s.parse().unwrap(),
                )),
                access_list: parse_access_list(access_list),
            }),
        }
    }
}

impl TestFillerTransaction {
    // returns true if the tx is supported in the current Ethereum version, false otherwise
    pub fn is_supported(&self, network: EthereumNetworkVersion) -> bool {
        match self {
            TestFillerTransaction::EIP2930 { .. } => network >= EthereumNetworkVersion::Berlin,
            TestFillerTransaction::EIP1559 { .. } => network >= EthereumNetworkVersion::London,
            TestFillerTransaction::Legacy { .. } => true,
        }
    }
}

#[derive(Deserialize, Debug, Clone)]
#[serde(untagged)]
#[allow(clippy::large_enum_variant)]
pub enum TestFiller {
    ExpectExceptionFormat {
        /// This is a list of expection exceptions based on versions, empty means success is expected
        ///  ie >=Frontier : AddressTooShort
        ///     <London : InvalidVRS
        #[serde(rename = "expectException")]
        expect_exception: HashMap<String, String>,
        /// Test transaction, we may not deserialize all elements, just the ones
        /// in our struct
        transaction: Option<TestFillerTransaction>,
    },
    ResultFormat {
        result: TestFixtureResult,
        txbytes: String,
    },
}

impl TestFiller {
    /// Returns true if a failure is expected for the given test and version of Ethereum consensus rules
    pub fn should_fail(&self, version: EthereumNetworkVersion) -> bool {
        self.get_exception(version).is_some()
    }

    /// Returns the expected exception string given a version, none is returned if the test is expected to succeed
    pub fn get_exception(&self, version: EthereumNetworkVersion) -> Option<String> {
        match self {
            TestFiller::ExpectExceptionFormat {
                expect_exception,
                transaction: _,
            } => {
                if expect_exception.is_empty() {
                    None
                } else {
                    for (ineqality, error) in expect_exception {
                        // Empty exception string means no exception expected for this network
                        if error.is_empty() {
                            continue;
                        }
                        if ineqality.starts_with(">=") {
                            let compare_to: EthereumNetworkVersion =
                                ineqality.strip_prefix(">=").unwrap().parse().unwrap();
                            if version >= compare_to {
                                return Some(error.clone());
                            }
                        } else if ineqality.starts_with("<=") {
                            let compare_to: EthereumNetworkVersion =
                                ineqality.strip_prefix("<=").unwrap().parse().unwrap();
                            // because this is at the front of the string the interpretation is reversed
                            // for example <berlin implies you are checking that hte value is less than berlin
                            if compare_to >= version {
                                return Some(error.clone());
                            }
                        } else if ineqality.starts_with('<') {
                            let compare_to: EthereumNetworkVersion =
                                ineqality.strip_prefix('<').unwrap().parse().unwrap();
                            // because this is at the front of the string the interpretation is reversed
                            // for example <berlin implies you are checking that hte value is less than berlin
                            if compare_to > version {
                                return Some(error.clone());
                            }
                        } else if ineqality.starts_with('>') {
                            let compare_to: EthereumNetworkVersion =
                                ineqality.strip_prefix('>').unwrap().parse().unwrap();
                            if compare_to > version {
                                return Some(error.clone());
                            }
                        } else if let Ok(compare_to) = ineqality.parse() {
                            let compare_to: EthereumNetworkVersion = compare_to;
                            if version == compare_to {
                                return Some(error.clone());
                            }
                        } else {
                            panic!("Invalid inequality {ineqality}")
                        }
                    }
                    None
                }
            }
            TestFiller::ResultFormat { result, txbytes: _ } => match version {
                EthereumNetworkVersion::Berlin => result.berlin.get_exception(),
                EthereumNetworkVersion::Byzantium => result.byzantium.get_exception(),
                EthereumNetworkVersion::Constantinople => result.constantinople.get_exception(),
                EthereumNetworkVersion::ConstantinopleFix => {
                    result.constantinople_fix.get_exception()
                }
                EthereumNetworkVersion::EIP150 => result.eip150.get_exception(),
                EthereumNetworkVersion::EIP158 => result.eip158.get_exception(),
                EthereumNetworkVersion::Frontier => result.frontier.get_exception(),
                EthereumNetworkVersion::Homestead => result.homestead.get_exception(),
                EthereumNetworkVersion::Instanbul => result.istanbul.get_exception(),
                EthereumNetworkVersion::London => result.london.get_exception(),
                // This test format has not been updated
                EthereumNetworkVersion::Shanghi => result
                    .shanghai
                    .as_ref()
                    .map(|s| s.get_exception())
                    .unwrap_or(None),
                EthereumNetworkVersion::Merge => result
                    .merge
                    .as_ref()
                    .map(|m| m.get_exception())
                    .unwrap_or(None),
            },
        }
    }
}

#[derive(Deserialize, Debug, Clone)]
pub struct TestFixtureInfo {
    #[serde(rename = "comment")]
    pub _comment: String,
    #[serde(rename = "filling-rpc-server")]
    pub _filling_rpc_server: String,
    #[serde(rename = "filling-tool-version")]
    pub _filling_tool_version: String,
    #[serde(rename = "generatedTestHash")]
    pub _generated_test_hash: String,
    #[serde(rename = "lllcversion")]
    pub _lllcversion: String,
    pub source: String,
    #[serde(rename = "sourceHash")]
    pub _source_hash: String,
}

#[derive(Deserialize, Debug, Clone)]
#[serde(untagged)]
pub enum TestFixtureNetwork {
    Success {
        hash: String,
        #[serde(rename = "intrinsicGas")]
        _intrinsic_gas: Option<String>,
        sender: String,
    },
    Failure {
        _intrinsic_gas: Option<String>,
        exception: String,
    },
}

impl TestFixtureNetwork {
    pub fn get_exception(&self) -> Option<String> {
        match self {
            TestFixtureNetwork::Success { .. } => None,
            TestFixtureNetwork::Failure {
                _intrinsic_gas: _,
                exception,
            } => Some(exception.clone()),
        }
    }
}

/// These can show up in the fixture or in the filler (fixture being TransactionTests/ and Filler being src/TransactionTestsFiller)
/// It can have an exception if the output is failure, or hash and sender if successful
#[derive(Deserialize, Debug, Clone)]
pub struct TestFixtureResult {
    #[serde(rename = "Byzantium")]
    pub byzantium: TestFixtureNetwork,
    #[serde(rename = "Constantinople")]
    pub constantinople: TestFixtureNetwork,
    #[serde(rename = "EIP150")]
    pub eip150: TestFixtureNetwork,
    #[serde(rename = "EIP158")]
    pub eip158: TestFixtureNetwork,
    #[serde(rename = "Frontier")]
    pub frontier: TestFixtureNetwork,
    #[serde(rename = "Homestead")]
    pub homestead: TestFixtureNetwork,
    #[serde(rename = "London")]
    pub london: TestFixtureNetwork,
    #[serde(rename = "Berlin")]
    pub berlin: TestFixtureNetwork,
    #[serde(rename = "ConstantinopleFix")]
    pub constantinople_fix: TestFixtureNetwork,
    #[serde(rename = "Istanbul")]
    pub istanbul: TestFixtureNetwork,
    #[serde(rename = "Merge", default)]
    pub merge: Option<TestFixtureNetwork>,
    #[serde(rename = "Shanghai", default)]
    pub shanghai: Option<TestFixtureNetwork>,
}

impl TestFixtureResult {
    pub fn _get_exception(self, network: EthereumNetworkVersion) -> Option<String> {
        self.get_fixture(network).get_exception()
    }

    pub fn get_fixture(self, network: EthereumNetworkVersion) -> TestFixtureNetwork {
        match network {
            EthereumNetworkVersion::Berlin => self.berlin,
            EthereumNetworkVersion::Byzantium => self.byzantium,
            EthereumNetworkVersion::Constantinople => self.constantinople,
            EthereumNetworkVersion::ConstantinopleFix => self.constantinople_fix,
            EthereumNetworkVersion::EIP150 => self.eip150,
            EthereumNetworkVersion::EIP158 => self.eip158,
            EthereumNetworkVersion::Frontier => self.frontier,
            EthereumNetworkVersion::Homestead => self.homestead,
            EthereumNetworkVersion::Instanbul => self.istanbul,
            EthereumNetworkVersion::London => self.london,
            EthereumNetworkVersion::Merge => {
                self.merge.expect("Merge result not present in fixture")
            }
            EthereumNetworkVersion::Shanghi => self
                .shanghai
                .expect("Shanghai result not present in fixture"),
        }
    }
}

#[derive(Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
pub enum EthereumNetworkVersion {
    Berlin,
    Byzantium,
    Constantinople,
    ConstantinopleFix,
    EIP150,
    EIP158,
    Frontier,
    Homestead,
    Instanbul,
    London,
    Shanghi,
    Merge,
}

impl Ord for EthereumNetworkVersion {
    fn cmp(&self, other: &Self) -> Ordering {
        self.as_num().cmp(&other.as_num())
    }
}

impl PartialOrd for EthereumNetworkVersion {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl FromStr for EthereumNetworkVersion {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "Berlin" => Ok(EthereumNetworkVersion::Berlin),
            "Byzantium" => Ok(EthereumNetworkVersion::Byzantium),
            "Constantinople" => Ok(EthereumNetworkVersion::Constantinople),
            "ConstantinopleFix" => Ok(EthereumNetworkVersion::ConstantinopleFix),
            "EIP150" => Ok(EthereumNetworkVersion::EIP150),
            "EIP158" => Ok(EthereumNetworkVersion::EIP158),
            "Frontier" => Ok(EthereumNetworkVersion::Frontier),
            "Homestead" => Ok(EthereumNetworkVersion::Homestead),
            "Istanbul" => Ok(EthereumNetworkVersion::Instanbul),
            "London" => Ok(EthereumNetworkVersion::London),
            "Shanghai" => Ok(EthereumNetworkVersion::Shanghi),
            "Merge" => Ok(EthereumNetworkVersion::Merge),
            v => Err(format!("Invalid version {v}")),
        }
    }
}

impl Display for EthereumNetworkVersion {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            EthereumNetworkVersion::Berlin => write!(f, "Berlin"),
            EthereumNetworkVersion::Byzantium => write!(f, "Byzantium"),
            EthereumNetworkVersion::Constantinople => write!(f, "Constantinople"),
            EthereumNetworkVersion::ConstantinopleFix => write!(f, "ConstantinopleFix"),
            EthereumNetworkVersion::EIP150 => write!(f, "EIP150"),
            EthereumNetworkVersion::EIP158 => write!(f, "EIP158"),
            EthereumNetworkVersion::Frontier => write!(f, "Frontier"),
            EthereumNetworkVersion::Homestead => write!(f, "Homestead"),
            EthereumNetworkVersion::Instanbul => write!(f, "Istantbul"),
            EthereumNetworkVersion::London => write!(f, "London"),
            EthereumNetworkVersion::Shanghi => write!(f, "Shanghi"),
            EthereumNetworkVersion::Merge => write!(f, "Merge"),
        }
    }
}

impl EthereumNetworkVersion {
    // converts to an internal number representation, used for ordering
    pub fn as_num(&self) -> usize {
        match self {
            EthereumNetworkVersion::Frontier => 1,
            EthereumNetworkVersion::Homestead => 2,
            EthereumNetworkVersion::EIP150 => 3,
            // not totally sure aSbout this one
            EthereumNetworkVersion::EIP158 => 4,
            EthereumNetworkVersion::Byzantium => 5,
            EthereumNetworkVersion::Constantinople => 6,
            EthereumNetworkVersion::ConstantinopleFix => 7,
            EthereumNetworkVersion::Instanbul => 8,
            EthereumNetworkVersion::Berlin => 9,
            EthereumNetworkVersion::London => 10,
            EthereumNetworkVersion::Merge => 11,
            EthereumNetworkVersion::Shanghi => 12,
        }
    }
    pub fn get_all() -> [EthereumNetworkVersion; 12] {
        [
            EthereumNetworkVersion::Berlin,
            EthereumNetworkVersion::Byzantium,
            EthereumNetworkVersion::Constantinople,
            EthereumNetworkVersion::ConstantinopleFix,
            EthereumNetworkVersion::EIP150,
            EthereumNetworkVersion::EIP158,
            EthereumNetworkVersion::Frontier,
            EthereumNetworkVersion::Homestead,
            EthereumNetworkVersion::Instanbul,
            EthereumNetworkVersion::London,
            EthereumNetworkVersion::Merge,
            EthereumNetworkVersion::Shanghi,
        ]
    }
}

#[derive(Deserialize, Debug, Clone)]
pub struct TestFixture {
    #[serde(rename = "_info")]
    pub info: TestFixtureInfo,
    #[serde(rename = "result")]
    pub _result: TestFixtureResult,
    pub txbytes: String,
}