Allow configurable max ops for unstaked sender (#80)

Author: hazim-j

internal/config/values.go

@@ -14,13 +14,14 @@ import (
 
 type Values struct {
 	// Documented variables.
-	PrivateKey           string
-	EthClientUrl         string
-	Port                 int
-	DataDirectory        string
-	SupportedEntryPoints []common.Address
-	MaxVerificationGas   *big.Int
-	Beneficiary          string
+	PrivateKey              string
+	EthClientUrl            string
+	Port                    int
+	DataDirectory           string
+	SupportedEntryPoints    []common.Address
+	MaxVerificationGas      *big.Int
+	MaxOpsForUnstakedSender int
+	Beneficiary             string
 
 	// Undocumented variables.
 	DebugMode              bool
@@ -46,6 +47,7 @@ func GetValues() *Values {
 	viper.SetDefault("erc4337_bundler_data_directory", "/tmp/stackup_bundler")
 	viper.SetDefault("erc4337_bundler_supported_entry_points", "0x0F46c65C17AA6b4102046935F33301f0510B163A")
 	viper.SetDefault("erc4337_bundler_max_verification_gas", 1500000)
+	viper.SetDefault("erc4337_bundler_max_ops_for_unstaked_sender", 4)
 	viper.SetDefault("erc4337_bundler_debug_mode", false)
 	viper.SetDefault("erc4337_bundler_gin_mode", gin.ReleaseMode)
 
@@ -63,30 +65,15 @@ func GetValues() *Values {
 	}
 
 	// Read in from environment variables
-	if err := viper.BindEnv("erc4337_bundler_eth_client_url"); err != nil {
-		panic(err)
-	}
-	if err := viper.BindEnv("erc4337_bundler_private_key"); err != nil {
-		panic(err)
-	}
-	if err := viper.BindEnv("erc4337_bundler_port"); err != nil {
-		panic(err)
-	}
-	if err := viper.BindEnv("erc4337_bundler_data_directory"); err != nil {
-		panic(err)
-	}
-	if err := viper.BindEnv("erc4337_bundler_supported_entry_points"); err != nil {
-		panic(err)
-	}
-	if err := viper.BindEnv("erc4337_bundler_beneficiary"); err != nil {
-		panic(err)
-	}
-	if err := viper.BindEnv("erc4337_bundler_max_verification_gas"); err != nil {
-		panic(err)
-	}
-	if err := viper.BindEnv("erc4337_bundler_gin_mode"); err != nil {
-		panic(err)
-	}
+	_ = viper.BindEnv("erc4337_bundler_eth_client_url")
+	_ = viper.BindEnv("erc4337_bundler_private_key")
+	_ = viper.BindEnv("erc4337_bundler_port")
+	_ = viper.BindEnv("erc4337_bundler_data_directory")
+	_ = viper.BindEnv("erc4337_bundler_supported_entry_points")
+	_ = viper.BindEnv("erc4337_bundler_beneficiary")
+	_ = viper.BindEnv("erc4337_bundler_max_verification_gas")
+	_ = viper.BindEnv("erc4337_bundler_max_ops_for_unstaked_sender")
+	_ = viper.BindEnv("erc4337_bundler_gin_mode")
 
 	// Validate required variables
 	if !viper.IsSet("erc4337_bundler_eth_client_url") ||
@@ -120,18 +107,20 @@ 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")))
+	maxOpsForUnstakedSender := viper.GetInt("erc4337_bundler_max_ops_for_unstaked_sender")
 	debugMode := viper.GetBool("erc4337_bundler_debug_mode")
 	ginMode := viper.GetString("erc4337_bundler_gin_mode")
 	return &Values{
-		PrivateKey:             privateKey,
-		EthClientUrl:           ethClientUrl,
-		Port:                   port,
-		DataDirectory:          dataDirectory,
-		SupportedEntryPoints:   supportedEntryPoints,
-		Beneficiary:            beneficiary,
-		MaxVerificationGas:     maxVerificationGas,
-		DebugMode:              debugMode,
-		GinMode:                ginMode,
-		BundlerCollectorTracer: bct,
+		PrivateKey:              privateKey,
+		EthClientUrl:            ethClientUrl,
+		Port:                    port,
+		DataDirectory:           dataDirectory,
+		SupportedEntryPoints:    supportedEntryPoints,
+		Beneficiary:             beneficiary,
+		MaxVerificationGas:      maxVerificationGas,
+		MaxOpsForUnstakedSender: maxOpsForUnstakedSender,
+		DebugMode:               debugMode,
+		GinMode:                 ginMode,
+		BundlerCollectorTracer:  bct,
 	}
 }

internal/start/private.go

@@ -77,7 +77,12 @@ func PrivateMode() {
 		log.Fatal(err)
 	}
 
-	check := checks.New(rpc, conf.MaxVerificationGas, conf.BundlerCollectorTracer)
+	check := checks.New(
+		rpc,
+		conf.MaxVerificationGas,
+		conf.MaxOpsForUnstakedSender,
+		conf.BundlerCollectorTracer,
+	)
 	relayer := relay.New(db, eoa, eth, chain, beneficiary, logr)
 	paymaster := paymaster.New(db)
 

internal/testutils/constants.go

@@ -9,11 +9,13 @@ import (
 )
 
 var (
-	OneETH                 = big.NewInt(1000000000000000000)
-	DefaultUnstakeDelaySec = uint32(86400)
-	ValidAddress           = common.HexToAddress("0x7357b8a705328FC283dF72D7Ac546895B596DC12")
-	ChainID                = big.NewInt(1)
-	StakedDepositInfo      = &entrypoint.IStakeManagerDepositInfo{
+	OneETH                  = big.NewInt(1000000000000000000)
+	DefaultUnstakeDelaySec  = uint32(86400)
+	ValidAddress1           = common.HexToAddress("0x7357b8a705328FC283dF72D7Ac546895B596DC12")
+	ValidAddress2           = common.HexToAddress("0x7357c9504B8686c008CCcD6ea47f1c21B7475dE3")
+	ChainID                 = big.NewInt(1)
+	MaxOpsForUnstakedSender = 1
+	StakedDepositInfo       = &entrypoint.IStakeManagerDepositInfo{
 		Deposit:         big.NewInt(OneETH.Int64()),
 		Staked:          true,
 		Stake:           big.NewInt(OneETH.Int64()),

pkg/client/debug.go

@@ -77,6 +77,9 @@ func (d *Debug) SendBundleNow() (string, error) {
 	if err != nil {
 		return "", err
 	}
+	if len(batch) > 1 {
+		batch = batch[:1]
+	}
 
 	est, revert, err := entrypoint.EstimateHandleOpsGas(
 		d.eoa,
@@ -107,6 +110,10 @@ func (d *Debug) SendBundleNow() (string, error) {
 		return "", errors.New("debug: bad batch during call")
 	}
 
+	if err := d.mempool.RemoveOps(d.entrypoint, batch...); err != nil {
+		return "", err
+	}
+
 	return txn.Hash().String(), nil
 }
 

pkg/mempool/instance_test.go

@@ -14,7 +14,7 @@ func TestAddOpToMempool(t *testing.T) {
 	db := testutils.DBMock()
 	defer db.Close()
 	mem, _ := New(db)
-	ep := testutils.ValidAddress
+	ep := testutils.ValidAddress1
 	op := testutils.MockValidInitUserOp()
 
 	if err := mem.AddOp(ep, op); err != nil {
@@ -40,7 +40,7 @@ func TestReplaceOpInMempool(t *testing.T) {
 	db := testutils.DBMock()
 	defer db.Close()
 	mem, _ := New(db)
-	ep := testutils.ValidAddress
+	ep := testutils.ValidAddress1
 	op1 := testutils.MockValidInitUserOp()
 	op2 := testutils.MockValidInitUserOp()
 	op2.MaxPriorityFeePerGas = big.NewInt(0).Add(op1.MaxPriorityFeePerGas, common.Big1)
@@ -70,7 +70,7 @@ func TestRemoveOpsFromMempool(t *testing.T) {
 	db := testutils.DBMock()
 	defer db.Close()
 	mem, _ := New(db)
-	ep := testutils.ValidAddress
+	ep := testutils.ValidAddress1
 	op := testutils.MockValidInitUserOp()
 
 	if err := mem.AddOp(ep, op); err != nil {
@@ -96,9 +96,10 @@ func TestBundleOpsFromMempool(t *testing.T) {
 	db := testutils.DBMock()
 	defer db.Close()
 	mem, _ := New(db)
-	ep := testutils.ValidAddress
+	ep := testutils.ValidAddress1
 	op1 := testutils.MockValidInitUserOp()
 	op2 := testutils.MockValidInitUserOp()
+	op2.Sender = testutils.ValidAddress2
 	op2.Nonce = big.NewInt(0).Add(op1.Nonce, common.Big1)
 	op2.MaxPriorityFeePerGas = big.NewInt(0).Add(op1.MaxPriorityFeePerGas, common.Big1)
 
@@ -128,7 +129,7 @@ func TestNewMempoolLoadsFromDisk(t *testing.T) {
 	db := testutils.DBMock()
 	defer db.Close()
 	mem1, _ := New(db)
-	ep := testutils.ValidAddress
+	ep := testutils.ValidAddress1
 	op1 := testutils.MockValidInitUserOp()
 	op2 := testutils.MockValidInitUserOp()
 	op2.Nonce = big.NewInt(0).Add(op1.Nonce, common.Big1)

pkg/mempool/queue.go

@@ -69,6 +69,15 @@ func (q *userOpQueues) Next(entryPoint common.Address) []*userop.UserOperation {
 		batch = append(batch, n.Value.(*userop.UserOperation))
 	}
 
+	// Ensure that ops with same sender is ordered by ascending nonce regardless of MaxPriorityFeePerGas
+	for i := 0; i < len(batch); i++ {
+		for j := i + 1; j < len(batch); j++ {
+			if batch[i].Sender == batch[j].Sender && batch[i].Nonce.Cmp(batch[j].Nonce) > 0 {
+				batch[i], batch[j] = batch[j], batch[i]
+			}
+		}
+	}
+
 	return batch
 }
 

pkg/modules/checks/pendingops.go

@@ -2,6 +2,7 @@ package checks
 
 import (
 	"errors"
+	"fmt"
 	"math/big"
 
 	"github.com/stackup-wallet/stackup-bundler/pkg/userop"
@@ -11,8 +12,13 @@ import (
 //
 //  1. Sender doesn't have another UserOperation already present in the pool.
 //  2. It replaces an existing UserOperation with same nonce and higher fee.
-//  3. Sender is staked and is allowed multiple UserOperations in the pool.
-func ValidatePendingOps(op *userop.UserOperation, penOps []*userop.UserOperation, gs GetStakeFunc) error {
+//  3. Sender is staked and is allowed uncapped UserOperations in the pool.
+func ValidatePendingOps(
+	op *userop.UserOperation,
+	penOps []*userop.UserOperation,
+	maxOpsForUnstakedSender int,
+	gs GetStakeFunc,
+) error {
 	dep, err := gs(op.Sender)
 	if err != nil {
 		return err
@@ -38,9 +44,10 @@ func ValidatePendingOps(op *userop.UserOperation, penOps []*userop.UserOperation
 			if op.MaxFeePerGas.Cmp(mf) != 0 {
 				return errors.New("pending ops: replaced op must have an equally higher max fee")
 			}
-		} else if !dep.Staked {
-			return errors.New(
-				"pending ops: sender must be staked to have multiple ops in the mempool",
+		} else if !dep.Staked && len(penOps) >= maxOpsForUnstakedSender {
+			return fmt.Errorf(
+				"pending ops: sender must be staked to have more than %d ops in the mempool",
+				maxOpsForUnstakedSender,
 			)
 		}
 	}

pkg/modules/checks/pendingops_test.go

@@ -13,7 +13,12 @@ import (
 func TestNoPendingOps(t *testing.T) {
 	penOps := []*userop.UserOperation{}
 	op := testutils.MockValidInitUserOp()
-	err := ValidatePendingOps(op, penOps, testutils.MockGetNotStakeZeroDeposit)
+	err := ValidatePendingOps(
+		op,
+		penOps,
+		testutils.MaxOpsForUnstakedSender,
+		testutils.MockGetNotStakeZeroDeposit,
+	)
 
 	if err != nil {
 		t.Fatalf("got err %v, want nil", err)
@@ -27,7 +32,12 @@ func TestPendingOpsNotStaked(t *testing.T) {
 	penOps := []*userop.UserOperation{penOp}
 	op := testutils.MockValidInitUserOp()
 	op.Nonce = big.NewInt(0).Add(penOp.Nonce, common.Big1)
-	err := ValidatePendingOps(op, penOps, testutils.MockGetNotStakeZeroDeposit)
+	err := ValidatePendingOps(
+		op,
+		penOps,
+		testutils.MaxOpsForUnstakedSender,
+		testutils.MockGetNotStakeZeroDeposit,
+	)
 
 	if err == nil {
 		t.Fatal("got nil, want err")
@@ -41,7 +51,12 @@ func TestPendingOpsStaked(t *testing.T) {
 	penOps := []*userop.UserOperation{penOp}
 	op := testutils.MockValidInitUserOp()
 	op.Nonce = big.NewInt(0).Add(penOp.Nonce, common.Big1)
-	err := ValidatePendingOps(op, penOps, testutils.MockGetStakeZeroDeposit)
+	err := ValidatePendingOps(
+		op,
+		penOps,
+		testutils.MaxOpsForUnstakedSender,
+		testutils.MockGetStakeZeroDeposit,
+	)
 
 	if err != nil {
 		t.Fatalf("got err %v, want nil", err)
@@ -56,7 +71,12 @@ func TestReplaceOp(t *testing.T) {
 	op := testutils.MockValidInitUserOp()
 	op.MaxPriorityFeePerGas = big.NewInt(0).Add(penOp.MaxPriorityFeePerGas, common.Big1)
 	op.MaxFeePerGas = big.NewInt(0).Add(penOp.MaxFeePerGas, common.Big1)
-	err := ValidatePendingOps(op, penOps, testutils.MockGetNotStakeZeroDeposit)
+	err := ValidatePendingOps(
+		op,
+		penOps,
+		testutils.MaxOpsForUnstakedSender,
+		testutils.MockGetNotStakeZeroDeposit,
+	)
 
 	if err != nil {
 		t.Fatalf("got err %v, want nil", err)
@@ -70,7 +90,12 @@ func TestReplaceOpLowerMPF(t *testing.T) {
 	penOps := []*userop.UserOperation{penOp}
 	op := testutils.MockValidInitUserOp()
 	op.MaxPriorityFeePerGas = big.NewInt(0).Sub(penOp.MaxPriorityFeePerGas, common.Big1)
-	err := ValidatePendingOps(op, penOps, testutils.MockGetNotStakeZeroDeposit)
+	err := ValidatePendingOps(
+		op,
+		penOps,
+		testutils.MaxOpsForUnstakedSender,
+		testutils.MockGetNotStakeZeroDeposit,
+	)
 
 	if err == nil {
 		t.Fatal("got nil, want err")
@@ -84,7 +109,12 @@ func TestReplaceOpEqualMPF(t *testing.T) {
 	penOps := []*userop.UserOperation{penOp}
 	op := testutils.MockValidInitUserOp()
 	op.MaxPriorityFeePerGas = big.NewInt(0).Add(penOp.MaxPriorityFeePerGas, common.Big0)
-	err := ValidatePendingOps(op, penOps, testutils.MockGetNotStakeZeroDeposit)
+	err := ValidatePendingOps(
+		op,
+		penOps,
+		testutils.MaxOpsForUnstakedSender,
+		testutils.MockGetNotStakeZeroDeposit,
+	)
 
 	if err == nil {
 		t.Fatal("got nil, want err")
@@ -99,7 +129,12 @@ func TestReplaceOpNotEqualIncMF(t *testing.T) {
 	op := testutils.MockValidInitUserOp()
 	op.MaxPriorityFeePerGas = big.NewInt(0).Add(penOp.MaxPriorityFeePerGas, common.Big2)
 	op.MaxFeePerGas = big.NewInt(0).Add(penOp.MaxFeePerGas, common.Big1)
-	err := ValidatePendingOps(op, penOps, testutils.MockGetNotStakeZeroDeposit)
+	err := ValidatePendingOps(
+		op,
+		penOps,
+		testutils.MaxOpsForUnstakedSender,
+		testutils.MockGetNotStakeZeroDeposit,
+	)
 
 	if err == nil {
 		t.Fatal("got nil, want err")
@@ -114,7 +149,12 @@ func TestReplaceOpSameMF(t *testing.T) {
 	op := testutils.MockValidInitUserOp()
 	op.MaxPriorityFeePerGas = big.NewInt(0).Add(penOp.MaxPriorityFeePerGas, common.Big1)
 	op.MaxFeePerGas = big.NewInt(0).Add(penOp.MaxFeePerGas, common.Big0)
-	err := ValidatePendingOps(op, penOps, testutils.MockGetNotStakeZeroDeposit)
+	err := ValidatePendingOps(
+		op,
+		penOps,
+		testutils.MaxOpsForUnstakedSender,
+		testutils.MockGetNotStakeZeroDeposit,
+	)
 
 	if err == nil {
 		t.Fatal("got nil, want err")
@@ -129,7 +169,12 @@ func TestReplaceOpDecMF(t *testing.T) {
 	op := testutils.MockValidInitUserOp()
 	op.MaxPriorityFeePerGas = big.NewInt(0).Add(penOp.MaxPriorityFeePerGas, common.Big1)
 	op.MaxFeePerGas = big.NewInt(0).Sub(penOp.MaxFeePerGas, common.Big1)
-	err := ValidatePendingOps(op, penOps, testutils.MockGetNotStakeZeroDeposit)
+	err := ValidatePendingOps(
+		op,
+		penOps,
+		testutils.MaxOpsForUnstakedSender,
+		testutils.MockGetNotStakeZeroDeposit,
+	)
 
 	if err == nil {
 		t.Fatal("got nil, want err")