Merge pull request #196 from flashbots/feat/contender-target-chain-flag

variable contender targets

Author: zeroXbrock

main.go

@@ -32,6 +32,7 @@ var disableLogs bool
 var platform string
 var contenderEnabled bool
 var contenderArgs []string
+var contenderTarget string
 
 var rootCmd = &cobra.Command{
 	Use:   "playground",
@@ -183,6 +184,7 @@ func main() {
 		recipeCmd.Flags().StringVar(&platform, "platform", "", "docker platform to use")
 		recipeCmd.Flags().BoolVar(&contenderEnabled, "contender", false, "spam nodes with contender")
 		recipeCmd.Flags().StringArrayVar(&contenderArgs, "contender.arg", []string{}, "add/override contender CLI flags")
+		recipeCmd.Flags().StringVar(&contenderTarget, "contender.target", "", "override the node that contender spams -- accepts names like \"el\"")
 
 		cookCmd.AddCommand(recipeCmd)
 	}
@@ -232,8 +234,9 @@ func runIt(recipe playground.Recipe) error {
 	svcManager := recipe.Apply(&playground.ExContext{
 		LogLevel: logLevel,
 		Contender: &playground.ContenderContext{
-			Enabled:   contenderEnabled,
-			ExtraArgs: contenderArgs,
+			Enabled:     contenderEnabled,
+			ExtraArgs:   contenderArgs,
+			TargetChain: contenderTarget,
 		},
 	}, artifacts)
 	if err := svcManager.Validate(); err != nil {

playground/components.go

@@ -813,7 +813,16 @@ func (n *nullService) Name() string {
 }
 
 type Contender struct {
-	ExtraArgs []string
+	ExtraArgs   []string
+	TargetChain string // defaults to "el", may be any chain name in a recipe's spec
+}
+
+// Converts a `ContenderContext` into a `Contender` service. `Enabled` is ignored.
+func (cc *ContenderContext) Contender() *Contender {
+	return &Contender{
+		ExtraArgs:   cc.ExtraArgs,
+		TargetChain: cc.TargetChain,
+	}
 }
 
 func (c *Contender) Name() string {
@@ -854,10 +863,16 @@ func (c *Contender) Run(service *Service, ctx *ExContext) {
 		val    string
 		hasVal bool
 	}
+
+	targetChain := "el"
+	if c.TargetChain != "" {
+		targetChain = c.TargetChain
+	}
+
 	defaults := []opt{
 		{name: "-l"},
 		{name: "--min-balance", val: "10 ether", hasVal: true},
-		{name: "-r", val: Connect("el", "http"), hasVal: true},
+		{name: "-r", val: Connect(targetChain, "http"), hasVal: true},
 		{name: "--tps", val: "20", hasVal: true},
 	}
 
@@ -888,6 +903,9 @@ func (c *Contender) Run(service *Service, ctx *ExContext) {
 		if flag == "-l" && seen["--loops"] {
 			return true
 		}
+		if flag == "-r" && seen["--rpc-url"] {
+			return true
+		}
 		return false
 	}
 
@@ -922,4 +940,7 @@ func (c *Contender) Run(service *Service, ctx *ExContext) {
 		WithArgs(args...).
 		DependsOnHealthy("beacon")
 
+	if c.TargetChain == "op-geth" {
+		service.DependsOnRunning("op-node")
+	}
 }

playground/manifest.go

@@ -74,8 +74,11 @@ type ContenderContext struct {
 	// Run `contender spam` automatically once all playground services are running.
 	Enabled bool
 
-	// Provide additional args to contender's CLI
+	// Provide additional args to contender's CLI.
 	ExtraArgs []string
+
+	// Override the default target chain for contender to spam.
+	TargetChain string
 }
 
 // Execution context
@@ -603,3 +606,9 @@ func ReadManifest(outputFolder string) (*Manifest, error) {
 	}
 	return &manifestData, nil
 }
+
+func (svcManager *Manifest) RunContenderIfEnabled() {
+	if svcManager.ctx.Contender.Enabled {
+		svcManager.AddService("contender", svcManager.ctx.Contender.Contender())
+	}
+}

playground/recipe_buildernet.go

@@ -59,11 +59,7 @@ func (b *BuilderNetRecipe) Apply(ctx *ExContext, artifacts *Artifacts) *Manifest
 		})
 	}
 
-	if ctx.Contender.Enabled {
-		svcManager.AddService("contender", &Contender{
-			ExtraArgs: ctx.Contender.ExtraArgs,
-		})
-	}
+	svcManager.RunContenderIfEnabled()
 
 	return svcManager
 }

playground/recipe_l1.go

@@ -107,11 +107,7 @@ func (l *L1Recipe) Apply(ctx *ExContext, artifacts *Artifacts) *Manifest {
 		})
 	}
 
-	if ctx.Contender.Enabled {
-		svcManager.AddService("contender", &Contender{
-			ExtraArgs: ctx.Contender.ExtraArgs,
-		})
-	}
+	svcManager.RunContenderIfEnabled()
 
 	return svcManager
 }

playground/recipe_opstack.go

@@ -175,11 +175,10 @@ func (o *OpRecipe) Apply(ctx *ExContext, artifacts *Artifacts) *Manifest {
 		MaxChannelDuration: o.batcherMaxChannelDuration,
 	})
 
-	if ctx.Contender.Enabled {
-		svcManager.AddService("contender", &Contender{
-			ExtraArgs: ctx.Contender.ExtraArgs,
-		})
+	if svcManager.ctx.Contender.TargetChain == "" {
+		svcManager.ctx.Contender.TargetChain = "op-geth"
 	}
+	svcManager.RunContenderIfEnabled()
 
 	return svcManager
 }