load star looks good

README.md

@@ -49,7 +49,7 @@ This is the Startosis version of the popular [eth2-merge-kurtosis-module](https:
     - [x] framework
   - [ ] loadstar
     - [ ] facts and waits
-    - [ ] framework
+    - [x] framework
   - [ ] nymbus
     - [ ] facts and waits
     - [ ] framework  

src/participant_network/cl/loadstar_launcher/loadstar_launcher.star

+load("github.com/kurtosis-tech/eth2-module/src/shared_utils/shared_utils.star", "new_port_spec", "path_join", "path_dir")
+load("github.com/kurtosis-tech/eth2-module/src/module_io/parse_input.star", "get_client_log_level_or_default")
+load("github.com/kurtosis-tech/eth2-module/src/cl/cl_client_context.star", "new_cl_client_context")
+load("github.com/kurtosis-tech/eth2-module/src/cl/cl_node_metrics_info.star", "new_cl_node_metrics_info")
+load("github.com/kurtosis-tech/eth2-module/src/mev_boost/mev_boost_context.star", "mev_boost_endpoint")
+
+module_io = import_types("github.com/kurtosis-tech/eth2-module/types.proto")
+
+CONSENSUS_DATA_DIRPATH_ON_SERVICE_CONTAINER      = "/consensus-data"
+GENESIS_DATA_MOUNT_DIRPATH_ON_SERVICE_CONTAINER   = "/genesis"
+VALIDATOR_KEYS_MOUNT_DIRPATH_ON_SERVICE_CONTAINER = "/validator-keys"
+
+# Port IDs
+TCP_DISCOVERY_PORT_ID     = "tcp-discovery"
+UDP_DISCOVERY_PORT_ID     = "udp-discovery"
+HTTP_PORT_ID             = "http"
+METRICS_PORT_ID          = "metrics"
+VALIDATOR_METRICS_PORT_ID = "validator-metrics"
+
+# Port nums
+DISCOVERY_PORT_NUM        = 9000
+HTTP_PORT_NUM                    = 4000
+METRICS_PORT_NUM           = 8008
+VALIDATOR_METRICS_PORT_NUM        = 5064
+
+# TODO Remove this if facts & waits doesn't need this
+MAX_NUM_HEALTHCHECK_RETRIES      = 30
+TIME_BETWEEN_HEALTHCHECK_RETRIES = 2 * time.second
+
+BEACON_SUFFIX_SERVICE_ID    = "beacon"
+VALIDATOR_SUFFIX_SERVICE_ID = "validator"
+
+METRICS_PATH = "/metrics"
+
+PRIVATE_IP_ADDRESS_PLACEHOLDER = "KURTOSIS_IP_ADDR_PLACEHOLDER"
+
+# TODO push this into shared_utils
+TCP_PROTOCOL = "TCP"
+UDP_PROTOCOL = "UDP"
+
+
+# TODO verify this - why do we pass the same used ports to both
+USED_PORTS = {
+	TCP_DISCOVERY_PORT_ID: new_port_spec(TCP_DISCOVERY_PORT_ID, TCP_PROTOCOL),
+	UDP_DISCOVERY_PORT_ID: new_port_spec(UDP_DISCOVERY_PORT_ID, UDP_PROTOCOL),
+	HTTP_PORT_ID:         new_port_spec(HTTP_PORT_ID, TCP_PROTOCOL),
+	METRICS_PORT_ID:      new_port_spec(METRICS_PORT_NUM, TCP_PROTOCOL),
+	VALIDATOR_METRICS_PORT_ID: new_port_spec(VALIDATOR_METRICS_PORT_NUM, TCP_PROTOCOL)
+}
+
+
+LOADSTAR_LOG_LEVELS = {
+	module_io.GlobalClientLogLevel.error: "error",
+	module_io.GlobalClientLogLeve.warn:  "warn",
+	module_io.GlobalClientLogLeve.info:  "info",
+	module_io.GlobalClientLogLevel.debug: "debug",
+	module_io.GlobalClientLogLevel.trace: "trace",
+}
+
+
+def launch(
+	launcher,
+	service_id,
+	image,
+	participant_log_level,
+	global_log_level,
+	bootnode_context,
+	el_client_context,
+	mev_boost_context,
+	node_keystore_files,
+	extra_beacon_params,
+	extra_validator_params):
+
+	beacon_node_service_id = "{0}-{1}".format(service_id, BEACON_SUFFIX_SERVICE_ID)
+	validator_node_service_id = "{0}-{1}".format(service_id, VALIDATOR_SUFFIX_SERVICE_ID)
+
+	log_level = get_client_log_level_or_default(participant_log_level, global_log_level, LOADSTAR_LOG_LEVELS)
+
+	# Launch Beacon node
+	beacon_service_config = get_beacon_service_config(
+		launcher.genesis_data,
+		image,
+		bootnode_context,
+		el_client_context,
+		mev_boost_context,
+		log_level,
+		extra_beacon_params,
+	)
+
+	beacon_service = add_service(beacon_node_service_id, beacon_service_config)
+
+	beacon_http_port = beacon_service.ports[BEACON_HTTP_PORT_ID]
+
+	# TODO add facts & waits
+
+	# Launch validator node
+	beacon_http_url = "http://{0}:{1}".format(beacon_service.ip_address, beacon_http_port.number)
+
+	validator_service_config = get_validator_service_config(
+		validator_node_service_id,
+		launcher.genesis_data,
+		image,
+		log_level,
+		beacon_http_url,
+		node_keystore_files,
+		mev_boost_context,
+		extra_validator_params,
+	)
+
+	validator_service = add_service(validator_node_service_id, validator_service_config)
+
+	# TODO add validator availability using the validator API: https://ethereum.github.io/beacon-APIs/?urls.primaryName=v1#/ValidatorRequiredApi | from eth2-merge-kurtosis-module
+
+	# TODO get node identity using facts and waits
+	beacon_node_enr = ""
+
+	beacon_metrics_port = beacon_service.ports[BEACON_METRICS_PORT_ID]
+	beacon_metrics_url = "{0}:{1}".format(beacon_service.ip_address, beacon_metrics_port.number)
+
+	# TODO verify if this is correct - from eth2-merge-kurtosis-module
+	# why do we pass the "service_id" that isn't used
+	beacon_node_metrics_info = new_cl_node_metrics_info(service_id, METRICS_PATH, beacon_metrics_url)
+	nodes_metrics_info = [beacon_node_metrics_info]
+
+	result = new_cl_client_context(
+		"loadstar",
+		beacon_node_enr,
+		beacon_service.ip_address,
+		HTTP_PORT_NUM,
+		nodes_metrics_info,
+	)
+
+	return result
+
+
+def get_beacon_service_config(
+	genesis_data,
+	image
+	boot_cl_client_ctx,
+	el_client_ctx,
+	mev_boost_context,
+	log_level
+	extra_params):
+
+	el_client_rpc_url_str = "http://{0}:{1}".format(
+		el_client_ctx.ip_address,
+		el_client_ctx.rpc_port_num,
+	)
+
+	el_client_engine_rpc_url_str = "http://{0}:{1}"(
+		el_client_ctx.ip_address,
+		el_client_ctx.engine_rpc_port_num,
+	)
+
+	genesis_config_filepath = path_join(GENESIS_DATA_MOUNT_DIRPATH_ON_SERVICE_CONTAINER, genesis_data.config_yml_rel_filepath)
+	genesis_ssz_filepath = path_join(GENESIS_DATA_MOUNT_DIRPATH_ON_SERVICE_CONTAINER, genesis_data.genesis_ssz_filepath)
+	jwt_secret_filepath = path_join(GENESIS_DATA_MOUNT_DIRPATH_ON_SERVICE_CONTAINER, genesis_data.jwt_secret_relative_filepath)
+	cmd_args = [
+		"beacon",
+		"--logLevel=" + logLevel,
+		"--port=%v".format(DISCOVERY_PORT_NUM),
+		"--discoveryPort={0}".format(DISCOVERY_PORT_NUM),
+		"--dataDir=" + CONSENSUS_DATA_DIRPATH_ON_SERVICE_CONTAINER,
+		"--paramsFile=" + genesis_config_filepath,
+		"--genesisStateFile=" + genesis_ssz_filepath,
+		"--eth1.depositContractDeployBlock=0",
+		"--network.connectToDiscv5Bootnodes=true",
+		"--discv5=true",
+		"--eth1=true",
+		"--eth1.providerUrls=" + el_client_rpc_url_str,
+		"--execution.urls=" + el_client_engine_rpc_url_str,
+		"--rest=true",
+		"--rest.address=0.0.0.0",
+		"--rest.namespace=*",
+		"--rest.port=%v".format(HTTP_PORT_NUM),
+		"--enr.ip=" + PRIVATE_IP_ADDRESS_PLACEHOLDER,
+		"--enr.tcp=%v".format(DISCOVERY_PORT_NUM),
+		"--enr.udp=%v".format(DISCOVERY_PORT_NUM),
+		# Set per Pari's recommendation to reduce noise in the logs
+		"--subscribeAllSubnets=true",
+		"--jwt-secret=%v".format(jwt_secret_filepath),
+		# vvvvvvvvvvvvvvvvvvv METRICS CONFIG vvvvvvvvvvvvvvvvvvvvv
+		"--metrics",
+		"--metrics.address=0.0.0.0",
+		"--metrics.port=%v".format(METRICS_PORT_NUM),
+		# ^^^^^^^^^^^^^^^^^^^ METRICS CONFIG ^^^^^^^^^^^^^^^^^^^^^
+	]
+
+	if boot_cl_client_ctx != None :
+		cmd_args.append("--bootnodes="+boot_cl_client_ctx.enr)
+	
+
+	if mev_boost_context != None:
+		cmd_args.append("--builder")
+		cmd_args.append(mev_boost_endpoint(mev_boost_context))
+	
+
+	if len(extraParams) > 0:
+		cmd_args.extend(extra_params)
+	
+	return struct(
+		container_image_name = image,
+		used_ports = USED_PORTS,
+		cmd_args = cmd_args,
+		files_artifact_mount_dirpaths = {
+			genesis_data.files_artifact_uuid: GENESIS_DATA_MOUNT_DIRPATH_ON_SERVICE_CONTAINER
+		},
+		env_vars = {
+			RUST_BACKTRACE_ENVVAR_NAME: RUST_FULL_BACKTRACE_KEYWORD
+		},
+		privaite_ip_address_placeholder = PRIVATE_IP_ADDRESS_PLACEHOLDER
+	)
+
+
+def get_validator_service_config(
+	service_id,
+	genesis_data,
+	image,
+	log_level,
+	beacon_client_http_url,
+	node_keystore_files,
+	mev_boost_context,
+	extra_params):
+
+	root_dirpath = path_join(CONSENSUS_DATA_DIRPATH_ON_SERVICE_CONTAINER, service_id)
+
+	genesis_config_filepath = path_join(GENESIS_DATA_MOUNT_DIRPATH_ON_SERVICE_CONTAINER, genesis_data.config_yml_rel_filepath)
+	validator_keys_dirpath = path_join(VALIDATOR_KEYS_MOUNT_DIRPATH_ON_SERVICE_CONTAINER, node_keystore_files.raw_keys_relative_dirpath)
+	validator_secrets_dirpath = path_join(VALIDATOR_KEYS_MOUNT_DIRPATH_ON_SERVICE_CONTAINER, node_keystore_files.raw_secrets_relative_dirpath)
+
+	cmd_args = [
+		"validator",
+		"--logLevel=" + logLevel,
+		"--dataDir=" + root_dirpath,
+		"--paramsFile=" + genesis_config_filepath,
+		"--server=" + beacon_http_url,
+		"--keystoresDir=" + validator_keys_dirpath,
+		"--secretsDir=" + validator_secrets_dirpath,
+		# vvvvvvvvvvvvvvvvvvv PROMETHEUS CONFIG vvvvvvvvvvvvvvvvvvvvv
+		"--metrics",
+		"--metrics.address=0.0.0.0",
+		"--metrics.port={0}".format(VALIDATOR_METRICS_PORT_NUM),
+		# ^^^^^^^^^^^^^^^^^^^ PROMETHEUS CONFIG ^^^^^^^^^^^^^^^^^^^^^
+	]
+
+	if mevBoostContext != None:
+		cmd_args.append("--builder")
+		# TODO required to work? - from old module
+		# cmdArgs = append(cmdArgs, "--defaultFeeRecipient <your ethereum address>")
+	
+	if len(cmd_args) > 0:
+		cmd_args.extend(extraParams)
+
+	return struct(
+		container_image_name = image,
+		used_ports = USED_PORTS,
+		cmd_args = cmd_args,
+		files_artifact_mount_dirpaths = {
+			genesis_data.files_artifact_uuid: GENESIS_DATA_MOUNT_DIRPATH_ON_SERVICE_CONTAINER
+			node_keystore_files.files_artifact_uuid: VALIDATOR_KEYS_MOUNT_DIRPATH_ON_SERVICE_CONTAINER
+		},
+		env_vars = {
+			RUST_BACKTRACE_ENVVAR_NAME: RUST_FULL_BACKTRACE_KEYWORD
+		},
+		privaite_ip_address_placeholder = PRIVATE_IP_ADDRESS_PLACEHOLDER
+	)
+
+
+def new_loadstar_launcher(cl_genesi_data):
+	return struct(
+		cl_genesi_data = cl_genesi_data,
+	)
\ No newline at end of file