You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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.
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).
The text was updated successfully, but these errors were encountered:
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.
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:
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:
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 likecargo run
just works.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).
The text was updated successfully, but these errors were encountered: