@nomicfoundation/edr 0.7.0 → 0.9.0

package/Cargo.toml

@@ -7,34 +7,28 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
-alloy-dyn-abi = { version = "0.7.6", default-features = false }
-alloy-json-abi = { version = "0.7.4", default-features = false }
 alloy-sol-types = { version = "0.5.1", default-features = false, features = ["std"] }
 ansi_term = { version = "0.12.1", default-features = false }
-crossbeam-channel = { version = "0.5.6", default-features = false }
 itertools = { version = "0.12.0", default-features = false }
-indexmap = { version = "2" }
 k256 = { version = "0.13.1", default-features = false, features = ["arithmetic", "ecdsa", "pkcs8", "precomputed-tables", "std"] }
-log = { version = "0.4.20", default-features = false }
 # The `async` feature ensures that a tokio runtime is available
 napi = { version = "2.16.11", default-features = false, features = ["async", "error_anyhow", "napi8", "serde-json"] }
 napi-derive = "2.16.11"
 edr_defaults = { version = "0.3.5", path = "../edr_defaults" }
-edr_evm = { version = "0.3.5", path = "../edr_evm", features = ["tracing"]}
+edr_evm = { version = "0.3.5", path = "../edr_evm", features = ["tracing"] }
 edr_eth = { version = "0.3.5", path = "../edr_eth" }
 edr_provider = { version = "0.3.5", path = "../edr_provider" }
 edr_rpc_eth = { version = "0.3.5", path = "../edr_rpc_eth" }
-edr_solidity ={ version = "0.3.5", path = "../edr_solidity" }
+edr_solidity = { version = "0.3.5", path = "../edr_solidity" }
+edr_scenarios = { version = "0.3.5", path = "../edr_scenarios", optional = true }
 serde_json = { version = "1.0.85", default-features = false, features = ["alloc"] }
 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"] }
-parking_lot = { version = "0.12.1", default-features = false }
-lazy_static = { version = "1.4.0", features = [] }
 rand = { version = "0.8.4", optional = true }
-semver = "1.0.22"
 serde = { version = "1.0.189", features = ["derive"] }
+static_assertions = "1.1.0"
 strum = { version = "0.26.0", features = ["derive"] }
 mimalloc = { version = "0.1.39", default-features = false, features = ["local_dynamic_tls"] }
 
@@ -55,7 +49,7 @@ napi-build = "2.0.1"
 
 [features]
 tracing = ["edr_evm/tracing", "edr_provider/tracing"]
-scenarios = ["rand"]
+scenarios = ["rand", "edr_scenarios"]
 
 [profile.release]
 lto = true

package/index.d.ts

@@ -42,6 +42,12 @@ export interface BlockOptions {
    * block (EIP-4788).
    */
   parentBeaconBlockRoot?: Buffer
+  /**
+   * The commitment hash calculated for a list of [EIP-7685] data requests.
+   *
+   * [EIP-7685]: https://eips.ethereum.org/EIPS/eip-7685
+   */
+  requestsHash?: Buffer
 }
 /** Information about the blob gas used in a block. */
 export interface BlobGas {
@@ -254,6 +260,27 @@ export interface ProviderConfig {
   /** The network ID of the blockchain */
   networkId: bigint
 }
+/** Tracing config for Solidity stack trace generation. */
+export interface TracingConfigWithBuffers {
+  /**
+   * Build information to use for decoding contracts. Either a Hardhat v2
+   * build info file that contains both input and output or a Hardhat v3
+   * build info file that doesn't contain output and a separate output file.
+   */
+  buildInfos?: Array<Uint8Array> | Array<BuildInfoAndOutput>
+  /** Whether to ignore contracts whose name starts with "Ignored". */
+  ignoreContracts?: boolean
+}
+/**
+ * Hardhat V3 build info where the compiler output is not part of the build
+ * info file.
+ */
+export interface BuildInfoAndOutput {
+  /** The build info input file */
+  buildInfo: Uint8Array
+  /** The build info output file */
+  output: Uint8Array
+}
 /** The possible reasons for successful termination of the EVM. */
 export const enum SuccessReason {
   /** The opcode `STOP` was called */
@@ -321,7 +348,9 @@ export const enum ExceptionalHalt {
   /** Aud data is smaller then already present data size. */
   EofAuxDataTooSmall = 15,
   /** EOF Subroutine stack overflow */
-  EOFFunctionStackOverflow = 16
+  EOFFunctionStackOverflow = 16,
+  /** Check for target address validity is only done inside subcall. */
+  InvalidEXTCALLTarget = 17
 }
 /** The result when the EVM terminates due to an exceptional halt. */
 export interface HaltResult {
@@ -595,7 +624,7 @@ export declare class EdrContext {
 /** A JSON-RPC provider for Ethereum. */
 export declare class Provider {
   /**Constructs a new provider with the provided configuration. */
-  static withConfig(context: EdrContext, config: ProviderConfig, loggerConfig: LoggerConfig, tracingConfig: any, subscriberCallback: (event: SubscriptionEvent) => void): Promise<Provider>
+  static withConfig(context: EdrContext, config: ProviderConfig, loggerConfig: LoggerConfig, tracingConfig: TracingConfigWithBuffers, 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nomicfoundation/edr",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "devDependencies": {
     "@napi-rs/cli": "^2.18.4",
     "@types/chai": "^4.2.0",
@@ -52,13 +52,13 @@
   "repository": "NomicFoundation/edr.git",
   "types": "index.d.ts",
   "dependencies": {
-    "@nomicfoundation/edr-darwin-arm64": "0.7.0",
-    "@nomicfoundation/edr-darwin-x64": "0.7.0",
-    "@nomicfoundation/edr-linux-arm64-gnu": "0.7.0",
-    "@nomicfoundation/edr-linux-arm64-musl": "0.7.0",
-    "@nomicfoundation/edr-linux-x64-gnu": "0.7.0",
-    "@nomicfoundation/edr-linux-x64-musl": "0.7.0",
-    "@nomicfoundation/edr-win32-x64-msvc": "0.7.0"
+    "@nomicfoundation/edr-darwin-arm64": "0.9.0",
+    "@nomicfoundation/edr-darwin-x64": "0.9.0",
+    "@nomicfoundation/edr-linux-arm64-gnu": "0.9.0",
+    "@nomicfoundation/edr-linux-arm64-musl": "0.9.0",
+    "@nomicfoundation/edr-linux-x64-gnu": "0.9.0",
+    "@nomicfoundation/edr-linux-x64-musl": "0.9.0",
+    "@nomicfoundation/edr-win32-x64-msvc": "0.9.0"
   },
   "scripts": {
     "artifacts": "napi artifacts",

package/src/account.rs

@@ -1,14 +1,22 @@
-use edr_eth::signature::secret_key_from_str;
-use napi::{bindgen_prelude::BigInt, Status};
+use std::fmt::{Debug, Display};
+
+#[allow(deprecated)]
+// This is the only source file in production code where it's allowed to create
+// `DangerousSecretKeyStr`.
+use edr_eth::signature::{secret_key_from_str, DangerousSecretKeyStr};
+use napi::{bindgen_prelude::BigInt, JsString, Status};
 use napi_derive::napi;
+use serde::Serialize;
 
 use crate::cast::TryCast;
 
 /// An account that needs to be created during the genesis block.
 #[napi(object)]
 pub struct GenesisAccount {
+    // Using JsString here as it doesn't have `Debug`, `Display` and `Serialize` implementation
+    // which prevents accidentally leaking the secret keys to error messages and logs.
     /// Account secret key
-    pub secret_key: String,
+    pub secret_key: JsString,
     /// Account balance
     pub balance: BigInt,
 }
@@ -17,7 +25,17 @@ impl TryFrom<GenesisAccount> for edr_provider::AccountConfig {
     type Error = napi::Error;
 
     fn try_from(value: GenesisAccount) -> Result<Self, Self::Error> {
-        let secret_key = secret_key_from_str(&value.secret_key)
+        static_assertions::assert_not_impl_all!(JsString: Debug, Display, Serialize);
+        // `k256::SecretKey` has `Debug` implementation, but it's opaque (only shows the
+        // type name)
+        static_assertions::assert_not_impl_any!(k256::SecretKey: Display, Serialize);
+
+        let secret_key = value.secret_key.into_utf8()?;
+        // This is the only place in production code where it's allowed to use
+        // `DangerousSecretKeyStr`.
+        #[allow(deprecated)]
+        let secret_key_str = DangerousSecretKeyStr(secret_key.as_str()?);
+        let secret_key: k256::SecretKey = secret_key_from_str(secret_key_str)
             .map_err(|e| napi::Error::new(Status::InvalidArg, e.to_string()))?;
 
         Ok(Self {

package/src/block.rs

@@ -35,6 +35,10 @@ pub struct BlockOptions {
     /// The hash tree root of the parent beacon block for the given execution
     /// block (EIP-4788).
     pub parent_beacon_block_root: Option<Buffer>,
+    /// The commitment hash calculated for a list of [EIP-7685] data requests.
+    ///
+    /// [EIP-7685]: https://eips.ethereum.org/EIPS/eip-7685
+    pub requests_hash: Option<Buffer>,
 }
 
 impl TryFrom<BlockOptions> for edr_eth::block::BlockOptions {
@@ -92,6 +96,10 @@ impl TryFrom<BlockOptions> for edr_eth::block::BlockOptions {
                 .parent_beacon_block_root
                 .map(TryCast::<B256>::try_cast)
                 .transpose()?,
+            requests_hash: value
+                .requests_hash
+                .map(TryCast::<B256>::try_cast)
+                .transpose()?,
         })
     }
 }

package/src/provider.rs

@@ -5,7 +5,9 @@ use std::sync::Arc;
 use edr_provider::{time::CurrentTime, InvalidRequestReason};
 use edr_rpc_eth::jsonrpc;
 use edr_solidity::contract_decoder::ContractDecoder;
-use napi::{tokio::runtime, Either, Env, JsFunction, JsObject, Status};
+use napi::{
+    bindgen_prelude::Uint8Array, tokio::runtime, Either, Env, JsFunction, JsObject, Status,
+};
 use napi_derive::napi;
 
 use self::config::ProviderConfig;
@@ -37,7 +39,7 @@ impl Provider {
         _context: &EdrContext,
         config: ProviderConfig,
         logger_config: LoggerConfig,
-        tracing_config: serde_json::Value,
+        tracing_config: TracingConfigWithBuffers,
         #[napi(ts_arg_type = "(event: SubscriptionEvent) => void")] subscriber_callback: JsFunction,
     ) -> napi::Result<JsObject> {
         let runtime = runtime::Handle::current();
@@ -45,8 +47,9 @@ impl Provider {
         let config = edr_provider::ProviderConfig::try_from(config)?;
 
         // TODO https://github.com/NomicFoundation/edr/issues/760
-        let build_info_config: edr_solidity::contract_decoder::BuildInfoConfig =
-            serde_json::from_value(tracing_config)?;
+        let build_info_config =
+            edr_solidity::artifacts::BuildInfoConfig::parse_from_buffers((&tracing_config).into())
+                .map_err(|err| napi::Error::from_reason(err.to_string()))?;
         let contract_decoder = ContractDecoder::new(&build_info_config)
             .map_err(|error| napi::Error::from_reason(error.to_string()))?;
         let contract_decoder = Arc::new(contract_decoder);
@@ -245,6 +248,66 @@ impl Provider {
     }
 }
 
+/// Tracing config for Solidity stack trace generation.
+#[napi(object)]
+pub struct TracingConfigWithBuffers {
+    /// Build information to use for decoding contracts. Either a Hardhat v2
+    /// build info file that contains both input and output or a Hardhat v3
+    /// build info file that doesn't contain output and a separate output file.
+    pub build_infos: Option<Either<Vec<Uint8Array>, Vec<BuildInfoAndOutput>>>,
+    /// Whether to ignore contracts whose name starts with "Ignored".
+    pub ignore_contracts: Option<bool>,
+}
+
+/// Hardhat V3 build info where the compiler output is not part of the build
+/// info file.
+#[napi(object)]
+pub struct BuildInfoAndOutput {
+    /// The build info input file
+    pub build_info: Uint8Array,
+    /// The build info output file
+    pub output: Uint8Array,
+}
+
+impl<'a> From<&'a BuildInfoAndOutput>
+    for edr_solidity::artifacts::BuildInfoBufferSeparateOutput<'a>
+{
+    fn from(value: &'a BuildInfoAndOutput) -> Self {
+        Self {
+            build_info: value.build_info.as_ref(),
+            output: value.output.as_ref(),
+        }
+    }
+}
+
+impl<'a> From<&'a TracingConfigWithBuffers>
+    for edr_solidity::artifacts::BuildInfoConfigWithBuffers<'a>
+{
+    fn from(value: &'a TracingConfigWithBuffers) -> Self {
+        use edr_solidity::artifacts::{BuildInfoBufferSeparateOutput, BuildInfoBuffers};
+
+        let build_infos = value.build_infos.as_ref().map(|infos| match infos {
+            Either::A(with_output) => BuildInfoBuffers::WithOutput(
+                with_output
+                    .iter()
+                    .map(std::convert::AsRef::as_ref)
+                    .collect(),
+            ),
+            Either::B(separate_output) => BuildInfoBuffers::SeparateInputOutput(
+                separate_output
+                    .iter()
+                    .map(BuildInfoBufferSeparateOutput::from)
+                    .collect(),
+            ),
+        });
+
+        Self {
+            build_infos,
+            ignore_contracts: value.ignore_contracts,
+        }
+    }
+}
+
 #[derive(Debug)]
 struct SolidityTraceData {
     trace: Arc<edr_evm::trace::Trace>,

package/src/result.rs

@@ -106,6 +106,8 @@ pub enum ExceptionalHalt {
     EofAuxDataTooSmall,
     /// EOF Subroutine stack overflow
     EOFFunctionStackOverflow,
+    /// Check for target address validity is only done inside subcall.
+    InvalidEXTCALLTarget,
 }
 
 impl From<edr_evm::HaltReason> for ExceptionalHalt {
@@ -136,6 +138,7 @@ impl From<edr_evm::HaltReason> for ExceptionalHalt {
             edr_evm::HaltReason::EOFFunctionStackOverflow => {
                 ExceptionalHalt::EOFFunctionStackOverflow
             }
+            edr_evm::HaltReason::InvalidEXTCALLTarget => ExceptionalHalt::InvalidEXTCALLTarget,
             edr_evm::HaltReason::OverflowPayment
             | edr_evm::HaltReason::StateChangeDuringStaticCall
             | edr_evm::HaltReason::CallNotAllowedInsideStatic
@@ -167,6 +170,7 @@ impl From<ExceptionalHalt> for edr_evm::HaltReason {
             ExceptionalHalt::EofAuxDataOverflow => Self::EofAuxDataOverflow,
             ExceptionalHalt::EofAuxDataTooSmall => Self::EofAuxDataTooSmall,
             ExceptionalHalt::EOFFunctionStackOverflow => Self::EOFFunctionStackOverflow,
+            ExceptionalHalt::InvalidEXTCALLTarget => Self::InvalidEXTCALLTarget,
         }
     }
 }

package/src/scenarios.rs

@@ -8,8 +8,8 @@ use serde::Serialize;
 const SCENARIO_FILE_PREFIX: &str = "EDR_SCENARIO_PREFIX";
 
 #[derive(Clone, Debug, Serialize)]
-struct ScenarioConfig<'a> {
-    provider_config: &'a edr_provider::ProviderConfig,
+struct ScenarioConfig {
+    provider_config: edr_scenarios::ScenarioProviderConfig,
     logger_enabled: bool,
 }
 
@@ -32,7 +32,7 @@ pub(crate) async fn scenario_file(
             File::create(format!("{scenario_prefix}_{timestamp}_{suffix}.json")).await?;
 
         let config = ScenarioConfig {
-            provider_config,
+            provider_config: provider_config.clone().into(),
             logger_enabled,
         };
         let mut line = serde_json::to_string(&config)?;