feat!: launch spamoor daemon with web ui (#964)

pk910 · barnabasbusa · web-flow · commit dabce8c5ae92 · 2025-04-15T19:59:10.000+02:00
This PR changes the spamoor service to use the spamoor-damon that comes with a management web interface. This is a breaking change as the previous spamoor properties (`scenario`, `throughput`, `max_pending`, `max_wallets`) are replaced with a list of spammers to load on startup: ``` spamoor_params: image: "ethpandaops/spamoor:master" spammers: - scenario: eoatx # The spamoor scenario to use (see https://github.com/ethpandaops/spamoor) name: "Optional name for this example spammer" config: throughput: 10 # 10 tx per block # more spammers when needed ``` --------- Co-authored-by: Barnabas Busa <barnabas.busa@ethereum.org>
diff --git a/.github/tests/blobber.yaml b/.github/tests/blobber.yaml
@@ -13,4 +13,4 @@ participants:
     count: 1
 additional_services:
   - dora
-  - spamoor_blob
+  - spamoor
diff --git a/.github/tests/eof-fulu.yaml.norun b/.github/tests/eof-fulu.yaml.norun
@@ -22,6 +22,6 @@ network_params:
 additional_services:
   - dora
   - tx_fuzz
-  - spamoor_blob
+  - spamoor
 
 snooper_enabled: true
diff --git a/.github/tests/geth-all.yaml b/.github/tests/geth-all.yaml
@@ -12,5 +12,5 @@ participants:
   - el_type: geth
     cl_type: grandine
 additional_services:
-  - spamoor_blob
+  - spamoor
   - dora
diff --git a/.github/tests/mainnet-split.yaml.norun b/.github/tests/mainnet-split.yaml.norun
@@ -48,7 +48,7 @@ mev_type: flashbots
 
 additional_services:
   - dora
-  - spamoor_blob
+  - spamoor
   - tx_fuzz
   - assertoor
 
diff --git a/.github/tests/mev-commit-boost.yaml b/.github/tests/mev-commit-boost.yaml
@@ -4,7 +4,7 @@ participants:
 mev_type: commit-boost
 additional_services:
   - tx_fuzz
-  - spamoor_blob
+  - spamoor
   - custom_flood
   - forkmon
   - dora
diff --git a/.github/tests/mev-mock.yaml b/.github/tests/mev-mock.yaml
@@ -5,7 +5,7 @@ participants:
 mev_type: mock
 additional_services:
   - dora
-  - spamoor_blob
+  - spamoor
   - tx_fuzz
 mev_params:
   mock_mev_image: "ethpandaops/rustic-builder:main"
diff --git a/.github/tests/mev-pectra.yaml b/.github/tests/mev-pectra.yaml
@@ -35,7 +35,6 @@ participants:
 additional_services:
   - dora
   - tx_fuzz
-  - spamoor_blob
   - spamoor
 mev_type: flashbots
 
@@ -53,7 +52,10 @@ network_params:
   churn_limit_quotient: 16
   genesis_delay: 120
 
-spamoor_blob_params:
-  throughput: 10
-  sidecars: 2
-  max_pending: 40
+spamoor_params:
+  spammers:
+    - scenario: blob-combined
+      config:
+        throughput: 10
+        sidecars: 2
+        max_pending: 40
diff --git a/.github/tests/mev.yaml b/.github/tests/mev.yaml
@@ -12,7 +12,7 @@ mev_params:
 additional_services:
   - tx_fuzz
   - custom_flood
-  - spamoor_blob
+  - spamoor
   - dora
   - prometheus_grafana
 network_params:
diff --git a/.github/tests/minimal-pectra-devnet-5.yaml.norun b/.github/tests/minimal-pectra-devnet-5.yaml.norun
@@ -21,15 +21,18 @@ network_params:
   genesis_delay: 240
 additional_services:
   - dora
-  - spamoor_blob
+  - spamoor
   - tx_fuzz
   - assertoor
 dora_params:
   image: "ethpandaops/dora:master-latest"
-spamoor_blob_params:
-  throughput: 10
-  sidecars: 2
-  max_pending: 40
+spamoor_params:
+  spammers:
+    - scenario: blob-combined
+      config:
+        throughput: 10
+        sidecars: 2
+        max_pending: 40
 
 assertoor_params:
   image: "ethpandaops/assertoor:master"
diff --git a/.github/tests/mix-with-tools-mev.yaml b/.github/tests/mix-with-tools-mev.yaml
@@ -16,7 +16,6 @@ additional_services:
   - forkmon
   - dora
   - prometheus_grafana
-  - spamoor_blob
   - custom_flood
   - blobscan
   - blockscout
diff --git a/.github/tests/mix-with-tools-minimal.yaml b/.github/tests/mix-with-tools-minimal.yaml
@@ -18,7 +18,6 @@ additional_services:
   - forkmon
   - dora
   - prometheus_grafana
-  - spamoor_blob
   - custom_flood
   - blobscan
   - blockscout
diff --git a/.github/tests/mix-with-tools.yaml b/.github/tests/mix-with-tools.yaml
@@ -18,7 +18,6 @@ additional_services:
   - forkmon
   - dora
   - prometheus_grafana
-  - spamoor_blob
   - custom_flood
   - blobscan
   - dugtrio
diff --git a/.github/tests/mock-mev-pectra-devnet-5.yaml.norun b/.github/tests/mock-mev-pectra-devnet-5.yaml.norun
@@ -29,14 +29,17 @@ network_params:
 
 additional_services:
   - dora
-  - spamoor_blob
+  - spamoor
   - tx_fuzz
   - assertoor
 dora_params:
   image: "ethpandaops/dora:master-latest"
-spamoor_blob_params:
-  throughput: 10
-  sidecars: 2
-  max_pending: 40
+spamoor_params:
+  spammers:
+    - scenario: blob-combined
+      config:
+        throughput: 10
+        sidecars: 2
+        max_pending: 40
 
 global_log_level: debug
diff --git a/.github/tests/pectra-devnet-6.yaml.norun b/.github/tests/pectra-devnet-6.yaml.norun
@@ -32,15 +32,18 @@ network_params:
   genesis_delay: 240
 additional_services:
   - dora
-  - spamoor_blob
+  - spamoor
   - tx_fuzz
   - assertoor
 dora_params:
   image: "ethpandaops/dora:master-latest"
-spamoor_blob_params:
-  throughput: 10
-  sidecars: 2
-  max_pending: 40
+spamoor_params:
+  spammers:
+    - scenario: blob-combined
+      config:
+        throughput: 10
+        sidecars: 2
+        max_pending: 40
 
 global_log_level: debug
 
diff --git a/.github/tests/peerdas-fulu.yaml.norun b/.github/tests/peerdas-fulu.yaml.norun
@@ -73,7 +73,7 @@ network_params:
 
 additional_services:
   - dora
-  - spamoor_blob
+  - spamoor
   - prometheus_grafana
 
 snooper_enabled: false
diff --git a/README.md b/README.md
@@ -663,7 +663,6 @@ additional_services:
   - tx_fuzz
   - custom_flood
   - spamoor
-  - spamoor_blob
   - forkmon
   - blockscout
   - dora
@@ -952,51 +951,18 @@ checkpoint_sync_url: ""
 spamoor_params:
   # The image to use for spamoor
   image: ethpandaops/spamoor:latest
-  # The spamoor scenario to use (see https://github.com/ethpandaops/spamoor)
-  # Valid scenarios are:
-  #  eoatx, erctx, deploytx, deploy-destruct, blobs, gasburnertx
-  # Defaults to eoatx
-  scenario: eoatx
-  # Throughput of spamoor
-  # Defaults to 1000
-  throughput: 1000
-  # Max pending transactions for spamoor
-  # Defaults to 1000
-  max_pending: 1000
-  # Max wallets for spamoor
-  # Defaults to 500
-  max_wallets: 500
-  # Extra parameters to send to spamoor
-  # Defaults to empty
-  spamoor_extra_args: []
-
-# Configuration place for spammor as blob spammer
-spamoor_blob_params:
-  # spamoor docker image to use
-  # Defaults to the latest
-  image: "ethpandaops/spamoor:latest"
-  # The spamoor blob scenario to use (see https://github.com/ethpandaops/spamoor)
-  # Valid blob scenarios are:
-  # - blobs (normal blob transactions only)
-  # - blob-combined (normal & special blobs with replacements)
-  # - blob-conflicting (conflicting blob & dynfee transactions)
-  # - blob-replacements (normal blobs with replacement blob transactions)
-  # Defaults to blob-combined
-  scenario: blob-combined
-  # Throughput of spamoor
-  # Defaults to 3
-  throughput: 3
-  # Maximum number of blobs per transaction
-  # Defaults to 2
-  sidecars: 2
-  # Max pending blob transactions for spamoor
-  # Defaults to 6
-  max_pending: 6
-  # Max wallets for spamoor
-  # Defaults to 20
-  max_wallets: 20
+  # A list of spammers to launch on startup
+  # example:
+  # - scenario: eoatx  # The spamoor scenario to use (see https://github.com/ethpandaops/spamoor)
+  #   name: "Optional name for this example spammer"
+  #   config:
+  #     throughput: 10  # 10 tx per block
+  # - scenario: erctx
+  #   config:
+  #     throughput: 10  # 10 tx per block
+  spammers: []
   # A list of optional params that will be passed to the spamoor command for modifying its behaviour
-  spamoor_extra_args: []
+  extra_args: []
 
 # Ethereum genesis generator params
 ethereum_genesis_generator_params:
@@ -1235,7 +1201,6 @@ Here's a table of where the keys are used
 | 0             | Builder             | ✅                |                 | As coinbase                |
 | 0             | mev_custom_flood    |                   | ✅              | As the receiver of balance |
 | 3             | transaction_spammer | ✅                |                 | To spam transactions with  |
-| 4             | spamoor_blob        | ✅                |                 | As the sender of blobs     |
 | 6             | mev_flood           | ✅                |                 | As the contract owner      |
 | 7             | mev_flood           | ✅                |                 | As the user_key            |
 | 8             | assertoor           | ✅                | ✅              | As the funding for tests   |
diff --git a/main.star b/main.star
@@ -12,7 +12,6 @@ validator_ranges = import_module(
 )
 
 tx_fuzz = import_module("./src/tx_fuzz/tx_fuzz.star")
-spamoor_blob = import_module("./src/spamoor_blob/spamoor_blob.star")
 forkmon = import_module("./src/forkmon/forkmon_launcher.star")
 
 dora = import_module("./src/dora/dora_launcher.star")
@@ -676,24 +675,18 @@ def run(plan, args={}):
             )
         elif additional_service == "spamoor":
             plan.print("Launching spamoor")
+            spamoor_config_template = read_file(
+                static_files.SPAMOOR_CONFIG_TEMPLATE_FILEPATH
+            )
             spamoor.launch_spamoor(
                 plan,
+                spamoor_config_template,
                 prefunded_accounts,
-                all_el_contexts,
+                all_participants,
+                args_with_right_defaults.participants,
                 args_with_right_defaults.spamoor_params,
                 global_node_selectors,
             )
-        elif additional_service == "spamoor_blob":
-            plan.print("Launching spamoor as blob spammer")
-            spamoor_blob.launch_spamoor_blob(
-                plan,
-                prefunded_accounts,
-                all_el_contexts,
-                args_with_right_defaults.spamoor_blob_params,
-                global_node_selectors,
-                args_with_right_defaults.network_params,
-                osaka_time,
-            )
         else:
             fail("Invalid additional service %s" % (additional_service))
     if launch_prometheus_grafana:
diff --git a/network_params.yaml b/network_params.yaml
@@ -106,8 +106,8 @@ dora_params:
   image: ""
 tx_fuzz_params:
   tx_fuzz_extra_args: []
-spamoor_blob_params:
-  spamoor_extra_args: []
+spamoor_params:
+  extra_args: []
 prometheus_params:
   storage_tsdb_retention_time: "1d"
   storage_tsdb_retention_size: "512MB"
diff --git a/src/package_io/constants.star b/src/package_io/constants.star
@@ -89,7 +89,6 @@ MEV_RS_MEV_TYPE = "mev-rs"
 COMMIT_BOOST_MEV_TYPE = "commit-boost"
 DEFAULT_DORA_IMAGE = "ethpandaops/dora:latest"
 DEFAULT_SPAMOOR_IMAGE = "ethpandaops/spamoor:latest"
-DEFAULT_SPAMOOR_BLOB_IMAGE = "ethpandaops/spamoor:latest"
 DEFAULT_ASSERTOOR_IMAGE = "ethpandaops/assertoor:latest"
 DEFAULT_SNOOPER_IMAGE = "ethpandaops/rpc-snooper:latest"
 DEFAULT_ETHEREUM_GENESIS_GENERATOR_IMAGE = (
@@ -305,8 +304,3 @@ VOLUME_SIZE["mainnet-shadowfork"] = VOLUME_SIZE["mainnet"]
 VOLUME_SIZE["sepolia-shadowfork"] = VOLUME_SIZE["sepolia"]
 VOLUME_SIZE["holesky-shadowfork"] = VOLUME_SIZE["holesky"]
 VOLUME_SIZE["hoodi-shadowfork"] = VOLUME_SIZE["hoodi"]
-
-SPAMOOR_BLOB_THROUGHPUT_MULTIPLIER = 2
-SPAMOOR_BLOB_DEFAULT_THROUGHPUT = 3
-SPAMOOR_BLOB_DEFAULT_SIDECARS = 2
-SPAMOOR_BLOB_DEFAULT_MAX_WALLETS = 29
diff --git a/src/package_io/input_parser.star b/src/package_io/input_parser.star
diff --git a/src/package_io/sanity_check.star b/src/package_io/sanity_check.star
diff --git a/src/spamoor/spamoor.star b/src/spamoor/spamoor.star
diff --git a/src/spamoor_blob/spamoor_blob.star b/src/spamoor_blob/spamoor_blob.star
diff --git a/src/static_files/static_files.star b/src/static_files/static_files.star
diff --git a/static_files/spamoor-config/startup-spammer.yaml.tmpl b/static_files/spamoor-config/startup-spammer.yaml.tmpl
