feat: add Optimism as separate N-API package

.cargo/config.toml

@@ -3,3 +3,7 @@ gen-execution-api       = "run --bin tools -- gen-execution-api"
 scenario                = "run --release --bin tools -- scenario"
 scenario-with-tracing   = "run --release --features tracing --bin tools -- scenario"
 replay-block            = "run --release --bin tools -- replay-block"
+
+# To be able to run unit tests on Linux, support compilation to 'x86_64-unknown-linux-gnu'.
+[target.'cfg(target_os = "linux")']
+rustflags = ["-C", "link-args=-Wl,--warn-unresolved-symbols"]

.github/workflows/edr-ci.yml

@@ -10,7 +10,6 @@ on:
   workflow_dispatch:
 
 env:
-  RUSTFLAGS: -Dwarnings
   RUSTDOCFLAGS: -Dwarnings
 
 concurrency:

crates/edr_napi/.cargo/config.toml

@@ -6,3 +6,7 @@ target-dir = "./target"
 [target.aarch64-unknown-linux-musl]
 linker = "aarch64-linux-musl-gcc"
 rustflags = ["-C", "target-feature=-crt-static"]
+
+# To be able to run unit tests on Linux, support compilation to 'x86_64-unknown-linux-gnu'.
+[target.'cfg(target_os = "linux")']
+rustflags = ["-C", "link-args=-Wl,--warn-unresolved-symbols"]

crates/edr_napi/Cargo.toml

@@ -4,18 +4,16 @@ version = "0.3.5"
 edition = "2021"
 
 [lib]
-crate-type = ["cdylib"]
+crate-type = ["cdylib", "lib"]
 
 [dependencies]
-ansi_term = { version = "0.12.1", default-features = false }
 derive-where = { version = "1.2.7", default-features = false }
 edr_eth = { path = "../edr_eth" }
 edr_evm = { path = "../edr_evm" }
 edr_generic = { path = "../edr_generic" }
 edr_napi_core = { path = "../edr_napi_core" }
 edr_provider = { path = "../edr_provider" }
 edr_rpc_client = { path = "../edr_rpc_client" }
-itertools = { version = "0.12.0", default-features = false }
 mimalloc = { version = "0.1.39", default-features = false, features = ["local_dynamic_tls"] }
 # when napi is pinned, be sure to pin napi-derive to the same version
 # The `async` feature ensures that a tokio runtime is available
@@ -24,7 +22,6 @@ napi-derive = "2.16.0"
 rand = { version = "0.8.4", optional = true }
 serde = { version = "1.0.209", features = ["derive"] }
 serde_json = { version = "1.0.127" }
-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"] }
@@ -45,11 +42,8 @@ openssl-sys = { version = "0.9.93", features = ["vendored"] }
 napi-build = "2.0.1"
 
 [features]
-tracing = ["edr_evm/tracing", "edr_napi_core/tracing", "edr_provider/tracing"]
 scenarios = ["rand"]
-
-[profile.release]
-lto = true
+tracing = ["edr_evm/tracing", "edr_napi_core/tracing", "edr_provider/tracing"]
 
 [lints]
 workspace = true

crates/edr_napi/index.d.ts

@@ -437,6 +437,14 @@ export class EdrContext {
   registerProviderFactory(chainType: string, factory: ProviderFactory): Promise<void>
 }
 export class ProviderFactory { }
+export class Response {
+  /**Returns the response data as a JSON string or a JSON object. */
+  get data(): string | any
+  /**Returns the Solidity trace of the transaction that failed to execute, if any. */
+  get solidityTrace(): RawTrace | null
+  /**Returns the raw traces of executed contracts. This maybe contain zero or more traces. */
+  get traces(): Array<RawTrace>
+}
 /** A JSON-RPC provider for Ethereum. */
 export class Provider {
   /**Handles a JSON-RPC request and returns a JSON-RPC response. */
@@ -450,14 +458,6 @@ export class Provider {
    */
   setVerboseTracing(verboseTracing: boolean): Promise<void>
 }
-export class Response {
-  /**Returns the response data as a JSON string or a JSON object. */
-  get data(): string | any
-  /**Returns the Solidity trace of the transaction that failed to execute, if any. */
-  get solidityTrace(): RawTrace | null
-  /**Returns the raw traces of executed contracts. This maybe contain zero or more traces. */
-  get traces(): Array<RawTrace>
-}
 export class RawTrace {
   trace(): Array<TracingMessage | TracingStep | TracingMessageResult>
 }

crates/edr_napi/index.js

@@ -310,7 +310,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { MineOrdering, EdrContext, GENERIC_CHAIN_TYPE, genericChainProviderFactory, L1_CHAIN_TYPE, l1ProviderFactory, SpecId, FRONTIER, FRONTIER_THAWING, HOMESTEAD, DAO_FORK, TANGERINE, SPURIOUS_DRAGON, BYZANTIUM, CONSTANTINOPLE, PETERSBURG, ISTANBUL, MUIR_GLACIER, BERLIN, LONDON, ARROW_GLACIER, GRAY_GLACIER, MERGE, SHANGHAI, CANCUN, PRAGUE, PRAGUE_EOF, LATEST, ProviderFactory, Provider, SuccessReason, ExceptionalHalt, Response, RawTrace } = nativeBinding
+const { MineOrdering, EdrContext, GENERIC_CHAIN_TYPE, genericChainProviderFactory, L1_CHAIN_TYPE, l1ProviderFactory, SpecId, FRONTIER, FRONTIER_THAWING, HOMESTEAD, DAO_FORK, TANGERINE, SPURIOUS_DRAGON, BYZANTIUM, CONSTANTINOPLE, PETERSBURG, ISTANBUL, MUIR_GLACIER, BERLIN, LONDON, ARROW_GLACIER, GRAY_GLACIER, MERGE, SHANGHAI, CANCUN, PRAGUE, PRAGUE_EOF, LATEST, ProviderFactory, Response, Provider, SuccessReason, ExceptionalHalt, RawTrace } = nativeBinding
 
 module.exports.MineOrdering = MineOrdering
 module.exports.EdrContext = EdrContext
@@ -341,8 +341,8 @@ module.exports.PRAGUE = PRAGUE
 module.exports.PRAGUE_EOF = PRAGUE_EOF
 module.exports.LATEST = LATEST
 module.exports.ProviderFactory = ProviderFactory
+module.exports.Response = Response
 module.exports.Provider = Provider
 module.exports.SuccessReason = SuccessReason
 module.exports.ExceptionalHalt = ExceptionalHalt
-module.exports.Response = Response
 module.exports.RawTrace = RawTrace

crates/edr_napi/package.json

@@ -52,7 +52,7 @@
     "build:debug": "napi build --platform",
     "build:tracing": "napi build --platform --release --features tracing",
     "build:scenarios": "napi build --platform --release --features scenarios",
-    "prepublishOnly": "bash scripts/prepublish.sh",
+    "prepublishOnly": "bash ../../scripts/prepublish.sh",
     "universal": "napi universal",
     "version": "napi version",
     "pretest": "pnpm build",

crates/edr_napi/src/context.rs

@@ -1,6 +1,7 @@
 use std::{io, sync::Arc};
 
 use edr_eth::HashMap;
+use edr_napi_core::provider::{self, SyncProviderFactory};
 use napi::{
     tokio::{runtime, sync::Mutex as AsyncMutex},
     Env, JsObject, Status,
@@ -11,7 +12,7 @@ use tracing_subscriber::{prelude::*, EnvFilter, Registry};
 use crate::{
     config::ProviderConfig,
     logger::LoggerConfig,
-    provider::{factory::SyncProviderFactory, Provider, ProviderFactory},
+    provider::{Provider, ProviderFactory},
     subscription::SubscriptionConfig,
 };
 
@@ -44,6 +45,7 @@ impl EdrContext {
         subscription_config: SubscriptionConfig,
     ) -> napi::Result<JsObject> {
         let provider_config = edr_napi_core::provider::Config::try_from(provider_config)?;
+        let logger_config = logger_config.resolve(&env)?;
 
         #[cfg(feature = "scenarios")]
         let scenario_file =
@@ -61,7 +63,7 @@ impl EdrContext {
                 &chain_type,
                 provider_config,
                 logger_config,
-                subscription_config,
+                subscription_config.into(),
             )?
         };
 
@@ -153,17 +155,10 @@ impl Context {
         env: &napi::Env,
         chain_type: &str,
         provider_config: edr_napi_core::provider::Config,
-        logger_config: LoggerConfig,
-        subscription_config: SubscriptionConfig,
-    ) -> napi::Result<Box<dyn crate::provider::Builder>> {
+        logger_config: edr_napi_core::logger::Config,
+        subscription_config: edr_napi_core::subscription::Config,
+    ) -> napi::Result<Box<dyn provider::Builder>> {
         if let Some(factory) = self.provider_factories.get(chain_type) {
-            // #[cfg(feature = "scenarios")]
-            // let scenario_file = crate::scenarios::scenario_file(
-            //     &config,
-            //     edr_provider::Logger::is_enabled(&*logger),
-            // )
-            // .await?;
-
             factory.create_provider_builder(
                 env,
                 provider_config,

crates/edr_napi/src/generic_chain.rs

@@ -1,14 +1,15 @@
 use std::sync::Arc;
 
 use edr_generic::GenericChainSpec;
+use edr_napi_core::{
+    logger::{self, Logger},
+    provider::{self, ProviderBuilder, SyncProviderFactory},
+    spec::SyncNapiSpec as _,
+    subscription,
+};
 use napi_derive::napi;
 
-use crate::{
-    logger::{Logger, LoggerConfig},
-    provider::{self, factory::SyncProviderFactory, ProviderBuilder, ProviderFactory},
-    spec::SyncNapiSpec,
-    subscription::{SubscriptionCallback, SubscriptionConfig},
-};
+use crate::provider::ProviderFactory;
 
 pub struct GenericChainProviderFactory;
 
@@ -17,19 +18,19 @@ impl SyncProviderFactory for GenericChainProviderFactory {
         &self,
         env: &napi::Env,
         provider_config: edr_napi_core::provider::Config,
-        logger_config: LoggerConfig,
-        subscription_config: SubscriptionConfig,
+        logger_config: logger::Config,
+        subscription_config: subscription::Config,
     ) -> napi::Result<Box<dyn provider::Builder>> {
-        let logger = Logger::<GenericChainSpec>::new(env, logger_config)?;
+        let logger = Logger::<GenericChainSpec>::new(logger_config)?;
 
         let provider_config =
             edr_provider::ProviderConfig::<GenericChainSpec>::from(provider_config);
 
         let subscription_callback =
-            SubscriptionCallback::new(env, subscription_config.subscription_callback)?;
+            subscription::Callback::new(env, subscription_config.subscription_callback)?;
 
         Ok(Box::new(ProviderBuilder::new(
-            logger,
+            Box::new(logger),
             provider_config,
             subscription_callback,
         )))

crates/edr_napi/src/l1.rs

@@ -1,14 +1,15 @@
 use std::sync::Arc;
 
 use edr_eth::{chain_spec::L1ChainSpec, specification};
+use edr_napi_core::{
+    logger::Logger,
+    provider::{self, ProviderBuilder, SyncProviderFactory},
+    spec::SyncNapiSpec as _,
+    subscription,
+};
 use napi_derive::napi;
 
-use crate::{
-    logger::{Logger, LoggerConfig},
-    provider::{self, factory::SyncProviderFactory, ProviderBuilder, ProviderFactory},
-    spec::SyncNapiSpec,
-    subscription::{SubscriptionCallback, SubscriptionConfig},
-};
+use crate::provider::ProviderFactory;
 
 pub struct L1ProviderFactory;
 
@@ -17,18 +18,18 @@ impl SyncProviderFactory for L1ProviderFactory {
         &self,
         env: &napi::Env,
         provider_config: edr_napi_core::provider::Config,
-        logger_config: LoggerConfig,
-        subscription_config: SubscriptionConfig,
+        logger_config: edr_napi_core::logger::Config,
+        subscription_config: edr_napi_core::subscription::Config,
     ) -> napi::Result<Box<dyn provider::Builder>> {
-        let logger = Logger::<L1ChainSpec>::new(env, logger_config)?;
+        let logger = Logger::<L1ChainSpec>::new(logger_config)?;
 
         let provider_config = edr_provider::ProviderConfig::<L1ChainSpec>::from(provider_config);
 
         let subscription_callback =
-            SubscriptionCallback::new(env, subscription_config.subscription_callback)?;
+            subscription::Callback::new(env, subscription_config.subscription_callback)?;
 
         Ok(Box::new(ProviderBuilder::new(
-            logger,
+            Box::new(logger),
             provider_config,
             subscription_callback,
         )))

crates/edr_napi/src/lib.rs

@@ -32,8 +32,6 @@ pub mod result;
 /// Types relating to benchmark scenarios.
 #[cfg(feature = "scenarios")]
 pub mod scenarios;
-/// Types for N-API-related chain specification.
-pub mod spec;
 /// Types for subscribing to events.
 pub mod subscription;
 /// Types for EVM traces.