test-utils (#16)

* feat: test-utils

* fix: lint

* lint: clippy

* nit: import

* test: add one for extraction

* chore: change hidden to feature gate

* feat: assert_conforms

* fix: clippy

* lint: fmt

* feat: assert_conforms

* nit: import

* chore: unused clone

* chore: bump jsonrpsee

* nit: newline

* nit: newline

Author: prestwich

Cargo.toml

@@ -81,7 +81,7 @@ async-trait = "0.1.87"
 parking_lot = "0.12"
 
 # Rpc
-jsonrpsee = "0.24"
+jsonrpsee = "0.24.9"
 jsonrpsee-core = "0.24"
 jsonrpsee-http-client = "0.24"
 jsonrpsee-types = "0.24"

crates/evm/Cargo.toml

@@ -28,6 +28,9 @@ reth-db-common.workspace = true
 
 trevm = { workspace = true, features = ["test-utils"] }
 
+signet-types = { workspace = true, features = ["test-utils"] }
+signet-extract = { workspace = true, features = ["test-utils"] }
+
 [features]
 default = []
-test_utils = []
+test-utils = ["signet-types/test-utils"]

crates/evm/src/driver.rs

@@ -780,7 +780,10 @@ mod test {
     };
     use reth::primitives::{Block, RecoveredBlock, Transaction};
     use signet_extract::ExtractedEvent;
-    use signet_types::config::{HostConfig, PredeployTokens, RollupConfig};
+    use signet_types::{
+        config::{HostConfig, PredeployTokens, RollupConfig},
+        test_utils::*,
+    };
     use trevm::NoopCfg;
 
     /// Make a fake block with a specific number.

crates/evm/src/lib.rs

@@ -76,61 +76,14 @@ where
 }
 
 /// Test utilities for the Signet EVM impl.
-#[cfg(any(test, feature = "test_utils"))]
+#[cfg(any(test, feature = "test-utils"))]
 pub mod test_utils {
-    use alloy::primitives::Address;
-    use reth::revm::InMemoryDB;
-    use signet_types::config::{HostConfig, PredeployTokens, RollupConfig, SignetSystemConstants};
-
-    /// Test chain id for the host chain.
-    pub const TEST_HOST_CHAIN_ID: u64 = 1;
-    /// Test chain id for the RU chain.
-    pub const TEST_RU_CHAIN_ID: u64 = 15;
-    /// Test address for the host zenith.
-    pub const HOST_ZENITH_ADDRESS: Address = Address::repeat_byte(0xdf);
-    /// Test address for the RU zenith.
-    pub const RU_ORDERS_ADDRESS: Address = Address::repeat_byte(0xac);
-    /// Test address for the host orders.
-    pub const HOST_ORDERS_ADDRESS: Address = Address::repeat_byte(0xdc);
-
-    /// Test address for USDC.
-    pub const TEST_USDC: Address = Address::repeat_byte(0x01);
-
-    /// Test address for USDT.
-    pub const TEST_USDT: Address = Address::repeat_byte(0x02);
-
-    /// Test address for WBTC.
-    pub const TEST_WBTC: Address = Address::repeat_byte(0x03);
-
-    /// Create a new set of Signet system constants for testing.
-    pub const fn test_signet_constants() -> SignetSystemConstants {
-        let usdc = Address::repeat_byte(0x01);
-        let usdt = Address::repeat_byte(0x02);
-        let wbtc = Address::repeat_byte(0x03);
-
-        SignetSystemConstants::new(
-            HostConfig::new(
-                TEST_HOST_CHAIN_ID,
-                0,
-                HOST_ZENITH_ADDRESS,
-                HOST_ORDERS_ADDRESS,
-                Address::repeat_byte(1),
-                Address::repeat_byte(2),
-                PredeployTokens::new(usdc, usdt, wbtc),
-            ),
-            RollupConfig::new(
-                TEST_RU_CHAIN_ID,
-                RU_ORDERS_ADDRESS,
-                Address::repeat_byte(3),
-                Address::repeat_byte(4),
-                PredeployTokens::new(usdc, usdt, wbtc),
-            ),
-        )
-    }
+    use signet_types::test_utils::*;
+    use trevm::revm::InMemoryDB;
 
     /// Create a new Signet EVM with an in-memory database for testing.
     pub fn test_signet_evm() -> super::EvmNeedsCfg<'static, trevm::revm::db::InMemoryDB> {
-        let mut trevm = super::signet_evm(InMemoryDB::default(), test_signet_constants());
+        let mut trevm = super::signet_evm(InMemoryDB::default(), TEST_CONSTANTS);
         trevm.inner_mut_unchecked().cfg_mut().chain_id = TEST_RU_CHAIN_ID;
         trevm
     }

crates/extract/Cargo.toml

@@ -17,3 +17,14 @@ alloy.workspace = true
 reth.workspace = true
 
 tracing.workspace = true
+
+# test utils
+reth-exex = { workspace = true, optional = true }
+
+[dev-dependencies]
+signet-types = { workspace = true, features = ["test-utils"] }
+reth-exex = { workspace = true }
+
+[features]
+default = []
+test-utils = ["dep:reth-exex", "signet-types/test-utils"]

crates/extract/src/block.rs

@@ -1,9 +1,8 @@
+use crate::ExtractedEvent;
 use reth::primitives::{Block, RecoveredBlock};
 use signet_types::MarketContext;
 use signet_zenith::{Passage, Transactor, Zenith};
 
-use crate::ExtractedEvent;
-
 /// The output of the block extraction process. This struct contains borrows
 /// from a block object, the extracted events, and a [`MarketContext`]
 /// populated with the fills present in the host block.
@@ -73,7 +72,7 @@ impl Extracts<'_> {
 
 impl<'a> Extracts<'a> {
     /// Used for testing.
-    #[doc(hidden)]
+    #[cfg(any(test, feature = "test-utils"))]
     pub fn empty(host_block: &'a RecoveredBlock<Block>) -> Self {
         Self {
             host_block,

crates/extract/src/extractor.rs

@@ -150,3 +150,37 @@ impl Extractor {
             })
     }
 }
+
+#[cfg(test)]
+mod test {
+    use super::*;
+    use crate::test_utils::*;
+    use alloy::{
+        consensus::constants::GWEI_TO_WEI,
+        primitives::{Address, U256},
+    };
+    use signet_types::test_utils::*;
+
+    #[test]
+    fn extraction() {
+        let mut ru_block = RuBlockSpec::new(TEST_CONSTANTS)
+            .with_gas_limit(12345)
+            .with_reward_address(Address::repeat_byte(0x99));
+        ru_block.add_simple_send(&TEST_SIGNERS[0], TEST_USERS[1], U256::from(GWEI_TO_WEI), 0);
+
+        let hbs = HostBlockSpec::new(TEST_CONSTANTS)
+            .with_block_number(1)
+            .enter(TEST_USERS[0], (GWEI_TO_WEI * 4) as usize)
+            .enter(TEST_USERS[1], (GWEI_TO_WEI * 2) as usize)
+            .enter_token(TEST_USERS[2], 10_000_000, USDC)
+            .simple_transact(TEST_USERS[0], TEST_USERS[4], [1, 2, 3, 4], GWEI_TO_WEI as usize)
+            .fill(USDT, TEST_USERS[4], 10_000)
+            .submit_block(ru_block);
+        let (chain, _) = hbs.to_chain();
+
+        let extractor = Extractor::new(&TEST_CONSTANTS);
+        let extracts = extractor.extract_signet(&chain).next().unwrap();
+
+        hbs.assert_conforms(&extracts);
+    }
+}

crates/extract/src/lib.rs

@@ -36,3 +36,7 @@ pub use extractor::Extractor;
 
 mod block;
 pub use block::Extracts;
+
+#[cfg(any(test, feature = "test-utils"))]
+/// Utils for unit and integration tests.
+pub mod test_utils;