@nomicfoundation/edr 0.12.0-next.2 → 0.12.0-next.20

package/src/solidity_tests/test_results.rs

@@ -18,6 +18,7 @@ use napi_derive::napi;
 
 use crate::{
     cast::TryCast,
+    gas_report::GasReport,
     solidity_tests::{artifact::ArtifactId, config::IncludeTraces},
     trace::{solidity_stack_trace::SolidityStackTraceEntry, u256_to_bigint},
 };
@@ -42,7 +43,7 @@ pub struct ValueSnapshotEntry {
     pub value: String,
 }
 
-/// See [edr_solidity_tests::result::SuiteResult]
+/// See [`edr_solidity_tests::result::SuiteResult`]
 #[napi]
 #[derive(Clone, Debug)]
 pub struct SuiteResult {
@@ -50,13 +51,13 @@ pub struct SuiteResult {
     /// callback
     #[napi(readonly)]
     pub id: ArtifactId,
-    /// See [edr_solidity_tests::result::SuiteResult::duration]
+    /// See [`edr_solidity_tests::result::SuiteResult::duration`]
     #[napi(readonly)]
     pub duration_ns: BigInt,
-    /// See [edr_solidity_tests::result::SuiteResult::test_results]
+    /// See [`edr_solidity_tests::result::SuiteResult::test_results`]
     #[napi(readonly)]
     pub test_results: Vec<TestResult>,
-    /// See [edr_solidity_tests::result::SuiteResult::warnings]
+    /// See [`edr_solidity_tests::result::SuiteResult::warnings`]
     #[napi(readonly)]
     pub warnings: Vec<String>,
 }
@@ -80,29 +81,29 @@ impl SuiteResult {
     }
 }
 
-/// See [edr_solidity_tests::result::TestResult]
+/// See [`edr_solidity_tests::result::TestResult`]
 #[napi]
 #[derive(Clone, Debug)]
 pub struct TestResult {
     /// The name of the test.
     #[napi(readonly)]
     pub name: String,
-    /// See [edr_solidity_tests::result::TestResult::status]
+    /// See [`edr_solidity_tests::result::TestResult::status`]
     #[napi(readonly)]
     pub status: TestStatus,
-    /// See [edr_solidity_tests::result::TestResult::reason]
+    /// See [`edr_solidity_tests::result::TestResult::reason`]
     #[napi(readonly)]
     pub reason: Option<String>,
-    /// See [edr_solidity_tests::result::TestResult::counterexample]
+    /// See [`edr_solidity_tests::result::TestResult::counterexample`]
     #[napi(readonly)]
     pub counterexample: Option<Either<BaseCounterExample, CounterExampleSequence>>,
-    /// See [edr_solidity_tests::result::TestResult::decoded_logs]
+    /// See [`edr_solidity_tests::result::TestResult::decoded_logs`]
     #[napi(readonly)]
     pub decoded_logs: Vec<String>,
-    /// See [edr_solidity_tests::result::TestResult::kind]
+    /// See [`edr_solidity_tests::result::TestResult::kind`]
     #[napi(readonly)]
     pub kind: Either3<StandardTestKind, FuzzTestKind, InvariantTestKind>,
-    /// See [edr_solidity_tests::result::TestResult::duration]
+    /// See [`edr_solidity_tests::result::TestResult::duration`]
     #[napi(readonly)]
     pub duration_ns: BigInt,
     /// Groups of value snapshot entries (incl. gas).
@@ -263,7 +264,7 @@ impl TestResult {
                 }),
             decoded_logs: test_result.decoded_logs,
             kind: match test_result.kind {
-                edr_solidity_tests::result::TestKind::Standard(gas_consumed) => {
+                edr_solidity_tests::result::TestKind::Unit { gas: gas_consumed } => {
                     Either3::A(StandardTestKind {
                         consumed_gas: BigInt::from(gas_consumed),
                     })
@@ -282,11 +283,27 @@ impl TestResult {
                     runs,
                     calls,
                     reverts,
+                    metrics,
+                    failed_corpus_replays,
                 } => Either3::C(InvariantTestKind {
                     // usize as u64 is always safe
                     runs: BigInt::from(runs as u64),
                     calls: BigInt::from(calls as u64),
                     reverts: BigInt::from(reverts as u64),
+                    metrics: metrics
+                        .into_iter()
+                        .map(|(name, metric)| {
+                            (
+                                name,
+                                InvariantMetrics {
+                                    calls: BigInt::from(metric.calls as u64),
+                                    reverts: BigInt::from(metric.reverts as u64),
+                                    discards: BigInt::from(metric.discards as u64),
+                                },
+                            )
+                        })
+                        .collect(),
+                    failed_corpus_replays: BigInt::from(failed_corpus_replays as u64),
                 }),
             },
             duration_ns: BigInt::from(test_result.duration.as_nanos()),
@@ -335,7 +352,7 @@ impl From<edr_solidity_tests::result::TestStatus> for TestStatus {
     }
 }
 
-/// See [edr_solidity_tests::result::TestKind::Standard]
+/// See [`edr_solidity_tests::result::TestKind::Unit`]
 #[napi(object)]
 #[derive(Debug, Clone)]
 pub struct StandardTestKind {
@@ -344,22 +361,22 @@ pub struct StandardTestKind {
     pub consumed_gas: BigInt,
 }
 
-/// See [edr_solidity_tests::result::TestKind::Fuzz]
+/// See [`edr_solidity_tests::result::TestKind::Fuzz`]
 #[napi(object)]
 #[derive(Debug, Clone)]
 pub struct FuzzTestKind {
-    /// See [edr_solidity_tests::result::TestKind::Fuzz]
+    /// See [`edr_solidity_tests::result::TestKind::Fuzz`]
     #[napi(readonly)]
     pub runs: BigInt,
-    /// See [edr_solidity_tests::result::TestKind::Fuzz]
+    /// See [`edr_solidity_tests::result::TestKind::Fuzz`]
     #[napi(readonly)]
     pub mean_gas: BigInt,
-    /// See [edr_solidity_tests::result::TestKind::Fuzz]
+    /// See [`edr_solidity_tests::result::TestKind::Fuzz`]
     #[napi(readonly)]
     pub median_gas: BigInt,
 }
 
-/// See [edr_solidity_tests::fuzz::FuzzCase]
+/// See [`edr_solidity_tests::fuzz::FuzzCase`]
 #[napi(object)]
 #[derive(Clone)]
 pub struct FuzzCase {
@@ -383,19 +400,40 @@ impl Debug for FuzzCase {
     }
 }
 
-/// See [edr_solidity_tests::result::TestKind::Invariant]
+/// See [`edr_solidity_tests::result::TestKind::Invariant`]
 #[napi(object)]
 #[derive(Debug, Clone)]
 pub struct InvariantTestKind {
-    /// See [edr_solidity_tests::result::TestKind::Invariant]
+    /// See [`edr_solidity_tests::result::TestKind::Invariant`]
     #[napi(readonly)]
     pub runs: BigInt,
-    /// See [edr_solidity_tests::result::TestKind::Invariant]
+    /// See [`edr_solidity_tests::result::TestKind::Invariant`]
     #[napi(readonly)]
     pub calls: BigInt,
-    /// See [edr_solidity_tests::result::TestKind::Invariant]
+    /// See [`edr_solidity_tests::result::TestKind::Invariant`]
     #[napi(readonly)]
     pub reverts: BigInt,
+    /// See [`edr_solidity_tests::result::TestKind::Invariant`]
+    #[napi(readonly)]
+    pub metrics: std::collections::HashMap<String, InvariantMetrics>,
+    /// See [`edr_solidity_tests::result::TestKind::Invariant`]
+    #[napi(readonly)]
+    pub failed_corpus_replays: BigInt,
+}
+
+/// See [`edr_solidity_tests::result::InvariantMetrics`]
+#[napi(object)]
+#[derive(Debug, Clone)]
+pub struct InvariantMetrics {
+    // Count of fuzzed selector calls.
+    #[napi(readonly)]
+    pub calls: BigInt,
+    // Count of fuzzed selector reverts.
+    #[napi(readonly)]
+    pub reverts: BigInt,
+    // Count of fuzzed selector discards (through assume cheatcodes).
+    #[napi(readonly)]
+    pub discards: BigInt,
 }
 
 /// Original sequence size and sequence of calls used as a counter example
@@ -409,26 +447,26 @@ pub struct CounterExampleSequence {
     pub sequence: Vec<BaseCounterExample>,
 }
 
-/// See [edr_solidity_tests::fuzz::BaseCounterExample]
+/// See [`edr_solidity_tests::fuzz::BaseCounterExample`]
 #[napi(object)]
 #[derive(Clone)]
 pub struct BaseCounterExample {
-    /// See [edr_solidity_tests::fuzz::BaseCounterExample::sender]
+    /// See [`edr_solidity_tests::fuzz::BaseCounterExample::sender`]
     #[napi(readonly)]
     pub sender: Option<Uint8Array>,
-    /// See [edr_solidity_tests::fuzz::BaseCounterExample::addr]
+    /// See [`edr_solidity_tests::fuzz::BaseCounterExample::addr`]
     #[napi(readonly)]
     pub address: Option<Uint8Array>,
-    /// See [edr_solidity_tests::fuzz::BaseCounterExample::calldata]
+    /// See [`edr_solidity_tests::fuzz::BaseCounterExample::calldata`]
     #[napi(readonly)]
     pub calldata: Uint8Array,
-    /// See [edr_solidity_tests::fuzz::BaseCounterExample::contract_name]
+    /// See [`edr_solidity_tests::fuzz::BaseCounterExample::contract_name`]
     #[napi(readonly)]
     pub contract_name: Option<String>,
-    /// See [edr_solidity_tests::fuzz::BaseCounterExample::signature]
+    /// See [`edr_solidity_tests::fuzz::BaseCounterExample::signature`]
     #[napi(readonly)]
     pub signature: Option<String>,
-    /// See [edr_solidity_tests::fuzz::BaseCounterExample::args]
+    /// See [`edr_solidity_tests::fuzz::BaseCounterExample::args`]
     #[napi(readonly)]
     pub args: Option<String>,
 }
@@ -542,10 +580,19 @@ impl CallTrace {
     /// Instantiates a `CallTrace` with the details from a node and the supplied
     /// children.
     fn new(node: &traces::CallTraceNode, children: Vec<Either<CallTrace, LogTrace>>) -> Self {
-        let contract = node.trace.decoded.label.clone();
+        let contract = node
+            .trace
+            .decoded
+            .as_ref()
+            .and_then(|decoded| decoded.label.clone());
         let address = node.trace.address.to_checksum(None);
 
-        let inputs = match &node.trace.decoded.call_data {
+        let inputs = match &node
+            .trace
+            .decoded
+            .as_ref()
+            .and_then(|decoded| decoded.call_data.as_ref())
+        {
             Some(traces::DecodedCallData { signature, args }) => {
                 let name = signature
                     .split('(')
@@ -558,7 +605,12 @@ impl CallTrace {
             None => Either::B(node.trace.data.as_ref().into()),
         };
 
-        let outputs = match &node.trace.decoded.return_data {
+        let outputs = match node
+            .trace
+            .decoded
+            .as_ref()
+            .and_then(|decoded| decoded.return_data.as_ref())
+        {
             Some(outputs) => Either::A(outputs.clone()),
             None => {
                 if node.kind().is_any_create() && node.trace.success {
@@ -604,7 +656,10 @@ impl CallTrace {
         loop {
             // We will break out of the loop before the stack goes empty.
             let mut item = stack.pop().unwrap();
-            let node = &arena.nodes()[item.arena_index];
+            let node = arena
+                .nodes()
+                .get(item.arena_index)
+                .expect("Arena index should be valid");
 
             if item.visited {
                 let mut logs = node
@@ -618,11 +673,20 @@ impl CallTrace {
                     .iter()
                     .filter_map(|ord| match *ord {
                         traces::TraceMemberOrder::Log(i) => {
-                            let log = logs[i].take().unwrap();
+                            let log = logs
+                                .get_mut(i)
+                                .expect("Log index should be valid")
+                                .take()
+                                .unwrap();
                             Some(Either::B(log))
                         }
                         traces::TraceMemberOrder::Call(i) => {
-                            let child_trace = item.child_traces[i].take().unwrap();
+                            let child_trace = item
+                                .child_traces
+                                .get_mut(i)
+                                .expect("Child trace index should be valid")
+                                .take()
+                                .unwrap();
                             Some(Either::A(child_trace))
                         }
                         traces::TraceMemberOrder::Step(_) => None,
@@ -632,7 +696,9 @@ impl CallTrace {
                 let trace = CallTrace::new(node, children);
 
                 if let Some(parent_stack_index) = item.parent_stack_index {
-                    let parent = &mut stack[parent_stack_index];
+                    let parent = stack
+                        .get_mut(parent_stack_index)
+                        .expect("Parent stack index should be valid");
                     parent.child_traces.push(Some(trace));
                 } else {
                     return trace;
@@ -661,7 +727,10 @@ impl CallTrace {
 
 impl From<&traces::CallLog> for LogTrace {
     fn from(log: &traces::CallLog) -> Self {
-        let decoded_log = log.decoded.name.clone().zip(log.decoded.params.as_ref());
+        let decoded_log = log
+            .decoded
+            .as_ref()
+            .and_then(|decoded| decoded.name.clone().zip(decoded.params.as_ref()));
 
         let parameters = decoded_log.map_or_else(
             || {
@@ -703,3 +772,19 @@ impl From<traces::CallKind> for CallKind {
         }
     }
 }
+
+/// The result of a Solidity test run.
+#[napi(object)]
+pub struct SolidityTestResult {
+    /// Gas report, if it was generated.
+    #[napi(readonly)]
+    pub gas_report: Option<GasReport>,
+}
+
+impl From<edr_solidity_tests::multi_runner::SolidityTestResult> for SolidityTestResult {
+    fn from(value: edr_solidity_tests::multi_runner::SolidityTestResult) -> Self {
+        Self {
+            gas_report: value.gas_report.map(GasReport::from),
+        }
+    }
+}

package/src/solidity_tests.rs

@@ -9,7 +9,7 @@ pub mod test_results;
 
 use std::path::Path;
 
-use edr_eth::Bytes;
+use edr_primitives::Bytes;
 use edr_solidity::linker::{LinkOutput, Linker};
 use edr_solidity_tests::{constants::LIBRARY_DEPLOYER, contracts::ContractsByArtifact};
 use foundry_compilers::artifacts::Libraries;

package/src/trace/debug.rs

@@ -1,6 +1,6 @@
 //! Port of `hardhat-network/stack-traces/debug.ts` from Hardhat.
 
-use napi::bindgen_prelude::Either24;
+use napi::bindgen_prelude::Either25;
 use napi_derive::napi;
 
 use super::solidity_stack_trace::{RevertErrorStackTraceEntry, SolidityStackTrace};
@@ -11,31 +11,32 @@ fn print_stack_trace(trace: SolidityStackTrace) -> napi::Result<()> {
     let entry_values = trace
         .into_iter()
         .map(|entry| match entry {
-            Either24::A(entry) => serde_json::to_value(entry),
-            Either24::B(entry) => serde_json::to_value(entry),
-            Either24::C(entry) => serde_json::to_value(entry),
-            Either24::D(entry) => serde_json::to_value(entry),
-            Either24::F(entry) => serde_json::to_value(entry),
-            Either24::G(entry) => serde_json::to_value(entry),
-            Either24::H(entry) => serde_json::to_value(entry),
-            Either24::I(entry) => serde_json::to_value(entry),
-            Either24::J(entry) => serde_json::to_value(entry),
-            Either24::K(entry) => serde_json::to_value(entry),
-            Either24::L(entry) => serde_json::to_value(entry),
-            Either24::M(entry) => serde_json::to_value(entry),
-            Either24::N(entry) => serde_json::to_value(entry),
-            Either24::O(entry) => serde_json::to_value(entry),
-            Either24::P(entry) => serde_json::to_value(entry),
-            Either24::Q(entry) => serde_json::to_value(entry),
-            Either24::R(entry) => serde_json::to_value(entry),
-            Either24::S(entry) => serde_json::to_value(entry),
-            Either24::T(entry) => serde_json::to_value(entry),
-            Either24::U(entry) => serde_json::to_value(entry),
-            Either24::V(entry) => serde_json::to_value(entry),
-            Either24::W(entry) => serde_json::to_value(entry),
-            Either24::X(entry) => serde_json::to_value(entry),
+            Either25::A(entry) => serde_json::to_value(entry),
+            Either25::B(entry) => serde_json::to_value(entry),
+            Either25::C(entry) => serde_json::to_value(entry),
+            Either25::D(entry) => serde_json::to_value(entry),
+            Either25::F(entry) => serde_json::to_value(entry),
+            Either25::G(entry) => serde_json::to_value(entry),
+            Either25::H(entry) => serde_json::to_value(entry),
+            Either25::I(entry) => serde_json::to_value(entry),
+            Either25::J(entry) => serde_json::to_value(entry),
+            Either25::K(entry) => serde_json::to_value(entry),
+            Either25::L(entry) => serde_json::to_value(entry),
+            Either25::M(entry) => serde_json::to_value(entry),
+            Either25::N(entry) => serde_json::to_value(entry),
+            Either25::O(entry) => serde_json::to_value(entry),
+            Either25::P(entry) => serde_json::to_value(entry),
+            Either25::Q(entry) => serde_json::to_value(entry),
+            Either25::R(entry) => serde_json::to_value(entry),
+            Either25::S(entry) => serde_json::to_value(entry),
+            Either25::T(entry) => serde_json::to_value(entry),
+            Either25::U(entry) => serde_json::to_value(entry),
+            Either25::V(entry) => serde_json::to_value(entry),
+            Either25::W(entry) => serde_json::to_value(entry),
+            Either25::X(entry) => serde_json::to_value(entry),
+            Either25::Y(entry) => serde_json::to_value(entry),
             // Decode the error message from the return data
-            Either24::E(entry @ RevertErrorStackTraceEntry { .. }) => {
+            Either25::E(entry @ RevertErrorStackTraceEntry { .. }) => {
                 use serde::de::Error;
 
                 let decoded_error_msg = ReturnData::new(entry.return_data.clone())
@@ -45,7 +46,9 @@ fn print_stack_trace(trace: SolidityStackTrace) -> napi::Result<()> {
                 })?;
 
                 let mut value = serde_json::to_value(entry)?;
-                value["message"] = decoded_error_msg.into();
+                if let Some(obj) = value.as_object_mut() {
+                    obj.insert("message".to_string(), decoded_error_msg.into());
+                }
                 Ok(value)
             }
         })

package/src/trace/exit.rs

@@ -3,6 +3,7 @@
 
 use std::fmt;
 
+use edr_chain_spec::EvmHaltReason;
 use napi_derive::napi;
 
 #[napi]
@@ -50,20 +51,20 @@ impl fmt::Display for ExitCode {
 }
 
 #[allow(clippy::fallible_impl_from)] // naively ported for now
-impl From<edr_solidity::exit_code::ExitCode<edr_eth::l1::HaltReason>> for ExitCode {
-    fn from(code: edr_solidity::exit_code::ExitCode<edr_eth::l1::HaltReason>) -> Self {
+impl From<edr_solidity::exit_code::ExitCode<EvmHaltReason>> for ExitCode {
+    fn from(code: edr_solidity::exit_code::ExitCode<EvmHaltReason>) -> Self {
         use edr_solidity::exit_code::ExitCode;
 
         match code {
             ExitCode::Success => Self::SUCCESS,
             ExitCode::Revert => Self::REVERT,
-            ExitCode::Halt(edr_eth::l1::HaltReason::OutOfGas(_)) => Self::OUT_OF_GAS,
-            ExitCode::Halt(edr_eth::l1::HaltReason::OpcodeNotFound | edr_eth::l1::HaltReason::InvalidFEOpcode
+            ExitCode::Halt(EvmHaltReason::OutOfGas(_)) => Self::OUT_OF_GAS,
+            ExitCode::Halt(EvmHaltReason::OpcodeNotFound | EvmHaltReason::InvalidFEOpcode
               // Returned when an opcode is not implemented for the hardfork
-              | edr_eth::l1::HaltReason::NotActivated) => Self::INVALID_OPCODE,
-            ExitCode::Halt(edr_eth::l1::HaltReason::StackUnderflow) => Self::STACK_UNDERFLOW,
-            ExitCode::Halt(edr_eth::l1::HaltReason::CreateContractSizeLimit) => Self::CODESIZE_EXCEEDS_MAXIMUM,
-            ExitCode::Halt(edr_eth::l1::HaltReason::CreateCollision) => Self::CREATE_COLLISION,
+              | EvmHaltReason::NotActivated) => Self::INVALID_OPCODE,
+            ExitCode::Halt(EvmHaltReason::StackUnderflow) => Self::STACK_UNDERFLOW,
+            ExitCode::Halt(EvmHaltReason::CreateContractSizeLimit) => Self::CODESIZE_EXCEEDS_MAXIMUM,
+            ExitCode::Halt(EvmHaltReason::CreateCollision) => Self::CREATE_COLLISION,
             _ => Self::UNKNOWN_HALT_REASON,
         }
     }

package/src/trace/return_data.rs

@@ -22,11 +22,9 @@ pub struct ReturnData {
 impl ReturnData {
     #[napi(catch_unwind, constructor)]
     pub fn new(value: Uint8Array) -> Self {
-        let selector = if value.len() >= 4 {
-            Some(value[0..4].try_into().unwrap())
-        } else {
-            None
-        };
+        let selector = value
+            .get(0..4)
+            .map(|selector| selector.try_into().expect("selector is 4 bytes"));
 
         Self { value, selector }
     }
@@ -57,10 +55,17 @@ impl ReturnData {
             return Ok(String::new());
         }
 
+        if !self.is_error_return_data() {
+            return Err(napi::Error::new(
+                napi::Status::InvalidArg,
+                "VM Exception while processing transaction: Expected return data to be a Error(string)",
+            ));
+        }
+
         let result = Error::abi_decode(&self.value[..]).map_err(|_err| {
             napi::Error::new(
                 napi::Status::InvalidArg,
-                "Expected return data to be a Error(string) and contain a valid string",
+                "VM Exception while processing transaction: Expected return data to contain a valid string",
             )
         })?;
 
@@ -69,10 +74,17 @@ impl ReturnData {
 
     #[napi(catch_unwind)]
     pub fn decode_panic(&self) -> napi::Result<BigInt> {
+        if !self.is_panic_return_data() {
+            return Err(napi::Error::new(
+                napi::Status::InvalidArg,
+                "VM Exception while processing transaction: Expected return data to be a Panic(uint256)",
+            ));
+        }
+
         let result = Panic::abi_decode(&self.value[..]).map_err(|_err| {
             napi::Error::new(
                 napi::Status::InvalidArg,
-                "Expected return data to be a Error(string) and contain a valid string",
+                "VM Exception while processing transaction: Expected return data to contain a valid uint256",
             )
         })?;