Add pending UserOps by same sender to context (#73)

Author: hazim-j

internal/testutils/constants.go

@@ -12,6 +12,7 @@ var (
 	OneETH                 = big.NewInt(1000000000000000000)
 	DefaultUnstakeDelaySec = uint32(86400)
 	ValidAddress           = common.HexToAddress("0x7357b8a705328FC283dF72D7Ac546895B596DC12")
+	ChainID                = big.NewInt(1)
 	StakedDepositInfo      = &entrypoint.IStakeManagerDepositInfo{
 		Deposit:         big.NewInt(OneETH.Int64()),
 		Staked:          true,

pkg/client/client.go

@@ -113,8 +113,15 @@ func (i *Client) SendUserOperation(op map[string]any, ep string) (string, error)
 	// 	}
 	// }
 
+	// Fetch any pending UserOperations in the mempool by the same sender
+	penOps, err := i.mempool.GetOps(epAddr, userOp.Sender)
+	if err != nil {
+		l.Error(err, "eth_sendUserOperation error")
+		return "", err
+	}
+
 	// Run through client module stack.
-	ctx := modules.NewUserOpHandlerContext(userOp, epAddr, i.chainID)
+	ctx := modules.NewUserOpHandlerContext(userOp, penOps, epAddr, i.chainID)
 	if err := i.userOpHandler(ctx); err != nil {
 		l.Error(err, "eth_sendUserOperation error")
 		return "", err

pkg/modules/context.go

@@ -64,11 +64,13 @@ type UserOpHandlerCtx struct {
 	EntryPoint common.Address
 	ChainID    *big.Int
 	deposits   map[common.Address]*entrypoint.IStakeManagerDepositInfo
+	pendingOps []*userop.UserOperation
 }
 
 // NewUserOpHandlerContext creates a new UserOpHandlerCtx using a given op.
 func NewUserOpHandlerContext(
 	op *userop.UserOperation,
+	pendingOps []*userop.UserOperation,
 	entryPoint common.Address,
 	chainID *big.Int,
 ) *UserOpHandlerCtx {
@@ -77,6 +79,7 @@ func NewUserOpHandlerContext(
 		EntryPoint: entryPoint,
 		ChainID:    chainID,
 		deposits:   make(map[common.Address]*entrypoint.IStakeManagerDepositInfo),
+		pendingOps: append([]*userop.UserOperation{}, pendingOps...),
 	}
 }
 
@@ -90,3 +93,8 @@ func (c *UserOpHandlerCtx) AddDepositInfo(entity common.Address, dep *entrypoint
 func (c *UserOpHandlerCtx) GetDepositInfo(entity common.Address) *entrypoint.IStakeManagerDepositInfo {
 	return c.deposits[entity]
 }
+
+// GetPendingOps returns all pending UserOperations in the mempool by the same UserOp.Sender.
+func (c *UserOpHandlerCtx) GetPendingOps() []*userop.UserOperation {
+	return c.pendingOps
+}

pkg/modules/context_test.go

@@ -6,12 +6,14 @@ import (
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/stackup-wallet/stackup-bundler/internal/testutils"
+	"github.com/stackup-wallet/stackup-bundler/pkg/userop"
 )
 
 // TestAddDepositInfoToCtx verifies that stake info can be added to a context and later retrieved.
 func TestAddDepositInfoToCtx(t *testing.T) {
 	op := testutils.MockValidInitUserOp()
-	ctx := NewUserOpHandlerContext(op, common.HexToAddress("0x"), big.NewInt(1))
+	penOps := []*userop.UserOperation{}
+	ctx := NewUserOpHandlerContext(op, penOps, testutils.ValidAddress, testutils.ChainID)
 
 	entity := op.GetFactory()
 	dep := testutils.StakedDepositInfo
@@ -26,9 +28,34 @@ func TestAddDepositInfoToCtx(t *testing.T) {
 // set. Expects nil.
 func TestGetNilDepositInfoFromCtx(t *testing.T) {
 	op := testutils.MockValidInitUserOp()
-	ctx := NewUserOpHandlerContext(op, common.HexToAddress("0x"), big.NewInt(1))
+	penOps := []*userop.UserOperation{}
+	ctx := NewUserOpHandlerContext(op, penOps, testutils.ValidAddress, testutils.ChainID)
 
 	if dep := ctx.GetDepositInfo(op.GetFactory()); dep != nil {
 		t.Fatalf("got %+v, want nil", dep)
 	}
 }
+
+// TestGetPendingOps calls (c *UserOpHandlerCtx).GetPendingOps and verifies that it returns the same array of
+// UserOperations the context was initialized with.
+func TestGetPendingOps(t *testing.T) {
+	op := testutils.MockValidInitUserOp()
+	penOp1 := testutils.MockValidInitUserOp()
+	penOp2 := testutils.MockValidInitUserOp()
+	penOp2.Nonce = big.NewInt(0).Add(penOp1.Nonce, common.Big1)
+	penOp3 := testutils.MockValidInitUserOp()
+	penOp3.Nonce = big.NewInt(0).Add(penOp2.Nonce, common.Big1)
+	initPenOps := []*userop.UserOperation{penOp1, penOp2, penOp3}
+	ctx := NewUserOpHandlerContext(op, initPenOps, testutils.ValidAddress, testutils.ChainID)
+
+	penOps := ctx.GetPendingOps()
+	if len(penOps) != len(initPenOps) {
+		t.Fatalf("got length %d, want %d", len(penOps), len(initPenOps))
+	}
+
+	for i, penOp := range penOps {
+		if !testutils.IsOpsEqual(penOp, initPenOps[i]) {
+			t.Fatalf("ops not equal: %s", testutils.GetOpsDiff(penOp, initPenOps[i]))
+		}
+	}
+}