mirror of
https://github.com/pezkuwichain/revive-differential-tests.git
synced 2026-04-22 10:17:56 +00:00
Compare commits
38 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 2a1f81fb6d | |||
| 51191013c1 | |||
| c81279fc8f | |||
| 0392b6b629 | |||
| ac94c972de | |||
| 5cc814b0e0 | |||
| 0722791a28 | |||
| 52042dfff5 | |||
| e3c717f4d9 | |||
| e7ebe4fa2f | |||
| 5c957e5ac1 | |||
| a0248b58f3 | |||
| 6a9acea748 | |||
| c31c7d94f9 | |||
| dcc43d4ea6 | |||
| cb13c3c2cd | |||
| 7cda3416f0 | |||
| d7bc4f1fab | |||
| b6db597a57 | |||
| d7136d9a3d | |||
| e5a3f0aee9 | |||
| 3cdf57f7c3 | |||
| dab8ffe520 | |||
| c913a8222f | |||
| c8cef4834f | |||
| ca59a1f6a9 | |||
| adc0c44cde | |||
| 811e17136b | |||
| ba32bad6b3 | |||
| bb754cba4f | |||
| c858bbe66d | |||
| 906878f06a | |||
| 9a71369e8a | |||
| 84ab873b46 | |||
| 2ef6f7ba63 | |||
| 38e6140a7c | |||
| ca6c5529e2 | |||
| 038a2db53c |
Generated
+5
-16
@@ -3948,22 +3948,10 @@ dependencies = [
|
||||
"serde_stacker",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "revive-dt-common"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"futures",
|
||||
"once_cell",
|
||||
"tokio",
|
||||
"tracing",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "revive-dt-compiler"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"alloy-primitives",
|
||||
"anyhow",
|
||||
"revive-common",
|
||||
"revive-dt-config",
|
||||
@@ -3994,7 +3982,6 @@ dependencies = [
|
||||
"clap",
|
||||
"indexmap 2.10.0",
|
||||
"rayon",
|
||||
"revive-dt-common",
|
||||
"revive-dt-compiler",
|
||||
"revive-dt-config",
|
||||
"revive-dt-format",
|
||||
@@ -4016,7 +4003,7 @@ dependencies = [
|
||||
"alloy-primitives",
|
||||
"alloy-sol-types",
|
||||
"anyhow",
|
||||
"revive-dt-common",
|
||||
"revive-dt-node-interaction",
|
||||
"semver 1.0.26",
|
||||
"serde",
|
||||
"serde_json",
|
||||
@@ -4029,9 +4016,7 @@ version = "0.1.0"
|
||||
dependencies = [
|
||||
"alloy",
|
||||
"anyhow",
|
||||
"revive-dt-common",
|
||||
"revive-dt-config",
|
||||
"revive-dt-format",
|
||||
"revive-dt-node-interaction",
|
||||
"serde",
|
||||
"serde_json",
|
||||
@@ -4048,6 +4033,10 @@ version = "0.1.0"
|
||||
dependencies = [
|
||||
"alloy",
|
||||
"anyhow",
|
||||
"futures",
|
||||
"once_cell",
|
||||
"tokio",
|
||||
"tracing",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
|
||||
@@ -11,7 +11,6 @@ repository = "https://github.com/paritytech/revive-differential-testing.git"
|
||||
rust-version = "1.85.0"
|
||||
|
||||
[workspace.dependencies]
|
||||
revive-dt-common = { version = "0.1.0", path = "crates/common" }
|
||||
revive-dt-compiler = { version = "0.1.0", path = "crates/compiler" }
|
||||
revive-dt-config = { version = "0.1.0", path = "crates/config" }
|
||||
revive-dt-core = { version = "0.1.0", path = "crates/core" }
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
[package]
|
||||
name = "revive-dt-common"
|
||||
description = "A library containing common concepts that other crates in the workspace can rely on"
|
||||
version.workspace = true
|
||||
authors.workspace = true
|
||||
license.workspace = true
|
||||
edition.workspace = true
|
||||
repository.workspace = true
|
||||
rust-version.workspace = true
|
||||
|
||||
[dependencies]
|
||||
anyhow = { workspace = true }
|
||||
futures = { workspace = true }
|
||||
tracing = { workspace = true }
|
||||
once_cell = { workspace = true }
|
||||
tokio = { workspace = true }
|
||||
@@ -1,3 +0,0 @@
|
||||
mod blocking_executor;
|
||||
|
||||
pub use blocking_executor::*;
|
||||
@@ -1,3 +0,0 @@
|
||||
mod files_with_extension_iterator;
|
||||
|
||||
pub use files_with_extension_iterator::*;
|
||||
@@ -1,6 +0,0 @@
|
||||
//! This crate provides common concepts, functionality, types, macros, and more that other crates in
|
||||
//! the workspace can benefit from.
|
||||
|
||||
pub mod concepts;
|
||||
pub mod iterators;
|
||||
pub mod macros;
|
||||
@@ -1,3 +0,0 @@
|
||||
mod define_wrapper_type;
|
||||
|
||||
pub use define_wrapper_type::*;
|
||||
@@ -9,13 +9,11 @@ repository.workspace = true
|
||||
rust-version.workspace = true
|
||||
|
||||
[dependencies]
|
||||
anyhow = { workspace = true }
|
||||
revive-solc-json-interface = { workspace = true }
|
||||
revive-dt-config = { workspace = true }
|
||||
revive-dt-solc-binaries = { workspace = true }
|
||||
revive-common = { workspace = true }
|
||||
|
||||
alloy-primitives = { workspace = true }
|
||||
anyhow = { workspace = true }
|
||||
semver = { workspace = true }
|
||||
serde_json = { workspace = true }
|
||||
tracing = { workspace = true }
|
||||
|
||||
@@ -9,7 +9,6 @@ use std::{
|
||||
path::{Path, PathBuf},
|
||||
};
|
||||
|
||||
use alloy_primitives::Address;
|
||||
use revive_dt_config::Arguments;
|
||||
|
||||
use revive_common::EVMVersion;
|
||||
@@ -159,26 +158,6 @@ where
|
||||
self
|
||||
}
|
||||
|
||||
pub fn with_library(
|
||||
mut self,
|
||||
scope: impl AsRef<Path>,
|
||||
library_ident: impl AsRef<str>,
|
||||
library_address: Address,
|
||||
) -> Self {
|
||||
self.input
|
||||
.settings
|
||||
.libraries
|
||||
.get_or_insert_with(Default::default)
|
||||
.entry(scope.as_ref().display().to_string())
|
||||
.or_default()
|
||||
.insert(
|
||||
library_ident.as_ref().to_owned(),
|
||||
library_address.to_string(),
|
||||
);
|
||||
|
||||
self
|
||||
}
|
||||
|
||||
pub fn try_build(self, solc_path: PathBuf) -> anyhow::Result<CompilerOutput<T::Options>> {
|
||||
T::new(solc_path).build(CompilerInput {
|
||||
extra_options: self.extra_options,
|
||||
|
||||
@@ -10,10 +10,6 @@ use crate::{CompilerInput, CompilerOutput, SolidityCompiler};
|
||||
use revive_dt_config::Arguments;
|
||||
use revive_solc_json_interface::SolcStandardJsonOutput;
|
||||
|
||||
// TODO: I believe that we need to also pass the solc compiler to resolc so that resolc uses the
|
||||
// specified solc compiler. I believe that currently we completely ignore the specified solc binary
|
||||
// when invoking resolc which doesn't seem right if we're using solc as a compiler frontend.
|
||||
|
||||
/// A wrapper around the `resolc` binary, emitting PVM-compatible bytecode.
|
||||
#[derive(Debug)]
|
||||
pub struct Resolc {
|
||||
|
||||
@@ -76,7 +76,7 @@ pub struct Arguments {
|
||||
/// This argument controls which private keys the nodes should have access to and be added to
|
||||
/// its wallet signers. With a value of N, private keys (0, N] will be added to the signer set
|
||||
/// of the node.
|
||||
#[arg(long = "private-keys-count", default_value_t = 30)]
|
||||
#[arg(short, long = "private-keys-count", default_value_t = 30)]
|
||||
pub private_keys_to_add: usize,
|
||||
|
||||
/// The differential testing leader node implementation.
|
||||
|
||||
@@ -13,7 +13,6 @@ name = "retester"
|
||||
path = "src/main.rs"
|
||||
|
||||
[dependencies]
|
||||
revive-dt-common = { workspace = true }
|
||||
revive-dt-compiler = { workspace = true }
|
||||
revive-dt-config = { workspace = true }
|
||||
revive-dt-format = { workspace = true }
|
||||
|
||||
+164
-320
@@ -1,11 +1,11 @@
|
||||
//! The test driver handles the compilation and execution of the test cases.
|
||||
|
||||
use std::collections::HashMap;
|
||||
use std::fmt::Debug;
|
||||
use std::marker::PhantomData;
|
||||
|
||||
use alloy::json_abi::JsonAbi;
|
||||
use alloy::network::{Ethereum, TransactionBuilder};
|
||||
use alloy::primitives::Bytes;
|
||||
use alloy::rpc::types::TransactionReceipt;
|
||||
use alloy::rpc::types::trace::geth::{
|
||||
CallFrame, GethDebugBuiltInTracerType, GethDebugTracerType, GethDebugTracingOptions, GethTrace,
|
||||
@@ -20,21 +20,21 @@ use alloy::{
|
||||
};
|
||||
use anyhow::Context;
|
||||
use indexmap::IndexMap;
|
||||
use serde_json::Value;
|
||||
|
||||
use revive_dt_common::iterators::FilesWithExtensionIterator;
|
||||
use revive_dt_compiler::{Compiler, SolidityCompiler};
|
||||
use revive_dt_config::Arguments;
|
||||
use revive_dt_format::case::CaseIdx;
|
||||
use revive_dt_format::input::{Calldata, EtherValue, Expected, ExpectedOutput, Method};
|
||||
use revive_dt_format::metadata::{ContractInstance, ContractPathAndIdent};
|
||||
use revive_dt_format::input::{Calldata, Expected, ExpectedOutput, Method};
|
||||
use revive_dt_format::metadata::{ContractInstance, ContractPathAndIdentifier};
|
||||
use revive_dt_format::{input::Input, metadata::Metadata, mode::SolcMode};
|
||||
use revive_dt_node::Node;
|
||||
use revive_dt_node_interaction::EthereumNode;
|
||||
use revive_dt_report::reporter::{CompilationTask, Report, Span};
|
||||
use revive_solc_json_interface::SolcStandardJsonOutput;
|
||||
use serde_json::Value;
|
||||
use std::fmt::Debug;
|
||||
|
||||
use crate::Platform;
|
||||
use crate::common::*;
|
||||
|
||||
pub struct State<'a, T: Platform> {
|
||||
/// The configuration that the framework was started with.
|
||||
@@ -57,12 +57,6 @@ pub struct State<'a, T: Platform> {
|
||||
/// files.
|
||||
deployed_contracts: HashMap<CaseIdx, HashMap<ContractInstance, (Address, JsonAbi)>>,
|
||||
|
||||
/// This is a map of the deployed libraries.
|
||||
///
|
||||
/// This map is not per case, but rather, per metadata file. This means that we do not redeploy
|
||||
/// the libraries with each case.
|
||||
deployed_libraries: HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||
|
||||
phantom: PhantomData<T>,
|
||||
}
|
||||
|
||||
@@ -76,7 +70,6 @@ where
|
||||
span,
|
||||
contracts: Default::default(),
|
||||
deployed_contracts: Default::default(),
|
||||
deployed_libraries: Default::default(),
|
||||
phantom: Default::default(),
|
||||
}
|
||||
}
|
||||
@@ -103,28 +96,10 @@ where
|
||||
let compiler = Compiler::<T::Compiler>::new()
|
||||
.allow_path(metadata.directory()?)
|
||||
.solc_optimizer(mode.solc_optimize());
|
||||
let mut compiler = FilesWithExtensionIterator::new(metadata.directory()?)
|
||||
|
||||
let compiler = FilesWithExtensionIterator::new(metadata.directory()?)
|
||||
.with_allowed_extension("sol")
|
||||
.try_fold(compiler, |compiler, path| compiler.with_source(&path))?;
|
||||
for (library_instance, (library_address, _)) in self.deployed_libraries.iter() {
|
||||
let library_ident = &metadata
|
||||
.contracts
|
||||
.as_ref()
|
||||
.and_then(|contracts| contracts.get(library_instance))
|
||||
.expect("Impossible for library to not be found in contracts")
|
||||
.contract_ident;
|
||||
|
||||
// Note the following: we need to tell solc which files require the libraries to be
|
||||
// linked into them. We do not have access to this information and therefore we choose
|
||||
// an easier, yet more compute intensive route, of telling solc that all of the files
|
||||
// need to link the library and it will only perform the linking for the files that do
|
||||
// actually need the library.
|
||||
compiler = FilesWithExtensionIterator::new(metadata.directory()?)
|
||||
.with_allowed_extension("sol")
|
||||
.fold(compiler, |compiler, path| {
|
||||
compiler.with_library(&path, library_ident.as_str(), *library_address)
|
||||
});
|
||||
}
|
||||
|
||||
let mut task = CompilationTask {
|
||||
json_input: compiler.input(),
|
||||
@@ -166,47 +141,18 @@ where
|
||||
}
|
||||
}
|
||||
|
||||
pub fn build_and_publish_libraries(
|
||||
&mut self,
|
||||
metadata: &Metadata,
|
||||
mode: &SolcMode,
|
||||
node: &T::Blockchain,
|
||||
) -> anyhow::Result<()> {
|
||||
self.build_contracts(mode, metadata)?;
|
||||
|
||||
for library_instance in metadata
|
||||
.libraries
|
||||
.iter()
|
||||
.flatten()
|
||||
.flat_map(|(_, map)| map.values())
|
||||
{
|
||||
self.get_or_deploy_contract_instance(
|
||||
library_instance,
|
||||
metadata,
|
||||
None,
|
||||
Input::default_caller(),
|
||||
None,
|
||||
None,
|
||||
node,
|
||||
)?;
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn handle_input(
|
||||
&mut self,
|
||||
metadata: &Metadata,
|
||||
case_idx: CaseIdx,
|
||||
input: &Input,
|
||||
node: &T::Blockchain,
|
||||
mode: &SolcMode,
|
||||
) -> 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_input_expectations(case_idx, input, &execution_receipt, node, mode)?;
|
||||
self.handle_input_expectations(case_idx, input, &execution_receipt, node)?;
|
||||
self.handle_input_diff(case_idx, execution_receipt, node)
|
||||
}
|
||||
|
||||
@@ -227,7 +173,12 @@ where
|
||||
|
||||
let mut instances_we_must_deploy = IndexMap::<ContractInstance, bool>::new();
|
||||
for instance in input.find_all_contract_instances().into_iter() {
|
||||
if !self.deployed_contracts(case_idx).contains_key(&instance) {
|
||||
if !self
|
||||
.deployed_contracts
|
||||
.entry(case_idx)
|
||||
.or_default()
|
||||
.contains_key(&instance)
|
||||
{
|
||||
instances_we_must_deploy.entry(instance).or_insert(false);
|
||||
}
|
||||
}
|
||||
@@ -243,22 +194,124 @@ where
|
||||
|
||||
let mut receipts = HashMap::new();
|
||||
for (instance, deploy_with_constructor_arguments) in instances_we_must_deploy.into_iter() {
|
||||
let calldata = deploy_with_constructor_arguments.then_some(&input.calldata);
|
||||
let value = deploy_with_constructor_arguments
|
||||
.then_some(input.value)
|
||||
.flatten();
|
||||
// What we have at this moment is just a contract instance which is kind of like a variable
|
||||
// name for an actual underlying contract. So, we need to resolve this instance to the info
|
||||
// of the contract that it belongs to.
|
||||
let Some(ContractPathAndIdentifier {
|
||||
contract_source_path,
|
||||
contract_ident,
|
||||
}) = metadata.contract_sources()?.remove(&instance)
|
||||
else {
|
||||
tracing::error!("Contract source not found for instance");
|
||||
anyhow::bail!("Contract source not found for instance {:?}", instance)
|
||||
};
|
||||
|
||||
if let (_, _, Some(receipt)) = self.get_or_deploy_contract_instance(
|
||||
&instance,
|
||||
metadata,
|
||||
case_idx,
|
||||
input.caller,
|
||||
calldata,
|
||||
value,
|
||||
node,
|
||||
)? {
|
||||
receipts.insert(instance.clone(), receipt);
|
||||
let compiled_contract = self.contracts.iter().find_map(|output| {
|
||||
output
|
||||
.contracts
|
||||
.as_ref()?
|
||||
.get(&contract_source_path.display().to_string())
|
||||
.and_then(|source_file_contracts| {
|
||||
source_file_contracts.get(contract_ident.as_ref())
|
||||
})
|
||||
});
|
||||
let Some(code) = compiled_contract
|
||||
.and_then(|contract| contract.evm.as_ref().and_then(|evm| evm.bytecode.as_ref()))
|
||||
else {
|
||||
tracing::error!(
|
||||
contract_source_path = contract_source_path.display().to_string(),
|
||||
contract_ident = contract_ident.as_ref(),
|
||||
"Failed to find bytecode for contract"
|
||||
);
|
||||
anyhow::bail!("Failed to find bytecode for contract {:?}", instance)
|
||||
};
|
||||
|
||||
// TODO: When we want to do linking it would be best to do it at this stage here. We have
|
||||
// the context from the metadata files and therefore know what needs to be linked and in
|
||||
// what order it needs to happen.
|
||||
|
||||
let mut code = match alloy::hex::decode(&code.object) {
|
||||
Ok(code) => code,
|
||||
Err(error) => {
|
||||
tracing::error!(
|
||||
?error,
|
||||
contract_source_path = contract_source_path.display().to_string(),
|
||||
contract_ident = contract_ident.as_ref(),
|
||||
"Failed to hex-decode byte code - This could possibly mean that the bytecode requires linking"
|
||||
);
|
||||
anyhow::bail!("Failed to hex-decode the byte code {}", error)
|
||||
}
|
||||
};
|
||||
|
||||
if deploy_with_constructor_arguments {
|
||||
let encoded_input = input
|
||||
.encoded_input(self.deployed_contracts.entry(case_idx).or_default(), node)?;
|
||||
code.extend(encoded_input.to_vec());
|
||||
}
|
||||
|
||||
let tx = {
|
||||
let tx = TransactionRequest::default().from(input.caller);
|
||||
let tx = match input.value {
|
||||
Some(ref value) if deploy_with_constructor_arguments => {
|
||||
tx.value(value.into_inner())
|
||||
}
|
||||
_ => tx,
|
||||
};
|
||||
TransactionBuilder::<Ethereum>::with_deploy_code(tx, code)
|
||||
};
|
||||
|
||||
let receipt = match node.execute_transaction(tx) {
|
||||
Ok(receipt) => receipt,
|
||||
Err(error) => {
|
||||
tracing::error!(
|
||||
node = std::any::type_name::<T>(),
|
||||
?error,
|
||||
"Contract deployment transaction failed."
|
||||
);
|
||||
return Err(error);
|
||||
}
|
||||
};
|
||||
|
||||
let Some(address) = receipt.contract_address else {
|
||||
tracing::error!("Contract deployment transaction didn't return an address");
|
||||
anyhow::bail!("Contract deployment didn't return an address");
|
||||
};
|
||||
tracing::info!(
|
||||
instance_name = ?instance,
|
||||
instance_address = ?address,
|
||||
"Deployed contract"
|
||||
);
|
||||
|
||||
let Some(Value::String(metadata)) =
|
||||
compiled_contract.and_then(|contract| contract.metadata.as_ref())
|
||||
else {
|
||||
tracing::error!("Contract does not have a metadata field");
|
||||
anyhow::bail!("Contract does not have a metadata field");
|
||||
};
|
||||
|
||||
let Ok(metadata) = serde_json::from_str::<Value>(metadata) else {
|
||||
tracing::error!(%metadata, "Failed to parse solc metadata into a structured value");
|
||||
anyhow::bail!("Failed to parse solc metadata into a structured value {metadata}");
|
||||
};
|
||||
|
||||
let Some(abi) = metadata.get("output").and_then(|value| value.get("abi")) else {
|
||||
tracing::error!(%metadata, "Failed to access the .output.abi field of the solc metadata");
|
||||
anyhow::bail!(
|
||||
"Failed to access the .output.abi field of the solc metadata {metadata}"
|
||||
);
|
||||
};
|
||||
|
||||
let Ok(abi) = serde_json::from_value::<JsonAbi>(abi.clone()) else {
|
||||
tracing::error!(%metadata, "Failed to deserialize ABI into a structured format");
|
||||
anyhow::bail!("Failed to deserialize ABI into a structured format {metadata}");
|
||||
};
|
||||
|
||||
self.deployed_contracts
|
||||
.entry(case_idx)
|
||||
.or_default()
|
||||
.insert(instance.clone(), (address, abi));
|
||||
|
||||
receipts.insert(instance.clone(), receipt);
|
||||
}
|
||||
|
||||
Ok(receipts)
|
||||
@@ -279,7 +332,9 @@ where
|
||||
.remove(&input.instance)
|
||||
.context("Failed to find deployment receipt"),
|
||||
Method::Fallback | Method::FunctionName(_) => {
|
||||
let tx = match input.legacy_transaction(self.deployed_contracts(case_idx), node) {
|
||||
let tx = match input
|
||||
.legacy_transaction(self.deployed_contracts.entry(case_idx).or_default(), node)
|
||||
{
|
||||
Ok(tx) => {
|
||||
tracing::debug!("Legacy transaction data: {tx:#?}");
|
||||
tx
|
||||
@@ -313,7 +368,6 @@ where
|
||||
input: &Input,
|
||||
execution_receipt: &TransactionReceipt,
|
||||
node: &T::Blockchain,
|
||||
mode: &SolcMode,
|
||||
) -> anyhow::Result<()> {
|
||||
let span = tracing::info_span!("Handling input expectations");
|
||||
let _guard = span.enter();
|
||||
@@ -369,7 +423,6 @@ where
|
||||
node,
|
||||
expectation,
|
||||
&tracing_result,
|
||||
mode,
|
||||
)?;
|
||||
}
|
||||
|
||||
@@ -383,19 +436,15 @@ where
|
||||
node: &T::Blockchain,
|
||||
expectation: &ExpectedOutput,
|
||||
tracing_result: &CallFrame,
|
||||
mode: &SolcMode,
|
||||
) -> anyhow::Result<()> {
|
||||
if let Some(ref version_requirement) = expectation.compiler_version {
|
||||
let Some(compiler_version) = mode.last_patch_version(&self.config.solc) else {
|
||||
anyhow::bail!("unsupported solc version: {:?}", &mode.solc_version);
|
||||
};
|
||||
if !version_requirement.matches(&compiler_version) {
|
||||
return Ok(());
|
||||
}
|
||||
}
|
||||
// TODO: We want to respect the compiler version filter on the expected output but would
|
||||
// require some changes to the interfaces of the compiler and such. So, we add it later.
|
||||
// Additionally, what happens if the compiler filter doesn't match? Do we consider that the
|
||||
// transaction should succeed? Do we just ignore the expectation?
|
||||
|
||||
let deployed_contracts = self.deployed_contracts(case_idx);
|
||||
let chain_state_provider = node;
|
||||
let error_span =
|
||||
tracing::error_span!("Exception failed", ?tracing_result, ?execution_receipt,);
|
||||
let _guard = error_span.enter();
|
||||
|
||||
// Handling the receipt state assertion.
|
||||
let expected = !expectation.exception;
|
||||
@@ -409,16 +458,17 @@ where
|
||||
|
||||
// Handling the calldata assertion
|
||||
if let Some(ref expected_calldata) = expectation.return_data {
|
||||
let expected = expected_calldata;
|
||||
let actual = &tracing_result.output.as_ref().unwrap_or_default();
|
||||
if !expected.is_equivalent(actual, deployed_contracts, chain_state_provider)? {
|
||||
let expected = expected_calldata
|
||||
.calldata(self.deployed_contracts.entry(case_idx).or_default(), node)
|
||||
.map(Bytes::from)?;
|
||||
let actual = tracing_result.output.clone().unwrap_or_default();
|
||||
if !expected.starts_with(&actual) {
|
||||
tracing::error!(
|
||||
?execution_receipt,
|
||||
?expected,
|
||||
%expected,
|
||||
%actual,
|
||||
"Calldata assertion failed"
|
||||
);
|
||||
anyhow::bail!("Calldata assertion failed - Expected {expected:?} but got {actual}",);
|
||||
anyhow::bail!("Calldata assertion failed - Expected {expected} but got {actual}",);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -455,24 +505,17 @@ where
|
||||
}
|
||||
|
||||
// Handling the topics assertion.
|
||||
for (expected, actual) in expected_event
|
||||
for (expected_topic, actual_topic) in expected_event
|
||||
.topics
|
||||
.as_slice()
|
||||
.iter()
|
||||
.zip(actual_event.topics())
|
||||
{
|
||||
let expected = Calldata::new_compound([expected]);
|
||||
if !expected.is_equivalent(
|
||||
&actual.0,
|
||||
deployed_contracts,
|
||||
chain_state_provider,
|
||||
)? {
|
||||
tracing::error!(
|
||||
?execution_receipt,
|
||||
?expected,
|
||||
?actual,
|
||||
"Event topics assertion failed",
|
||||
);
|
||||
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!(?expected, ?actual, "Event topics assertion failed",);
|
||||
anyhow::bail!(
|
||||
"Event topics assertion failed - Expected {expected:?} but got {actual:?}",
|
||||
);
|
||||
@@ -480,15 +523,13 @@ where
|
||||
}
|
||||
|
||||
// Handling the values assertion.
|
||||
let expected = &expected_event.values;
|
||||
let expected = &expected_event
|
||||
.values
|
||||
.calldata(self.deployed_contracts.entry(case_idx).or_default(), node)
|
||||
.map(Bytes::from)?;
|
||||
let actual = &actual_event.data().data;
|
||||
if !expected.is_equivalent(&actual.0, deployed_contracts, chain_state_provider)? {
|
||||
tracing::error!(
|
||||
?execution_receipt,
|
||||
?expected,
|
||||
?actual,
|
||||
"Event value assertion failed",
|
||||
);
|
||||
if !expected.starts_with(actual) {
|
||||
tracing::error!(?expected, ?actual, "Event value assertion failed",);
|
||||
anyhow::bail!(
|
||||
"Event value assertion failed - Expected {expected:?} but got {actual:?}",
|
||||
);
|
||||
@@ -519,162 +560,6 @@ where
|
||||
|
||||
Ok((execution_receipt, trace, diff))
|
||||
}
|
||||
|
||||
fn deployed_contracts(
|
||||
&mut self,
|
||||
case_idx: impl Into<Option<CaseIdx>>,
|
||||
) -> &mut HashMap<ContractInstance, (Address, JsonAbi)> {
|
||||
match case_idx.into() {
|
||||
Some(case_idx) => self
|
||||
.deployed_contracts
|
||||
.entry(case_idx)
|
||||
.or_insert_with(|| self.deployed_libraries.clone()),
|
||||
None => &mut self.deployed_libraries,
|
||||
}
|
||||
}
|
||||
|
||||
/// Gets the information of a deployed contract or library from the state. If it's found to not
|
||||
/// be deployed then it will be deployed.
|
||||
///
|
||||
/// If a [`CaseIdx`] is not specified then this contact instance address will be stored in the
|
||||
/// cross-case deployed contracts address mapping.
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
pub fn get_or_deploy_contract_instance(
|
||||
&mut self,
|
||||
contract_instance: &ContractInstance,
|
||||
metadata: &Metadata,
|
||||
case_idx: impl Into<Option<CaseIdx>>,
|
||||
deployer: Address,
|
||||
calldata: Option<&Calldata>,
|
||||
value: Option<EtherValue>,
|
||||
node: &T::Blockchain,
|
||||
) -> anyhow::Result<(Address, JsonAbi, Option<TransactionReceipt>)> {
|
||||
let case_idx = case_idx.into();
|
||||
|
||||
if let Some((address, abi)) = self.deployed_libraries.get(contract_instance) {
|
||||
return Ok((*address, abi.clone(), None));
|
||||
}
|
||||
if let Some(case_idx) = case_idx {
|
||||
if let Some((address, abi)) = self
|
||||
.deployed_contracts
|
||||
.get(&case_idx)
|
||||
.and_then(|contracts| contracts.get(contract_instance))
|
||||
{
|
||||
return Ok((*address, abi.clone(), None));
|
||||
}
|
||||
}
|
||||
|
||||
let Some(ContractPathAndIdent {
|
||||
contract_source_path,
|
||||
contract_ident,
|
||||
}) = metadata.contract_sources()?.remove(contract_instance)
|
||||
else {
|
||||
tracing::error!("Contract source not found for instance");
|
||||
anyhow::bail!(
|
||||
"Contract source not found for instance {:?}",
|
||||
contract_instance
|
||||
)
|
||||
};
|
||||
|
||||
let compiled_contract = self.contracts.iter().rev().find_map(|output| {
|
||||
output
|
||||
.contracts
|
||||
.as_ref()?
|
||||
.get(&contract_source_path.display().to_string())
|
||||
.and_then(|source_file_contracts| {
|
||||
source_file_contracts.get(contract_ident.as_ref())
|
||||
})
|
||||
});
|
||||
let Some(code) = compiled_contract
|
||||
.and_then(|contract| contract.evm.as_ref().and_then(|evm| evm.bytecode.as_ref()))
|
||||
else {
|
||||
tracing::error!(
|
||||
contract_source_path = contract_source_path.display().to_string(),
|
||||
contract_ident = contract_ident.as_ref(),
|
||||
"Failed to find bytecode for contract"
|
||||
);
|
||||
anyhow::bail!(
|
||||
"Failed to find bytecode for contract {:?}",
|
||||
contract_instance
|
||||
)
|
||||
};
|
||||
|
||||
let mut code = match alloy::hex::decode(&code.object) {
|
||||
Ok(code) => code,
|
||||
Err(error) => {
|
||||
tracing::error!(
|
||||
?error,
|
||||
contract_source_path = contract_source_path.display().to_string(),
|
||||
contract_ident = contract_ident.as_ref(),
|
||||
"Failed to hex-decode byte code - This could possibly mean that the bytecode requires linking"
|
||||
);
|
||||
anyhow::bail!("Failed to hex-decode the byte code {}", error)
|
||||
}
|
||||
};
|
||||
|
||||
let Some(Value::String(metadata)) =
|
||||
compiled_contract.and_then(|contract| contract.metadata.as_ref())
|
||||
else {
|
||||
tracing::error!("Contract does not have a metadata field");
|
||||
anyhow::bail!("Contract does not have a metadata field");
|
||||
};
|
||||
|
||||
let Ok(metadata) = serde_json::from_str::<Value>(metadata) else {
|
||||
tracing::error!(%metadata, "Failed to parse solc metadata into a structured value");
|
||||
anyhow::bail!("Failed to parse solc metadata into a structured value {metadata}");
|
||||
};
|
||||
|
||||
let Some(abi) = metadata.get("output").and_then(|value| value.get("abi")) else {
|
||||
tracing::error!(%metadata, "Failed to access the .output.abi field of the solc metadata");
|
||||
anyhow::bail!("Failed to access the .output.abi field of the solc metadata {metadata}");
|
||||
};
|
||||
|
||||
let Ok(abi) = serde_json::from_value::<JsonAbi>(abi.clone()) else {
|
||||
tracing::error!(%metadata, "Failed to deserialize ABI into a structured format");
|
||||
anyhow::bail!("Failed to deserialize ABI into a structured format {metadata}");
|
||||
};
|
||||
|
||||
if let Some(calldata) = calldata {
|
||||
let calldata = calldata.calldata(self.deployed_contracts(case_idx), node)?;
|
||||
code.extend(calldata);
|
||||
}
|
||||
|
||||
let tx = {
|
||||
let tx = TransactionRequest::default().from(deployer);
|
||||
let tx = match value {
|
||||
Some(ref value) => tx.value(value.into_inner()),
|
||||
_ => tx,
|
||||
};
|
||||
TransactionBuilder::<Ethereum>::with_deploy_code(tx, code)
|
||||
};
|
||||
|
||||
let receipt = match node.execute_transaction(tx) {
|
||||
Ok(receipt) => receipt,
|
||||
Err(error) => {
|
||||
tracing::error!(
|
||||
node = std::any::type_name::<T>(),
|
||||
?error,
|
||||
"Contract deployment transaction failed."
|
||||
);
|
||||
return Err(error);
|
||||
}
|
||||
};
|
||||
|
||||
let Some(address) = receipt.contract_address else {
|
||||
tracing::error!("Contract deployment transaction didn't return an address");
|
||||
anyhow::bail!("Contract deployment didn't return an address");
|
||||
};
|
||||
tracing::info!(
|
||||
instance_name = ?contract_instance,
|
||||
instance_address = ?address,
|
||||
"Deployed contract"
|
||||
);
|
||||
|
||||
self.deployed_contracts(case_idx)
|
||||
.insert(contract_instance.clone(), (address, abi.clone()));
|
||||
|
||||
Ok((address, abi, Some(receipt)))
|
||||
}
|
||||
}
|
||||
|
||||
pub struct Driver<'a, Leader: Platform, Follower: Platform> {
|
||||
@@ -781,42 +666,6 @@ where
|
||||
let mut leader_state = State::<L>::new(self.config, span);
|
||||
let mut follower_state = State::<F>::new(self.config, span);
|
||||
|
||||
// Note: we are currently forced to do two compilation passes due to linking. In the
|
||||
// first compilation pass we compile the libraries and publish them to the chain. In the
|
||||
// second compilation pass we compile the contracts with the library addresses so that
|
||||
// they're linked at compile-time.
|
||||
let build_result = tracing::info_span!("Building and publishing libraries")
|
||||
.in_scope(|| {
|
||||
match leader_state.build_and_publish_libraries(self.metadata, &mode, self.leader_node) {
|
||||
Ok(_) => {
|
||||
tracing::debug!(target = ?Target::Leader, "Library building succeeded");
|
||||
execution_result.add_successful_build(Target::Leader, mode.clone());
|
||||
},
|
||||
Err(error) => {
|
||||
tracing::error!(target = ?Target::Leader, ?error, "Library building failed");
|
||||
execution_result.add_failed_build(Target::Leader, mode.clone(), error);
|
||||
return Err(());
|
||||
}
|
||||
}
|
||||
match follower_state.build_and_publish_libraries(self.metadata, &mode, self.follower_node) {
|
||||
Ok(_) => {
|
||||
tracing::debug!(target = ?Target::Follower, "Library building succeeded");
|
||||
execution_result.add_successful_build(Target::Follower, mode.clone());
|
||||
},
|
||||
Err(error) => {
|
||||
tracing::error!(target = ?Target::Follower, ?error, "Library building failed");
|
||||
execution_result.add_failed_build(Target::Follower, mode.clone(), error);
|
||||
return Err(());
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
});
|
||||
if build_result.is_err() {
|
||||
// Note: We skip to the next solc mode as there's nothing that we can do at this
|
||||
// point, the building has failed. We do NOT bail out of the execution as a whole.
|
||||
continue;
|
||||
}
|
||||
|
||||
// We build the contracts. If building the contracts for the metadata file fails then we
|
||||
// have no other option but to keep note of this error and move on to the next solc mode
|
||||
// and NOT just bail out of the execution as a whole.
|
||||
@@ -853,6 +702,7 @@ 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.
|
||||
|
||||
'case_loop: for (case_idx, case) in self.metadata.cases.iter().enumerate() {
|
||||
let tracing_span = tracing::info_span!(
|
||||
"Handling case",
|
||||
@@ -861,7 +711,7 @@ where
|
||||
);
|
||||
let _guard = tracing_span.enter();
|
||||
|
||||
let case_idx = CaseIdx::new(case_idx);
|
||||
let case_idx = CaseIdx::new_from(case_idx);
|
||||
|
||||
// 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).
|
||||
@@ -873,13 +723,8 @@ 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,
|
||||
&mode,
|
||||
) {
|
||||
.handle_input(self.metadata, case_idx, &input, self.leader_node)
|
||||
{
|
||||
Ok(result) => result,
|
||||
Err(error) => {
|
||||
tracing::error!(
|
||||
@@ -908,7 +753,6 @@ where
|
||||
case_idx,
|
||||
&input,
|
||||
self.follower_node,
|
||||
&mode,
|
||||
) {
|
||||
Ok(result) => result,
|
||||
Err(error) => {
|
||||
|
||||
@@ -5,17 +5,17 @@
|
||||
|
||||
use revive_dt_compiler::{SolidityCompiler, revive_resolc, solc};
|
||||
use revive_dt_config::TestingPlatform;
|
||||
use revive_dt_format::traits::ResolverApi;
|
||||
use revive_dt_node::{Node, geth, kitchensink::KitchensinkNode};
|
||||
use revive_dt_node_interaction::EthereumNode;
|
||||
|
||||
pub mod common;
|
||||
pub mod driver;
|
||||
|
||||
/// One platform can be tested differentially against another.
|
||||
///
|
||||
/// For this we need a blockchain node implementation and a compiler.
|
||||
pub trait Platform {
|
||||
type Blockchain: EthereumNode + Node + ResolverApi;
|
||||
type Blockchain: EthereumNode + Node;
|
||||
type Compiler: SolidityCompiler;
|
||||
|
||||
/// Returns the matching [TestingPlatform] of the [revive_dt_config::Arguments].
|
||||
|
||||
@@ -9,7 +9,7 @@ repository.workspace = true
|
||||
rust-version.workspace = true
|
||||
|
||||
[dependencies]
|
||||
revive-dt-common = { workspace = true }
|
||||
revive-dt-node-interaction = { workspace = true }
|
||||
|
||||
alloy = { workspace = true }
|
||||
alloy-primitives = { workspace = true }
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
use serde::Deserialize;
|
||||
|
||||
use revive_dt_common::macros::define_wrapper_type;
|
||||
|
||||
use crate::{
|
||||
define_wrapper_type,
|
||||
input::{Expected, Input},
|
||||
mode::Mode,
|
||||
};
|
||||
@@ -46,5 +45,5 @@ impl Case {
|
||||
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)]
|
||||
pub struct CaseIdx(usize);
|
||||
CaseIdx(usize);
|
||||
);
|
||||
|
||||
+251
-546
@@ -8,21 +8,19 @@ use alloy::{
|
||||
rpc::types::TransactionRequest,
|
||||
};
|
||||
use alloy_primitives::{FixedBytes, utils::parse_units};
|
||||
use anyhow::Context;
|
||||
use semver::VersionReq;
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use revive_dt_common::macros::define_wrapper_type;
|
||||
use revive_dt_node_interaction::EthereumNode;
|
||||
|
||||
use crate::metadata::ContractInstance;
|
||||
use crate::traits::ResolverApi;
|
||||
use crate::{define_wrapper_type, metadata::ContractInstance};
|
||||
|
||||
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
|
||||
pub struct Input {
|
||||
#[serde(default = "Input::default_caller")]
|
||||
#[serde(default = "default_caller")]
|
||||
pub caller: Address,
|
||||
pub comment: Option<String>,
|
||||
#[serde(default = "Input::default_instance")]
|
||||
#[serde(default = "default_instance")]
|
||||
pub instance: ContractInstance,
|
||||
pub method: Method,
|
||||
#[serde(default)]
|
||||
@@ -56,86 +54,11 @@ pub struct Event {
|
||||
pub values: Calldata,
|
||||
}
|
||||
|
||||
/// A type definition for the calldata supported by the testing framework.
|
||||
///
|
||||
/// We choose to document all of the types used in [`Calldata`] in this one doc comment to elaborate
|
||||
/// on why they exist and consolidate all of the documentation for calldata in a single place where
|
||||
/// it can be viewed and understood.
|
||||
///
|
||||
/// The [`Single`] variant of this enum is quite simple and straightforward: it's a hex-encoded byte
|
||||
/// array of the calldata.
|
||||
///
|
||||
/// The [`Compound`] type is more intricate and allows for capabilities such as resolution and some
|
||||
/// simple arithmetic operations. It houses a vector of [`CalldataItem`]s which is just a wrapper
|
||||
/// around an owned string.
|
||||
///
|
||||
/// A [`CalldataItem`] could be a simple hex string of a single calldata argument, but it could also
|
||||
/// be something that requires resolution such as `MyContract.address` which is a variable that is
|
||||
/// understood by the resolution logic to mean "Lookup the address of this particular contract
|
||||
/// instance".
|
||||
///
|
||||
/// In addition to the above, the format supports some simple arithmetic operations like add, sub,
|
||||
/// divide, multiply, bitwise AND, bitwise OR, and bitwise XOR. Our parser understands the [reverse
|
||||
/// polish notation] simply because it's easy to write a calculator for that notation and since we
|
||||
/// do not have plans to use arithmetic too often in tests. In reverse polish notation a typical
|
||||
/// `2 + 4` would be written as `2 4 +` which makes this notation very simple to implement through
|
||||
/// a stack.
|
||||
///
|
||||
/// Combining the above, a single [`CalldataItem`] could employ both resolution and arithmetic at
|
||||
/// the same time. For example, a [`CalldataItem`] of `$BLOCK_NUMBER $BLOCK_NUMBER +` means that
|
||||
/// the block number should be retrieved and then it should be added to itself.
|
||||
///
|
||||
/// Internally, we split the [`CalldataItem`] by spaces. Therefore, `$BLOCK_NUMBER $BLOCK_NUMBER+`
|
||||
/// is invalid but `$BLOCK_NUMBER $BLOCK_NUMBER +` is valid and can be understood by the parser and
|
||||
/// calculator. After the split is done, each token is parsed into a [`CalldataToken<&str>`] forming
|
||||
/// an [`Iterator`] over [`CalldataToken<&str>`]. A [`CalldataToken<&str>`] can then be resolved
|
||||
/// into a [`CalldataToken<U256>`] through the resolution logic. Finally, after resolution is done,
|
||||
/// this iterator of [`CalldataToken<U256>`] is collapsed into the final result by applying the
|
||||
/// arithmetic operations requested.
|
||||
///
|
||||
/// For example, supplying a [`Compound`] calldata of `0xdeadbeef` produces an iterator of a single
|
||||
/// [`CalldataToken<&str>`] items of the value [`CalldataToken::Item`] of the string value 12 which
|
||||
/// we can then resolve into the appropriate [`U256`] value and convert into calldata.
|
||||
///
|
||||
/// In summary, the various types used in [`Calldata`] represent the following:
|
||||
/// - [`CalldataItem`]: A calldata string from the metadata files.
|
||||
/// - [`CalldataToken<&str>`]: Typically used in an iterator of items from the space splitted
|
||||
/// [`CalldataItem`] and represents a token that has not yet been resolved into its value.
|
||||
/// - [`CalldataToken<U256>`]: Represents a token that's been resolved from being a string and into
|
||||
/// the word-size calldata argument on which we can perform arithmetic.
|
||||
///
|
||||
/// [`Single`]: Calldata::Single
|
||||
/// [`Compound`]: Calldata::Compound
|
||||
/// [reverse polish notation]: https://en.wikipedia.org/wiki/Reverse_Polish_notation
|
||||
#[derive(Clone, Debug, Deserialize, Eq, PartialEq)]
|
||||
#[serde(untagged)]
|
||||
pub enum Calldata {
|
||||
Single(Bytes),
|
||||
Compound(Vec<CalldataItem>),
|
||||
}
|
||||
|
||||
define_wrapper_type! {
|
||||
/// This represents an item in the [`Calldata::Compound`] variant.
|
||||
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||
#[serde(transparent)]
|
||||
pub struct CalldataItem(String);
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||
enum CalldataToken<T> {
|
||||
Item(T),
|
||||
Operation(Operation),
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||
enum Operation {
|
||||
Addition,
|
||||
Subtraction,
|
||||
Multiplication,
|
||||
Division,
|
||||
BitwiseAnd,
|
||||
BitwiseOr,
|
||||
BitwiseXor,
|
||||
Single(String),
|
||||
Compound(Vec<String>),
|
||||
}
|
||||
|
||||
/// Specify how the contract is called.
|
||||
@@ -161,20 +84,119 @@ pub enum Method {
|
||||
|
||||
define_wrapper_type!(
|
||||
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||
pub struct EtherValue(U256);
|
||||
EtherValue(U256);
|
||||
);
|
||||
|
||||
impl Serialize for EtherValue {
|
||||
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
||||
where
|
||||
S: serde::Serializer,
|
||||
{
|
||||
format!("{} wei", self.0).serialize(serializer)
|
||||
}
|
||||
}
|
||||
|
||||
impl<'de> Deserialize<'de> for EtherValue {
|
||||
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
||||
where
|
||||
D: serde::Deserializer<'de>,
|
||||
{
|
||||
let string = String::deserialize(deserializer)?;
|
||||
let mut splitted = string.split(' ');
|
||||
let (Some(value), Some(unit)) = (splitted.next(), splitted.next()) else {
|
||||
return Err(serde::de::Error::custom("Failed to parse the value"));
|
||||
};
|
||||
let parsed = parse_units(value, unit.replace("eth", "ether"))
|
||||
.map_err(|_| serde::de::Error::custom("Failed to parse units"))?
|
||||
.into();
|
||||
Ok(Self(parsed))
|
||||
}
|
||||
}
|
||||
|
||||
impl ExpectedOutput {
|
||||
pub fn new() -> Self {
|
||||
Default::default()
|
||||
}
|
||||
|
||||
pub fn with_success(mut self) -> Self {
|
||||
self.exception = false;
|
||||
self
|
||||
}
|
||||
|
||||
pub fn with_failure(mut self) -> Self {
|
||||
self.exception = true;
|
||||
self
|
||||
}
|
||||
|
||||
pub fn with_calldata(mut self, calldata: Calldata) -> Self {
|
||||
self.return_data = Some(calldata);
|
||||
self
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for Calldata {
|
||||
fn default() -> Self {
|
||||
Self::Compound(Default::default())
|
||||
}
|
||||
}
|
||||
|
||||
impl Calldata {
|
||||
pub fn find_all_contract_instances(&self, vec: &mut Vec<ContractInstance>) {
|
||||
if let Calldata::Compound(compound) = self {
|
||||
for item in compound {
|
||||
if let Some(instance) = item.strip_suffix(".address") {
|
||||
vec.push(ContractInstance::new_from(instance))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub fn calldata(
|
||||
&self,
|
||||
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||
chain_state_provider: &impl EthereumNode,
|
||||
) -> anyhow::Result<Vec<u8>> {
|
||||
let mut buffer = Vec::<u8>::with_capacity(self.size_requirement());
|
||||
self.calldata_into_slice(&mut buffer, deployed_contracts, chain_state_provider)?;
|
||||
Ok(buffer)
|
||||
}
|
||||
|
||||
pub fn calldata_into_slice(
|
||||
&self,
|
||||
buffer: &mut Vec<u8>,
|
||||
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||
chain_state_provider: &impl EthereumNode,
|
||||
) -> anyhow::Result<()> {
|
||||
match self {
|
||||
Calldata::Single(string) => {
|
||||
alloy::hex::decode_to_slice(string, buffer)?;
|
||||
}
|
||||
Calldata::Compound(items) => {
|
||||
for (arg_idx, arg) in items.iter().enumerate() {
|
||||
match resolve_argument(arg, deployed_contracts, chain_state_provider) {
|
||||
Ok(resolved) => {
|
||||
buffer.extend(resolved.to_be_bytes::<32>());
|
||||
}
|
||||
Err(error) => {
|
||||
tracing::error!(arg, arg_idx, ?error, "Failed to resolve argument");
|
||||
return Err(error);
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
};
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn size_requirement(&self) -> usize {
|
||||
match self {
|
||||
Calldata::Single(single) => (single.len() - 2) / 2,
|
||||
Calldata::Compound(items) => items.len() * 32,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Input {
|
||||
pub const fn default_caller() -> Address {
|
||||
Address(FixedBytes(alloy::hex!(
|
||||
"0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1"
|
||||
)))
|
||||
}
|
||||
|
||||
fn default_instance() -> ContractInstance {
|
||||
ContractInstance::new("Test")
|
||||
}
|
||||
|
||||
fn instance_to_address(
|
||||
&self,
|
||||
instance: &ContractInstance,
|
||||
@@ -189,7 +211,7 @@ impl Input {
|
||||
pub fn encoded_input(
|
||||
&self,
|
||||
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||
chain_state_provider: &impl ResolverApi,
|
||||
chain_state_provider: &impl EthereumNode,
|
||||
) -> anyhow::Result<Bytes> {
|
||||
match self.method {
|
||||
Method::Deployer | Method::Fallback => {
|
||||
@@ -256,7 +278,7 @@ impl Input {
|
||||
pub fn legacy_transaction(
|
||||
&self,
|
||||
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||
chain_state_provider: &impl ResolverApi,
|
||||
chain_state_provider: &impl EthereumNode,
|
||||
) -> anyhow::Result<TransactionRequest> {
|
||||
let input_data = self.encoded_input(deployed_contracts, chain_state_provider)?;
|
||||
let transaction_request = TransactionRequest::default().from(self.caller).value(
|
||||
@@ -282,337 +304,84 @@ impl Input {
|
||||
}
|
||||
}
|
||||
|
||||
impl ExpectedOutput {
|
||||
pub fn new() -> Self {
|
||||
Default::default()
|
||||
}
|
||||
|
||||
pub fn with_success(mut self) -> Self {
|
||||
self.exception = false;
|
||||
self
|
||||
}
|
||||
|
||||
pub fn with_failure(mut self) -> Self {
|
||||
self.exception = true;
|
||||
self
|
||||
}
|
||||
|
||||
pub fn with_calldata(mut self, calldata: Calldata) -> Self {
|
||||
self.return_data = Some(calldata);
|
||||
self
|
||||
}
|
||||
fn default_instance() -> ContractInstance {
|
||||
ContractInstance::new_from("Test")
|
||||
}
|
||||
|
||||
impl Default for Calldata {
|
||||
fn default() -> Self {
|
||||
Self::Compound(Default::default())
|
||||
}
|
||||
pub const fn default_caller() -> Address {
|
||||
Address(FixedBytes(alloy::hex!(
|
||||
"90F8bf6A479f320ead074411a4B0e7944Ea8c9C1"
|
||||
)))
|
||||
}
|
||||
|
||||
impl Calldata {
|
||||
pub fn new_single(item: impl Into<Bytes>) -> Self {
|
||||
Self::Single(item.into())
|
||||
}
|
||||
|
||||
pub fn new_compound(items: impl IntoIterator<Item = impl AsRef<str>>) -> Self {
|
||||
Self::Compound(
|
||||
items
|
||||
.into_iter()
|
||||
.map(|item| item.as_ref().to_owned())
|
||||
.map(CalldataItem::new)
|
||||
.collect(),
|
||||
)
|
||||
}
|
||||
|
||||
pub fn find_all_contract_instances(&self, vec: &mut Vec<ContractInstance>) {
|
||||
if let Calldata::Compound(compound) = self {
|
||||
for item in compound {
|
||||
if let Some(instance) =
|
||||
item.strip_suffix(CalldataToken::<()>::ADDRESS_VARIABLE_SUFFIX)
|
||||
{
|
||||
vec.push(ContractInstance::new(instance))
|
||||
}
|
||||
}
|
||||
/// This function takes in the string calldata argument provided in the JSON input and resolves it
|
||||
/// into a [`U256`] which is later used to construct the calldata.
|
||||
///
|
||||
/// # Note
|
||||
///
|
||||
/// 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(
|
||||
value: &str,
|
||||
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||
chain_state_provider: &impl EthereumNode,
|
||||
) -> anyhow::Result<U256> {
|
||||
if let Some(instance) = value.strip_suffix(".address") {
|
||||
Ok(U256::from_be_slice(
|
||||
deployed_contracts
|
||||
.get(&ContractInstance::new_from(instance))
|
||||
.map(|(a, _)| *a)
|
||||
.ok_or_else(|| anyhow::anyhow!("Instance `{}` not found", instance))?
|
||||
.as_ref(),
|
||||
))
|
||||
} else if let Some(value) = value.strip_prefix('-') {
|
||||
let value = U256::from_str_radix(value, 10)
|
||||
.map_err(|error| anyhow::anyhow!("Invalid decimal literal after `-`: {}", error))?;
|
||||
if value > U256::ONE << 255u8 {
|
||||
anyhow::bail!("Decimal literal after `-` is too big");
|
||||
}
|
||||
}
|
||||
let value = value
|
||||
.checked_sub(U256::ONE)
|
||||
.ok_or_else(|| anyhow::anyhow!("`-0` is invalid literal"))?;
|
||||
Ok(U256::MAX.checked_sub(value).expect("Always valid"))
|
||||
} else if let Some(value) = value.strip_prefix("0x") {
|
||||
Ok(U256::from_str_radix(value, 16)
|
||||
.map_err(|error| anyhow::anyhow!("Invalid hexadecimal literal: {}", error))?)
|
||||
} else if value == "$CHAIN_ID" {
|
||||
let chain_id = chain_state_provider.chain_id()?;
|
||||
Ok(U256::from(chain_id))
|
||||
} else if value == "$GAS_LIMIT" {
|
||||
let gas_limit = chain_state_provider.block_gas_limit(BlockNumberOrTag::Latest)?;
|
||||
Ok(U256::from(gas_limit))
|
||||
} else if value == "$COINBASE" {
|
||||
let coinbase = chain_state_provider.block_coinbase(BlockNumberOrTag::Latest)?;
|
||||
Ok(U256::from_be_slice(coinbase.as_ref()))
|
||||
} else if value == "$DIFFICULTY" {
|
||||
let block_difficulty = chain_state_provider.block_difficulty(BlockNumberOrTag::Latest)?;
|
||||
Ok(block_difficulty)
|
||||
} else if value.starts_with("$BLOCK_HASH") {
|
||||
let offset: u64 = value
|
||||
.split(':')
|
||||
.next_back()
|
||||
.and_then(|value| value.parse().ok())
|
||||
.unwrap_or_default();
|
||||
|
||||
pub fn calldata(
|
||||
&self,
|
||||
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||
chain_state_provider: &impl ResolverApi,
|
||||
) -> anyhow::Result<Vec<u8>> {
|
||||
let mut buffer = Vec::<u8>::with_capacity(self.size_requirement());
|
||||
self.calldata_into_slice(&mut buffer, deployed_contracts, chain_state_provider)?;
|
||||
Ok(buffer)
|
||||
}
|
||||
let current_block_number = chain_state_provider.last_block_number()?;
|
||||
let desired_block_number = current_block_number - offset;
|
||||
|
||||
pub fn calldata_into_slice(
|
||||
&self,
|
||||
buffer: &mut Vec<u8>,
|
||||
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||
chain_state_provider: &impl ResolverApi,
|
||||
) -> anyhow::Result<()> {
|
||||
match self {
|
||||
Calldata::Single(bytes) => {
|
||||
buffer.extend_from_slice(bytes);
|
||||
}
|
||||
Calldata::Compound(items) => {
|
||||
for (arg_idx, arg) in items.iter().enumerate() {
|
||||
match arg.resolve(deployed_contracts, chain_state_provider) {
|
||||
Ok(resolved) => {
|
||||
buffer.extend(resolved.to_be_bytes::<32>());
|
||||
}
|
||||
Err(error) => {
|
||||
tracing::error!(?arg, arg_idx, ?error, "Failed to resolve argument");
|
||||
return Err(error);
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
};
|
||||
Ok(())
|
||||
}
|
||||
let block_hash = chain_state_provider.block_hash(desired_block_number.into())?;
|
||||
|
||||
pub fn size_requirement(&self) -> usize {
|
||||
match self {
|
||||
Calldata::Single(single) => single.len(),
|
||||
Calldata::Compound(items) => items.len() * 32,
|
||||
}
|
||||
}
|
||||
|
||||
/// Checks if this [`Calldata`] is equivalent to the passed calldata bytes.
|
||||
pub fn is_equivalent(
|
||||
&self,
|
||||
other: &[u8],
|
||||
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||
chain_state_provider: &impl ResolverApi,
|
||||
) -> anyhow::Result<bool> {
|
||||
match self {
|
||||
Calldata::Single(calldata) => Ok(calldata == other),
|
||||
Calldata::Compound(items) => {
|
||||
// Chunking the "other" calldata into 32 byte chunks since each
|
||||
// one of the items in the compound calldata represents 32 bytes
|
||||
for (this, other) in items.iter().zip(other.chunks(32)) {
|
||||
// The matterlabs format supports wildcards and therefore we
|
||||
// also need to support them.
|
||||
if this.as_ref() == "*" {
|
||||
continue;
|
||||
}
|
||||
|
||||
let other = if other.len() < 32 {
|
||||
let mut vec = other.to_vec();
|
||||
vec.resize(32, 0);
|
||||
std::borrow::Cow::Owned(vec)
|
||||
} else {
|
||||
std::borrow::Cow::Borrowed(other)
|
||||
};
|
||||
|
||||
let this = this.resolve(deployed_contracts, chain_state_provider)?;
|
||||
let other = U256::from_be_slice(&other);
|
||||
if this != other {
|
||||
return Ok(false);
|
||||
}
|
||||
}
|
||||
Ok(true)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl CalldataItem {
|
||||
fn resolve(
|
||||
&self,
|
||||
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||
chain_state_provider: &impl ResolverApi,
|
||||
) -> anyhow::Result<U256> {
|
||||
let mut stack = Vec::<CalldataToken<U256>>::new();
|
||||
|
||||
for token in self
|
||||
.calldata_tokens()
|
||||
.map(|token| token.resolve(deployed_contracts, chain_state_provider))
|
||||
{
|
||||
let token = token?;
|
||||
let new_token = match token {
|
||||
CalldataToken::Item(_) => token,
|
||||
CalldataToken::Operation(operation) => {
|
||||
let right_operand = stack
|
||||
.pop()
|
||||
.and_then(CalldataToken::into_item)
|
||||
.context("Invalid calldata arithmetic operation")?;
|
||||
let left_operand = stack
|
||||
.pop()
|
||||
.and_then(CalldataToken::into_item)
|
||||
.context("Invalid calldata arithmetic operation")?;
|
||||
|
||||
let result = match operation {
|
||||
Operation::Addition => left_operand.checked_add(right_operand),
|
||||
Operation::Subtraction => left_operand.checked_sub(right_operand),
|
||||
Operation::Multiplication => left_operand.checked_mul(right_operand),
|
||||
Operation::Division => left_operand.checked_div(right_operand),
|
||||
Operation::BitwiseAnd => Some(left_operand & right_operand),
|
||||
Operation::BitwiseOr => Some(left_operand | right_operand),
|
||||
Operation::BitwiseXor => Some(left_operand ^ right_operand),
|
||||
}
|
||||
.context("Invalid calldata arithmetic operation")?;
|
||||
|
||||
CalldataToken::Item(result)
|
||||
}
|
||||
};
|
||||
stack.push(new_token)
|
||||
}
|
||||
|
||||
match stack.as_slice() {
|
||||
// Empty stack means that we got an empty compound calldata which we resolve to zero.
|
||||
[] => Ok(U256::ZERO),
|
||||
[CalldataToken::Item(item)] => Ok(*item),
|
||||
_ => Err(anyhow::anyhow!("Invalid calldata arithmetic operation")),
|
||||
}
|
||||
}
|
||||
|
||||
fn calldata_tokens<'a>(&'a self) -> impl Iterator<Item = CalldataToken<&'a str>> + 'a {
|
||||
self.0.split(' ').map(|item| match item {
|
||||
"+" => CalldataToken::Operation(Operation::Addition),
|
||||
"-" => CalldataToken::Operation(Operation::Subtraction),
|
||||
"/" => CalldataToken::Operation(Operation::Division),
|
||||
"*" => CalldataToken::Operation(Operation::Multiplication),
|
||||
"&" => CalldataToken::Operation(Operation::BitwiseAnd),
|
||||
"|" => CalldataToken::Operation(Operation::BitwiseOr),
|
||||
"^" => CalldataToken::Operation(Operation::BitwiseXor),
|
||||
_ => CalldataToken::Item(item),
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> CalldataToken<T> {
|
||||
const ADDRESS_VARIABLE_SUFFIX: &str = ".address";
|
||||
const NEGATIVE_VALUE_PREFIX: char = '-';
|
||||
const HEX_LITERAL_PREFIX: &str = "0x";
|
||||
const CHAIN_VARIABLE: &str = "$CHAIN_ID";
|
||||
const GAS_LIMIT_VARIABLE: &str = "$GAS_LIMIT";
|
||||
const COINBASE_VARIABLE: &str = "$COINBASE";
|
||||
const DIFFICULTY_VARIABLE: &str = "$DIFFICULTY";
|
||||
const BLOCK_HASH_VARIABLE_PREFIX: &str = "$BLOCK_HASH";
|
||||
const BLOCK_NUMBER_VARIABLE: &str = "$BLOCK_NUMBER";
|
||||
const BLOCK_TIMESTAMP_VARIABLE: &str = "$BLOCK_TIMESTAMP";
|
||||
|
||||
fn into_item(self) -> Option<T> {
|
||||
match self {
|
||||
CalldataToken::Item(item) => Some(item),
|
||||
CalldataToken::Operation(_) => None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: AsRef<str>> CalldataToken<T> {
|
||||
/// This function takes in the string calldata argument provided in the JSON input and resolves
|
||||
/// it into a [`U256`] which is later used to construct the calldata.
|
||||
///
|
||||
/// # Note
|
||||
///
|
||||
/// 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(
|
||||
self,
|
||||
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||
chain_state_provider: &impl ResolverApi,
|
||||
) -> anyhow::Result<CalldataToken<U256>> {
|
||||
match self {
|
||||
Self::Item(item) => {
|
||||
let item = item.as_ref();
|
||||
let value = if let Some(instance) = item.strip_suffix(Self::ADDRESS_VARIABLE_SUFFIX)
|
||||
{
|
||||
Ok(U256::from_be_slice(
|
||||
deployed_contracts
|
||||
.get(&ContractInstance::new(instance))
|
||||
.map(|(a, _)| *a)
|
||||
.ok_or_else(|| anyhow::anyhow!("Instance `{}` not found", instance))?
|
||||
.as_ref(),
|
||||
))
|
||||
} else if let Some(value) = item.strip_prefix(Self::NEGATIVE_VALUE_PREFIX) {
|
||||
let value = U256::from_str_radix(value, 10).map_err(|error| {
|
||||
anyhow::anyhow!("Invalid decimal literal after `-`: {}", error)
|
||||
})?;
|
||||
if value > U256::ONE << 255u8 {
|
||||
anyhow::bail!("Decimal literal after `-` is too big");
|
||||
}
|
||||
let value = value
|
||||
.checked_sub(U256::ONE)
|
||||
.ok_or_else(|| anyhow::anyhow!("`-0` is invalid literal"))?;
|
||||
Ok(U256::MAX.checked_sub(value).expect("Always valid"))
|
||||
} else if let Some(value) = item.strip_prefix(Self::HEX_LITERAL_PREFIX) {
|
||||
Ok(U256::from_str_radix(value, 16).map_err(|error| {
|
||||
anyhow::anyhow!("Invalid hexadecimal literal: {}", error)
|
||||
})?)
|
||||
} else if item == Self::CHAIN_VARIABLE {
|
||||
let chain_id = chain_state_provider.chain_id()?;
|
||||
Ok(U256::from(chain_id))
|
||||
} else if item == Self::GAS_LIMIT_VARIABLE {
|
||||
let gas_limit =
|
||||
chain_state_provider.block_gas_limit(BlockNumberOrTag::Latest)?;
|
||||
Ok(U256::from(gas_limit))
|
||||
} else if item == Self::COINBASE_VARIABLE {
|
||||
let coinbase = chain_state_provider.block_coinbase(BlockNumberOrTag::Latest)?;
|
||||
Ok(U256::from_be_slice(coinbase.as_ref()))
|
||||
} else if item == Self::DIFFICULTY_VARIABLE {
|
||||
let block_difficulty =
|
||||
chain_state_provider.block_difficulty(BlockNumberOrTag::Latest)?;
|
||||
Ok(block_difficulty)
|
||||
} else if item.starts_with(Self::BLOCK_HASH_VARIABLE_PREFIX) {
|
||||
let offset: u64 = item
|
||||
.split(':')
|
||||
.next_back()
|
||||
.and_then(|value| value.parse().ok())
|
||||
.unwrap_or_default();
|
||||
|
||||
let current_block_number = chain_state_provider.last_block_number()?;
|
||||
let desired_block_number = current_block_number - offset;
|
||||
|
||||
let block_hash =
|
||||
chain_state_provider.block_hash(desired_block_number.into())?;
|
||||
|
||||
Ok(U256::from_be_bytes(block_hash.0))
|
||||
} else if item == Self::BLOCK_NUMBER_VARIABLE {
|
||||
let current_block_number = chain_state_provider.last_block_number()?;
|
||||
Ok(U256::from(current_block_number))
|
||||
} else if item == Self::BLOCK_TIMESTAMP_VARIABLE {
|
||||
let timestamp =
|
||||
chain_state_provider.block_timestamp(BlockNumberOrTag::Latest)?;
|
||||
Ok(U256::from(timestamp))
|
||||
} else {
|
||||
Ok(U256::from_str_radix(item, 10)
|
||||
.map_err(|error| anyhow::anyhow!("Invalid decimal literal: {}", error))?)
|
||||
};
|
||||
value.map(CalldataToken::Item)
|
||||
}
|
||||
Self::Operation(operation) => Ok(CalldataToken::Operation(operation)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Serialize for EtherValue {
|
||||
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
||||
where
|
||||
S: serde::Serializer,
|
||||
{
|
||||
format!("{} wei", self.0).serialize(serializer)
|
||||
}
|
||||
}
|
||||
|
||||
impl<'de> Deserialize<'de> for EtherValue {
|
||||
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
||||
where
|
||||
D: serde::Deserializer<'de>,
|
||||
{
|
||||
let string = String::deserialize(deserializer)?;
|
||||
let mut splitted = string.split(' ');
|
||||
let (Some(value), Some(unit)) = (splitted.next(), splitted.next()) else {
|
||||
return Err(serde::de::Error::custom("Failed to parse the value"));
|
||||
};
|
||||
let parsed = parse_units(value, unit.replace("eth", "ether"))
|
||||
.map_err(|_| serde::de::Error::custom("Failed to parse units"))?
|
||||
.into();
|
||||
Ok(Self(parsed))
|
||||
Ok(U256::from_be_bytes(block_hash.0))
|
||||
} else if value == "$BLOCK_NUMBER" {
|
||||
let current_block_number = chain_state_provider.last_block_number()?;
|
||||
Ok(U256::from(current_block_number))
|
||||
} else if value == "$BLOCK_TIMESTAMP" {
|
||||
let timestamp = chain_state_provider.block_timestamp(BlockNumberOrTag::Latest)?;
|
||||
Ok(U256::from(timestamp))
|
||||
} else {
|
||||
Ok(U256::from_str_radix(value, 10)
|
||||
.map_err(|error| anyhow::anyhow!("Invalid decimal literal: {}", error))?)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -625,9 +394,31 @@ mod tests {
|
||||
use alloy_sol_types::SolValue;
|
||||
use std::collections::HashMap;
|
||||
|
||||
struct MockResolver;
|
||||
struct DummyEthereumNode;
|
||||
|
||||
impl EthereumNode for DummyEthereumNode {
|
||||
fn execute_transaction(
|
||||
&self,
|
||||
_: TransactionRequest,
|
||||
) -> anyhow::Result<alloy::rpc::types::TransactionReceipt> {
|
||||
unimplemented!()
|
||||
}
|
||||
|
||||
fn trace_transaction(
|
||||
&self,
|
||||
_: &alloy::rpc::types::TransactionReceipt,
|
||||
_: alloy::rpc::types::trace::geth::GethDebugTracingOptions,
|
||||
) -> anyhow::Result<alloy::rpc::types::trace::geth::GethTrace> {
|
||||
unimplemented!()
|
||||
}
|
||||
|
||||
fn state_diff(
|
||||
&self,
|
||||
_: &alloy::rpc::types::TransactionReceipt,
|
||||
) -> anyhow::Result<alloy::rpc::types::trace::geth::DiffMode> {
|
||||
unimplemented!()
|
||||
}
|
||||
|
||||
impl ResolverApi for MockResolver {
|
||||
fn chain_id(&self) -> anyhow::Result<alloy_primitives::ChainId> {
|
||||
Ok(0x123)
|
||||
}
|
||||
@@ -687,19 +478,19 @@ mod tests {
|
||||
.0;
|
||||
|
||||
let input = Input {
|
||||
instance: ContractInstance::new("Contract"),
|
||||
instance: ContractInstance::new_from("Contract"),
|
||||
method: Method::FunctionName("store".to_owned()),
|
||||
calldata: Calldata::new_compound(["42"]),
|
||||
calldata: Calldata::Compound(vec!["42".into()]),
|
||||
..Default::default()
|
||||
};
|
||||
|
||||
let mut contracts = HashMap::new();
|
||||
contracts.insert(
|
||||
ContractInstance::new("Contract"),
|
||||
ContractInstance::new_from("Contract"),
|
||||
(Address::ZERO, parsed_abi),
|
||||
);
|
||||
|
||||
let encoded = input.encoded_input(&contracts, &MockResolver).unwrap();
|
||||
let encoded = input.encoded_input(&contracts, &DummyEthereumNode).unwrap();
|
||||
assert!(encoded.0.starts_with(&selector));
|
||||
|
||||
type T = (u64,);
|
||||
@@ -731,17 +522,19 @@ mod tests {
|
||||
let input: Input = Input {
|
||||
instance: "Contract".to_owned().into(),
|
||||
method: Method::FunctionName("send(address)".to_owned()),
|
||||
calldata: Calldata::new_compound(["0x1000000000000000000000000000000000000001"]),
|
||||
calldata: Calldata::Compound(vec![
|
||||
"0x1000000000000000000000000000000000000001".to_string(),
|
||||
]),
|
||||
..Default::default()
|
||||
};
|
||||
|
||||
let mut contracts = HashMap::new();
|
||||
contracts.insert(
|
||||
ContractInstance::new("Contract"),
|
||||
ContractInstance::new_from("Contract"),
|
||||
(Address::ZERO, parsed_abi),
|
||||
);
|
||||
|
||||
let encoded = input.encoded_input(&contracts, &MockResolver).unwrap();
|
||||
let encoded = input.encoded_input(&contracts, &DummyEthereumNode).unwrap();
|
||||
assert!(encoded.0.starts_with(&selector));
|
||||
|
||||
type T = (alloy_primitives::Address,);
|
||||
@@ -774,19 +567,21 @@ mod tests {
|
||||
.0;
|
||||
|
||||
let input: Input = Input {
|
||||
instance: ContractInstance::new("Contract"),
|
||||
instance: ContractInstance::new_from("Contract"),
|
||||
method: Method::FunctionName("send".to_owned()),
|
||||
calldata: Calldata::new_compound(["0x1000000000000000000000000000000000000001"]),
|
||||
calldata: Calldata::Compound(vec![
|
||||
"0x1000000000000000000000000000000000000001".to_string(),
|
||||
]),
|
||||
..Default::default()
|
||||
};
|
||||
|
||||
let mut contracts = HashMap::new();
|
||||
contracts.insert(
|
||||
ContractInstance::new("Contract"),
|
||||
ContractInstance::new_from("Contract"),
|
||||
(Address::ZERO, parsed_abi),
|
||||
);
|
||||
|
||||
let encoded = input.encoded_input(&contracts, &MockResolver).unwrap();
|
||||
let encoded = input.encoded_input(&contracts, &DummyEthereumNode).unwrap();
|
||||
assert!(encoded.0.starts_with(&selector));
|
||||
|
||||
type T = (alloy_primitives::Address,);
|
||||
@@ -797,25 +592,17 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
fn resolve_calldata_item(
|
||||
input: &str,
|
||||
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||
chain_state_provider: &impl ResolverApi,
|
||||
) -> anyhow::Result<U256> {
|
||||
CalldataItem::new(input).resolve(deployed_contracts, chain_state_provider)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn resolver_can_resolve_chain_id_variable() {
|
||||
// Arrange
|
||||
let input = "$CHAIN_ID";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||
|
||||
// Assert
|
||||
let resolved = resolved.expect("Failed to resolve argument");
|
||||
assert_eq!(resolved, U256::from(MockResolver.chain_id().unwrap()))
|
||||
assert_eq!(resolved, U256::from(DummyEthereumNode.chain_id().unwrap()))
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -824,13 +611,17 @@ mod tests {
|
||||
let input = "$GAS_LIMIT";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||
|
||||
// Assert
|
||||
let resolved = resolved.expect("Failed to resolve argument");
|
||||
assert_eq!(
|
||||
resolved,
|
||||
U256::from(MockResolver.block_gas_limit(Default::default()).unwrap())
|
||||
U256::from(
|
||||
DummyEthereumNode
|
||||
.block_gas_limit(Default::default())
|
||||
.unwrap()
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
@@ -840,14 +631,14 @@ mod tests {
|
||||
let input = "$COINBASE";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||
|
||||
// Assert
|
||||
let resolved = resolved.expect("Failed to resolve argument");
|
||||
assert_eq!(
|
||||
resolved,
|
||||
U256::from_be_slice(
|
||||
MockResolver
|
||||
DummyEthereumNode
|
||||
.block_coinbase(Default::default())
|
||||
.unwrap()
|
||||
.as_ref()
|
||||
@@ -861,13 +652,15 @@ mod tests {
|
||||
let input = "$DIFFICULTY";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||
|
||||
// Assert
|
||||
let resolved = resolved.expect("Failed to resolve argument");
|
||||
assert_eq!(
|
||||
resolved,
|
||||
MockResolver.block_difficulty(Default::default()).unwrap()
|
||||
DummyEthereumNode
|
||||
.block_difficulty(Default::default())
|
||||
.unwrap()
|
||||
)
|
||||
}
|
||||
|
||||
@@ -877,13 +670,13 @@ mod tests {
|
||||
let input = "$BLOCK_HASH";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||
|
||||
// Assert
|
||||
let resolved = resolved.expect("Failed to resolve argument");
|
||||
assert_eq!(
|
||||
resolved,
|
||||
U256::from_be_bytes(MockResolver.block_hash(Default::default()).unwrap().0)
|
||||
U256::from_be_bytes(DummyEthereumNode.block_hash(Default::default()).unwrap().0)
|
||||
)
|
||||
}
|
||||
|
||||
@@ -893,13 +686,13 @@ mod tests {
|
||||
let input = "$BLOCK_NUMBER";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||
|
||||
// Assert
|
||||
let resolved = resolved.expect("Failed to resolve argument");
|
||||
assert_eq!(
|
||||
resolved,
|
||||
U256::from(MockResolver.last_block_number().unwrap())
|
||||
U256::from(DummyEthereumNode.last_block_number().unwrap())
|
||||
)
|
||||
}
|
||||
|
||||
@@ -909,105 +702,17 @@ mod tests {
|
||||
let input = "$BLOCK_TIMESTAMP";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||
|
||||
// Assert
|
||||
let resolved = resolved.expect("Failed to resolve argument");
|
||||
assert_eq!(
|
||||
resolved,
|
||||
U256::from(MockResolver.block_timestamp(Default::default()).unwrap())
|
||||
U256::from(
|
||||
DummyEthereumNode
|
||||
.block_timestamp(Default::default())
|
||||
.unwrap()
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn simple_addition_can_be_resolved() {
|
||||
// Arrange
|
||||
let input = "2 4 +";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
|
||||
// Assert
|
||||
let resolved = resolved.expect("Failed to resolve argument");
|
||||
assert_eq!(resolved, U256::from(6));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn simple_subtraction_can_be_resolved() {
|
||||
// Arrange
|
||||
let input = "4 2 -";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
|
||||
// Assert
|
||||
let resolved = resolved.expect("Failed to resolve argument");
|
||||
assert_eq!(resolved, U256::from(2));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn simple_multiplication_can_be_resolved() {
|
||||
// Arrange
|
||||
let input = "4 2 *";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
|
||||
// Assert
|
||||
let resolved = resolved.expect("Failed to resolve argument");
|
||||
assert_eq!(resolved, U256::from(8));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn simple_division_can_be_resolved() {
|
||||
// Arrange
|
||||
let input = "4 2 /";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
|
||||
// Assert
|
||||
let resolved = resolved.expect("Failed to resolve argument");
|
||||
assert_eq!(resolved, U256::from(2));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn arithmetic_errors_are_not_panics() {
|
||||
// Arrange
|
||||
let input = "4 0 /";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
|
||||
// Assert
|
||||
assert!(resolved.is_err())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn arithmetic_with_resolution_works() {
|
||||
// Arrange
|
||||
let input = "$BLOCK_NUMBER 10 +";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
|
||||
// Assert
|
||||
let resolved = resolved.expect("Failed to resolve argument");
|
||||
assert_eq!(
|
||||
resolved,
|
||||
U256::from(MockResolver.last_block_number().unwrap() + 10)
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn incorrect_number_of_arguments_errors() {
|
||||
// Arrange
|
||||
let input = "$BLOCK_NUMBER 10 + +";
|
||||
|
||||
// Act
|
||||
let resolved = resolve_calldata_item(input, &Default::default(), &MockResolver);
|
||||
|
||||
// Assert
|
||||
assert!(resolved.is_err())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,6 +3,6 @@
|
||||
pub mod case;
|
||||
pub mod corpus;
|
||||
pub mod input;
|
||||
pub mod macros;
|
||||
pub mod metadata;
|
||||
pub mod mode;
|
||||
pub mod traits;
|
||||
|
||||
@@ -12,9 +12,11 @@
|
||||
/// pub struct CaseId(usize);
|
||||
/// ```
|
||||
///
|
||||
/// And would also implement a number of methods on this type making it easier to use.
|
||||
/// And would also implement a number of methods on this type making it easier
|
||||
/// to use.
|
||||
///
|
||||
/// These wrapper types become very useful as they make the code a lot easier to read.
|
||||
/// These wrapper types become very useful as they make the code a lot easier
|
||||
/// to read.
|
||||
///
|
||||
/// Take the following as an example:
|
||||
///
|
||||
@@ -24,31 +26,33 @@
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// In the above code it's hard to understand what the various types refer to or what to expect them
|
||||
/// to contain.
|
||||
/// In the above code it's hard to understand what the various types refer to or
|
||||
/// what to expect them to contain.
|
||||
///
|
||||
/// With these wrapper types we're able to create code that's self-documenting in that the types
|
||||
/// tell us what the code is referring to. The above code is transformed into
|
||||
/// With these wrapper types we're able to create code that's self-documenting
|
||||
/// in that the types tell us what the code is referring to. The above code is
|
||||
/// transformed into
|
||||
///
|
||||
/// ```rust,ignore
|
||||
/// struct State {
|
||||
/// contracts: HashMap<CaseId, HashMap<ContractName, ContractByteCode>>
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// Note that we follow the same syntax for defining wrapper structs but we do not permit the use of
|
||||
/// generics.
|
||||
#[macro_export]
|
||||
macro_rules! define_wrapper_type {
|
||||
(
|
||||
$(#[$meta: meta])*
|
||||
$vis:vis struct $ident: ident($ty: ty);
|
||||
$ident: ident($ty: ty) $(;)?
|
||||
) => {
|
||||
$(#[$meta])*
|
||||
$vis struct $ident($ty);
|
||||
pub struct $ident($ty);
|
||||
|
||||
impl $ident {
|
||||
pub fn new(value: impl Into<$ty>) -> Self {
|
||||
pub fn new(value: $ty) -> Self {
|
||||
Self(value)
|
||||
}
|
||||
|
||||
pub fn new_from<T: Into<$ty>>(value: T) -> Self {
|
||||
Self(value.into())
|
||||
}
|
||||
|
||||
@@ -100,7 +104,3 @@ macro_rules! define_wrapper_type {
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
/// Technically not needed but this allows for the macro to be found in the `macros` module of the
|
||||
/// crate in addition to being found in the root of the crate.
|
||||
pub use define_wrapper_type;
|
||||
@@ -9,10 +9,9 @@ use std::{
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use revive_dt_common::macros::define_wrapper_type;
|
||||
|
||||
use crate::{
|
||||
case::Case,
|
||||
define_wrapper_type,
|
||||
mode::{Mode, SolcMode},
|
||||
};
|
||||
|
||||
@@ -47,9 +46,9 @@ impl Deref for MetadataFile {
|
||||
pub struct Metadata {
|
||||
pub targets: Option<Vec<String>>,
|
||||
pub cases: Vec<Case>,
|
||||
pub contracts: Option<BTreeMap<ContractInstance, ContractPathAndIdent>>,
|
||||
pub contracts: Option<BTreeMap<ContractInstance, ContractPathAndIdentifier>>,
|
||||
// TODO: Convert into wrapper types for clarity.
|
||||
pub libraries: Option<BTreeMap<PathBuf, BTreeMap<ContractIdent, ContractInstance>>>,
|
||||
pub libraries: Option<BTreeMap<String, BTreeMap<String, String>>>,
|
||||
pub ignore: Option<bool>,
|
||||
pub modes: Option<Vec<Mode>>,
|
||||
pub file_path: Option<PathBuf>,
|
||||
@@ -86,7 +85,7 @@ impl Metadata {
|
||||
/// Returns the contract sources with canonicalized paths for the files
|
||||
pub fn contract_sources(
|
||||
&self,
|
||||
) -> anyhow::Result<BTreeMap<ContractInstance, ContractPathAndIdent>> {
|
||||
) -> anyhow::Result<BTreeMap<ContractInstance, ContractPathAndIdentifier>> {
|
||||
let directory = self.directory()?;
|
||||
let mut sources = BTreeMap::new();
|
||||
let Some(contracts) = &self.contracts else {
|
||||
@@ -95,7 +94,7 @@ impl Metadata {
|
||||
|
||||
for (
|
||||
alias,
|
||||
ContractPathAndIdent {
|
||||
ContractPathAndIdentifier {
|
||||
contract_source_path,
|
||||
contract_ident,
|
||||
},
|
||||
@@ -107,7 +106,7 @@ impl Metadata {
|
||||
|
||||
sources.insert(
|
||||
alias,
|
||||
ContractPathAndIdent {
|
||||
ContractPathAndIdentifier {
|
||||
contract_source_path: absolute_path,
|
||||
contract_ident,
|
||||
},
|
||||
@@ -193,10 +192,10 @@ impl Metadata {
|
||||
metadata.file_path = Some(path.to_path_buf());
|
||||
metadata.contracts = Some(
|
||||
[(
|
||||
ContractInstance::new("test"),
|
||||
ContractPathAndIdent {
|
||||
ContractInstance::new_from("test"),
|
||||
ContractPathAndIdentifier {
|
||||
contract_source_path: path.to_path_buf(),
|
||||
contract_ident: ContractIdent::new("Test"),
|
||||
contract_ident: ContractIdent::new_from("Test"),
|
||||
},
|
||||
)]
|
||||
.into(),
|
||||
@@ -218,22 +217,18 @@ define_wrapper_type!(
|
||||
/// Represents a contract instance found a metadata file.
|
||||
///
|
||||
/// Typically, this is used as the key to the "contracts" field of metadata files.
|
||||
#[derive(
|
||||
Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
|
||||
)]
|
||||
#[derive(Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||
#[serde(transparent)]
|
||||
pub struct ContractInstance(String);
|
||||
ContractInstance(String);
|
||||
);
|
||||
|
||||
define_wrapper_type!(
|
||||
/// Represents a contract identifier found a metadata file.
|
||||
///
|
||||
/// A contract identifier is the name of the contract in the source code.
|
||||
#[derive(
|
||||
Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
|
||||
)]
|
||||
#[derive(Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||
#[serde(transparent)]
|
||||
pub struct ContractIdent(String);
|
||||
ContractIdent(String);
|
||||
);
|
||||
|
||||
/// Represents an identifier used for contracts.
|
||||
@@ -245,7 +240,7 @@ define_wrapper_type!(
|
||||
/// ```
|
||||
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||
#[serde(try_from = "String", into = "String")]
|
||||
pub struct ContractPathAndIdent {
|
||||
pub struct ContractPathAndIdentifier {
|
||||
/// The path of the contract source code relative to the directory containing the metadata file.
|
||||
pub contract_source_path: PathBuf,
|
||||
|
||||
@@ -253,7 +248,7 @@ pub struct ContractPathAndIdent {
|
||||
pub contract_ident: ContractIdent,
|
||||
}
|
||||
|
||||
impl Display for ContractPathAndIdent {
|
||||
impl Display for ContractPathAndIdentifier {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
write!(
|
||||
f,
|
||||
@@ -264,7 +259,7 @@ impl Display for ContractPathAndIdent {
|
||||
}
|
||||
}
|
||||
|
||||
impl FromStr for ContractPathAndIdent {
|
||||
impl FromStr for ContractPathAndIdentifier {
|
||||
type Err = anyhow::Error;
|
||||
|
||||
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||
@@ -300,7 +295,7 @@ impl FromStr for ContractPathAndIdent {
|
||||
}
|
||||
}
|
||||
|
||||
impl TryFrom<String> for ContractPathAndIdent {
|
||||
impl TryFrom<String> for ContractPathAndIdentifier {
|
||||
type Error = anyhow::Error;
|
||||
|
||||
fn try_from(value: String) -> Result<Self, Self::Error> {
|
||||
@@ -308,8 +303,8 @@ impl TryFrom<String> for ContractPathAndIdent {
|
||||
}
|
||||
}
|
||||
|
||||
impl From<ContractPathAndIdent> for String {
|
||||
fn from(value: ContractPathAndIdent) -> Self {
|
||||
impl From<ContractPathAndIdentifier> for String {
|
||||
fn from(value: ContractPathAndIdentifier) -> Self {
|
||||
value.to_string()
|
||||
}
|
||||
}
|
||||
@@ -324,7 +319,7 @@ mod test {
|
||||
let string = "ERC20/ERC20.sol:ERC20";
|
||||
|
||||
// Act
|
||||
let identifier = ContractPathAndIdent::from_str(string);
|
||||
let identifier = ContractPathAndIdentifier::from_str(string);
|
||||
|
||||
// Assert
|
||||
let identifier = identifier.expect("Failed to parse");
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
use alloy::eips::BlockNumberOrTag;
|
||||
use alloy::primitives::{Address, BlockHash, BlockNumber, BlockTimestamp, ChainId, U256};
|
||||
use anyhow::Result;
|
||||
|
||||
/// A trait of the interface are required to implement to be used by the resolution logic that this
|
||||
/// crate implements to go from string calldata and into the bytes calldata.
|
||||
pub trait ResolverApi {
|
||||
/// Returns the ID of the chain that the node is on.
|
||||
fn chain_id(&self) -> Result<ChainId>;
|
||||
|
||||
// TODO: This is currently a u128 due to Kitchensink needing more than 64 bits for its gas limit
|
||||
// when we implement the changes to the gas we need to adjust this to be a u64.
|
||||
/// Returns the gas limit of the specified block.
|
||||
fn block_gas_limit(&self, number: BlockNumberOrTag) -> Result<u128>;
|
||||
|
||||
/// Returns the coinbase of the specified block.
|
||||
fn block_coinbase(&self, number: BlockNumberOrTag) -> Result<Address>;
|
||||
|
||||
/// Returns the difficulty of the specified block.
|
||||
fn block_difficulty(&self, number: BlockNumberOrTag) -> Result<U256>;
|
||||
|
||||
/// Returns the hash of the specified block.
|
||||
fn block_hash(&self, number: BlockNumberOrTag) -> Result<BlockHash>;
|
||||
|
||||
/// Returns the timestamp of the specified block,
|
||||
fn block_timestamp(&self, number: BlockNumberOrTag) -> Result<BlockTimestamp>;
|
||||
|
||||
/// Returns the number of the last block.
|
||||
fn last_block_number(&self) -> Result<BlockNumber>;
|
||||
}
|
||||
@@ -11,3 +11,7 @@ rust-version.workspace = true
|
||||
[dependencies]
|
||||
alloy = { workspace = true }
|
||||
anyhow = { workspace = true }
|
||||
futures = { workspace = true }
|
||||
tracing = { workspace = true }
|
||||
once_cell = { workspace = true }
|
||||
tokio = { workspace = true }
|
||||
|
||||
+16
-13
@@ -23,7 +23,7 @@ use tracing::Instrument;
|
||||
/// executor to drive an async computation:
|
||||
///
|
||||
/// ```rust
|
||||
/// use revive_dt_common::concepts::*;
|
||||
/// use revive_dt_node_interaction::*;
|
||||
///
|
||||
/// fn blocking_function() {
|
||||
/// let result = BlockingExecutor::execute(async move {
|
||||
@@ -134,17 +134,22 @@ impl BlockingExecutor {
|
||||
}
|
||||
};
|
||||
|
||||
let result = match result {
|
||||
Ok(result) => result,
|
||||
match result.map(|result| {
|
||||
*result
|
||||
.downcast::<R>()
|
||||
.expect("Type mismatch in the downcast")
|
||||
}) {
|
||||
Ok(result) => Ok(result),
|
||||
Err(error) => {
|
||||
tracing::error!(?error, "An error occurred when running the async task");
|
||||
anyhow::bail!("An error occurred when running the async task: {error:?}")
|
||||
tracing::error!(
|
||||
?error,
|
||||
"Failed to downcast the returned result into the expected type"
|
||||
);
|
||||
anyhow::bail!(
|
||||
"Failed to downcast the returned result into the expected type: {error:?}"
|
||||
)
|
||||
}
|
||||
};
|
||||
|
||||
Ok(*result
|
||||
.downcast::<R>()
|
||||
.expect("An error occurred when downcasting into R. This is a bug"))
|
||||
}
|
||||
}
|
||||
}
|
||||
/// Represents the state of the async runtime. This runtime is designed to be a singleton runtime
|
||||
@@ -203,9 +208,7 @@ mod test {
|
||||
fn panics_in_futures_are_caught() {
|
||||
// Act
|
||||
let result = BlockingExecutor::execute(async move {
|
||||
panic!(
|
||||
"If this panic causes, well, a panic, then this is an issue. If it's caught then all good!"
|
||||
);
|
||||
panic!("This is a panic!");
|
||||
0xFFu8
|
||||
});
|
||||
|
||||
@@ -1,9 +1,14 @@
|
||||
//! This crate implements all node interactions.
|
||||
|
||||
use alloy::eips::BlockNumberOrTag;
|
||||
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 anyhow::Result;
|
||||
|
||||
mod blocking_executor;
|
||||
pub use blocking_executor::*;
|
||||
|
||||
/// An interface for all interactions with Ethereum compatible nodes.
|
||||
pub trait EthereumNode {
|
||||
/// Execute the [TransactionRequest] and return a [TransactionReceipt].
|
||||
@@ -18,4 +23,27 @@ pub trait EthereumNode {
|
||||
|
||||
/// Returns the state diff of the transaction hash in the [TransactionReceipt].
|
||||
fn state_diff(&self, receipt: &TransactionReceipt) -> Result<DiffMode>;
|
||||
|
||||
/// Returns the ID of the chain that the node is on.
|
||||
fn chain_id(&self) -> Result<ChainId>;
|
||||
|
||||
// TODO: This is currently a u128 due to Kitchensink needing more than 64 bits for its gas limit
|
||||
// when we implement the changes to the gas we need to adjust this to be a u64.
|
||||
/// Returns the gas limit of the specified block.
|
||||
fn block_gas_limit(&self, number: BlockNumberOrTag) -> Result<u128>;
|
||||
|
||||
/// Returns the coinbase of the specified block.
|
||||
fn block_coinbase(&self, number: BlockNumberOrTag) -> Result<Address>;
|
||||
|
||||
/// Returns the difficulty of the specified block.
|
||||
fn block_difficulty(&self, number: BlockNumberOrTag) -> Result<U256>;
|
||||
|
||||
/// Returns the hash of the specified block.
|
||||
fn block_hash(&self, number: BlockNumberOrTag) -> Result<BlockHash>;
|
||||
|
||||
/// Returns the timestamp of the specified block,
|
||||
fn block_timestamp(&self, number: BlockNumberOrTag) -> Result<BlockTimestamp>;
|
||||
|
||||
/// Returns the number of the last block.
|
||||
fn last_block_number(&self) -> Result<BlockNumber>;
|
||||
}
|
||||
|
||||
@@ -14,10 +14,8 @@ alloy = { workspace = true }
|
||||
tracing = { workspace = true }
|
||||
tokio = { workspace = true }
|
||||
|
||||
revive-dt-common = { workspace = true }
|
||||
revive-dt-config = { workspace = true }
|
||||
revive-dt-format = { workspace = true }
|
||||
revive-dt-node-interaction = { workspace = true }
|
||||
revive-dt-config = { workspace = true }
|
||||
|
||||
serde = { workspace = true }
|
||||
serde_json = { workspace = true }
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
/// This constant defines how much Wei accounts are pre-seeded with in genesis.
|
||||
///
|
||||
/// Note: After changing this number, check that the tests for kitchensink work as we encountered
|
||||
/// some issues with different values of the initial balance on Kitchensink.
|
||||
pub const INITIAL_BALANCE: u128 = 10u128.pow(37);
|
||||
+49
-45
@@ -25,13 +25,11 @@ use alloy::{
|
||||
},
|
||||
signers::local::PrivateKeySigner,
|
||||
};
|
||||
use revive_dt_common::concepts::BlockingExecutor;
|
||||
use revive_dt_config::Arguments;
|
||||
use revive_dt_format::traits::ResolverApi;
|
||||
use revive_dt_node_interaction::EthereumNode;
|
||||
use revive_dt_node_interaction::{BlockingExecutor, EthereumNode};
|
||||
use tracing::Level;
|
||||
|
||||
use crate::{Node, common::FallbackGasFiller, constants::INITIAL_BALANCE};
|
||||
use crate::{Node, common::FallbackGasFiller};
|
||||
|
||||
static NODE_COUNT: AtomicU32 = AtomicU32::new(0);
|
||||
|
||||
@@ -76,8 +74,6 @@ impl Instance {
|
||||
const GETH_STDOUT_LOG_FILE_NAME: &str = "node_stdout.log";
|
||||
const GETH_STDERR_LOG_FILE_NAME: &str = "node_stderr.log";
|
||||
|
||||
const TRANSACTION_INDEXING_ERROR: &str = "transaction indexing is in progress";
|
||||
|
||||
/// Create the node directory and call `geth init` to configure the genesis.
|
||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||
fn init(&mut self, genesis: String) -> anyhow::Result<&mut Self> {
|
||||
@@ -88,12 +84,10 @@ impl Instance {
|
||||
for signer_address in
|
||||
<EthereumWallet as NetworkWallet<Ethereum>>::signer_addresses(&self.wallet)
|
||||
{
|
||||
// Note, the use of the entry API here means that we only modify the entries for any
|
||||
// account that is not in the `alloc` field of the genesis state.
|
||||
genesis
|
||||
.alloc
|
||||
.entry(signer_address)
|
||||
.or_insert(GenesisAccount::default().with_balance(U256::from(INITIAL_BALANCE)));
|
||||
genesis.alloc.entry(signer_address).or_insert(
|
||||
GenesisAccount::default()
|
||||
.with_balance(10000000000000000000000u128.try_into().unwrap()),
|
||||
);
|
||||
}
|
||||
let genesis_path = self.base_directory.join(Self::GENESIS_JSON_FILE);
|
||||
serde_json::to_writer(File::create(&genesis_path)?, &genesis)?;
|
||||
@@ -271,45 +265,57 @@ impl EthereumNode for Instance {
|
||||
// it eventually works, but we only do that if the error we get back is the "transaction
|
||||
// indexing is in progress" error or if the receipt is None.
|
||||
//
|
||||
// Getting the transaction indexed and taking a receipt can take a long time especially
|
||||
// when a lot of transactions are being submitted to the node. Thus, while initially we
|
||||
// only allowed for 60 seconds of waiting with a 1 second delay in polling, we need to
|
||||
// allow for a larger wait time. Therefore, in here we allow for 5 minutes of waiting
|
||||
// with exponential backoff each time we attempt to get the receipt and find that it's
|
||||
// not available.
|
||||
// At the moment we do not allow for the 60 seconds to be modified and we take it as
|
||||
// being an implementation detail that's invisible to anything outside of this module.
|
||||
//
|
||||
// We allow a total of 60 retries for getting the receipt with one second between each
|
||||
// retry and the next which means that we allow for a total of 60 seconds of waiting
|
||||
// before we consider that we're unable to get the transaction receipt.
|
||||
let mut retries = 0;
|
||||
let mut total_wait_duration = Duration::from_secs(0);
|
||||
let max_allowed_wait_duration = Duration::from_secs(5 * 60);
|
||||
loop {
|
||||
if total_wait_duration >= max_allowed_wait_duration {
|
||||
tracing::error!(
|
||||
?total_wait_duration,
|
||||
?max_allowed_wait_duration,
|
||||
retry_count = retries,
|
||||
"Failed to get receipt after polling for it"
|
||||
);
|
||||
anyhow::bail!(
|
||||
"Polled for receipt for {total_wait_duration:?} but failed to get it"
|
||||
);
|
||||
}
|
||||
|
||||
match provider.get_transaction_receipt(*transaction_hash).await {
|
||||
Ok(Some(receipt)) => break Ok(receipt),
|
||||
Ok(None) => {}
|
||||
Ok(Some(receipt)) => {
|
||||
tracing::info!("Obtained the transaction receipt");
|
||||
break Ok(receipt);
|
||||
}
|
||||
Ok(None) => {
|
||||
if retries == 60 {
|
||||
tracing::error!(
|
||||
"Polled for transaction receipt for 60 seconds but failed to get it"
|
||||
);
|
||||
break Err(anyhow::anyhow!("Failed to get the transaction receipt"));
|
||||
} else {
|
||||
tracing::trace!(
|
||||
retries,
|
||||
"Sleeping for 1 second and trying to get the receipt again"
|
||||
);
|
||||
retries += 1;
|
||||
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
|
||||
continue;
|
||||
}
|
||||
}
|
||||
Err(error) => {
|
||||
let error_string = error.to_string();
|
||||
if !error_string.contains(Self::TRANSACTION_INDEXING_ERROR) {
|
||||
if error_string.contains("transaction indexing is in progress") {
|
||||
if retries == 60 {
|
||||
tracing::error!(
|
||||
"Polled for transaction receipt for 60 seconds but failed to get it"
|
||||
);
|
||||
break Err(error.into());
|
||||
} else {
|
||||
tracing::trace!(
|
||||
retries,
|
||||
"Sleeping for 1 second and trying to get the receipt again"
|
||||
);
|
||||
retries += 1;
|
||||
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
|
||||
continue;
|
||||
}
|
||||
} else {
|
||||
break Err(error.into());
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
let next_wait_duration = Duration::from_secs(2u64.pow(retries))
|
||||
.min(max_allowed_wait_duration - total_wait_duration);
|
||||
total_wait_duration += next_wait_duration;
|
||||
retries += 1;
|
||||
|
||||
tokio::time::sleep(next_wait_duration).await;
|
||||
}
|
||||
}
|
||||
})?
|
||||
}
|
||||
@@ -345,9 +351,7 @@ impl EthereumNode for Instance {
|
||||
_ => anyhow::bail!("expected a diff mode trace"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl ResolverApi for Instance {
|
||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||
fn chain_id(&self) -> anyhow::Result<alloy::primitives::ChainId> {
|
||||
let provider = self.provider();
|
||||
|
||||
@@ -30,18 +30,16 @@ use alloy::{
|
||||
},
|
||||
signers::local::PrivateKeySigner,
|
||||
};
|
||||
use revive_dt_format::traits::ResolverApi;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use serde_json::{Value as JsonValue, json};
|
||||
use sp_core::crypto::Ss58Codec;
|
||||
use sp_runtime::AccountId32;
|
||||
use tracing::Level;
|
||||
|
||||
use revive_dt_common::concepts::BlockingExecutor;
|
||||
use revive_dt_config::Arguments;
|
||||
use revive_dt_node_interaction::EthereumNode;
|
||||
use revive_dt_node_interaction::{BlockingExecutor, EthereumNode};
|
||||
|
||||
use crate::{Node, common::FallbackGasFiller, constants::INITIAL_BALANCE};
|
||||
use crate::{Node, common::FallbackGasFiller};
|
||||
|
||||
static NODE_COUNT: AtomicU32 = AtomicU32::new(0);
|
||||
|
||||
@@ -133,12 +131,10 @@ impl KitchensinkNode {
|
||||
for signer_address in
|
||||
<EthereumWallet as NetworkWallet<Ethereum>>::signer_addresses(&self.wallet)
|
||||
{
|
||||
// Note, the use of the entry API here means that we only modify the entries for any
|
||||
// account that is not in the `alloc` field of the genesis state.
|
||||
genesis
|
||||
.alloc
|
||||
.entry(signer_address)
|
||||
.or_insert(GenesisAccount::default().with_balance(U256::from(INITIAL_BALANCE)));
|
||||
genesis.alloc.entry(signer_address).or_insert(
|
||||
GenesisAccount::default()
|
||||
.with_balance(10000000000000000000000u128.try_into().unwrap()),
|
||||
);
|
||||
}
|
||||
self.extract_balance_from_genesis_file(&genesis)?
|
||||
};
|
||||
@@ -426,9 +422,7 @@ impl EthereumNode for KitchensinkNode {
|
||||
_ => anyhow::bail!("expected a diff mode trace"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl ResolverApi for KitchensinkNode {
|
||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||
fn chain_id(&self) -> anyhow::Result<alloy::primitives::ChainId> {
|
||||
let provider = self.provider();
|
||||
|
||||
@@ -4,7 +4,6 @@ use revive_dt_config::Arguments;
|
||||
use revive_dt_node_interaction::EthereumNode;
|
||||
|
||||
pub mod common;
|
||||
pub mod constants;
|
||||
pub mod geth;
|
||||
pub mod kitchensink;
|
||||
pub mod pool;
|
||||
|
||||
+5
-1
@@ -33,5 +33,9 @@
|
||||
"mixhash": "0x0000000000000000000000000000000000000000000000000000000000000000",
|
||||
"parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
|
||||
"timestamp": "0x00",
|
||||
"alloc": {}
|
||||
"alloc": {
|
||||
"90F8bf6A479f320ead074411a4B0e7944Ea8c9C1": {
|
||||
"balance": "10000000000000000000000"
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user