@nomicfoundation/edr 0.5.0 → 0.5.2

package/index.d.ts

@@ -418,7 +418,9 @@ export class Provider {
   setVerboseTracing(verboseTracing: boolean): void
 }
 export class Response {
-  get json(): string
+  /** Returns the response data as a JSON string or a JSON object. */
+  get data(): string | any
+  get json(): string | any
   get solidityTrace(): RawTrace | null
   get traces(): Array<RawTrace>
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nomicfoundation/edr",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
@@ -38,6 +38,7 @@
     "@types/node": "^18.0.0",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
+    "json-stream-stringify": "^3.1.4",
     "mocha": "^10.0.0",
     "ts-node": "^10.8.0",
     "typescript": "~4.5.2"
@@ -46,13 +47,13 @@
     "node": ">= 18"
   },
   "dependencies": {
-    "@nomicfoundation/edr-darwin-arm64": "0.5.0",
-    "@nomicfoundation/edr-darwin-x64": "0.5.0",
-    "@nomicfoundation/edr-linux-arm64-gnu": "0.5.0",
-    "@nomicfoundation/edr-linux-arm64-musl": "0.5.0",
-    "@nomicfoundation/edr-linux-x64-gnu": "0.5.0",
-    "@nomicfoundation/edr-linux-x64-musl": "0.5.0",
-    "@nomicfoundation/edr-win32-x64-msvc": "0.5.0"
+    "@nomicfoundation/edr-darwin-arm64": "0.5.2",
+    "@nomicfoundation/edr-darwin-x64": "0.5.2",
+    "@nomicfoundation/edr-linux-arm64-gnu": "0.5.2",
+    "@nomicfoundation/edr-linux-arm64-musl": "0.5.2",
+    "@nomicfoundation/edr-linux-x64-gnu": "0.5.2",
+    "@nomicfoundation/edr-linux-x64-musl": "0.5.2",
+    "@nomicfoundation/edr-win32-x64-msvc": "0.5.2"
   },
   "scripts": {
     "artifacts": "napi artifacts",
@@ -63,8 +64,8 @@
     "universal": "napi universal",
     "version": "napi version",
     "pretest": "pnpm build",
-    "test": "pnpm tsc && mocha --recursive \"test/**/*.ts\"",
-    "testNoBuild": "pnpm tsc && mocha --recursive \"test/**/*.ts\"",
+    "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\"",
     "clean": "rm -rf @nomicfoundation/edr.node"
   }
 }

package/src/provider.rs

@@ -4,7 +4,7 @@ use std::sync::Arc;
 
 use edr_provider::{time::CurrentTime, InvalidRequestReason};
 use edr_rpc_eth::jsonrpc;
-use napi::{tokio::runtime, Env, JsFunction, JsObject, Status};
+use napi::{tokio::runtime, Either, Env, JsFunction, JsObject, Status};
 use napi_derive::napi;
 
 use self::config::ProviderConfig;
@@ -120,9 +120,9 @@ impl Provider {
                             format!("Invalid JSON `{json_request}` due to: {error}"),
                         )
                     })
-                    .map(|json_response| Response {
+                    .map(|json| Response {
                         solidity_trace: None,
-                        json: json_response,
+                        data: Either::A(json),
                         traces: Vec::new(),
                     });
             }
@@ -168,10 +168,25 @@ impl Provider {
         let response = jsonrpc::ResponseData::from(response.map(|response| response.result));
 
         serde_json::to_string(&response)
-            .map_err(|e| napi::Error::new(Status::GenericFailure, e.to_string()))
-            .map(|json_response| Response {
+            .and_then(|json| {
+                // We experimentally determined that 500_000_000 was the maximum string length
+                // that can be returned without causing the error:
+                //
+                // > Failed to convert rust `String` into napi `string`
+                //
+                // To be safe, we're limiting string lengths to half of that.
+                const MAX_STRING_LENGTH: usize = 250_000_000;
+
+                if json.len() <= MAX_STRING_LENGTH {
+                    Ok(Either::A(json))
+                } else {
+                    serde_json::to_value(response).map(Either::B)
+                }
+            })
+            .map_err(|error| napi::Error::new(Status::GenericFailure, error.to_string()))
+            .map(|data| Response {
                 solidity_trace,
-                json: json_response,
+                data,
                 traces: traces.into_iter().map(Arc::new).collect(),
             })
     }
@@ -209,7 +224,10 @@ impl Provider {
 
 #[napi]
 pub struct Response {
-    json: String,
+    // N-API is known to be slow when marshalling `serde_json::Value`s, so we try to return a
+    // `String`. If the object is too large to be represented as a `String`, we return a `Buffer`
+    // instead.
+    data: Either<String, serde_json::Value>,
     /// When a transaction fails to execute, the provider returns a trace of the
     /// transaction.
     solidity_trace: Option<Arc<edr_evm::trace::Trace>>,
@@ -219,9 +237,16 @@ pub struct Response {
 
 #[napi]
 impl Response {
+    /// Returns the response data as a JSON string or a JSON object.
+    #[napi(getter)]
+    pub fn data(&self) -> Either<String, serde_json::Value> {
+        self.data.clone()
+    }
+
+    // Temporary alias for data to prevent breaking change
     #[napi(getter)]
-    pub fn json(&self) -> String {
-        self.json.clone()
+    pub fn json(&self) -> Either<String, serde_json::Value> {
+        self.data.clone()
     }
 
     #[napi(getter)]