@xchainjs/xchain-thorchain-query 0.1.9 → 0.1.11

package/README.md

@@ -62,3 +62,24 @@ List pools: https://replit.com/@thorchain/listPools#package.json\
 Get Network Values: https://replit.com/@thorchain/networkValues#index.ts\
 
 Estimate AddSaver() & WithdrawSaver() & getSaverPosition() https://replit.com/@thorchain/quoteDepositTS#index.ts
+
+### Setting Headers for Nine Realms endpoints
+
+If you plan on using the publically accessible endpoints provided by Nine Realms(listed below), ensure that you add a valid 'x-client-id' to all requests
+
+- https://midgard.ninerealms.com
+- https://haskoin.ninerealms.com (BTC/BCH/LTC)
+- https://thornode.ninerealms.com
+
+Example
+
+```typescript
+import cosmosclient from '@cosmos-client/core'
+import axios from 'axios'
+import { register9Rheader } from '@xchainjs/xchain-util'
+
+register9Rheader(axios)
+register9Rheader(cosmosclient.config.globalAxios)
+```
+
+For a complete example please see this [test](https://github.com/xchainjs/xchainjs-lib/blob/master/packages/xchain-thorchain-amm/__e2e__/wallet.e2e.ts)

package/lib/index.esm.js

@@ -1,4 +1,4 @@
-import { assetToBase, formatAssetAmountCurrency, baseToAsset, eqAsset, assetToString, assetFromString, baseAmount, AssetRuneNative, Chain, AssetAtom, AssetAVAX, AssetETH, AssetBNB, AssetDOGE, AssetLTC, AssetBCH, AssetBTC, AvalancheChain, DOGEChain, LTCChain, BCHChain, CosmosChain, THORChain, ETHChain, BTCChain, BNBChain, assetFromStringEx, isAssetRuneNative, assetAmount } from '@xchainjs/xchain-util';
+import { assetToBase, formatAssetAmountCurrency, baseToAsset, eqAsset, assetToString, assetFromString, baseAmount, AssetRuneNative, Chain, AssetAtom, AssetAVAX, AssetETH, AssetBNB, AssetDOGE, AssetLTC, AssetBCH, AssetBTC, AvalancheChain, DOGEChain, LTCChain, BCHChain, CosmosChain, THORChain, ETHChain, BTCChain, BNBChain, assetFromStringEx, isAssetRuneNative, getContractAddressFromAsset, assetAmount } from '@xchainjs/xchain-util';
 import { BigNumber } from 'bignumber.js';
 import { Network } from '@xchainjs/xchain-client';
 import { MidgardApi, Configuration } from '@xchainjs/xchain-midgard';
@@ -1597,6 +1597,15 @@ class ThorchainQuery {
             return swapEstimate;
         });
     }
+    abbreviateAssetString(asset) {
+        const contractAddress = getContractAddressFromAsset(asset);
+        if (contractAddress && contractAddress.length > 5) {
+            const abrev = contractAddress.substring(contractAddress.length - 5);
+            const sep = asset.chain !== Chain.THORChain && asset.synth ? '/' : '.';
+            return `${asset.chain}${sep}${asset.ticker}-${abrev}`;
+        }
+        return assetToString(asset);
+    }
     /**
      *
      * @param params - swap object
@@ -1605,21 +1614,16 @@ class ThorchainQuery {
     constructSwapMemo(params) {
         var _a;
         const limstring = params.limit.amount().toFixed();
-        // create LIM with interface ID
         const lim = limstring.substring(0, limstring.length - 3).concat(params.interfaceID);
-        // create the full memo
-        let memo = `=:${assetToString(params.destinationAsset)}`;
+        let memo = `=:${this.abbreviateAssetString(params.destinationAsset)}:${params.destinationAddress}:${lim}`;
         // NOTE: we should validate affiliate address is EITHER: a thorname or valid thorchain address, currently we cannot do this without importing xchain-thorchain
         if (((_a = params.affiliateAddress) === null || _a === void 0 ? void 0 : _a.length) > 0) {
             // NOTE: we should validate destinationAddress address is valid destination address for the asset type requested
-            memo = memo.concat(`:${params.destinationAddress}:${lim}:${params.affiliateAddress}:${params.affiliateFeeBasisPoints}`);
-        }
-        else {
-            memo = memo.concat(`:${params.destinationAddress}:${lim}`);
+            memo = memo.concat(`:${params.affiliateAddress}:${params.affiliateFeeBasisPoints}`);
         }
         // If memo length is too long for BTC, trim it
         if (eqAsset(params.input.asset, AssetBTC) && memo.length > 80) {
-            memo = `=:${assetToString(params.destinationAsset)}:${params.destinationAddress}`;
+            memo = `=:${this.abbreviateAssetString(params.destinationAsset)}:${params.destinationAddress}:${lim}`;
         }
         return memo;
     }

package/lib/index.js

@@ -1606,6 +1606,15 @@ class ThorchainQuery {
             return swapEstimate;
         });
     }
+    abbreviateAssetString(asset) {
+        const contractAddress = xchainUtil.getContractAddressFromAsset(asset);
+        if (contractAddress && contractAddress.length > 5) {
+            const abrev = contractAddress.substring(contractAddress.length - 5);
+            const sep = asset.chain !== xchainUtil.Chain.THORChain && asset.synth ? '/' : '.';
+            return `${asset.chain}${sep}${asset.ticker}-${abrev}`;
+        }
+        return xchainUtil.assetToString(asset);
+    }
     /**
      *
      * @param params - swap object
@@ -1614,21 +1623,16 @@ class ThorchainQuery {
     constructSwapMemo(params) {
         var _a;
         const limstring = params.limit.amount().toFixed();
-        // create LIM with interface ID
         const lim = limstring.substring(0, limstring.length - 3).concat(params.interfaceID);
-        // create the full memo
-        let memo = `=:${xchainUtil.assetToString(params.destinationAsset)}`;
+        let memo = `=:${this.abbreviateAssetString(params.destinationAsset)}:${params.destinationAddress}:${lim}`;
         // NOTE: we should validate affiliate address is EITHER: a thorname or valid thorchain address, currently we cannot do this without importing xchain-thorchain
         if (((_a = params.affiliateAddress) === null || _a === void 0 ? void 0 : _a.length) > 0) {
             // NOTE: we should validate destinationAddress address is valid destination address for the asset type requested
-            memo = memo.concat(`:${params.destinationAddress}:${lim}:${params.affiliateAddress}:${params.affiliateFeeBasisPoints}`);
-        }
-        else {
-            memo = memo.concat(`:${params.destinationAddress}:${lim}`);
+            memo = memo.concat(`:${params.affiliateAddress}:${params.affiliateFeeBasisPoints}`);
         }
         // If memo length is too long for BTC, trim it
         if (xchainUtil.eqAsset(params.input.asset, xchainUtil.AssetBTC) && memo.length > 80) {
-            memo = `=:${xchainUtil.assetToString(params.destinationAsset)}:${params.destinationAddress}`;
+            memo = `=:${this.abbreviateAssetString(params.destinationAsset)}:${params.destinationAddress}:${lim}`;
         }
         return memo;
     }

package/lib/thorchain-query.d.ts

@@ -45,6 +45,7 @@ export declare class ThorchainQuery {
      * @returns
      */
     private calcSwapEstimate;
+    private abbreviateAssetString;
     /**
      *
      * @param params - swap object

package/lib/types.d.ts

@@ -1,5 +1,5 @@
 import { FeeOption } from '@xchainjs/xchain-client';
-import { LiquidityProvider } from '@xchainjs/xchain-thornode';
+import { LiquidityProviderSummary } from '@xchainjs/xchain-thornode';
 import { Address, Asset, BaseAmount, Chain } from '@xchainjs/xchain-util';
 import { BigNumber } from 'bignumber.js';
 import { CryptoAmount } from './crypto-amount';
@@ -168,7 +168,7 @@ export declare type WithdrawLiquidityPosition = {
 };
 export declare type LiquidityPosition = {
     poolShare: PoolShareDetail;
-    position: LiquidityProvider;
+    position: LiquidityProviderSummary;
     lpGrowth: string;
     impermanentLossProtection: ILProtectionData;
 };

package/lib/utils/thornode.d.ts

@@ -1,5 +1,5 @@
 import { Network } from '@xchainjs/xchain-client';
-import { InboundAddress, LastBlock, LiquidityProvider, LiquidityProviderResponse, Pool, QuoteSaverDepositResponse, QuoteSaverWithdrawResponse, QuoteSwapResponse, TxOutItem, TxResponse } from '@xchainjs/xchain-thornode';
+import { InboundAddress, LastBlock, LiquidityProviderSummary, Pool, QuoteSaverDepositResponse, QuoteSaverWithdrawResponse, QuoteSwapResponse, SaverResponse, TxOutItem, TxResponse } from '@xchainjs/xchain-thornode';
 import { SaversWithdraw } from '../types';
 export declare type ThornodeConfig = {
     apiRetries: number;
@@ -48,7 +48,7 @@ export declare class Thornode {
      * @param height - optional block height, defaults to current tip
      * @returns
      */
-    getLiquidityProvider(asset: string, address: string, height?: number): Promise<LiquidityProvider | undefined>;
+    getLiquidityProvider(asset: string, address: string, height?: number): Promise<LiquidityProviderSummary | undefined>;
     /**
      *
      * @param asset - asset string
@@ -63,14 +63,14 @@ export declare class Thornode {
      * @param height - optional thorchain block height parameter
      * @returns - Liquidity Provider Object
      */
-    getSavers(asset: string, height?: number): Promise<LiquidityProviderResponse>;
+    getSavers(asset: string, height?: number): Promise<SaverResponse>;
     /**
      *
      * @param asset - asset string
      * @param height - optional thorchain block height parameter
      * @returns - Liquidity Provider Object
      */
-    getSaver(asset: string, address: string, height?: number): Promise<LiquidityProviderResponse>;
+    getSaver(asset: string, address: string, height?: number): Promise<SaverResponse>;
     /**
      *
      * @param asset - asset to add to savers

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-query",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "license": "MIT",
   "description": "Thorchain query module that is resposible for estimating swap calculations and add/remove liquidity for thorchain ",
   "keywords": [
@@ -33,7 +33,7 @@
     "postversion": "git push --follow-tags"
   },
   "devDependencies": {
-    "@xchainjs/xchain-client": "^0.13.3",
+    "@xchainjs/xchain-client": "^0.13.4",
     "@xchainjs/xchain-midgard": "^0.4.0",
     "@xchainjs/xchain-thornode": "^0.1.3",
     "@xchainjs/xchain-util": "^0.11.0",
@@ -43,10 +43,10 @@
     "rimraf": "~3.0.2"
   },
   "peerDependencies": {
-    "@xchainjs/xchain-client": "^0.13.3",
-    "@xchainjs/xchain-midgard": "^0.3.0",
-    "@xchainjs/xchain-thornode": "^0.1.2",
-    "@xchainjs/xchain-util": "^0.11.0",
+    "@xchainjs/xchain-client": "^0.13.4",
+    "@xchainjs/xchain-midgard": "^0.4.1",
+    "@xchainjs/xchain-thornode": "^0.1.5",
+    "@xchainjs/xchain-util": "^0.11.1",
     "axios": "^0.25.0",
     "axios-retry": "^3.2.5",
     "bignumber.js": "^9.0.0",