docs: update dydx validator quickstart (#633)

Co-authored-by: Alex Johnson <[email protected]>
skip-mev · Jul 30, 2024 · 6b5d4ca · 6b5d4ca
1 parent 83283e5
commit 6b5d4ca
Showing 1 changed file with 47 additions and 30 deletions.
diff --git a/docs/snippets/start-connect-dydx-snippet.mdx b/docs/snippets/start-connect-dydx-snippet.mdx
@@ -1,49 +1,64 @@
-The dYdX blockchain requires some additional steps to start Connect.
+**The minimum required version for Connect with dYdX is `v1.0.5+`.**
 
-**The minimum required version for Connect with dYdX is `v1.0.1+`.**
-
-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.
+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.
+
+We will also supply an edited configuration for the `dydx_migration_api` which facilitates graceful migration from dydx's `x/prices` to `x/marketmap`.
+
+**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": {
-      "raydium_api": {
-         "api": {
-            "endpoints": [
+   "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://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://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.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://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"
+                  "url":"https://dydx.helius-rpc.com",
+                  "authentication":{
+                     "apiKeyHeader":"x-api-key",
+                     "apiKey":"API KEY"
                   }
                }
             ]
@@ -52,8 +67,10 @@ Next, place your API keys under their corresponding URLs in the following file a
    }
 }
 ```
-With your dYdX node's REST API endpoint and the `oracle.json` file path, enter the following command to run Connect.
+With 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
+slinky \
+  --marketmap-provider dydx_migration_api \
+  --oracle-config path/to/oracle.json
 ```