From 52f481e0c8bc69e3ae7925bfe86301969d87fbf8 Mon Sep 17 00:00:00 2001 From: Nikhil Vasan Date: Wed, 10 Jul 2024 16:16:32 -0700 Subject: [PATCH] docs changes --- docs/integrations/dydx.mdx | 2 ++ docs/integrations/neutron.mdx | 5 ++++- docs/validator/troubleshooting.mdx | 9 +++++++++ docs/validator/validator-connect-config.mdx | 22 +++++++++++++++++++++ 4 files changed, 37 insertions(+), 1 deletion(-) diff --git a/docs/integrations/dydx.mdx b/docs/integrations/dydx.mdx index 554151db4..2b18f329e 100644 --- a/docs/integrations/dydx.mdx +++ b/docs/integrations/dydx.mdx @@ -39,6 +39,8 @@ Before you complete your connect setup it is important that you setup your raydi #### **Point your chain binary at your Connect instance** +> Notice if you are using a remote signer, please see [this](/validator/troubleshooting#can-i-use-a-remote-signer) + The dYdX binary has been altered to accept new options which are used to configure your application. The following options in `app.toml` are relevant to operating Connect. The top level config fields are as follows: diff --git a/docs/integrations/neutron.mdx b/docs/integrations/neutron.mdx index 8ff755e63..a904774aa 100644 --- a/docs/integrations/neutron.mdx +++ b/docs/integrations/neutron.mdx @@ -29,10 +29,13 @@ title: Neutron slinky ``` - > Notice, some default values may need to change depending on how you've setup your node + connect-sidecar. See the **marketmap-provider** [section](/validator/flags-guide#marketmap-provider) of the [flags-guide](/validator/flags-guide) + > Notice, some default values may need to change depending on how you've setup your node + connect-sidecar. See the **marketmap-provider** [section](/validator/flags-guide#marketmap-provider) of the [flags-guide](/validator/flags-guide) an example config that over-rides relevant slinky defaults is [here](/validator/validator-connect-config#overriding-the-market-map-oracle-server-endpoint) 3. **Point your chain binary at your Connect instance** + > Notice if you are using a remote signer, please see [this](/validator/troubleshooting#can-i-use-a-remote-signer) + + The chain binary has been altered to accept new options which are used to configure your application. The following options in `app.toml` are relevant to Connect operation. ```toml diff --git a/docs/validator/troubleshooting.mdx b/docs/validator/troubleshooting.mdx index 6734c9f01..dc0df381c 100644 --- a/docs/validator/troubleshooting.mdx +++ b/docs/validator/troubleshooting.mdx @@ -30,3 +30,12 @@ Yes - feel free to contribute via opening an issue in [our repo](https://github. ### I do not see an issue addressing my question. Please reach out to us using your preferred method. We are available on [our website](https://skip.money/contact) or via a [Github issue](https://github.com/skip-mev/slinky/issues/new). + +### Can I use a remote signer? + +The following remote signers with the specified versions are supported + +- [Horcrux](https://github.com/strangelove-ventures/horcrux/releases/tag/v3.3.0): v3.3.0+ is compatible with slinky + vote-extensions + - If you are using [horcrux-proxy](https://github.com/strangelove-ventures/horcrux-proxy/releases/tag/v1.0.0) be sure to use v1.0.0+ so that the `maxReadSize` can be configured in accordance with larger vote-extension payloads + +- [TMKMS](https://github.com/iqlusioninc/tmkms/tree/v0.13.1): v0.13.1+ is compatible with slinky + vote-extensions \ No newline at end of file diff --git a/docs/validator/validator-connect-config.mdx b/docs/validator/validator-connect-config.mdx index 90cf0839a..42e32cff3 100644 --- a/docs/validator/validator-connect-config.mdx +++ b/docs/validator/validator-connect-config.mdx @@ -149,6 +149,28 @@ auth support. ## Sample Configuration: +### Overriding the market-map / oracle server endpoint + +```json +{ + "port": 8080, + "metrics": { + "prometheusServerAddress": "0.0.0.0:26662" + }, + "providers": { + "marketmap_api": { + "api": { + "endpoints": [ + { + "url": "127.0.0.1:9090" + } + ] + } + } + } +} +``` + ### Overriding Prometheus Server Endpoint ```json