Parse state override set (#347)

Author: hazim-j

pkg/client/client.go

@@ -14,6 +14,7 @@ import (
 	"github.com/stackup-wallet/stackup-bundler/pkg/mempool"
 	"github.com/stackup-wallet/stackup-bundler/pkg/modules"
 	"github.com/stackup-wallet/stackup-bundler/pkg/modules/noop"
+	"github.com/stackup-wallet/stackup-bundler/pkg/state"
 	"github.com/stackup-wallet/stackup-bundler/pkg/userop"
 )
 
@@ -139,11 +140,15 @@ func (i *Client) SendUserOperation(op map[string]any, ep string) (string, error)
 	return hash.String(), nil
 }
 
-// EstimateUserOperationGas returns estimates for PreVerificationGas, VerificationGas, and CallGasLimit given
-// a UserOperation and EntryPoint address. The signature field and current gas values will not be validated
-// although there should be dummy values in place for the most reliable results (e.g. a signature with the
-// correct length).
-func (i *Client) EstimateUserOperationGas(op map[string]any, ep string) (*gas.GasEstimates, error) {
+// EstimateUserOperationGas returns estimates for PreVerificationGas, VerificationGasLimit, and CallGasLimit
+// given a UserOperation, EntryPoint address, and state OverrideSet. The signature field and current gas
+// values will not be validated although there should be dummy values in place for the most reliable results
+// (e.g. a signature with the correct length).
+func (i *Client) EstimateUserOperationGas(
+	op map[string]any,
+	ep string,
+	os map[string]any,
+) (*gas.GasEstimates, error) {
 	// Init logger
 	l := i.logger.WithName("eth_estimateUserOperationGas")
 
@@ -165,6 +170,12 @@ func (i *Client) EstimateUserOperationGas(op map[string]any, ep string) (*gas.Ga
 	hash := userOp.GetUserOpHash(epAddr, i.chainID)
 	l = l.WithValues("userop_hash", hash)
 
+	_, 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)
 	if err != nil {

pkg/client/rpc.go

@@ -33,9 +33,9 @@ func (r *RpcAdapter) Eth_sendUserOperation(op userOperation, ep string) (string,
 func (r *RpcAdapter) Eth_estimateUserOperationGas(
 	op userOperation,
 	ep string,
-	ov optional_stateOverride,
+	os optional_stateOverride,
 ) (*gas.GasEstimates, error) {
-	return r.client.EstimateUserOperationGas(op, ep)
+	return r.client.EstimateUserOperationGas(op, ep, os)
 }
 
 // Eth_getUserOperationReceipt routes method calls to *Client.GetUserOperationReceipt.

pkg/state/override.go

@@ -1,18 +1,44 @@
 package state
 
 import (
+	"encoding/json"
+	"fmt"
+
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/common/hexutil"
 )
 
 type OverrideAccount struct {
 	Nonce     *hexutil.Uint64              `json:"nonce"`
 	Code      *hexutil.Bytes               `json:"code"`
-	Balance   **hexutil.Big                `json:"balance"`
+	Balance   *hexutil.Big                 `json:"balance"`
 	State     *map[common.Hash]common.Hash `json:"state"`
 	StateDiff *map[common.Hash]common.Hash `json:"stateDiff"`
 }
 
 // OverrideSet is a set of accounts with customized state that can be applied during eth_call or
 // debug_traceCall.
 type OverrideSet map[common.Address]OverrideAccount
+
+// ParseOverrideData decodes a map into an OverrideSet and validates all the fields are correctly typed.
+func ParseOverrideData(data map[string]any) (OverrideSet, error) {
+	os := OverrideSet{}
+	for key, value := range data {
+		if !common.IsHexAddress(key) {
+			return nil, fmt.Errorf("%w: %s", ErrBadKey, key)
+		}
+
+		b, err := json.Marshal(value)
+		if err != nil {
+			return nil, fmt.Errorf("%w %s: %w", ErrBadValue, key, err)
+		}
+
+		oa := OverrideAccount{}
+		if err := json.Unmarshal(b, &oa); err != nil {
+			return nil, fmt.Errorf("%w %s: %w", ErrBadValue, key, err)
+		}
+
+		os[common.HexToAddress(key)] = oa
+	}
+	return os, nil
+}