feat: support legacy zkevm-node and new zkevm sequence senders and aggregators

.github/workflows/deploy.yml

@@ -30,6 +30,9 @@ jobs:
       # Additionally, deploy cdk-erigon and zkevm-node as permissionless nodes or RPCs.
       - name: Deploy L1 chain and a first CDK L2 chain (erigon)
         run: |
+          yq -Y --in-place '.deploy_cdk_erigon_node = true' params.yml
+          yq -Y --in-place '.args.sequencer_type = "erigon"' params.yml
+          yq -Y --in-place '.args.aggregator_sequence_sender_type = "cdk"' params.yml
           yq -Y --in-place '.args.additional_services = ["pless_zkevm_node", "tx_spammer"]' params.yml
           kurtosis run --enclave=${{ env.ENCLAVE_NAME }} --show-enclave-inspect=false --args-file=params.yml .
 
@@ -105,6 +108,7 @@ jobs:
         run: |
           yq -Y --in-place '.deploy_cdk_erigon_node = false' params.yml
           yq -Y --in-place '.args.sequencer_type = "zkevm"' params.yml
+          yq -Y --in-place '.args.aggregator_sequence_sender_type = "zkevm"' params.yml
           yq -Y --in-place '.args.additional_services = ["pless_zkevm_node", "tx_spammer"]' params.yml
           kurtosis run --enclave=${{ env.ENCLAVE_NAME }} --show-enclave-inspect=false --args-file=params.yml .
 

agglayer-attach-cdk-params.yml

@@ -35,6 +35,12 @@ args:
   # - 'zkevm': Use the legacy sequencer (https://github.com/0xPolygonHermez/zkevm-node).
   sequencer_type: erigon
 
+  # The type of aggregator and sequence sender to deploy.
+  # Options:
+  # - 'cdk': Use the new cdk-node (https://github.com/0xPolygon/cdk).
+  # - 'zkevm': Use the legacy aggregator and sequence sender (https://github.com/0xPolygonHermez/zkevm-node).
+  aggregator_sequence_sender_type: cdk
+
   # Deploy agglayer.
   deploy_agglayer: false
 

cdk_central_environment.star

@@ -1,3 +1,4 @@
+constants = import_module("./src/package_io/constants.star")
 data_availability_package = import_module("./lib/data_availability.star")
 service_package = import_module("./lib/service.star")
 zkevm_dac_package = import_module("./lib/zkevm_dac.star")
@@ -41,15 +42,19 @@ def run(plan, args):
         )
 
     keystore_artifacts = get_keystores_artifacts(plan, args)
-    if args["sequencer_type"] == "zkevm":
-        # Create the zkevm node config.
-        node_config_template = read_file(
+
+    # Create the zkevm-node configuration if needed.
+    if (args["sequencer_type"] == "zkevm") or (
+        args["aggregator_sequence_sender_type"]
+        == constants.AGGREGATOR_SEQUENCE_SENDER_TYPE.zkevm
+    ):
+        zkevm_node_config_template = read_file(
             src="./templates/trusted-node/node-config.toml"
         )
-        node_config_artifact = plan.render_templates(
+        zkevm_node_config_artifact = plan.render_templates(
             config={
                 "node-config.toml": struct(
-                    template=node_config_template,
+                    template=zkevm_node_config_template,
                     data=args
                     | {
                         "is_cdk_validium": data_availability_package.is_cdk_validium(
@@ -62,15 +67,16 @@ def run(plan, args):
             name="trusted-node-config",
         )
 
+    if args["sequencer_type"] == "zkevm":
         # Start the synchronizer.
         zkevm_node_package.start_synchronizer(
-            plan, args, node_config_artifact, genesis_artifact
+            plan, args, zkevm_node_config_artifact, genesis_artifact
         )
 
         # Start the rest of the zkevm node components.
         zkevm_node_components_configs = (
             zkevm_node_package.create_zkevm_node_components_config(
-                args, node_config_artifact, genesis_artifact, keystore_artifacts
+                args, zkevm_node_config_artifact, genesis_artifact, keystore_artifacts
             )
         )
 
@@ -79,19 +85,23 @@ def run(plan, args):
             description="Starting the rest of the zkevm node components",
         )
 
-    if args["sequencer_type"] == "erigon":
+    # Deploy aggregator and sequence sender.
+    if (
+        args["aggregator_sequence_sender_type"]
+        == constants.AGGREGATOR_SEQUENCE_SENDER_TYPE.cdk
+    ):
         # Create the cdk node config.
-        node_config_template = read_file(
+        cdk_node_config_template = read_file(
             src="./templates/trusted-node/cdk-node-config.toml"
         )
         contract_setup_addresses = service_package.get_contract_setup_addresses(
             plan, args
         )
-        node_config_artifact = plan.render_templates(
+        cdk_node_config_artifact = plan.render_templates(
             name="cdk-node-config-artifact",
             config={
                 "cdk-node-config.toml": struct(
-                    template=node_config_template,
+                    template=cdk_node_config_template,
                     data=args
                     | {
                         "is_cdk_validium": data_availability_package.is_cdk_validium(
@@ -106,12 +116,39 @@ def run(plan, args):
 
         # Start the cdk components.
         cdk_node_configs = cdk_node_package.create_cdk_node_service_config(
-            args, node_config_artifact, genesis_artifact, keystore_artifacts
+            args, cdk_node_config_artifact, genesis_artifact, keystore_artifacts
         )
 
         plan.add_services(
             configs=cdk_node_configs,
-            description="Starting the cdk node components",
+            description="Starting the cdk-node components",
+        )
+    elif (
+        args["aggregator_sequence_sender_type"]
+        == constants.AGGREGATOR_SEQUENCE_SENDER_TYPE.zkevm
+    ):
+        zkevm_aggregator_service_config = (
+            zkevm_node_package.create_aggregator_service_config(
+                args,
+                zkevm_node_config_artifact,
+                genesis_artifact,
+                keystore_artifacts.sequencer,
+                keystore_artifacts.aggregator,
+                keystore_artifacts.proofsigner,
+            )
+        )
+        zkevm_sequence_sender_service_config = (
+            zkevm_node_package.create_sequence_sender_service_config(
+                args,
+                zkevm_node_config_artifact,
+                genesis_artifact,
+                keystore_artifacts.sequencer,
+            )
+        )
+        plan.add_services(
+            configs=zkevm_aggregator_service_config
+            | zkevm_sequence_sender_service_config,
+            description="Starting zkevm aggregator and sequence sender",
         )
 
     # Start the DAC if in validium mode.

cdk_erigon.star

@@ -23,15 +23,15 @@ def run_rpc(plan, args):
             plan, args, stateless_executor_config_artifact
         )
 
-    zkevm_sequencer_service = plan.get_service(
+    sequencer_service = plan.get_service(
         name=args["sequencer_name"] + args["deployment_suffix"]
     )
-    zkevm_sequence_url = "http://{}:{}".format(
-        zkevm_sequencer_service.ip_address, zkevm_sequencer_service.ports["rpc"].number
+    sequencer_url = "http://{}:{}".format(
+        sequencer_service.ip_address, sequencer_service.ports["rpc"].number
     )
-    zkevm_datastreamer_url = "{}:{}".format(
-        zkevm_sequencer_service.ip_address,
-        zkevm_sequencer_service.ports["data-streamer"].number,
+    datastreamer_url = "{}:{}".format(
+        sequencer_service.ip_address,
+        sequencer_service.ports["data-streamer"].number,
     )
 
     cdk_erigon_node_config_template = read_file(src="./templates/cdk-erigon/config.yml")
@@ -42,8 +42,8 @@ def run_rpc(plan, args):
             "config.yaml": struct(
                 template=cdk_erigon_node_config_template,
                 data={
-                    "zkevm_sequencer_url": zkevm_sequence_url,
-                    "zkevm_datastreamer_url": zkevm_datastreamer_url,
+                    "sequencer_url": sequencer_url,
+                    "datastreamer_url": datastreamer_url,
                     "is_sequencer": False,
                 }
                 | args

input_parser.star

@@ -4,6 +4,7 @@ DEFAULT_ARGS = {
     "deployment_suffix": "-001",
     "global_log_level": "info",
     "sequencer_type": "erigon",
+    "aggregator_sequence_sender_type": "cdk",
     "deploy_agglayer": True,
     "data_availability_mode": "cdk-validium",
     "additional_services": [],
@@ -77,6 +78,7 @@ DEFAULT_ARGS = {
 
 def parse_args(args):
     validate_global_log_level(args["global_log_level"])
+    validate_aggregator_sequence_sender_type(args["aggregator_sequence_sender_type"])
     return DEFAULT_ARGS | args
 
 
@@ -98,3 +100,17 @@ def validate_global_log_level(global_log_level):
                 constants.GLOBAL_LOG_LEVEL.trace,
             )
         )
+
+
+def validate_aggregator_sequence_sender_type(aggregator_sequence_sender_type):
+    if aggregator_sequence_sender_type not in (
+        constants.AGGREGATOR_SEQUENCE_SENDER_TYPE.cdk,
+        constants.AGGREGATOR_SEQUENCE_SENDER_TYPE.zkevm,
+    ):
+        fail(
+            "Unsupported aggregator and sequence sender type: '{}', please use '{}' or '{}'".format(
+                aggregator_sequence_sender_type,
+                constants.AGGREGATOR_SEQUENCE_SENDER_TYPE.cdk,
+                constants.AGGREGATOR_SEQUENCE_SENDER_TYPE.zkevm,
+            )
+        )

kurtosis.yml

@@ -34,6 +34,12 @@ description: |-
 
   sequencer_type: erigon
 
+  # The type of aggregator and sequence sender to deploy.
+  # Options:
+  # - 'cdk': Use the new cdk-node (https://github.com/0xPolygon/cdk).
+  # - 'zkevm': Use the legacy aggregator and sequence sender (https://github.com/0xPolygonHermez/zkevm-node).
+  aggregator_sequence_sender_type: cdk
+
   deploy_agglayer: true
 
   # The type of data availability to use.

lib/zkevm_node.star

@@ -203,14 +203,6 @@ def create_zkevm_node_components_config(
     genesis_artifact,
     keystore_artifacts,
 ):
-    aggregator_config = create_aggregator_service_config(
-        args,
-        config_artifact,
-        genesis_artifact,
-        keystore_artifacts.sequencer,
-        keystore_artifacts.aggregator,
-        keystore_artifacts.proofsigner,
-    )
     rpc_config = create_rpc_service_config(args, config_artifact, genesis_artifact)
     eth_tx_manager_config = create_eth_tx_manager_service_config(
         args,
@@ -222,22 +214,12 @@ def create_zkevm_node_components_config(
     l2_gas_pricer_config = create_l2_gas_pricer_service_config(
         args, config_artifact, genesis_artifact
     )
-    configs = (
-        aggregator_config | rpc_config | eth_tx_manager_config | l2_gas_pricer_config
-    )
+    configs = rpc_config | eth_tx_manager_config | l2_gas_pricer_config
 
     if args["sequencer_type"] == "zkevm":
         sequencer_config = create_sequencer_service_config(
             args, config_artifact, genesis_artifact
         )
-
-        sequence_sender_config = create_sequence_sender_service_config(
-            args,
-            config_artifact,
-            genesis_artifact,
-            keystore_artifacts.sequencer,
-        )
-
-        return configs | sequencer_config | sequence_sender_config
+        return configs | sequencer_config
     else:
         return configs

params.yml

@@ -35,6 +35,12 @@ args:
   # - 'zkevm': Use the legacy sequencer (https://github.com/0xPolygonHermez/zkevm-node).
   sequencer_type: erigon
 
+  # The type of aggregator and sequence sender to deploy.
+  # Options:
+  # - 'cdk': Use the new cdk-node (https://github.com/0xPolygon/cdk).
+  # - 'zkevm': Use the legacy aggregator and sequence sender (https://github.com/0xPolygonHermez/zkevm-node).
+  aggregator_sequence_sender_type: cdk
+
   # Deploy agglayer.
   deploy_agglayer: true
 

src/package_io/constants.star

@@ -5,3 +5,8 @@ GLOBAL_LOG_LEVEL = struct(
     debug="debug",
     trace="trace",
 )
+
+AGGREGATOR_SEQUENCE_SENDER_TYPE = struct(
+    cdk="cdk",
+    zkevm="zkevm",
+)

templates/cdk-erigon/config.yml

@@ -62,6 +62,6 @@ zkevm.data-stream-host: "0.0.0.0"
 zkevm.data-stream-port: {{.zkevm_data_stream_port}}
 # rpc node {{else}}
 txpool.disable: true
-zkevm.l2-sequencer-rpc-url: {{.zkevm_sequencer_url}}
-zkevm.l2-datastreamer-url: {{.zkevm_datastreamer_url}}
+zkevm.l2-sequencer-rpc-url: {{.sequencer_url}}
+zkevm.l2-datastreamer-url: {{.datastreamer_url}}
 # end {{end}}