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

package/index.d.ts

@@ -841,6 +841,20 @@ export enum IncludeTraces {
 }
 export declare function l1SolidityTestRunnerFactory(): SolidityTestRunnerFactory
 export declare function opSolidityTestRunnerFactory(): SolidityTestRunnerFactory
+/** A grouping of value snapshot entries for a test. */
+export interface ValueSnapshotGroup {
+  /** The group name. */
+  name: string
+  /** The entries in the group. */
+  entries: Array<ValueSnapshotEntry>
+}
+/** An entry in a value snapshot group. */
+export interface ValueSnapshotEntry {
+  /** The name of the entry. */
+  name: string
+  /** The value of the entry. */
+  value: string
+}
 /** The stack trace result */
 export interface StackTrace {
   /** Enum tag for JS. */
@@ -968,11 +982,10 @@ export interface CallTrace {
   gasUsed: bigint
   /** The amount of native token that was included with the call. */
   value: bigint
-  /**
-   * The target of the call. Provided as a contract name if known, otherwise
-   * a checksum address.
-   */
-  contract: string
+  /** The target address of the call. */
+  address: string
+  /** The name of the contract that is the target of the call, if known. */
+  contract?: string
   /**
    * The input (calldata) to the call. If it encodes a known function call,
    * it will be decoded into the function name and a list of arguments.
@@ -1365,6 +1378,13 @@ export declare class TestResult {
   readonly kind: StandardTestKind | FuzzTestKind | InvariantTestKind
   /** See [edr_solidity_tests::result::TestResult::duration] */
   readonly durationNs: bigint
+  /**
+   * Groups of value snapshot entries (incl. gas).
+   *
+   * Only present if the test runner collected scoped snapshots. Currently,
+   * this is always the case.
+   */
+  readonly valueSnapshotGroups?: Array<ValueSnapshotGroup>
   /**
    * Compute the error stack trace.
    * The result is either the stack trace or the reason why we couldn't

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@nomicfoundation/edr",
-  "version": "0.12.0-next.0",
+  "version": "0.12.0-next.2",
   "devDependencies": {
     "@napi-rs/cli": "^2.18.4",
     "@nomicfoundation/ethereumjs-util": "^9.0.4",
+    "@tsconfig/node20": "^20.1.6",
     "@types/chai": "^4.2.0",
     "@types/chai-as-promised": "^7.1.8",
     "@types/mocha": ">=9.1.0",
@@ -25,14 +26,17 @@
     "typescript": "~5.8.2"
   },
   "engines": {
-    "node": ">= 18"
+    "node": ">= 20"
+  },
+  "exports": {
+    ".": "./index.js",
+    "./solidity-tests": "./dist/src/ts/solidity_tests.js"
   },
   "files": [
     "index.js",
     "index.d.ts",
-    "Cargo.toml",
-    "build.rs",
-    "src/"
+    "src/",
+    "dist/src/"
   ],
   "license": "MIT",
   "main": "index.js",
@@ -54,31 +58,31 @@
   "repository": "NomicFoundation/edr.git",
   "types": "index.d.ts",
   "optionalDependencies": {
-    "@nomicfoundation/edr-darwin-arm64": "0.12.0-next.0",
-    "@nomicfoundation/edr-darwin-x64": "0.12.0-next.0",
-    "@nomicfoundation/edr-linux-arm64-gnu": "0.12.0-next.0",
-    "@nomicfoundation/edr-linux-arm64-musl": "0.12.0-next.0",
-    "@nomicfoundation/edr-linux-x64-gnu": "0.12.0-next.0",
-    "@nomicfoundation/edr-linux-x64-musl": "0.12.0-next.0",
-    "@nomicfoundation/edr-win32-x64-msvc": "0.12.0-next.0"
+    "@nomicfoundation/edr-darwin-arm64": "0.12.0-next.2",
+    "@nomicfoundation/edr-darwin-x64": "0.12.0-next.2",
+    "@nomicfoundation/edr-linux-arm64-gnu": "0.12.0-next.2",
+    "@nomicfoundation/edr-linux-arm64-musl": "0.12.0-next.2",
+    "@nomicfoundation/edr-linux-x64-gnu": "0.12.0-next.2",
+    "@nomicfoundation/edr-linux-x64-musl": "0.12.0-next.2",
+    "@nomicfoundation/edr-win32-x64-msvc": "0.12.0-next.2"
   },
   "scripts": {
     "artifacts": "napi artifacts",
     "build": "pnpm run build:publish",
-    "build:debug": "napi build --platform  --no-const-enum --features op",
-    "build:dev": "napi build --platform --release --no-const-enum --features op,test-mock",
-    "build:publish": "napi build --platform --profile napi-publish --no-const-enum --features op",
-    "build:scenarios": "napi build --platform --release --no-const-enum --features op,scenarios",
-    "build:tracing": "napi build --platform --release --no-const-enum --features op,tracing",
-    "build:typingFile": "napi build --platform --no-const-enum --features op",
+    "build:debug": "bash ../../scripts/build_edr_napi.sh --features op",
+    "build:dev": "bash ../../scripts/build_edr_napi.sh --release --features op,test-mock",
+    "build:publish": "bash ../../scripts/build_edr_napi.sh --profile napi-publish --features op",
+    "build:scenarios": "bash ../../scripts/build_edr_napi.sh --release --features op,scenarios",
+    "build:tracing": "bash ../../scripts/build_edr_napi.sh --release --features op,tracing",
+    "build:typingFile": "bash ../../scripts/build_edr_napi.sh --features op",
     "clean": "rm -rf @nomicfoundation/edr.node",
     "eslint": "eslint 'test/**/*.ts'",
     "lint": "pnpm run prettier && pnpm run eslint",
     "lint:fix": "pnpm run prettier --write",
     "pretest": "pnpm build:dev",
     "prettier": "prettier --check \"test/**.ts\"",
-    "test": "pnpm tsc && node --max-old-space-size=8192 node_modules/mocha/bin/_mocha --recursive \"test/**/*.ts\"",
-    "testNoBuild": "pnpm tsc && node --max-old-space-size=8192 node_modules/mocha/bin/_mocha --recursive \"test/**/{,!(mock)}.ts\"",
+    "test": "node --max-old-space-size=8192 node_modules/mocha/bin/_mocha --recursive \"test/**/*.ts\"",
+    "testNoBuild": "node --max-old-space-size=8192 node_modules/mocha/bin/_mocha --recursive \"test/**/{,!(mock)}.ts\"",
     "universal": "napi universal",
     "version": "napi version"
   }

package/src/context.rs

@@ -281,11 +281,12 @@ impl EdrContext {
 
             let include_traces = config.include_traces.into();
 
+            let runtime_for_factory = runtime.clone();
             let test_runner = try_or_reject_deferred!(runtime
                 .clone()
                 .spawn_blocking(move || {
                     factory.create_test_runner(
-                        runtime,
+                        runtime_for_factory,
                         config,
                         contracts,
                         linking_output.known_contracts,
@@ -297,28 +298,38 @@ impl EdrContext {
                 .await
                 .expect("Failed to join test runner factory thread"));
 
-            let () = try_or_reject_deferred!(test_runner.run_tests(
-                test_filter,
-                Arc::new(
-                    move |SuiteResultAndArtifactId {
-                              artifact_id,
-                              result,
-                          }| {
-                        let suite_result = SuiteResult::new(artifact_id, result, include_traces);
-
-                        let status = on_test_suite_completed_callback
-                            .call(suite_result, ThreadsafeFunctionCallMode::Blocking);
-
-                        // This should always succeed since we're using an unbounded queue. We add
-                        // an assertion for completeness.
-                        assert_eq!(
+            let runtime_for_runner = runtime.clone();
+            let () = try_or_reject_deferred!(runtime
+                .clone()
+                .spawn_blocking(move || {
+                    test_runner.run_tests(
+                        runtime_for_runner,
+                        test_filter,
+                        Arc::new(
+                            move |SuiteResultAndArtifactId {
+                                      artifact_id,
+                                      result,
+                                  }| {
+                                let suite_result =
+                                    SuiteResult::new(artifact_id, result, include_traces);
+
+                                let status = on_test_suite_completed_callback
+                                    .call(suite_result, ThreadsafeFunctionCallMode::Blocking);
+
+                                // This should always succeed since we're using an unbounded queue.
+                                // We add an assertion for
+                                // completeness.
+                                assert_eq!(
                             status,
                             napi::Status::Ok,
                             "Failed to call on_test_suite_completed_callback with status: {status}"
                         );
-                    }
-                ),
-            ));
+                            },
+                        ),
+                    )
+                })
+                .await
+                .expect("Failed to join test runner thread"));
 
             deferred.resolve(move |_env| Ok(()));
         });

package/src/solidity_tests/test_results.rs

@@ -22,6 +22,26 @@ use crate::{
     trace::{solidity_stack_trace::SolidityStackTraceEntry, u256_to_bigint},
 };
 
+/// A grouping of value snapshot entries for a test.
+#[napi(object)]
+#[derive(Clone, Debug)]
+pub struct ValueSnapshotGroup {
+    /// The group name.
+    pub name: String,
+    /// The entries in the group.
+    pub entries: Vec<ValueSnapshotEntry>,
+}
+
+/// An entry in a value snapshot group.
+#[napi(object)]
+#[derive(Clone, Debug)]
+pub struct ValueSnapshotEntry {
+    /// The name of the entry.
+    pub name: String,
+    /// The value of the entry.
+    pub value: String,
+}
+
 /// See [edr_solidity_tests::result::SuiteResult]
 #[napi]
 #[derive(Clone, Debug)]
@@ -85,6 +105,12 @@ pub struct TestResult {
     /// See [edr_solidity_tests::result::TestResult::duration]
     #[napi(readonly)]
     pub duration_ns: BigInt,
+    /// Groups of value snapshot entries (incl. gas).
+    ///
+    /// Only present if the test runner collected scoped snapshots. Currently,
+    /// this is always the case.
+    #[napi(readonly)]
+    pub value_snapshot_groups: Option<Vec<ValueSnapshotGroup>>,
 
     stack_trace_result: Option<Arc<StackTraceResult<String>>>,
     call_trace_arenas: Vec<(traces::TraceKind, SparsedTraceArena)>,
@@ -264,6 +290,19 @@ impl TestResult {
                 }),
             },
             duration_ns: BigInt::from(test_result.duration.as_nanos()),
+            value_snapshot_groups: Some(
+                test_result
+                    .value_snapshots
+                    .into_iter()
+                    .map(|(group_name, entries)| ValueSnapshotGroup {
+                        name: group_name,
+                        entries: entries
+                            .into_iter()
+                            .map(|(name, value)| ValueSnapshotEntry { name, value })
+                            .collect(),
+                    })
+                    .collect(),
+            ),
             stack_trace_result: test_result.stack_trace_result.map(Arc::new),
             call_trace_arenas: if include_trace {
                 test_result.traces
@@ -431,9 +470,10 @@ pub struct CallTrace {
     pub gas_used: BigInt,
     /// The amount of native token that was included with the call.
     pub value: BigInt,
-    /// The target of the call. Provided as a contract name if known, otherwise
-    /// a checksum address.
-    pub contract: String,
+    /// The target address of the call.
+    pub address: String,
+    /// The name of the contract that is the target of the call, if known.
+    pub contract: Option<String>,
     /// The input (calldata) to the call. If it encodes a known function call,
     /// it will be decoded into the function name and a list of arguments.
     /// For example, `{ name: "ownerOf", arguments: ["1"] }`. Note that the
@@ -502,12 +542,8 @@ 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()
-            .unwrap_or(node.trace.address.to_checksum(None));
+        let contract = node.trace.decoded.label.clone();
+        let address = node.trace.address.to_checksum(None);
 
         let inputs = match &node.trace.decoded.call_data {
             Some(traces::DecodedCallData { signature, args }) => {
@@ -540,6 +576,7 @@ impl CallTrace {
             gas_used: node.trace.gas_used.into(),
             value: u256_to_bigint(&node.trace.value),
             contract,
+            address,
             inputs,
             outputs,
             children,

package/src/ts/solidity_tests.ts

@@ -0,0 +1,46 @@
+import { StandardTestKind, FuzzTestKind, InvariantTestKind } from "../../index";
+
+export enum SortOrder {
+  Ascending,
+  Descending,
+}
+
+export interface GasUsageFilter {
+  minThreshold?: bigint;
+  maxThreshold?: bigint;
+}
+
+export function extractGasUsage(
+  testResults: {
+    name: string;
+    kind: StandardTestKind | FuzzTestKind | InvariantTestKind;
+  }[],
+  filter?: GasUsageFilter,
+  ordering?: SortOrder
+): { name: string; gas: bigint }[] {
+  const gasUsage: { name: string; gas: bigint }[] = [];
+
+  for (const result of testResults) {
+    // Default to zero gas for invariant tests
+    const gas = "consumedGas" in result.kind
+      ? result.kind.consumedGas
+      : "medianGas" in result.kind
+        ? result.kind.medianGas
+        : BigInt(0);
+
+    if (
+      (!filter?.minThreshold || gas >= filter.minThreshold) &&
+      (!filter?.maxThreshold || gas <= filter.maxThreshold)
+    ) {
+      gasUsage.push({ name: result.name, gas });
+    }
+  }
+
+  if (ordering === SortOrder.Ascending) {
+    gasUsage.sort((a, b) => (a.gas < b.gas ? -1 : a.gas > b.gas ? 1 : 0));
+  } else if (ordering === SortOrder.Descending) {
+    gasUsage.sort((a, b) => (a.gas > b.gas ? -1 : a.gas < b.gas ? 1 : 0));
+  }
+
+  return gasUsage;
+}

package/Cargo.toml

@@ -1,92 +0,0 @@
-[package]
-name = "edr_napi"
-version.workspace = true
-edition.workspace = true
-
-[lib]
-crate-type = ["cdylib"]
-
-[dependencies]
-alloy-dyn-abi.workspace = true
-alloy-json-abi.workspace = true
-alloy-sol-types.workspace = true
-derive_more.workspace = true
-derive-where.workspace = true
-edr_coverage.workspace = true
-edr_defaults = { path = "../edr_defaults" }
-edr_eth = { path = "../edr_eth" }
-edr_evm = { path = "../edr_evm" }
-edr_generic = { path = "../edr_generic" }
-edr_instrument = { path = "../edr_instrument" }
-edr_napi_core = { path = "../edr_napi_core" }
-edr_op = { path = "../edr_op", optional = true }
-edr_provider = { path = "../edr_provider" }
-edr_rpc_client = { path = "../edr_rpc_client" }
-edr_scenarios = { version = "0.3.5", path = "../edr_scenarios", optional = true }
-edr_solidity = { version = "0.3.5", path = "../edr_solidity" }
-k256 = { version = "0.13.1", default-features = false, features = [
-    "arithmetic",
-    "ecdsa",
-    "pkcs8",
-] }
-mimalloc = { version = "0.1.39", default-features = false, features = [
-    "local_dynamic_tls",
-] }
-# The `async` feature ensures that a tokio runtime is available
-napi = { version = "2.16.17", default-features = false, features = [
-    "async",
-    "error_anyhow",
-    "napi8",
-    "serde-json",
-] }
-napi-derive = "2.16.13"
-rand = { version = "0.8.4", optional = true }
-semver = "1.0.22"
-serde.workspace = true
-serde_json.workspace = true
-static_assertions = "1.1.0"
-strum = { version = "0.26.0", features = ["derive"] }
-thiserror = { version = "1.0.37", default-features = false }
-tracing = { version = "0.1.37", default-features = false, features = ["std"] }
-tracing-flame = { version = "0.2.0", default-features = false, features = [
-    "smallvec",
-] }
-tracing-subscriber = { version = "0.3.18", default-features = false, features = [
-    "ansi",
-    "env-filter",
-    "fmt",
-    "parking_lot",
-    "smallvec",
-    "std",
-] }
-
-# Solidity tests
-edr_solidity_tests.workspace = true
-foundry-cheatcodes.workspace = true
-foundry-compilers.workspace = true
-edr_common.workspace = true
-tempfile = "3.10.1"
-
-[target.x86_64-unknown-linux-gnu.dependencies]
-openssl-sys = { version = "0.9.93", features = ["vendored"] }
-
-[target.x86_64-unknown-linux-musl.dependencies]
-openssl-sys = { version = "0.9.93", features = ["vendored"] }
-
-[target.aarch64-unknown-linux-gnu.dependencies]
-openssl-sys = { version = "0.9.93", features = ["vendored"] }
-
-[target.aarch64-unknown-linux-musl.dependencies]
-openssl-sys = { version = "0.9.93", features = ["vendored"] }
-
-[build-dependencies]
-napi-build = "2.0.1"
-
-[features]
-op = ["dep:edr_op"]
-scenarios = ["dep:edr_scenarios", "dep:rand"]
-tracing = ["edr_evm/tracing", "edr_napi_core/tracing", "edr_provider/tracing"]
-test-mock = []
-
-[lints]
-workspace = true

package/build.rs

@@ -1,3 +0,0 @@
-fn main() {
-    napi_build::setup();
-}