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.

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

Documentation improvement: better document client's config files #62

Closed
gumb0 opened this issue Nov 12, 2019 · 2 comments
Closed

Documentation improvement: better document client's config files #62

gumb0 opened this issue Nov 12, 2019 · 2 comments
Labels
help wanted Extra attention is needed

Comments

@gumb0
Copy link
Member

gumb0 commented Nov 12, 2019

The config files and genesis/<ForkName>.json files in https://github.com/ethereum/tests/tree/develop/Retesteth are not sufficiently documented, I think. There are some portions config files mentioned in https://github.com/ethereum/retesteth/wiki/Add-client-configuration-to-Retesteth but ideally I'd like to see what is the schema of these files, what must be included, what may be optionally included, what is not included, how retesteth uses these files exactly.

For example, currently it seems that these fields are required in config:

  • name
  • socketType
  • socketAddress
  • forks
  • additonalForks (what is this, how is it different from forks?)

And in *.json:

  • params
  • accounts with a list of precompiles (this actually might be required only for aleth), but no other accounts

This kind of info would be useful in the guide "how to mare retesteth work with your client"

@winsvega winsvega added the help wanted Extra attention is needed label Nov 29, 2019
@winsvega
Copy link
Collaborator

winsvega commented Mar 2, 2020

@winsvega
Copy link
Collaborator

winsvega commented Nov 5, 2020

@winsvega winsvega closed this as completed Nov 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants