-
Notifications
You must be signed in to change notification settings - Fork 45
Add Slinky sections #433
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
base: main
Are you sure you want to change the base?
Add Slinky sections #433
Conversation
|
@2dpetkov is attempting to deploy a commit to the dYdX Trading Team on Vercel. A member of the Team first needs to authorize it. |
| # Interval is the time between each price update request. The recommended interval | ||
| # is the block time of the chain. Otherwise, 1.5 seconds (1500ms) is a good default. If this | ||
| # is greater than 1 minute (1m), the app will not start. | ||
| interval = "1500ms" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The default should reflect our recommendation of $blocktime
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
true, I'll recommend 600ms since block times are slightly higher than that number nowadays.
|
|
||
| | Key | Default | Description | | ||
| |---------------------------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `CONNECT_CONFIG_HOST` | `"0.0.0.0"` | The address Slinky will serve requests from. WARNING: changing this value requires updating the oracle_address in the app.toml configuration. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should add a note on security concerns, e.g. using 0.0.0.0 vs 127.0.0.1 permits external queries. That might be desired for convenience but I think our recommendations should lean towards security.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
true, adding such a note
| ## Slinky | ||
|
|
||
| Starting in `v5.0.0`, running a validating full node requires a Skip Protocol's Connect Sidecar to be run in order to fetch Oracle prices. The sidecar should be started before upgrading from `v4` to `v5`. Instructions to start Connect Sidecar can be found [here](https://docs.skip.build/connect/validators/quickstart). | ||
| Starting in `v5.0.0`, running a validating full node requires the Slinky sidecar to be running in order to fetch Oracle prices. Slinky is a sidecar that pulls price data from external sources and caches them for the validator to use. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't a note on v5.0.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the dYdX Chain Protocol version v5.0.0 - the dydxprotocold version when prices were moved from price daemon to Skip's sidecar
I can of course remove it, or reword it so that it's clearly referencing the corresponding dYdX Chain hard fork.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or better yet - link the dYdX Protocol upgrade proposal that introduced Skip's sidecar
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My thinking is: the wording Starting in v5.0.0 was there in docs.dydx.xyz before this change, why not build on top of it.
I can remove though, if there's something I'm missing
This content is taken from the subsections under the Validators section from
https://docs.skip.build/connect/validators/.Summary
https://github.com/dydxprotocol/slinky).oracle.jsonexample from the original Validators documentation with the latest set of provider endpoints that validators need to configure.running-a-validator.mdxnow points torequired-node-configs.mdx#oracle-configurationandrequired-node-configs.mdx#slinky-configs.upgrading-sidecar.mdxremoves the Skip/Connect upgrade link and adds native upgrade steps, while still linking to../running-node/optimize.mdx#slinky-sidecar.onboarding-faqs/index.mdxswitches the oracle breakdown to “Slinky” and adds additional Oracle FAQ entries in the existing sequence.