|
1 | 1 | # 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/). |
41 | 3 |
|
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`. |
46 | 5 |
|
| 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). |
47 | 7 |
|
48 | 8 | # Ethereum Package |
49 | 9 |
|
@@ -74,22 +34,22 @@ Optional features (enabled via flags or parameter files at runtime): |
74 | 34 |
|
75 | 35 | ## Quickstart |
76 | 36 |
|
77 | | -[](https://gitpod.io/new/?editor=code#https://github.com/kurtosis-tech/ethereum-package) |
| 37 | +[](https://gitpod.io/new/?editor=code#https://github.com/ethpandaops/ethereum-package) |
78 | 38 |
|
79 | 39 | 1. [Install Docker & start the Docker Daemon if you haven't done so already][docker-installation] |
80 | 40 | 2. [Install the Kurtosis CLI, or upgrade it to the latest version if it's already installed][kurtosis-cli-installation] |
81 | 41 | 3. Run the package with default configurations from the command line: |
82 | 42 |
|
83 | 43 | ```bash |
84 | | - kurtosis run --enclave my-testnet github.com/kurtosis-tech/ethereum-package |
| 44 | + kurtosis run --enclave my-testnet github.com/ethpandaops/ethereum-package |
85 | 45 | ``` |
86 | 46 |
|
87 | 47 | #### Run with your own configuration |
88 | 48 |
|
89 | 49 | 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: |
90 | 50 |
|
91 | 51 | ```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 |
93 | 53 | ``` |
94 | 54 |
|
95 | 55 | Where `network_params.yaml` contains the parameters for your network in your home directory. |
@@ -978,7 +938,7 @@ Consensus Layer (CL) nodes - Validator: |
978 | 938 | To spin up the network of Ethereum nodes with an external block building network (using Flashbot's `mev-boost` protocol), simply use: |
979 | 939 |
|
980 | 940 | ``` |
981 | | -kurtosis run github.com/kurtosis-tech/ethereum-package '{"mev_type": "full"}' |
| 941 | +kurtosis run github.com/ethpandaops/ethereum-package '{"mev_type": "full"}' |
982 | 942 | ``` |
983 | 943 |
|
984 | 944 | 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 |
1008 | 968 |
|
1009 | 969 | ## Pre-funded accounts at Genesis |
1010 | 970 |
|
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). |
1012 | 972 |
|
1013 | 973 | Here's a table of where the keys are used |
1014 | 974 |
|
|
0 commit comments