Use state override set in eth_estimateUserOperationGas (#348)

Author: hazim-j

e2e/package.json

@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "ethers": "^5.7.2",
-    "userop": "^0.3.3"
+    "userop": "^0.3.7"
   },
   "devDependencies": {
     "@types/jest": "^29.5.2",

e2e/src/errors.ts

@@ -1,4 +1,5 @@
 export const errorCodes = {
+  rejectedByEpOrAccount: -32500,
   executionReverted: -32521,
   invalidFields: -32602,
 };

e2e/test/verification.test.ts

@@ -1,4 +1,6 @@
-import { Client } from "userop";
+import { ethers } from "ethers";
+import { Client, Presets } from "userop";
+import { errorCodes } from "../src/errors";
 import { TestAccount } from "../src/testAccount";
 import config from "../config";
 
@@ -56,4 +58,50 @@ describe("During the verification phase", () => {
       });
     });
   });
+
+  describe("With state overrides", () => {
+    test("Sender with zero funds can successfully estimate UserOperation gas", async () => {
+      expect.assertions(4);
+      const randAcc = await Presets.Builder.SimpleAccount.init(
+        new ethers.Wallet(ethers.utils.randomBytes(32)),
+        config.nodeUrl,
+        {
+          overrideBundlerRpc: config.bundlerUrl,
+        }
+      );
+      randAcc
+        .setPreVerificationGas(0)
+        .setVerificationGasLimit(0)
+        .setCallGasLimit(0);
+
+      try {
+        await client.sendUserOperation(
+          randAcc.execute(randAcc.getSender(), ethers.constants.Zero, "0x")
+        );
+      } catch (error: any) {
+        expect(error?.error.code).toBe(errorCodes.rejectedByEpOrAccount);
+      }
+
+      await client.sendUserOperation(
+        randAcc.execute(randAcc.getSender(), ethers.constants.Zero, "0x"),
+        {
+          dryRun: true,
+          stateOverrides: {
+            [randAcc.getSender()]: {
+              balance: ethers.constants.MaxUint256.toHexString(),
+            },
+          },
+          onBuild(op) {
+            expect(ethers.BigNumber.from(op.preVerificationGas).gte(0)).toBe(
+              true
+            );
+            expect(ethers.BigNumber.from(op.verificationGasLimit).gte(0)).toBe(
+              true
+            );
+            expect(ethers.BigNumber.from(op.callGasLimit).gte(0)).toBe(true);
+          },
+        }
+      );
+    });
+  });
 });

e2e/yarn.lock

@@ -1620,7 +1620,7 @@ electron-to-chromium@^1.4.431:
   resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.4.454.tgz#774dc7cb5e58576d0125939ec34a4182f3ccc87d"
   integrity sha512-pmf1rbAStw8UEQ0sr2cdJtWl48ZMuPD9Sto8HVQOq9vx9j2WgDEN6lYoaqFvqEHYOmGA9oRGn7LqWI9ta0YugQ==
 
-[email protected]:
+[email protected], elliptic@^6.5.4:
   version "6.5.4"
   resolved "https://registry.yarnpkg.com/elliptic/-/elliptic-6.5.4.tgz#da37cebd31e79a1367e941b592ed1fbebd58abbb"
   integrity sha512-iLhC6ULemrljPZb+QutR5TQGB+pdW6KGD5RSegS+8sorOZT+rdQFbsQFJgvN3eRqNALqJer4oQ16YvJHlU8hzQ==
@@ -2580,6 +2580,11 @@ jest@^29.6.1:
     import-local "^3.0.2"
     jest-cli "^29.6.1"
 
+js-base64@^3.7.5:
+  version "3.7.5"
+  resolved "https://registry.yarnpkg.com/js-base64/-/js-base64-3.7.5.tgz#21e24cf6b886f76d6f5f165bfcd69cc55b9e3fca"
+  integrity sha512-3MEt5DTINKqfScXKfJFrRbxkrnk2AxPWGBL/ycjz4dK8iqiSJ06UxD8jh8xuh6p10TX4t2+7FsBYVxxQbMg+qA==
+
 [email protected]:
   version "0.8.0"
   resolved "https://registry.yarnpkg.com/js-sha3/-/js-sha3-0.8.0.tgz#b9b7a5da73afad7dedd0f8c463954cbde6818840"
@@ -3264,12 +3269,14 @@ uri-js@^4.2.2:
   dependencies:
     punycode "^2.1.0"
 
-userop@^0.3.3:
-  version "0.3.3"
-  resolved "https://registry.yarnpkg.com/userop/-/userop-0.3.3.tgz#e78e97fa2bcc9682d532766ee6c4dc086aa24ddf"
-  integrity sha512-7rPYqo5SJVVzUg9CPF3m03iXcMlXGRdkwtmhBlkHIroX8ftOSjlgwX7qDDv+uU1pumKQoqE5gNh3ydet9oFJ1Q==
+userop@^0.3.7:
+  version "0.3.7"
+  resolved "https://registry.yarnpkg.com/userop/-/userop-0.3.7.tgz#cd2fe1fca2f438db6bce186a96918684cb9facb3"
+  integrity sha512-T4amKAySvJx5z5WLWf2pTtN6scLDqza4yODrWuNx7v9TIc/RGdHgY+5r3rvQ3W6om42heIW1Tnmw+B4LVL/Mgg==
   dependencies:
+    elliptic "^6.5.4"
     ethers "^5.7.2"
+    js-base64 "^3.7.5"
 
 v8-compile-cache-lib@^3.0.1:
   version "3.0.1"

pkg/client/client.go

@@ -170,14 +170,14 @@ func (i *Client) EstimateUserOperationGas(
 	hash := userOp.GetUserOpHash(epAddr, i.chainID)
 	l = l.WithValues("userop_hash", hash)
 
-	_, err = state.ParseOverrideData(os)
+	sos, err := state.ParseOverrideData(os)
 	if err != nil {
 		l.Error(err, "eth_estimateUserOperationGas error")
 		return nil, err
 	}
 
 	// Estimate gas limits
-	vg, cg, err := i.getGasEstimate(epAddr, userOp)
+	vg, cg, err := i.getGasEstimate(epAddr, userOp, state.WithZeroAddressOverride(sos))
 	if err != nil {
 		l.Error(err, "eth_estimateUserOperationGas error")
 		return nil, err

pkg/client/utils.go

@@ -9,6 +9,7 @@ import (
 	"github.com/ethereum/go-ethereum/rpc"
 	"github.com/stackup-wallet/stackup-bundler/pkg/entrypoint/filter"
 	"github.com/stackup-wallet/stackup-bundler/pkg/gas"
+	"github.com/stackup-wallet/stackup-bundler/pkg/state"
 	"github.com/stackup-wallet/stackup-bundler/pkg/userop"
 )
 
@@ -33,10 +34,18 @@ func GetUserOpReceiptWithEthClient(eth *ethclient.Client) GetUserOpReceiptFunc {
 
 // GetGasEstimateFunc is a general interface for fetching an estimate for verificationGasLimit and
 // callGasLimit given a userOp and EntryPoint address.
-type GetGasEstimateFunc = func(ep common.Address, op *userop.UserOperation) (verificationGas uint64, callGas uint64, err error)
+type GetGasEstimateFunc = func(
+	ep common.Address,
+	op *userop.UserOperation,
+	sos state.OverrideSet,
+) (verificationGas uint64, callGas uint64, err error)
 
 func getGasEstimateNoop() GetGasEstimateFunc {
-	return func(ep common.Address, op *userop.UserOperation) (verificationGas uint64, callGas uint64, err error) {
+	return func(
+		ep common.Address,
+		op *userop.UserOperation,
+		sos state.OverrideSet,
+	) (verificationGas uint64, callGas uint64, err error) {
 		//lint:ignore ST1005 This needs to match the bundler test spec.
 		return 0, 0, errors.New("Missing/invalid userOpHash")
 	}
@@ -50,11 +59,16 @@ func GetGasEstimateWithEthClient(
 	chain *big.Int,
 	maxGasLimit *big.Int,
 ) GetGasEstimateFunc {
-	return func(ep common.Address, op *userop.UserOperation) (verificationGas uint64, callGas uint64, err error) {
+	return func(
+		ep common.Address,
+		op *userop.UserOperation,
+		sos state.OverrideSet,
+	) (verificationGas uint64, callGas uint64, err error) {
 		return gas.EstimateGas(&gas.EstimateInput{
 			Rpc:         rpc,
 			EntryPoint:  ep,
 			Op:          op,
+			Sos:         sos,
 			Ov:          ov,
 			ChainID:     chain,
 			MaxGasLimit: maxGasLimit,

pkg/entrypoint/execution/simulate.go

@@ -1,21 +1,29 @@
 package execution
 
 import (
+	"context"
 	"fmt"
+	"math"
+	"math/big"
 
+	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/ethclient"
 	"github.com/ethereum/go-ethereum/rpc"
 	"github.com/stackup-wallet/stackup-bundler/pkg/entrypoint"
 	"github.com/stackup-wallet/stackup-bundler/pkg/entrypoint/reverts"
+	"github.com/stackup-wallet/stackup-bundler/pkg/entrypoint/utils"
 	"github.com/stackup-wallet/stackup-bundler/pkg/errors"
+	"github.com/stackup-wallet/stackup-bundler/pkg/state"
 	"github.com/stackup-wallet/stackup-bundler/pkg/userop"
 )
 
 type SimulateInput struct {
 	Rpc        *rpc.Client
 	EntryPoint common.Address
 	Op         *userop.UserOperation
+	Sos        state.OverrideSet
+	ChainID    *big.Int
 
 	// Optional params for simulateHandleOps
 	Target common.Address
@@ -27,16 +35,23 @@ func SimulateHandleOp(in *SimulateInput) (*reverts.ExecutionResultRevert, error)
 	if err != nil {
 		return nil, err
 	}
+	auth, err := bind.NewKeyedTransactorWithChainID(utils.DummyPk, in.ChainID)
+	if err != nil {
+		return nil, err
+	}
+	auth.GasLimit = math.MaxUint64
+	auth.NoSend = true
+	tx, err := ep.SimulateHandleOp(auth, entrypoint.UserOperation(*in.Op), in.Target, in.Data)
+	if err != nil {
+		return nil, err
+	}
 
-	rawCaller := &entrypoint.EntrypointRaw{Contract: ep}
-	err = rawCaller.Call(
-		nil,
-		nil,
-		"simulateHandleOp",
-		entrypoint.UserOperation(*in.Op),
-		in.Target,
-		in.Data,
-	)
+	req := utils.EthCallReq{
+		From: common.HexToAddress("0x"),
+		To:   in.EntryPoint,
+		Data: tx.Data(),
+	}
+	err = in.Rpc.CallContext(context.Background(), nil, "eth_call", &req, "latest", in.Sos)
 
 	sim, simErr := reverts.NewExecutionResult(err)
 	if simErr != nil {

pkg/entrypoint/execution/trace.go

@@ -16,6 +16,7 @@ import (
 	"github.com/stackup-wallet/stackup-bundler/pkg/entrypoint/reverts"
 	"github.com/stackup-wallet/stackup-bundler/pkg/entrypoint/utils"
 	"github.com/stackup-wallet/stackup-bundler/pkg/errors"
+	"github.com/stackup-wallet/stackup-bundler/pkg/state"
 	"github.com/stackup-wallet/stackup-bundler/pkg/tracer"
 	"github.com/stackup-wallet/stackup-bundler/pkg/userop"
 )
@@ -24,6 +25,7 @@ type TraceInput struct {
 	Rpc        *ethRpc.Client
 	EntryPoint common.Address
 	Op         *userop.UserOperation
+	Sos        state.OverrideSet
 	ChainID    *big.Int
 
 	// Optional params for simulateHandleOps
@@ -98,7 +100,7 @@ func TraceSimulateHandleOp(in *TraceInput) (*TraceOutput, error) {
 	}
 	opts := utils.TraceCallOpts{
 		Tracer:         tracer.Loaded.BundlerExecutionTracer,
-		StateOverrides: utils.DefaultStateOverrides,
+		StateOverrides: in.Sos,
 	}
 	if err := in.Rpc.CallContext(context.Background(), &res, "debug_traceCall", &req, "latest", &opts); err != nil {
 		return nil, err

pkg/entrypoint/simulation/tracevalidation.go

@@ -17,6 +17,7 @@ import (
 	"github.com/stackup-wallet/stackup-bundler/pkg/entrypoint"
 	"github.com/stackup-wallet/stackup-bundler/pkg/entrypoint/methods"
 	"github.com/stackup-wallet/stackup-bundler/pkg/entrypoint/utils"
+	"github.com/stackup-wallet/stackup-bundler/pkg/state"
 	"github.com/stackup-wallet/stackup-bundler/pkg/tracer"
 	"github.com/stackup-wallet/stackup-bundler/pkg/userop"
 )
@@ -62,7 +63,7 @@ func TraceSimulateValidation(in *TraceInput) (*TraceOutput, error) {
 	}
 	opts := utils.TraceCallOpts{
 		Tracer:         tracer.Loaded.BundlerCollectorTracer,
-		StateOverrides: utils.DefaultStateOverrides,
+		StateOverrides: state.WithZeroAddressOverride(state.OverrideSet{}),
 	}
 	if err := in.Rpc.CallContext(context.Background(), &res, "debug_traceCall", &req, "latest", &opts); err != nil {
 		return nil, err

pkg/entrypoint/utils/tracing.go renamed to pkg/entrypoint/utils/values.go

@@ -1,13 +1,18 @@
 package utils
 
 import (
-	"math/big"
-
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/ethereum/go-ethereum/crypto"
+	"github.com/stackup-wallet/stackup-bundler/pkg/state"
 )
 
+type EthCallReq struct {
+	From common.Address `json:"from"`
+	To   common.Address `json:"to"`
+	Data hexutil.Bytes  `json:"data"`
+}
+
 type TraceCallReq struct {
 	From         common.Address `json:"from"`
 	To           common.Address `json:"to"`
@@ -20,18 +25,11 @@ type TraceStateOverrides struct {
 }
 
 type TraceCallOpts struct {
-	Tracer         string                         `json:"tracer"`
-	StateOverrides map[string]TraceStateOverrides `json:"stateOverrides"`
+	Tracer         string            `json:"tracer"`
+	StateOverrides state.OverrideSet `json:"stateOverrides"`
 }
 
 var (
 	// A dummy private key used to build *bind.TransactOpts for simulation.
 	DummyPk, _ = crypto.GenerateKey()
-
-	maxUint96, _ = big.NewInt(0).SetString("79228162514264337593543950335", 10)
-
-	// A default state override to ensure the zero address always has sufficient funds.
-	DefaultStateOverrides = map[string]TraceStateOverrides{
-		common.HexToAddress("0x").Hex(): {Balance: hexutil.Big(*maxUint96)},
-	}
 )