Merge branch 'rethnet/main' into hardhat-edr-merge

Author: fvictorio

.github/workflows/hardhat-core-ci.yml

@@ -75,7 +75,7 @@ jobs:
         # disable until actions/virtual-environments#4896 is fixed
         # os: ["macos-latest", "ubuntu-latest", "windows-latest"]
         os: ["ubuntu-latest", "windows-latest"]
-        vm: ["dual", "rethnet"]
+        vm: ["dual", "ethereumjs", "rethnet"]
     steps:
       - uses: actions/checkout@v3
 

crates/rethnet_evm/src/trace.rs

@@ -6,7 +6,7 @@ use revm::{
         instruction_result::SuccessOrHalt, opcode, return_revert, CallInputs, CreateInputs, Gas,
         InstructionResult, Interpreter,
     },
-    primitives::{AccountInfo, Bytecode, ExecutionResult, Output},
+    primitives::{Bytecode, ExecutionResult, Output},
     EVMData, Inspector,
 };
 
@@ -56,8 +56,10 @@ pub struct Step {
     pub pc: u64,
     /// The call depth
     pub depth: u64,
-    // /// The executed op code
-    // pub opcode: u8,
+    /// The executed op code
+    pub opcode: u8,
+    /// The top entry on the stack. None if the stack is empty.
+    pub stack_top: Option<U256>,
     // /// The amount of gas that was used by the step
     // pub gas_cost: u64,
     // /// The amount of gas that was refunded by the step
@@ -80,21 +82,12 @@ impl Trace {
     }
 
     /// Adds a VM step to the trace.
-    pub fn add_step(
-        &mut self,
-        depth: u64,
-        pc: usize,
-        _opcode: u8,
-        _gas: &Gas,
-        _contract: &AccountInfo,
-        _contract_address: &Address,
-    ) {
+    pub fn add_step(&mut self, depth: u64, pc: usize, opcode: u8, stack_top: Option<U256>) {
         self.messages.push(TraceMessage::Step(Step {
             pc: pc as u64,
             depth,
-            // opcode,
-            // contract: contract.clone(),
-            // contract_address: *contract_address,
+            opcode,
+            stack_top,
         }));
     }
 }
@@ -302,12 +295,7 @@ where
                 data.journaled_state().depth(),
                 interp.program_counter(),
                 interp.current_opcode(),
-                interp.gas(),
-                &data
-                    .journaled_state()
-                    .account(interp.contract().address)
-                    .info,
-                &interp.contract().address,
+                interp.stack.data().last().cloned(),
             );
         }
 

crates/rethnet_evm_napi/index.d.ts

@@ -247,6 +247,10 @@ export interface TracingStep {
   readonly depth: number
   /** The program counter */
   readonly pc: bigint
+  /** The executed op code */
+  readonly opcode: string
+  /** The top entry on the stack. None if the stack is empty. */
+  readonly stackTop?: bigint
 }
 export interface TracingMessageResult {
   /** Execution result */

crates/rethnet_evm_napi/src/trace.rs

@@ -6,6 +6,7 @@ use napi::{
 };
 use napi_derive::napi;
 use rethnet_evm::trace::BeforeMessage;
+use rethnet_evm::OPCODE_JUMPMAP;
 
 use crate::transaction::result::ExecutionResult;
 
@@ -93,9 +94,12 @@ pub struct TracingStep {
     /// The program counter
     #[napi(readonly)]
     pub pc: BigInt,
-    // /// The executed op code
-    // #[napi(readonly)]
-    // pub opcode: String,
+    /// The executed op code
+    #[napi(readonly)]
+    pub opcode: String,
+    /// The top entry on the stack. None if the stack is empty.
+    #[napi(readonly)]
+    pub stack_top: Option<BigInt>,
     // /// The return value of the step
     // #[napi(readonly)]
     // pub return_value: u8,
@@ -130,9 +134,13 @@ impl TracingStep {
         Self {
             depth: step.depth as u8,
             pc: BigInt::from(step.pc),
-            // opcode: OPCODE_JUMPMAP[usize::from(step.opcode)]
-            //     .unwrap_or("")
-            //     .to_string(),
+            opcode: OPCODE_JUMPMAP[usize::from(step.opcode)]
+                .unwrap_or("")
+                .to_string(),
+            stack_top: step.stack_top.map(|v| BigInt {
+                sign_bit: false,
+                words: v.into_limbs().to_vec(),
+            }),
             // gas_cost: BigInt::from(0u64),
             // gas_refunded: BigInt::from(0u64),
             // gas_left: BigInt::from(0u64),

packages/hardhat-core/src/internal/hardhat-network/provider/context/rethnet.ts

@@ -1,12 +1,13 @@
 import { Blockchain, RethnetContext, SpecId } from "@ignored/edr";
+import { AsyncEventEmitter } from "@nomicfoundation/ethereumjs-util";
 import { BlockchainAdapter } from "../blockchain";
 import { RethnetBlockchain } from "../blockchain/rethnet";
 import { EthContextAdapter } from "../context";
 import { MemPoolAdapter } from "../mem-pool";
 import { BlockMinerAdapter } from "../miner";
 import { VMAdapter } from "../vm/vm-adapter";
 import { RethnetMiner } from "../miner/rethnet";
-import { RethnetAdapter } from "../vm/rethnet";
+import { RethnetAdapter, VMStub } from "../vm/rethnet";
 import { NodeConfig, isForkedNodeConfig } from "../node-types";
 import {
   ethereumjsHeaderDataToRethnetBlockOptions,
@@ -139,13 +140,20 @@ export class RethnetEthContext implements EthContextAdapter {
         ? UNLIMITED_CONTRACT_SIZE_VALUE
         : undefined;
 
+    const vmStub: VMStub = {
+      evm: {
+        events: new AsyncEventEmitter(),
+      },
+    };
+
     const vm = new RethnetAdapter(
       blockchain.asInner(),
       state,
       common,
       limitContractCodeSize,
       limitInitcodeSize,
-      config.enableTransientStorage
+      config.enableTransientStorage,
+      vmStub
     );
 
     const memPool = new RethnetMemPool(
@@ -161,7 +169,8 @@ export class RethnetEthContext implements EthContextAdapter {
       common,
       limitContractCodeSize,
       ethereumjsMempoolOrderToRethnetMineOrdering(config.mempoolOrder),
-      prevRandaoGenerator
+      prevRandaoGenerator,
+      vmStub
     );
 
     return new RethnetEthContext(blockchain, memPool, miner, vm);

packages/hardhat-core/src/internal/hardhat-network/provider/miner/rethnet.ts

@@ -15,6 +15,7 @@ import { RethnetBlockchain } from "../blockchain/rethnet";
 import { RethnetStateManager } from "../RethnetState";
 import { RethnetMemPool } from "../mem-pool/rethnet";
 import { RandomBufferGenerator } from "../utils/random";
+import { VMStub } from "../vm/rethnet";
 
 export class RethnetMiner implements BlockMinerAdapter {
   constructor(
@@ -24,7 +25,8 @@ export class RethnetMiner implements BlockMinerAdapter {
     private readonly _common: Common,
     private readonly _limitContractCodeSize: bigint | undefined,
     private _mineOrdering: MineOrdering,
-    private _prevRandaoGenerator: RandomBufferGenerator
+    private _prevRandaoGenerator: RandomBufferGenerator,
+    private _vmStub: VMStub
   ) {}
 
   public async mineBlock(
@@ -74,6 +76,14 @@ export class RethnetMiner implements BlockMinerAdapter {
       for (const traceItem of mineTrace) {
         if ("pc" in traceItem) {
           await vmTracer.addStep(traceItem);
+
+          // For solidity-coverage compatibility
+          this._vmStub.evm.events.emit("step", {
+            pc: Number(traceItem.pc),
+            depth: traceItem.depth,
+            opcode: { name: traceItem.opcode },
+            stackTop: traceItem.stackTop,
+          });
         } else if ("executionResult" in traceItem) {
           await vmTracer.addAfterMessage(traceItem);
         } else {

packages/hardhat-core/src/internal/hardhat-network/provider/vm/creation.ts

@@ -16,11 +16,11 @@ export async function createContext(
 
   const prevRandaoGenerator = RandomBufferGenerator.create("randomMixHashSeed");
 
-  if (vmModeEnvVar === "ethereumjs") {
-    return HardhatEthContext.create(config, prevRandaoGenerator);
-  } else if (vmModeEnvVar === "rethnet") {
+  if (vmModeEnvVar === "edr") {
     return RethnetEthContext.create(config);
-  } else {
+  } else if (vmModeEnvVar === "dual") {
     return DualEthContext.create(config, prevRandaoGenerator);
+  } else {
+    return HardhatEthContext.create(config, prevRandaoGenerator);
   }
 }

packages/hardhat-core/src/internal/hardhat-network/provider/vm/ethereumjs.ts

@@ -706,7 +706,7 @@ export class EthereumJSAdapter implements VMAdapter {
       await this._vmTracer.addStep({
         depth: step.depth,
         pc: BigInt(step.pc),
-        // opcode: step.opcode.name,
+        opcode: step.opcode.name,
         // returnValue: 0, // Do we have error values in ethereumjs?
         // gasCost: BigInt(step.opcode.fee) + (step.opcode.dynamicFee ?? 0n),
         // gasRefunded: step.gasRefund,

packages/hardhat-core/src/internal/hardhat-network/provider/vm/rethnet.ts

@@ -1,8 +1,10 @@
 import { Block } from "@nomicfoundation/ethereumjs-block";
 import { Common } from "@nomicfoundation/ethereumjs-common";
+import { InterpreterStep } from "@nomicfoundation/ethereumjs-evm";
 import {
   Account,
   Address,
+  AsyncEventEmitter,
   KECCAK256_NULL,
 } from "@nomicfoundation/ethereumjs-util";
 import { TypedTransaction } from "@nomicfoundation/ethereumjs-tx";
@@ -59,7 +61,9 @@ export class RethnetAdapter implements VMAdapter {
     private readonly _common: Common,
     private readonly _limitContractCodeSize: bigint | undefined,
     private readonly _limitInitcodeSize: bigint | undefined,
-    private readonly _enableTransientStorage: boolean
+    private readonly _enableTransientStorage: boolean,
+    // For solidity-coverage compatibility. Name cannot be changed.
+    private _vm: VMStub
   ) {
     this._vmTracer = new VMTracer(_common, false);
   }
@@ -93,13 +97,20 @@ export class RethnetAdapter implements VMAdapter {
         ? UNLIMITED_CONTRACT_SIZE_VALUE
         : undefined;
 
+    const vmStub: VMStub = {
+      evm: {
+        events: new AsyncEventEmitter(),
+      },
+    };
+
     return new RethnetAdapter(
       blockchain,
       state,
       common,
       limitContractCodeSize,
       limitInitcodeSize,
-      config.enableTransientStorage
+      config.enableTransientStorage,
+      vmStub
     );
   }
 
@@ -184,6 +195,16 @@ export class RethnetAdapter implements VMAdapter {
       }
     }
 
+    // For solidity-coverage compatibility
+    for (const step of this._vmTracer.tracingSteps) {
+      this._vm.evm.events.emit("step", {
+        pc: Number(step.pc),
+        depth: step.depth,
+        opcode: { name: step.opcode },
+        stackTop: step.stackTop,
+      });
+    }
+
     try {
       const result = rethnetResultToRunTxResult(
         rethnetResult.result,
@@ -415,6 +436,16 @@ export class RethnetAdapter implements VMAdapter {
       }
     }
 
+    // For solidity-coverage compatibility
+    for (const step of this._vmTracer.tracingSteps) {
+      this._vm.evm.events.emit("step", {
+        pc: Number(step.pc),
+        depth: step.depth,
+        opcode: { name: step.opcode },
+        stackTop: step.stackTop,
+      });
+    }
+
     try {
       const result = rethnetResultToRunTxResult(
         rethnetResult.result,
@@ -623,3 +654,19 @@ export class RethnetAdapter implements VMAdapter {
     return undefined;
   }
 }
+
+type InterpreterStepStub = Pick<InterpreterStep, "pc" | "depth"> & {
+  opcode: { name: string };
+  stackTop?: bigint;
+};
+
+interface EVMStub {
+  events: AsyncEventEmitter<{
+    step: (data: InterpreterStepStub, resolve?: (result?: any) => void) => void;
+  }>;
+}
+
+// For compatibility with solidity-coverage that attaches a listener to the step event.
+export interface VMStub {
+  evm: EVMStub;
+}