Merge pull request #18 from kurtosis-tech/gyani/docs

update readme to reflect latest

docs/architecture.md

+Module Architecture
+===================
+This repo is a Kurtosis module. To get general information on what a Kurtosis module is and how it works, visit [the Starlark documentation](https://docs.kurtosis.com/reference/starlark-introduction).
+
+The overview of this particular module's operation is as follows:
+
+1. Parse user parameters
+1. Launch a network of Ethereum participants
+    1. Generate execution layer (EL) client config data
+    1. Launch EL clients
+    1. Wait for EL clients to start mining, such that all EL clients have a nonzero block number
+    1. Generate consensus layer (CL) client config data
+    1. Launch CL clients
+1. Launch auxiliary services (Grafana, Forkmon, etc.)
+1. Run Ethereum Merge verification logic
+1. Return information to the user
+
+Overview
+--------
+The module has six main components, in accordance with the above operation:
+
+1. [Main Function][main-function]
+1. [Module I/O][module-io]
+1. [Static Files][static-files]
+1. [Participant Network][participant-network]
+1. [Auxiliary Services][auxiliary-services]
+1. [Merge Verification Logic][testnet-verifier]
+
+[Main][main-function]
+------------------------------------
+The main function is the module's entrypoint, where parameters are received from the user, lower-level calls are made, and a response is returned.
+
+[Module I/O][module-io]
+-----------------------
+This particular module has many configuration options (see the "Configuration" section in the README for the full list of values). These are passed in as a JSON-serialized string, and arrive to the module's main function via the `input_args` variable. The process of setting defaults, overriding them with the user's desired options, and validating the resulting config object requires some space in the codebase. All this logic happens inside the `module_io` directory, so you'll want to visit this directory if you want to:
+
+- View or change parameters that the module can receive
+- Change the default values of module parameters
+- View or change the validation logic that the module applies to configuration parameters
+- View or change the properties that the module passes back to the user after execution is complete
+
+[Static Files][static-files]
+----------------------------
+Kurtosis modules can have static files that are made available inside the container during the module's operation. For this module, [the static files included][static-files] are various key files and config templates which get used during participant network operation.
+
+[Participant Network][participant-network]
+------------------------------------------
+The participant network is the beating heart at the center of the module. The participant network code is responsible for:
+
+1. Generating EL client config data
+1. Starting the EL clients
+1. Waiting until the EL clients have started mining
+1. Generating CL client config data
+1. Starting the CL clients
+
+We'll explain these phases one by one.
+
+### Generating EL client data
+All EL clients require both a genesis file and a JWT secret. The exact format of the genesis file differs per client, so we first leverage [a Docker image containing tools for generating this genesis data][ethereum-genesis-generator] to create the actual files that the EL clients-to-be will need. This is accomplished by filling in several genesis generation config files found in [the `static_files` directory][static-files].
+
+The generated output files then get stored in the Kurtosis enclave, ready for use when we start the EL clients. The information about these stored files is tracked in [the `el_genesis_data` struct](https://github.com/kurtosis-tech/eth2-module/blob/master/src/participant_network/prelaunch_data_generator/el_genesis/el_genesis_data.star).
+
+### Starting EL clients
+Next, we plug the generated genesis data [into EL client "launchers"](https://github.com/kurtosis-tech/eth2-module/tree/master/src/participant_network/el) to start a mining network of EL nodes. The launchers come with a `launch` function that consumes EL genesis data and produces information about the running EL client node. Running EL node information is represented by [an `el_client_context` struct](https://github.com/kurtosis-tech/eth2-module/blob/master/src/participant_network/el/el_client_context.star). Each EL client type has its own launcher (e.g. [Geth](https://github.com/kurtosis-tech/eth2-module/tree/master/src/participant_network/el/geth), [Besu](https://github.com/kurtosis-tech/eth2-module/tree/master/src/participant_network/el/besu)) because each EL client will require different environment variables and flags to be set when launching the client's container.
+
+### Waiting until EL clients have started mining
+Once we have a network of EL nodes started, we block until all EL clients have a block number > 0 to ensure that they are in fact working. After the nodes have started mining, we're ready to move on to adding the CL client network.
+
+### Generating CL client data
+CL clients, like EL clients, also have genesis and config files that they need. We use [the same Docker image with tools for generating genesis data][ethereum-genesis-generator] to create the necessary CL files, we provide the genesis generation config using templates in [the `static_files` directory][static-files], and we store the generated output files in the Kurtosis enclave in the same way as the EL client genesis files. Like with EL nodes, CL genesis data information is tracked in [the `cl_client_context` struct](https://github.com/kurtosis-tech/eth2-module/blob/master/src/participant_network/el/el_client_context.star).
+
+The major difference with CL clients is that CL clients have validator keys, so we need to generate keys for the CL clients to use during validation. The generation happens using [the same genesis-generating Docker image][ethereum-genesis-generator], but via a call to [a different tool bundled inside the Docker image](https://github.com/protolambda/eth2-val-tools).
+
+### Starting CL clients
+Once CL genesis data and keys have been created, the CL client nodes are started via [the CL client launchers](https://github.com/kurtosis-tech/eth2-module/tree/master/src/participant_network/cl). Just as with EL clients:
+
+- CL client launchers implement come with a `launch` method
+- One CL client launcher exists per client type (e.g. [Nimbus](https://github.com/kurtosis-tech/eth2-module/tree/master/src/participant_network/cl/nimbus), [Lighthouse](https://github.com/kurtosis-tech/eth2-module/tree/master/src/participant_network/cl/lighthouse))
+- Launched CL node information is tracked in [a `cl_client_context` struct](https://github.com/kurtosis-tech/eth2-module/blob/master/src/participant_network/cl/cl_client_context.star)
+
+There are only two major difference between CL client and EL client launchers. First, the `cl_client_launcher.launch` method also consumes an `el_client_context`, because each CL client is connected in a 1:1 relationship with an EL client. Second, because CL clients have keys, the keystore files are passed in to the `launch` function as well.
+
+Auxiliary Services
+------------------
+After the Ethereum network is up and running, this module starts several auxiliary containers to make it easier to work with the Ethereum network. At time of writing, these are:
+
+- [Forkmon](https://github.com/kurtosis-tech/eth2-module/tree/master/src/forkmon), a "fork monitor" web UI for visualizing the CL clients' forks
+- [Prometheus](https://github.com/kurtosis-tech/eth2-module/tree/master/src/prometheus) for collecting client node metrics
+- [Grafana](https://github.com/kurtosis-tech/eth2-module/tree/master/src/grafana) for visualizing client node metrics
+- [An ETH transaction spammer](https://github.com/kurtosis-tech/eth2-module/tree/master/src/transaction_spammer), which [has been forked off](https://github.com/kurtosis-tech/tx-fuzz) of [Marius' transaction spammer code](https://github.com/MariusVanDerWijden/tx-fuzz) so that it can run as a container
+
+[Testnet Verifier][testnet-verifier]
+------------------------------------
+Once the Ethereum network is up and running, verification logic will be run to ensure that the Merge has happened successfully. This happens via [a testnet-verifying Docker image](https://github.com/ethereum/merge-testnet-verifier) that periodically polls the network to check the state of the merge. If the merge doesn't occur, the testnet-verifying image returns an unsuccessful exit code which in turn signals the Kurtosis module to exit with an error. This merge verification can be disabled in the module's configuration (see the "Configuration" section in the README).
+
+<!------------------------ Only links below here -------------------------------->
+
+[module-docs]: https://docs.kurtosistech.com/modules.html
+[enclave-context]: https://docs.kurtosistech.com/kurtosis/core-lib-documentation#enclavecontext
+
+[main-function]: https://github.com/kurtosis-tech/eth2-module/blob/master/main.star#22
+[module-io]: https://github.com/kurtosis-tech/eth2-module/tree/master/src/module_io
+[participant-network]: https://github.com/kurtosis-tech/eth2-module/tree/master/src/participant_network
+[ethereum-genesis-generator]: https://github.com/skylenet/ethereum-genesis-generator
+[static-files]: https://github.com/kurtosis-tech/eth2-module/tree/master/static_files
+[testnet-verifier]: https://github.com/kurtosis-tech/eth2-module/tree/master/src/testnet_verifier
+
+[auxiliary-services]: #auxiliary-services
\ No newline at end of file

docs/changelog.md

 # TBD
 
+### Features
+- Added the docs
+
+### Fixes
+- Renamed `num_validators_per_keynode` to `num_validator_keys_per_node`
+
 # 0.0.1
 
 ### Features

src/module_io/parse_input.star

@@ -104,7 +104,7 @@ def parse_input(input_args):
 		fail("seconds_per_slot is 0 needs to be > 0 ")
 
 	required_num_validtors = 2 * result["network_params"]["slots_per_epoch"]
-	actual_num_validators = len(result["participants"]) * result["network_params"]["num_validators_per_keynode"]
+	actual_num_validators = len(result["participants"]) * result["network_params"]["num_validator_keys_per_node"]
 	if required_num_validtors > actual_num_validators:
 		fail("required_num_validtors - {0} is greater than actual_num_validators - {1}".format(required_num_validtors, actual_num_validators))
 
@@ -149,7 +149,7 @@ def default_network_params():
 	# this is temporary till we get params working
 	return {
 		"preregistered_validator_keys_mnemonic" :  "giant issue aisle success illegal bike spike question tent bar rely arctic volcano long crawl hungry vocal artwork sniff fantasy very lucky have athlete",
-		"num_validators_per_keynode" : 64,
+		"num_validator_keys_per_node" : 64,
 		"network_id" : "3151908",
 		"deposit_contract_address" : "0x4242424242424242424242424242424242424242",
 		"seconds_per_slot" : 12,

src/participant_network/participant_network.star

@@ -54,7 +54,7 @@ def launch_participant_network(participants, network_params, global_log_level):
 	cl_validator_data = generate_cl_validator_keystores(
 		network_params.preregistered_validator_keys_mnemonic,
 		num_participants,
-		network_params.num_validators_per_keynode
+		network_params.num_validator_keys_per_node,
 	)
 
 	
@@ -118,7 +118,7 @@ def launch_participant_network(participants, network_params, global_log_level):
 
 	genesis_generation_config_yml_template = read_file(CL_GENESIS_GENERATION_CONFIG_TEMPLATE_FILEPATH)
 	genesis_generation_mnemonics_yml_template = read_file(CL_GENESIS_GENERATION_MNEMONICS_TEMPLATE_FILEPATH)
-	total_number_of_validator_keys = network_params.num_validators_per_keynode * num_participants
+	total_number_of_validator_keys = network_params.num_validator_keys_per_node * num_participants
 	cl_genesis_data = generate_cl_genesis_data(
 		genesis_generation_config_yml_template,
 		genesis_generation_mnemonics_yml_template,

types.proto

@@ -110,7 +110,7 @@ message NetworkParams {
 	// Number of slots in an epoch on the Beacon chain
 	optional uint32 slots_per_epoch = 4;
 	// The number of validator keys that each CL validator node should get
-	optional uint32 num_validators_per_keynode = 5;
+	optional uint32 num_validator_keys_per_node = 5;
 	// This menmonic will a) be used to create keystores for all the types of validators that we have and b) be used to generate a CL genesis.ssz that has the children
 	//  validator keys already preregistered as validators	
 	optional string preregistered_validator_keys_mnemonic = 6;