refactor: Prune StackTraceEntry.message to make it clonable

Author: Xanewok

packages/hardhat-core/src/internal/hardhat-network/stack-traces/debug.ts

@@ -1,7 +1,7 @@
 import { bytesToHex as bufferToHex } from "@nomicfoundation/ethereumjs-util";
 import chalk from "chalk";
 
-import { stackTraceEntryTypeToString } from "@nomicfoundation/edr";
+import { ReturnData, stackTraceEntryTypeToString } from "@nomicfoundation/edr";
 import {
   CallMessageTrace,
   CreateMessageTrace,
@@ -191,7 +191,7 @@ function flattenSourceReference(sourceReference?: SourceReference) {
 export function printStackTrace(trace: SolidityStackTrace) {
   const withDecodedMessages = trace.map((entry) =>
     entry.type === StackTraceEntryType.REVERT_ERROR
-      ? { ...entry, message: entry.message.decodeError() }
+      ? { ...entry, message: new ReturnData(entry.returnData).decodeError() }
       : entry
   );
 

packages/hardhat-core/src/internal/hardhat-network/stack-traces/solidity-errors.ts

@@ -1,5 +1,6 @@
 import { bytesToHex as bufferToHex } from "@nomicfoundation/ethereumjs-util";
 
+import { ReturnData } from "../provider/return-data";
 import { panicErrorCodeToMessage } from "./panic-errors";
 import {
   CONSTRUCTOR_FUNCTION_NAME,
@@ -259,23 +260,22 @@ function getMessageFromLastStackTraceEntry(
 
     case StackTraceEntryType.UNRECOGNIZED_CREATE_ERROR:
     case StackTraceEntryType.UNRECOGNIZED_CONTRACT_ERROR:
-      if (stackTraceEntry.message.isErrorReturnData()) {
-        return `VM Exception while processing transaction: reverted with reason string '${stackTraceEntry.message.decodeError()}'`;
+      let returnData = new ReturnData(stackTraceEntry.returnData);
+      if (returnData.isErrorReturnData()) {
+        return `VM Exception while processing transaction: reverted with reason string '${new ReturnData(
+          stackTraceEntry.returnData
+        ).decodeError()}'`;
       }
 
-      if (stackTraceEntry.message.isPanicReturnData()) {
-        const message = panicErrorCodeToMessage(
-          stackTraceEntry.message.decodePanic()
-        );
+      if (returnData.isPanicReturnData()) {
+        const message = panicErrorCodeToMessage(returnData.decodePanic());
         return `VM Exception while processing transaction: ${message}`;
       }
 
-      if (!stackTraceEntry.message.isEmpty()) {
-        const returnData = Buffer.from(stackTraceEntry.message.value).toString(
-          "hex"
-        );
+      if (!returnData.isEmpty()) {
+        const buffer = Buffer.from(returnData.value).toString("hex");
 
-        return `VM Exception while processing transaction: reverted with an unrecognized custom error (return data: 0x${returnData})`;
+        return `VM Exception while processing transaction: reverted with an unrecognized custom error (return data: 0x${buffer})`;
       }
 
       if (stackTraceEntry.isInvalidOpcodeError) {
@@ -285,8 +285,9 @@ function getMessageFromLastStackTraceEntry(
       return "Transaction reverted without a reason string";
 
     case StackTraceEntryType.REVERT_ERROR:
-      if (stackTraceEntry.message.isErrorReturnData()) {
-        return `VM Exception while processing transaction: reverted with reason string '${stackTraceEntry.message.decodeError()}'`;
+      returnData = new ReturnData(stackTraceEntry.returnData);
+      if (returnData.isErrorReturnData()) {
+        return `VM Exception while processing transaction: reverted with reason string '${returnData.decodeError()}'`;
       }
 
       if (stackTraceEntry.isInvalidOpcodeError) {

packages/hardhat-core/src/internal/hardhat-network/stack-traces/solidityTracer.ts

@@ -1,7 +1,6 @@
 import { equalsBytes } from "@nomicfoundation/ethereumjs-util";
 
 import { SolidityTracer as SolidityTracerRs } from "@nomicfoundation/edr";
-import { ReturnData } from "../provider/return-data";
 import { ExitCode } from "../provider/vm/exit";
 
 import {
@@ -117,7 +116,7 @@ export class SolidityTracer {
       return [
         {
           type: StackTraceEntryType.UNRECOGNIZED_CREATE_ERROR,
-          message: new ReturnData(trace.returnData),
+          returnData: trace.returnData,
           isInvalidOpcodeError,
         },
       ];
@@ -127,7 +126,7 @@ export class SolidityTracer {
       {
         type: StackTraceEntryType.UNRECOGNIZED_CONTRACT_ERROR,
         address: trace.address,
-        message: new ReturnData(trace.returnData),
+        returnData: trace.returnData,
         isInvalidOpcodeError,
       },
     ];

packages/hardhat-core/test/internal/hardhat-network/stack-traces/test.ts

@@ -336,22 +336,15 @@ function compareStackTraces(
       `Stack trace of tx ${txIndex} entry ${i} type is incorrect: expected ${expectedErrorType}, got ${actualErrorType}`
     );
 
-    const actualMessage = (actual as any).message as
-      | ReturnData
-      | string
-      | undefined;
-
-    // actual.message is a ReturnData in revert errors, but a string
-    // in custom errors
-    let decodedMessage = "";
-    if (typeof actualMessage === "string") {
-      decodedMessage = actualMessage;
-    } else if (
-      actualMessage instanceof ReturnData &&
-      actualMessage.isErrorReturnData()
-    ) {
-      decodedMessage = actualMessage.decodeError();
-    }
+    // actual.message is a ReturnData in revert errors but in custom errors
+    // we need to decode it
+    const decodedMessage =
+      "message" in actual
+        ? actual.message
+        : "returnData" in actual &&
+          new ReturnData(actual.returnData).isErrorReturnData()
+        ? new ReturnData(actual.returnData).decodeError()
+        : "";
 
     if (expected.message !== undefined) {
       assert.equal(