feat: extract statetest models/structs to standalone crate (#1808)

* feat: split test models to statetest-tests

* chore: attempt documentation

* Update Cargo.toml

* Update Cargo.toml


---------

Cargo.toml

@@ -18,6 +18,7 @@ members = [
     "crates/state",
     "crates/wiring",
     "crates/specification",
+    "crates/statetest-types",
 
     # examples
     "examples/block_traces",
@@ -42,6 +43,7 @@ revm = { path = "crates/revm", version = "14.0.1", default-features = false }
 interpreter = { path = "crates/interpreter", package = "revm-interpreter", version = "10.0.1", default-features = false }
 inspector = { path = "crates/inspector", package = "revm-inspector", version = "1.0.0", default-features = false }
 precompile = { path = "crates/precompile", package = "revm-precompile", version = "11.0.1", default-features = false }
+statetest-types = { path = "crates/statetest-types", package = "revm-statetest-types", version = "1.0.0", default-features = false }
 
 [workspace.package]
 license = "MIT"

bins/revme/Cargo.toml

@@ -12,6 +12,7 @@ repository.workspace = true
 # revm
 database.workspace = true
 revm = { workspace = true, features = ["std", "hashbrown", "c-kzg", "blst"] }
+statetest-types = { workspace = true }
 inspector = { workspace = true, features = ["std", "serde-json"] }
 # enable parse std and parse feature. 
 bytecode = { workspace = true, features = ["std", "parse"] }

bins/revme/src/cmd/statetest.rs

@@ -1,5 +1,4 @@
 pub mod merkle_trie;
-pub mod models;
 mod runner;
 pub mod utils;
 

bins/revme/src/cmd/statetest/runner.rs

@@ -1,6 +1,5 @@
 use super::{
     merkle_trie::{log_rlp_hash, state_merkle_trie_root},
-    models::{SpecName, Test, TestSuite},
     utils::recover_address,
 };
 use database::State;
@@ -20,6 +19,8 @@ use revm::{
     Evm,
 };
 use serde_json::json;
+use statetest_types::{SpecName, Test, TestSuite};
+
 use std::{
     fmt::Debug,
     io::{stderr, stdout},

crates/statetest-types/Cargo.toml

@@ -0,0 +1,28 @@
+[package]
+name = "revm-statetest-types"
+description = "State test types for revm"
+version = "1.0.0"
+authors.workspace = true
+edition.workspace = true
+keywords.workspace = true
+license.workspace = true
+repository.workspace = true
+readme.workspace = true
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[lints.rust]
+unreachable_pub = "warn"
+unused_must_use = "deny"
+rust_2018_idioms = "deny"
+
+[lints.rustdoc]
+all = "warn"
+
+[dependencies]
+# revm
+revm = { workspace = true, features = ["std", "serde"] }
+serde = { version = "1.0", features = ["derive", "rc"] }
+serde_json = { version = "1.0", features = ["preserve_order"] }

crates/statetest-types/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2024 draganrakita
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

crates/statetest-types/src/account_info.rs

@@ -0,0 +1,15 @@
+use revm::primitives::{Bytes, HashMap, U256};
+use serde::Deserialize;
+
+use crate::deserializer::deserialize_str_as_u64;
+
+/// Account information.
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize)]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
+pub struct AccountInfo {
+    pub balance: U256,
+    pub code: Bytes,
+    #[serde(deserialize_with = "deserialize_str_as_u64")]
+    pub nonce: u64,
+    pub storage: HashMap<U256, U256>,
+}

bins/revme/src/cmd/statetest/models/deserializer.rs → crates/statetest-types/src/deserializer.rs

@@ -1,6 +1,7 @@
 use revm::primitives::Address;
 use serde::{de, Deserialize};
 
+/// Deserialize a string as a u64.
 pub fn deserialize_str_as_u64<'de, D>(deserializer: D) -> Result<u64, D::Error>
 where
     D: de::Deserializer<'de>,
@@ -15,6 +16,7 @@ where
     .map_err(serde::de::Error::custom)
 }
 
+/// Deserialize a string as an optional Address.
 pub fn deserialize_maybe_empty<'de, D>(deserializer: D) -> Result<Option<Address>, D::Error>
 where
     D: de::Deserializer<'de>,

crates/statetest-types/src/env.rs

@@ -0,0 +1,24 @@
+use revm::primitives::{Address, B256, U256};
+use serde::Deserialize;
+
+/// Environment variables.
+#[derive(Debug, PartialEq, Eq, Deserialize)]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
+pub struct Env {
+    pub current_coinbase: Address,
+    #[serde(default)]
+    pub current_difficulty: U256,
+    pub current_gas_limit: U256,
+    pub current_number: U256,
+    pub current_timestamp: U256,
+    pub current_base_fee: Option<U256>,
+    pub previous_hash: Option<B256>,
+
+    pub current_random: Option<B256>,
+    pub current_beacon_root: Option<B256>,
+    pub current_withdrawals_root: Option<B256>,
+
+    pub parent_blob_gas_used: Option<U256>,
+    pub parent_excess_blob_gas: Option<U256>,
+    pub current_excess_blob_gas: Option<U256>,
+}