Return null if userOpHash is valid but cannot be found on-chain (#362)

Author: hazim-j

pkg/client/utils.go

@@ -1,7 +1,6 @@
 package client
 
 import (
-	"errors"
 	"math/big"
 
 	"github.com/ethereum/go-ethereum/common"
@@ -20,8 +19,7 @@ type GetUserOpReceiptFunc = func(hash string, ep common.Address) (*filter.UserOp
 
 func getUserOpReceiptNoop() GetUserOpReceiptFunc {
 	return func(hash string, ep common.Address) (*filter.UserOperationReceipt, error) {
-		//lint:ignore ST1005 This needs to match the bundler test spec.
-		return nil, errors.New("Missing/invalid userOpHash")
+		return nil, nil
 	}
 }
 
@@ -67,8 +65,7 @@ func getGasEstimateNoop() GetGasEstimateFunc {
 		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")
+		return 0, 0, nil
 	}
 }
 
@@ -103,8 +100,7 @@ type GetUserOpByHashFunc func(hash string, ep common.Address, chain *big.Int) (*
 
 func getUserOpByHashNoop() GetUserOpByHashFunc {
 	return func(hash string, ep common.Address, chain *big.Int) (*filter.HashLookupResult, error) {
-		//lint:ignore ST1005 This needs to match the bundler test spec.
-		return nil, errors.New("Missing/invalid userOpHash")
+		return nil, nil
 	}
 }
 

pkg/entrypoint/filter/hash.go

@@ -0,0 +1,17 @@
+package filter
+
+import (
+	"fmt"
+	"regexp"
+	"strings"
+)
+
+var (
+	userOpHashStrLen = 64
+	userOpHashRegex  = regexp.MustCompile(fmt.Sprintf("(?i)0x[0-9a-f]{%d}", userOpHashStrLen))
+)
+
+func IsValidUserOpHash(userOpHash string) bool {
+	return len(strings.TrimPrefix(strings.ToLower(userOpHash), "0x")) == userOpHashStrLen &&
+		userOpHashRegex.MatchString(userOpHash)
+}

pkg/entrypoint/filter/hash_test.go

@@ -0,0 +1,68 @@
+package filter
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/stackup-wallet/stackup-bundler/internal/testutils"
+)
+
+func TestIsValidUserOpHash(t *testing.T) {
+	if ok := IsValidUserOpHash(testutils.MockHash); !ok {
+		t.Fatalf("%s: got false, want true", testutils.MockHash)
+	}
+
+	allNumHash := strings.ReplaceAll(testutils.MockHash, "dead", "0101")
+	if ok := IsValidUserOpHash(allNumHash); !ok {
+		t.Fatalf("%s: got false, want true", allNumHash)
+	}
+}
+
+func TestIsValidUserOpHashAllCaps(t *testing.T) {
+	hash := strings.ToUpper(testutils.MockHash)
+	if ok := IsValidUserOpHash(hash); !ok {
+		t.Fatalf("%s: got false, want true", hash)
+	}
+}
+
+func TestIsValidUserOpHashEmptyString(t *testing.T) {
+	hash := ""
+	if ok := IsValidUserOpHash(hash); ok {
+		t.Fatalf("%s: got true, want false", hash)
+	}
+}
+
+func TestIsValidUserOpHashEmptyHexString(t *testing.T) {
+	hash := "0x"
+	if ok := IsValidUserOpHash(hash); ok {
+		t.Fatalf("%s: got true, want false", hash)
+	}
+}
+
+func TestIsValidUserOpHashNoPrefix(t *testing.T) {
+	hash := strings.TrimPrefix(testutils.MockHash, "0x")
+	if ok := IsValidUserOpHash(hash); ok {
+		t.Fatalf("%s: got true, want false", hash)
+	}
+}
+
+func TestIsValidUserOpHashTooShort(t *testing.T) {
+	hash := "0xdead"
+	if ok := IsValidUserOpHash(hash); ok {
+		t.Fatalf("%s: got true, want false", hash)
+	}
+}
+
+func TestIsValidUserOpHashTooLong(t *testing.T) {
+	hash := testutils.MockHash + "dead"
+	if ok := IsValidUserOpHash(hash); ok {
+		t.Fatalf("%s: got true, want false", hash)
+	}
+}
+
+func TestIsValidUserOpHashInvalidChar(t *testing.T) {
+	hash := strings.ReplaceAll(testutils.MockHash, "dead", "zzzz")
+	if ok := IsValidUserOpHash(hash); ok {
+		t.Fatalf("%s: got true, want false", hash)
+	}
+}

pkg/entrypoint/filter/opbyhash.go

@@ -31,6 +31,11 @@ func GetUserOperationByHash(
 	entryPoint common.Address,
 	chainID *big.Int,
 ) (*HashLookupResult, error) {
+	if !IsValidUserOpHash(userOpHash) {
+		//lint:ignore ST1005 This needs to match the bundler test spec.
+		return nil, errors.New("Missing/invalid userOpHash")
+	}
+
 	it, err := filterUserOperationEvent(eth, userOpHash, entryPoint)
 	if err != nil {
 		return nil, err
@@ -45,8 +50,7 @@ func GetUserOperationByHash(
 		if err != nil {
 			return nil, err
 		} else if isPending {
-			//lint:ignore ST1005 This needs to match the bundler test spec.
-			return nil, errors.New("Missing/invalid userOpHash")
+			return nil, nil
 		}
 
 		hex := hexutil.Encode(tx.Data())
@@ -106,6 +110,5 @@ func GetUserOperationByHash(
 
 	}
 
-	//lint:ignore ST1005 This needs to match the bundler test spec.
-	return nil, errors.New("Missing/invalid userOpHash")
+	return nil, nil
 }

pkg/entrypoint/filter/receipt.go

@@ -44,6 +44,11 @@ func GetUserOperationReceipt(
 	userOpHash string,
 	entryPoint common.Address,
 ) (*UserOperationReceipt, error) {
+	if !IsValidUserOpHash(userOpHash) {
+		//lint:ignore ST1005 This needs to match the bundler test spec.
+		return nil, errors.New("Missing/invalid userOpHash")
+	}
+
 	it, err := filterUserOperationEvent(eth, userOpHash, entryPoint)
 	if err != nil {
 		return nil, err
@@ -58,8 +63,7 @@ func GetUserOperationReceipt(
 		if err != nil {
 			return nil, err
 		} else if isPending {
-			//lint:ignore ST1005 This needs to match the bundler test spec.
-			return nil, errors.New("Missing/invalid userOpHash")
+			return nil, nil
 		}
 		from, err := types.Sender(types.LatestSignerForChainID(tx.ChainId()), tx)
 		if err != nil {
@@ -92,6 +96,5 @@ func GetUserOperationReceipt(
 		}, nil
 	}
 
-	//lint:ignore ST1005 This needs to match the bundler test spec.
-	return nil, errors.New("Missing/invalid userOpHash")
+	return nil, nil
 }