Fix CGL estimate for deeper call stacks (#220)

Author: hazim-j

.air.private-mode.toml

@@ -14,7 +14,7 @@ tmp_dir = "tmp"
   follow_symlink = false
   full_bin = ""
   include_dir = []
-  include_ext = ["go", "tpl", "tmpl", "html"]
+  include_ext = ["go", "tpl", "tmpl", "html", "js"]
   kill_delay = "0s"
   log = "build-errors.log"
   send_interrupt = false

.air.searcher-mode.toml

@@ -14,7 +14,7 @@ tmp_dir = "tmp"
   follow_symlink = false
   full_bin = ""
   include_dir = []
-  include_ext = ["go", "tpl", "tmpl", "html"]
+  include_ext = ["go", "tpl", "tmpl", "html", "js"]
   kill_delay = "0s"
   log = "build-errors.log"
   send_interrupt = false

e2e/src/errors.ts

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

e2e/test/withoutPaymaster.test.ts

@@ -2,6 +2,7 @@ import { ethers } from "ethers";
 import { Presets, Client } from "userop";
 import { fundIfRequired } from "../src/helpers";
 import { erc20ABI, testGasABI } from "../src/abi";
+import { errorCodes } from "../src/errors";
 import config from "../config";
 
 describe("Without Paymaster", () => {
@@ -19,8 +20,8 @@ describe("Without Paymaster", () => {
     client = await Client.init(config.nodeUrl, {
       overrideBundlerRpc: config.bundlerUrl,
     });
-    client.waitTimeoutMs = 5000;
-    client.waitIntervalMs = 500;
+    client.waitTimeoutMs = 2000;
+    client.waitIntervalMs = 100;
     acc = await Presets.Builder.SimpleAccount.init(signer, config.nodeUrl, {
       overrideBundlerRpc: config.bundlerUrl,
     });
@@ -105,6 +106,21 @@ describe("Without Paymaster", () => {
     expect(event?.args.success).toBe(true);
   });
 
+  test("Sender cannot exceed the max batch gas limit", async () => {
+    expect.assertions(1);
+    try {
+      await client.sendUserOperation(
+        acc.execute(
+          config.testGas,
+          0,
+          testGas.interface.encodeFunctionData("recursiveCall", [32, 32])
+        )
+      );
+    } catch (error: any) {
+      expect(error?.error.code).toBe(errorCodes.invalidFields);
+    }
+  });
+
   describe("With increasing call stack size", () => {
     describe("With zero value calls", () => {
       [0, 2, 4, 8, 16].forEach((depth) => {

internal/config/values.go

@@ -10,7 +10,6 @@ import (
 	"github.com/gin-gonic/gin"
 	"github.com/spf13/viper"
 	"github.com/stackup-wallet/stackup-bundler/pkg/signer"
-	"github.com/stackup-wallet/stackup-bundler/pkg/tracer"
 )
 
 type Values struct {
@@ -21,6 +20,7 @@ type Values struct {
 	DataDirectory           string
 	SupportedEntryPoints    []common.Address
 	MaxVerificationGas      *big.Int
+	MaxBatchGasLimit        *big.Int
 	MaxOpsForUnstakedSender int
 	Beneficiary             string
 
@@ -33,10 +33,8 @@ type Values struct {
 	BlocksInTheFuture int
 
 	// Undocumented variables.
-	DebugMode              bool
-	GinMode                string
-	BundlerCollectorTracer string
-	BundlerErrorTracer     string
+	DebugMode bool
+	GinMode   string
 }
 
 func envArrayToAddressSlice(s string) []common.Address {
@@ -61,6 +59,7 @@ func GetValues() *Values {
 	viper.SetDefault("erc4337_bundler_data_directory", "/tmp/stackup_bundler")
 	viper.SetDefault("erc4337_bundler_supported_entry_points", "0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789")
 	viper.SetDefault("erc4337_bundler_max_verification_gas", 1500000)
+	viper.SetDefault("erc4337_bundler_max_batch_gas_limit", 25000000)
 	viper.SetDefault("erc4337_bundler_max_ops_for_unstaked_sender", 4)
 	viper.SetDefault("erc4337_bundler_blocks_in_the_future", 25)
 	viper.SetDefault("erc4337_bundler_debug_mode", false)
@@ -87,6 +86,7 @@ func GetValues() *Values {
 	_ = viper.BindEnv("erc4337_bundler_supported_entry_points")
 	_ = viper.BindEnv("erc4337_bundler_beneficiary")
 	_ = viper.BindEnv("erc4337_bundler_max_verification_gas")
+	_ = viper.BindEnv("erc4337_bundler_max_batch_gas_limit")
 	_ = viper.BindEnv("erc4337_bundler_max_ops_for_unstaked_sender")
 	_ = viper.BindEnv("erc4337_bundler_relayer_banned_threshold")
 	_ = viper.BindEnv("erc4337_bundler_relayer_banned_time_window")
@@ -119,12 +119,6 @@ func GetValues() *Values {
 		}
 	}
 
-	// Load js tracers from embedded file
-	trc, err := tracer.NewTracers()
-	if err != nil {
-		panic(err)
-	}
-
 	// Return Values
 	privateKey := viper.GetString("erc4337_bundler_private_key")
 	ethClientUrl := viper.GetString("erc4337_bundler_eth_client_url")
@@ -133,6 +127,7 @@ func GetValues() *Values {
 	supportedEntryPoints := envArrayToAddressSlice(viper.GetString("erc4337_bundler_supported_entry_points"))
 	beneficiary := viper.GetString("erc4337_bundler_beneficiary")
 	maxVerificationGas := big.NewInt(int64(viper.GetInt("erc4337_bundler_max_verification_gas")))
+	maxBatchGasLimit := big.NewInt(int64(viper.GetInt("erc4337_bundler_max_batch_gas_limit")))
 	maxOpsForUnstakedSender := viper.GetInt("erc4337_bundler_max_ops_for_unstaked_sender")
 	relayerBannedThreshold := viper.GetInt("erc4337_bundler_relayer_banned_threshold")
 	relayerBannedTimeWindow := viper.GetInt("erc4337_bundler_relayer_banned_time_window") * int(time.Second)
@@ -148,14 +143,13 @@ func GetValues() *Values {
 		SupportedEntryPoints:    supportedEntryPoints,
 		Beneficiary:             beneficiary,
 		MaxVerificationGas:      maxVerificationGas,
+		MaxBatchGasLimit:        maxBatchGasLimit,
 		MaxOpsForUnstakedSender: maxOpsForUnstakedSender,
 		RelayerBannedThreshold:  relayerBannedThreshold,
 		RelayerBannedTimeWindow: time.Duration(relayerBannedTimeWindow),
 		EthBuilderUrl:           ethBuilderUrl,
 		BlocksInTheFuture:       blocksInTheFuture,
 		DebugMode:               debugMode,
 		GinMode:                 ginMode,
-		BundlerCollectorTracer:  trc.BundlerCollectorTracer,
-		BundlerErrorTracer:      trc.BundlerErrorTracer,
 	}
 }

internal/start/private.go

@@ -64,7 +64,8 @@ func PrivateMode() {
 		ov.SetCalcPreVerificationGasFunc(gas.CalcArbitrumPVGWithEthClient(rpc, conf.SupportedEntryPoints[0]))
 		ov.SetPreVerificationGasBufferFactor(16)
 	}
-	if chain.Cmp(config.OptimismChainID) == 0 || chain.Cmp(config.OptimismGoerliChainID) == 0 || chain.Cmp(config.BaseGoerliChainID) == 0 {
+	if chain.Cmp(config.OptimismChainID) == 0 || chain.Cmp(config.OptimismGoerliChainID) == 0 ||
+		chain.Cmp(config.BaseGoerliChainID) == 0 {
 		ov.SetCalcPreVerificationGasFunc(
 			gas.CalcOptimismPVGWithEthClient(rpc, chain, conf.SupportedEntryPoints[0]),
 		)
@@ -81,8 +82,8 @@ func PrivateMode() {
 		rpc,
 		ov,
 		conf.MaxVerificationGas,
+		conf.MaxBatchGasLimit,
 		conf.MaxOpsForUnstakedSender,
-		conf.BundlerCollectorTracer,
 	)
 
 	relayer := relay.New(db, eoa, eth, chain, beneficiary, logr)
@@ -98,7 +99,7 @@ func PrivateMode() {
 	// Init Client
 	c := client.New(mem, ov, chain, conf.SupportedEntryPoints)
 	c.SetGetUserOpReceiptFunc(client.GetUserOpReceiptWithEthClient(eth))
-	c.SetGetGasEstimateFunc(client.GetGasEstimateWithEthClient(rpc, ov, chain, conf.BundlerErrorTracer))
+	c.SetGetGasEstimateFunc(client.GetGasEstimateWithEthClient(rpc, ov, chain))
 	c.SetGetUserOpByHashFunc(client.GetUserOpByHashWithEthClient(eth))
 	c.UseLogger(logr)
 	c.UseModules(
@@ -118,6 +119,7 @@ func PrivateMode() {
 		gasprice.SortByGasPrice(),
 		gasprice.FilterUnderpriced(),
 		batch.SortByNonce(),
+		batch.MaintainGasLimit(conf.MaxBatchGasLimit),
 		check.CodeHashes(),
 		check.PaymasterDeposit(),
 		relayer.SendUserOperation(),

internal/start/searcher.go

@@ -80,8 +80,8 @@ func SearcherMode() {
 		rpc,
 		ov,
 		conf.MaxVerificationGas,
+		conf.MaxBatchGasLimit,
 		conf.MaxOpsForUnstakedSender,
-		conf.BundlerCollectorTracer,
 	)
 	// TODO: Create separate go-routine for tracking transactions sent to the block builder.
 	builder := builder.New(eoa, eth, fb, beneficiary, conf.BlocksInTheFuture)
@@ -90,7 +90,7 @@ func SearcherMode() {
 	// Init Client
 	c := client.New(mem, ov, chain, conf.SupportedEntryPoints)
 	c.SetGetUserOpReceiptFunc(client.GetUserOpReceiptWithEthClient(eth))
-	c.SetGetGasEstimateFunc(client.GetGasEstimateWithEthClient(rpc, ov, chain, conf.BundlerErrorTracer))
+	c.SetGetGasEstimateFunc(client.GetGasEstimateWithEthClient(rpc, ov, chain))
 	c.SetGetUserOpByHashFunc(client.GetUserOpByHashWithEthClient(eth))
 	c.UseLogger(logr)
 	c.UseModules(
@@ -111,6 +111,7 @@ func SearcherMode() {
 		gasprice.SortByGasPrice(),
 		gasprice.FilterUnderpriced(),
 		batch.SortByNonce(),
+		batch.MaintainGasLimit(conf.MaxBatchGasLimit),
 		check.CodeHashes(),
 		check.PaymasterDeposit(),
 		builder.SendUserOperation(),

pkg/client/utils.go

@@ -48,10 +48,15 @@ func GetGasEstimateWithEthClient(
 	rpc *rpc.Client,
 	ov *gas.Overhead,
 	chain *big.Int,
-	tracer string,
 ) GetGasEstimateFunc {
 	return func(ep common.Address, op *userop.UserOperation) (verificationGas uint64, callGas uint64, err error) {
-		return gas.EstimateGas(rpc, ep, op, ov, chain, tracer)
+		return gas.EstimateGas(&gas.EstimateInput{
+			Rpc:        rpc,
+			EntryPoint: ep,
+			Op:         op,
+			Ov:         ov,
+			ChainID:    chain,
+		})
 	}
 }
 

pkg/entrypoint/execution/trace.go

@@ -26,9 +26,6 @@ type TraceInput struct {
 	Op         *userop.UserOperation
 	ChainID    *big.Int
 
-	// Tracer for debug_traceCall
-	CustomTracer string
-
 	// Optional params for simulateHandleOps
 	Target common.Address
 	Data   []byte
@@ -94,7 +91,7 @@ func TraceSimulateHandleOp(in *TraceInput) (*TraceOutput, error) {
 		Data: tx.Data(),
 	}
 	opts := utils.TraceCallOpts{
-		Tracer: in.CustomTracer,
+		Tracer: tracer.Loaded.BundlerErrorTracer,
 	}
 	if err := in.Rpc.CallContext(context.Background(), &res, "debug_traceCall", &req, "latest", &opts); err != nil {
 		return nil, err

pkg/entrypoint/simulation/tracevalidation.go

@@ -26,7 +26,6 @@ func TraceSimulateValidation(
 	entryPoint common.Address,
 	op *userop.UserOperation,
 	chainID *big.Int,
-	customTracer string,
 	stakes EntityStakes,
 ) ([]common.Address, error) {
 	ep, err := entrypoint.NewEntrypoint(entryPoint, ethclient.NewClient(rpc))
@@ -51,7 +50,7 @@ func TraceSimulateValidation(
 		Data: tx.Data(),
 	}
 	opts := utils.TraceCallOpts{
-		Tracer: customTracer,
+		Tracer: tracer.Loaded.BundlerCollectorTracer,
 	}
 	if err := rpc.CallContext(context.Background(), &res, "debug_traceCall", &req, "latest", &opts); err != nil {
 		return nil, err