refactor: Port ErrorInferrer and SolidityTracer from Hardhat (#593)

* Start porting SolidityTracer

* Start porting ErrorInferrer

* WIP: Keep Reference in MessageTraces

* Port 99% of the ErrorInferrer

Except `ErrorInferrer.inferAfterTracing`. I discovered that the original
code creates a shallow copy of the stack trace during select heuristics
and returns the modified one or the *original* one if the heuristic does
not hit.

One could keep track of possible series of changes that would have to be
subsequently applied if the heuristic hits and returns a modified the
stack trace but instead, I want the code to do exactly what the original
code did.

Rather than wrap every entry in a shareable `Rc` (they are not
modified), I decided to make them clonable in the next PR, which means
we need to not keep the `ClassInstance` around to derive the Clone
trait.

* Port mapped-inlined-internal-functions-heuristics.ts

* refactor: Prune StackTraceEntry.message to make it clonable

See previous commit "Port 99% of the ErrorInferrer".

* refactor: Drop unused inner funcs in the ErrorInferrer

* feat: Finish porting `ErrorInferrer`

* feat: Finish porting `SolidityTracer`

* refactor: Remove now unused utils IntoEither/IntoOption

* patch(hardhat): Port ErrorInferrer and SolidityTracer

* fixup! refactor: Prune StackTraceEntry.message to make it clonable

* fixup: Reformat

* Document the unsafety surrounding napi-rs's References

* refactor: Remove some now unused functions

* Address review feedback

* fix a missing period

* fix alphabetical sorting

Author: Xanewok

Cargo.lock

@@ -7,6 +7,8 @@ edition = "2021"
 crate-type = ["cdylib"]
 
 [dependencies]
+alloy-dyn-abi = { version = "0.7.6", default-features = false }
+alloy-json-abi = { version = "0.7.4", default-features = false }
 alloy-sol-types = { version = "0.5.1", default-features = false, features = ["std"] }
 ansi_term = { version = "0.12.1", default-features = false }
 crossbeam-channel = { version = "0.5.6", default-features = false }
@@ -32,6 +34,7 @@ tracing-subscriber = { version = "0.3.18", default-features = false, features =
 parking_lot = { version = "0.12.1", default-features = false }
 lazy_static = { version = "1.4.0", features = [] }
 rand = { version = "0.8.4", optional = true }
+semver = "1.0.22"
 serde = { version = "1.0.189", features = ["derive"] }
 strum = { version = "0.26.0", features = ["derive"] }
 mimalloc = { version = "0.1.39", default-features = false, features = ["local_dynamic_tls"] }

crates/edr_napi/Cargo.toml

@@ -387,6 +387,11 @@ export interface SourceMap {
   location: SourceMapLocation
   jumpType: JumpType
 }
+export interface SubmessageData {
+  messageTrace: PrecompileMessageTrace | CallMessageTrace | CreateMessageTrace
+  stacktrace: SolidityStackTrace
+  stepIndex: number
+}
 /** Represents the exit code of the EVM. */
 export const enum ExitCode {
   /** Execution was successful. */
@@ -770,7 +775,7 @@ export interface PrecompileErrorStackTraceEntry {
 }
 export interface RevertErrorStackTraceEntry {
   type: StackTraceEntryType.REVERT_ERROR
-  message: ReturnData
+  returnData: Uint8Array
   sourceReference: SourceReference
   isInvalidOpcodeError: boolean
 }
@@ -784,10 +789,6 @@ export interface CustomErrorStackTraceEntry {
   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
@@ -833,21 +834,25 @@ export interface DirectLibraryCallErrorStackTraceEntry {
 }
 export interface UnrecognizedCreateErrorStackTraceEntry {
   type: StackTraceEntryType.UNRECOGNIZED_CREATE_ERROR
-  message: ReturnData
+  returnData: Uint8Array
   sourceReference?: undefined
   isInvalidOpcodeError: boolean
 }
 export interface UnrecognizedContractErrorStackTraceEntry {
   type: StackTraceEntryType.UNRECOGNIZED_CONTRACT_ERROR
   address: Uint8Array
-  message: ReturnData
+  returnData: Uint8Array
   sourceReference?: undefined
   isInvalidOpcodeError: boolean
 }
 export interface OtherExecutionErrorStackTraceEntry {
   type: StackTraceEntryType.OTHER_EXECUTION_ERROR
   sourceReference?: SourceReference
 }
+export interface UnmappedSolc063RevertErrorStackTraceEntry {
+  type: StackTraceEntryType.UNMAPPED_SOLC_0_6_3_REVERT_ERROR
+  sourceReference?: SourceReference
+}
 export interface ContractTooLargeErrorStackTraceEntry {
   type: StackTraceEntryType.CONTRACT_TOO_LARGE_ERROR
   sourceReference?: SourceReference
@@ -1010,12 +1015,16 @@ export class ReturnData {
   readonly value: Uint8Array
   constructor(value: Uint8Array)
   isEmpty(): boolean
-  matchesSelector(selector: Uint8Array): boolean
   isErrorReturnData(): boolean
   isPanicReturnData(): boolean
   decodeError(): string
   decodePanic(): bigint
 }
+export class SolidityTracer {
+  
+  constructor()
+  getStackTrace(trace: PrecompileMessageTrace | CallMessageTrace | CreateMessageTrace): SolidityStackTrace
+}
 export class VmTraceDecoder {
   constructor(contractsIdentifier: ContractsIdentifier)
   addBytecode(bytecode: Bytecode): void

crates/edr_napi/index.d.ts

@@ -310,7 +310,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { SpecId, EdrContext, MineOrdering, Provider, Response, SuccessReason, ExceptionalHalt, createModelsAndDecodeBytecodes, linkHexStringBytecode, SourceFile, SourceLocation, ContractFunctionType, ContractFunctionVisibility, ContractFunction, CustomError, Instruction, JumpType, jumpTypeToString, Bytecode, ContractType, Contract, ContractsIdentifier, Exit, ExitCode, Opcode, opcodeToString, isPush, isJump, isCall, isCreate, ReturnData, StackTraceEntryType, stackTraceEntryTypeToString, FALLBACK_FUNCTION_NAME, RECEIVE_FUNCTION_NAME, CONSTRUCTOR_FUNCTION_NAME, UNRECOGNIZED_FUNCTION_NAME, UNKNOWN_FUNCTION_NAME, PRECOMPILE_FUNCTION_NAME, UNRECOGNIZED_CONTRACT_NAME, VmTraceDecoder, initializeVmTraceDecoder, VmTracer, RawTrace } = nativeBinding
+const { SpecId, EdrContext, MineOrdering, Provider, Response, SuccessReason, ExceptionalHalt, createModelsAndDecodeBytecodes, linkHexStringBytecode, SourceFile, SourceLocation, ContractFunctionType, ContractFunctionVisibility, ContractFunction, CustomError, Instruction, JumpType, jumpTypeToString, Bytecode, ContractType, Contract, ContractsIdentifier, Exit, ExitCode, Opcode, opcodeToString, isPush, isJump, isCall, isCreate, 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
 
 module.exports.SpecId = SpecId
 module.exports.EdrContext = EdrContext
@@ -352,6 +352,7 @@ 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

crates/edr_napi/index.js

@@ -22,11 +22,14 @@ mod model;
 mod source_map;
 
 mod contracts_identifier;
+mod error_inferrer;
 mod exit;
+mod mapped_inlined_internal_functions_heuristics;
 mod message_trace;
 mod opcodes;
 mod return_data;
 mod solidity_stack_trace;
+mod solidity_tracer;
 mod vm_trace_decoder;
 mod vm_tracer;
 

crates/edr_napi/src/trace.rs

@@ -326,14 +326,8 @@ fn process_function_definition_ast_node(
 
     let param_types = matching_function_abi
         .as_ref()
-        .and_then(|matching_function_abi| {
-            matching_function_abi.inputs.as_ref().map(|inputs| {
-                inputs
-                    .iter()
-                    .map(|input| input["type"].as_str().unwrap())
-                    .collect::<Vec<_>>()
-            })
-        });
+        .and_then(|abi| abi.inputs.as_ref())
+        .cloned();
 
     let contract_func = ContractFunction {
         name: node["name"].as_str().unwrap().to_string(),
@@ -343,7 +337,7 @@ fn process_function_definition_ast_node(
         visibility: Some(visibility),
         is_payable: Some(node["stateMutability"].as_str().unwrap() == "payable"),
         selector: selector.map(Uint8Array::from),
-        param_types: Some(param_types.into_iter().map(Into::into).collect()),
+        param_types,
     }
     .into_instance(env)?;
     let contract_func = Rc::new(ClassInstanceRef::from_obj(contract_func, env)?);
@@ -414,13 +408,8 @@ fn process_variable_declaration_ast_node(
 
     let param_types = getter_abi
         .as_ref()
-        .and_then(|getter_abi| getter_abi.inputs.as_ref())
-        .map(|inputs| {
-            inputs
-                .iter()
-                .map(|input| input["type"].as_str().unwrap())
-                .collect::<Vec<_>>()
-        });
+        .and_then(|abi| abi.inputs.as_ref())
+        .cloned();
 
     let contract_func = ContractFunction {
         name: node["name"].as_str().unwrap().to_string(),
@@ -432,7 +421,7 @@ fn process_variable_declaration_ast_node(
         selector: Some(Uint8Array::from(
             get_public_variable_selector_from_declaration_ast_node(node)?,
         )),
-        param_types: Some(param_types.into_iter().map(Into::into).collect()),
+        param_types,
     }
     .into_instance(env)?;
     let contract_func = Rc::new(ClassInstanceRef::from_obj(contract_func, env)?);