Change edr_napi::provider::Response::solidity_trace to return a stack trace

.changeset/dirty-humans-exercise.md

@@ -0,0 +1,5 @@
+---
+"@nomicfoundation/edr": minor
+---
+
+Add a `stackTrace` getter to the provider's response and remove the old, lower-level `solidityTrace` getter.

crates/edr_evm/src/trace.rs

@@ -192,7 +192,7 @@ pub struct Trace {
 #[derive(Clone, Debug)]
 pub struct Step {
     /// The program counter
-    pub pc: u64,
+    pub pc: u32,
     /// The call depth
     pub depth: u64,
     /// The executed op code
@@ -491,7 +491,10 @@ impl TraceCollector {
                 None
             };
             self.current_trace_mut().add_step(Step {
-                pc: interp.program_counter() as u64,
+                pc: interp
+                    .program_counter()
+                    .try_into()
+                    .expect("program counter fits into u32"),
                 depth: data.journaled_state.depth(),
                 opcode: interp.current_opcode(),
                 stack,

crates/edr_napi/index.d.ts

@@ -149,8 +149,6 @@ export interface LoggerConfig {
   /** Whether to enable the logger. */
   enable: boolean
   decodeConsoleLogInputsCallback: (inputs: Buffer[]) => string[]
-  /** Used to resolve the contract and function name when logging. */
-  getContractAndFunctionNameCallback: (code: Buffer, calldata?: Buffer) => ContractAndFunctionName
   printLineCallback: (message: string, replace: boolean) => void
 }
 /** Configuration for a chain */
@@ -346,18 +344,7 @@ export interface SubscriptionEvent {
   filterId: bigint
   result: any
 }
-export declare function createModelsAndDecodeBytecodes(solcVersion: string, compilerInput: any, compilerOutput: any): Array<BytecodeWrapper>
 export declare function linkHexStringBytecode(code: string, address: string, position: number): string
-export const enum ContractFunctionType {
-  CONSTRUCTOR = 0,
-  FUNCTION = 1,
-  FALLBACK = 2,
-  RECEIVE = 3,
-  GETTER = 4,
-  MODIFIER = 5,
-  FREE_FUNCTION = 6
-}
-export declare function printMessageTrace(trace: PrecompileMessageTrace | CallMessageTrace | CreateMessageTrace, depth?: number | undefined | null): void
 export declare function printStackTrace(trace: SolidityStackTrace): void
 /** Represents the exit code of the EVM. */
 export const enum ExitCode {
@@ -380,51 +367,14 @@ export const enum ExitCode {
   /** Unknown halt reason. */
   UNKNOWN_HALT_REASON = 8
 }
-export interface EvmStep {
-  pc: number
-}
-export interface PrecompileMessageTrace {
-  value: bigint
-  returnData: Uint8Array
-  exit: Exit
-  gasUsed: bigint
-  depth: number
-  precompile: number
-  calldata: Uint8Array
-}
-export interface CreateMessageTrace {
-  value: bigint
-  returnData: Uint8Array
-  exit: Exit
-  gasUsed: bigint
-  depth: number
-  code: Uint8Array
-  steps: Array<EvmStep | PrecompileMessageTrace | CallMessageTrace | CreateMessageTrace>
-  /**
-   * Reference to the resolved `Bytecode` EDR data.
-   * Only used on the JS side by the `VmTraceDecoder` class.
-   */
-  bytecode?: BytecodeWrapper
-  numberOfSubtraces: number
-  deployedContract?: Uint8Array | undefined
-}
-export interface CallMessageTrace {
-  value: bigint
-  returnData: Uint8Array
-  exit: Exit
-  gasUsed: bigint
-  depth: number
-  code: Uint8Array
-  steps: Array<EvmStep | PrecompileMessageTrace | CallMessageTrace | CreateMessageTrace>
-  /**
-   * Reference to the resolved `Bytecode` EDR data.
-   * Only used on the JS side by the `VmTraceDecoder` class.
-   */
-  bytecode?: BytecodeWrapper
-  numberOfSubtraces: number
-  calldata: Uint8Array
-  address: Uint8Array
-  codeAddress: Uint8Array
+export const enum ContractFunctionType {
+  CONSTRUCTOR = 0,
+  FUNCTION = 1,
+  FALLBACK = 2,
+  RECEIVE = 3,
+  GETTER = 4,
+  MODIFIER = 5,
+  FREE_FUNCTION = 6
 }
 export const enum StackTraceEntryType {
   CALLSTACK_ENTRY = 0,
@@ -580,11 +530,6 @@ export interface ContractCallRunOutOfGasError {
   type: StackTraceEntryType.CONTRACT_CALL_RUN_OUT_OF_GAS_ERROR
   sourceReference?: SourceReference
 }
-export interface ContractAndFunctionName {
-  contractName: string
-  functionName: string | undefined
-}
-export declare function initializeVmTraceDecoder(vmTraceDecoder: VmTraceDecoder, tracingConfig: any): void
 export interface TracingMessage {
   /** Sender address */
   readonly caller: Buffer
@@ -645,7 +590,7 @@ export declare class EdrContext {
 /** A JSON-RPC provider for Ethereum. */
 export declare class Provider {
   /**Constructs a new provider with the provided configuration. */
-  static withConfig(context: EdrContext, config: ProviderConfig, loggerConfig: LoggerConfig, subscriberCallback: (event: SubscriptionEvent) => void): Promise<Provider>
+  static withConfig(context: EdrContext, config: ProviderConfig, loggerConfig: LoggerConfig, tracingConfig: any, subscriberCallback: (event: SubscriptionEvent) => void): Promise<Provider>
   /**Handles a JSON-RPC request and returns a JSON-RPC response. */
   handleRequest(jsonRequest: string): Promise<Response>
   setCallOverrideCallback(callOverrideCallback: (contract_address: Buffer, data: Buffer) => Promise<CallOverrideResult | undefined>): void
@@ -660,19 +605,20 @@ export declare class Provider {
 export declare class Response {
   /** Returns the response data as a JSON string or a JSON object. */
   get data(): string | any
-  get solidityTrace(): RawTrace | null
   get traces(): Array<RawTrace>
+  /**Compute the error stack trace. Return undefined if there was no error, returns the stack trace if it can be computed or returns the error message if available as a fallback. */
+  stackTrace(): SolidityStackTrace | string | null
 }
-/**
- * Opaque handle to the `Bytecode` struct.
- * Only used on the JS side by the `VmTraceDecoder` class.
- */
-export declare class BytecodeWrapper { }
 export declare class Exit {
   get kind(): ExitCode
   isError(): boolean
   getReason(): string
 }
+/**
+ * Opaque handle to the `Bytecode` struct.
+ * Only used on the JS side by the `VmTraceDecoder` class.
+ */
+export declare class BytecodeWrapper { }
 export declare class ReturnData {
   readonly value: Uint8Array
   constructor(value: Uint8Array)
@@ -682,26 +628,6 @@ export declare class ReturnData {
   decodeError(): string
   decodePanic(): bigint
 }
-export declare class SolidityTracer {
-
-  constructor()
-  getStackTrace(trace: PrecompileMessageTrace | CallMessageTrace | CreateMessageTrace): SolidityStackTrace
-}
-export declare class VmTraceDecoder {
-  constructor()
-  addBytecode(bytecode: BytecodeWrapper): void
-  tryToDecodeMessageTrace(messageTrace: PrecompileMessageTrace | CallMessageTrace | CreateMessageTrace): PrecompileMessageTrace | CallMessageTrace | CreateMessageTrace
-  getContractAndFunctionNamesForCall(code: Uint8Array, calldata: Uint8Array | undefined): ContractAndFunctionName
-}
-export type VMTracer = VmTracer
-/** N-API bindings for the Rust port of `VMTracer` from Hardhat. */
-export declare class VmTracer {
-  constructor()
-  /** Observes a trace, collecting information about the execution of the EVM. */
-  observe(trace: RawTrace): void
-  getLastTopLevelMessageTrace(): PrecompileMessageTrace | CallMessageTrace | CreateMessageTrace | undefined
-  getLastError(): Error | undefined
-}
 export declare class RawTrace {
   trace(): Array<TracingMessage | TracingStep | TracingMessageResult>
 }

crates/edr_napi/index.js

@@ -310,7 +310,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { SpecId, EdrContext, MineOrdering, Provider, Response, SuccessReason, ExceptionalHalt, createModelsAndDecodeBytecodes, linkHexStringBytecode, BytecodeWrapper, ContractFunctionType, printMessageTrace, printStackTrace, Exit, ExitCode, ReturnData, StackTraceEntryType, stackTraceEntryTypeToString, FALLBACK_FUNCTION_NAME, RECEIVE_FUNCTION_NAME, CONSTRUCTOR_FUNCTION_NAME, UNRECOGNIZED_FUNCTION_NAME, UNKNOWN_FUNCTION_NAME, PRECOMPILE_FUNCTION_NAME, UNRECOGNIZED_CONTRACT_NAME, SolidityTracer, VmTraceDecoder, initializeVmTraceDecoder, VmTracer, RawTrace } = nativeBinding
+const { SpecId, EdrContext, MineOrdering, Provider, Response, SuccessReason, ExceptionalHalt, linkHexStringBytecode, printStackTrace, Exit, ExitCode, BytecodeWrapper, ContractFunctionType, ReturnData, StackTraceEntryType, stackTraceEntryTypeToString, FALLBACK_FUNCTION_NAME, RECEIVE_FUNCTION_NAME, CONSTRUCTOR_FUNCTION_NAME, UNRECOGNIZED_FUNCTION_NAME, UNKNOWN_FUNCTION_NAME, PRECOMPILE_FUNCTION_NAME, UNRECOGNIZED_CONTRACT_NAME, RawTrace } = nativeBinding
 
 module.exports.SpecId = SpecId
 module.exports.EdrContext = EdrContext
@@ -319,14 +319,12 @@ module.exports.Provider = Provider
 module.exports.Response = Response
 module.exports.SuccessReason = SuccessReason
 module.exports.ExceptionalHalt = ExceptionalHalt
-module.exports.createModelsAndDecodeBytecodes = createModelsAndDecodeBytecodes
 module.exports.linkHexStringBytecode = linkHexStringBytecode
-module.exports.BytecodeWrapper = BytecodeWrapper
-module.exports.ContractFunctionType = ContractFunctionType
-module.exports.printMessageTrace = printMessageTrace
 module.exports.printStackTrace = printStackTrace
 module.exports.Exit = Exit
 module.exports.ExitCode = ExitCode
+module.exports.BytecodeWrapper = BytecodeWrapper
+module.exports.ContractFunctionType = ContractFunctionType
 module.exports.ReturnData = ReturnData
 module.exports.StackTraceEntryType = StackTraceEntryType
 module.exports.stackTraceEntryTypeToString = stackTraceEntryTypeToString
@@ -337,8 +335,4 @@ module.exports.UNRECOGNIZED_FUNCTION_NAME = UNRECOGNIZED_FUNCTION_NAME
 module.exports.UNKNOWN_FUNCTION_NAME = UNKNOWN_FUNCTION_NAME
 module.exports.PRECOMPILE_FUNCTION_NAME = PRECOMPILE_FUNCTION_NAME
 module.exports.UNRECOGNIZED_CONTRACT_NAME = UNRECOGNIZED_CONTRACT_NAME
-module.exports.SolidityTracer = SolidityTracer
-module.exports.VmTraceDecoder = VmTraceDecoder
-module.exports.initializeVmTraceDecoder = initializeVmTraceDecoder
-module.exports.VmTracer = VmTracer
 module.exports.RawTrace = RawTrace