feat: add Optimism bindings in N-API (#664)

NomicFoundation · Sep 17, 2024 · bcdcafa · bcdcafa
1 parent 05a8cb6
commit bcdcafa
Show file tree

Hide file tree

Showing 36 changed files with 2,080 additions and 1,669 deletions.
diff --git a/.github/workflows/edr-ci.yml b/.github/workflows/edr-ci.yml
@@ -10,7 +10,6 @@ on:
   workflow_dispatch:
 
 env:
-  RUSTFLAGS: -Dwarnings
   RUSTDOCFLAGS: -Dwarnings
 
 concurrency:
@@ -37,6 +36,8 @@ jobs:
 
       - name: Cargo hack
         uses: actions-rs/cargo@v1
+        env:
+          RUSTFLAGS: -Dwarnings
         with:
           command: hack
           args: check --feature-powerset --no-dev-deps

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/edr_napi/Cargo.toml b/crates/edr_napi/Cargo.toml
@@ -7,15 +7,14 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [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_optimism = { path = "../edr_optimism", optional = true }
 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 +23,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 +43,9 @@ 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"]
+optimism = ["dep:edr_optimism"]
 scenarios = ["rand"]
-
-[profile.release]
-lto = true
+tracing = ["edr_evm/tracing", "edr_napi_core/tracing", "edr_provider/tracing"]
 
 [lints]
 workspace = true
diff --git a/crates/edr_napi/index.d.ts b/crates/edr_napi/index.d.ts
@@ -63,6 +63,72 @@ export interface CallOverrideResult {
   result: Buffer
   shouldRevert: boolean
 }
+export const GENERIC_CHAIN_TYPE: string
+export function genericChainProviderFactory(): ProviderFactory
+export const L1_CHAIN_TYPE: string
+export function l1ProviderFactory(): ProviderFactory
+/** Identifier for the Ethereum spec. */
+export const enum SpecId {
+  /** Frontier */
+  Frontier = 0,
+  /** Frontier Thawing */
+  FrontierThawing = 1,
+  /** Homestead */
+  Homestead = 2,
+  /** DAO Fork */
+  DaoFork = 3,
+  /** Tangerine */
+  Tangerine = 4,
+  /** Spurious Dragon */
+  SpuriousDragon = 5,
+  /** Byzantium */
+  Byzantium = 6,
+  /** Constantinople */
+  Constantinople = 7,
+  /** Petersburg */
+  Petersburg = 8,
+  /** Istanbul */
+  Istanbul = 9,
+  /** Muir Glacier */
+  MuirGlacier = 10,
+  /** Berlin */
+  Berlin = 11,
+  /** London */
+  London = 12,
+  /** Arrow Glacier */
+  ArrowGlacier = 13,
+  /** Gray Glacier */
+  GrayGlacier = 14,
+  /** Merge */
+  Merge = 15,
+  /** Shanghai */
+  Shanghai = 16,
+  /** Cancun */
+  Cancun = 17,
+  /** Latest */
+  Latest = 18
+}
+export const FRONTIER: string
+export const FRONTIER_THAWING: string
+export const HOMESTEAD: string
+export const DAO_FORK: string
+export const TANGERINE: string
+export const SPURIOUS_DRAGON: string
+export const BYZANTIUM: string
+export const CONSTANTINOPLE: string
+export const PETERSBURG: string
+export const ISTANBUL: string
+export const MUIR_GLACIER: string
+export const BERLIN: string
+export const LONDON: string
+export const ARROW_GLACIER: string
+export const GRAY_GLACIER: string
+export const MERGE: string
+export const SHANGHAI: string
+export const CANCUN: string
+export const PRAGUE: string
+export const PRAGUE_EOF: string
+export const LATEST: string
 /** Configuration for a chain */
 export interface ChainConfig {
   /** The chain ID */
@@ -195,72 +261,6 @@ export interface DebugTraceLogItem {
   /** Map of all stored values with keys and values encoded as hex strings. */
   storage?: Record<string, string>
 }
-export const GENERIC_CHAIN_TYPE: string
-export function genericChainProviderFactory(): ProviderFactory
-export const L1_CHAIN_TYPE: string
-export function l1ProviderFactory(): ProviderFactory
-/** Identifier for the Ethereum spec. */
-export const enum SpecId {
-  /** Frontier */
-  Frontier = 0,
-  /** Frontier Thawing */
-  FrontierThawing = 1,
-  /** Homestead */
-  Homestead = 2,
-  /** DAO Fork */
-  DaoFork = 3,
-  /** Tangerine */
-  Tangerine = 4,
-  /** Spurious Dragon */
-  SpuriousDragon = 5,
-  /** Byzantium */
-  Byzantium = 6,
-  /** Constantinople */
-  Constantinople = 7,
-  /** Petersburg */
-  Petersburg = 8,
-  /** Istanbul */
-  Istanbul = 9,
-  /** Muir Glacier */
-  MuirGlacier = 10,
-  /** Berlin */
-  Berlin = 11,
-  /** London */
-  London = 12,
-  /** Arrow Glacier */
-  ArrowGlacier = 13,
-  /** Gray Glacier */
-  GrayGlacier = 14,
-  /** Merge */
-  Merge = 15,
-  /** Shanghai */
-  Shanghai = 16,
-  /** Cancun */
-  Cancun = 17,
-  /** Latest */
-  Latest = 18
-}
-export const FRONTIER: string
-export const FRONTIER_THAWING: string
-export const HOMESTEAD: string
-export const DAO_FORK: string
-export const TANGERINE: string
-export const SPURIOUS_DRAGON: string
-export const BYZANTIUM: string
-export const CONSTANTINOPLE: string
-export const PETERSBURG: string
-export const ISTANBUL: string
-export const MUIR_GLACIER: string
-export const BERLIN: string
-export const LONDON: string
-export const ARROW_GLACIER: string
-export const GRAY_GLACIER: string
-export const MERGE: string
-export const SHANGHAI: string
-export const CANCUN: string
-export const PRAGUE: string
-export const PRAGUE_EOF: string
-export const LATEST: string
 /** Ethereum execution log. */
 export interface ExecutionLog {
   address: Buffer
@@ -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>
 }
diff --git a/crates/edr_napi/index.js b/crates/edr_napi/index.js
@@ -310,10 +310,8 @@ 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 { 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, MineOrdering, EdrContext, ProviderFactory, Response, Provider, SuccessReason, ExceptionalHalt, RawTrace } = nativeBinding
 
-module.exports.MineOrdering = MineOrdering
-module.exports.EdrContext = EdrContext
 module.exports.GENERIC_CHAIN_TYPE = GENERIC_CHAIN_TYPE
 module.exports.genericChainProviderFactory = genericChainProviderFactory
 module.exports.L1_CHAIN_TYPE = L1_CHAIN_TYPE
@@ -340,9 +338,11 @@ module.exports.CANCUN = CANCUN
 module.exports.PRAGUE = PRAGUE
 module.exports.PRAGUE_EOF = PRAGUE_EOF
 module.exports.LATEST = LATEST
+module.exports.MineOrdering = MineOrdering
+module.exports.EdrContext = EdrContext
 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
diff --git a/crates/edr_napi/package.json b/crates/edr_napi/package.json
@@ -32,6 +32,7 @@
   "license": "MIT",
   "devDependencies": {
     "@napi-rs/cli": "^2.18.1",
+    "@nomicfoundation/ethereumjs-util": "^9.0.4",
     "@types/chai": "^4.2.0",
     "@types/chai-as-promised": "^7.1.8",
     "@types/mocha": ">=9.1.0",
@@ -50,14 +51,15 @@
     "artifacts": "napi artifacts",
     "build": "napi build --platform --release",
     "build:debug": "napi build --platform",
+    "build:optimism": "napi build --platform --release --features optimism",
     "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",
+    "pretest": "pnpm build:optimism",
     "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/**/*.ts\"",
+    "testNoBuild": "pnpm tsc && node --max-old-space-size=8192 node_modules/mocha/bin/_mocha --recursive \"test/**/{,!(optimism)}.ts\"",
     "clean": "rm -rf @nomicfoundation/edr.node"
   }
 }
diff --git a/crates/edr_napi/src/chains.rs b/crates/edr_napi/src/chains.rs
@@ -0,0 +1,7 @@
+/// Types for the generic L1 Ethereum implementation.
+pub mod generic;
+/// Types for L1 Ethereum implementation.
+pub mod l1;
+/// Types for Optimism implementation.
+#[cfg(feature = "optimism")]
+pub mod optimism;
diff --git a/crates/edr_napi/src/generic_chain.rs → crates/edr_napi/src/chains/generic.rs b/crates/edr_napi/src/generic_chain.rs → crates/edr_napi/src/chains/generic.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,
         )))