@xchainjs/xchain-thorchain-amm 0.3.2 → 0.3.4

package/lib/index.esm.js

@@ -8,11 +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 { ThorchainQuery } from '@xchainjs/xchain-thorchain-query';
-import { BigNumber } from 'bignumber.js';
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -423,7 +422,7 @@ class EthHelper {
      */
     sendDeposit(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const inboundAsgard = (yield this.thorchainCache.getInboundAddresses())[params.asset.chain];
+            const inboundAsgard = (yield this.thorchainCache.getInboundDetails())[params.asset.chain];
             if (!(inboundAsgard === null || inboundAsgard === void 0 ? void 0 : inboundAsgard.router)) {
                 throw new Error('router address is not defined');
             }
@@ -518,7 +517,7 @@ class EvmHelper {
      */
     sendDeposit(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const inboundAsgard = (yield this.thorchainCache.getInboundAddresses())[params.asset.chain];
+            const inboundAsgard = (yield this.thorchainCache.getInboundDetails())[params.asset.chain];
             if (!(inboundAsgard === null || inboundAsgard === void 0 ? void 0 : inboundAsgard.router)) {
                 throw new Error('router address is not defined');
             }
@@ -677,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;
@@ -702,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;
@@ -714,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];
@@ -732,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 };
@@ -743,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);
@@ -755,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
      */
@@ -800,7 +810,7 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity Withdraw
      *
      * @param params - parameters required for liquidity position
      * @returns object with tx response, url and wait time in seconds
@@ -836,7 +846,7 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity add for all non rune assets
      *
      * @param params - parameters for add liquidity
      * @param constructedMemo - memo needed for thorchain
@@ -889,7 +899,7 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity Withdraw for Non rune assets
      *
      * @param params - parameters for withdraw liquidity
      * @param constructedMemo - memo needed for thorchain execution
@@ -943,7 +953,7 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity Add for Rune only
      *
      * @param params - deposit parameters
      * @param memo - memo needed to withdraw lp
@@ -957,12 +967,11 @@ 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 - withdraw parameters
      * @param memo - memo needed to withdraw lp
@@ -976,14 +985,12 @@ 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.
@@ -1008,14 +1015,14 @@ class ThorchainAMM {
   
      * @returns The SwapEstimate
      */
-    estimateSwap({ input, destinationAsset, destinationAddress, affiliateAddress = '', interfaceID = 999, affiliateFeePercent = 0, slipLimit, }) {
+    estimateSwap({ input, destinationAsset, destinationAddress, affiliateAddress = '', interfaceID = `555`, affiliateFeeBasisPoints = 0, slipLimit, }) {
         return this.thorchainQuery.estimateSwap({
             input,
             destinationAsset,
             destinationAddress,
             affiliateAddress,
             interfaceID,
-            affiliateFeePercent,
+            affiliateFeeBasisPoints,
             slipLimit,
         });
     }
@@ -1028,29 +1035,17 @@ 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,
             });
         });
     }

package/lib/index.js

@@ -16,7 +16,6 @@ var xchainUtil = require('@xchainjs/xchain-util');
 var ethers = require('ethers');
 var xchainEvm = require('@xchainjs/xchain-evm');
 var xchainThorchainQuery = require('@xchainjs/xchain-thorchain-query');
-var bignumber_js = require('bignumber.js');
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -427,7 +426,7 @@ class EthHelper {
      */
     sendDeposit(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const inboundAsgard = (yield this.thorchainCache.getInboundAddresses())[params.asset.chain];
+            const inboundAsgard = (yield this.thorchainCache.getInboundDetails())[params.asset.chain];
             if (!(inboundAsgard === null || inboundAsgard === void 0 ? void 0 : inboundAsgard.router)) {
                 throw new Error('router address is not defined');
             }
@@ -522,7 +521,7 @@ class EvmHelper {
      */
     sendDeposit(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const inboundAsgard = (yield this.thorchainCache.getInboundAddresses())[params.asset.chain];
+            const inboundAsgard = (yield this.thorchainCache.getInboundDetails())[params.asset.chain];
             if (!(inboundAsgard === null || inboundAsgard === void 0 ? void 0 : inboundAsgard.router)) {
                 throw new Error('router address is not defined');
             }
@@ -681,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;
@@ -706,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;
@@ -718,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];
@@ -736,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 };
@@ -747,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);
@@ -759,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
      */
@@ -804,7 +814,7 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity Withdraw
      *
      * @param params - parameters required for liquidity position
      * @returns object with tx response, url and wait time in seconds
@@ -840,7 +850,7 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity add for all non rune assets
      *
      * @param params - parameters for add liquidity
      * @param constructedMemo - memo needed for thorchain
@@ -893,7 +903,7 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity Withdraw for Non rune assets
      *
      * @param params - parameters for withdraw liquidity
      * @param constructedMemo - memo needed for thorchain execution
@@ -947,7 +957,7 @@ class Wallet {
             }
         });
     }
-    /**
+    /** Function handles liquidity Add for Rune only
      *
      * @param params - deposit parameters
      * @param memo - memo needed to withdraw lp
@@ -961,12 +971,11 @@ 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 - withdraw parameters
      * @param memo - memo needed to withdraw lp
@@ -980,14 +989,12 @@ 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.
@@ -1012,14 +1019,14 @@ class ThorchainAMM {
   
      * @returns The SwapEstimate
      */
-    estimateSwap({ input, destinationAsset, destinationAddress, affiliateAddress = '', interfaceID = 999, affiliateFeePercent = 0, slipLimit, }) {
+    estimateSwap({ input, destinationAsset, destinationAddress, affiliateAddress = '', interfaceID = `555`, affiliateFeeBasisPoints = 0, slipLimit, }) {
         return this.thorchainQuery.estimateSwap({
             input,
             destinationAsset,
             destinationAddress,
             affiliateAddress,
             interfaceID,
-            affiliateFeePercent,
+            affiliateFeeBasisPoints,
             slipLimit,
         });
     }
@@ -1032,29 +1039,17 @@ 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,
             });
         });
     }

package/lib/thorchain-amm.d.ts

@@ -23,7 +23,7 @@ export declare class ThorchainAMM {
   
      * @returns The SwapEstimate
      */
-    estimateSwap({ input, destinationAsset, destinationAddress, affiliateAddress, interfaceID, affiliateFeePercent, slipLimit, }: EstimateSwapParams): Promise<TxDetails>;
+    estimateSwap({ input, destinationAsset, destinationAddress, affiliateAddress, interfaceID, affiliateFeeBasisPoints, slipLimit, }: EstimateSwapParams): Promise<TxDetails>;
     /**
      * Conducts a swap with the given inputs. Should be called after estimateSwap() to ensure the swap is valid
      *

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 = {
@@ -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

@@ -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
      */
     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,7 +76,7 @@ export declare class Wallet {
      * @returns - tx object
      */
     private addAssetLP;
-    /**
+    /** Function handles liquidity Withdraw for Non rune assets
      *
      * @param params - parameters for withdraw liquidity
      * @param constructedMemo - memo needed for thorchain execution
@@ -72,14 +86,14 @@ export declare class Wallet {
      * @returns - tx object
      */
     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 - withdraw parameters
      * @param memo - memo needed to withdraw lp

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-amm",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "module that exposes estimating & swappping cryptocurrency assets on thorchain",
   "keywords": [
     "THORChain",
@@ -51,10 +51,10 @@
     "@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.5",
+    "@xchainjs/xchain-thornode": "^0.1.1",
     "@xchainjs/xchain-util": "^0.11.0",
     "axios": "^0.25.0",
     "axios-retry": "^3.2.5",
@@ -84,7 +84,7 @@
     "@xchainjs/xchain-evm": "^0.1.0",
     "@xchainjs/xchain-avax": "^0.1.0",
     "@xchainjs/xchain-litecoin": "^0.10.4",
-    "@xchainjs/xchain-midgard": "0.1.0",
+    "@xchainjs/xchain-midgard": "0.2.0",
     "@xchainjs/xchain-thornode": "^0.1.0",
     "@xchainjs/xchain-thorchain": "^0.27.1",
     "@xchainjs/xchain-thorchain-query": "^0.1.2",