Skip to content

Commit d980fee

Browse files
authored
feat!: migrate from kurtosis-tech to ethpandaops repository (ethpandaops#663)
1 parent caf393d commit d980fee

File tree

7 files changed

+26
-66
lines changed

7 files changed

+26
-66
lines changed

.github/workflows/conventional-pr-title-checker.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ jobs:
1717
title_check:
1818
runs-on: ubuntu-latest
1919
steps:
20-
- uses: aslafy-z/conventional-pr-title-action@v3
20+
- uses: amannn/action-semantic-pull-request@v5
2121
env:
2222
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 8 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,9 @@
11
# Important recent update notes - temporary note
2-
There are many participant fields that have been renamed to be more consistent with the rest of the package. The following fields have been renamed:
3-
### EL Flags
4-
```
5-
el_client_type -> el_type
6-
el_client_image -> el_image
7-
el_client_log_level -> el_log_level
8-
el_client_volume_size -> el_volume_size
9-
```
10-
### CL Flags
11-
```
12-
cl_client_type -> cl_type
13-
cl_client_image -> cl_image
14-
cl_client_volume_size -> cl_volume_size
15-
cl_client_log_level -> cl_log_level
16-
beacon_extra_params -> cl_extra_params
17-
beacon_extra_labels -> cl_extra_labels
18-
bn_min_cpu -> cl_min_cpu
19-
bn_max_cpu -> cl_max_cpu
20-
bn_min_mem -> cl_min_mem
21-
bn_max_mem -> cl_max_mem
22-
use_separate_validator_client -> use_separate_vc
23-
```
24-
### Validator flags
25-
```
26-
validator_client_type -> vc_type
27-
validator_tolerations -> vc_tolerations
28-
validator_client_image -> vc_image
29-
validator_extra_params -> vc_extra_params
30-
validator_extra_labels -> vc_extra_labels
31-
v_min_cpu -> vc_min_cpu
32-
v_max_cpu -> vc_max_cpu
33-
v_min_mem -> vc_min_mem
34-
v_max_mem -> vc_max_mem
35-
```
36-
### Global flags
37-
```
38-
global_client_log_level -> global_log_level
39-
mev_type: full -> mev_type: flashbots # new rename as of 3 May 2024
40-
```
2+
The `ethereum-package` has been moved to the [ethpandaops organization](https://github.com/ethpandaops/).
413

42-
To help you with the transition, we have added a script that will automatically update your `yaml` file to the new format. You can run the following command to update your network_params.yaml file:
43-
```bash
44-
./rename.sh example.yaml
45-
```
4+
The new repository is located at [github.com/ethpandaops/ethereum-package](https://github.com/ethpandaops/ethereum-package). For all your references please replace `kurtosis-tech` with `ethpandaops`.
465

6+
If you would like to use the latest release of the package, released by kurtosis-tech, please refer to using the tag [v3.1.0](https://github.com/kurtosis-tech/ethereum-package/releases/tag/3.1.0).
477

488
# Ethereum Package
499

@@ -74,22 +34,22 @@ Optional features (enabled via flags or parameter files at runtime):
7434

7535
## Quickstart
7636

77-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/new/?editor=code#https://github.com/kurtosis-tech/ethereum-package)
37+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/new/?editor=code#https://github.com/ethpandaops/ethereum-package)
7838

7939
1. [Install Docker & start the Docker Daemon if you haven't done so already][docker-installation]
8040
2. [Install the Kurtosis CLI, or upgrade it to the latest version if it's already installed][kurtosis-cli-installation]
8141
3. Run the package with default configurations from the command line:
8242

8343
```bash
84-
kurtosis run --enclave my-testnet github.com/kurtosis-tech/ethereum-package
44+
kurtosis run --enclave my-testnet github.com/ethpandaops/ethereum-package
8545
```
8646

8747
#### Run with your own configuration
8848

8949
Kurtosis packages are parameterizable, meaning you can customize your network and its behavior to suit your needs by storing parameters in a file that you can pass in at runtime like so:
9050

9151
```bash
92-
kurtosis run --enclave my-testnet github.com/kurtosis-tech/ethereum-package --args-file network_params.yaml
52+
kurtosis run --enclave my-testnet github.com/ethpandaops/ethereum-package --args-file network_params.yaml
9353
```
9454

9555
Where `network_params.yaml` contains the parameters for your network in your home directory.
@@ -978,7 +938,7 @@ Consensus Layer (CL) nodes - Validator:
978938
To spin up the network of Ethereum nodes with an external block building network (using Flashbot's `mev-boost` protocol), simply use:
979939

980940
```
981-
kurtosis run github.com/kurtosis-tech/ethereum-package '{"mev_type": "full"}'
941+
kurtosis run github.com/ethpandaops/ethereum-package '{"mev_type": "full"}'
982942
```
983943

984944
Starting your network up with `"mev_type": "full"` will instantiate and connect the following infrastructure to your network:
@@ -1008,7 +968,7 @@ For more details, including a guide and architecture of the `mev-boost` infrastr
1008968

1009969
## Pre-funded accounts at Genesis
1010970

1011-
This package comes with [20 prefunded keys for testing](https://github.com/kurtosis-tech/ethereum-package/blob/main/src/prelaunch_data_generator/genesis_constants/genesis_constants.star).
971+
This package comes with [20 prefunded keys for testing](https://github.com/ethpandaops/ethereum-package/blob/main/src/prelaunch_data_generator/genesis_constants/genesis_constants.star).
1012972

1013973
Here's a table of where the keys are used
1014974

docs/architecture.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -63,26 +63,26 @@ Then the validator keys are generated. A tool called [eth2-val-tools](https://gi
6363

6464
### Starting EL clients
6565

66-
Next, we plug the generated genesis data [into EL client "launchers"](https://github.com/kurtosis-tech/ethereum-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_context` struct](https://github.com/kurtosis-tech/ethereum-package/blob/main/src/participant_network/el/el_context.star). Each EL client type has its own launcher (e.g. [Geth](https://github.com/kurtosis-tech/ethereum-package/tree/main/src/participant_network/el/geth), [Besu](https://github.com/kurtosis-tech/ethereum-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.
66+
Next, we plug the generated genesis data [into EL client "launchers"](https://github.com/ethpandaops/ethereum-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_context` struct](https://github.com/ethpandaops/ethereum-package/blob/main/src/participant_network/el/el_context.star). Each EL client type has its own launcher (e.g. [Geth](https://github.com/ethpandaops/ethereum-package/tree/main/src/participant_network/el/geth), [Besu](https://github.com/ethpandaops/ethereum-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.
6767

6868
### Starting CL clients
6969

70-
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/ethereum-package/tree/main/src/participant_network/cl). Just as with EL clients:
70+
Once CL genesis data and keys have been created, the CL client nodes are started via [the CL client launchers](https://github.com/ethpandaops/ethereum-package/tree/main/src/participant_network/cl). Just as with EL clients:
7171

7272
- CL client launchers implement come with a `launch` method
73-
- One CL client launcher exists per client type (e.g. [Nimbus](https://github.com/kurtosis-tech/ethereum-package/tree/main/src/participant_network/cl/nimbus), [Lighthouse](https://github.com/kurtosis-tech/ethereum-package/tree/main/src/participant_network/cl/lighthouse))
74-
- Launched CL node information is tracked in [a `cl_context` struct](https://github.com/kurtosis-tech/ethereum-package/blob/main/src/participant_network/cl/cl_context.star)
73+
- One CL client launcher exists per client type (e.g. [Nimbus](https://github.com/ethpandaops/ethereum-package/tree/main/src/participant_network/cl/nimbus), [Lighthouse](https://github.com/ethpandaops/ethereum-package/tree/main/src/participant_network/cl/lighthouse))
74+
- Launched CL node information is tracked in [a `cl_context` struct](https://github.com/ethpandaops/ethereum-package/blob/main/src/participant_network/cl/cl_context.star)
7575

7676
There are only two major difference between CL client and EL client launchers. First, the `cl_client_launcher.launch` method also consumes an `el_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.
7777

7878
## Auxiliary Services
7979

8080
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:
8181

82-
- [Forkmon](https://github.com/kurtosis-tech/ethereum-package/tree/main/src/el_forkmon), a "fork monitor" web UI for visualizing the CL clients' forks
83-
- [Prometheus](https://github.com/kurtosis-tech/ethereum-package/tree/main/src/prometheus) for collecting client node metrics
84-
- [Grafana](https://github.com/kurtosis-tech/ethereum-package/tree/main/src/grafana) for visualizing client node metrics
85-
- [An ETH transaction spammer](https://github.com/kurtosis-tech/ethereum-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
82+
- [Forkmon](https://github.com/ethpandaops/ethereum-package/tree/main/src/el_forkmon), a "fork monitor" web UI for visualizing the CL clients' forks
83+
- [Prometheus](https://github.com/ethpandaops/ethereum-package/tree/main/src/prometheus) for collecting client node metrics
84+
- [Grafana](https://github.com/ethpandaops/ethereum-package/tree/main/src/grafana) for visualizing client node metrics
85+
- [An ETH transaction spammer](https://github.com/ethpandaops/ethereum-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
8686

8787
## [Testnet Verifier][testnet-verifier]
8888

@@ -91,9 +91,9 @@ Once the Ethereum network is up and running, verification logic will be run to e
9191
<!------------------------ Only links below here -------------------------------->
9292

9393
[enclave-context]: https://docs.kurtosistech.com/kurtosis/core-lib-documentation#enclavecontext
94-
[main-function]: https://github.com/kurtosis-tech/ethereum-package/blob/main/main.star#22
95-
[package-io]: https://github.com/kurtosis-tech/ethereum-package/tree/main/src/package_io
96-
[participant-network]: https://github.com/kurtosis-tech/ethereum-package/tree/main/src/participant_network
94+
[main-function]: https://github.com/ethpandaops/ethereum-package/blob/main/main.star#22
95+
[package-io]: https://github.com/ethpandaops/ethereum-package/tree/main/src/package_io
96+
[participant-network]: https://github.com/ethpandaops/ethereum-package/tree/main/src/participant_network
9797
[ethereum-genesis-generator]: https://github.com/ethpandaops/ethereum-genesis-generator
98-
[static-files]: https://github.com/kurtosis-tech/ethereum-package/tree/main/static_files
99-
[testnet-verifier]: https://github.com/kurtosis-tech/ethereum-package/tree/main/src/testnet_verifier
98+
[static-files]: https://github.com/ethpandaops/ethereum-package/tree/main/static_files
99+
[testnet-verifier]: https://github.com/ethpandaops/ethereum-package/tree/main/src/testnet_verifier

kurtosis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
name: "github.com/kurtosis-tech/ethereum-package"
1+
name: "github.com/ethpandaops/ethereum-package"

main.star

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ def run(plan, args={}):
6767
"""Launches an arbitrarily complex ethereum testnet based on the arguments provided
6868
6969
Args:
70-
args: A YAML or JSON argument to configure the network; example https://github.com/kurtosis-tech/ethereum-package/blob/main/network_params.yaml
70+
args: A YAML or JSON argument to configure the network; example https://github.com/ethpandaops/ethereum-package/blob/main/network_params.yaml
7171
"""
7272

7373
args_with_right_defaults = input_parser.input_parser(plan, args)

src/el/ethereumjs/ethereumjs_launcher.star

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ def launch(
143143

144144
enode = el_admin_node_info.get_enode_for_node(plan, service_name, RPC_PORT_ID)
145145

146-
# TODO: Passing empty string for metrics_url for now https://github.com/kurtosis-tech/ethereum-package/issues/127
146+
# TODO: Passing empty string for metrics_url for now https://github.com/ethpandaops/ethereum-package/issues/127
147147
# metrics_url = "http://{0}:{1}".format(service.ip_address, METRICS_PORT_NUM)
148148
ethjs_metrics_info = None
149149

src/mev/flashbots/mev_boost/mev_boost_launcher.star

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def get_config(
6262
cmd=command,
6363
env_vars={
6464
# TODO(maybe) remove the hardcoding
65-
# This is set to match this file https://github.com/kurtosis-tech/ethereum-package/blob/main/static_files/genesis-generation-config/cl/config.yaml.tmpl#L11
65+
# This is set to match this file https://github.com/ethpandaops/ethereum-package/blob/main/static_files/genesis-generation-config/cl/config.yaml.tmpl#L11
6666
# latest-notes
6767
# does this need genesis time to be set as well
6868
"GENESIS_FORK_VERSION": "0x10000038",

0 commit comments

Comments
 (0)