From d8c386bb2ebd64da006f922c6ecdb97df1d7f0b0 Mon Sep 17 00:00:00 2001 From: Tyler <48813565+technicallyty@users.noreply.github.com> Date: Mon, 5 Aug 2024 12:12:14 -0400 Subject: [PATCH] docs: dydx v5 and v6 quickstart docs (#645) --- docs/snippets/start-connect-dydx-snippet.mdx | 211 +++++++++++++------ 1 file changed, 141 insertions(+), 70 deletions(-) diff --git a/docs/snippets/start-connect-dydx-snippet.mdx b/docs/snippets/start-connect-dydx-snippet.mdx index ebae77274..1f32b1516 100644 --- a/docs/snippets/start-connect-dydx-snippet.mdx +++ b/docs/snippets/start-connect-dydx-snippet.mdx @@ -1,76 +1,147 @@ -**The minimum required version for Connect with dYdX 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. + **The minimum required version for Connect with dYdX v6 is `v1.0.5+`.** -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. + 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. -We will also supply an edited configuration for the `dydx_migration_api` which facilitates graceful migration from dydx's `x/prices` to `x/marketmap`. + 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. -**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 if the REST API endpoint is not the first endpoint in the list. + We will also supply an edited configuration for the `dydx_migration_api` which facilitates graceful migration from dydx's `x/prices` to `x/marketmap`. -```json oracle.json -{ - "providers":{ - "dydx_migration_api":{ - "api":{ - "endpoints":[ - { - "url":"http://" - }, - { - "url":":" - } - ] - } - }, - "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 the `oracle.json` file path, enter the following command to run Connect. + **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 if the REST API endpoint is not the first endpoint in the list. + + ```json oracle.json + { + "providers":{ + "dydx_migration_api":{ + "api":{ + "endpoints":[ + { + "url":"http://" + }, + { + "url":":" + } + ] + } + }, + "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 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 + ``` + + + + **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:// \ + --oracle-config path/to/oracle.json + ``` + + -```shell -slinky \ - --marketmap-provider dydx_migration_api \ - --oracle-config path/to/oracle.json -``` \ No newline at end of file