-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: dydx v5 and v6 quickstart docs (#645)
- Loading branch information
1 parent
4ab8c8b
commit d8c386b
Showing
1 changed file
with
141 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,76 +1,147 @@ | ||
| **The minimum required version for Connect with dYdX is `v1.0.5+`.** | ||
| <AccordionGroup> | ||
| <Accordion title="dYdX v6"> | ||
|
|
||
| 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://<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" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| 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://<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" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| 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> | ||
|
|
||
| ```shell | ||
| slinky \ | ||
| --marketmap-provider dydx_migration_api \ | ||
| --oracle-config path/to/oracle.json | ||
| ``` |