From 30e37c5c7b2ef11d3742d04cf3379509e80b70ce Mon Sep 17 00:00:00 2001 From: ForwardSlashBack <142098649+ForwardSlashBack@users.noreply.github.com> Date: Sat, 12 Aug 2023 23:53:09 -0400 Subject: [PATCH 1/2] Fix minor documentation typo --- RETESTBOR.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RETESTBOR.md b/RETESTBOR.md index c04fd7edef..41b6d767e9 100644 --- a/RETESTBOR.md +++ b/RETESTBOR.md @@ -70,7 +70,7 @@ Eventually. these config needs to be adapted according to the following doc https://ethereum-tests.readthedocs.io/en/latest/retesteth-tutorial.html Specifically: ``` -f you look inside ~/tests/config, you’ll see a directory for each configured client. Typically this directory has these files: +If you look inside ~/tests/config, you’ll see a directory for each configured client. Typically this directory has these files: config, which contains the configuration for the client: The communication protocol to use with the client (typically TCP) From b58ce594c2ba0e5c8ce436a84caddf837f6d551d Mon Sep 17 00:00:00 2001 From: ForwardSlashBack <142098649+ForwardSlashBack@users.noreply.github.com> Date: Sun, 13 Aug 2023 15:21:21 -0400 Subject: [PATCH 2/2] Additional reformatting and cleanup of RETESTBOR document --- RETESTBOR.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/RETESTBOR.md b/RETESTBOR.md index 41b6d767e9..39751f7958 100644 --- a/RETESTBOR.md +++ b/RETESTBOR.md @@ -65,22 +65,21 @@ ls ``` ./dretesteth.sh -t GeneralStateTests/stExample -- --testpath /home/ubuntu/retestethBuild/tests --datadir /tests/config ``` -This will create the config files for the different clients in ~/tests/config -Eventually. these config needs to be adapted according to the following doc +This will create the config files for the different clients in `~/tests/config` +Eventually, these configuration files need to be adapted according to the following document: + https://ethereum-tests.readthedocs.io/en/latest/retesteth-tutorial.html -Specifically: -``` -If you look inside ~/tests/config, you’ll see a directory for each configured client. Typically this directory has these files: -config, which contains the configuration for the client: -The communication protocol to use with the client (typically TCP) -The address(es) to use with that protocol -The forks the client supports -The exceptions the client can throw, and how retesteth should interpret them. This is particularly important when testing the client’s behavior when given invalid blocks. -start.sh, which starts the client inside the docker image -stop.sh, which stops the client instance(s) -genesis, a directory which includes the genesis blocks for various forks the client supports. If this directory does not exist for a client, it uses the genesis blocks for the default client. -``` +Specifically, if you look inside `~/tests/config`, you'll see a directory for each configured client. Typically this directory contains the following: + +* `config`: Contains the test configuration for the client + * The communication protocol to use with the client (typically TCP). + * The address(es) to use with that protocol. + * The forks supported by the client. + * The exceptions the client can throw, and how retesteth should interpret them. This is particularly important when testing the client's behavior when given invalid blocks. +* `start.sh`: Starts the client inside the Docker image +* `stop.sh`: Stops the client instance(s) +* `genesis`: A directory which includes the genesis blocks for the various forks supported by the cient. If this directory does not exist for a client, it uses the genesis blocks for the default client. We replaced geth inside docker by using https://ethereum-tests.readthedocs.io/en/latest/retesteth-tutorial.html#replace-geth-inside-the-docker Theoretically, we would not need any additional config change