This is a [Kurtosis Starlark Package][starlark-docs] that will:
...
...
@@ -11,8 +10,7 @@ This is a [Kurtosis Starlark Package][starlark-docs] that will:
For much more detailed information about how the merge works in Ethereum testnets, see [this document](https://notes.ethereum.org/@ExXcnR0-SJGthjz1dwkA1A/H1MSKgm3F).
Quickstart
----------
## Quickstart
1.[Install Docker if you haven't done so already][docker-installation]
1.[Install the Kurtosis CLI, or upgrade it to the latest version if it's already installed][kurtosis-cli-installation]
...
...
@@ -24,9 +22,9 @@ Quickstart
```bash
kurtosis run --enclave eth2 github.com/kurtosis-tech/eth2-package
```
To remove the enclave running the Ethereum network, run `kurtosis enclave rm -f eth2`.
You can customize the package's behaviour by passing in a configuration JSON or YAML (see the "Configuration" section below). For example:
```bash
...
...
@@ -46,13 +44,11 @@ For extra convenience, you can store the parameters in a file:
kurtosis run --enclave eth2 github.com/kurtosis-tech/eth2-package "$(cat ~/eth2-package-params.json)"
```
Management
----------
## Management
Kurtosis will create a new enclave to house the services of the Ethereum network. [This page][using-the-cli] contains documentation for managing the created enclave & viewing detailed information about it.
Configuration
-------------
## Configuration
To configure the package behaviour, you can modify your `eth2-package-params.yaml` file. The full YAML schema that can be passed in is as follows with the defaults provided:
...
...
@@ -60,6 +56,7 @@ To configure the package behaviour, you can modify your `eth2-package-params.yam
<summary>Click to show all configuration options</summary>
<!-- Yes, it's weird that none of this is indented but it's intentional - indenting anything inside this "details" expandable will cause it to render weird" -->
```json
{
//Specificationoftheparticipantsinthenetwork
...
...
@@ -74,7 +71,7 @@ To configure the package behaviour, you can modify your `eth2-package-params.yam
@@ -151,7 +148,7 @@ To configure the package behaviour, you can modify your `eth2-package-params.yam
"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"
1. Rebuild and re-run the package by running the following from the root of the repo:
```bash
...
...
@@ -205,20 +204,22 @@ Then, run the dev loop:
To get detailed information about the structure of the package, visit [the architecture docs](./docs/architecture.md).
When you're happy with your changes:
- Add an entry to `docs/changelog.md` under the `# TBD` header describing your changes (this is required for CI checks to pass!)
- Create a PR
- Add one of the maintainers of the repo as a "Review Request":
-`parithosh` (Ethereum)
-`gbouv` (Kurtosis)
-`h4ck3rk3y` (Kurtosis)
-`mieubrisse` (Kurtosis)
- Once everything works, merge!
-`parithosh` (Ethereum)
-`gbouv` (Kurtosis)
-`h4ck3rk3y` (Kurtosis)
-`mieubrisse` (Kurtosis)
- Once everything works, merge!
## Known Bugs
`wait_for_epoch_finalization` - doesn't work as expected, as Starlark doesn't have ways to do assertions on facts just yet. The [issue](https://github.com/kurtosis-tech/eth2-package/issues/15) tracks this.
<!------------------------ Only links below here -------------------------------->
This repo is a Kurtosis package. To get general information on what a Kurtosis package is and how it works, visit [the Starlark documentation](https://docs.kurtosis.com/starlark-reference).
The overview of this particular package'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. Generate consensus layer (CL) client config data
1. Launch CL clients
1. Generate execution layer (EL) client config data
1. Launch EL clients
1. Generate consensus layer (CL) client config data
The package has six main components, in accordance with the above operation:
1.[Main Function][main-function]
...
...
@@ -25,12 +25,12 @@ The package has six main components, in accordance with the above operation:
1.[Auxiliary Services][auxiliary-services]
1.[Merge Verification Logic][testnet-verifier]
[Main][main-function]
------------------------------------
## [Main][main-function]
The main function is the package's entrypoint, where parameters are received from the user, lower-level calls are made, and a response is returned.
[Package I/O][package-io]
-----------------------
## [Package I/O][package-io]
This particular package 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 package'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 `package_io` directory, so you'll want to visit this directory if you want to:
- View or change parameters that the package can receive
...
...
@@ -38,12 +38,12 @@ This particular package has many configuration options (see the "Configuration"
- View or change the validation logic that the package applies to configuration parameters
- View or change the properties that the package passes back to the user after execution is complete
[Static Files][static-files]
----------------------------
## [Static Files][static-files]
Kurtosis packages can have static files that are made available inside the container during the package's operation. For this package, [the static files included][static-files] are various key files and config templates which get used during participant network operation.
[Participant Network][participant-network]
------------------------------------------
## [Participant Network][participant-network]
The participant network is the beating heart at the center of the package. The participant network code is responsible for:
1. Generating EL client config data
...
...
@@ -54,19 +54,23 @@ The participant network is the beating heart at the center of the package. The p
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-package/blob/main/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-package/tree/main/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-package/blob/main/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-package/tree/main/src/participant_network/el/geth), [Besu](https://github.com/kurtosis-tech/eth2-package/tree/main/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.
### 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-package/blob/main/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-package/tree/main/src/participant_network/cl). Just as with EL clients:
- CL client launchers implement come with a `launch` method
...
...
@@ -75,8 +79,8 @@ Once CL genesis data and keys have been created, the CL client nodes are started
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
------------------
## Auxiliary Services
After the Ethereum network is up and running, this package 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-package/tree/main/src/forkmon), a "fork monitor" web UI for visualizing the CL clients' forks
...
...
@@ -84,19 +88,17 @@ After the Ethereum network is up and running, this package starts several auxili
-[Grafana](https://github.com/kurtosis-tech/eth2-package/tree/main/src/grafana) for visualizing client node metrics
-[An ETH transaction spammer](https://github.com/kurtosis-tech/eth2-package/tree/main/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]
------------------------------------
## [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 package to exit with an error. This merge verification can be disabled in the package's configuration (see the "Configuration" section in the README).
<!------------------------ Only links below here -------------------------------->
"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",
