Skip to content

Commit

Permalink
docs: Add stargaze quickstart (#695)
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric-Warehime authored Aug 22, 2024
1 parent ecf90fa commit 68c03ef
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/snippets/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
To run Connect, which starts the service on the default port of `8080`, enter the following command:

```shell
slinky --market-map-endpoint="<YOUR_NODE_GRPC_URL>:<YOUR_NODE_GRPC_PORT>"
connect --market-map-endpoint="<YOUR_NODE_GRPC_URL>:<YOUR_NODE_GRPC_PORT>"
```
25 changes: 25 additions & 0 deletions docs/snippets/stargaze-quickstart-guide.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
**The minimum required version for Connect with Stargaze is `v1.0.10+`.**

You need to configure a custom API endpoint for use with the Osmosis provider, `https://rest.osmosis-1.interchain-apis.com`.
Set the following `oracle.json` configuration file. **Keep the file path handy** as we will pass it into a flag when running Connect.

```json oracle.json
{
"providers":{
"osmosis_api":{
"api":{
"endpoints":[
{"url":"https://rest.osmosis-1.interchain-apis.com"}
]
}
}
}
}
```
With the `oracle.json` file path, enter the following command to run Connect.

```shell
connect \
--market-map-endpoint="<YOUR_NODE_GRPC_URL>:<YOUR_NODE_GRPC_PORT>" \
--oracle-config path/to/oracle.json
```
4 changes: 4 additions & 0 deletions docs/validators/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ icon: person-running-fast

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


<Info>
Expand Down Expand Up @@ -59,6 +60,9 @@ slinky version
**The minimum required Connect version for the Neutron chain is `v1.0.3+`.**
<QuickStartSnippet />
</Tab>
<Tab title="Stargaze Blockchain">
<QuickStartStargazeSnippet />
</Tab>
</Tabs>


Expand Down

0 comments on commit 68c03ef

Please sign in to comment.