Merge pull request #5 from rhinestonewtf/feature/simulation-success

feat: add simulation success return
rhinestonewtf · Aug 15, 2024 · e1e7c81 · e1e7c81
2 parents 68bdedc + 7675cdc
commit e1e7c81
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 18 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@rhinestone/erc4337-validation",
-  "version": "0.0.1-alpha.4",
+  "version": "0.0.1-alpha.5",
   "description": "A library to validate the ERC-4337 rules within Foundry",
   "license": "MIT",
   "author": {

diff --git a/src/Simulator.sol b/src/Simulator.sol
@@ -28,26 +28,47 @@ import { ERC4337SpecsParser } from "./SpecsParser.sol";
  */
 library Simulator {
     /**
-     * Simulates a UserOperation and validates the ERC-4337 rules will revert if the UserOperation
-     * is invalid
+     * Simulates a UserOperation and validates the ERC-4337 rules
+     * @dev This function will revert if the UserOperation is invalid
+     * @dev If the simulation fails, the rules might not be checked correctly so simulationSuccess
+     * should be handled accordingly
      * @dev This function is used for v0.7 ERC-4337
      *
      * @param userOp The PackedUserOperation to simulate
      * @param onEntryPoint The address of the entry point to simulate the UserOperation on
+     *
+     * @return simulationSuccess True if the simulation was successful, false otherwise
      */
-    function simulateUserOp(PackedUserOperation memory userOp, address onEntryPoint) internal {
+    function simulateUserOp(
+        PackedUserOperation memory userOp,
+        address onEntryPoint
+    )
+        internal
+        returns (bool simulationSuccess)
+    {
         // Pre-simulation setup
         _preSimulation();
 
-        // Simulate the UserOperation
+        // Encode the call data
+        bytes memory epCallData =
+            abi.encodeCall(IEntryPointSimulations.simulateValidation, (userOp));
+
+        // Simulate the UserOperation and exit on revert
+        bytes memory returnData;
+        (simulationSuccess, returnData) = address(onEntryPoint).call(epCallData);
+        if (!simulationSuccess) {
+            return simulationSuccess;
+        }
+
+        // Decode the return data
         IEntryPointSimulations.ValidationResult memory result =
-            IEntryPointSimulations(onEntryPoint).simulateValidation(userOp);
+            abi.decode(returnData, (IEntryPointSimulations.ValidationResult));
 
         // Ensure that the signature was valid
         if (result.returnInfo.accountValidationData != 0) {
             bool sigFailed = (result.returnInfo.accountValidationData & 1) == 1;
             if (sigFailed) {
-                revert("Simulation error: signature failed");
+                simulationSuccess = false;
             }
         }
 
@@ -66,30 +87,40 @@ library Simulator {
     }
 
     /**
-     * Simulates a UserOperation and validates the ERC-4337 rules will revert if the UserOperation
-     * is invalid
+     * Simulates a UserOperation and validates the ERC-4337 rules
+     * @dev this function will revert if the UserOperation is invalid
+     * @dev If the simulation fails, the rules might not be checked correctly so simulationSuccess
+     * should be handled accordingly
      * @dev This function is used for v0.6 ERC-4337
      *
      * @param userOp The UserOperation to simulate
      * @param onEntryPoint The address of the entry point to simulate the UserOperation on
+     *
+     * @return simulationSuccess True if the simulation was successful, false otherwise
      */
-    function simulateUserOp(UserOperation memory userOp, address onEntryPoint) internal {
+    function simulateUserOp(
+        UserOperation memory userOp,
+        address onEntryPoint
+    )
+        internal
+        returns (bool simulationSuccess)
+    {
         // Pre-simulation setup
         _preSimulation();
 
         // Simulate the UserOperation and handle revert
-        try IEntryPointSimulationsV060(onEntryPoint).simulateValidation(userOp) { }
-        catch (bytes memory reason) {
+        try IEntryPointSimulationsV060(onEntryPoint).simulateValidation(userOp) {
+            simulationSuccess = true;
+        } catch (bytes memory reason) {
+            simulationSuccess = false;
+
             uint256 sigFailed;
             // selector (4 bytes) + length(32 bytes) + preOpGas(32 bytes)
             // + prefund (32 bytes) + sigFailed (32 bytes)
             uint256 pos = 4 + 32 + 32 + 32;
             assembly {
                 sigFailed := mload(add(reason, pos))
             }
-            if (sigFailed == 1) {
-                revert("Simulation error: signature failed");
-            }
         }
 
         // Create a UserOperationDetails struct

diff --git a/src/SpecsParser.sol b/src/SpecsParser.sol
@@ -373,7 +373,9 @@ library ERC4337SpecsParser {
      *
      * @return entities The entities of the UserOperation
      */
-    function getEntities(UserOperationDetails memory userOpDetails)
+    function getEntities(
+        UserOperationDetails memory userOpDetails
+    )
         internal
         view
         returns (Entities memory entities)

diff --git a/test/utils/TestBaseUtil.sol b/test/utils/TestBaseUtil.sol
@@ -24,7 +24,9 @@ contract TestBaseUtil is Test {
         factory = new MockFactory(address(implementation));
     }
 
-    function getAccountAndInitCode(bytes32 salt)
+    function getAccountAndInitCode(
+        bytes32 salt
+    )
         internal
         returns (address account, bytes memory initCode)
     {

diff --git a/test/utils/TestBaseUtilV060.sol b/test/utils/TestBaseUtilV060.sol
@@ -27,7 +27,9 @@ contract TestBaseUtil is Test {
         factory = new MockFactory(address(implementation));
     }
 
-    function getAccountAndInitCode(bytes32 salt)
+    function getAccountAndInitCode(
+        bytes32 salt
+    )
         internal
         returns (address account, bytes memory initCode)
     {