Merge pull request #42 from xchainjs/docs-14122023

Mayachain docs

Author: 0xp3gasus

xchain-mayachain-amm/available-functions/README.md

@@ -0,0 +1,7 @@
+---
+sort: 3
+---
+
+# Available Functions
+
+{% include list.liquid all=true %}

xchain-mayachain-query/README.md

@@ -1,5 +1,5 @@
 ---
-sort: 3
+sort: 2
 ---
 
 # MAYACHAIN-QUERY

xchain-mayachain-query/available-functions/README.md

@@ -0,0 +1,7 @@
+---
+sort: 3
+---
+
+# Available Functions
+
+{% include list.liquid all=true %}

xchain-mayamidgard-query/README.md

@@ -0,0 +1,9 @@
+---
+sort: 2
+---
+
+# MAYAMIDGARD-QUERY
+
+Custom midgard query package 
+
+{% include list.liquid all=true %}

xchain-mayamidgard-query/available-functions/README.md

@@ -0,0 +1,7 @@
+---
+sort: 3
+---
+
+# Available Functions
+
+{% include list.liquid all=true %}

xchain-mayamidgard-query/how-it-works.md

@@ -0,0 +1,21 @@
+---
+sort: 1
+---
+
+# How it works
+
+Mayachain Midgard-query module use Midgard Api's to query [Midgard API].
+
+Midgard is a layer 2 REST API that provides *front-end consumers with semi real-time* rolled up data
+and analytics of the Mayachain network. Most requests to the network will come through Midgard. This
+daemon is here to keep the chain itself from fielding large quantities of requests. You can think of
+it as a “read-only slave” to the chain. This keeps the resources of the network focused on
+processing transactions.
+
+## Dependencies
+
+* [`@xchainjs/xchain-client`](http://docs.xchainjs.org/xchain-client/interface.html)
+* [`@xchainjs/xchain-util`](http://docs.xchainjs.org/xchain-util/how-to-use.html)
+* [`@xchainjs/xchain-mayamidgard`](http://docs.xchainjs.org/xchain-mayamidgard-query/how-to-use.html)
+
+[Mayachain Midgard API]: https://gitlab.com/thorchain/midgard/-/tree/develop?ref_type=heads

xchain-mayamidgard-query/how-to-use.md

@@ -0,0 +1,42 @@
+---
+sort: 2
+---
+
+# How to use
+
+## Installation
+
+```
+yarn add @xchainjs/xchain-midgard-query
+```
+
+Following peer dependencies have to be installed into your project. These are not included in `@xchainjs/xchain-midgard-query`.
+
+```
+yarn add @xchainjs/xchain-client @xchainjs/xchain-util @xchainjs/xchain-midgard axios axios-retry bignumber.js
+```
+
+## Basic usage examples
+```ts
+import { AssetBTC } from '@xchainjs/xchain-bitcoin'
+import { AssetATOM } from '@xchainjs/xchain-cosmos'
+import { Midgard, MidgardCache, MidgardQuery, SaversPosition } from '@xchainjs/xchain-midgard-query'
+import { Network } from '@xchainjs/xchain-client'
+
+const saverBtc: getSaver = {
+  asset: AssetBTC,
+  address: '',
+}
+const saverAtom: getSaver = {
+  asset: AssetATOM,
+  address: '',
+}
+
+const midgardCache = new MidgardCache(new Midgard(Network.Testnet))
+const midgardQuery = new MidgardQuery(midgardCache)
+// Get saver positions (cached)
+const getSavers: SaversPosition[] = await midgardQuery.getSaverPositions([saverAtom, saverBtc])
+// Get thorname info (no cached)
+const thorname = await midgardQuery.midgardCache.midgard.getTHORNameDetails('gx')
+```
+

xchain-mayamidgard/README.md

@@ -1,5 +1,5 @@
 ---
-sort: 3
+sort: 2
 ---
 
 # XCHAIN MAYAMIDGARD

xchain-mayamidgard/available-functions/README.md

@@ -0,0 +1,7 @@
+---
+sort: 3
+---
+
+# Available Functions
+
+{% include list.liquid all=true %}