@xchainjs/xchain-thorchain-query 0.4.8 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # `@xchainjs/xchain-thorchain-query`
2
2
 
3
- Thorchain-query module to query thorchain for estimation of swaps/ add and remove Liquidity and checking a transaction stage.
3
+ Thorchain-query module to query thorchain for estimation of swaps/ add and remove Liquidity and checking a transaction stage.
4
4
  Returns a TxDetail object with all the information needed to conduct a swap, or add liquidity. This includes estimateAddSavers()
5
5
 
6
6
  ## Installation
@@ -12,7 +12,7 @@ yarn add @xchainjs/xchain-thorchain-query
12
12
  Following peer dependencies have to be installed into your project. These are not included in `@xchainjs/xchain-thorchain-query`.
13
13
 
14
14
  ```
15
- yarn add @xchainjs/xchain-client @xchainjs/xchain-util @xchainjs/xchain-midgard @xchainjs/xchain-thornode axios
15
+ yarn add @xchainjs/xchain-client @xchainjs/xchain-util @xchainjs/xchain-midgard-query @xchainjs/xchain-thornode axios
16
16
 
17
17
  ```
18
18
 
@@ -43,6 +43,7 @@ Estimation example from a swap of 2 BTC to RUNE
43
43
  ```
44
44
 
45
45
  Estimation of add symetric liquidity
46
+
46
47
  ```ts
47
48
  {
48
49
  rune: 'ᚱ 12,000',
@@ -58,6 +59,7 @@ Estimation of add symetric liquidity
58
59
  ```
59
60
 
60
61
  Estimation of remove Liquidity
62
+
61
63
  ```ts
62
64
  {
63
65
  asset: { chain: 'BTC', symbol: 'BTC', ticker: 'BTC', synth: false },
@@ -83,6 +85,7 @@ Estimation of remove Liquidity
83
85
  ```
84
86
 
85
87
  Estimation of Add Saver
88
+
86
89
  ```ts
87
90
  {
88
91
  assetAmount: '₿ 0.5',
@@ -125,7 +128,7 @@ Get Network Values: https://replit.com/@thorchain/networkValues#index.ts\
125
128
 
126
129
  Estimate AddSaver() & WithdrawSaver() & getSaverPosition() https://replit.com/@thorchain/quoteDepositTS#index.ts
127
130
 
128
- Check transaction Stage
131
+ Check transaction Stage
129
132
 
130
133
  ### Setting Headers for Nine Realms endpoints
131
134
 
package/lib/index.d.ts CHANGED
@@ -3,5 +3,6 @@ export * from './thorchain-checktx';
3
3
  export * from './thorchain-cache';
4
4
  export * from './liquidity-pool';
5
5
  export * from './crypto-amount';
6
+ export * from './chain-defaults';
6
7
  export * from './types';
7
8
  export * from './utils';