From cc1b360838a3d60234a84160b974d51a95f5aad8 Mon Sep 17 00:00:00 2001
From: Barnabas Busa <busa.barnabas@gmail.com>
Date: Fri, 7 Jun 2024 13:48:17 +0200
Subject: [PATCH] update readme

---
 README.md                            | 69 ++++++++++++++++++++++++++++
 src/cl/op-node/op_node_launcher.star |  8 ++++
 src/el/op-geth/op_geth_launcher.star |  1 -
 src/el/op-reth/op_reth_launcher.star |  1 -
 4 files changed, 77 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 43caf32..05e68db 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,72 @@ ethereum_package:
     - dora
     - blockscout
 ```
+
+
+## Configuration
+
+To configure the package behaviour, you can modify your `network_params.yaml` file. The full YAML schema that can be passed in is as follows with the defaults provided:
+
+```yaml
+optimism_package:
+  # Specification of the optimism-participants in the network
+  participants:
+    # EL(Execution Layer) Specific flags
+      # The type of EL client that should be started
+      # Valid values are op-geth, op-reth
+    - el_type: geth
+
+      # The Docker image that should be used for the EL client; leave blank to use the default for the client type
+      # Defaults by client:
+      # - op-geth: us-docker.pkg.dev/oplabs-tools-artifacts/images/op-geth:latest
+      # - op-reth: parithoshj/op-reth:v0.2.0-beta.9
+      el_image: ""
+
+    # CL(Consensus Layer) Specific flags
+      # The type of CL client that should be started
+      # Valid values are op-node, ?
+      cl_type: op-node
+
+      # The Docker image that should be used for the CL client; leave blank to use the default for the client type
+      # Defaults by client:
+      # - op-node: parithoshj/op-node:v1
+      cl_image: ""
+
+      # Count of nodes to spin up for this participant
+      # Default to 1
+      count: 1
+
+  # Default configuration parameters for the network
+  network_params:
+    # Network name, used to enable syncing of alternative networks
+    # Defaults to "kurtosis"
+    # You can sync any public network by setting this to the network name (e.g. "mainnet", "sepolia", "holesky")
+    # You can sync any devnet by setting this to the network name (e.g. "dencun-devnet-12", "verkle-gen-devnet-2")
+    network: "kurtosis"
+
+    # The network ID of the network.
+    network_id: "2151908"
+
+    # Seconds per slots
+    seconds_per_slot: 2
+```
+
+### Additional configuration recommendations
+
+It is required you to launch an L1 Ethereum node to interact with the L2 network. You can use the `ethereum_package` to launch an Ethereum node. The `ethereum_package` configuration is as follows:
+
+```yaml
+optimism_package:
+  participants:
+    - el_type: op-geth
+      cl_type: op-node
+ethereum_package:
+  participants:
+    - el_type: geth
+    - el_type: reth
+  network_params:
+    preset: minimal
+  additional_services:
+    - dora
+    - blockscout
+```
diff --git a/src/cl/op-node/op_node_launcher.star b/src/cl/op-node/op_node_launcher.star
index 9a433d8..fb14c8b 100644
--- a/src/cl/op-node/op_node_launcher.star
+++ b/src/cl/op-node/op_node_launcher.star
@@ -196,3 +196,11 @@ def get_beacon_config(
             timeout="1m",
         ),
     )
+
+
+def new_op_node_launcher(el_cl_genesis_data, jwt_file, network_params):
+    return struct(
+        el_cl_genesis_data=el_cl_genesis_data,
+        jwt_file=jwt_file,
+        network=network_params.network,
+    )
diff --git a/src/el/op-geth/op_geth_launcher.star b/src/el/op-geth/op_geth_launcher.star
index 7619363..b70c24d 100644
--- a/src/el/op-geth/op_geth_launcher.star
+++ b/src/el/op-geth/op_geth_launcher.star
@@ -183,7 +183,6 @@ def get_config(
         "--metrics.port={0}".format(METRICS_PORT_NUM),
         "--discovery.port={0}".format(discovery_port),
         "--port={0}".format(discovery_port),
-        "--rollup.disabletxpoolgossip=true",
     ]
 
     if not sequencer_enabled:
diff --git a/src/el/op-reth/op_reth_launcher.star b/src/el/op-reth/op_reth_launcher.star
index fff627e..88e26ef 100644
--- a/src/el/op-reth/op_reth_launcher.star
+++ b/src/el/op-reth/op_reth_launcher.star
@@ -168,7 +168,6 @@ def get_config(
         "--metrics=0.0.0.0:{0}".format(METRICS_PORT_NUM),
         "--discovery.port={0}".format(discovery_port),
         "--port={0}".format(discovery_port),
-        "--rollup.disabletxpoolgossip=true",
     ]
 
     if not sequencer_enabled: