@xchainjs/xchain-thorchain-amm 0.3.1 → 0.3.3

package/README.md

@@ -54,6 +54,11 @@ Following peer dependencies have to be installed into your project. These are no
 [How thorchain-amm works](http://docs.xchainjs.org/xchain-thorchain-amm/how-it-works.html)\
 [How to use thorchain-amm](http://docs.xchainjs.org/xchain-thorchain-amm/how-to-use.html)
 
+For live examples
+[Do Swap](https://replit.com/@thorchain/doSwap-Single)
+[Add Liquidity](https://replit.com/@thorchain/addLiquidity)
+[Withdraw liquidity](https://replit.com/@thorchain/removeLiquidity)
+
 ##
 
 tsconfig compiler options

package/lib/index.esm.js

@@ -8,10 +8,10 @@ import { Client as Client$2 } from '@xchainjs/xchain-doge';
 import { MAX_APPROVAL, ETH_DECIMAL, Client as Client$3 } from '@xchainjs/xchain-ethereum';
 import { Client as Client$5 } from '@xchainjs/xchain-litecoin';
 import { Client as Client$4 } from '@xchainjs/xchain-thorchain';
-import { eqAsset, AssetETH, getContractAddressFromAsset, baseAmount, Chain, assetToString, AssetBTC } from '@xchainjs/xchain-util';
+import { eqAsset, AssetETH, getContractAddressFromAsset, baseAmount, Chain } from '@xchainjs/xchain-util';
 import { ethers } from 'ethers';
 import { MAX_APPROVAL as MAX_APPROVAL$1 } from '@xchainjs/xchain-evm';
-import { BigNumber } from 'bignumber.js';
+import { ThorchainQuery } from '@xchainjs/xchain-thorchain-query';
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -676,24 +676,10 @@ class Wallet {
             }
         });
     }
-    constructSwapMemo(swap) {
-        const limstring = swap.limit.amount().toFixed();
-        // create LIM with interface ID
-        const lim = limstring.substring(0, limstring.length - 3).concat(swap.interfaceID.toString());
-        // create the full memo
-        let memo = `=:${assetToString(swap.destinationAsset)}`;
-        if (swap.affiliateAddress != '' || swap.affiliateFee == undefined) {
-            memo = memo.concat(`:${swap.destinationAddress}:${lim}:${swap.affiliateAddress}:${swap.affiliateFee.amount().toFixed()}`);
-        }
-        else {
-            memo = memo.concat(`:${swap.destinationAddress}:${lim}`);
-        }
-        // If memo length is too long for BTC, trim it
-        if (eqAsset(swap.input.asset, AssetBTC) && memo.length > 80) {
-            memo = `=:${assetToString(swap.destinationAsset)}:${swap.destinationAddress}`;
-        }
-        return memo;
-    }
+    /** Validate swap object
+     *
+     * @param swap  - swap parameters
+     */
     validateSwap(swap) {
         const errors = [];
         const isThorchainDestinationAsset = swap.destinationAsset.synth || swap.destinationAsset.chain === Chain.THORChain;
@@ -701,11 +687,31 @@ class Wallet {
         if (!this.clients[chain].validateAddress(swap.destinationAddress)) {
             errors.push(`destinationAddress ${swap.destinationAddress} is not a valid address`);
         }
-        if (swap.affiliateAddress && !this.clients[Chain.THORChain].validateAddress(swap.affiliateAddress))
-            errors.push(`affiliateAddress ${swap.affiliateAddress} is not a valid address`);
+        // Affiliate address should be THORName or THORAddress
+        const checkAffiliateAddress = swap.memo.split(':');
+        if (checkAffiliateAddress.length > 4) {
+            const affiliateAddress = checkAffiliateAddress[4];
+            if (affiliateAddress.length > 0) {
+                const isValidThorchainAddress = this.clients[Chain.THORChain].validateAddress(affiliateAddress);
+                const isValidThorname = this.isThorname(affiliateAddress);
+                if (!(isValidThorchainAddress || isValidThorname))
+                    errors.push(`affiliateAddress ${affiliateAddress} is not a valid THOR address`);
+            }
+        }
         if (errors.length > 0)
             throw Error(errors.join('\n'));
     }
+    isThorname(name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const thornameDetails = yield this.thorchainQuery.thorchainCache.midgard.getTHORNameDetails(name);
+            return thornameDetails !== undefined;
+        });
+    }
+    /** Function handles all swaps from Rune to asset
+     *
+     * @param swap - swap parameters
+     * @returns - tx submitted object
+     */
     swapRuneTo(swap) {
         return __awaiter(this, void 0, void 0, function* () {
             const thorClient = this.clients.THOR;
@@ -713,11 +719,16 @@ class Wallet {
             const hash = yield thorClient.deposit({
                 amount: swap.input.baseAmount,
                 asset: swap.input.asset,
-                memo: this.constructSwapMemo(swap),
+                memo: swap.memo,
             });
             return { hash, url: this.clients.THOR.getExplorerTxUrl(hash), waitTimeSeconds };
         });
     }
+    /** Function handles all swaps from Non Rune
+     *
+     * @param swap - swap object
+     * @returns - TxSubmitted object
+     */
     swapNonRune(swap) {
         return __awaiter(this, void 0, void 0, function* () {
             const client = this.clients[swap.input.asset.chain];
@@ -731,7 +742,7 @@ class Wallet {
                     asset: swap.input.asset,
                     amount: swap.input.baseAmount,
                     feeOption: swap.feeOption || FeeOption.Fast,
-                    memo: this.constructSwapMemo(swap),
+                    memo: swap.memo,
                 };
                 const hash = yield this.ethHelper.sendDeposit(params);
                 return { hash, url: client.getExplorerTxUrl(hash), waitTimeSeconds };
@@ -742,7 +753,7 @@ class Wallet {
                     asset: swap.input.asset,
                     amount: swap.input.baseAmount,
                     feeOption: swap.feeOption || FeeOption.Fast,
-                    memo: this.constructSwapMemo(swap),
+                    memo: swap.memo,
                 };
                 const evmHelper = new EvmHelper(this.clients.AVAX, this.thorchainQuery.thorchainCache);
                 const hash = yield evmHelper.sendDeposit(params);
@@ -754,15 +765,15 @@ class Wallet {
                     asset: swap.input.asset,
                     amount: swap.input.baseAmount,
                     recipient: inbound.address,
-                    memo: this.constructSwapMemo(swap),
+                    memo: swap.memo,
                 };
                 const hash = yield client.transfer(params);
                 return { hash, url: client.getExplorerTxUrl(hash), waitTimeSeconds };
             }
         });
     }
-    /** BASED OFF https://dev.thorchain.or›g/thorchain-dev/network/memos
-     *
+    /** Function handles liquidity Add
+     * BASED OFF https://dev.thorchain.or›g/thorchain-dev/network/memos
      * @param params input parameters needed to add liquidity
      * @returns transaction details submitted
      */
@@ -799,12 +810,12 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity Withdraw
      *
      * @param params - parameters required for liquidity position
      * @returns object with tx response, url and wait time in seconds
      */
-    removeLiquidity(params) {
+    withdrawLiquidity(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const assetClient = this.clients[params.assetFee.asset.chain];
             const inboundAsgard = (yield this.thorchainQuery.thorchainCache.getInboundDetails())[params.assetFee.asset.chain]
@@ -816,26 +827,26 @@ class Wallet {
             const txSubmitted = [];
             if (params.assetAddress && params.runeAddress) {
                 constructedMemo = `-:${params.assetPool}:${basisPoints}`;
-                txSubmitted.push(yield this.removeAssetLP(params, constructedMemo, assetClient, waitTimeSeconds, inboundAsgard));
+                txSubmitted.push(yield this.withdrawAssetLP(params, constructedMemo, assetClient, waitTimeSeconds, inboundAsgard));
                 constructedMemo = `-:${params.assetPool}:${basisPoints}`;
-                txSubmitted.push(yield this.removeRuneLP(params, constructedMemo, thorchainClient, waitTimeSeconds));
+                txSubmitted.push(yield this.withdrawRuneLP(params, constructedMemo, thorchainClient, waitTimeSeconds));
                 return txSubmitted;
             }
             else if (params.assetAddress && !params.runeAddress) {
                 // asymmetrical asset only
                 constructedMemo = `-:${params.assetPool}:${basisPoints}`;
-                txSubmitted.push(yield this.removeAssetLP(params, constructedMemo, assetClient, waitTimeSeconds, inboundAsgard));
+                txSubmitted.push(yield this.withdrawAssetLP(params, constructedMemo, assetClient, waitTimeSeconds, inboundAsgard));
                 return txSubmitted;
             }
             else {
                 // asymmetrical rune only
                 constructedMemo = `-:${params.assetPool}:${basisPoints}`;
-                txSubmitted.push(yield this.removeRuneLP(params, constructedMemo, thorchainClient, waitTimeSeconds));
+                txSubmitted.push(yield this.withdrawRuneLP(params, constructedMemo, thorchainClient, waitTimeSeconds));
                 return txSubmitted;
             }
         });
     }
-    /**
+    /** Function handles liquidity add for all non rune assets
      *
      * @param params - parameters for add liquidity
      * @param constructedMemo - memo needed for thorchain
@@ -888,31 +899,31 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity Withdraw for Non rune assets
      *
-     * @param params - parameters for remove liquidity
+     * @param params - parameters for withdraw liquidity
      * @param constructedMemo - memo needed for thorchain execution
      * @param assetClient - asset client to call transfer
      * @param waitTimeSeconds - return back estimated wait
      * @param inboundAsgard - destination address
      * @returns - tx object
      */
-    removeAssetLP(params, constructedMemo, assetClient, waitTimeSeconds, inboundAsgard) {
+    withdrawAssetLP(params, constructedMemo, assetClient, waitTimeSeconds, inboundAsgard) {
         return __awaiter(this, void 0, void 0, function* () {
             if (params.assetFee.asset.chain === Chain.Ethereum) {
-                const removeParams = {
+                const withdrawParams = {
                     wallIndex: 0,
                     asset: params.assetFee.asset,
                     amount: params.assetFee.baseAmount,
                     feeOption: FeeOption.Fast,
                     memo: constructedMemo,
                 };
-                // console.log(removeParams.amount.amount().toNumber())
-                const hash = yield this.ethHelper.sendDeposit(removeParams);
+                // console.log(withdrawParams.amount.amount().toNumber())
+                const hash = yield this.ethHelper.sendDeposit(withdrawParams);
                 return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
             }
             else if (params.assetFee.asset.chain === Chain.Avalanche) {
-                const removeParams = {
+                const withdrawParams = {
                     wallIndex: 0,
                     asset: params.assetFee.asset,
                     amount: params.assetFee.baseAmount,
@@ -920,11 +931,11 @@ class Wallet {
                     memo: constructedMemo,
                 };
                 const evmHelper = new EvmHelper(this.clients.AVAX, this.thorchainQuery.thorchainCache);
-                const hash = yield evmHelper.sendDeposit(removeParams);
+                const hash = yield evmHelper.sendDeposit(withdrawParams);
                 return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
             }
             else {
-                const removeParams = {
+                const withdrawParams = {
                     wallIndex: 0,
                     asset: params.assetFee.asset,
                     amount: params.assetFee.baseAmount,
@@ -932,7 +943,7 @@ class Wallet {
                     memo: constructedMemo,
                 };
                 try {
-                    const hash = yield assetClient.transfer(removeParams);
+                    const hash = yield assetClient.transfer(withdrawParams);
                     return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
                 }
                 catch (err) {
@@ -942,7 +953,7 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity Add for Rune only
      *
      * @param params - deposit parameters
      * @param memo - memo needed to withdraw lp
@@ -956,18 +967,17 @@ class Wallet {
                 amount: params.rune.baseAmount,
                 memo: memo,
             };
-            // console.log(addParams)
             const hash = yield thorClient.deposit(addParams);
             return { hash, url: thorchainClient.getExplorerTxUrl(hash), waitTimeSeconds };
         });
     }
-    /**
+    /** Function handles liquidity Withdraw for Rune only
      *
-     * @param params - remove parameters
+     * @param params - withdraw parameters
      * @param memo - memo needed to withdraw lp
      * @returns - tx object
      */
-    removeRuneLP(params, memo, thorchainClient, waitTimeSeconds) {
+    withdrawRuneLP(params, memo, thorchainClient, waitTimeSeconds) {
         return __awaiter(this, void 0, void 0, function* () {
             const thorClient = this.clients.THOR;
             const addParams = {
@@ -975,14 +985,13 @@ class Wallet {
                 amount: params.runeFee.baseAmount,
                 memo: memo,
             };
-            // console.log(addParams)
             const hash = yield thorClient.deposit(addParams);
             return { hash, url: thorchainClient.getExplorerTxUrl(hash), waitTimeSeconds };
         });
     }
 }
 
-const BN_1 = new BigNumber(1);
+const defaultQuery = new ThorchainQuery();
 /**
  * THORChain Class for interacting with THORChain.
  * Recommended main class to use for swapping with THORChain
@@ -995,7 +1004,7 @@ class ThorchainAMM {
      * @param thorchainQuery - an instance of the ThorchainQuery
      * @returns ThorchainAMM
      */
-    constructor(thorchainQuery) {
+    constructor(thorchainQuery = defaultQuery) {
         this.thorchainQuery = thorchainQuery;
     }
     /**
@@ -1026,32 +1035,40 @@ class ThorchainAMM {
      */
     doSwap(wallet, params) {
         return __awaiter(this, void 0, void 0, function* () {
-            // TODO validate all input fields
+            // Thorchain-query call satisfies the data needed for executeSwap to be called.
             const txDetails = yield this.thorchainQuery.estimateSwap(params);
             if (!txDetails.txEstimate.canSwap) {
                 throw Error(txDetails.txEstimate.errors.join('\n'));
             }
-            // remove any affiliateFee. netInput * affiliateFee (%age) of the destination asset type
-            const affiliateFee = params.input.baseAmount.times(params.affiliateFeePercent || 0);
-            // Work out LIM from the slip percentage
-            let limPercentage = BN_1;
-            if (params.slipLimit) {
-                limPercentage = BN_1.minus(params.slipLimit || 1);
-            } // else allowed slip is 100%
-            const limAssetAmount = txDetails.txEstimate.netOutput.times(limPercentage);
-            const waitTimeSeconds = txDetails.txEstimate.waitTimeSeconds;
             return yield wallet.executeSwap({
                 input: params.input,
                 destinationAsset: params.destinationAsset,
-                limit: limAssetAmount.baseAmount,
                 destinationAddress: params.destinationAddress,
-                affiliateAddress: params.affiliateAddress || '',
-                affiliateFee,
-                interfaceID: params.interfaceID || 999,
-                waitTimeSeconds,
+                memo: txDetails.memo,
+                waitTimeSeconds: txDetails.txEstimate.waitTimeSeconds,
             });
         });
     }
+    /**
+     * Wraps estimate from thorchain query
+     * @param params - estimate add liquidity
+     * @returns - Estimate add lp object
+     */
+    estimateAddLiquidity(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.thorchainQuery.estimateAddLP(params);
+        });
+    }
+    /**
+     * Wraps estimate withdraw from thorchain query
+     * @param params - estimate withdraw liquidity
+     * @returns - Estimate withdraw lp object
+     */
+    estimateWithdrawLiquidity(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.thorchainQuery.estimateWithdrawLP(params);
+        });
+    }
     /**
      *
      * @param wallet - wallet class
@@ -1062,6 +1079,8 @@ class ThorchainAMM {
         return __awaiter(this, void 0, void 0, function* () {
             // Check amounts are greater than fees and use return estimated wait
             const checkLPAdd = yield this.thorchainQuery.estimateAddLP(params);
+            if (!checkLPAdd.canAdd)
+                throw Error(`${checkLPAdd.errors}`);
             return wallet.addLiquidity({
                 asset: params.asset,
                 rune: params.rune,
@@ -1076,11 +1095,11 @@ class ThorchainAMM {
      * @param wallet - wallet needed to perform tx
      * @return
      */
-    removeLiquidityPosition(wallet, params) {
+    withdrawLiquidityPosition(wallet, params) {
         return __awaiter(this, void 0, void 0, function* () {
             // Caution Dust Limits: BTC,BCH,LTC chains 10k sats; DOGE 1m Sats; ETH 0 wei; THOR 0 RUNE.
             const withdrawParams = yield this.thorchainQuery.estimateWithdrawLP(params);
-            return wallet.removeLiquidity({
+            return wallet.withdrawLiquidity({
                 assetFee: withdrawParams.transactionFee.assetFee,
                 runeFee: withdrawParams.transactionFee.runeFee,
                 waitTimeSeconds: withdrawParams.estimatedWaitSeconds,

package/lib/index.js

@@ -15,7 +15,7 @@ var xchainThorchain = require('@xchainjs/xchain-thorchain');
 var xchainUtil = require('@xchainjs/xchain-util');
 var ethers = require('ethers');
 var xchainEvm = require('@xchainjs/xchain-evm');
-var bignumber_js = require('bignumber.js');
+var xchainThorchainQuery = require('@xchainjs/xchain-thorchain-query');
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -680,24 +680,10 @@ class Wallet {
             }
         });
     }
-    constructSwapMemo(swap) {
-        const limstring = swap.limit.amount().toFixed();
-        // create LIM with interface ID
-        const lim = limstring.substring(0, limstring.length - 3).concat(swap.interfaceID.toString());
-        // create the full memo
-        let memo = `=:${xchainUtil.assetToString(swap.destinationAsset)}`;
-        if (swap.affiliateAddress != '' || swap.affiliateFee == undefined) {
-            memo = memo.concat(`:${swap.destinationAddress}:${lim}:${swap.affiliateAddress}:${swap.affiliateFee.amount().toFixed()}`);
-        }
-        else {
-            memo = memo.concat(`:${swap.destinationAddress}:${lim}`);
-        }
-        // If memo length is too long for BTC, trim it
-        if (xchainUtil.eqAsset(swap.input.asset, xchainUtil.AssetBTC) && memo.length > 80) {
-            memo = `=:${xchainUtil.assetToString(swap.destinationAsset)}:${swap.destinationAddress}`;
-        }
-        return memo;
-    }
+    /** Validate swap object
+     *
+     * @param swap  - swap parameters
+     */
     validateSwap(swap) {
         const errors = [];
         const isThorchainDestinationAsset = swap.destinationAsset.synth || swap.destinationAsset.chain === xchainUtil.Chain.THORChain;
@@ -705,11 +691,31 @@ class Wallet {
         if (!this.clients[chain].validateAddress(swap.destinationAddress)) {
             errors.push(`destinationAddress ${swap.destinationAddress} is not a valid address`);
         }
-        if (swap.affiliateAddress && !this.clients[xchainUtil.Chain.THORChain].validateAddress(swap.affiliateAddress))
-            errors.push(`affiliateAddress ${swap.affiliateAddress} is not a valid address`);
+        // Affiliate address should be THORName or THORAddress
+        const checkAffiliateAddress = swap.memo.split(':');
+        if (checkAffiliateAddress.length > 4) {
+            const affiliateAddress = checkAffiliateAddress[4];
+            if (affiliateAddress.length > 0) {
+                const isValidThorchainAddress = this.clients[xchainUtil.Chain.THORChain].validateAddress(affiliateAddress);
+                const isValidThorname = this.isThorname(affiliateAddress);
+                if (!(isValidThorchainAddress || isValidThorname))
+                    errors.push(`affiliateAddress ${affiliateAddress} is not a valid THOR address`);
+            }
+        }
         if (errors.length > 0)
             throw Error(errors.join('\n'));
     }
+    isThorname(name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const thornameDetails = yield this.thorchainQuery.thorchainCache.midgard.getTHORNameDetails(name);
+            return thornameDetails !== undefined;
+        });
+    }
+    /** Function handles all swaps from Rune to asset
+     *
+     * @param swap - swap parameters
+     * @returns - tx submitted object
+     */
     swapRuneTo(swap) {
         return __awaiter(this, void 0, void 0, function* () {
             const thorClient = this.clients.THOR;
@@ -717,11 +723,16 @@ class Wallet {
             const hash = yield thorClient.deposit({
                 amount: swap.input.baseAmount,
                 asset: swap.input.asset,
-                memo: this.constructSwapMemo(swap),
+                memo: swap.memo,
             });
             return { hash, url: this.clients.THOR.getExplorerTxUrl(hash), waitTimeSeconds };
         });
     }
+    /** Function handles all swaps from Non Rune
+     *
+     * @param swap - swap object
+     * @returns - TxSubmitted object
+     */
     swapNonRune(swap) {
         return __awaiter(this, void 0, void 0, function* () {
             const client = this.clients[swap.input.asset.chain];
@@ -735,7 +746,7 @@ class Wallet {
                     asset: swap.input.asset,
                     amount: swap.input.baseAmount,
                     feeOption: swap.feeOption || xchainClient.FeeOption.Fast,
-                    memo: this.constructSwapMemo(swap),
+                    memo: swap.memo,
                 };
                 const hash = yield this.ethHelper.sendDeposit(params);
                 return { hash, url: client.getExplorerTxUrl(hash), waitTimeSeconds };
@@ -746,7 +757,7 @@ class Wallet {
                     asset: swap.input.asset,
                     amount: swap.input.baseAmount,
                     feeOption: swap.feeOption || xchainClient.FeeOption.Fast,
-                    memo: this.constructSwapMemo(swap),
+                    memo: swap.memo,
                 };
                 const evmHelper = new EvmHelper(this.clients.AVAX, this.thorchainQuery.thorchainCache);
                 const hash = yield evmHelper.sendDeposit(params);
@@ -758,15 +769,15 @@ class Wallet {
                     asset: swap.input.asset,
                     amount: swap.input.baseAmount,
                     recipient: inbound.address,
-                    memo: this.constructSwapMemo(swap),
+                    memo: swap.memo,
                 };
                 const hash = yield client.transfer(params);
                 return { hash, url: client.getExplorerTxUrl(hash), waitTimeSeconds };
             }
         });
     }
-    /** BASED OFF https://dev.thorchain.or›g/thorchain-dev/network/memos
-     *
+    /** Function handles liquidity Add
+     * BASED OFF https://dev.thorchain.or›g/thorchain-dev/network/memos
      * @param params input parameters needed to add liquidity
      * @returns transaction details submitted
      */
@@ -803,12 +814,12 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity Withdraw
      *
      * @param params - parameters required for liquidity position
      * @returns object with tx response, url and wait time in seconds
      */
-    removeLiquidity(params) {
+    withdrawLiquidity(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const assetClient = this.clients[params.assetFee.asset.chain];
             const inboundAsgard = (yield this.thorchainQuery.thorchainCache.getInboundDetails())[params.assetFee.asset.chain]
@@ -820,26 +831,26 @@ class Wallet {
             const txSubmitted = [];
             if (params.assetAddress && params.runeAddress) {
                 constructedMemo = `-:${params.assetPool}:${basisPoints}`;
-                txSubmitted.push(yield this.removeAssetLP(params, constructedMemo, assetClient, waitTimeSeconds, inboundAsgard));
+                txSubmitted.push(yield this.withdrawAssetLP(params, constructedMemo, assetClient, waitTimeSeconds, inboundAsgard));
                 constructedMemo = `-:${params.assetPool}:${basisPoints}`;
-                txSubmitted.push(yield this.removeRuneLP(params, constructedMemo, thorchainClient, waitTimeSeconds));
+                txSubmitted.push(yield this.withdrawRuneLP(params, constructedMemo, thorchainClient, waitTimeSeconds));
                 return txSubmitted;
             }
             else if (params.assetAddress && !params.runeAddress) {
                 // asymmetrical asset only
                 constructedMemo = `-:${params.assetPool}:${basisPoints}`;
-                txSubmitted.push(yield this.removeAssetLP(params, constructedMemo, assetClient, waitTimeSeconds, inboundAsgard));
+                txSubmitted.push(yield this.withdrawAssetLP(params, constructedMemo, assetClient, waitTimeSeconds, inboundAsgard));
                 return txSubmitted;
             }
             else {
                 // asymmetrical rune only
                 constructedMemo = `-:${params.assetPool}:${basisPoints}`;
-                txSubmitted.push(yield this.removeRuneLP(params, constructedMemo, thorchainClient, waitTimeSeconds));
+                txSubmitted.push(yield this.withdrawRuneLP(params, constructedMemo, thorchainClient, waitTimeSeconds));
                 return txSubmitted;
             }
         });
     }
-    /**
+    /** Function handles liquidity add for all non rune assets
      *
      * @param params - parameters for add liquidity
      * @param constructedMemo - memo needed for thorchain
@@ -892,31 +903,31 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity Withdraw for Non rune assets
      *
-     * @param params - parameters for remove liquidity
+     * @param params - parameters for withdraw liquidity
      * @param constructedMemo - memo needed for thorchain execution
      * @param assetClient - asset client to call transfer
      * @param waitTimeSeconds - return back estimated wait
      * @param inboundAsgard - destination address
      * @returns - tx object
      */
-    removeAssetLP(params, constructedMemo, assetClient, waitTimeSeconds, inboundAsgard) {
+    withdrawAssetLP(params, constructedMemo, assetClient, waitTimeSeconds, inboundAsgard) {
         return __awaiter(this, void 0, void 0, function* () {
             if (params.assetFee.asset.chain === xchainUtil.Chain.Ethereum) {
-                const removeParams = {
+                const withdrawParams = {
                     wallIndex: 0,
                     asset: params.assetFee.asset,
                     amount: params.assetFee.baseAmount,
                     feeOption: xchainClient.FeeOption.Fast,
                     memo: constructedMemo,
                 };
-                // console.log(removeParams.amount.amount().toNumber())
-                const hash = yield this.ethHelper.sendDeposit(removeParams);
+                // console.log(withdrawParams.amount.amount().toNumber())
+                const hash = yield this.ethHelper.sendDeposit(withdrawParams);
                 return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
             }
             else if (params.assetFee.asset.chain === xchainUtil.Chain.Avalanche) {
-                const removeParams = {
+                const withdrawParams = {
                     wallIndex: 0,
                     asset: params.assetFee.asset,
                     amount: params.assetFee.baseAmount,
@@ -924,11 +935,11 @@ class Wallet {
                     memo: constructedMemo,
                 };
                 const evmHelper = new EvmHelper(this.clients.AVAX, this.thorchainQuery.thorchainCache);
-                const hash = yield evmHelper.sendDeposit(removeParams);
+                const hash = yield evmHelper.sendDeposit(withdrawParams);
                 return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
             }
             else {
-                const removeParams = {
+                const withdrawParams = {
                     wallIndex: 0,
                     asset: params.assetFee.asset,
                     amount: params.assetFee.baseAmount,
@@ -936,7 +947,7 @@ class Wallet {
                     memo: constructedMemo,
                 };
                 try {
-                    const hash = yield assetClient.transfer(removeParams);
+                    const hash = yield assetClient.transfer(withdrawParams);
                     return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
                 }
                 catch (err) {
@@ -946,7 +957,7 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity Add for Rune only
      *
      * @param params - deposit parameters
      * @param memo - memo needed to withdraw lp
@@ -960,18 +971,17 @@ class Wallet {
                 amount: params.rune.baseAmount,
                 memo: memo,
             };
-            // console.log(addParams)
             const hash = yield thorClient.deposit(addParams);
             return { hash, url: thorchainClient.getExplorerTxUrl(hash), waitTimeSeconds };
         });
     }
-    /**
+    /** Function handles liquidity Withdraw for Rune only
      *
-     * @param params - remove parameters
+     * @param params - withdraw parameters
      * @param memo - memo needed to withdraw lp
      * @returns - tx object
      */
-    removeRuneLP(params, memo, thorchainClient, waitTimeSeconds) {
+    withdrawRuneLP(params, memo, thorchainClient, waitTimeSeconds) {
         return __awaiter(this, void 0, void 0, function* () {
             const thorClient = this.clients.THOR;
             const addParams = {
@@ -979,14 +989,13 @@ class Wallet {
                 amount: params.runeFee.baseAmount,
                 memo: memo,
             };
-            // console.log(addParams)
             const hash = yield thorClient.deposit(addParams);
             return { hash, url: thorchainClient.getExplorerTxUrl(hash), waitTimeSeconds };
         });
     }
 }
 
-const BN_1 = new bignumber_js.BigNumber(1);
+const defaultQuery = new xchainThorchainQuery.ThorchainQuery();
 /**
  * THORChain Class for interacting with THORChain.
  * Recommended main class to use for swapping with THORChain
@@ -999,7 +1008,7 @@ class ThorchainAMM {
      * @param thorchainQuery - an instance of the ThorchainQuery
      * @returns ThorchainAMM
      */
-    constructor(thorchainQuery) {
+    constructor(thorchainQuery = defaultQuery) {
         this.thorchainQuery = thorchainQuery;
     }
     /**
@@ -1030,32 +1039,40 @@ class ThorchainAMM {
      */
     doSwap(wallet, params) {
         return __awaiter(this, void 0, void 0, function* () {
-            // TODO validate all input fields
+            // Thorchain-query call satisfies the data needed for executeSwap to be called.
             const txDetails = yield this.thorchainQuery.estimateSwap(params);
             if (!txDetails.txEstimate.canSwap) {
                 throw Error(txDetails.txEstimate.errors.join('\n'));
             }
-            // remove any affiliateFee. netInput * affiliateFee (%age) of the destination asset type
-            const affiliateFee = params.input.baseAmount.times(params.affiliateFeePercent || 0);
-            // Work out LIM from the slip percentage
-            let limPercentage = BN_1;
-            if (params.slipLimit) {
-                limPercentage = BN_1.minus(params.slipLimit || 1);
-            } // else allowed slip is 100%
-            const limAssetAmount = txDetails.txEstimate.netOutput.times(limPercentage);
-            const waitTimeSeconds = txDetails.txEstimate.waitTimeSeconds;
             return yield wallet.executeSwap({
                 input: params.input,
                 destinationAsset: params.destinationAsset,
-                limit: limAssetAmount.baseAmount,
                 destinationAddress: params.destinationAddress,
-                affiliateAddress: params.affiliateAddress || '',
-                affiliateFee,
-                interfaceID: params.interfaceID || 999,
-                waitTimeSeconds,
+                memo: txDetails.memo,
+                waitTimeSeconds: txDetails.txEstimate.waitTimeSeconds,
             });
         });
     }
+    /**
+     * Wraps estimate from thorchain query
+     * @param params - estimate add liquidity
+     * @returns - Estimate add lp object
+     */
+    estimateAddLiquidity(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.thorchainQuery.estimateAddLP(params);
+        });
+    }
+    /**
+     * Wraps estimate withdraw from thorchain query
+     * @param params - estimate withdraw liquidity
+     * @returns - Estimate withdraw lp object
+     */
+    estimateWithdrawLiquidity(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.thorchainQuery.estimateWithdrawLP(params);
+        });
+    }
     /**
      *
      * @param wallet - wallet class
@@ -1066,6 +1083,8 @@ class ThorchainAMM {
         return __awaiter(this, void 0, void 0, function* () {
             // Check amounts are greater than fees and use return estimated wait
             const checkLPAdd = yield this.thorchainQuery.estimateAddLP(params);
+            if (!checkLPAdd.canAdd)
+                throw Error(`${checkLPAdd.errors}`);
             return wallet.addLiquidity({
                 asset: params.asset,
                 rune: params.rune,
@@ -1080,11 +1099,11 @@ class ThorchainAMM {
      * @param wallet - wallet needed to perform tx
      * @return
      */
-    removeLiquidityPosition(wallet, params) {
+    withdrawLiquidityPosition(wallet, params) {
         return __awaiter(this, void 0, void 0, function* () {
             // Caution Dust Limits: BTC,BCH,LTC chains 10k sats; DOGE 1m Sats; ETH 0 wei; THOR 0 RUNE.
             const withdrawParams = yield this.thorchainQuery.estimateWithdrawLP(params);
-            return wallet.removeLiquidity({
+            return wallet.withdrawLiquidity({
                 assetFee: withdrawParams.transactionFee.assetFee,
                 runeFee: withdrawParams.transactionFee.runeFee,
                 waitTimeSeconds: withdrawParams.estimatedWaitSeconds,

package/lib/thorchain-amm.d.ts

@@ -1,4 +1,4 @@
-import { AddliquidityPosition, EstimateSwapParams, RemoveLiquidityPosition, ThorchainQuery, TxDetails } from '@xchainjs/xchain-thorchain-query';
+import { AddliquidityPosition, EstimateAddLP, EstimateSwapParams, EstimateWithdrawLP, ThorchainQuery, TxDetails, WithdrawLiquidityPosition } from '@xchainjs/xchain-thorchain-query';
 import { TxSubmitted } from './types';
 import { Wallet } from './wallet';
 /**
@@ -14,7 +14,7 @@ export declare class ThorchainAMM {
      * @param thorchainQuery - an instance of the ThorchainQuery
      * @returns ThorchainAMM
      */
-    constructor(thorchainQuery: ThorchainQuery);
+    constructor(thorchainQuery?: ThorchainQuery);
     /**
      * Provides a swap estimate for the given swap detail. Will check the params for errors before trying to get the estimate.
      * Uses current pool data, works out inbound and outboud fee, affiliate fees and works out the expected wait time for the swap (in and out)
@@ -32,6 +32,18 @@ export declare class ThorchainAMM {
      * @returns {SwapSubmitted} - Tx Hash, URL of BlockExplorer and expected wait time.
      */
     doSwap(wallet: Wallet, params: EstimateSwapParams): Promise<TxSubmitted>;
+    /**
+     * Wraps estimate from thorchain query
+     * @param params - estimate add liquidity
+     * @returns - Estimate add lp object
+     */
+    estimateAddLiquidity(params: AddliquidityPosition): Promise<EstimateAddLP>;
+    /**
+     * Wraps estimate withdraw from thorchain query
+     * @param params - estimate withdraw liquidity
+     * @returns - Estimate withdraw lp object
+     */
+    estimateWithdrawLiquidity(params: WithdrawLiquidityPosition): Promise<EstimateWithdrawLP>;
     /**
      *
      * @param wallet - wallet class
@@ -45,5 +57,5 @@ export declare class ThorchainAMM {
      * @param wallet - wallet needed to perform tx
      * @return
      */
-    removeLiquidityPosition(wallet: Wallet, params: RemoveLiquidityPosition): Promise<TxSubmitted[]>;
+    withdrawLiquidityPosition(wallet: Wallet, params: WithdrawLiquidityPosition): Promise<TxSubmitted[]>;
 }

package/lib/types.d.ts

@@ -1,20 +1,12 @@
 import { FeeOption } from '@xchainjs/xchain-client';
 import { CryptoAmount, LiquidityPool } from '@xchainjs/xchain-thorchain-query';
 import { Address, Asset, BaseAmount } from '@xchainjs/xchain-util';
-import { BigNumber } from 'bignumber.js';
-export declare type MidgardConfig = {
-    apiRetries: number;
-    midgardBaseUrls: string[];
-};
 export declare type ExecuteSwap = {
     input: CryptoAmount;
     destinationAsset: Asset;
-    limit: BaseAmount;
     destinationAddress: Address;
-    affiliateAddress: Address;
-    affiliateFee: BaseAmount;
+    memo: string;
     feeOption?: FeeOption;
-    interfaceID: number;
     waitTimeSeconds: number;
 };
 export declare type TxSubmitted = {
@@ -34,7 +26,7 @@ export declare type AddLiquidity = {
     waitTimeSeconds: number;
     assetPool: string;
 };
-export declare type RemoveLiquidity = {
+export declare type WithdrawLiquidity = {
     assetFee: CryptoAmount;
     runeFee: CryptoAmount;
     waitTimeSeconds: number;
@@ -50,12 +42,3 @@ export declare type DepositParams = {
     feeOption: FeeOption;
     memo: string;
 };
-export declare type SwapOutput = {
-    output: CryptoAmount;
-    swapFee: CryptoAmount;
-    slip: BigNumber;
-};
-export declare type UnitData = {
-    liquidityUnits: BigNumber;
-    totalUnits: BigNumber;
-};

package/lib/wallet.d.ts

@@ -1,7 +1,7 @@
 import { Balance, XChainClient } from '@xchainjs/xchain-client';
 import { ThorchainQuery } from '@xchainjs/xchain-thorchain-query';
 import { Chain } from '@xchainjs/xchain-util';
-import { AddLiquidity, ExecuteSwap, RemoveLiquidity, TxSubmitted } from './types';
+import { AddLiquidity, ExecuteSwap, TxSubmitted, WithdrawLiquidity } from './types';
 declare type AllBalances = {
     chain: Chain;
     address: string;
@@ -36,23 +36,37 @@ export declare class Wallet {
      * @see ThorchainAMM.doSwap()
      */
     executeSwap(swap: ExecuteSwap): Promise<TxSubmitted>;
-    private constructSwapMemo;
+    /** Validate swap object
+     *
+     * @param swap  - swap parameters
+     */
     private validateSwap;
+    private isThorname;
+    /** Function handles all swaps from Rune to asset
+     *
+     * @param swap - swap parameters
+     * @returns - tx submitted object
+     */
     private swapRuneTo;
-    private swapNonRune;
-    /** BASED OFF https://dev.thorchain.or›g/thorchain-dev/network/memos
+    /** Function handles all swaps from Non Rune
      *
+     * @param swap - swap object
+     * @returns - TxSubmitted object
+     */
+    private swapNonRune;
+    /** Function handles liquidity Add
+     * BASED OFF https://dev.thorchain.or›g/thorchain-dev/network/memos
      * @param params input parameters needed to add liquidity
      * @returns transaction details submitted
      */
     addLiquidity(params: AddLiquidity): Promise<TxSubmitted[]>;
-    /**
+    /** Function handles liquidity Withdraw
      *
      * @param params - parameters required for liquidity position
      * @returns object with tx response, url and wait time in seconds
      */
-    removeLiquidity(params: RemoveLiquidity): Promise<TxSubmitted[]>;
-    /**
+    withdrawLiquidity(params: WithdrawLiquidity): Promise<TxSubmitted[]>;
+    /** Function handles liquidity add for all non rune assets
      *
      * @param params - parameters for add liquidity
      * @param constructedMemo - memo needed for thorchain
@@ -62,29 +76,29 @@ export declare class Wallet {
      * @returns - tx object
      */
     private addAssetLP;
-    /**
+    /** Function handles liquidity Withdraw for Non rune assets
      *
-     * @param params - parameters for remove liquidity
+     * @param params - parameters for withdraw liquidity
      * @param constructedMemo - memo needed for thorchain execution
      * @param assetClient - asset client to call transfer
      * @param waitTimeSeconds - return back estimated wait
      * @param inboundAsgard - destination address
      * @returns - tx object
      */
-    private removeAssetLP;
-    /**
+    private withdrawAssetLP;
+    /** Function handles liquidity Add for Rune only
      *
      * @param params - deposit parameters
      * @param memo - memo needed to withdraw lp
      * @returns - tx object
      */
     private addRuneLP;
-    /**
+    /** Function handles liquidity Withdraw for Rune only
      *
-     * @param params - remove parameters
+     * @param params - withdraw parameters
      * @param memo - memo needed to withdraw lp
      * @returns - tx object
      */
-    private removeRuneLP;
+    private withdrawRuneLP;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-amm",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "module that exposes estimating & swappping cryptocurrency assets on thorchain",
   "keywords": [
     "THORChain",
@@ -48,13 +48,13 @@
     "@xchainjs/xchain-crypto": "^0.2.6",
     "@xchainjs/xchain-doge": "^0.5.0",
     "@xchainjs/xchain-ethereum": "^0.27.0",
-    "@xchainjs/xchain-evm": "^0.1.0-alpha2",
-    "@xchainjs/xchain-avax": "^0.1.0-alpha3",
+    "@xchainjs/xchain-evm": "^0.1.0",
+    "@xchainjs/xchain-avax": "^0.1.0",
     "@xchainjs/xchain-litecoin": "^0.10.3",
-    "@xchainjs/xchain-midgard": "0.1.0",
+    "@xchainjs/xchain-midgard": "0.2.0",
     "@xchainjs/xchain-thorchain": "^0.27.0",
-    "@xchainjs/xchain-thorchain-query": "^0.1.2",
-    "@xchainjs/xchain-thornode": "^0.1.0",
+    "@xchainjs/xchain-thorchain-query": "^0.1.4",
+    "@xchainjs/xchain-thornode": "^0.1.1",
     "@xchainjs/xchain-util": "^0.11.0",
     "axios": "^0.25.0",
     "axios-retry": "^3.2.5",
@@ -73,22 +73,21 @@
     "@binance-chain/javascript-sdk": "^4.2.0",
     "@cosmos-client/core": "0.45.13",
     "@psf/bitcoincashjs-lib": "^4.0.2",
-    "@terra-money/terra.js": "^3.0.2",
-    "@xchainjs/xchain-binance": "^5.6.0",
-    "@xchainjs/xchain-bitcoin": "^0.20.0",
-    "@xchainjs/xchain-bitcoincash": "^0.15.0",
+    "@xchainjs/xchain-binance": "^5.6.4",
+    "@xchainjs/xchain-bitcoin": "^0.20.4",
+    "@xchainjs/xchain-bitcoincash": "^0.15.3",
     "@xchainjs/xchain-client": "^0.13.2",
-    "@xchainjs/xchain-cosmos": "^0.20.0",
+    "@xchainjs/xchain-cosmos": "^0.20.3",
     "@xchainjs/xchain-crypto": "^0.2.6",
-    "@xchainjs/xchain-doge": "^0.5.0",
-    "@xchainjs/xchain-ethereum": "^0.27.0",
-    "@xchainjs/xchain-evm": "^0.1.0-alpha2",
-    "@xchainjs/xchain-avax": "^0.1.0-alpha3",
-    "@xchainjs/xchain-litecoin": "^0.10.0",
-    "@xchainjs/xchain-midgard": "0.1.0",
+    "@xchainjs/xchain-doge": "^0.5.4",
+    "@xchainjs/xchain-ethereum": "^0.27.3",
+    "@xchainjs/xchain-evm": "^0.1.0",
+    "@xchainjs/xchain-avax": "^0.1.0",
+    "@xchainjs/xchain-litecoin": "^0.10.4",
+    "@xchainjs/xchain-midgard": "0.2.0",
     "@xchainjs/xchain-thornode": "^0.1.0",
-    "@xchainjs/xchain-thorchain": "^0.26.0",
-    "@xchainjs/xchain-thorchain-query": "^0.1.0",
+    "@xchainjs/xchain-thorchain": "^0.27.1",
+    "@xchainjs/xchain-thorchain-query": "^0.1.2",
     "@xchainjs/xchain-util": "^0.11.0",
     "axios": "^0.25.0",
     "axios-retry": "^3.2.5",