@nomicfoundation/edr 0.2.0-alpha.2 → 0.2.0

package/Cargo.toml

@@ -27,6 +27,8 @@ tracing-flame = { version = "0.2.0", default-features = false, features = ["smal
 tracing-subscriber = { version = "0.3.18", default-features = false, features = ["ansi", "env-filter", "fmt", "parking_lot", "smallvec", "std"] }
 parking_lot = { version = "0.12.1", default-features = false }
 lazy_static = { version = "1.4.0", features = [] }
+rand = { version = "0.8.4", optional = true }
+serde = { version = "1.0.189", features = ["derive"] }
 
 [target.x86_64-unknown-linux-gnu.dependencies]
 openssl-sys = { version = "0.9.93", features = ["vendored"] }
@@ -45,6 +47,7 @@ napi-build = "2.0.1"
 
 [features]
 tracing = ["edr_evm/tracing"]
+scenarios = ["rand"]
 
 [profile.release]
 lto = true

package/index.d.ts

@@ -33,8 +33,10 @@ export interface BlockOptions {
   nonce?: Buffer
   /** The block's base gas fee */
   baseFee?: bigint
-  /** The block's withdrawals root */
-  withdrawalsRoot?: Buffer
+  /** The block's withdrawals */
+  withdrawals?: Array<Withdrawal>
+  /** Blob gas was added by EIP-4844 and is ignored in older headers. */
+  blobGas?: BlobGas
   /**
    * The hash tree root of the parent beacon block for the given execution
    * block (EIP-4788).
@@ -56,6 +58,11 @@ export interface BlobGas {
    */
   excessGas: bigint
 }
+/** The result of executing a call override. */
+export interface CallOverrideResult {
+  result: Buffer
+  shouldRevert: boolean
+}
 /** Identifier for the Ethereum spec. */
 export const enum SpecId {
   /** Frontier */
@@ -362,6 +369,16 @@ export interface TracingMessageResult {
   /** Execution result */
   readonly executionResult: ExecutionResult
 }
+export interface Withdrawal {
+  /** The index of withdrawal */
+  index: bigint
+  /** The index of the validator that generated the withdrawal */
+  validatorIndex: bigint
+  /** The recipient address for withdrawal value */
+  address: Buffer
+  /** The value contained in withdrawal */
+  amount: bigint
+}
 export class EdrContext {
   /**Creates a new [`EdrContext`] instance. Should only be called once! */
   constructor()
@@ -372,6 +389,7 @@ export class Provider {
   static withConfig(context: EdrContext, config: ProviderConfig, loggerConfig: LoggerConfig, subscriberCallback: (event: SubscriptionEvent) => void): Promise<Provider>
   /**Handles a JSON-RPC request and returns a JSON-RPC response. */
   handleRequest(jsonRequest: string): Promise<Response>
+  setCallOverrideCallback(callOverrideCallback: (contract_address: Buffer, data: Buffer) => Promise<CallOverrideResult | undefined>): void
 }
 export class Response {
   get json(): string

package/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}`)
     }

package/npm/darwin-arm64/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/NomicFoundation/hardhat.git",
     "type": "git"
   },
-  "version": "0.2.0-alpha.2",
+  "version": "0.2.0",
   "os": [
     "darwin"
   ],

package/npm/darwin-x64/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/NomicFoundation/hardhat.git",
     "type": "git"
   },
-  "version": "0.2.0-alpha.2",
+  "version": "0.2.0",
   "os": [
     "darwin"
   ],

package/npm/linux-arm64-gnu/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/NomicFoundation/hardhat.git",
     "type": "git"
   },
-  "version": "0.2.0-alpha.2",
+  "version": "0.2.0",
   "os": [
     "linux"
   ],

package/npm/linux-arm64-musl/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/NomicFoundation/hardhat.git",
     "type": "git"
   },
-  "version": "0.2.0-alpha.2",
+  "version": "0.2.0",
   "os": [
     "linux"
   ],

package/npm/linux-x64-gnu/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/NomicFoundation/hardhat.git",
     "type": "git"
   },
-  "version": "0.2.0-alpha.2",
+  "version": "0.2.0",
   "os": [
     "linux"
   ],

package/npm/linux-x64-musl/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/NomicFoundation/hardhat.git",
     "type": "git"
   },
-  "version": "0.2.0-alpha.2",
+  "version": "0.2.0",
   "os": [
     "linux"
   ],

package/npm/win32-arm64-msvc/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/NomicFoundation/hardhat.git",
     "type": "git"
   },
-  "version": "0.2.0-alpha.2",
+  "version": "0.2.0",
   "os": [
     "win32"
   ],

package/npm/win32-ia32-msvc/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/NomicFoundation/hardhat.git",
     "type": "git"
   },
-  "version": "0.2.0-alpha.2",
+  "version": "0.2.0",
   "os": [
     "win32"
   ],

package/npm/win32-x64-msvc/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/NomicFoundation/hardhat.git",
     "type": "git"
   },
-  "version": "0.2.0-alpha.2",
+  "version": "0.2.0",
   "os": [
     "win32"
   ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nomicfoundation/edr",
-  "version": "0.2.0-alpha.2",
+  "version": "0.2.0",
   "main": "index.js",
   "types": "index.d.ts",
   "repository": {
@@ -26,7 +26,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",
@@ -36,21 +36,22 @@
     "node": ">= 18"
   },
   "optionalDependencies": {
-    "@nomicfoundation/edr-win32-x64-msvc": "0.2.0-alpha.2",
-    "@nomicfoundation/edr-darwin-x64": "0.2.0-alpha.2",
-    "@nomicfoundation/edr-linux-x64-gnu": "0.2.0-alpha.2",
-    "@nomicfoundation/edr-darwin-arm64": "0.2.0-alpha.2",
-    "@nomicfoundation/edr-win32-arm64-msvc": "0.2.0-alpha.2",
-    "@nomicfoundation/edr-linux-arm64-gnu": "0.2.0-alpha.2",
-    "@nomicfoundation/edr-linux-arm64-musl": "0.2.0-alpha.2",
-    "@nomicfoundation/edr-linux-x64-musl": "0.2.0-alpha.2",
-    "@nomicfoundation/edr-win32-ia32-msvc": "0.2.0-alpha.2"
+    "@nomicfoundation/edr-win32-x64-msvc": "0.2.0",
+    "@nomicfoundation/edr-darwin-x64": "0.2.0",
+    "@nomicfoundation/edr-linux-x64-gnu": "0.2.0",
+    "@nomicfoundation/edr-darwin-arm64": "0.2.0",
+    "@nomicfoundation/edr-win32-arm64-msvc": "0.2.0",
+    "@nomicfoundation/edr-linux-arm64-gnu": "0.2.0",
+    "@nomicfoundation/edr-linux-arm64-musl": "0.2.0",
+    "@nomicfoundation/edr-linux-x64-musl": "0.2.0",
+    "@nomicfoundation/edr-win32-ia32-msvc": "0.2.0"
   },
   "scripts": {
     "artifacts": "napi artifacts",
     "build": "napi build --platform --release",
     "build:debug": "napi build --platform",
     "build:tracing": "napi build --release --features tracing",
+    "build:scenarios": "napi build --release --features scenarios",
     "universal": "napi universal",
     "version": "napi version",
     "pretest": "pnpm build",

package/src/block.rs

@@ -2,7 +2,7 @@ use edr_eth::{Address, Bytes, B256, B64};
 use napi::bindgen_prelude::{BigInt, Buffer};
 use napi_derive::napi;
 
-use crate::cast::TryCast;
+use crate::{cast::TryCast, withdrawal::Withdrawal};
 
 #[napi(object)]
 pub struct BlockOptions {
@@ -28,8 +28,10 @@ pub struct BlockOptions {
     pub nonce: Option<Buffer>,
     /// The block's base gas fee
     pub base_fee: Option<BigInt>,
-    /// The block's withdrawals root
-    pub withdrawals_root: Option<Buffer>,
+    /// The block's withdrawals
+    pub withdrawals: Option<Vec<Withdrawal>>,
+    /// Blob gas was added by EIP-4844 and is ignored in older headers.
+    pub blob_gas: Option<BlobGas>,
     /// The hash tree root of the parent beacon block for the given execution
     /// block (EIP-4788).
     pub parent_beacon_block_root: Option<Buffer>,
@@ -73,9 +75,18 @@ impl TryFrom<BlockOptions> for edr_eth::block::BlockOptions {
             base_fee: value
                 .base_fee
                 .map_or(Ok(None), |basefee| basefee.try_cast().map(Some))?,
-            withdrawals_root: value
-                .withdrawals_root
-                .map(TryCast::<B256>::try_cast)
+            withdrawals: value
+                .withdrawals
+                .map(|withdrawals| {
+                    withdrawals
+                        .into_iter()
+                        .map(edr_eth::withdrawal::Withdrawal::try_from)
+                        .collect()
+                })
+                .transpose()?,
+            blob_gas: value
+                .blob_gas
+                .map(edr_eth::block::BlobGas::try_from)
                 .transpose()?,
             parent_beacon_block_root: value
                 .parent_beacon_block_root

package/src/call_override.rs

@@ -0,0 +1,102 @@
+use std::sync::mpsc::{channel, Sender};
+
+use edr_eth::{Address, Bytes};
+use napi::{bindgen_prelude::Buffer, Env, JsFunction, NapiRaw, Status};
+use napi_derive::napi;
+
+use crate::{
+    cast::TryCast,
+    sync::{await_promise, handle_error},
+    threadsafe_function::{ThreadSafeCallContext, ThreadsafeFunction, ThreadsafeFunctionCallMode},
+};
+
+/// The result of executing a call override.
+#[napi(object)]
+pub struct CallOverrideResult {
+    pub result: Buffer,
+    pub should_revert: bool,
+}
+
+impl TryCast<Option<edr_provider::CallOverrideResult>> for Option<CallOverrideResult> {
+    type Error = napi::Error;
+
+    fn try_cast(self) -> Result<Option<edr_provider::CallOverrideResult>, Self::Error> {
+        match self {
+            None => Ok(None),
+            Some(result) => Ok(Some(edr_provider::CallOverrideResult {
+                result: result.result.try_cast()?,
+                should_revert: result.should_revert,
+            })),
+        }
+    }
+}
+
+struct CallOverrideCall {
+    contract_address: Address,
+    data: Bytes,
+    sender: Sender<napi::Result<Option<edr_provider::CallOverrideResult>>>,
+}
+
+#[derive(Clone)]
+pub struct CallOverrideCallback {
+    call_override_callback_fn: ThreadsafeFunction<CallOverrideCall>,
+}
+
+impl CallOverrideCallback {
+    pub fn new(env: &Env, call_override_callback: JsFunction) -> napi::Result<Self> {
+        let call_override_callback_fn = ThreadsafeFunction::create(
+            env.raw(),
+            // SAFETY: The callback is guaranteed to be valid for the lifetime of the inspector.
+            unsafe { call_override_callback.raw() },
+            0,
+            |ctx: ThreadSafeCallContext<CallOverrideCall>| {
+                let address = ctx
+                    .env
+                    .create_buffer_with_data(ctx.value.contract_address.to_vec())?
+                    .into_raw();
+
+                let data = ctx
+                    .env
+                    .create_buffer_with_data(ctx.value.data.to_vec())?
+                    .into_raw();
+
+                let sender = ctx.value.sender.clone();
+                let promise = ctx.callback.call(None, &[address, data])?;
+                let result = await_promise::<
+                    Option<CallOverrideResult>,
+                    Option<edr_provider::CallOverrideResult>,
+                >(ctx.env, promise, ctx.value.sender);
+
+                handle_error(sender, result)
+            },
+        )?;
+
+        Ok(Self {
+            call_override_callback_fn,
+        })
+    }
+
+    pub fn call_override(
+        &self,
+        contract_address: Address,
+        data: Bytes,
+    ) -> Option<edr_provider::CallOverrideResult> {
+        let (sender, receiver) = channel();
+
+        let status = self.call_override_callback_fn.call(
+            CallOverrideCall {
+                contract_address,
+                data,
+                sender,
+            },
+            ThreadsafeFunctionCallMode::Blocking,
+        );
+
+        assert_eq!(status, Status::Ok, "Call override callback failed");
+
+        receiver
+            .recv()
+            .unwrap()
+            .expect("Failed call to call_override_callback")
+    }
+}

package/src/cast.rs

@@ -1,4 +1,4 @@
-use edr_eth::{Address, B256, B64, U256};
+use edr_eth::{Address, Bytes, B256, B64, U256};
 use napi::{
     bindgen_prelude::{BigInt, Buffer},
     Status,
@@ -117,3 +117,19 @@ impl<T> TryCast<T> for T {
         Ok(self)
     }
 }
+
+impl TryCast<Bytes> for Buffer {
+    type Error = napi::Error;
+
+    fn try_cast(self) -> Result<Bytes, Self::Error> {
+        Ok(Bytes::copy_from_slice(&self))
+    }
+}
+
+impl TryCast<Option<Bytes>> for Option<Buffer> {
+    type Error = napi::Error;
+
+    fn try_cast(self) -> Result<Option<Bytes>, Self::Error> {
+        Ok(self.map(|buffer| Bytes::copy_from_slice(&buffer)))
+    }
+}

package/src/lib.rs

@@ -4,6 +4,7 @@
 
 mod account;
 mod block;
+mod call_override;
 mod cast;
 mod config;
 mod context;
@@ -12,7 +13,10 @@ mod log;
 mod logger;
 mod provider;
 mod result;
+#[cfg(feature = "scenarios")]
+mod scenarios;
 mod subscribe;
 mod sync;
 mod threadsafe_function;
 mod trace;
+mod withdrawal;

package/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,
             );
 

package/src/provider.rs

@@ -9,6 +9,7 @@ use napi_derive::napi;
 
 use self::config::ProviderConfig;
 use crate::{
+    call_override::CallOverrideCallback,
     context::EdrContext,
     logger::{Logger, LoggerConfig, LoggerError},
     subscribe::SubscriberCallback,
@@ -19,6 +20,8 @@ use crate::{
 #[napi]
 pub struct Provider {
     provider: Arc<edr_provider::Provider<LoggerError>>,
+    #[cfg(feature = "scenarios")]
+    scenario_file: Option<napi::tokio::sync::Mutex<napi::tokio::fs::File>>,
 }
 
 #[napi]
@@ -42,17 +45,27 @@ impl Provider {
 
         let (deferred, promise) = env.create_deferred()?;
         runtime.clone().spawn_blocking(move || {
+            #[cfg(feature = "scenarios")]
+            let scenario_file =
+                runtime::Handle::current().block_on(crate::scenarios::scenario_file(
+                    &config,
+                    edr_provider::Logger::is_enabled(&*logger),
+                ))?;
+
             let result = edr_provider::Provider::new(runtime, logger, subscriber_callback, config)
                 .map_or_else(
                     |error| Err(napi::Error::new(Status::GenericFailure, error.to_string())),
                     |provider| {
                         Ok(Provider {
                             provider: Arc::new(provider),
+                            #[cfg(feature = "scenarios")]
+                            scenario_file,
                         })
                     },
                 );
 
             deferred.resolve(|_env| result);
+            Ok::<_, napi::Error>(())
         });
 
         Ok(promise)
@@ -107,6 +120,11 @@ impl Provider {
             }
         };
 
+        #[cfg(feature = "scenarios")]
+        if let Some(scenario_file) = &self.scenario_file {
+            crate::scenarios::write_request(scenario_file, &request).await?;
+        }
+
         let mut response = runtime::Handle::current()
             .spawn_blocking(move || provider.handle_request(request))
             .await
@@ -149,6 +167,26 @@ impl Provider {
                 traces: traces.into_iter().map(Arc::new).collect(),
             })
     }
+
+    #[napi(ts_return_type = "void")]
+    pub fn set_call_override_callback(
+        &self,
+        env: Env,
+        #[napi(
+            ts_arg_type = "(contract_address: Buffer, data: Buffer) => Promise<CallOverrideResult | undefined>"
+        )]
+        call_override_callback: JsFunction,
+    ) -> napi::Result<()> {
+        let provider = self.provider.clone();
+
+        let call_override_callback = CallOverrideCallback::new(&env, call_override_callback)?;
+        let call_override_callback =
+            Arc::new(move |address, data| call_override_callback.call_override(address, data));
+
+        provider.set_call_override_callback(Some(call_override_callback));
+
+        Ok(())
+    }
 }
 
 #[napi]

package/src/scenarios.rs

@@ -0,0 +1,59 @@
+use std::time::{SystemTime, UNIX_EPOCH};
+
+use edr_provider::ProviderRequest;
+use napi::tokio::{fs::File, io::AsyncWriteExt, sync::Mutex};
+use rand::{distributions::Alphanumeric, Rng};
+use serde::Serialize;
+
+const SCENARIO_FILE_PREFIX: &str = "EDR_SCENARIO_PREFIX";
+
+#[derive(Clone, Debug, Serialize)]
+struct ScenarioConfig<'a> {
+    provider_config: &'a edr_provider::ProviderConfig,
+    logger_enabled: bool,
+}
+
+pub(crate) async fn scenario_file(
+    provider_config: &edr_provider::ProviderConfig,
+    logger_enabled: bool,
+) -> Result<Option<Mutex<File>>, napi::Error> {
+    if let Ok(scenario_prefix) = std::env::var(SCENARIO_FILE_PREFIX) {
+        let timestamp = SystemTime::now()
+            .duration_since(UNIX_EPOCH)
+            .expect("Time went backwards")
+            .as_secs();
+        let suffix = rand::thread_rng()
+            .sample_iter(&Alphanumeric)
+            .take(4)
+            .map(char::from)
+            .collect::<String>();
+
+        let mut scenario_file =
+            File::create(format!("{scenario_prefix}_{timestamp}_{suffix}.json")).await?;
+
+        let config = ScenarioConfig {
+            provider_config,
+            logger_enabled,
+        };
+        let mut line = serde_json::to_string(&config)?;
+        line.push('\n');
+        scenario_file.write_all(line.as_bytes()).await?;
+
+        Ok(Some(Mutex::new(scenario_file)))
+    } else {
+        Ok(None)
+    }
+}
+
+pub(crate) async fn write_request(
+    scenario_file: &Mutex<File>,
+    request: &ProviderRequest,
+) -> napi::Result<()> {
+    let mut line = serde_json::to_string(request)?;
+    line.push('\n');
+    {
+        let mut scenario_file = scenario_file.lock().await;
+        scenario_file.write_all(line.as_bytes()).await?;
+    }
+    Ok(())
+}

package/src/withdrawal.rs

@@ -0,0 +1,49 @@
+use edr_eth::Address;
+use napi::bindgen_prelude::{BigInt, Buffer};
+use napi_derive::napi;
+
+use crate::cast::TryCast;
+
+#[napi(object)]
+pub struct Withdrawal {
+    /// The index of withdrawal
+    pub index: BigInt,
+    /// The index of the validator that generated the withdrawal
+    pub validator_index: BigInt,
+    /// The recipient address for withdrawal value
+    pub address: Buffer,
+    /// The value contained in withdrawal
+    pub amount: BigInt,
+}
+
+impl From<edr_eth::withdrawal::Withdrawal> for Withdrawal {
+    fn from(withdrawal: edr_eth::withdrawal::Withdrawal) -> Self {
+        Self {
+            index: BigInt::from(withdrawal.index),
+            validator_index: BigInt::from(withdrawal.validator_index),
+            address: Buffer::from(withdrawal.address.as_slice()),
+            amount: BigInt {
+                sign_bit: false,
+                words: withdrawal.amount.as_limbs().to_vec(),
+            },
+        }
+    }
+}
+
+impl TryFrom<Withdrawal> for edr_eth::withdrawal::Withdrawal {
+    type Error = napi::Error;
+
+    fn try_from(value: Withdrawal) -> Result<Self, Self::Error> {
+        let index: u64 = BigInt::try_cast(value.index)?;
+        let validator_index: u64 = BigInt::try_cast(value.validator_index)?;
+        let amount = BigInt::try_cast(value.amount)?;
+        let address = Address::from_slice(&value.address);
+
+        Ok(Self {
+            index,
+            validator_index,
+            address,
+            amount,
+        })
+    }
+}