Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Improve RETESTBOR.md document formatting #960

Merged
merged 2 commits into from
Aug 17, 2023
Merged

fix: Improve RETESTBOR.md document formatting #960

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30e37c5
Fix minor documentation typo
ForwardSlashBack Aug 13, 2023
b58ce59
Additional reformatting and cleanup of RETESTBOR document
ForwardSlashBack Aug 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 13 additions & 14 deletions RETESTBOR.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
```
f 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
Expand Down