hardhat 2.22.10 → 2.22.12

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

@@ -1,129 +1,12 @@
-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 type { PrecompileMessageTrace, CreateMessageTrace, CallMessageTrace };
+
 export type MessageTrace =
   | CreateMessageTrace
   | CallMessageTrace
   | PrecompileMessageTrace;
-
-export type EvmMessageTrace = CreateMessageTrace | CallMessageTrace;
-
-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;
-}
-
-export interface DecodedCallMessageTrace extends CallMessageTrace {
-  bytecode: Bytecode;
-}
-
-export function isPrecompileTrace(
-  trace: MessageTrace
-): trace is PrecompileMessageTrace {
-  return "precompile" in trace;
-}
-
-export function isCreateTrace(
-  trace: MessageTrace
-): trace is CreateMessageTrace {
-  return "code" in trace && !isCallTrace(trace);
-}
-
-export function isDecodedCreateTrace(
-  trace: MessageTrace
-): trace is DecodedCreateMessageTrace {
-  return isCreateTrace(trace) && trace.bytecode !== undefined;
-}
-
-export function isCallTrace(trace: MessageTrace): trace is CallMessageTrace {
-  return "code" in trace && "calldata" in trace;
-}
-
-export function isDecodedCallTrace(
-  trace: MessageTrace
-): trace is DecodedCallMessageTrace {
-  return isCallTrace(trace) && trace.bytecode !== undefined;
-}
-
-export function isEvmStep(step: MessageTraceStep): step is EvmStep {
-  return "pc" in step && step.pc !== undefined;
-}
-
-export type MessageTraceStep = MessageTrace | EvmStep;
-
-export interface EvmStep {
-  pc: number;
-}
-
-export function isCallOutput(
-  output: CallOutput | CreateOutput
-): output is CallOutput {
-  return !isCreateOutput(output);
-}
-
-export function isCreateOutput(
-  output: CallOutput | CreateOutput
-): output is CreateOutput {
-  return "address" in output;
-}
-
-export function isSuccessResult(
-  result: SuccessResult | RevertResult | HaltResult
-): result is SuccessResult {
-  // Only need to check for one unique field
-  return "gasRefunded" in result;
-}
-
-export function isRevertResult(
-  result: SuccessResult | RevertResult | HaltResult
-): result is RevertResult {
-  return !("reason" in result);
-}
-
-export function isHaltResult(
-  result: SuccessResult | RevertResult | HaltResult
-): result is HaltResult {
-  return !("output" in result);
-}

package/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,
@@ -258,24 +259,21 @@ function getMessageFromLastStackTraceEntry(
       return `Transaction reverted: library was called directly`;
 
     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()}'`;
+    case StackTraceEntryType.UNRECOGNIZED_CONTRACT_ERROR: {
+      const returnData = new ReturnData(stackTraceEntry.returnData);
+      if (returnData.isErrorReturnData()) {
+        return `VM Exception while processing transaction: reverted with reason string '${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) {
@@ -283,10 +281,12 @@ 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()}'`;
+    case StackTraceEntryType.REVERT_ERROR: {
+      const returnData = new ReturnData(stackTraceEntry.returnData);
+      if (returnData.isErrorReturnData()) {
+        return `VM Exception while processing transaction: reverted with reason string '${returnData.decodeError()}'`;
       }
 
       if (stackTraceEntry.isInvalidOpcodeError) {
@@ -294,6 +294,7 @@ function getMessageFromLastStackTraceEntry(
       }
 
       return "Transaction reverted without a reason string";
+    }
 
     case StackTraceEntryType.PANIC_ERROR:
       const panicMessage = panicErrorCodeToMessage(stackTraceEntry.errorCode);

package/src/internal/hardhat-network/stack-traces/solidity-stack-trace.ts

@@ -1,189 +1,86 @@
-import { ReturnData } from "../provider/return-data";
-
-import { ContractFunctionType } from "./model";
-
-export enum StackTraceEntryType {
-  CALLSTACK_ENTRY,
-  UNRECOGNIZED_CREATE_CALLSTACK_ENTRY,
-  UNRECOGNIZED_CONTRACT_CALLSTACK_ENTRY,
-  PRECOMPILE_ERROR,
-  REVERT_ERROR,
-  PANIC_ERROR,
-  CUSTOM_ERROR,
-  FUNCTION_NOT_PAYABLE_ERROR,
-  INVALID_PARAMS_ERROR,
-  FALLBACK_NOT_PAYABLE_ERROR,
-  FALLBACK_NOT_PAYABLE_AND_NO_RECEIVE_ERROR,
-  UNRECOGNIZED_FUNCTION_WITHOUT_FALLBACK_ERROR, // TODO: Should trying to call a private/internal be a special case of this?
-  MISSING_FALLBACK_OR_RECEIVE_ERROR,
-  RETURNDATA_SIZE_ERROR,
-  NONCONTRACT_ACCOUNT_CALLED_ERROR,
-  CALL_FAILED_ERROR,
-  DIRECT_LIBRARY_CALL_ERROR,
-  UNRECOGNIZED_CREATE_ERROR,
-  UNRECOGNIZED_CONTRACT_ERROR,
-  OTHER_EXECUTION_ERROR,
-  // This is a special case to handle a regression introduced in solc 0.6.3
-  // For more info: https://github.com/ethereum/solidity/issues/9006
-  UNMAPPED_SOLC_0_6_3_REVERT_ERROR,
-  CONTRACT_TOO_LARGE_ERROR,
-  INTERNAL_FUNCTION_CALLSTACK_ENTRY,
-  CONTRACT_CALL_RUN_OUT_OF_GAS_ERROR,
-}
-
-export const FALLBACK_FUNCTION_NAME = "<fallback>";
-export const RECEIVE_FUNCTION_NAME = "<receive>";
-export const CONSTRUCTOR_FUNCTION_NAME = "constructor";
-export const UNRECOGNIZED_FUNCTION_NAME = "<unrecognized-selector>";
-export const UNKNOWN_FUNCTION_NAME = "<unknown>";
-export const PRECOMPILE_FUNCTION_NAME = "<precompile>";
-export const UNRECOGNIZED_CONTRACT_NAME = "<UnrecognizedContract>";
-
-export interface SourceReference {
-  sourceName: string;
-  sourceContent: string;
-  contract?: string;
-  function?: string;
-  line: number;
-  range: [number, number];
-}
-
-export interface CallstackEntryStackTraceEntry {
-  type: StackTraceEntryType.CALLSTACK_ENTRY;
-  sourceReference: SourceReference;
-  functionType: ContractFunctionType;
-}
-
-export interface UnrecognizedCreateCallstackEntryStackTraceEntry {
-  type: StackTraceEntryType.UNRECOGNIZED_CREATE_CALLSTACK_ENTRY;
-  sourceReference?: undefined;
-}
-
-export interface UnrecognizedContractCallstackEntryStackTraceEntry {
-  type: StackTraceEntryType.UNRECOGNIZED_CONTRACT_CALLSTACK_ENTRY;
-  address: Uint8Array;
-  sourceReference?: undefined;
-}
-
-export interface PrecompileErrorStackTraceEntry {
-  type: StackTraceEntryType.PRECOMPILE_ERROR;
-  precompile: number;
-  sourceReference?: undefined;
-}
-
-export interface RevertErrorStackTraceEntry {
-  type: StackTraceEntryType.REVERT_ERROR;
-  message: ReturnData;
-  sourceReference: SourceReference;
-  isInvalidOpcodeError: boolean;
-}
-
-export interface PanicErrorStackTraceEntry {
-  type: StackTraceEntryType.PANIC_ERROR;
-  errorCode: bigint;
-  sourceReference?: SourceReference;
-}
-
-export interface CustomErrorStackTraceEntry {
-  type: StackTraceEntryType.CUSTOM_ERROR;
-  // unlike RevertErrorStackTraceEntry, this includes the message already parsed
-  message: string;
-  sourceReference: SourceReference;
-}
-
-export interface UnmappedSolc063RevertErrorStackTraceEntry {
-  type: StackTraceEntryType.UNMAPPED_SOLC_0_6_3_REVERT_ERROR;
-  sourceReference?: SourceReference;
-}
-
-export interface FunctionNotPayableErrorStackTraceEntry {
-  type: StackTraceEntryType.FUNCTION_NOT_PAYABLE_ERROR;
-  value: bigint;
-  sourceReference: SourceReference;
-}
-
-export interface InvalidParamsErrorStackTraceEntry {
-  type: StackTraceEntryType.INVALID_PARAMS_ERROR;
-  sourceReference: SourceReference;
-}
-
-export interface FallbackNotPayableErrorStackTraceEntry {
-  type: StackTraceEntryType.FALLBACK_NOT_PAYABLE_ERROR;
-  value: bigint;
-  sourceReference: SourceReference;
-}
-
-export interface FallbackNotPayableAndNoReceiveErrorStackTraceEntry {
-  type: StackTraceEntryType.FALLBACK_NOT_PAYABLE_AND_NO_RECEIVE_ERROR;
-  value: bigint;
-  sourceReference: SourceReference;
-}
-
-export interface UnrecognizedFunctionWithoutFallbackErrorStackTraceEntry {
-  type: StackTraceEntryType.UNRECOGNIZED_FUNCTION_WITHOUT_FALLBACK_ERROR;
-  sourceReference: SourceReference;
-}
-
-export interface MissingFallbackOrReceiveErrorStackTraceEntry {
-  type: StackTraceEntryType.MISSING_FALLBACK_OR_RECEIVE_ERROR;
-  sourceReference: SourceReference;
-}
-
-export interface ReturndataSizeErrorStackTraceEntry {
-  type: StackTraceEntryType.RETURNDATA_SIZE_ERROR;
-  sourceReference: SourceReference;
-}
-
-export interface NonContractAccountCalledErrorStackTraceEntry {
-  type: StackTraceEntryType.NONCONTRACT_ACCOUNT_CALLED_ERROR;
-  sourceReference: SourceReference;
-}
-
-export interface CallFailedErrorStackTraceEntry {
-  type: StackTraceEntryType.CALL_FAILED_ERROR;
-  sourceReference: SourceReference;
-}
-
-export interface DirectLibraryCallErrorStackTraceEntry {
-  type: StackTraceEntryType.DIRECT_LIBRARY_CALL_ERROR;
-  sourceReference: SourceReference;
-}
-
-export interface UnrecognizedCreateErrorStackTraceEntry {
-  type: StackTraceEntryType.UNRECOGNIZED_CREATE_ERROR;
-  message: ReturnData;
-  sourceReference?: undefined;
-  isInvalidOpcodeError: boolean;
-}
-
-export interface UnrecognizedContractErrorStackTraceEntry {
-  type: StackTraceEntryType.UNRECOGNIZED_CONTRACT_ERROR;
-  address: Uint8Array;
-  message: ReturnData;
-  sourceReference?: undefined;
-  isInvalidOpcodeError: boolean;
-}
-
-export interface OtherExecutionErrorStackTraceEntry {
-  type: StackTraceEntryType.OTHER_EXECUTION_ERROR;
-  sourceReference?: SourceReference;
-}
-
-export interface ContractTooLargeErrorStackTraceEntry {
-  type: StackTraceEntryType.CONTRACT_TOO_LARGE_ERROR;
-  sourceReference?: SourceReference;
-}
-
-export interface InternalFunctionCallStackEntry {
-  type: StackTraceEntryType.INTERNAL_FUNCTION_CALLSTACK_ENTRY;
-  pc: number;
-  sourceReference: SourceReference;
-}
-
-export interface ContractCallRunOutOfGasError {
-  type: StackTraceEntryType.CONTRACT_CALL_RUN_OUT_OF_GAS_ERROR;
-  sourceReference?: SourceReference;
-}
+import type {
+  SourceReference,
+  CallstackEntryStackTraceEntry,
+  UnrecognizedCreateCallstackEntryStackTraceEntry,
+  UnrecognizedContractCallstackEntryStackTraceEntry,
+  PrecompileErrorStackTraceEntry,
+  RevertErrorStackTraceEntry,
+  PanicErrorStackTraceEntry,
+  CustomErrorStackTraceEntry,
+  FunctionNotPayableErrorStackTraceEntry,
+  InvalidParamsErrorStackTraceEntry,
+  FallbackNotPayableErrorStackTraceEntry,
+  FallbackNotPayableAndNoReceiveErrorStackTraceEntry,
+  UnrecognizedFunctionWithoutFallbackErrorStackTraceEntry,
+  MissingFallbackOrReceiveErrorStackTraceEntry,
+  ReturndataSizeErrorStackTraceEntry,
+  NonContractAccountCalledErrorStackTraceEntry,
+  CallFailedErrorStackTraceEntry,
+  DirectLibraryCallErrorStackTraceEntry,
+  UnrecognizedCreateErrorStackTraceEntry,
+  UnrecognizedContractErrorStackTraceEntry,
+  OtherExecutionErrorStackTraceEntry,
+  UnmappedSolc063RevertErrorStackTraceEntry,
+  ContractTooLargeErrorStackTraceEntry,
+  InternalFunctionCallStackEntry,
+  ContractCallRunOutOfGasError,
+} from "@nomicfoundation/edr";
+
+import { requireNapiRsModule } from "../../../common/napi-rs";
+
+const {
+  StackTraceEntryType,
+  stackTraceEntryTypeToString,
+  FALLBACK_FUNCTION_NAME,
+  RECEIVE_FUNCTION_NAME,
+  CONSTRUCTOR_FUNCTION_NAME,
+  UNRECOGNIZED_FUNCTION_NAME,
+  UNKNOWN_FUNCTION_NAME,
+  PRECOMPILE_FUNCTION_NAME,
+  UNRECOGNIZED_CONTRACT_NAME,
+} = requireNapiRsModule(
+  "@nomicfoundation/edr"
+) as typeof import("@nomicfoundation/edr");
+
+export {
+  SourceReference,
+  StackTraceEntryType,
+  stackTraceEntryTypeToString,
+  FALLBACK_FUNCTION_NAME,
+  RECEIVE_FUNCTION_NAME,
+  CONSTRUCTOR_FUNCTION_NAME,
+  UNRECOGNIZED_FUNCTION_NAME,
+  UNKNOWN_FUNCTION_NAME,
+  PRECOMPILE_FUNCTION_NAME,
+  UNRECOGNIZED_CONTRACT_NAME,
+};
+
+export type {
+  CallstackEntryStackTraceEntry,
+  UnrecognizedCreateCallstackEntryStackTraceEntry,
+  UnrecognizedContractCallstackEntryStackTraceEntry,
+  PrecompileErrorStackTraceEntry,
+  RevertErrorStackTraceEntry,
+  PanicErrorStackTraceEntry,
+  CustomErrorStackTraceEntry,
+  FunctionNotPayableErrorStackTraceEntry,
+  InvalidParamsErrorStackTraceEntry,
+  FallbackNotPayableErrorStackTraceEntry,
+  FallbackNotPayableAndNoReceiveErrorStackTraceEntry,
+  UnrecognizedFunctionWithoutFallbackErrorStackTraceEntry,
+  MissingFallbackOrReceiveErrorStackTraceEntry,
+  ReturndataSizeErrorStackTraceEntry,
+  NonContractAccountCalledErrorStackTraceEntry,
+  CallFailedErrorStackTraceEntry,
+  DirectLibraryCallErrorStackTraceEntry,
+  UnrecognizedCreateErrorStackTraceEntry,
+  UnrecognizedContractErrorStackTraceEntry,
+  OtherExecutionErrorStackTraceEntry,
+  UnmappedSolc063RevertErrorStackTraceEntry,
+  ContractTooLargeErrorStackTraceEntry,
+  InternalFunctionCallStackEntry,
+  ContractCallRunOutOfGasError,
+};
 
 export type SolidityStackTraceEntry =
   | CallstackEntryStackTraceEntry