refactor: Re-use MessageTrace and VmTracer from EDR now

Author: Xanewok

packages/hardhat-core/src/internal/hardhat-network/provider/provider.ts

@@ -364,6 +364,9 @@ export class EdrProviderWrapper
     if (needsTraces) {
       const rawTraces = responseObject.traces;
       for (const rawTrace of rawTraces) {
+        this._vmTracer?.observe(rawTrace);
+
+        // For other consumers in JS we need to marshall the entire trace over FFI
         const trace = rawTrace.trace();
 
         // beforeTx event
@@ -380,8 +383,6 @@ export class EdrProviderWrapper
                 edrTracingStepToMinimalInterpreterStep(traceItem)
               );
             }
-
-            this._vmTracer?.addStep(traceItem);
           }
           // afterMessage event
           else if ("executionResult" in traceItem) {
@@ -391,8 +392,6 @@ export class EdrProviderWrapper
                 edrTracingMessageResultToMinimalEVMResult(traceItem)
               );
             }
-
-            this._vmTracer?.addAfterMessage(traceItem.executionResult);
           }
           // beforeMessage event
           else {
@@ -402,8 +401,6 @@ export class EdrProviderWrapper
                 edrTracingMessageToMinimalMessage(traceItem)
               );
             }
-
-            this._vmTracer?.addBeforeMessage(traceItem);
           }
         }
 
@@ -574,17 +571,7 @@ export class EdrProviderWrapper
     rawTrace: RawTrace
   ): Promise<SolidityStackTrace | undefined> {
     const vmTracer = new VMTracer();
-
-    const trace = rawTrace.trace();
-    for (const traceItem of trace) {
-      if ("pc" in traceItem) {
-        vmTracer.addStep(traceItem);
-      } else if ("executionResult" in traceItem) {
-        vmTracer.addAfterMessage(traceItem.executionResult);
-      } else {
-        vmTracer.addBeforeMessage(traceItem);
-      }
-    }
+    vmTracer.observe(rawTrace);
 
     let vmTrace = vmTracer.getLastTopLevelMessageTrace();
     const vmTracerError = vmTracer.getLastError();

packages/hardhat-core/src/internal/hardhat-network/provider/vm/exit.ts

@@ -1,95 +1,2 @@
-import type { ExceptionalHalt, SuccessReason } from "@nomicfoundation/edr";
-
-import { requireNapiRsModule } from "../../../../common/napi-rs";
-
-export enum ExitCode {
-  SUCCESS,
-  REVERT,
-  OUT_OF_GAS,
-  INTERNAL_ERROR,
-  INVALID_OPCODE,
-  STACK_UNDERFLOW,
-  CODESIZE_EXCEEDS_MAXIMUM,
-  CREATE_COLLISION,
-  STATIC_STATE_CHANGE,
-}
-
-export class Exit {
-  public static fromEdrSuccessReason(reason: SuccessReason): Exit {
-    const { SuccessReason } = requireNapiRsModule(
-      "@nomicfoundation/edr"
-    ) as typeof import("@nomicfoundation/edr");
-
-    switch (reason) {
-      case SuccessReason.Stop:
-      case SuccessReason.Return:
-      case SuccessReason.SelfDestruct:
-      case SuccessReason.EofReturnContract:
-        return new Exit(ExitCode.SUCCESS);
-    }
-
-    const _exhaustiveCheck: never = reason;
-  }
-
-  public static fromEdrExceptionalHalt(halt: ExceptionalHalt): Exit {
-    const { ExceptionalHalt } = requireNapiRsModule(
-      "@nomicfoundation/edr"
-    ) as typeof import("@nomicfoundation/edr");
-
-    switch (halt) {
-      case ExceptionalHalt.OutOfGas:
-        return new Exit(ExitCode.OUT_OF_GAS);
-
-      case ExceptionalHalt.OpcodeNotFound:
-      case ExceptionalHalt.InvalidFEOpcode:
-      // Returned when an opcode is not implemented for the hardfork
-      case ExceptionalHalt.NotActivated:
-        return new Exit(ExitCode.INVALID_OPCODE);
-
-      case ExceptionalHalt.StackUnderflow:
-        return new Exit(ExitCode.STACK_UNDERFLOW);
-
-      case ExceptionalHalt.CreateCollision:
-        return new Exit(ExitCode.CREATE_COLLISION);
-
-      case ExceptionalHalt.CreateContractSizeLimit:
-        return new Exit(ExitCode.CODESIZE_EXCEEDS_MAXIMUM);
-
-      default: {
-        // eslint-disable-next-line @nomicfoundation/hardhat-internal-rules/only-hardhat-error
-        throw new Error(`Unmatched EDR exceptional halt: ${halt}`);
-      }
-    }
-  }
-
-  constructor(public kind: ExitCode) {}
-
-  public isError(): boolean {
-    return this.kind !== ExitCode.SUCCESS;
-  }
-
-  public getReason(): string {
-    switch (this.kind) {
-      case ExitCode.SUCCESS:
-        return "Success";
-      case ExitCode.REVERT:
-        return "Reverted";
-      case ExitCode.OUT_OF_GAS:
-        return "Out of gas";
-      case ExitCode.INTERNAL_ERROR:
-        return "Internal error";
-      case ExitCode.INVALID_OPCODE:
-        return "Invalid opcode";
-      case ExitCode.STACK_UNDERFLOW:
-        return "Stack underflow";
-      case ExitCode.CODESIZE_EXCEEDS_MAXIMUM:
-        return "Codesize exceeds maximum";
-      case ExitCode.CREATE_COLLISION:
-        return "Create collision";
-      case ExitCode.STATIC_STATE_CHANGE:
-        return "Static state change";
-    }
-
-    const _exhaustiveCheck: never = this.kind;
-  }
-}
+import { ExitCode } from "@nomicfoundation/edr";
+export { ExitCode };

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

@@ -1,13 +1,17 @@
 import type { Bytecode } from "./model";
-import type { Exit } from "../provider/vm/exit";
 import type {
   CallOutput,
   CreateOutput,
   HaltResult,
   RevertResult,
   SuccessResult,
+  PrecompileMessageTrace,
+  CreateMessageTrace,
+  CallMessageTrace,
 } from "@nomicfoundation/edr";
 
+export { PrecompileMessageTrace, CreateMessageTrace, CallMessageTrace };
+
 export type MessageTrace =
   | CreateMessageTrace
   | CallMessageTrace
@@ -19,38 +23,6 @@ export type DecodedEvmMessageTrace =
   | DecodedCreateMessageTrace
   | DecodedCallMessageTrace;
 
-export interface BaseMessageTrace {
-  value: bigint;
-  returnData: Uint8Array;
-  exit: Exit;
-  gasUsed: bigint;
-  depth: number;
-}
-
-export interface PrecompileMessageTrace extends BaseMessageTrace {
-  precompile: number;
-  calldata: Uint8Array;
-}
-
-export interface BaseEvmMessageTrace extends BaseMessageTrace {
-  code: Uint8Array;
-  steps: MessageTraceStep[];
-  bytecode?: Bytecode;
-  // The following is just an optimization: When processing this traces it's useful to know ahead of
-  // time how many subtraces there are.
-  numberOfSubtraces: number;
-}
-
-export interface CreateMessageTrace extends BaseEvmMessageTrace {
-  deployedContract: Uint8Array | undefined;
-}
-
-export interface CallMessageTrace extends BaseEvmMessageTrace {
-  calldata: Uint8Array;
-  address: Uint8Array;
-  codeAddress: Uint8Array;
-}
-
 export interface DecodedCreateMessageTrace extends CreateMessageTrace {
   bytecode: Bytecode;
 }