feat: add chain-monitor

Author: julio4

playground/catalog.go

@@ -27,6 +27,7 @@ func init() {
 	register(&Contender{})
 	register(&BProxy{})
 	register(&WebsocketProxy{})
+	register(&ChainMonitor{})
 }
 
 func FindComponent(name string) ServiceGen {

playground/components.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"net"
 	"strconv"
 	"strings"
 	"time"
@@ -77,10 +78,18 @@ func (o *OpRbuilder) Run(service *Service, ctx *ExContext) {
 			"--metrics", `0.0.0.0:{{Port "metrics" 9090}}`,
 			"--port", `{{Port "rpc" 30303}}`,
 			"--builder.enable-revert-protection",
+			"--rollup.builder-secret-key", "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80",
 		).
 		WithArtifact("/data/jwtsecret", "jwtsecret").
 		WithArtifact("/data/l2-genesis.json", "l2-genesis.json").
-		WithVolume("data", "/data_op_reth")
+		WithVolume("data", "/data_op_reth").
+		WithReady(ReadyCheck{
+			QueryURL:    "http://localhost:8545",
+			Interval:    1 * time.Second,
+			Timeout:     10 * time.Second,
+			Retries:     20,
+			StartPeriod: 1 * time.Second,
+		})
 
 	if ctx.Bootnode != nil {
 		service.WithArgs("--trusted-peers", ctx.Bootnode.Connect())
@@ -225,6 +234,43 @@ func (w *WebsocketProxy) Name() string {
 	return "websocket-proxy"
 }
 
+type ChainMonitor struct {
+	L1RPC            string
+	L2BlockTime      string
+	L2BuilderAddress string
+	L2RPC            string
+	ServerListenAddress string
+}
+
+func (c *ChainMonitor) Run(service *Service, ctx *ExContext) {
+	serverListenAddress := c.ServerListenAddress
+	if serverListenAddress == "" {
+		serverListenAddress = "0.0.0.0:{{Port \"metrics\" 8080}}"
+	}
+
+    // we need to extract the port to register this service as exposing metrics
+	if _, portStr, err := net.SplitHostPort(serverListenAddress); err == nil {
+		if portNum, err := strconv.Atoi(portStr); err == nil {
+			service.WithPort("metrics", portNum)
+		}
+	}
+
+	service.WithImage("ghcr.io/flashbots/chain-monitor").
+		WithTag("v0.0.54").
+		WithArgs(
+			"serve",
+			"--l1-rpc", c.L1RPC,
+			"--l2-block-time", c.L2BlockTime,
+			"--l2-monitor-builder-address", c.L2BuilderAddress,
+			"--l2-rpc", c.L2RPC,
+			"--server-listen-address", serverListenAddress,
+		)
+}
+
+func (c *ChainMonitor) Name() string {
+	return "chain-monitor"
+}
+
 type OpBatcher struct {
 	L1Node             string
 	L2Node             string
@@ -275,6 +321,9 @@ func (o *OpNode) Run(service *Service, ctx *ExContext) {
 			"--l1.http-poll-interval", "6s",
 			"--l2", Connect(o.L2Node, "authrpc"),
 			"--l2.jwt-secret", "/data/jwtsecret",
+			"--metrics.enabled",
+			"--metrics.addr", "0.0.0.0",
+			"--metrics.port", `{{Port "metrics" 7300}}`,
 			"--sequencer.enabled",
 			"--sequencer.l1-confs", "0",
 			"--verifier.l1-confs", "0",
@@ -287,9 +336,6 @@ func (o *OpNode) Run(service *Service, ctx *ExContext) {
 			"--p2p.listen.udp", `{{PortUDP "p2p" 9003}}`,
 			"--p2p.scoring.peers", "light",
 			"--p2p.ban.peers", "true",
-			"--metrics.enabled",
-			"--metrics.addr", "0.0.0.0",
-			"--metrics.port", `{{Port "metrics" 7300}}`,
 			"--pprof.enabled",
 			"--rpc.enable-admin",
 			"--safedb.path", "/data_db",
@@ -375,7 +421,14 @@ func (o *OpGeth) Run(service *Service, ctx *ExContext) {
 		WithVolume("data", "/data_opgeth").
 		WithArtifact("/data/l2-genesis.json", "l2-genesis.json").
 		WithArtifact("/data/jwtsecret", "jwtsecret").
-		WithArtifact("/data/p2p_key.txt", o.Enode.Artifact)
+		WithArtifact("/data/p2p_key.txt", o.Enode.Artifact).
+		WithReady(ReadyCheck{
+			QueryURL:    "http://localhost:8545",
+			Interval:    1 * time.Second,
+			Timeout:     10 * time.Second,
+			Retries:     20,
+			StartPeriod: 1 * time.Second,
+		})
 }
 
 func (o *OpGeth) Name() string {
@@ -471,7 +524,14 @@ func (r *RethEL) Run(svc *Service, ctx *ExContext) {
 		).
 		WithArtifact("/data/genesis.json", "genesis.json").
 		WithArtifact("/data/jwtsecret", "jwtsecret").
-		WithVolume("data", "/data_reth")
+		WithVolume("data", "/data_reth").
+		WithReady(ReadyCheck{
+			QueryURL:    "http://localhost:8545",
+			Interval:    1 * time.Second,
+			Timeout:     10 * time.Second,
+			Retries:     20,
+			StartPeriod: 1 * time.Second,
+		})
 
 	if r.UseNativeReth {
 		// we need to use this otherwise the db cannot be binded
@@ -734,7 +794,14 @@ func (o *OpReth) Run(service *Service, ctx *ExContext) {
 			"--port", `{{Port "rpc" 30303}}`).
 		WithArtifact("/data/jwtsecret", "jwtsecret").
 		WithArtifact("/data/l2-genesis.json", "l2-genesis.json").
-		WithVolume("data", "/data_op_reth")
+		WithVolume("data", "/data_op_reth").
+		WithReady(ReadyCheck{
+			QueryURL:    "http://localhost:8545",
+			Interval:    1 * time.Second,
+			Timeout:     10 * time.Second,
+			Retries:     20,
+			StartPeriod: 1 * time.Second,
+		})
 }
 
 func (o *OpReth) Name() string {

playground/recipe_opstack.go

@@ -1,11 +1,14 @@
 package playground
 
 import (
+	"fmt"
 	flag "github.com/spf13/pflag"
 )
 
 var _ Recipe = &OpRecipe{}
 
+const defaultL2BuilderAddress = "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"
+
 // OpRecipe is a recipe that deploys an OP stack
 type OpRecipe struct {
 	// externalBuilder is the URL of the external builder to use. If enabled, the recipe deploys
@@ -36,6 +39,9 @@ type OpRecipe struct {
 
 	// whether to enable websocket proxy
 	enableWebsocketProxy bool
+
+	// whether to enable chain-monitor
+	enableChainMonitor bool
 }
 
 func (o *OpRecipe) Name() string {
@@ -56,6 +62,7 @@ func (o *OpRecipe) Flags() *flag.FlagSet {
 	flags.BoolVar(&o.baseOverlay, "base-overlay", false, "Whether to use base implementation for flashblocks-rpc")
 	flags.StringVar(&o.flashblocksBuilderURL, "flashblocks-builder", "", "External URL of builder flashblocks stream")
 	flags.BoolVar(&o.enableWebsocketProxy, "enable-websocket-proxy", false, "Whether to enable websocket proxy")
+	flags.BoolVar(&o.enableChainMonitor, "chain-monitor", false, "Whether to enable chain-monitor")
 	return flags
 }
 
@@ -175,6 +182,21 @@ func (o *OpRecipe) Apply(ctx *ExContext, artifacts *Artifacts) *Manifest {
 		MaxChannelDuration: o.batcherMaxChannelDuration,
 	})
 
+	if o.enableChainMonitor {
+		l2BlockTime := fmt.Sprintf("%ds", o.blockTime)
+
+		svcManager.AddService("chain-monitor", &ChainMonitor{
+			L1RPC:            Connect("el", "http"),
+			L2BlockTime:      l2BlockTime,
+			L2BuilderAddress: defaultL2BuilderAddress,
+			L2RPC:            Connect("op-geth", "http"),
+		})
+
+		svcManager.MustGetService("chain-monitor").
+			DependsOnHealthy("el").
+			DependsOnHealthy("op-geth")
+	}
+
 	if svcManager.ctx.Contender.TargetChain == "" {
 		svcManager.ctx.Contender.TargetChain = "op-geth"
 	}