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.

Sign up for GitHub

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

docs: more examples + guidance on remote-signers #593

Merged
merged 5 commits into from
Jul 11, 2024
Merged

docs: more examples + guidance on remote-signers #593

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
52f481e
docs changes
nivasan1 Jul 10, 2024
f98af28
Update docs/integrations/neutron.mdx
nivasan1 Jul 10, 2024
4724629
Update docs/validator/troubleshooting.mdx
nivasan1 Jul 10, 2024
e329498
nit fixes
nivasan1 Jul 10, 2024
5e07f3c
Merge branch 'main' into nv/docs-additions
Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/integrations/dydx.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
5 changes: 4 additions & 1 deletion docs/integrations/neutron.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
nivasan1 marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> 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)
> 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
Expand Down
9 changes: 9 additions & 0 deletions docs/validator/troubleshooting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
nivasan1 marked this conversation as resolved.
Show resolved Hide resolved
22 changes: 22 additions & 0 deletions docs/validator/validator-connect-config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading