NTRN-303 add basic slinky bindings docs #176
Conversation
| Using `neutron-sdk` you can query these modules via contracts | ||
|
|
||
| ### Oracle | ||
| For example usage of these queries in contract, check our related [dev-contract](https://github.com/neutron-org/neutron-dev-contracts/blob/727aa94dff53373e34226d31d5bdcfc66e3a1aaf/contracts/oracle/src/contract.rs#L53) |
There was a problem hiding this comment.
Let's do not refer to dev-contract in the docs.
We usually refer to simple and easily readable contracts in neutron-sdk repo
| @@ -0,0 +1,210 @@ | |||
| # Overview | |||
| We have integrated the [Slinky](https://skip-protocol-docs.netlify.app/slinky/overview) modules (Oracle & MarketMap) into the Neutron and added WASM bindings to facilitate their usage. This integration enhances our blockchain with reliable, real-time price feeds and market data. | |||
There was a problem hiding this comment.
Weird link, why not https://docs.skip.money/slinky/overview?
| ### Market Map | ||
| For more detailed descriptions, refer to the [MarketMap README](https://github.com/skip-mev/slinky/blob/main/x/marketmap/README.md). | ||
|
|
||
| For example usage of these queries in contract, check our related [dev-contract](https://github.com/neutron-org/neutron-dev-contracts/blob/feat/sdk-50/contracts/marketmap/src/contract.rs#L52) |
There was a problem hiding this comment.
The same about dev-contracts
| Using `neutron-sdk` you can query these modules via contracts | ||
|
|
||
| ### Oracle | ||
| For example usage of these queries in contract, check our related [example contract](https://github.com/neutron-org/neutron-sdk/tree/d9abe67f0f62d4ea42d1943af53189ec6674d29e/contracts/marketmaphttps://github.com/neutron-org/neutron-sdk/tree/d9abe67f0f62d4ea42d1943af53189ec6674d29e/contracts/marketmap) |
| } | ||
| ``` | ||
|
|
||
| #### GetAllCurrencyPairs |
There was a problem hiding this comment.
I believe it's better to move the messages from the overview page to the Messages page just like it's done in other module sections
| @@ -0,0 +1,210 @@ | |||
| # Overview | |||
| We have integrated the [Slinky](https://docs.skip.money/slinky/overview) modules (Oracle & MarketMap) into the Neutron and added WASM bindings to facilitate their usage. This integration enhances our blockchain with reliable, real-time price feeds and market data. | |||
There was a problem hiding this comment.
would be nice to have a link to the neutron-sdk file with bindings defined to ease navigation. if we add links, users will be able to quickly find the actual definition of requests and responses and investigate them and different auxiliary structs/types
…y-bindings # Conflicts: # docs/neutron/modules/3rdparty/skip/slinky/overview.md # sidebars.js
| ], | ||
| }, | ||
| { | ||
| label: "Cosmos Hub", | ||
| { | ||
| label: 'Slinky', | ||
| type: 'category', | ||
| items: [ | ||
| 'neutron/modules/3rdparty/skip/slinky/overview', | ||
| ] | ||
| } | ||
| ], | ||
| }, | ||
| { | ||
| label: "Cosmos Hub", |
There was a problem hiding this comment.
something's wrong here. did you run yarn start and took a look at the result version after last changes?
There was a problem hiding this comment.
and the bindings pages are not included in the sidebars.js
| ], | ||
| }, | ||
| { | ||
| label: "Cosmos Hub", | ||
| { | ||
| label: 'Slinky', | ||
| type: 'category', | ||
| items: [ | ||
| 'neutron/modules/3rdparty/skip/slinky/overview', | ||
| ] | ||
| } | ||
| ], | ||
| }, | ||
| { | ||
| label: "Cosmos Hub", |
There was a problem hiding this comment.
and the bindings pages are not included in the sidebars.js
| ```rust | ||
| pub enum OracleQuery { | ||
| GetAllCurrencyPairs {}, | ||
| GetPrice { currency_pair: CurrencyPair }, | ||
| GetPrices { currency_pair_ids: Vec<String> }, | ||
| } | ||
| ``` |
There was a problem hiding this comment.
there is a number of unformatted snippets. please apply formatting:
| ```rust | ||
| GetPrice { currency_pair: CurrencyPair } | ||
| ``` | ||
| resp: |
There was a problem hiding this comment.
| resp: | |
| Response: |
TASK
This PR implements some basic docs for bindings, related to
Oracle&MarketMapmodules