Fix #60: Update READMEs for remote testnet #143
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@trentmc could you review and let me know if there are any areas that needs to be improved? |
trentmc
changed the title
trentmc
changed the title
trentmc
approved these changes
Sep 7, 2023
Comment on lines
22
to
26
| - PAIR_FILTER: List of pairs to filter (separated by comma), if empty the app will fetch all available pairs. | ||
| - TIMEFRAME_FILTER: Timeframes to filter (separated by comma), if empty the app will fetch all available timeframes. | ||
| - SOURCE_FILTER: Price sources filter (separated by comma), if empty the app will fetch all available sources. | ||
| - RPC_URL: The RPC URL of the network. | ||
| - SUBGRAPH_URL: The Ocean subgraph url. |
There was a problem hiding this comment.
You can delete these lines.
Some envvars are self-documenting. Eg RPC_URL, SUBGRAPH_URL
Some envvars could use a bit of documentation. In that case, do a comment right above the command. (Many other pdr-backend READMEs do this, check it out. (And in some cases, an inline comment will work too.)
There was a problem hiding this comment.
Thanks! I noticed that we're missing documentation for filter env vars and how to use them.
This is very important, if they are unset the agents will process all available contracts, even the ones that were not deployed by OPF. I'll create an issue for this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #60
Changes proposed in this PR: