From b6db597a575e301888fb648c1f76d32c6e4d58d2 Mon Sep 17 00:00:00 2001 From: Omar Abdulla Date: Mon, 21 Jul 2025 18:54:09 +0300 Subject: [PATCH] Add support for address replacement --- Cargo.lock | 144 +++++++++++++++-------------- crates/core/src/driver/mod.rs | 128 ++++++++++++++++++++----- crates/core/src/main.rs | 10 +- crates/format/src/case.rs | 16 ++++ crates/format/src/input.rs | 113 ++++++++++++++++++++-- crates/format/src/metadata.rs | 141 +++++++++++++++++++++++++++- crates/node-interaction/src/lib.rs | 10 +- crates/node/src/geth.rs | 42 ++++++--- crates/node/src/kitchensink.rs | 57 +++++++++--- 9 files changed, 531 insertions(+), 130 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index bedf2a6..b2684a9 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -67,9 +67,9 @@ checksum = "683d7910e743518b0e34f1186f92494becacb047c7b6bf616c96772180fef923" [[package]] name = "alloy" -version = "1.0.20" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ae58d888221eecf621595e2096836ce7cfc37be06bfa39d7f64aa6a3ea4c9e5b" +checksum = "8ad4eb51e7845257b70c51b38ef8d842d5e5e93196701fcbd757577971a043c6" dependencies = [ "alloy-consensus", "alloy-contract", @@ -102,15 +102,16 @@ dependencies = [ [[package]] name = "alloy-consensus" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ad451f9a70c341d951bca4e811d74dbe1e193897acd17e9dbac1353698cc430b" +checksum = "ca3b746060277f3d7f9c36903bb39b593a741cb7afcb0044164c28f0e9b673f0" dependencies = [ "alloy-eips", "alloy-primitives", "alloy-rlp", "alloy-serde", "alloy-trie", + "alloy-tx-macros", "auto_impl", "c-kzg", "derive_more 2.0.1", @@ -126,9 +127,9 @@ dependencies = [ [[package]] name = "alloy-consensus-any" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "142daffb15d5be1a2b20d2cd540edbcef03037b55d4ff69dc06beb4d06286dba" +checksum = "bf98679329fa708fa809ea596db6d974da892b068ad45e48ac1956f582edf946" dependencies = [ "alloy-consensus", "alloy-eips", @@ -140,9 +141,9 @@ dependencies = [ [[package]] name = "alloy-contract" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ebf25443920ecb9728cb087fe4dc04a0b290bd6ac85638c58fe94aba70f1a44e" +checksum = "a10e47f5305ea08c37b1772086c1573e9a0a257227143996841172d37d3831bb" dependencies = [ "alloy-consensus", "alloy-dyn-abi", @@ -157,6 +158,7 @@ dependencies = [ "alloy-transport", "futures", "futures-util", + "serde_json", "thiserror 2.0.12", ] @@ -227,9 +229,9 @@ dependencies = [ [[package]] name = "alloy-eips" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3056872f6da48046913e76edb5ddced272861f6032f09461aea1a2497be5ae5d" +checksum = "f562a81278a3ed83290e68361f2d1c75d018ae3b8589a314faf9303883e18ec9" dependencies = [ "alloy-eip2124", "alloy-eip2930", @@ -247,15 +249,16 @@ dependencies = [ [[package]] name = "alloy-genesis" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c98fb40f07997529235cc474de814cd7bd9de561e101716289095696c0e4639d" +checksum = "dc41384e9ab8c9b2fb387c52774d9d432656a28edcda1c2d4083e96051524518" dependencies = [ "alloy-eips", "alloy-primitives", "alloy-serde", "alloy-trie", "serde", + "serde_with", ] [[package]] @@ -272,12 +275,13 @@ dependencies = [ [[package]] name = "alloy-json-rpc" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dc08b31ebf9273839bd9a01f9333cbb7a3abb4e820c312ade349dd18bdc79581" +checksum = "12c454fcfcd5d26ed3b8cae5933cbee9da5f0b05df19b46d4bd4446d1f082565" dependencies = [ "alloy-primitives", "alloy-sol-types", + "http", "serde", "serde_json", "thiserror 2.0.12", @@ -286,9 +290,9 @@ dependencies = [ [[package]] name = "alloy-network" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ed117b08f0cc190312bf0c38c34cf4f0dabfb4ea8f330071c587cd7160a88cb2" +checksum = "42d6d39eabe5c7b3d8f23ac47b0b683b99faa4359797114636c66e0743103d05" dependencies = [ "alloy-consensus", "alloy-consensus-any", @@ -312,9 +316,9 @@ dependencies = [ [[package]] name = "alloy-network-primitives" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c7162ff7be8649c0c391f4e248d1273e85c62076703a1f3ec7daf76b283d886d" +checksum = "3704fa8b7ba9ba3f378d99b3d628c8bc8c2fc431b709947930f154e22a8368b6" dependencies = [ "alloy-consensus", "alloy-eips", @@ -342,7 +346,7 @@ dependencies = [ "keccak-asm", "paste", "proptest", - "rand 0.9.1", + "rand 0.9.2", "ruint", "rustc-hash", "serde", @@ -352,9 +356,9 @@ dependencies = [ [[package]] name = "alloy-provider" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d84eba1fd8b6fe8b02f2acd5dd7033d0f179e304bd722d11e817db570d1fa6c4" +checksum = "08800e8cbe70c19e2eb7cf3d7ff4b28bdd9b3933f8e1c8136c7d910617ba03bf" dependencies = [ "alloy-chains", "alloy-consensus", @@ -380,6 +384,7 @@ dependencies = [ "either", "futures", "futures-utils-wasm", + "http", "lru", "parking_lot", "pin-project", @@ -395,9 +400,9 @@ dependencies = [ [[package]] name = "alloy-pubsub" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8550f7306e0230fc835eb2ff4af0a96362db4b6fc3f25767d161e0ad0ac765bf" +checksum = "ae68457a2c2ead6bd7d7acb5bf5f1623324b1962d4f8e7b0250657a3c3ab0a0b" dependencies = [ "alloy-json-rpc", "alloy-primitives", @@ -438,9 +443,9 @@ dependencies = [ [[package]] name = "alloy-rpc-client" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "518a699422a3eab800f3dac2130d8f2edba8e4fff267b27a9c7dc6a2b0d313ee" +checksum = "162301b5a57d4d8f000bf30f4dcb82f9f468f3e5e846eeb8598dd39e7886932c" dependencies = [ "alloy-json-rpc", "alloy-primitives", @@ -448,7 +453,6 @@ dependencies = [ "alloy-transport", "alloy-transport-http", "alloy-transport-ipc", - "async-stream", "futures", "pin-project", "reqwest", @@ -458,16 +462,15 @@ dependencies = [ "tokio-stream", "tower", "tracing", - "tracing-futures", "url", "wasmtimer", ] [[package]] name = "alloy-rpc-types" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c000cab4ec26a4b3e29d144e999e1c539c2fa0abed871bf90311eb3466187ca8" +checksum = "6cd8ca94ae7e2b32cc3895d9981f3772aab0b4756aa60e9ed0bcfee50f0e1328" dependencies = [ "alloy-primitives", "alloy-rpc-types-eth", @@ -478,9 +481,9 @@ dependencies = [ [[package]] name = "alloy-rpc-types-any" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "508b2fbe66d952089aa694e53802327798806498cd29ff88c75135770ecaabfc" +checksum = "076b47e834b367d8618c52dd0a0d6a711ddf66154636df394805300af4923b8a" dependencies = [ "alloy-consensus-any", "alloy-rpc-types-eth", @@ -489,9 +492,9 @@ dependencies = [ [[package]] name = "alloy-rpc-types-debug" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8c832f2e851801093928dbb4b7bd83cd22270faf76b2e080646b806a285c8757" +checksum = "94a2a86ad7b7d718c15e79d0779bd255561b6b22968dc5ed2e7c0fbc43bb55fe" dependencies = [ "alloy-primitives", "serde", @@ -499,9 +502,9 @@ dependencies = [ [[package]] name = "alloy-rpc-types-eth" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fcaf7dff0fdd756a714d58014f4f8354a1706ebf9fa2cf73431e0aeec3c9431e" +checksum = "2c2f847e635ec0be819d06e2ada4bcc4e4204026a83c4bfd78ae8d550e027ae7" dependencies = [ "alloy-consensus", "alloy-consensus-any", @@ -514,14 +517,15 @@ dependencies = [ "itertools 0.14.0", "serde", "serde_json", + "serde_with", "thiserror 2.0.12", ] [[package]] name = "alloy-rpc-types-trace" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6e3507a04e868dd83219ad3cd6a8c58aefccb64d33f426b3934423a206343e84" +checksum = "6fc58180302a94c934d455eeedb3ecb99cdc93da1dbddcdbbdb79dd6fe618b2a" dependencies = [ "alloy-primitives", "alloy-rpc-types-eth", @@ -533,9 +537,9 @@ dependencies = [ [[package]] name = "alloy-serde" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "730e8f2edf2fc224cabd1c25d090e1655fa6137b2e409f92e5eec735903f1507" +checksum = "ae699248d02ade9db493bbdae61822277dc14ae0f82a5a4153203b60e34422a6" dependencies = [ "alloy-primitives", "serde", @@ -544,9 +548,9 @@ dependencies = [ [[package]] name = "alloy-signer" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6b0d2428445ec13edc711909e023d7779618504c4800be055a5b940025dbafe3" +checksum = "3cf7d793c813515e2b627b19a15693960b3ed06670f9f66759396d06ebe5747b" dependencies = [ "alloy-primitives", "async-trait", @@ -559,9 +563,9 @@ dependencies = [ [[package]] name = "alloy-signer-local" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e14fe6fedb7fe6e0dfae47fe020684f1d8e063274ef14bca387ddb7a6efa8ec1" +checksum = "51a424bc5a11df0d898ce0fd15906b88ebe2a6e4f17a514b51bc93946bb756bd" dependencies = [ "alloy-consensus", "alloy-network", @@ -648,9 +652,9 @@ dependencies = [ [[package]] name = "alloy-transport" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a712bdfeff42401a7dd9518f72f617574c36226a9b5414537fedc34350b73bf9" +checksum = "4f317d20f047b3de4d9728c556e2e9a92c9a507702d2016424cd8be13a74ca5e" dependencies = [ "alloy-json-rpc", "alloy-primitives", @@ -671,9 +675,9 @@ dependencies = [ [[package]] name = "alloy-transport-http" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7ea5a76d7f2572174a382aedf36875bedf60bcc41116c9f031cf08040703a2dc" +checksum = "ff084ac7b1f318c87b579d221f11b748341d68b9ddaa4ffca5e62ed2b8cfefb4" dependencies = [ "alloy-json-rpc", "alloy-transport", @@ -686,9 +690,9 @@ dependencies = [ [[package]] name = "alloy-transport-ipc" -version = "1.0.9" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "606af17a7e064d219746f6d2625676122c79d78bf73dfe746d6db9ecd7dbcb85" +checksum = "edb099cdad8ed2e6a80811cdf9bbf715ebf4e34c981b4a6e2d1f9daacbf8b218" dependencies = [ "alloy-json-rpc", "alloy-pubsub", @@ -706,9 +710,9 @@ dependencies = [ [[package]] name = "alloy-trie" -version = "0.8.1" +version = "0.9.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "983d99aa81f586cef9dae38443245e585840fcf0fc58b09aee0b1f27aed1d500" +checksum = "bada1fc392a33665de0dc50d401a3701b62583c655e3522a323490a5da016962" dependencies = [ "alloy-primitives", "alloy-rlp", @@ -720,6 +724,19 @@ dependencies = [ "tracing", ] +[[package]] +name = "alloy-tx-macros" +version = "1.0.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1154c8187a5ff985c95a8b2daa2fedcf778b17d7668e5e50e556c4ff9c881154" +dependencies = [ + "alloy-primitives", + "darling", + "proc-macro2", + "quote", + "syn 2.0.101", +] + [[package]] name = "android-tzdata" version = "0.1.1" @@ -3268,13 +3285,14 @@ dependencies = [ [[package]] name = "nybbles" -version = "0.3.4" +version = "0.4.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8983bb634df7248924ee0c4c3a749609b5abcb082c28fffe3254b3eb3602b307" +checksum = "675b3a54e5b12af997abc8b6638b0aee51a28caedab70d4967e0d5db3a3f1d06" dependencies = [ "alloy-rlp", - "const-hex", + "cfg-if", "proptest", + "ruint", "serde", "smallvec", ] @@ -3719,9 +3737,9 @@ dependencies = [ [[package]] name = "rand" -version = "0.9.1" +version = "0.9.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9fbfd9d094a40bf3ae768db9361049ace4c0e04a4fd6b359518bd7b73a73dd97" +checksum = "6db2770f06117d490610c7488547d543617b21bfa07796d7a12f6f1bd53850d1" dependencies = [ "rand_chacha 0.9.0", "rand_core 0.9.3", @@ -4113,7 +4131,7 @@ dependencies = [ "primitive-types 0.12.2", "proptest", "rand 0.8.5", - "rand 0.9.1", + "rand 0.9.2", "rlp", "ruint-macro", "serde", @@ -5489,18 +5507,6 @@ dependencies = [ "valuable", ] -[[package]] -name = "tracing-futures" -version = "0.2.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "97d095ae15e245a057c8e8451bab9b3ee1e1f68e9ba2b4fbc18d0ac5237835f2" -dependencies = [ - "futures", - "futures-task", - "pin-project", - "tracing", -] - [[package]] name = "tracing-log" version = "0.2.0" diff --git a/crates/core/src/driver/mod.rs b/crates/core/src/driver/mod.rs index fb13c29..55c59d1 100644 --- a/crates/core/src/driver/mod.rs +++ b/crates/core/src/driver/mod.rs @@ -22,8 +22,10 @@ use indexmap::IndexMap; use revive_dt_compiler::{Compiler, SolidityCompiler}; use revive_dt_config::Arguments; use revive_dt_format::case::CaseIdx; -use revive_dt_format::input::{Calldata, Expected, ExpectedOutput, Method}; -use revive_dt_format::metadata::{ContractInstance, ContractPathAndIdentifier}; +use revive_dt_format::input::{Calldata, Expected, ExpectedOutput, Method, default_caller}; +use revive_dt_format::metadata::{ + AddressReplacementMap, ContractInstance, ContractPathAndIdentifier, +}; use revive_dt_format::{input::Input, metadata::Metadata, mode::SolcMode}; use revive_dt_node_interaction::EthereumNode; use revive_dt_report::reporter::{CompilationTask, Report, Span}; @@ -145,11 +147,17 @@ where case_idx: CaseIdx, input: &Input, node: &T::Blockchain, + address_replacement: &AddressReplacementMap, ) -> anyhow::Result<(TransactionReceipt, GethTrace, DiffMode)> { let deployment_receipts = - self.handle_contract_deployment(metadata, case_idx, input, node)?; - let execution_receipt = - self.handle_input_execution(case_idx, input, deployment_receipts, node)?; + self.handle_contract_deployment(metadata, case_idx, input, node, address_replacement)?; + let execution_receipt = self.handle_input_execution( + case_idx, + input, + deployment_receipts, + node, + address_replacement, + )?; self.handle_input_expectations(case_idx, input, &execution_receipt, node)?; self.handle_input_diff(case_idx, execution_receipt, node) } @@ -161,6 +169,7 @@ where case_idx: CaseIdx, input: &Input, node: &T::Blockchain, + address_replacement: &AddressReplacementMap, ) -> anyhow::Result> { let span = tracing::debug_span!( "Handling contract deployment", @@ -252,7 +261,16 @@ where TransactionBuilder::::with_deploy_code(tx, code) }; - let receipt = match node.execute_transaction(tx) { + let receipt = match node.execute_transaction( + tx, + Some( + address_replacement + .as_ref() + .values() + .map(|(sk, _)| sk) + .map(Clone::clone), + ), + ) { Ok(receipt) => receipt, Err(error) => { tracing::error!( @@ -316,6 +334,7 @@ where input: &Input, mut deployment_receipts: HashMap, node: &T::Blockchain, + address_replacement: &AddressReplacementMap, ) -> anyhow::Result { match input.method { // This input was already executed when `handle_input` was called. We just need to @@ -339,7 +358,16 @@ where tracing::trace!("Executing transaction for input: {input:?}"); - match node.execute_transaction(tx) { + match node.execute_transaction( + tx, + Some( + address_replacement + .as_ref() + .values() + .map(|(sk, _)| sk) + .map(Clone::clone), + ), + ) { Ok(receipt) => Ok(receipt), Err(err) => { tracing::error!( @@ -503,18 +531,26 @@ where } // Handling the topics assertion. - let expected = expected_event.topics.as_slice(); - let actual = actual_event.topics(); - if actual != expected { - tracing::error!( - ?execution_receipt, - ?expected, - ?actual, - "Event topics assertion failed", - ); - anyhow::bail!( - "Event topics assertion failed - Expected {expected:?} but got {actual:?}", - ); + for (expected_topic, actual_topic) in expected_event + .topics + .as_slice() + .iter() + .zip(actual_event.topics()) + { + let expected = Calldata::Compound(vec![expected_topic.clone()]) + .calldata(self.deployed_contracts.entry(case_idx).or_default(), node)?; + let actual = actual_topic.to_vec(); + if actual != expected { + tracing::error!( + ?execution_receipt, + ?expected, + ?actual, + "Event topics assertion failed", + ); + anyhow::bail!( + "Event topics assertion failed - Expected {expected:?} but got {actual:?}", + ); + } } // Handling the values assertion. @@ -563,7 +599,7 @@ where } pub struct Driver<'a, Leader: Platform, Follower: Platform> { - metadata: &'a Metadata, + metadata: &'a mut Metadata, config: &'a Arguments, leader_node: &'a Leader::Blockchain, follower_node: &'a Follower::Blockchain, @@ -575,7 +611,7 @@ where F: Platform, { pub fn new( - metadata: &'a Metadata, + metadata: &'a mut Metadata, config: &'a Arguments, leader_node: &'a L::Blockchain, follower_node: &'a F::Blockchain, @@ -686,6 +722,45 @@ where // For cases if one of the inputs fail then we move on to the next case and we do NOT // bail out of the whole thing. + let replacement_maps = self + .metadata + .cases + .iter_mut() + .enumerate() + .map(|(case_id, case)| (CaseIdx::new(case_id), case)) + .fold(HashMap::new(), |mut map, (case_idx, case)| { + let mut replacement_map = AddressReplacementMap::default(); + case.inputs + .iter() + .filter_map(|input| { + if input.caller == default_caller() { + None + } else { + Some(input.caller) + } + }) + .for_each(|caller| { + replacement_map.get(caller); + }); + if let Err(error) = case.handle_address_replacement(&mut replacement_map) { + tracing::error!( + target = ?Target::Leader, + ?error, + "Case address replacement failed" + ); + execution_result.add_failed_case( + Target::Leader, + mode.clone(), + case.name.as_deref().unwrap_or("no case name").to_owned(), + case_idx, + 0, + anyhow::Error::msg(format!("{error}")), + ); + } + map.insert(case_idx, replacement_map); + map + }); + 'case_loop: for (case_idx, case) in self.metadata.cases.iter().enumerate() { let tracing_span = tracing::info_span!( "Handling case", @@ -695,6 +770,7 @@ where let _guard = tracing_span.enter(); let case_idx = CaseIdx::new_from(case_idx); + let replacement_map = replacement_maps.get(&case_idx).cloned().unwrap_or_default(); // For inputs if one of the inputs fail we move on to the next case (we do not move // on to the next input as it doesn't make sense. It depends on the previous one). @@ -706,8 +782,13 @@ where tracing::info_span!("Executing input", contract_name = ?input.instance) .in_scope(|| { let (leader_receipt, _, leader_diff) = match leader_state - .handle_input(self.metadata, case_idx, &input, self.leader_node) - { + .handle_input( + self.metadata, + case_idx, + &input, + self.leader_node, + &replacement_map, + ) { Ok(result) => result, Err(error) => { tracing::error!( @@ -736,6 +817,7 @@ where case_idx, &input, self.follower_node, + &replacement_map, ) { Ok(result) => result, Err(error) => { diff --git a/crates/core/src/main.rs b/crates/core/src/main.rs index c8403af..e61281b 100644 --- a/crates/core/src/main.rs +++ b/crates/core/src/main.rs @@ -20,12 +20,12 @@ static TEMP_DIR: LazyLock = LazyLock::new(|| TempDir::new().unwrap()); fn main() -> anyhow::Result<()> { let args = init_cli()?; - for (corpus, tests) in collect_corpora(&args)? { + for (corpus, mut tests) in collect_corpora(&args)? { let span = Span::new(corpus, args.clone())?; match &args.compile_only { Some(platform) => compile_corpus(&args, &tests, platform, span), - None => execute_corpus(&args, &tests, span)?, + None => execute_corpus(&args, &mut tests, span)?, } Report::save()?; @@ -83,7 +83,7 @@ fn collect_corpora(args: &Arguments) -> anyhow::Result(args: &Arguments, tests: &[MetadataFile], span: Span) -> anyhow::Result<()> +fn run_driver(args: &Arguments, tests: &mut [MetadataFile], span: Span) -> anyhow::Result<()> where L: Platform, F: Platform, @@ -93,7 +93,7 @@ where let leader_nodes = NodePool::::new(args)?; let follower_nodes = NodePool::::new(args)?; - tests.par_iter().for_each( + tests.par_iter_mut().for_each( |MetadataFile { content: metadata, path: metadata_file_path, @@ -141,7 +141,7 @@ where Ok(()) } -fn execute_corpus(args: &Arguments, tests: &[MetadataFile], span: Span) -> anyhow::Result<()> { +fn execute_corpus(args: &Arguments, tests: &mut [MetadataFile], span: Span) -> anyhow::Result<()> { match (&args.leader, &args.follower) { (TestingPlatform::Geth, TestingPlatform::Kitchensink) => { run_driver::(args, tests, span)? diff --git a/crates/format/src/case.rs b/crates/format/src/case.rs index 0013ac6..96cd299 100644 --- a/crates/format/src/case.rs +++ b/crates/format/src/case.rs @@ -3,6 +3,7 @@ use serde::Deserialize; use crate::{ define_wrapper_type, input::{Expected, Input}, + metadata::AddressReplacementMap, mode::Mode, }; @@ -16,6 +17,21 @@ pub struct Case { pub expected: Option, } +impl Case { + pub fn handle_address_replacement( + &mut self, + old_to_new_mapping: &mut AddressReplacementMap, + ) -> anyhow::Result<()> { + for input in self.inputs.iter_mut() { + input.handle_address_replacement(old_to_new_mapping)?; + } + if let Some(ref mut expected) = self.expected { + expected.handle_address_replacement(old_to_new_mapping)?; + } + Ok(()) + } +} + define_wrapper_type!( /// A wrapper type for the index of test cases found in metadata file. #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)] diff --git a/crates/format/src/input.rs b/crates/format/src/input.rs index 6d49e74..a0965f3 100644 --- a/crates/format/src/input.rs +++ b/crates/format/src/input.rs @@ -7,13 +7,13 @@ use alloy::{ primitives::{Address, Bytes, U256}, rpc::types::TransactionRequest, }; -use alloy_primitives::B256; +use alloy_primitives::FixedBytes; use semver::VersionReq; use serde::Deserialize; use revive_dt_node_interaction::EthereumNode; -use crate::metadata::ContractInstance; +use crate::metadata::{AddressReplacementMap, ContractInstance}; #[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)] pub struct Input { @@ -50,7 +50,7 @@ pub struct ExpectedOutput { #[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)] pub struct Event { pub address: Option
, - pub topics: Vec, + pub topics: Vec, pub values: Calldata, } @@ -101,6 +101,41 @@ impl ExpectedOutput { self.return_data = Some(calldata); self } + + pub fn handle_address_replacement( + &mut self, + old_to_new_mapping: &mut AddressReplacementMap, + ) -> anyhow::Result<()> { + if let Some(ref mut calldata) = self.return_data { + calldata.handle_address_replacement(old_to_new_mapping)?; + } + if let Some(ref mut events) = self.events { + for event in events.iter_mut() { + event.handle_address_replacement(old_to_new_mapping)?; + } + } + Ok(()) + } +} + +impl Event { + pub fn handle_address_replacement( + &mut self, + old_to_new_mapping: &mut AddressReplacementMap, + ) -> anyhow::Result<()> { + if let Some(ref mut address) = self.address { + if let Some(new_address) = old_to_new_mapping.resolve(address.to_string().as_str()) { + *address = new_address + } + }; + for topic in self.topics.iter_mut() { + if let Some(new_address) = old_to_new_mapping.resolve(topic.to_string().as_str()) { + *topic = new_address.to_string(); + } + } + self.values.handle_address_replacement(old_to_new_mapping)?; + Ok(()) + } } impl Default for Calldata { @@ -120,6 +155,23 @@ impl Calldata { } } + pub fn handle_address_replacement( + &mut self, + old_to_new_mapping: &mut AddressReplacementMap, + ) -> anyhow::Result<()> { + match self { + Calldata::Single(_) => {} + Calldata::Compound(items) => { + for item in items.iter_mut() { + if let Some(resolved) = old_to_new_mapping.resolve(item) { + *item = resolved.to_string() + } + } + } + } + Ok(()) + } + pub fn calldata( &self, deployed_contracts: &HashMap, @@ -165,6 +217,28 @@ impl Calldata { } } +impl Expected { + pub fn handle_address_replacement( + &mut self, + old_to_new_mapping: &mut AddressReplacementMap, + ) -> anyhow::Result<()> { + match self { + Expected::Calldata(calldata) => { + calldata.handle_address_replacement(old_to_new_mapping)?; + } + Expected::Expected(expected_output) => { + expected_output.handle_address_replacement(old_to_new_mapping)?; + } + Expected::ExpectedMany(expected_outputs) => { + for expected_output in expected_outputs.iter_mut() { + expected_output.handle_address_replacement(old_to_new_mapping)?; + } + } + } + Ok(()) + } +} + impl Input { fn instance_to_address( &self, @@ -267,14 +341,36 @@ impl Input { vec } + + pub fn handle_address_replacement( + &mut self, + old_to_new_mapping: &mut AddressReplacementMap, + ) -> anyhow::Result<()> { + if self.caller != default_caller() { + self.caller = old_to_new_mapping.get(self.caller); + } + self.calldata + .handle_address_replacement(old_to_new_mapping)?; + if let Some(ref mut expected) = self.expected { + expected.handle_address_replacement(old_to_new_mapping)?; + } + if let Some(ref mut storage) = self.storage { + for calldata in storage.values_mut() { + calldata.handle_address_replacement(old_to_new_mapping)?; + } + } + Ok(()) + } } fn default_instance() -> ContractInstance { ContractInstance::new_from("Test") } -fn default_caller() -> Address { - "90F8bf6A479f320ead074411a4B0e7944Ea8c9C1".parse().unwrap() +pub const fn default_caller() -> Address { + Address(FixedBytes(alloy::hex!( + "90F8bf6A479f320ead074411a4B0e7944Ea8c9C1" + ))) } /// This function takes in the string calldata argument provided in the JSON input and resolves it @@ -285,7 +381,7 @@ fn default_caller() -> Address { /// This piece of code is taken from the matter-labs-tester repository which is licensed under MIT /// or Apache. The original source code can be found here: /// https://github.com/matter-labs/era-compiler-tester/blob/0ed598a27f6eceee7008deab3ff2311075a2ec69/compiler_tester/src/test/case/input/value.rs#L43-L146 -fn resolve_argument( +pub fn resolve_argument( value: &str, deployed_contracts: &HashMap, chain_state_provider: &impl EthereumNode, @@ -352,8 +448,8 @@ fn resolve_argument( mod tests { use super::*; - use alloy::json_abi::JsonAbi; - use alloy_primitives::address; + use alloy::{json_abi::JsonAbi, network::TxSigner}; + use alloy_primitives::{Signature, address}; use alloy_sol_types::SolValue; use std::collections::HashMap; @@ -363,6 +459,7 @@ mod tests { fn execute_transaction( &self, _: TransactionRequest, + _: Option + Send + Sync + 'static>>, ) -> anyhow::Result { unimplemented!() } diff --git a/crates/format/src/metadata.rs b/crates/format/src/metadata.rs index abd4150..980d6d3 100644 --- a/crates/format/src/metadata.rs +++ b/crates/format/src/metadata.rs @@ -1,5 +1,5 @@ use std::{ - collections::BTreeMap, + collections::{BTreeMap, HashMap}, fmt::Display, fs::{File, read_to_string}, ops::Deref, @@ -7,11 +7,15 @@ use std::{ str::FromStr, }; +use alloy::{network::TxSigner, signers::local::PrivateKeySigner}; +use alloy_primitives::{Address, Signature}; +use revive_dt_node_interaction::EthereumNode; use serde::{Deserialize, Serialize}; use crate::{ case::Case, define_wrapper_type, + input::resolve_argument, mode::{Mode, SolcMode}, }; @@ -210,6 +214,17 @@ impl Metadata { } } } + + pub fn handle_address_replacement( + &mut self, + old_to_new_mapping: &mut AddressReplacementMap, + ) -> anyhow::Result<()> { + for case in self.cases.iter_mut() { + case.handle_address_replacement(old_to_new_mapping)?; + } + tracing::debug!(metadata = ?self, "Performed replacement on metadata"); + Ok(()) + } } define_wrapper_type!( @@ -308,6 +323,130 @@ impl From for String { } } +#[derive(Clone, Debug, Default)] +pub struct AddressReplacementMap(HashMap); + +impl AddressReplacementMap { + pub fn new() -> Self { + Self(Default::default()) + } + + pub fn into_inner(self) -> HashMap { + self.0 + } + + pub fn contains_key(&self, address: &Address) -> bool { + self.0.contains_key(address) + } + + pub fn get(&mut self, address: Address) -> Address { + self.0 + .entry(address) + .or_insert_with(|| { + let private_key = Self::new_random_private_key_signer(); + let account = private_key.address(); + tracing::debug!( + old_address = %address, + new_address = %account, + "Added a new address replacement" + ); + (private_key, account) + }) + .1 + } + + pub fn resolve(&mut self, value: &str) -> Option
{ + // We attempt to resolve the given string without any additional context of the deployed + // contracts or the node API as we do not need them. If the resolution fails then we know + // that this isn't an address and we skip it. + let Ok(resolved) = resolve_argument(value, &Default::default(), &UnimplementedEthereumNode) + else { + return None; + }; + let resolved_bytes = resolved.to_be_bytes_trimmed_vec(); + let Ok(address) = Address::try_from(resolved_bytes.as_slice()) else { + return None; + }; + self.0.get(&address).map(|(_, address)| *address) + } + + fn new_random_private_key_signer() -> PrivateKeySigner { + // TODO: Use a seedable RNG to allow for deterministic allocation of the private keys so + // that we get reproducible runs. + PrivateKeySigner::random() + } +} + +impl AsRef> for AddressReplacementMap { + fn as_ref(&self) -> &HashMap { + &self.0 + } +} + +struct UnimplementedEthereumNode; + +impl EthereumNode for UnimplementedEthereumNode { + fn execute_transaction( + &self, + _: alloy::rpc::types::TransactionRequest, + _: Option + Send + Sync + 'static>>, + ) -> anyhow::Result { + anyhow::bail!("Unimplemented") + } + + fn chain_id(&self) -> anyhow::Result { + anyhow::bail!("Unimplemented") + } + + fn block_gas_limit(&self, _: alloy::eips::BlockNumberOrTag) -> anyhow::Result { + anyhow::bail!("Unimplemented") + } + + fn block_coinbase(&self, _: alloy::eips::BlockNumberOrTag) -> anyhow::Result
{ + anyhow::bail!("Unimplemented") + } + + fn block_difficulty( + &self, + _: alloy::eips::BlockNumberOrTag, + ) -> anyhow::Result { + anyhow::bail!("Unimplemented") + } + + fn block_hash( + &self, + _: alloy::eips::BlockNumberOrTag, + ) -> anyhow::Result { + anyhow::bail!("Unimplemented") + } + + fn block_timestamp( + &self, + _: alloy::eips::BlockNumberOrTag, + ) -> anyhow::Result { + anyhow::bail!("Unimplemented") + } + + fn last_block_number(&self) -> anyhow::Result { + anyhow::bail!("Unimplemented") + } + + fn trace_transaction( + &self, + _: &alloy::rpc::types::TransactionReceipt, + _: alloy::rpc::types::trace::geth::GethDebugTracingOptions, + ) -> anyhow::Result { + anyhow::bail!("Unimplemented") + } + + fn state_diff( + &self, + _: &alloy::rpc::types::TransactionReceipt, + ) -> anyhow::Result { + anyhow::bail!("Unimplemented") + } +} + #[cfg(test)] mod test { use super::*; diff --git a/crates/node-interaction/src/lib.rs b/crates/node-interaction/src/lib.rs index 8ac488c..470c67c 100644 --- a/crates/node-interaction/src/lib.rs +++ b/crates/node-interaction/src/lib.rs @@ -1,9 +1,11 @@ //! This crate implements all node interactions. use alloy::eips::BlockNumberOrTag; +use alloy::network::TxSigner; use alloy::primitives::{Address, BlockHash, BlockNumber, BlockTimestamp, ChainId, U256}; use alloy::rpc::types::trace::geth::{DiffMode, GethDebugTracingOptions, GethTrace}; use alloy::rpc::types::{TransactionReceipt, TransactionRequest}; +use alloy::signers::Signature; use anyhow::Result; mod blocking_executor; @@ -12,7 +14,13 @@ pub use blocking_executor::*; /// An interface for all interactions with Ethereum compatible nodes. pub trait EthereumNode { /// Execute the [TransactionRequest] and return a [TransactionReceipt]. - fn execute_transaction(&self, transaction: TransactionRequest) -> Result; + fn execute_transaction( + &self, + transaction: TransactionRequest, + additional_signers: Option< + impl IntoIterator + Send + Sync + 'static>, + >, + ) -> Result; /// Trace the transaction in the [TransactionReceipt] and return a [GethTrace]. fn trace_transaction( diff --git a/crates/node/src/geth.rs b/crates/node/src/geth.rs index 1f5e9f1..84b100b 100644 --- a/crates/node/src/geth.rs +++ b/crates/node/src/geth.rs @@ -11,7 +11,7 @@ use std::{ use alloy::{ eips::BlockNumberOrTag, - network::{Ethereum, EthereumWallet}, + network::{Ethereum, EthereumWallet, TxSigner}, primitives::{Address, BlockHash, BlockNumber, BlockTimestamp, U256}, providers::{ Provider, ProviderBuilder, @@ -22,6 +22,7 @@ use alloy::{ TransactionReceipt, TransactionRequest, trace::geth::{DiffMode, GethDebugTracingOptions, PreStateConfig, PreStateFrame}, }, + signers::{Signature, local::PrivateKeySigner}, }; use revive_dt_config::Arguments; use revive_dt_node_interaction::{BlockingExecutor, EthereumNode}; @@ -195,13 +196,19 @@ impl Instance { fn provider( &self, + additional_signers: Option< + impl IntoIterator + Send + Sync + 'static>, + >, ) -> impl Future< Output = anyhow::Result< FillProvider, impl Provider, Ethereum>, >, > + 'static { let connection_string = self.connection_string(); - let wallet = self.wallet.clone(); + let mut wallet = self.wallet.clone(); + for signer in additional_signers.into_iter().flatten() { + wallet.register_signer(signer); + } // Note: We would like all providers to make use of the same nonce manager so that we have // monotonically increasing nonces that are cached. The cached nonce manager uses Arc's in @@ -221,6 +228,16 @@ impl Instance { .map_err(Into::into) }) } + + fn provider_no_additional_signers( + &self, + ) -> impl Future< + Output = anyhow::Result< + FillProvider, impl Provider, Ethereum>, + >, + > + 'static { + self.provider(None::>) + } } impl EthereumNode for Instance { @@ -228,8 +245,11 @@ impl EthereumNode for Instance { fn execute_transaction( &self, transaction: TransactionRequest, + additional_signers: Option< + impl IntoIterator + Send + Sync + 'static>, + >, ) -> anyhow::Result { - let provider = self.provider(); + let provider = self.provider(additional_signers); BlockingExecutor::execute(async move { let outer_span = tracing::debug_span!("Submitting transaction", ?transaction); let _outer_guard = outer_span.enter(); @@ -316,7 +336,7 @@ impl EthereumNode for Instance { trace_options: GethDebugTracingOptions, ) -> anyhow::Result { let tx_hash = transaction.transaction_hash; - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { Ok(provider .await? @@ -343,7 +363,7 @@ impl EthereumNode for Instance { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn chain_id(&self) -> anyhow::Result { - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider.await?.get_chain_id().await.map_err(Into::into) })? @@ -351,7 +371,7 @@ impl EthereumNode for Instance { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn block_gas_limit(&self, number: BlockNumberOrTag) -> anyhow::Result { - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider .await? @@ -364,7 +384,7 @@ impl EthereumNode for Instance { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn block_coinbase(&self, number: BlockNumberOrTag) -> anyhow::Result
{ - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider .await? @@ -377,7 +397,7 @@ impl EthereumNode for Instance { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn block_difficulty(&self, number: BlockNumberOrTag) -> anyhow::Result { - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider .await? @@ -390,7 +410,7 @@ impl EthereumNode for Instance { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn block_hash(&self, number: BlockNumberOrTag) -> anyhow::Result { - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider .await? @@ -403,7 +423,7 @@ impl EthereumNode for Instance { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn block_timestamp(&self, number: BlockNumberOrTag) -> anyhow::Result { - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider .await? @@ -416,7 +436,7 @@ impl EthereumNode for Instance { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn last_block_number(&self) -> anyhow::Result { - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider.await?.get_block_number().await.map_err(Into::into) })? diff --git a/crates/node/src/kitchensink.rs b/crates/node/src/kitchensink.rs index 4c9401c..2d835aa 100644 --- a/crates/node/src/kitchensink.rs +++ b/crates/node/src/kitchensink.rs @@ -12,7 +12,7 @@ use alloy::{ eips::BlockNumberOrTag, hex, network::{ - Ethereum, EthereumWallet, Network, TransactionBuilder, TransactionBuilderError, + Ethereum, EthereumWallet, Network, TransactionBuilder, TransactionBuilderError, TxSigner, UnbuiltTransactionError, }, primitives::{Address, B64, B256, BlockHash, BlockNumber, BlockTimestamp, Bloom, Bytes, U256}, @@ -26,6 +26,7 @@ use alloy::{ eth::{Block, Header, Transaction}, trace::geth::{DiffMode, GethDebugTracingOptions, PreStateConfig, PreStateFrame}, }, + signers::{Signature, local::PrivateKeySigner}, }; use serde::{Deserialize, Serialize}; use serde_json::{Value as JsonValue, json}; @@ -335,6 +336,9 @@ impl KitchensinkNode { fn provider( &self, + additional_signers: Option< + impl IntoIterator + Send + Sync + 'static>, + >, ) -> impl Future< Output = anyhow::Result< FillProvider< @@ -345,7 +349,10 @@ impl KitchensinkNode { >, > + 'static { let connection_string = self.connection_string(); - let wallet = self.wallet.clone(); + let mut wallet = self.wallet.clone(); + for signer in additional_signers.into_iter().flatten() { + wallet.register_signer(signer); + } // Note: We would like all providers to make use of the same nonce manager so that we have // monotonically increasing nonces that are cached. The cached nonce manager uses Arc's in @@ -370,6 +377,20 @@ impl KitchensinkNode { .map_err(Into::into) }) } + + fn provider_no_additional_signers( + &self, + ) -> impl Future< + Output = anyhow::Result< + FillProvider< + impl TxFiller, + impl Provider, + KitchenSinkNetwork, + >, + >, + > + 'static { + self.provider(None::>) + } } impl EthereumNode for KitchensinkNode { @@ -377,9 +398,12 @@ impl EthereumNode for KitchensinkNode { fn execute_transaction( &self, transaction: alloy::rpc::types::TransactionRequest, + additional_signers: Option< + impl IntoIterator + Send + Sync + 'static>, + >, ) -> anyhow::Result { tracing::debug!(?transaction, "Submitting transaction"); - let provider = self.provider(); + let provider = self.provider(additional_signers); let receipt = BlockingExecutor::execute(async move { Ok(provider .await? @@ -399,7 +423,7 @@ impl EthereumNode for KitchensinkNode { trace_options: GethDebugTracingOptions, ) -> anyhow::Result { let tx_hash = transaction.transaction_hash; - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { Ok(provider .await? @@ -426,7 +450,7 @@ impl EthereumNode for KitchensinkNode { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn chain_id(&self) -> anyhow::Result { - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider.await?.get_chain_id().await.map_err(Into::into) })? @@ -434,7 +458,7 @@ impl EthereumNode for KitchensinkNode { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn block_gas_limit(&self, number: BlockNumberOrTag) -> anyhow::Result { - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider .await? @@ -447,7 +471,7 @@ impl EthereumNode for KitchensinkNode { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn block_coinbase(&self, number: BlockNumberOrTag) -> anyhow::Result
{ - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider .await? @@ -460,7 +484,7 @@ impl EthereumNode for KitchensinkNode { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn block_difficulty(&self, number: BlockNumberOrTag) -> anyhow::Result { - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider .await? @@ -473,7 +497,7 @@ impl EthereumNode for KitchensinkNode { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn block_hash(&self, number: BlockNumberOrTag) -> anyhow::Result { - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider .await? @@ -486,7 +510,7 @@ impl EthereumNode for KitchensinkNode { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn block_timestamp(&self, number: BlockNumberOrTag) -> anyhow::Result { - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider .await? @@ -499,7 +523,7 @@ impl EthereumNode for KitchensinkNode { #[tracing::instrument(skip_all, fields(geth_node_id = self.id))] fn last_block_number(&self) -> anyhow::Result { - let provider = self.provider(); + let provider = self.provider_no_additional_signers(); BlockingExecutor::execute(async move { provider.await?.get_block_number().await.map_err(Into::into) })? @@ -634,6 +658,12 @@ impl TransactionBuilder for ::Transacti ) } + fn take_nonce(&mut self) -> Option { + <::TransactionRequest as TransactionBuilder>::take_nonce( + self, + ) + } + fn input(&self) -> Option<&alloy::primitives::Bytes> { <::TransactionRequest as TransactionBuilder>::input(self) } @@ -1076,7 +1106,10 @@ mod tests { // Arrange let (node, args, _temp_dir) = new_node(); - let provider = node.provider().await.expect("Failed to create provider"); + let provider = node + .provider_no_additional_signers() + .await + .expect("Failed to create provider"); let account_address = args.wallet().default_signer().address(); let transaction = TransactionRequest::default()