Skip to content

Commit

Permalink
docs: update dydx v6 docs (#674)
Browse files Browse the repository at this point in the history
  • Loading branch information
technicallyty authored Aug 16, 2024
1 parent d95ea98 commit 18128a8
Show file tree
Hide file tree
Showing 3 changed files with 209 additions and 148 deletions.
208 changes: 208 additions & 0 deletions docs/snippets/dydx-quickstart-guide.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,208 @@
<AccordionGroup>
<Accordion title="dYdX v6">

**The minimum required version for Connect with dYdX v6 is `v1.0.10+`.**

First, please ensure you've received your **API keys** for the relevant providers. If you have not received API keys, please reach out to the team in the relevant communication channels.

Next, place your API keys under their corresponding URLs in the following file and save it to your system. **Keep the file path handy** as we will pass it into a flag when running Connect.

We will also supply an edited configuration for the `dydx_migration_api` which facilitates graceful migration from dydx's `x/prices` to `x/marketmap`.

For the `dydx_migration_api` provider, **make sure to fill in the URL for the REST endpoint and gRPC endpoint of your node** (in that order). The migration API will _not_ work unless the REST API endpoint is the **first** endpoint in the endpoints list.

```json oracle.json
{
"providers":{
"dydx_migration_api":{
"api":{
"endpoints":[
{
"url":"http://<YOUR NODE REST API ENDPOINT>"
},
{
"url":"<YOUR NODE GRPC ENDPOINT>:<YOUR NODE GRPC PORT>"
}
]
}
},
"raydium_api":{
"api":{
"endpoints":[
{
"url":"https://solana.polkachu.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
},
{
"url":"https://slinky-solana.kingnodes.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
},
{
"url":"https://solana.lavenderfive.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
},
{
"url":"https://solana-rpc.rhino-apis.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
},
{
"url":"https://dydx.helius-rpc.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
}
]
}
},
"uniswapv3_api-ethereum": {
"api": {
"endpoints": [
{
"url":"https://ethereum.lavenderfive.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
},
{
"url":"https://ethereum-rpc.polkachu.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
},
{
"url":"https://eth.kingnodes.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
},
{
"url":"https://ethereum-rpc.rhino-apis.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
}
]
}
},
"uniswapv3_api-base": {
"api": {
"endpoints": [
{
"url":"https://base-rpc.rhino-apis.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
},
{
"url":"https://slinky-base.kingnodes.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
},
{
"url":"https://base.lavenderfive.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
}
]
}
}
}
}
```

With the `oracle.json` file path, enter the following command to run Connect.

```shell
slinky \
--marketmap-provider dydx_migration_api \
--oracle-config path/to/oracle.json
```
</Accordion>
<Accordion title="dYdX v5">

**The minimum required version for Connect with dYdX v5 is `v1.0.5+`.**

First, please ensure you've received your API keys for Raydium markets. If you have not received API keys, please reach out to the team in the relevant channels.

Next, place your API keys under their corresponding URLs in the following file and save it to your system. Keep the file path handy as we will pass it into a flag when running Connect.

```json oracle.json
{
"providers":{
"raydium_api":{
"api":{
"endpoints":[
{
"url":"https://solana.polkachu.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
},
{
"url":"https://slinky-solana.kingnodes.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
},
{
"url":"https://solana.lavenderfive.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
},
{
"url":"https://solana-rpc.rhino-apis.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
},
{
"url":"https://dydx.helius-rpc.com",
"authentication":{
"apiKeyHeader":"x-api-key",
"apiKey":"API KEY"
}
}
]
}
}
}
}
```
With your dYdX node's REST API endpoint and the `oracle.json` file path, enter the following command to run Connect.

```shell
slinky \
--marketmap-provider dydx_api \
--market-map-endpoint https://<dydx-node REST API endpoint> \
--oracle-config path/to/oracle.json
```
</Accordion>
</AccordionGroup>

147 changes: 0 additions & 147 deletions docs/snippets/dydx-quickstart.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/validators/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ icon: person-running-fast
---

import QuickStartSnippet from '/snippets/quickstart.mdx';
import QuickStartDYDXSnippet from '/snippets/dydx-quickstart.mdx';
import QuickStartDYDXSnippet from '/snippets/dydx-quickstart-guide.mdx';


<Info>
Expand Down

0 comments on commit 18128a8

Please sign in to comment.