.changeset/olive-kiwis-guess.md

@@ -0,0 +1,5 @@
+---
+"@nomicfoundation/hardhat-verify": patch
+---
+
+Updated polygonZkEVMTestnet to point to cardona testnet

.github/workflows/edr-npm-release.yml

@@ -360,6 +360,7 @@ jobs:
   check_commit:
     name: Check commit
     runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request' || github.event.pull_request.author_association == 'OWNER' || github.event.pull_request.author_association == 'MEMBER' || github.event.pull_request.author_association == 'COLLABORATOR'
     steps:
       - uses: actions/checkout@v4
         with:
@@ -391,7 +392,7 @@ jobs:
       - test-linux-aarch64-gnu-binding
       - test-linux-aarch64-musl-binding
     # Only run workflow if the PR is merged to main and the commit message is a release commit.
-    if: ${{ needs.check_commit.outputs.match == 'true' && github.ref == 'refs/heads/main' }}
+    if: ${{ needs.check_commit.outputs.match == 'true' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/edr/release') }}
     defaults:
       run:
         working-directory: ./crates/edr_napi

.github/workflows/pre-release.yml

@@ -76,4 +76,4 @@ jobs:
           NODE_OPTIONS: "--max-old-space-size=4096"
         run: |
           pnpm build
-          pnpm test:forking
+          pnpm test:except-tracing

.github/workflows/test-recent-mainnet-block.yml

@@ -2,7 +2,7 @@ name: Run a recent full block in the Hardhat Network
 
 on:
   schedule:
-    - cron: "0 0 * * *"
+    - cron: "0 */8 * * *"
   workflow_dispatch:
 
 defaults:
@@ -35,10 +35,9 @@ jobs:
         uses: actions-rs/cargo@v1
         env:
           RUSTFLAGS: ${{ matrix.RUSTFLAGS }}
-          ALCHEMY_URL: ${{ secrets.ALCHEMY_URL }}
         with:
           command: replay-block
-          args: -u $ALCHEMY_URL -c 1
+          args: -u ${{ secrets.ALCHEMY_URL }} -c 1
 
       - name: Notify failures
         if: failure()

.nvmrc

@@ -1 +1 @@
-16
+18

book/src/01_getting_started/04_benchmark.md

@@ -0,0 +1,64 @@
+# Benchmark
+
+We take two approaches to benchmarking EDR:
+
+1. Automated benchmarks using `criterion`
+2. Manual benchmarks using repositories of dependants
+
+## Automated
+
+## Manual
+
+To measure real-world performance, we use a build of [Hardhat](https://github.com/NomicFoundation/hardhat) with EDR in third-party projects.
+To make a local build of Hardhat available for linking in other packages, run:
+
+```bash
+cd packages/hardhat-core &&
+pnpm build &&
+npm link
+```
+
+For this example we will use [openzeppelin-contracts](https://github.com/OpenZeppelin/openzeppelin-contracts):
+
+```bash
+git clone https://github.com/OpenZeppelin/openzeppelin-contracts.git &&
+cd openzeppelin-contracts &&
+npm install
+```
+
+To use your local hardhat build in a third-party project, run:
+
+```bash
+npm link hardhat
+```
+
+To validate that this worked, you can run:
+
+```bash
+file node_modules/hardhat
+```
+
+The expected output will look similar to this:
+
+```bash
+node_modules/hardhat: symbolic link to ../../hardhat/packages/hardhat-core
+```
+
+To prevent the benchmark from being tainted by smart contract compilation, we first run:
+
+```bash
+npx hardhat compile
+```
+
+Finally, to benchmark the third-party project, we time its test suite.
+For example:
+
+```bash
+time npx hardhat test
+```
+
+Resulting in output similar to:
+
+```bash
+npx hardhat test  68.99s user 9.59s system 130% cpu 1:00.40 total
+```

book/src/01_getting_started/05_profiling.md

@@ -0,0 +1,26 @@
+# Profiling
+
+```bash
+pnpm build:tracing
+```
+
+When you now run `edr`, it will generate a `tracing.folded` file in the current working directory.
+Once the profiling run has completed, we can use [`inferno`](https://docs.rs/tracing-flame/latest/tracing_flame/#generating-the-image) to generate flamegraphs from the collected data.
+To install `inferno`, run:
+
+```bash
+cargo install inferno
+```
+
+When we want to analyze the run with its exact order preserved, run:
+
+```bash
+cat tracing.folded | inferno-flamegraph --flamechart > tracing-flamechart.svg
+```
+
+
+Alternatively, when we don't care about those details, a flamegraph with identical stack frames collapsed can be generated by running:
+
+```bash
+cat tracing.folded | inferno-flamegraph > tracing-flamegraph.svg
+```

crates/edr_napi/README.md

@@ -0,0 +1,6 @@
+# EDR - Ethereum Development Runtime
+
+**EDR**, or **Ethereum Development Runtime** in full, is a library for creating developer tooling on top of the Ethereum Virtual Machine (EVM), such as an EVM debugger or state inspector.
+EDR provides a performant API, written in Rust, with bindings for the Node API (TypeScript).
+
+At the moment, EDR is only meant to be consumed from [Hardhat](https://hardhat.org/), but we plan to have a stable API that can be used from any other tooling. If you are interested in this, please reach out.

crates/edr_napi/index.js

@@ -237,6 +237,49 @@ switch (platform) {
           loadError = e
         }
         break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'edr.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./edr.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@nomicfoundation/edr-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'edr.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./edr.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@nomicfoundation/edr-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'edr.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./edr.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@nomicfoundation/edr-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
       default:
         throw new Error(`Unsupported architecture on Linux: ${arch}`)
     }

crates/edr_napi/package.json

@@ -1,8 +1,15 @@
 {
   "name": "@nomicfoundation/edr",
-  "version": "0.2.0-alpha.2",
+  "version": "0.2.1",
   "main": "index.js",
   "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "Cargo.toml",
+    "build.rs",
+    "src/"
+  ],
   "repository": {
     "url": "https://github.com/NomicFoundation/hardhat.git",
     "type": "git"
@@ -26,7 +33,7 @@
     "@types/chai": "^4.2.0",
     "@types/chai-as-promised": "^7.1.8",
     "@types/mocha": ">=9.1.0",
-    "@types/node": "^16.0.0",
+    "@types/node": "^18.0.0",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
     "mocha": "^10.0.0",

crates/edr_napi/src/logger.rs

@@ -410,11 +410,9 @@ impl LogCollector {
 
             logger.log_console_log_messages(console_log_inputs);
 
-            if let Some(transaction_failure) = TransactionFailure::from_execution_result(
-                execution_result,
-                transaction.hash(),
-                trace,
-            ) {
+            if let Some(transaction_failure) =
+                TransactionFailure::from_execution_result(execution_result, None, trace)
+            {
                 logger.log_transaction_failure(&transaction_failure);
             }
         });
@@ -782,7 +780,7 @@ impl LogCollector {
 
             let transaction_failure = edr_provider::TransactionFailure::from_execution_result(
                 result,
-                transaction_hash,
+                Some(transaction_hash),
                 trace,
             );
 
@@ -1158,7 +1156,7 @@ impl LogCollector {
 
             let transaction_failure = edr_provider::TransactionFailure::from_execution_result(
                 transaction_result,
-                transaction_hash,
+                Some(transaction_hash),
                 trace,
             );
 

crates/edr_provider/src/data.rs

@@ -7,6 +7,7 @@ use std::{
     cmp,
     cmp::Ordering,
     collections::BTreeMap,
+    ffi::OsString,
     fmt::Debug,
     num::NonZeroUsize,
     sync::Arc,
@@ -76,7 +77,8 @@ use crate::{
 };
 
 const DEFAULT_INITIAL_BASE_FEE_PER_GAS: u64 = 1_000_000_000;
-const MAX_CACHED_STATES: usize = 10;
+const EDR_MAX_CACHED_STATES_ENV_VAR: &str = "__EDR_MAX_CACHED_STATES";
+const DEFAULT_MAX_CACHED_STATES: usize = 10;
 
 /// The result of executing an `eth_call`.
 #[derive(Clone, Debug)]
@@ -112,6 +114,8 @@ pub enum CreationError {
     /// Invalid initial date
     #[error("The initial date configuration value {0:?} is before the UNIX epoch")]
     InvalidInitialDate(SystemTime),
+    #[error("Invalid max cached states environment variable value: '{0:?}'. Please provide a non-zero integer!")]
+    InvalidMaxCachedStates(OsString),
     /// An error that occurred while constructing a local blockchain.
     #[error(transparent)]
     LocalBlockchainCreation(#[from] LocalCreationError),
@@ -183,8 +187,19 @@ impl<LoggerErrorT: Debug> ProviderData<LoggerErrorT> {
             next_block_base_fee_per_gas,
         } = create_blockchain_and_state(runtime_handle.clone(), &config, genesis_accounts)?;
 
-        let mut block_state_cache =
-            LruCache::new(NonZeroUsize::new(MAX_CACHED_STATES).expect("constant is non-zero"));
+        let max_cached_states = std::env::var(EDR_MAX_CACHED_STATES_ENV_VAR).map_or_else(
+            |err| match err {
+                std::env::VarError::NotPresent => {
+                    Ok(NonZeroUsize::new(DEFAULT_MAX_CACHED_STATES).expect("constant is non-zero"))
+                }
+                std::env::VarError::NotUnicode(s) => Err(CreationError::InvalidMaxCachedStates(s)),
+            },
+            |s| {
+                s.parse()
+                    .map_err(|_err| CreationError::InvalidMaxCachedStates(s.into()))
+            },
+        )?;
+        let mut block_state_cache = LruCache::new(max_cached_states);
         let mut block_number_to_state_id = BTreeMap::new();
 
         let current_state_id = StateId::default();
@@ -608,7 +623,6 @@ impl<LoggerErrorT: Debug> ProviderData<LoggerErrorT> {
         // Minimum gas cost that is required for transaction to be included in
         // a block
         let minimum_cost = transaction.initial_cost(self.spec_id());
-        let transaction_hash = *transaction.hash();
         let tx_env: TxEnv = transaction.into();
 
         let state_overrides = StateOverrides::default();
@@ -639,16 +653,12 @@ impl<LoggerErrorT: Debug> ProviderData<LoggerErrorT> {
 
             let mut initial_estimation = match result {
                 ExecutionResult::Success { gas_used, .. } => Ok(gas_used),
-                ExecutionResult::Revert { output, .. } => Err(TransactionFailure::revert(
-                    output,
-                    transaction_hash,
-                    trace.clone(),
-                )),
-                ExecutionResult::Halt { reason, .. } => Err(TransactionFailure::halt(
-                    reason,
-                    transaction_hash,
-                    trace.clone(),
-                )),
+                ExecutionResult::Revert { output, .. } => {
+                    Err(TransactionFailure::revert(output, None, trace.clone()))
+                }
+                ExecutionResult::Halt { reason, .. } => {
+                    Err(TransactionFailure::halt(reason, None, trace.clone()))
+                }
             }
             .map_err(|failure| EstimateGasFailure {
                 console_log_inputs: inspector.into_console_log_encoded_messages(),
@@ -3721,6 +3731,13 @@ mod tests {
             chain_id: 1,
             url: get_alchemy_url(),
         },
+        // This block contains a sequence of transaction that first raise
+        // an empty account's balance and then decrease it
+        mainnet_19318016 => {
+            block_number: 19_318_016,
+            chain_id: 1,
+            url: get_alchemy_url(),
+        },
         // This block has both EIP-2930 and EIP-1559 transactions
         goerli_merge => {
             block_number: 7_728_449,