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 to run a relay "out of the box" #18

Open
ralexstokes opened this issue Feb 2, 2024 · 2 comments · May be fixed by #71
Open

Documentation to run a relay "out of the box" #18

ralexstokes opened this issue Feb 2, 2024 · 2 comments · May be fixed by #71

Comments

@ralexstokes
Copy link

It would be nice if a user could clone the repo and run the relay with just a few steps (documenting anything outside the basic workflow).

When trying to do this myself, I've run into a few issues:

  1. Config file
    The relay expects a config file with a somewhat complex set of options. It would be nice if an example config.yml was present at the repo root so that something like cargo run just works.

  2. Documentation in the readme on external services
    It looks like the config expects references to the following external systems:
    a. Postgres
    b. Redis
    c. "simulator" -- payload validator I think at the moment
    d. beacon client with HTTP API enabled

It would be nice if the README called these out explicitly so a user can have them running before trying to run the relay (and presumably failing).

@Nomad-Free-Talent
Copy link

Can we have a documentation to run the helix relay for the custom network, please?
Now the documentation for the network-config from comfig.yml file is only provided for public testnets.

@0ex-d
Copy link
Contributor

0ex-d commented Jan 3, 2025

That’s a valid point! Since the current documentation focuses on 'out-of-the-box', I used testnet but I can expand the README.md to include a section for configuring Custom Networks. Here’s an example configuration for:
Example:

  network_config: !Custom
  dir_path: custom_dir
  genesis_validator_root: '0x0000000000000000000000000000000000000000000000000000000000000000'
  genesis_time: 1

Let me know what you think, and I’ll be happy to incorporate this into the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants