✨ Feat: Add official tevm trace methods

tevm/api/index.ts

@@ -1,4 +1,25 @@
 export type {
+	StructLog,
+	TraceCallParams,
+	TraceCallResult,
+	TraceCallHandler,
+	TraceScriptParams,
+	TraceScriptResult,
+	TraceCallProcedure,
+	TraceScriptHandler,
+	AnvilJsonRpcRequest,
+	DebugJsonRpcRequest,
+	TraceContractParams,
+	TraceContractResult,
+	TraceContractHandler,
+	TraceScriptProcedure,
+	TraceContractProcedure,
+	TraceCallJsonRpcRequest,
+	TraceCallJsonRpcResponse,
+	TraceScriptJsonRpcRequest,
+	TraceScriptJsonRpcResponse,
+	TraceContractJsonRpcRequest,
+	TraceContractJsonRpcResponse,
 	AnvilImpersonateAccountParams,
 	AnvilMineParams,
 	DebugTraceCallParams,

vm/api/src/Tevm.ts

@@ -3,16 +3,18 @@ import type {
 	AccountHandler,
 	CallHandler,
 	ContractHandler,
-	// DebugTraceCallHandler,
-	// DebugTraceTransactionHandler,
+	DebugTraceCallHandler,
+	DebugTraceTransactionHandler,
 	EthBlockNumberHandler,
-	// EthCallHandler,
 	EthChainIdHandler,
 	EthGasPriceHandler,
 	EthGetBalanceHandler,
 	EthGetCodeHandler,
 	EthGetStorageAtHandler,
 	ScriptHandler,
+	TraceCallHandler,
+	TraceContractHandler,
+	TraceScriptHandler,
 } from './handlers/index.js'
 
 /**
@@ -27,25 +29,19 @@ export type Tevm = {
 	account: AccountHandler
 	call: CallHandler
 	contract: ContractHandler
+	traceCall: TraceCallHandler
+	traceContract: TraceContractHandler
+	traceScript: TraceScriptHandler
 	eth: {
 		blockNumber: EthBlockNumberHandler
 		chainId: EthChainIdHandler
-		// call: EthCallHandler
 		getCode: EthGetCodeHandler
 		getStorageAt: EthGetStorageAtHandler
 		gasPrice: EthGasPriceHandler
 		getBalance: EthGetBalanceHandler
 	}
-	// Eth Handlers
-	// debug handlers
-	// traceTransaction: DebugTraceTransactionHandler
-	// traceCall: DebugTraceCallHandler
-	// anvil handlers
-	// Not implementing any yet
-	// hardhat handlers
-	// Not implementing any yet
-	// Ganache handlers
-	// Not implementing any yet
-	// Compile handlers
-	// Not implementing any yet
+	debug: {
+		traceTransaction: DebugTraceTransactionHandler
+		traceCall: DebugTraceCallHandler
+	}
 }

vm/api/src/TevmJsonRpcRequestHandler.ts

@@ -60,6 +60,9 @@ import type {
 import type { AnvilJsonRpcRequest } from './requests/AnvilJsonRpcRequest.js'
 import type { DebugJsonRpcRequest } from './requests/DebugJsonRpcRequest.js'
 import type { EthJsonRpcRequest } from './requests/EthJsonRpcRequest.js'
+import type { TraceCallJsonRpcResponse } from './responses/TraceCallJsonRpcResponse.js'
+import type { TraceContractJsonRpcResponse } from './responses/TraceContractJsonRpcResponse.js'
+import type { TraceScriptJsonRpcResponse } from './responses/TraceScriptJsonRpcResponse.js'
 
 type DebugReturnType = {
 	debug_traceTransaction: DebugTraceTransactionJsonRpcResponse
@@ -128,14 +131,17 @@ type TevmReturnType = {
 	tevm_call: CallJsonRpcResponse
 	tevm_script: ScriptJsonRpcResponse
 	tevm_account: AccountJsonRpcResponse
+	tevm_traceCall: TraceCallJsonRpcResponse
+	tevm_traceContract: TraceContractJsonRpcResponse
+	tevm_traceScript: TraceScriptJsonRpcResponse
 }
 
 type ReturnType<
 	TMethod extends
-		| keyof EthReturnType
-		| keyof TevmReturnType
-		| keyof AnvilReturnType
-		| keyof DebugReturnType,
+	| keyof EthReturnType
+	| keyof TevmReturnType
+	| keyof AnvilReturnType
+	| keyof DebugReturnType,
 > = (EthReturnType &
 	TevmReturnType &
 	AnvilReturnType &
@@ -147,10 +153,10 @@ type ReturnType<
  */
 export type TevmJsonRpcRequestHandler = <
 	TRequest extends
-		| TevmJsonRpcRequest
-		| EthJsonRpcRequest
-		| AnvilJsonRpcRequest
-		| DebugJsonRpcRequest,
+	| TevmJsonRpcRequest
+	| EthJsonRpcRequest
+	| AnvilJsonRpcRequest
+	| DebugJsonRpcRequest,
 >(
 	request: TRequest,
 ) => Promise<ReturnType<TRequest['method']>>

vm/api/src/handlers/TraceCallHandler.ts

@@ -0,0 +1,7 @@
+import type { TraceCallParams } from "../params/TraceCallParams.js";
+import type { TraceCallResult } from "../result/TraceCallResult.js";
+
+// tevm_traceCall
+export type TraceCallHandler = (
+	params: TraceCallParams,
+) => Promise<TraceCallResult>

vm/api/src/handlers/TraceContractHandler.ts

@@ -0,0 +1,7 @@
+import type { TraceContractParams } from "../params/TraceContractParams.js";
+import type { TraceContractResult } from "../result/TraceContractResult.js";
+
+// tevm_traceCall
+export type TraceContractHandler = (
+	params: TraceContractParams,
+) => Promise<TraceContractResult>

vm/api/src/handlers/TraceScriptHandler.ts

@@ -0,0 +1,7 @@
+import type { TraceScriptParams } from "../params/TraceScriptParams.js";
+import type { TraceScriptResult } from "../result/TraceScriptResult.js";
+
+// tevm_traceScript
+export type TraceScriptHandler = (
+	params: TraceScriptParams,
+) => Promise<TraceScriptResult>

vm/api/src/handlers/index.ts

@@ -5,3 +5,6 @@ export type * from './ScriptHandler.js'
 export type * from './AnvilHandler.js'
 export type * from './DebugHandler.js'
 export type * from './EthHandler.js'
+export type * from './TraceCallHandler.js'
+export type * from './TraceScriptHandler.js'
+export type * from './TraceContractHandler.js'

vm/api/src/index.ts

@@ -1,4 +1,6 @@
 export type {
+	TraceScriptParams,
+	TraceContractParams, TraceCallParams,
 	AnvilImpersonateAccountParams,
 	AnvilMineParams,
 	DebugTraceCallParams,
@@ -106,6 +108,9 @@ export type {
 	TevmEVMErrorMessage,
 } from './errors/index.js'
 export type {
+	TraceScriptHandler,
+	TraceContractHandler,
+	TraceCallHandler,
 	CallHandler,
 	ScriptHandler,
 	AccountHandler,
@@ -165,6 +170,8 @@ export type {
 	AnvilStopImpersonatingAccountHandler,
 } from './handlers/index.js'
 export type {
+	TraceCallResult,
+	StructLog,
 	AccountResult,
 	CallResult,
 	ScriptResult,
@@ -222,8 +229,15 @@ export type {
 	AnvilDropTransactionResult,
 	AnvilStopImpersonatingAccountResult,
 	DebugTraceTransactionResult,
+	TraceScriptResult,
+	TraceContractResult
 } from './result/index.js'
 export type {
+	TraceCallJsonRpcRequest,
+	AnvilJsonRpcRequest,
+	DebugJsonRpcRequest,
+	TraceScriptJsonRpcRequest,
+	TraceContractJsonRpcRequest,
 	JsonRpcRequest,
 	CallJsonRpcRequest,
 	ScriptJsonRpcRequest,
@@ -286,6 +300,9 @@ export type {
 	EthJsonRpcRequest,
 } from './requests/index.js'
 export type {
+	TraceScriptJsonRpcResponse,
+	TraceContractJsonRpcResponse,
+	TraceCallJsonRpcResponse,
 	JsonRpcResponse,
 	CallJsonRpcResponse,
 	ContractJsonRpcResponse,
@@ -346,6 +363,9 @@ export type {
 	DebugTraceTransactionJsonRpcResponse,
 } from './responses/index.js'
 export type {
+	TraceCallProcedure,
+	TraceScriptProcedure,
+	TraceContractProcedure,
 	CallJsonRpcProcedure,
 	ContractJsonRpcProcedure,
 	ScriptJsonRpcProcedure,

vm/api/src/params/DebugParams.ts

@@ -1,4 +1,5 @@
-import type { BlockTag, CallParameters, Chain, Hex } from 'viem'
+import type { BlockTag, Hex } from 'viem'
+import type { CallParams } from './CallParams.js'
 
 /**
  * Config params for trace calls
@@ -33,7 +34,7 @@ export type TraceParams = {
 		/**
 		 * boolean Setting this to true will disable stack capture. This avoids extra processing for each call frame if stack is not required.
 		 */
-		// readonly disableStack?: boolean
+		readonly disableStack?: boolean
 	}
 }
 
@@ -45,22 +46,20 @@ export type DebugTraceTransactionParams = TraceParams & {
 	/**
 	 * The transaction hash
 	 */
-	transactionHash: Hex
+	readonly transactionHash: Hex
 }
 
 // debug_traceCall
 /**
  * Params taken by `debug_traceCall` handler
  */
-export type DebugTraceCallParams<
-	TChain extends Chain | undefined = Chain | undefined,
-> = TraceParams & {
+export type DebugTraceCallParams = TraceParams & {
 	/**
-	 * The transaction to debug
+	 * The call to debug
 	 */
-	transaction: CallParameters<TChain>
+	readonly call: CallParams
 	/**
 	 * Block information
 	 */
-	block?: BlockTag | Hex | BigInt
+	readonly block?: BlockTag | Hex | bigint
 }

vm/api/src/params/TraceCallParams.ts

@@ -0,0 +1,23 @@
+import type { BlockTag, Hex } from 'viem'
+import type { CallParams } from './CallParams.js'
+import type { TraceParams } from './DebugParams.js'
+
+// tevm_traceCall
+/**
+ * Params taken by `tevm_traceCall` handler
+ * Tevm trace call is the same as eth_traceCall but with
+ * some extra nice to have features and the call interface
+ * nicely matches tevm_call interface.
+ *
+ * eth_traceCall uses tevm_call under the hood
+ */
+export type TraceCallParams = TraceParams & {
+  /**
+   * The call to debug
+   */
+  readonly call: CallParams
+  /**
+   * Block information
+   */
+  readonly block?: BlockTag | Hex | bigint
+}

vm/api/src/params/TraceContractParams.ts

@@ -0,0 +1,23 @@
+import type { BlockTag, Hex } from 'viem'
+import type { ContractParams } from './ContractParams.js'
+import type { TraceParams } from './DebugParams.js'
+
+// tevm_traceContract
+/**
+ * Params taken by `tevm_traceContract` handler
+ * Tevm trace call is the same as eth_traceContract but with
+ * some extra nice to have features and the call interface
+ * nicely matches tevm_call interface.
+ *
+ * eth_traceContract uses tevm_call under the hood
+ */
+export type TraceContractParams = TraceParams & {
+  /**
+   * The call to debug
+   */
+  readonly call: ContractParams
+  /**
+   * Block information
+   */
+  readonly block?: BlockTag | Hex | bigint
+}

vm/api/src/params/TraceScriptParams.ts

@@ -0,0 +1,23 @@
+import type { BlockTag, Hex } from 'viem'
+import type { ScriptParams } from './ScriptParams.js'
+import type { TraceParams } from './DebugParams.js'
+
+// tevm_traceScript
+/**
+ * Params taken by `tevm_traceScript` handler
+ * Tevm trace call is the same as eth_traceScript but with
+ * some extra nice to have features and the call interface
+ * nicely matches tevm_call interface.
+ *
+ * eth_traceScript uses tevm_call under the hood
+ */
+export type TraceScriptParams = TraceParams & {
+  /**
+   * The call to debug
+   */
+  readonly call: ScriptParams
+  /**
+   * Block information
+   */
+  readonly block?: BlockTag | Hex | bigint
+}

vm/api/src/params/index.ts

@@ -6,3 +6,6 @@ export type * from './ScriptParams.js'
 export type * from './EthParams.js'
 export type * from './AnvilParams.js'
 export type * from './DebugParams.js'
+export type * from './TraceCallParams.js'
+export type * from './TraceScriptParams.js'
+export type * from './TraceContractParams.js'

vm/api/src/procedure/TraceCallProcedure.ts

@@ -0,0 +1,12 @@
+
+// tevm_traceCall
+
+import type { TraceCallJsonRpcRequest } from "../requests/TraceCallJsonRpcRequest.js";
+import type { TraceCallJsonRpcResponse } from "../responses/TraceCallJsonRpcResponse.js";
+
+/**
+ * JSON-RPC procedure for `tevm_traceCall`
+ */
+export type TraceCallProcedure = (
+	request: TraceCallJsonRpcRequest,
+) => Promise<TraceCallJsonRpcResponse>

vm/api/src/procedure/TraceContractProcedure.ts

@@ -0,0 +1,10 @@
+import type { TraceContractJsonRpcRequest } from "../requests/TraceContractJsonRpcRequest.js";
+import type { TraceContractJsonRpcResponse } from "../responses/TraceContractJsonRpcResponse.js";
+
+// tevm_traceContract
+/**
+ * JSON-RPC procedure for `tevm_traceContract`
+ */
+export type TraceContractProcedure = (
+	request: TraceContractJsonRpcRequest,
+) => Promise<TraceContractJsonRpcResponse>

vm/api/src/procedure/TraceScriptProcedure.ts

@@ -0,0 +1,11 @@
+import type { TraceScriptJsonRpcRequest } from "../requests/TraceScriptJsonRpcRequest.js";
+import type { TraceScriptJsonRpcResponse } from "../responses/TraceScriptJsonRpcResponse.js";
+
+// tevm_traceScript
+
+/**
+ * JSON-RPC procedure for `tevm_traceScript`
+ */
+export type TraceScriptProcedure = (
+	request: TraceScriptJsonRpcRequest,
+) => Promise<TraceScriptJsonRpcResponse>

vm/api/src/procedure/index.ts

@@ -6,3 +6,6 @@ export type * from './EthProcedure.js'
 export type * from './EthProcedure.js'
 export type * from './AnvilProcedure.js'
 export type * from './DebugProcedure.js'
+export type * from './TraceCallProcedure.js'
+export type * from './TraceScriptProcedure.js'
+export type * from './TraceContractProcedure.js'