From 30de67bb0970045c68a1e797f698c62ca92ffcdb Mon Sep 17 00:00:00 2001 From: Tyler <48813565+technicallyty@users.noreply.github.com> Date: Thu, 15 Aug 2024 11:55:50 -0700 Subject: [PATCH 1/5] wip --- docs/snippets/dydx-quickstart.mdx | 156 +++++++++++++++++++----------- docs/snippets/foo.json | 97 +++++++++++++++++++ 2 files changed, 195 insertions(+), 58 deletions(-) create mode 100644 docs/snippets/foo.json diff --git a/docs/snippets/dydx-quickstart.mdx b/docs/snippets/dydx-quickstart.mdx index 1f32b1516..d8cd89d9b 100644 --- a/docs/snippets/dydx-quickstart.mdx +++ b/docs/snippets/dydx-quickstart.mdx @@ -1,73 +1,113 @@ - **The minimum required version for Connect with dYdX v6 is `v1.0.5+`.** + **The minimum required version for Connect with dYdX v6 is `v1.0.10+`.** - 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 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. + 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. + 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** in the endpoints 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" - } - } - ] - } + "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" + } + } + ] + } + }, + "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" + } + } + ] + } + }, + "uniswapv3_api-base": { + "api": { + "endpoints": [ + { + "url":"https://base-rpc.rhino-apis.com", + "authentication":{ + "apiKeyHeader":"x-api-key", + "apiKey":"API KEY" + } + } + ] + } + } + } } ``` diff --git a/docs/snippets/foo.json b/docs/snippets/foo.json new file mode 100644 index 000000000..2692a7b4f --- /dev/null +++ b/docs/snippets/foo.json @@ -0,0 +1,97 @@ +{ + "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" + } + } + ] + } + }, + "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" + } + } + ] + } + }, + "uniswapv3_api-base": { + "api": { + "endpoints": [ + { + "url":"https://base-rpc.rhino-apis.com", + "authentication":{ + "apiKeyHeader":"x-api-key", + "apiKey":"API KEY" + } + } + ] + } + } + } +} \ No newline at end of file From 1a70ae7c067a5a238a89cf3b9df933df724fe9bc Mon Sep 17 00:00:00 2001 From: Tyler <48813565+technicallyty@users.noreply.github.com> Date: Thu, 15 Aug 2024 12:01:35 -0700 Subject: [PATCH 2/5] word --- docs/snippets/dydx-quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/snippets/dydx-quickstart.mdx b/docs/snippets/dydx-quickstart.mdx index d8cd89d9b..109758f15 100644 --- a/docs/snippets/dydx-quickstart.mdx +++ b/docs/snippets/dydx-quickstart.mdx @@ -9,7 +9,7 @@ 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** in the endpoints list. + 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 { From d58e93e2ab3eecf826c8ed5d0298df8152d42745 Mon Sep 17 00:00:00 2001 From: Tyler <48813565+technicallyty@users.noreply.github.com> Date: Fri, 16 Aug 2024 12:59:13 -0700 Subject: [PATCH 3/5] new docs --- ...ickstart.mdx => dydx-quickstart-guide.mdx} | 28 +++++++++++++++++++ docs/snippets/foo.json | 28 +++++++++++++++++++ docs/validators/quickstart.mdx | 2 +- 3 files changed, 57 insertions(+), 1 deletion(-) rename docs/snippets/{dydx-quickstart.mdx => dydx-quickstart-guide.mdx} (87%) diff --git a/docs/snippets/dydx-quickstart.mdx b/docs/snippets/dydx-quickstart-guide.mdx similarity index 87% rename from docs/snippets/dydx-quickstart.mdx rename to docs/snippets/dydx-quickstart-guide.mdx index 109758f15..d3fcd5dea 100644 --- a/docs/snippets/dydx-quickstart.mdx +++ b/docs/snippets/dydx-quickstart-guide.mdx @@ -90,6 +90,13 @@ "apiKeyHeader":"x-api-key", "apiKey":"API KEY" } + }, + { + "url":"https://ethereum-rpc.rhino-apis.com", + "authentication":{ + "apiKeyHeader":"x-api-key", + "apiKey":"API KEY" + } } ] } @@ -103,6 +110,27 @@ "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" + } + }, + { + "url":"", + "authentication":{ + "apiKeyHeader":"x-api-key", + "apiKey":"API KEY" + } } ] } diff --git a/docs/snippets/foo.json b/docs/snippets/foo.json index 2692a7b4f..1e14fee0e 100644 --- a/docs/snippets/foo.json +++ b/docs/snippets/foo.json @@ -76,6 +76,13 @@ "apiKeyHeader":"x-api-key", "apiKey":"API KEY" } + }, + { + "url":"https://ethereum-rpc.rhino-apis.com", + "authentication":{ + "apiKeyHeader":"x-api-key", + "apiKey":"API KEY" + } } ] } @@ -89,6 +96,27 @@ "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" + } + }, + { + "url":"", + "authentication":{ + "apiKeyHeader":"x-api-key", + "apiKey":"API KEY" + } } ] } diff --git a/docs/validators/quickstart.mdx b/docs/validators/quickstart.mdx index 03bf733bf..ffc31f1cd 100644 --- a/docs/validators/quickstart.mdx +++ b/docs/validators/quickstart.mdx @@ -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'; From 2d0151e5d9440d65c292f8d884093c284512ef7e Mon Sep 17 00:00:00 2001 From: Tyler <48813565+technicallyty@users.noreply.github.com> Date: Fri, 16 Aug 2024 13:00:11 -0700 Subject: [PATCH 4/5] remove empty --- docs/snippets/dydx-quickstart-guide.mdx | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/snippets/dydx-quickstart-guide.mdx b/docs/snippets/dydx-quickstart-guide.mdx index d3fcd5dea..9df371077 100644 --- a/docs/snippets/dydx-quickstart-guide.mdx +++ b/docs/snippets/dydx-quickstart-guide.mdx @@ -124,13 +124,6 @@ "apiKeyHeader":"x-api-key", "apiKey":"API KEY" } - }, - { - "url":"", - "authentication":{ - "apiKeyHeader":"x-api-key", - "apiKey":"API KEY" - } } ] } From 90d4114192868f0b0fc5f593bb55afb7edabf4a1 Mon Sep 17 00:00:00 2001 From: Tyler <48813565+technicallyty@users.noreply.github.com> Date: Fri, 16 Aug 2024 13:01:07 -0700 Subject: [PATCH 5/5] remove json --- docs/snippets/foo.json | 125 ----------------------------------------- 1 file changed, 125 deletions(-) delete mode 100644 docs/snippets/foo.json diff --git a/docs/snippets/foo.json b/docs/snippets/foo.json deleted file mode 100644 index 1e14fee0e..000000000 --- a/docs/snippets/foo.json +++ /dev/null @@ -1,125 +0,0 @@ -{ - "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" - } - } - ] - } - }, - "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" - } - }, - { - "url":"", - "authentication":{ - "apiKeyHeader":"x-api-key", - "apiKey":"API KEY" - } - } - ] - } - } - } -} \ No newline at end of file