mirror of
https://github.com/pezkuwichain/revive-differential-tests.git
synced 2026-04-25 18:37:58 +00:00
879 lines
31 KiB
Rust
879 lines
31 KiB
Rust
//! The test driver handles the compilation and execution of the test cases.
|
|
|
|
use std::collections::HashMap;
|
|
use std::path::PathBuf;
|
|
|
|
use alloy::consensus::EMPTY_ROOT_HASH;
|
|
use alloy::hex;
|
|
use alloy::json_abi::JsonAbi;
|
|
use alloy::network::{Ethereum, TransactionBuilder};
|
|
use alloy::primitives::{TxHash, U256};
|
|
use alloy::rpc::types::TransactionReceipt;
|
|
use alloy::rpc::types::trace::geth::{
|
|
CallFrame, GethDebugBuiltInTracerType, GethDebugTracerConfig, GethDebugTracerType,
|
|
GethDebugTracingOptions, GethTrace, PreStateConfig,
|
|
};
|
|
use alloy::{
|
|
primitives::Address,
|
|
rpc::types::{TransactionRequest, trace::geth::DiffMode},
|
|
};
|
|
use anyhow::Context as _;
|
|
use futures::{TryStreamExt, future::try_join_all};
|
|
use indexmap::IndexMap;
|
|
use revive_dt_common::types::PlatformIdentifier;
|
|
use revive_dt_format::traits::{ResolutionContext, ResolverApi};
|
|
use revive_dt_report::ExecutionSpecificReporter;
|
|
use semver::Version;
|
|
|
|
use revive_dt_format::case::Case;
|
|
use revive_dt_format::input::{
|
|
BalanceAssertionStep, Calldata, EtherValue, Expected, ExpectedOutput, FunctionCallStep, Method,
|
|
StepIdx, StorageEmptyAssertionStep,
|
|
};
|
|
use revive_dt_format::metadata::{ContractIdent, ContractInstance, ContractPathAndIdent};
|
|
use revive_dt_format::{input::Step, metadata::Metadata};
|
|
use revive_dt_node_interaction::EthereumNode;
|
|
use tokio::try_join;
|
|
use tracing::{Instrument, info, info_span, instrument};
|
|
|
|
#[derive(Clone)]
|
|
pub struct CaseState {
|
|
/// A map of all of the compiled contracts for the given metadata file.
|
|
compiled_contracts: HashMap<PathBuf, HashMap<String, (String, JsonAbi)>>,
|
|
|
|
/// This map stores the contracts deployments for this case.
|
|
deployed_contracts: HashMap<ContractInstance, (ContractIdent, Address, JsonAbi)>,
|
|
|
|
/// This map stores the variables used for each one of the cases contained in the metadata
|
|
/// file.
|
|
variables: HashMap<String, U256>,
|
|
|
|
/// Stores the version used for the current case.
|
|
compiler_version: Version,
|
|
|
|
/// The execution reporter.
|
|
execution_reporter: ExecutionSpecificReporter,
|
|
}
|
|
|
|
impl CaseState {
|
|
pub fn new(
|
|
compiler_version: Version,
|
|
compiled_contracts: HashMap<PathBuf, HashMap<String, (String, JsonAbi)>>,
|
|
deployed_contracts: HashMap<ContractInstance, (ContractIdent, Address, JsonAbi)>,
|
|
execution_reporter: ExecutionSpecificReporter,
|
|
) -> Self {
|
|
Self {
|
|
compiled_contracts,
|
|
deployed_contracts,
|
|
variables: Default::default(),
|
|
compiler_version,
|
|
execution_reporter,
|
|
}
|
|
}
|
|
|
|
pub async fn handle_step(
|
|
&mut self,
|
|
metadata: &Metadata,
|
|
step: &Step,
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<StepOutput> {
|
|
match step {
|
|
Step::FunctionCall(input) => {
|
|
let (receipt, geth_trace, diff_mode) = self
|
|
.handle_input(metadata, input, node)
|
|
.await
|
|
.context("Failed to handle function call step")?;
|
|
Ok(StepOutput::FunctionCall(receipt, geth_trace, diff_mode))
|
|
}
|
|
Step::BalanceAssertion(balance_assertion) => {
|
|
self.handle_balance_assertion(metadata, balance_assertion, node)
|
|
.await
|
|
.context("Failed to handle balance assertion step")?;
|
|
Ok(StepOutput::BalanceAssertion)
|
|
}
|
|
Step::StorageEmptyAssertion(storage_empty) => {
|
|
self.handle_storage_empty(metadata, storage_empty, node)
|
|
.await
|
|
.context("Failed to handle storage empty assertion step")?;
|
|
Ok(StepOutput::StorageEmptyAssertion)
|
|
}
|
|
Step::Repeat(repetition_step) => {
|
|
self.handle_repeat(
|
|
metadata,
|
|
repetition_step.repeat,
|
|
&repetition_step.steps,
|
|
node,
|
|
)
|
|
.await
|
|
.context("Failed to handle the repetition step")?;
|
|
Ok(StepOutput::Repetition)
|
|
}
|
|
}
|
|
.inspect(|_| info!("Step Succeeded"))
|
|
}
|
|
|
|
#[instrument(level = "info", name = "Handling Input", skip_all)]
|
|
pub async fn handle_input(
|
|
&mut self,
|
|
metadata: &Metadata,
|
|
input: &FunctionCallStep,
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<(TransactionReceipt, GethTrace, DiffMode)> {
|
|
let resolver = node.resolver().await?;
|
|
|
|
let deployment_receipts = self
|
|
.handle_input_contract_deployment(metadata, input, node)
|
|
.await
|
|
.context("Failed during contract deployment phase of input handling")?;
|
|
let execution_receipt = self
|
|
.handle_input_execution(input, deployment_receipts, node)
|
|
.await
|
|
.context("Failed during transaction execution phase of input handling")?;
|
|
let tracing_result = self
|
|
.handle_input_call_frame_tracing(execution_receipt.transaction_hash, node)
|
|
.await
|
|
.context("Failed during callframe tracing phase of input handling")?;
|
|
self.handle_input_variable_assignment(input, &tracing_result)
|
|
.context("Failed to assign variables from callframe output")?;
|
|
let (_, (geth_trace, diff_mode)) = try_join!(
|
|
self.handle_input_expectations(
|
|
input,
|
|
&execution_receipt,
|
|
resolver.as_ref(),
|
|
&tracing_result
|
|
),
|
|
self.handle_input_diff(execution_receipt.transaction_hash, node)
|
|
)
|
|
.context("Failed while evaluating expectations and diffs in parallel")?;
|
|
Ok((execution_receipt, geth_trace, diff_mode))
|
|
}
|
|
|
|
#[instrument(level = "info", name = "Handling Balance Assertion", skip_all)]
|
|
pub async fn handle_balance_assertion(
|
|
&mut self,
|
|
metadata: &Metadata,
|
|
balance_assertion: &BalanceAssertionStep,
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<()> {
|
|
self.handle_balance_assertion_contract_deployment(metadata, balance_assertion, node)
|
|
.await
|
|
.context("Failed to deploy contract for balance assertion")?;
|
|
self.handle_balance_assertion_execution(balance_assertion, node)
|
|
.await
|
|
.context("Failed to execute balance assertion")?;
|
|
Ok(())
|
|
}
|
|
|
|
#[instrument(level = "info", name = "Handling Storage Assertion", skip_all)]
|
|
pub async fn handle_storage_empty(
|
|
&mut self,
|
|
metadata: &Metadata,
|
|
storage_empty: &StorageEmptyAssertionStep,
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<()> {
|
|
self.handle_storage_empty_assertion_contract_deployment(metadata, storage_empty, node)
|
|
.await
|
|
.context("Failed to deploy contract for storage empty assertion")?;
|
|
self.handle_storage_empty_assertion_execution(storage_empty, node)
|
|
.await
|
|
.context("Failed to execute storage empty assertion")?;
|
|
Ok(())
|
|
}
|
|
|
|
#[instrument(level = "info", name = "Handling Repetition", skip_all)]
|
|
pub async fn handle_repeat(
|
|
&mut self,
|
|
metadata: &Metadata,
|
|
repetitions: usize,
|
|
steps: &[Step],
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<()> {
|
|
let tasks = (0..repetitions).map(|_| {
|
|
let mut state = self.clone();
|
|
async move {
|
|
for step in steps {
|
|
state.handle_step(metadata, step, node).await?;
|
|
}
|
|
Ok::<(), anyhow::Error>(())
|
|
}
|
|
});
|
|
try_join_all(tasks).await?;
|
|
Ok(())
|
|
}
|
|
|
|
/// Handles the contract deployment for a given input performing it if it needs to be performed.
|
|
#[instrument(level = "info", skip_all)]
|
|
async fn handle_input_contract_deployment(
|
|
&mut self,
|
|
metadata: &Metadata,
|
|
input: &FunctionCallStep,
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<HashMap<ContractInstance, TransactionReceipt>> {
|
|
let mut instances_we_must_deploy = IndexMap::<ContractInstance, bool>::new();
|
|
for instance in input.find_all_contract_instances().into_iter() {
|
|
if !self.deployed_contracts.contains_key(&instance) {
|
|
instances_we_must_deploy.entry(instance).or_insert(false);
|
|
}
|
|
}
|
|
if let Method::Deployer = input.method {
|
|
instances_we_must_deploy.swap_remove(&input.instance);
|
|
instances_we_must_deploy.insert(input.instance.clone(), true);
|
|
}
|
|
|
|
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();
|
|
|
|
if let (_, _, Some(receipt)) = self
|
|
.get_or_deploy_contract_instance(
|
|
&instance,
|
|
metadata,
|
|
input.caller,
|
|
calldata,
|
|
value,
|
|
node,
|
|
)
|
|
.await
|
|
.context("Failed to get or deploy contract instance during input execution")?
|
|
{
|
|
receipts.insert(instance.clone(), receipt);
|
|
}
|
|
}
|
|
|
|
Ok(receipts)
|
|
}
|
|
|
|
/// Handles the execution of the input in terms of the calls that need to be made.
|
|
#[instrument(level = "info", skip_all)]
|
|
async fn handle_input_execution(
|
|
&mut self,
|
|
input: &FunctionCallStep,
|
|
mut deployment_receipts: HashMap<ContractInstance, TransactionReceipt>,
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<TransactionReceipt> {
|
|
match input.method {
|
|
// This input was already executed when `handle_input` was called. We just need to
|
|
// lookup the transaction receipt in this case and continue on.
|
|
Method::Deployer => deployment_receipts
|
|
.remove(&input.instance)
|
|
.context("Failed to find deployment receipt for constructor call"),
|
|
Method::Fallback | Method::FunctionName(_) => {
|
|
let resolver = node.resolver().await?;
|
|
let tx = match input
|
|
.legacy_transaction(resolver.as_ref(), self.default_resolution_context())
|
|
.await
|
|
{
|
|
Ok(tx) => tx,
|
|
Err(err) => {
|
|
return Err(err);
|
|
}
|
|
};
|
|
|
|
match node.execute_transaction(tx).await {
|
|
Ok(receipt) => Ok(receipt),
|
|
Err(err) => Err(err),
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[instrument(level = "info", skip_all)]
|
|
async fn handle_input_call_frame_tracing(
|
|
&self,
|
|
tx_hash: TxHash,
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<CallFrame> {
|
|
node.trace_transaction(
|
|
tx_hash,
|
|
GethDebugTracingOptions {
|
|
tracer: Some(GethDebugTracerType::BuiltInTracer(
|
|
GethDebugBuiltInTracerType::CallTracer,
|
|
)),
|
|
tracer_config: GethDebugTracerConfig(serde_json::json! {{
|
|
"onlyTopCall": true,
|
|
"withLog": false,
|
|
"withStorage": false,
|
|
"withMemory": false,
|
|
"withStack": false,
|
|
"withReturnData": true
|
|
}}),
|
|
..Default::default()
|
|
},
|
|
)
|
|
.await
|
|
.map(|trace| {
|
|
trace
|
|
.try_into_call_frame()
|
|
.expect("Impossible - we requested a callframe trace so we must get it back")
|
|
})
|
|
}
|
|
|
|
#[instrument(level = "info", skip_all)]
|
|
fn handle_input_variable_assignment(
|
|
&mut self,
|
|
input: &FunctionCallStep,
|
|
tracing_result: &CallFrame,
|
|
) -> anyhow::Result<()> {
|
|
let Some(ref assignments) = input.variable_assignments else {
|
|
return Ok(());
|
|
};
|
|
|
|
// Handling the return data variable assignments.
|
|
for (variable_name, output_word) in assignments.return_data.iter().zip(
|
|
tracing_result
|
|
.output
|
|
.as_ref()
|
|
.unwrap_or_default()
|
|
.to_vec()
|
|
.chunks(32),
|
|
) {
|
|
let value = U256::from_be_slice(output_word);
|
|
self.variables.insert(variable_name.clone(), value);
|
|
tracing::info!(
|
|
variable_name,
|
|
variable_value = hex::encode(value.to_be_bytes::<32>()),
|
|
"Assigned variable"
|
|
);
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[instrument(level = "info", skip_all)]
|
|
async fn handle_input_expectations(
|
|
&self,
|
|
input: &FunctionCallStep,
|
|
execution_receipt: &TransactionReceipt,
|
|
resolver: &(impl ResolverApi + ?Sized),
|
|
tracing_result: &CallFrame,
|
|
) -> anyhow::Result<()> {
|
|
// Resolving the `input.expected` into a series of expectations that we can then assert on.
|
|
let mut expectations = match input {
|
|
FunctionCallStep {
|
|
expected: Some(Expected::Calldata(calldata)),
|
|
..
|
|
} => vec![ExpectedOutput::new().with_calldata(calldata.clone())],
|
|
FunctionCallStep {
|
|
expected: Some(Expected::Expected(expected)),
|
|
..
|
|
} => vec![expected.clone()],
|
|
FunctionCallStep {
|
|
expected: Some(Expected::ExpectedMany(expected)),
|
|
..
|
|
} => expected.clone(),
|
|
FunctionCallStep { expected: None, .. } => vec![ExpectedOutput::new().with_success()],
|
|
};
|
|
|
|
// This is a bit of a special case and we have to support it separately on it's own. If it's
|
|
// a call to the deployer method, then the tests will assert that it "returns" the address
|
|
// of the contract. Deployments do not return the address of the contract but the runtime
|
|
// code of the contracts. Therefore, this assertion would always fail. So, we replace it
|
|
// with an assertion of "check if it succeeded"
|
|
if let Method::Deployer = &input.method {
|
|
for expectation in expectations.iter_mut() {
|
|
expectation.return_data = None;
|
|
}
|
|
}
|
|
|
|
futures::stream::iter(expectations.into_iter().map(Ok))
|
|
.try_for_each_concurrent(None, |expectation| async move {
|
|
self.handle_input_expectation_item(
|
|
execution_receipt,
|
|
resolver,
|
|
expectation,
|
|
tracing_result,
|
|
)
|
|
.await
|
|
})
|
|
.await
|
|
}
|
|
|
|
#[instrument(level = "info", skip_all)]
|
|
async fn handle_input_expectation_item(
|
|
&self,
|
|
execution_receipt: &TransactionReceipt,
|
|
resolver: &(impl ResolverApi + ?Sized),
|
|
expectation: ExpectedOutput,
|
|
tracing_result: &CallFrame,
|
|
) -> anyhow::Result<()> {
|
|
if let Some(ref version_requirement) = expectation.compiler_version {
|
|
if !version_requirement.matches(&self.compiler_version) {
|
|
return Ok(());
|
|
}
|
|
}
|
|
|
|
let resolution_context = self
|
|
.default_resolution_context()
|
|
.with_block_number(execution_receipt.block_number.as_ref())
|
|
.with_transaction_hash(&execution_receipt.transaction_hash);
|
|
|
|
// Handling the receipt state assertion.
|
|
let expected = !expectation.exception;
|
|
let actual = execution_receipt.status();
|
|
if actual != expected {
|
|
tracing::error!(
|
|
expected,
|
|
actual,
|
|
?execution_receipt,
|
|
?tracing_result,
|
|
"Transaction status assertion failed"
|
|
);
|
|
anyhow::bail!(
|
|
"Transaction status assertion failed - Expected {expected} but got {actual}",
|
|
);
|
|
}
|
|
|
|
// 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, resolver, resolution_context)
|
|
.await
|
|
.context("Failed to resolve calldata equivalence for return data assertion")?
|
|
{
|
|
tracing::error!(
|
|
?execution_receipt,
|
|
?expected,
|
|
%actual,
|
|
"Calldata assertion failed"
|
|
);
|
|
anyhow::bail!("Calldata assertion failed - Expected {expected:?} but got {actual}",);
|
|
}
|
|
}
|
|
|
|
// Handling the events assertion
|
|
if let Some(ref expected_events) = expectation.events {
|
|
// Handling the events length assertion.
|
|
let expected = expected_events.len();
|
|
let actual = execution_receipt.logs().len();
|
|
if actual != expected {
|
|
tracing::error!(expected, actual, "Event count assertion failed",);
|
|
anyhow::bail!(
|
|
"Event count assertion failed - Expected {expected} but got {actual}",
|
|
);
|
|
}
|
|
|
|
// Handling the events assertion.
|
|
for (event_idx, (expected_event, actual_event)) in expected_events
|
|
.iter()
|
|
.zip(execution_receipt.logs())
|
|
.enumerate()
|
|
{
|
|
// Handling the emitter assertion.
|
|
if let Some(ref expected_address) = expected_event.address {
|
|
let expected = Address::from_slice(
|
|
Calldata::new_compound([expected_address])
|
|
.calldata(resolver, resolution_context)
|
|
.await?
|
|
.get(12..32)
|
|
.expect("Can't fail"),
|
|
);
|
|
let actual = actual_event.address();
|
|
if actual != expected {
|
|
tracing::error!(
|
|
event_idx,
|
|
%expected,
|
|
%actual,
|
|
"Event emitter assertion failed",
|
|
);
|
|
anyhow::bail!(
|
|
"Event emitter assertion failed - Expected {expected} but got {actual}",
|
|
);
|
|
}
|
|
}
|
|
|
|
// Handling the topics assertion.
|
|
for (expected, actual) in expected_event
|
|
.topics
|
|
.as_slice()
|
|
.iter()
|
|
.zip(actual_event.topics())
|
|
{
|
|
let expected = Calldata::new_compound([expected]);
|
|
if !expected
|
|
.is_equivalent(&actual.0, resolver, resolution_context)
|
|
.await
|
|
.context("Failed to resolve event topic equivalence")?
|
|
{
|
|
tracing::error!(
|
|
event_idx,
|
|
?execution_receipt,
|
|
?expected,
|
|
?actual,
|
|
"Event topics assertion failed",
|
|
);
|
|
anyhow::bail!(
|
|
"Event topics assertion failed - Expected {expected:?} but got {actual:?}",
|
|
);
|
|
}
|
|
}
|
|
|
|
// Handling the values assertion.
|
|
let expected = &expected_event.values;
|
|
let actual = &actual_event.data().data;
|
|
if !expected
|
|
.is_equivalent(&actual.0, resolver, resolution_context)
|
|
.await
|
|
.context("Failed to resolve event value equivalence")?
|
|
{
|
|
tracing::error!(
|
|
event_idx,
|
|
?execution_receipt,
|
|
?expected,
|
|
?actual,
|
|
"Event value assertion failed",
|
|
);
|
|
anyhow::bail!(
|
|
"Event value assertion failed - Expected {expected:?} but got {actual:?}",
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[instrument(level = "info", skip_all)]
|
|
async fn handle_input_diff(
|
|
&self,
|
|
tx_hash: TxHash,
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<(GethTrace, DiffMode)> {
|
|
let trace_options = GethDebugTracingOptions::prestate_tracer(PreStateConfig {
|
|
diff_mode: Some(true),
|
|
disable_code: None,
|
|
disable_storage: None,
|
|
});
|
|
|
|
let trace = node
|
|
.trace_transaction(tx_hash, trace_options)
|
|
.await
|
|
.context("Failed to obtain geth prestate tracer output")?;
|
|
let diff = node
|
|
.state_diff(tx_hash)
|
|
.await
|
|
.context("Failed to obtain state diff for transaction")?;
|
|
|
|
Ok((trace, diff))
|
|
}
|
|
|
|
#[instrument(level = "info", skip_all)]
|
|
pub async fn handle_balance_assertion_contract_deployment(
|
|
&mut self,
|
|
metadata: &Metadata,
|
|
balance_assertion: &BalanceAssertionStep,
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<()> {
|
|
let Some(instance) = balance_assertion
|
|
.address
|
|
.strip_suffix(".address")
|
|
.map(ContractInstance::new)
|
|
else {
|
|
return Ok(());
|
|
};
|
|
self.get_or_deploy_contract_instance(
|
|
&instance,
|
|
metadata,
|
|
FunctionCallStep::default_caller(),
|
|
None,
|
|
None,
|
|
node,
|
|
)
|
|
.await?;
|
|
Ok(())
|
|
}
|
|
|
|
#[instrument(level = "info", skip_all)]
|
|
pub async fn handle_balance_assertion_execution(
|
|
&mut self,
|
|
BalanceAssertionStep {
|
|
address: address_string,
|
|
expected_balance: amount,
|
|
..
|
|
}: &BalanceAssertionStep,
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<()> {
|
|
let resolver = node.resolver().await?;
|
|
let address = Address::from_slice(
|
|
Calldata::new_compound([address_string])
|
|
.calldata(resolver.as_ref(), self.default_resolution_context())
|
|
.await?
|
|
.get(12..32)
|
|
.expect("Can't fail"),
|
|
);
|
|
|
|
let balance = node.balance_of(address).await?;
|
|
|
|
let expected = *amount;
|
|
let actual = balance;
|
|
if expected != actual {
|
|
tracing::error!(%expected, %actual, %address, "Balance assertion failed");
|
|
anyhow::bail!(
|
|
"Balance assertion failed - Expected {} but got {} for {} resolved to {}",
|
|
expected,
|
|
actual,
|
|
address_string,
|
|
address,
|
|
)
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[instrument(level = "info", skip_all)]
|
|
pub async fn handle_storage_empty_assertion_contract_deployment(
|
|
&mut self,
|
|
metadata: &Metadata,
|
|
storage_empty_assertion: &StorageEmptyAssertionStep,
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<()> {
|
|
let Some(instance) = storage_empty_assertion
|
|
.address
|
|
.strip_suffix(".address")
|
|
.map(ContractInstance::new)
|
|
else {
|
|
return Ok(());
|
|
};
|
|
self.get_or_deploy_contract_instance(
|
|
&instance,
|
|
metadata,
|
|
FunctionCallStep::default_caller(),
|
|
None,
|
|
None,
|
|
node,
|
|
)
|
|
.await?;
|
|
Ok(())
|
|
}
|
|
|
|
#[instrument(level = "info", skip_all)]
|
|
pub async fn handle_storage_empty_assertion_execution(
|
|
&mut self,
|
|
StorageEmptyAssertionStep {
|
|
address: address_string,
|
|
is_storage_empty,
|
|
..
|
|
}: &StorageEmptyAssertionStep,
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<()> {
|
|
let resolver = node.resolver().await?;
|
|
let address = Address::from_slice(
|
|
Calldata::new_compound([address_string])
|
|
.calldata(resolver.as_ref(), self.default_resolution_context())
|
|
.await?
|
|
.get(12..32)
|
|
.expect("Can't fail"),
|
|
);
|
|
|
|
let storage = node.latest_state_proof(address, Default::default()).await?;
|
|
let is_empty = storage.storage_hash == EMPTY_ROOT_HASH;
|
|
|
|
let expected = is_storage_empty;
|
|
let actual = is_empty;
|
|
|
|
if *expected != actual {
|
|
tracing::error!(%expected, %actual, %address, "Storage Empty Assertion failed");
|
|
anyhow::bail!(
|
|
"Storage Empty Assertion failed - Expected {} but got {} for {} resolved to {}",
|
|
expected,
|
|
actual,
|
|
address_string,
|
|
address,
|
|
)
|
|
};
|
|
|
|
Ok(())
|
|
}
|
|
|
|
/// 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 async fn get_or_deploy_contract_instance(
|
|
&mut self,
|
|
contract_instance: &ContractInstance,
|
|
metadata: &Metadata,
|
|
deployer: Address,
|
|
calldata: Option<&Calldata>,
|
|
value: Option<EtherValue>,
|
|
node: &dyn EthereumNode,
|
|
) -> anyhow::Result<(Address, JsonAbi, Option<TransactionReceipt>)> {
|
|
if let Some((_, address, abi)) = self.deployed_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 {
|
|
anyhow::bail!(
|
|
"Contract source not found for instance {:?}",
|
|
contract_instance
|
|
)
|
|
};
|
|
|
|
let Some((code, abi)) = self
|
|
.compiled_contracts
|
|
.get(&contract_source_path)
|
|
.and_then(|source_file_contracts| source_file_contracts.get(contract_ident.as_ref()))
|
|
.cloned()
|
|
else {
|
|
anyhow::bail!(
|
|
"Failed to find information for contract {:?}",
|
|
contract_instance
|
|
)
|
|
};
|
|
|
|
let mut code = match alloy::hex::decode(&code) {
|
|
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 let Some(calldata) = calldata {
|
|
let resolver = node.resolver().await?;
|
|
let calldata = calldata
|
|
.calldata(resolver.as_ref(), self.default_resolution_context())
|
|
.await?;
|
|
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).await {
|
|
Ok(receipt) => receipt,
|
|
Err(error) => {
|
|
tracing::error!(?error, "Contract deployment transaction failed.");
|
|
return Err(error);
|
|
}
|
|
};
|
|
|
|
let Some(address) = receipt.contract_address else {
|
|
anyhow::bail!("Contract deployment didn't return an address");
|
|
};
|
|
tracing::info!(
|
|
instance_name = ?contract_instance,
|
|
instance_address = ?address,
|
|
"Deployed contract"
|
|
);
|
|
self.execution_reporter
|
|
.report_contract_deployed_event(contract_instance.clone(), address)?;
|
|
|
|
self.deployed_contracts.insert(
|
|
contract_instance.clone(),
|
|
(contract_ident, address, abi.clone()),
|
|
);
|
|
|
|
Ok((address, abi, Some(receipt)))
|
|
}
|
|
|
|
fn default_resolution_context(&self) -> ResolutionContext<'_> {
|
|
ResolutionContext::default()
|
|
.with_deployed_contracts(&self.deployed_contracts)
|
|
.with_variables(&self.variables)
|
|
}
|
|
}
|
|
|
|
pub struct CaseDriver<'a> {
|
|
metadata: &'a Metadata,
|
|
case: &'a Case,
|
|
platform_state: Vec<(&'a dyn EthereumNode, PlatformIdentifier, CaseState)>,
|
|
}
|
|
|
|
impl<'a> CaseDriver<'a> {
|
|
#[allow(clippy::too_many_arguments)]
|
|
pub fn new(
|
|
metadata: &'a Metadata,
|
|
case: &'a Case,
|
|
platform_state: Vec<(&'a dyn EthereumNode, PlatformIdentifier, CaseState)>,
|
|
) -> CaseDriver<'a> {
|
|
Self {
|
|
metadata,
|
|
case,
|
|
platform_state,
|
|
}
|
|
}
|
|
|
|
#[instrument(level = "info", name = "Executing Case", skip_all)]
|
|
pub async fn execute(&mut self) -> anyhow::Result<usize> {
|
|
let mut steps_executed = 0;
|
|
for (step_idx, step) in self
|
|
.case
|
|
.steps_iterator()
|
|
.enumerate()
|
|
.map(|(idx, v)| (StepIdx::new(idx), v))
|
|
{
|
|
// Run this step concurrently across all platforms; short-circuit on first failure
|
|
let metadata = self.metadata;
|
|
let step_futs =
|
|
self.platform_state
|
|
.iter_mut()
|
|
.map(|(node, platform_id, case_state)| {
|
|
let platform_id = *platform_id;
|
|
let node_ref = *node;
|
|
let step_clone = step.clone();
|
|
let span = info_span!(
|
|
"Handling Step",
|
|
%step_idx,
|
|
platform = %platform_id,
|
|
);
|
|
async move {
|
|
case_state
|
|
.handle_step(metadata, &step_clone, node_ref)
|
|
.await
|
|
.map_err(|e| (platform_id, e))
|
|
}
|
|
.instrument(span)
|
|
});
|
|
|
|
match try_join_all(step_futs).await {
|
|
Ok(_outputs) => {
|
|
// All platforms succeeded for this step
|
|
steps_executed += 1;
|
|
}
|
|
Err((platform_id, error)) => {
|
|
tracing::error!(
|
|
%step_idx,
|
|
platform = %platform_id,
|
|
?error,
|
|
"Step failed on platform",
|
|
);
|
|
return Err(error);
|
|
}
|
|
}
|
|
}
|
|
|
|
Ok(steps_executed)
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Debug)]
|
|
#[allow(clippy::large_enum_variant)]
|
|
pub enum StepOutput {
|
|
FunctionCall(TransactionReceipt, GethTrace, DiffMode),
|
|
BalanceAssertion,
|
|
StorageEmptyAssertion,
|
|
Repetition,
|
|
}
|