Support native bundlerCollectorTracer (#365)

Author: hazim-j

.github/workflows/compliance.yml

@@ -49,15 +49,10 @@ jobs:
           yarn install --frozen-lockfile && \
           yarn build
 
-      - name: Install Geth
-        run: |
-          wget https://gethstore.blob.core.windows.net/builds/geth-linux-amd64-1.12.2-bed84606.tar.gz && \
-          tar -xvf geth-linux-amd64-1.12.2-bed84606.tar.gz
-
       - name: Run Geth
         run: |
-          cd geth-linux-amd64-1.12.2-bed84606 && \
-          ./geth \
+          docker run -d --name node -p 8545:8545 \
+          stackupwallet/go-ethereum:v1.13.11 \
           --verbosity 1 \
           --http.vhosts '*,localhost,host.docker.internal' \
           --http \
@@ -69,7 +64,7 @@ jobs:
           --dev \
           --allow-insecure-unlock \
           --rpc.allow-unprotected-txs \
-          --miner.gaslimit 12000000 &
+          --miner.gaslimit 12000000
 
       - name: Install bundler dependencies
         run: go mod download
@@ -85,8 +80,8 @@ jobs:
 
       - name: Fund bundler
         run: |
-          cd geth-linux-amd64-1.12.2-bed84606 && \
-          ./geth \
+          docker exec node \
+          geth \
           --exec "eth.sendTransaction({from: eth.accounts[0], to: \"0x43378ff8C70109Ee4Dbe85aF34428ab0615EBd23\", value: web3.toWei(10000, \"ether\")})" \
           attach http://localhost:8545/
 
@@ -96,6 +91,7 @@ jobs:
           ERC4337_BUNDLER_ETH_CLIENT_URL: http://localhost:8545/
           ERC4337_BUNDLER_PORT: 3000
           ERC4337_BUNDLER_DEBUG_MODE: true
+          ERC4337_BUNDLER_NATIVE_BUNDLER_COLLECTOR_TRACER: bundlerCollectorTracer
           # This key is for testing purposes only. Do not use for anything else.
           ERC4337_BUNDLER_PRIVATE_KEY: c6cbc5ffad570fdad0544d1b5358a36edeb98d163b6567912ac4754e144d4edb
 

.github/workflows/e2e.yml

@@ -62,15 +62,10 @@ jobs:
           path: ./contracts
           submodules: true
 
-      - name: Install Geth
-        run: |
-          sudo add-apt-repository -y ppa:ethereum/ethereum && \
-          sudo apt-get update && \
-          sudo apt-get install ethereum
-
       - name: Run Geth
         run: |
-          geth \
+          docker run -d --name node -p 8545:8545 \
+          stackupwallet/go-ethereum:v1.13.11 \
           --verbosity 1 \
           --http.vhosts '*,localhost,host.docker.internal' \
           --http \
@@ -82,7 +77,7 @@ jobs:
           --dev \
           --allow-insecure-unlock \
           --rpc.allow-unprotected-txs \
-          --miner.gaslimit 12000000 &
+          --miner.gaslimit 12000000
 
       - name: Install all dependencies
         run: |
@@ -110,6 +105,7 @@ jobs:
         env:
           ERC4337_BUNDLER_ETH_CLIENT_URL: http://localhost:8545/
           ERC4337_BUNDLER_DEBUG_MODE: true
+          ERC4337_BUNDLER_NATIVE_BUNDLER_COLLECTOR_TRACER: bundlerCollectorTracer
           # This key is for testing purposes only. Do not use for anything else.
           ERC4337_BUNDLER_PRIVATE_KEY: c6cbc5ffad570fdad0544d1b5358a36edeb98d163b6567912ac4754e144d4edb
 

e2e/README.md

@@ -61,3 +61,11 @@ Assuming you have your environment properly setup, you can use the following com
 ```bash
 yarn run test
 ```
+
+## Using native tracers for faster performance
+
+For better performance, build Geth from source using the [ERC-4337 Execution Clients](https://github.com/stackup-wallet/erc-4337-execution-clients) repository. Run the built geth binary and reset the bundler with the following config:
+
+```
+ERC4337_BUNDLER_NATIVE_BUNDLER_COLLECTOR_TRACER=bundlerCollectorTracer
+```

internal/config/values.go

@@ -15,16 +15,17 @@ import (
 
 type Values struct {
 	// Documented variables.
-	PrivateKey           string
-	EthClientUrl         string
-	Port                 int
-	DataDirectory        string
-	SupportedEntryPoints []common.Address
-	MaxVerificationGas   *big.Int
-	MaxBatchGasLimit     *big.Int
-	MaxOpTTL             time.Duration
-	Beneficiary          string
-	ReputationConstants  *entities.ReputationConstants
+	PrivateKey                   string
+	EthClientUrl                 string
+	Port                         int
+	DataDirectory                string
+	SupportedEntryPoints         []common.Address
+	MaxVerificationGas           *big.Int
+	MaxBatchGasLimit             *big.Int
+	MaxOpTTL                     time.Duration
+	Beneficiary                  string
+	NativeBundlerCollectorTracer string
+	ReputationConstants          *entities.ReputationConstants
 
 	// Searcher mode variables.
 	EthBuilderUrls    []string
@@ -113,6 +114,7 @@ func GetValues() *Values {
 	_ = viper.BindEnv("erc4337_bundler_data_directory")
 	_ = viper.BindEnv("erc4337_bundler_supported_entry_points")
 	_ = viper.BindEnv("erc4337_bundler_beneficiary")
+	_ = viper.BindEnv("erc4337_bundler_native_bundler_collector_tracer")
 	_ = viper.BindEnv("erc4337_bundler_max_verification_gas")
 	_ = viper.BindEnv("erc4337_bundler_max_batch_gas_limit")
 	_ = viper.BindEnv("erc4337_bundler_max_op_ttl_seconds")
@@ -170,6 +172,7 @@ func GetValues() *Values {
 	dataDirectory := viper.GetString("erc4337_bundler_data_directory")
 	supportedEntryPoints := envArrayToAddressSlice(viper.GetString("erc4337_bundler_supported_entry_points"))
 	beneficiary := viper.GetString("erc4337_bundler_beneficiary")
+	nativeBundlerCollectorTracer := viper.GetString("erc4337_bundler_native_bundler_collector_tracer")
 	maxVerificationGas := big.NewInt(int64(viper.GetInt("erc4337_bundler_max_verification_gas")))
 	maxBatchGasLimit := big.NewInt(int64(viper.GetInt("erc4337_bundler_max_batch_gas_limit")))
 	maxOpTTL := time.Second * viper.GetDuration("erc4337_bundler_max_op_ttl_seconds")
@@ -184,25 +187,26 @@ func GetValues() *Values {
 	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,
-		MaxBatchGasLimit:      maxBatchGasLimit,
-		MaxOpTTL:              maxOpTTL,
-		ReputationConstants:   NewReputationConstantsFromEnv(),
-		EthBuilderUrls:        ethBuilderUrls,
-		BlocksInTheFuture:     blocksInTheFuture,
-		OTELServiceName:       otelServiceName,
-		OTELCollectorHeaders:  otelCollectorHeader,
-		OTELCollectorUrl:      otelCollectorUrl,
-		OTELInsecureMode:      otelInsecureMode,
-		AltMempoolIPFSGateway: altMempoolIPFSGateway,
-		AltMempoolIds:         altMempoolIds,
-		DebugMode:             debugMode,
-		GinMode:               ginMode,
+		PrivateKey:                   privateKey,
+		EthClientUrl:                 ethClientUrl,
+		Port:                         port,
+		DataDirectory:                dataDirectory,
+		SupportedEntryPoints:         supportedEntryPoints,
+		Beneficiary:                  beneficiary,
+		NativeBundlerCollectorTracer: nativeBundlerCollectorTracer,
+		MaxVerificationGas:           maxVerificationGas,
+		MaxBatchGasLimit:             maxBatchGasLimit,
+		MaxOpTTL:                     maxOpTTL,
+		ReputationConstants:          NewReputationConstantsFromEnv(),
+		EthBuilderUrls:               ethBuilderUrls,
+		BlocksInTheFuture:            blocksInTheFuture,
+		OTELServiceName:              otelServiceName,
+		OTELCollectorHeaders:         otelCollectorHeader,
+		OTELCollectorUrl:             otelCollectorUrl,
+		OTELInsecureMode:             otelInsecureMode,
+		AltMempoolIPFSGateway:        altMempoolIPFSGateway,
+		AltMempoolIds:                altMempoolIds,
+		DebugMode:                    debugMode,
+		GinMode:                      ginMode,
 	}
 }

internal/start/private.go

@@ -115,6 +115,7 @@ func PrivateMode() {
 		alt,
 		conf.MaxVerificationGas,
 		conf.MaxBatchGasLimit,
+		conf.NativeBundlerCollectorTracer,
 		conf.ReputationConstants,
 	)
 

internal/start/searcher.go

@@ -111,6 +111,7 @@ func SearcherMode() {
 		alt,
 		conf.MaxVerificationGas,
 		conf.MaxBatchGasLimit,
+		conf.NativeBundlerCollectorTracer,
 		conf.ReputationConstants,
 	)
 

pkg/entrypoint/simulation/tracevalidation.go

@@ -27,6 +27,7 @@ type TraceInput struct {
 	EntryPoint  common.Address
 	Op          *userop.UserOperation
 	ChainID     *big.Int
+	Tracer      string
 	Stakes      EntityStakes
 	AltMempools *altmempools.Directory
 }
@@ -53,6 +54,10 @@ func TraceSimulateValidation(in *TraceInput) (*TraceOutput, error) {
 	if err != nil {
 		return nil, err
 	}
+	t := tracer.Loaded.BundlerCollectorTracer
+	if in.Tracer != "" {
+		t = in.Tracer
+	}
 
 	var res tracer.BundlerCollectorReturn
 	req := utils.TraceCallReq{
@@ -62,7 +67,7 @@ func TraceSimulateValidation(in *TraceInput) (*TraceOutput, error) {
 		MaxFeePerGas: hexutil.Big(*in.Op.MaxFeePerGas),
 	}
 	opts := utils.TraceCallOpts{
-		Tracer:         tracer.Loaded.BundlerCollectorTracer,
+		Tracer:         t,
 		StateOverrides: state.WithMaxBalanceOverride(common.HexToAddress("0x"), nil),
 	}
 	if err := in.Rpc.CallContext(context.Background(), &res, "debug_traceCall", &req, "latest", &opts); err != nil {

pkg/modules/checks/standalone.go

@@ -33,6 +33,7 @@ type Standalone struct {
 	alt                *altmempools.Directory
 	maxVerificationGas *big.Int
 	maxBatchGasLimit   *big.Int
+	tracer             string
 	repConst           *entities.ReputationConstants
 }
 
@@ -45,10 +46,11 @@ func New(
 	alt *altmempools.Directory,
 	maxVerificationGas *big.Int,
 	maxBatchGasLimit *big.Int,
+	tracer string,
 	repConst *entities.ReputationConstants,
 ) *Standalone {
 	eth := ethclient.NewClient(rpc)
-	return &Standalone{db, rpc, eth, ov, alt, maxVerificationGas, maxBatchGasLimit, repConst}
+	return &Standalone{db, rpc, eth, ov, alt, maxVerificationGas, maxBatchGasLimit, tracer, repConst}
 }
 
 // ValidateOpValues returns a UserOpHandler that runs through some first line sanity checks for new UserOps
@@ -109,6 +111,7 @@ func (s *Standalone) SimulateOp() modules.UserOpHandlerFunc {
 				AltMempools: s.alt,
 				Op:          ctx.UserOp,
 				ChainID:     ctx.ChainID,
+				Tracer:      s.tracer,
 				Stakes: simulation.EntityStakes{
 					ctx.UserOp.Sender:         ctx.GetSenderDepositInfo(),
 					ctx.UserOp.GetFactory():   ctx.GetFactoryDepositInfo(),

pkg/tracer/types.go

@@ -35,7 +35,7 @@ type CallFromEntryPointInfo struct {
 	Opcodes               Counts               `json:"opcodes"`
 	Access                AccessMap            `json:"access"`
 	ContractSize          ContractSizeMap      `json:"contractSize"`
-	ExtCodeAccessInfo     ExtCodeAccessInfoMap `json:"ExtCodeAccessInfo"`
+	ExtCodeAccessInfo     ExtCodeAccessInfoMap `json:"extCodeAccessInfo"`
 	OOG                   bool                 `json:"oog"`
 }