Merge pull request #178 from rhinestonewtf/feat/return-exec-logs

feat(ERC4337Helpers): return logs from exec4337

src/test/ModuleKitHelpers.sol

@@ -5,6 +5,7 @@ pragma solidity >=0.8.23 <0.9.0;
 import {
     AccountInstance,
     UserOpData,
+    ExecutionReturnData,
     AccountType,
     DEFAULT,
     SAFE,
@@ -41,7 +42,8 @@ import {
     startStateDiffRecording as vmStartStateDiffRecording,
     stopAndReturnStateDiff as vmStopAndReturnStateDiff,
     getMappingKeyAndParentOf,
-    envOr
+    envOr,
+    setEnv
 } from "./utils/Vm.sol";
 import {
     getAccountType as getAccountTypeFromStorage,
@@ -94,9 +96,13 @@ library ModuleKitHelpers {
 
     /// @notice Executes userOps on the entrypoint
     /// @param userOpData UserOpData struct containing the userOp, userOpHash, and entrypoint
-    function execUserOps(UserOpData memory userOpData) internal {
+    /// @return ExecutionReturnData struct containing the logs from the execution
+    function execUserOps(UserOpData memory userOpData)
+        internal
+        returns (ExecutionReturnData memory)
+    {
         // Send userOp to entrypoint
-        ERC4337Helpers.exec4337(userOpData.userOp, userOpData.entrypoint);
+        return ERC4337Helpers.exec4337(userOpData.userOp, userOpData.entrypoint);
     }
 
     /// @notice Configures a userOp to execute a single operation
@@ -556,6 +562,8 @@ library ModuleKitHelpers {
     /// @param value The value to write to storage (true or false)
     function simulateUserOp(AccountInstance memory, bool value) internal {
         writeSimulateUserOp(value);
+        string memory strValue = value ? "true" : "false";
+        setEnv("SIMULATE", strValue);
     }
 
     /// @notice Writes the storage compliance flag to storage

src/test/RhinestoneModuleKit.sol

@@ -106,6 +106,12 @@ struct UserOpData {
     IEntryPoint entrypoint;
 }
 
+/// @title ExecutionReturnData
+/// @param logs Execution logs
+struct ExecutionReturnData {
+    VmSafe.Log[] logs;
+}
+
 /// @title RhinestoneModuleKit
 /// @notice A development kit for building and testing smart account modules
 contract RhinestoneModuleKit is AuxiliaryFactory {

src/test/utils/ERC4337Helpers.sol

@@ -8,6 +8,7 @@ import {
     IEntryPointSimulations,
     IStakeManager
 } from "../../external/ERC4337.sol";
+import { ExecutionReturnData } from "../RhinestoneModuleKit.sol";
 
 // Deployments
 import { ENTRYPOINT_ADDR } from "../../deployment/predeploy/EntryPoint.sol";
@@ -45,7 +46,13 @@ library ERC4337Helpers {
     error InvalidRevertMessage(bytes4 expected, bytes4 reason);
     error InvalidRevertMessageBytes(bytes expected, bytes reason);
 
-    function exec4337(PackedUserOperation[] memory userOps, IEntryPoint onEntryPoint) internal {
+    function exec4337(
+        PackedUserOperation[] memory userOps,
+        IEntryPoint onEntryPoint
+    )
+        internal
+        returns (ExecutionReturnData memory executionData)
+    {
         uint256 isExpectRevert = getExpectRevert();
 
         // ERC-4337 specs validation
@@ -72,6 +79,7 @@ library ERC4337Helpers {
 
         // Parse logs and determine if a revert happened
         VmSafe.Log[] memory logs = getRecordedLogs();
+        executionData = ExecutionReturnData(logs);
         uint256 totalUserOpGas = 0;
         for (uint256 i; i < logs.length; i++) {
             // UserOperationEvent(bytes32,address,address,uint256,bool,uint256,uint256)
@@ -150,10 +158,16 @@ library ERC4337Helpers {
         }
     }
 
-    function exec4337(PackedUserOperation memory userOp, IEntryPoint onEntryPoint) internal {
+    function exec4337(
+        PackedUserOperation memory userOp,
+        IEntryPoint onEntryPoint
+    )
+        internal
+        returns (ExecutionReturnData memory logs)
+    {
         PackedUserOperation[] memory userOps = new PackedUserOperation[](1);
         userOps[0] = userOp;
-        exec4337(userOps, onEntryPoint);
+        return exec4337(userOps, onEntryPoint);
     }
 
     function getUserOpRevertReason(

src/test/utils/Vm.sol

@@ -113,6 +113,10 @@ function envOr(string memory name, bool defaultValue) view returns (bool value)
     return Vm(VM_ADDR).envOr(name, defaultValue);
 }
 
+function setEnv(string memory key, string memory value) {
+    Vm(VM_ADDR).setEnv(key, value);
+}
+
 function envBool(string memory key) view returns (bool value) {
     return Vm(VM_ADDR).envBool(key);
 }

test/Diff.t.sol

@@ -4,6 +4,7 @@ pragma solidity >=0.8.23 <0.9.0;
 import "src/ModuleKit.sol";
 import "./BaseTest.t.sol";
 import "src/Mocks.sol";
+import { ExecutionReturnData } from "src/test/RhinestoneModuleKit.sol";
 import {
     MODULE_TYPE_VALIDATOR,
     MODULE_TYPE_EXECUTOR,
@@ -52,6 +53,7 @@ contract ERC7579DifferentialModuleKitLibTest is BaseTest {
         token.initialize("Mock Token", "MTK", 18);
         deal(address(token), instance.account, 100 ether);
         vm.deal(instance.account, 1000 ether);
+        instance.simulateUserOp(false);
     }
 
     function test_transfer() public {
@@ -100,13 +102,16 @@ contract ERC7579DifferentialModuleKitLibTest is BaseTest {
         // bytes memory signature = "";
 
         // Create userOperation
-        instance.getExecOps({
+        ExecutionReturnData memory executionData = instance.getExecOps({
             target: receiver,
             value: value,
             callData: callData,
             txValidator: address(instance.defaultValidator)
         }).execUserOps();
 
+        // Validate Logs
+        assertTrue(executionData.logs.length >= 5);
+
         // Validate userOperation
         assertEq(receiver.balance, value, "Receiver should have 10 gwei");
     }

test/integrations/SwapTest.t.sol

@@ -40,6 +40,7 @@ contract TestUniswap is BaseTest {
         _fundAccountWithTokenA(amountIn);
         vm.deal(instance.account, 1 ether);
         assertTrue(instance.account.balance == 1 ether);
+        instance.simulateUserOp(false);
     }
 
     function _fundAccountWithTokenA(uint256 amount) internal {