Ensure all stack trace entry types are handled

Author: fvictorio

v-next/hardhat/src/internal/builtin-plugins/network-manager/edr/stack-traces/solidity-stack-trace.ts

@@ -24,6 +24,7 @@ import type {
   ContractTooLargeErrorStackTraceEntry,
   InternalFunctionCallStackEntry,
   ContractCallRunOutOfGasError,
+  CheatcodeErrorStackTraceEntry,
 } from "@nomicfoundation/edr";
 
 import {
@@ -102,6 +103,7 @@ export type SolidityStackTraceEntry =
   | UnmappedSolc063RevertErrorStackTraceEntry
   | ContractTooLargeErrorStackTraceEntry
   | InternalFunctionCallStackEntry
-  | ContractCallRunOutOfGasError;
+  | ContractCallRunOutOfGasError
+  | CheatcodeErrorStackTraceEntry;
 
 export type SolidityStackTrace = SolidityStackTraceEntry[];

v-next/hardhat/src/internal/builtin-plugins/network-manager/edr/stack-traces/stack-trace-solidity-errors.ts

@@ -89,6 +89,7 @@ export function encodeStackTraceEntry(
     case StackTraceEntryType.RETURNDATA_SIZE_ERROR:
     case StackTraceEntryType.NONCONTRACT_ACCOUNT_CALLED_ERROR:
     case StackTraceEntryType.CALL_FAILED_ERROR:
+    case StackTraceEntryType.CHEATCODE_ERROR:
     case StackTraceEntryType.DIRECT_LIBRARY_CALL_ERROR:
       return sourceReferenceToSolidityCallsite(stackTraceEntry.sourceReference);
 
@@ -265,6 +266,7 @@ function getMessageFromLastStackTraceEntry(
       return `VM Exception while processing transaction: ${panicMessage}`;
 
     case StackTraceEntryType.CUSTOM_ERROR:
+    case StackTraceEntryType.CHEATCODE_ERROR:
       return `VM Exception while processing transaction: ${stackTraceEntry.message}`;
 
     case StackTraceEntryType.OTHER_EXECUTION_ERROR:

v-next/hardhat/src/internal/builtin-plugins/solidity-test/stack-trace-solidity-errors.ts

@@ -63,6 +63,9 @@ export function getMessageFromLastStackTraceEntry(
     case StackTraceEntryType.CUSTOM_ERROR:
       return stackTraceEntry.message;
 
+    case StackTraceEntryType.CHEATCODE_ERROR:
+      return stackTraceEntry.message;
+
     case StackTraceEntryType.CONTRACT_TOO_LARGE_ERROR:
       return "Trying to deploy a contract whose code is too large";
 

v-next/hardhat/test/internal/builtin-plugins/network-manager/edr/stack-traces/stack-trace-solidity-errors.ts

@@ -1,3 +1,8 @@
+import type {
+  SolidityStackTraceEntry,
+  StackTraceEntryType,
+} from "../../../../../../src/internal/builtin-plugins/network-manager/edr/stack-traces/solidity-stack-trace.js";
+
 import assert from "node:assert/strict";
 import { describe, it } from "node:test";
 
@@ -37,5 +42,19 @@ describe("SolidityCallSite", function () {
 
       assert.equal(callSite.toString(), "Contract.functionName (Source.sol:1)");
     });
+
+    it("exhaustive stack trace entries", async () => {
+      // This is a type-only test to ensure that the SolidityStackTraceEntry union type
+      // includes all the expected variants.
+      const hhEntryType = (_entryType: SolidityStackTraceEntry["type"]) => {};
+      const edrEntryType = (_entryType: StackTraceEntryType) => {};
+
+      const _test1 = (entryType: SolidityStackTraceEntry["type"]) => {
+        edrEntryType(entryType);
+      };
+      const _test2 = (entryType: StackTraceEntryType) => {
+        hhEntryType(entryType);
+      };
+    });
   });
 });