Add flashblocks (#170)

* Add flashblocks

* Finish

* Update docs

* Fix

Author: ferranbt

examples/op-stack-flashblocks.md

@@ -0,0 +1,24 @@
+# Op Stack Rollup Boost with Flashblocks
+
+This example shows how to deploy an Op Stack with rollup-boost using Flashblocks for pre-confirmations.
+
+## What is Flashblocks?
+
+Flashblocks is a feature in rollup-boost that enables pre-confirmations by proposing incremental sections of blocks. This allows for faster transaction confirmations and improved user experience on L2 networks.
+
+## Quick Start
+
+Deploy the Op Stack with rollup-boost and Flashblocks enabled:
+
+```bash
+$ go run main.go cook opstack --external-builder op-rbuilder --flashblocks
+```
+
+This will deploy an Op Stack chain with:
+
+- A complete L1 setup (CL/EL)
+- A complete L2 sequencer (op-geth/op-node/op-batcher)
+- Rollup-boost with Flashblocks enabled for pre-confirmations
+- Op-rbuilder as the external block builder with Flashblocks support
+
+The `--flashblocks` flag enables the Flashblocks feature, allowing the system to provide pre-confirmations for faster transaction processing.

playground/artifacts.go

@@ -411,6 +411,10 @@ func Connect(service, port string) string {
 	return ConnectRaw(service, port, "http", "")
 }
 
+func ConnectWs(service, port string) string {
+	return ConnectRaw(service, port, "ws", "")
+}
+
 type output struct {
 	dst string
 

playground/catalog.go

@@ -21,6 +21,7 @@ func init() {
 	register(&BuilderHubPostgres{})
 	register(&BuilderHubMockProxy{})
 	register(&nullService{})
+	register(&OpRbuilder{})
 }
 
 func FindComponent(name string) ServiceGen {

playground/components.go

@@ -13,25 +13,80 @@ var defaultJWTToken = "04592280e1778419b7aa954d43871cb2cfb2ebda754fb735e8adeb293
 type RollupBoost struct {
 	ELNode  string
 	Builder string
+
+	Flashblocks           bool
+	FlashblocksBuilderURL string
 }
 
 func (r *RollupBoost) Run(service *Service, ctx *ExContext) {
 	service.
 		WithImage("docker.io/flashbots/rollup-boost").
-		WithTag("0.4rc1").
+		WithTag("0.7.0").
 		WithArgs(
+			"--rpc-host", "0.0.0.0",
 			"--rpc-port", `{{Port "authrpc" 8551}}`,
 			"--l2-jwt-path", "/data/jwtsecret",
 			"--l2-url", Connect(r.ELNode, "authrpc"),
 			"--builder-jwt-path", "/data/jwtsecret",
 			"--builder-url", r.Builder,
 		).WithArtifact("/data/jwtsecret", "jwtsecret")
+
+	if r.Flashblocks {
+		service.WithArgs(
+			"--flashblocks",
+			"--flashblocks-host", "0.0.0.0",
+			"--flashblocks-port", `{{Port "flashblocks" 1112}}`,
+		)
+	}
+	if r.FlashblocksBuilderURL != "" {
+		service.WithArgs(
+			"--flashblocks-builder-url", r.FlashblocksBuilderURL,
+		)
+	}
 }
 
 func (r *RollupBoost) Name() string {
 	return "rollup-boost"
 }
 
+type OpRbuilder struct {
+	Flashblocks bool
+}
+
+func (o *OpRbuilder) Run(service *Service, ctx *ExContext) {
+	service.WithImage("ghcr.io/flashbots/op-rbuilder").
+		WithTag("sha-4f1931b").
+		WithArgs(
+			"node",
+			"--authrpc.port", `{{Port "authrpc" 8551}}`,
+			"--authrpc.addr", "0.0.0.0",
+			"--authrpc.jwtsecret", "/data/jwtsecret",
+			"--http",
+			"--http.addr", "0.0.0.0",
+			"--http.port", `{{Port "http" 8545}}`,
+			"--chain", "/data/l2-genesis.json",
+			"--datadir", "/data_op_reth",
+			"--disable-discovery",
+			"--color", "never",
+			"--metrics", `0.0.0.0:{{Port "metrics" 9090}}`,
+			"--port", `{{Port "rpc" 30303}}`).
+		WithArtifact("/data/jwtsecret", "jwtsecret").
+		WithArtifact("/data/l2-genesis.json", "l2-genesis.json").
+		WithVolume("data", "/data_op_reth")
+
+	if o.Flashblocks {
+		service.WithArgs(
+			"--flashblocks.enabled",
+			"--flashblocks.addr", "0.0.0.0",
+			"--flashblocks.port", `{{Port "flashblocks" 1112}}`,
+		)
+	}
+}
+
+func (o *OpRbuilder) Name() string {
+	return "op-rbuilder"
+}
+
 type OpBatcher struct {
 	L1Node             string
 	L2Node             string

playground/recipe_opstack.go

@@ -22,6 +22,14 @@ type OpRecipe struct {
 	// batcherMaxChannelDuration is the maximum channel duration to use for the batcher
 	// (default is 2 seconds)
 	batcherMaxChannelDuration uint64
+
+	// whether to enable flashblocks in Rollup-boost. Note the internal builder **will not** be
+	// using flashblocks. This is meant to be used with an external builder for now.
+	flashblocks bool
+
+	// flashblocksBuilderURL is the URL of the builder that returns the flashblocks. This is meant to be used
+	// for external builders.
+	flashblocksBuilderURL string
 }
 
 func (o *OpRecipe) Name() string {
@@ -38,6 +46,7 @@ func (o *OpRecipe) Flags() *flag.FlagSet {
 	flags.Var(&nullableUint64Value{&o.enableLatestFork}, "enable-latest-fork", "Enable latest fork isthmus (nil or empty = disabled, otherwise enabled at specified block)")
 	flags.Uint64Var(&o.blockTime, "block-time", defaultOpBlockTimeSeconds, "Block time to use for the rollup")
 	flags.Uint64Var(&o.batcherMaxChannelDuration, "batcher-max-channel-duration", 2, "Maximum channel duration to use for the batcher")
+	flags.BoolVar(&o.flashblocks, "flashblocks", false, "Whether to enable flashblocks")
 	return flags
 }
 
@@ -58,21 +67,35 @@ func (o *OpRecipe) Apply(ctx *ExContext, artifacts *Artifacts) *Manifest {
 		BeaconNode: "beacon",
 	})
 
+	flashblocksBuilderURLRef := o.flashblocksBuilderURL
 	externalBuilderRef := o.externalBuilder
+
 	if o.externalBuilder == "op-reth" {
 		// Add a new op-reth service and connect it to Rollup-boost
 		svcManager.AddService("op-reth", &OpReth{})
 
 		externalBuilderRef = Connect("op-reth", "authrpc")
+	} else if o.externalBuilder == "op-rbuilder" {
+		svcManager.AddService("op-rbuilder", &OpRbuilder{
+			Flashblocks: o.flashblocks,
+		})
+		externalBuilderRef = Connect("op-rbuilder", "authrpc")
+	}
+
+	if o.flashblocks && o.externalBuilder == "op-rbuilder" {
+		// If flashblocks is enabled and using op-rbuilder, use it to deliver flashblocks
+		flashblocksBuilderURLRef = ConnectWs("op-rbuilder", "flashblocks")
 	}
 
 	elNode := "op-geth"
 	if o.externalBuilder != "" {
 		elNode = "rollup-boost"
 
 		svcManager.AddService("rollup-boost", &RollupBoost{
-			ELNode:  "op-geth",
-			Builder: externalBuilderRef,
+			ELNode:                "op-geth",
+			Builder:               externalBuilderRef,
+			Flashblocks:           o.flashblocks,
+			FlashblocksBuilderURL: flashblocksBuilderURLRef,
 		})
 	}
 	svcManager.AddService("op-node", &OpNode{