@xchainjs/xchain-thorchain-amm 0.8.21 → 0.8.22

package/lib/index.js

@@ -149,9 +149,9 @@ class Wallet {
     /**
      * Contructor to create a Wallet
      *
-     * @param phrase - mnemonic phrase
-     * @param thorchainCache - an instance of the ThorchainCache (could be pointing to stagenet,testnet,mainnet)
-     * @param chainConfigs - Config by chain
+     * @param phrase - Mnemonic phrase
+     * @param thorchainCache - An instance of the ThorchainCache (could be pointing to stagenet,testnet,mainnet)
+     * @param chainConfigs - Configuration settings for different blockchain chains
      * @returns Wallet
      */
     constructor(phrase, thorchainQuery, chainConfigs = {}) {
@@ -177,20 +177,24 @@ class Wallet {
         };
     }
     /**
-     * Fetch balances for all wallets
-     *
-     * @returns AllBalances[]
+     * Fetch the balance of all the chains.
+     * @returns An array of AllBalances objects containing balance information for all chains
      */
     getAllBalances() {
         return __awaiter(this, void 0, void 0, function* () {
             const allBalances = [];
+            // Loop through each chain's client and fetch the balance
             for (const [chain, client] of Object.entries(this.clients)) {
+                // Get the wallet address for the current chain
                 const address = yield client.getAddressAsync(0);
                 try {
+                    // Fetch the balance for the wallet address
                     const balances = yield client.getBalance(address);
+                    // Push the balance information to the allBalances array
                     allBalances.push({ chain, address, balances });
                 }
                 catch (err) {
+                    // If an error occurs, push an error message to the allBalances array
                     allBalances.push({ chain, address, balances: err.message });
                 }
             }
@@ -198,15 +202,16 @@ class Wallet {
         });
     }
     /**
-     * Executes a Swap from THORChainAMM.doSwap()
-     *
-     * @param swap object with all the required details for a swap.
-     * @returns transaction details and explorer url
+     * Executes a swap using the provided swap details.
+     * @param swap Object containing details required for the swap
+     * @returns Object containing transaction details and explorer URL
      * @see ThorchainAMM.doSwap()
      */
     executeSwap(swap) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Validate the swap details
             yield this.validateSwap(swap);
+            // Determine whether the destination asset is THORChain or a synthetic asset
             if (swap.input.asset.chain === xchainThorchain.THORChain || swap.input.asset.synth) {
                 return yield this.swapRuneTo(swap);
             }
@@ -215,20 +220,20 @@ class Wallet {
             }
         });
     }
-    /** Validate swap object
-     *
-     * @param swap  - swap parameters
+    /** Validates the swap object details.
+     * @param swap - Object containing swap parameters
+     * @returns An array of validation errors
      */
     validateSwap(swap) {
         return __awaiter(this, void 0, void 0, function* () {
             const errors = [];
             const isThorchainDestinationAsset = swap.destinationAsset.synth || swap.destinationAsset.chain === xchainThorchain.THORChain;
             const chain = isThorchainDestinationAsset ? xchainThorchain.THORChain : swap.destinationAsset.chain;
-            // check address
+            // Check if the destination address is valid
             if (swap.destinationAddress && !this.clients[chain].validateAddress(swap.destinationAddress)) {
                 errors.push(`destinationAddress ${swap.destinationAddress} is not a valid address`);
             }
-            // Affiliate address should be THORName or THORAddress
+            // Affiliate address should be a valid THOR address or THORName
             const checkAffiliateAddress = swap.memo.split(':');
             if (checkAffiliateAddress.length > 4) {
                 const affiliateAddress = checkAffiliateAddress[4];
@@ -239,9 +244,10 @@ class Wallet {
                         errors.push(`affiliateAddress ${affiliateAddress} is not a valid THOR address`);
                 }
             }
-            // if input == synth return errors.
+            // If input asset is synthetic, return errors
             if (swap.input.asset.synth)
                 return errors;
+            // Check if the input asset is an ERC20 asset and whether the router has been approved to spend this amount
             if (this.isERC20Asset(swap.input.asset)) {
                 const isApprovedResult = yield this.evmHelpers[swap.input.asset.chain].isTCRouterApprovedToSpend(swap.input.asset, swap.input.baseAmount, swap.walletIndex);
                 if (!isApprovedResult) {
@@ -251,16 +257,21 @@ class Wallet {
             return errors;
         });
     }
+    /**
+    * Checks if a given string is a valid THORName.
+    * @param name - Name to check
+    * @returns Boolean indicating whether the name is a valid THORName
+    */
     isThorname(name) {
         return __awaiter(this, void 0, void 0, function* () {
             const thornameDetails = yield this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.getTHORNameDetails(name); // Update when thorchainCache expose getTHORNameDetails method
             return thornameDetails !== undefined;
         });
     }
-    /** Function handles all swaps from Rune to asset
+    /** Swaps assets from RUNE to another asset.
      *
-     * @param swap - swap parameters
-     * @returns - tx submitted object
+     * @param swap - Swap details parameter
+     * @returns - Object containing transaction details and explorer URL
      */
     swapRuneTo(swap) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -273,17 +284,19 @@ class Wallet {
             return { hash, url: this.clients.THOR.getExplorerTxUrl(hash) };
         });
     }
-    /** Function handles all swaps from Non Rune
-     *
-     * @param swap - swap object
-     * @returns - TxSubmitted object
+    /** Swaps assets that are not RUNE.
+     * @param swap - swap details object
+     * @returns - Object containing transaction details and explorer URL
      */
     swapNonRune(swap) {
         return __awaiter(this, void 0, void 0, function* () {
             const client = this.clients[swap.input.asset.chain];
+            // Retrieve inbound details for the asset's chain
             const inbound = (yield this.thorchainQuery.thorchainCache.getInboundDetails())[swap.input.asset.chain];
+            // Check if there is an inbound address for the asset's chain
             if (!(inbound === null || inbound === void 0 ? void 0 : inbound.address))
                 throw Error(`no asgard address found for ${swap.input.asset.chain}`);
+            // Handle swaps for EVM chains
             if (this.isEVMChain(swap.input.asset)) {
                 const params = {
                     walletIndex: 0,
@@ -296,6 +309,7 @@ class Wallet {
                 return { hash, url: client.getExplorerTxUrl(hash) };
             }
             else {
+                // Handle swaps for non-EVM chains
                 const params = {
                     walletIndex: 0,
                     asset: swap.input.asset,
@@ -308,10 +322,10 @@ class Wallet {
             }
         });
     }
-    /** Function handles liquidity Add
+    /** Handles adding liquidity to the pool.
      * BASED OFF https://dev.thorchain.or›g/thorchain-dev/network/memos
-     * @param params input parameters needed to add liquidity
-     * @returns transaction details submitted
+     * @param params Input parameters for adding liquidity
+     * @returns An array of transaction details submitted
      */
     addLiquidity(params) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -324,7 +338,7 @@ class Wallet {
             // const waitTimeSeconds = params.waitTimeSeconds
             let constructedMemo = '';
             const txSubmitted = [];
-            // symmetrical add
+            // Symmetrical add
             if (params.asset.assetAmount.gt(0) && params.rune.assetAmount.gt(0)) {
                 constructedMemo = `+:${params.assetPool}:${addressRune}`;
                 txSubmitted.push(yield this.addAssetLP(params, constructedMemo, assetClient, inboundAsgard));
@@ -333,23 +347,22 @@ class Wallet {
                 return txSubmitted;
             }
             else if (params.asset.assetAmount.gt(0) && params.rune.assetAmount.eq(0)) {
-                // asymmetrical asset only
+                // Asymmetrical asset only
                 constructedMemo = `+:${params.assetPool}`;
                 txSubmitted.push(yield this.addAssetLP(params, constructedMemo, assetClient, inboundAsgard));
                 return txSubmitted;
             }
             else {
-                // asymmetrical rune only
+                // Asymmetrical rune only
                 constructedMemo = `+:${params.assetPool}`;
                 txSubmitted.push(yield this.addRuneLP(params, constructedMemo, thorchainClient));
                 return txSubmitted;
             }
         });
     }
-    /** Function handles liquidity Withdraw
-     *
-     * @param params - parameters required for liquidity position
-     * @returns object with tx response, url and wait time in seconds
+    /** Handles withdrawing liquidity from the pool.
+     * @param params - Parameters required for liquidity position
+     * @returns Object with transaction response, URL, and wait time in seconds
      */
     withdrawLiquidity(params) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -369,13 +382,13 @@ class Wallet {
                 return txSubmitted;
             }
             else if (params.assetAddress && !params.runeAddress) {
-                // asymmetrical asset only
+                // Asymmetrical asset only
                 constructedMemo = `-:${params.assetPool}:${basisPoints}`;
                 txSubmitted.push(yield this.withdrawAssetLP(params, constructedMemo, assetClient, inboundAsgard));
                 return txSubmitted;
             }
             else {
-                // asymmetrical rune only
+                // Asymmetrical rune only
                 constructedMemo = `-:${params.assetPool}:${basisPoints}`;
                 txSubmitted.push(yield this.withdrawRuneLP(params, constructedMemo, thorchainClient));
                 return txSubmitted;
@@ -383,15 +396,16 @@ class Wallet {
         });
     }
     /**
-     *
-     * @param assetAmount - amount to add
-     * @param memo - memo required
+     * Adds funds to a savers account.
+     * @param assetAmount - The amount of assets to add.
+     * @param memo - The memo required for the transaction.
      * @param waitTimeSeconds - expected wait for the transaction to be processed
-     * @returns
+     * @returns An object containing transaction details and explorer URL.
      */
     addSavers(assetAmount, memo, toAddress) {
         return __awaiter(this, void 0, void 0, function* () {
             const assetClient = this.clients[assetAmount.asset.chain];
+            // Handle EVM chains
             if (this.isEVMChain(assetAmount.asset)) {
                 const addParams = {
                     wallIndex: 0,
@@ -423,7 +437,7 @@ class Wallet {
                     return { hash, url: assetClient.getExplorerAddressUrl(assetClient.getAddress()) };
                 }
             }
-            else {
+            else { // Handle other chains
                 const addParams = {
                     wallIndex: 0,
                     asset: assetAmount.asset,
@@ -443,15 +457,16 @@ class Wallet {
         });
     }
     /**
-     *
-     * @param assetAmount - amount to withdraw
-     * @param memo - memo required
+     * Withdraws funds from a savers account.
+     * @param assetAmount - The amount of assets to withdraw.
+     * @param memo - The memo required for the transaction.
      * @param waitTimeSeconds - expected wait for the transaction to be processed
-     * @returns
+     * @returns An object containing transaction details and explorer URL.
      */
     withdrawSavers(assetAmount, memo, toAddress) {
         return __awaiter(this, void 0, void 0, function* () {
             const assetClient = this.clients[assetAmount.asset.chain];
+            // Handle EVM chains
             if (this.isEVMChain(assetAmount.asset)) {
                 const addParams = {
                     wallIndex: 0,
@@ -483,7 +498,7 @@ class Wallet {
                     return { hash, url: yield assetClient.getExplorerAddressUrl(yield assetClient.getAddressAsync()) };
                 }
             }
-            else {
+            else { // Handle other chains
                 const addParams = {
                     wallIndex: 0,
                     asset: assetAmount.asset,
@@ -502,9 +517,15 @@ class Wallet {
             }
         });
     }
+    /**
+    * Opens a new loan.
+    * @param params - Parameters required to open a loan.
+    * @returns An object containing transaction details and explorer URL.
+    */
     loanOpen(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const assetClient = this.clients[params.amount.asset.chain];
+            // Handle EVM chains
             if (this.isEVMChain(params.amount.asset)) {
                 const addParams = {
                     wallIndex: 0,
@@ -536,7 +557,7 @@ class Wallet {
                     return { hash, url: assetClient.getExplorerAddressUrl(yield assetClient.getAddressAsync()) };
                 }
             }
-            else {
+            else { // Handle other chains
                 const addParams = {
                     wallIndex: 0,
                     asset: params.amount.asset,
@@ -555,9 +576,15 @@ class Wallet {
             }
         });
     }
+    /**
+     * Closes an existing loan.
+     * @param params - Parameters required to close a loan.
+     * @returns An object containing transaction details and explorer URL.
+     */
     loanClose(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const assetClient = this.clients[params.amount.asset.chain];
+            // Handle EVM chains
             if (this.isEVMChain(params.amount.asset)) {
                 const addParams = {
                     wallIndex: 0,
@@ -589,7 +616,7 @@ class Wallet {
                     return { hash, url: assetClient.getExplorerAddressUrl(yield assetClient.getAddressAsync()) };
                 }
             }
-            else {
+            else { // Handle other chains
                 const addParams = {
                     wallIndex: 0,
                     asset: params.amount.asset,
@@ -608,7 +635,7 @@ class Wallet {
             }
         });
     }
-    /**
+    /**Registers a THORName with default parameters.
      * Register a THORName with a default expirity of one year. By default chain and chainAddress is getting from wallet instance and is BTC.
      * By default owner is getting from wallet
      * @param thorname - Name to register
@@ -622,13 +649,18 @@ class Wallet {
      */
     registerThorname(params) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Obtain the client corresponding to the specified chain or default to BTCChain
             const chainClient = this.clients[params.chain || xchainBitcoin.BTCChain];
             const thorClient = this.clients.THOR;
+            // Check if both chainClient and thorClient exist
             if (!chainClient || !thorClient) {
                 throw Error('Can not find a wallet client');
             }
+            // Estimate the THORName registration fee
             const thornameEstimation = yield this.thorchainQuery.estimateThorname(Object.assign(Object.assign({}, params), { chain: params.chain || xchainBitcoin.BTCChain, chainAddress: params.chainAddress || (yield chainClient.getAddressAsync()), owner: params.owner || (yield thorClient.getAddressAsync()) }));
+            // Cast thorClient to ThorchainClient
             const castedThorClient = thorClient;
+            // Deposit the registration fee for the THORName
             const result = yield castedThorClient.deposit({
                 asset: thornameEstimation.value.asset,
                 amount: thornameEstimation.value.baseAmount,
@@ -637,7 +669,7 @@ class Wallet {
             return result;
         });
     }
-    /**
+    /**Updates an existing THORName with default parameters.
      * Register a THORName with a default expirity of one year. By default chain and chainAddress is getting from wallet instance and is BTC.
      * By default owner is getting from wallet
      * @param thorname - Name to register
@@ -650,17 +682,24 @@ class Wallet {
      */
     updateThorname(params) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Obtain the client corresponding to the specified chain or default to BTCChain
             const chainClient = this.clients[params.chain || xchainBitcoin.BTCChain];
             const thorClient = this.clients.THOR;
+            // Check if both chainClient and thorClient exist
             if (!chainClient || !thorClient) {
                 throw Error('Can not find a wallet client');
             }
+            // Retrieve details of the existing THORName
             const thornameDetail = yield this.thorchainQuery.getThornameDetails(params.thorname);
+            // Verify ownership of the THORName
             if ((thornameDetail === null || thornameDetail === void 0 ? void 0 : thornameDetail.owner) !== (yield thorClient.getAddressAsync())) {
                 throw Error('You cannot update a domain that is not yours');
             }
+            // Estimate the updated THORName registration fee
             const thornameEstimation = yield this.thorchainQuery.estimateThorname(Object.assign(Object.assign({}, params), { chain: params.chain || xchainBitcoin.BTCChain, isUpdate: true, preferredAsset: params.preferredAsset || xchainUtil.assetFromString(thornameDetail.preferredAsset), chainAddress: params.chainAddress || (yield chainClient.getAddressAsync()) }));
+            // Cast thorClient to ThorchainClient
             const castedThorClient = thorClient;
+            // Deposit the updated registration fee for the THORName
             const result = yield castedThorClient.deposit({
                 asset: thornameEstimation.value.asset,
                 amount: thornameEstimation.value.baseAmount,
@@ -669,18 +708,19 @@ class Wallet {
             return result;
         });
     }
-    /** Function handles liquidity add for all non rune assets
-     *
-     * @param params - parameters for add liquidity
-     * @param constructedMemo - memo needed for thorchain
-     * @param waitTimeSeconds - wait time for the tx to be confirmed
-     * @param assetClient - passing XchainClient
-     * @param inboundAsgard - inbound Asgard address for the LP
-     * @returns - tx object
+    /** Handles liquidity addition for non-RUNE assets.
+     * @param params - Parameters for add liquidity
+     * @param constructedMemo - Memo needed for thorchain
+     * @param waitTimeSeconds - Wait time for the tx to be confirmed
+     * @param assetClient - XChainClient for the asset.
+     * @param inboundAsgard - Inbound Asgard address for the LP.
+     * @returns - Transaction object.
      */
     addAssetLP(params, constructedMemo, assetClient, inboundAsgard) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Handle EVM chains
             if (this.isEVMChain(params.asset.asset)) {
+                // Prepare parameters for sending a deposit on EVM chains
                 const addParams = {
                     wallIndex: 0,
                     asset: params.asset.asset,
@@ -692,8 +732,10 @@ class Wallet {
                 const hash = yield evmHelper.sendDeposit(addParams);
                 return { hash, url: assetClient.getExplorerTxUrl(hash) };
             }
-            else if (this.isUTXOChain(params.asset.asset)) {
+            else if (this.isUTXOChain(params.asset.asset)) { // Handle UTXO chains
+                // Get fee rates for UTXO chains
                 const feeRates = yield assetClient.getFeeRates(xchainClient.Protocol.THORCHAIN);
+                // Prepare parameters for transferring assets on UTXO chains
                 const addParams = {
                     wallIndex: 0,
                     asset: params.asset.asset,
@@ -703,15 +745,18 @@ class Wallet {
                     feeRate: feeRates.fast,
                 };
                 try {
+                    // Transfer assets with the provided parameters
                     const hash = yield assetClient.transfer(addParams);
                     return { hash, url: assetClient.getExplorerTxUrl(hash) };
                 }
                 catch (err) {
+                    // If an error occurs during the transfer, handle it and return the error message along with the explorer URL of the asset client's address
                     const hash = JSON.stringify(err);
                     return { hash, url: assetClient.getExplorerAddressUrl(yield assetClient.getAddressAsync()) };
                 }
             }
-            else {
+            else { // Handle other chains
+                // Prepare parameters for transferring assets on other chains
                 const addParams = {
                     wallIndex: 0,
                     asset: params.asset.asset,
@@ -720,28 +765,31 @@ class Wallet {
                     memo: constructedMemo,
                 };
                 try {
+                    // Transfer assets with the provided parameters
                     const hash = yield assetClient.transfer(addParams);
                     return { hash, url: assetClient.getExplorerTxUrl(hash) };
                 }
                 catch (err) {
+                    // If an error occurs during the transfer, handle it and return the error message along with the explorer URL of the asset client's address
                     const hash = JSON.stringify(err);
                     return { hash, url: assetClient.getExplorerAddressUrl(yield assetClient.getAddressAsync()) };
                 }
             }
         });
     }
-    /** Function handles liquidity Withdraw for Non rune assets
-     *
-     * @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
+    /** Handles liquidity withdrawal for non-RUNE assets.
+     * @param params - Parameters for withdrawing 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 - Transaction object.
      */
     withdrawAssetLP(params, constructedMemo, assetClient, inboundAsgard) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Handle EVM chains
             if (this.isEVMChain(params.assetFee.asset)) {
+                // Prepare parameters for sending a deposit on EVM chains
                 const withdrawParams = {
                     wallIndex: 0,
                     asset: params.assetFee.asset,
@@ -754,7 +802,9 @@ class Wallet {
                 return { hash, url: assetClient.getExplorerTxUrl(hash) };
             }
             else if (this.isUTXOChain(params.assetFee.asset)) {
+                // Handle UTXO chains
                 const feeRates = yield assetClient.getFeeRates(xchainClient.Protocol.THORCHAIN);
+                // Prepare parameters for transferring assets on UTXO chains
                 const withdrawParams = {
                     wallIndex: 0,
                     asset: params.assetFee.asset,
@@ -764,15 +814,18 @@ class Wallet {
                     feeRate: feeRates.fast,
                 };
                 try {
+                    // Transfer assets with the provided parameters
                     const hash = yield assetClient.transfer(withdrawParams);
                     return { hash, url: assetClient.getExplorerTxUrl(hash) };
                 }
                 catch (err) {
+                    // If an error occurs during the transfer, handle it and return the error message along with the explorer URL of the asset client's address
                     const hash = JSON.stringify(err);
                     return { hash, url: assetClient.getExplorerAddressUrl(yield assetClient.getAddressAsync()) };
                 }
             }
             else {
+                // Handle other chains
                 const withdrawParams = {
                     wallIndex: 0,
                     asset: params.assetFee.asset,
@@ -781,21 +834,22 @@ class Wallet {
                     memo: constructedMemo,
                 };
                 try {
+                    // Transfer assets with the provided parameters
                     const hash = yield assetClient.transfer(withdrawParams);
                     return { hash, url: assetClient.getExplorerTxUrl(hash) };
                 }
                 catch (err) {
+                    // If an error occurs during the transfer, handle it and return the error message along with the explorer URL of the asset client's address
                     const hash = JSON.stringify(err);
                     return { hash, url: assetClient.getExplorerAddressUrl(yield assetClient.getAddressAsync()) };
                 }
             }
         });
     }
-    /** Function handles liquidity Add for Rune only
-     *
-     * @param params - deposit parameters
-     * @param memo - memo needed to withdraw lp
-     * @returns - tx object
+    /** Handles liquidity addition for Rune only.
+     * @param params - Deposit parameters
+     * @param memo - Memo needed to withdraw lp
+     * @returns - Transaction object.
      */
     addRuneLP(params, memo, thorchainClient) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -809,11 +863,10 @@ class Wallet {
             return { hash, url: thorchainClient.getExplorerTxUrl(hash) };
         });
     }
-    /** Function handles liquidity Withdraw for Rune only
-     *
-     * @param params - withdraw parameters
-     * @param memo - memo needed to withdraw lp
-     * @returns - tx object
+    /** Handles liquidity withdrawal for Rune only.
+     * @param params - Withdraw parameters
+     * @param memo - Memo needed to withdraw lp
+     * @returns - Transaction object.
      */
     withdrawRuneLP(params, memo, thorchainClient) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -827,19 +880,35 @@ class Wallet {
             return { hash, url: thorchainClient.getExplorerTxUrl(hash) };
         });
     }
+    /**
+   * Checks if an asset is an ERC20 asset.
+   * @param asset - Asset to check.
+   * @returns - Boolean indicating whether the asset is an ERC20 asset.
+   */
     isERC20Asset(asset) {
         const isGasAsset = ['ETH', 'BSC', 'AVAX'].includes(asset.symbol);
         return this.isEVMChain(asset) && !isGasAsset;
     }
+    /**
+   * Checks if an asset belongs to an EVM chain.
+   * @param asset - Asset to check.
+   * @returns - Boolean indicating whether the asset belongs to an EVM chain.
+   */
     isEVMChain(asset) {
         const isEvmChain = ['ETH', 'BSC', 'AVAX'].includes(asset.chain);
         return isEvmChain;
     }
+    /**
+   * Checks if an asset belongs to a UTXO chain.
+   * @param asset - Asset to check.
+   * @returns - Boolean indicating whether the asset belongs to a UTXO chain.
+   */
     isUTXOChain(asset) {
         return ['BTC', 'BCH', 'DOGE'].includes(asset.chain);
     }
 }
 
+// Create a default ThorchainQuery instance
 const defaultQuery = new xchainThorchainQuery.ThorchainQuery();
 /**
  * THORChain Class for interacting with THORChain.
@@ -848,7 +917,7 @@ const defaultQuery = new xchainThorchainQuery.ThorchainQuery();
  */
 class ThorchainAMM {
     /**
-     * Contructor to create a ThorchainAMM
+     * Contructor to create a ThorchainAMM instance
      *
      * @param thorchainQuery - an instance of the ThorchainQuery
      * @returns ThorchainAMM
@@ -857,16 +926,18 @@ class ThorchainAMM {
         this.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)
-     *
-     * @param params - amount to swap
+     * * Provides an estimate for a swap based on the given swap details.
+     * Checks the parameters for errors before attempting to retrieve the estimate.
+     * Utilizes current pool data to calculate inbound and outbound fees, affiliate fees,
+     * and the expected wait time for the swap (inbound and outbound).
+     * @param params Parameters for the swap, including the amount to swap.
   
-     * @returns The SwapEstimate
+     * @returns The estimated swap details.
      */
     estimateSwap({ fromAsset, amount, destinationAsset, destinationAddress, affiliateAddress = '', interfaceID = `555`, affiliateBps = 0, toleranceBps, wallet, walletIndex, }) {
         return __awaiter(this, void 0, void 0, function* () {
             let errors = [];
+            // If a wallet is provided, validate the swap parameters
             if (wallet) {
                 const params = {
                     input: amount,
@@ -878,6 +949,7 @@ class ThorchainAMM {
                 };
                 errors = yield wallet.validateSwap(params);
             }
+            // Get the swap estimate from the ThorchainQuery instance
             const estimate = yield this.thorchainQuery.quoteSwap({
                 fromAsset,
                 amount,
@@ -888,25 +960,27 @@ class ThorchainAMM {
                 affiliateBps,
                 toleranceBps,
             });
+            // Add any validation errors to the estimate
             estimate.txEstimate.errors.push(...errors);
             estimate.txEstimate.canSwap = errors.length == 0;
             return estimate;
         });
     }
     /**
-     * Conducts a swap with the given inputs. Should be called after estimateSwap() to ensure the swap is valid
+     * Conducts a swap with the given inputs. This method should be called after estimateSwap() to ensure the swap is valid.
      *
-     * @param wallet - wallet to use
-     * @param params - swap params
-     * @returns {SwapSubmitted} - Tx Hash, URL of BlockExplorer and expected wait time.
+     * @param wallet - The wallet to use for the swap.
+     * @param params - The swap parameters.
+     * @returns {SwapSubmitted} - The transaction hash, URL of BlockExplorer, and expected wait time.
      */
     doSwap(wallet, params) {
         return __awaiter(this, void 0, void 0, function* () {
-            // Thorchain-query call satisfies the data needed for executeSwap to be called.
+            // Retrieve swap details from ThorchainQuery to ensure validity
             const txDetails = yield this.thorchainQuery.quoteSwap(params);
             if (!txDetails.txEstimate.canSwap) {
                 throw Error(txDetails.txEstimate.errors.join('\n'));
             }
+            // Execute the swap using the provided wallet
             return yield wallet.executeSwap({
                 input: params.amount,
                 destinationAsset: params.destinationAsset,
@@ -918,19 +992,19 @@ class ThorchainAMM {
         });
     }
     /**
-     * Wraps estimate from thorchain query
-     * @param params - estimate add liquidity
-     * @returns - Estimate add lp object
-     */
+    * Wraps the estimate from ThorchainQuery for adding liquidity.
+    * @param params - The parameters for estimating adding liquidity.
+    * @returns - The estimated liquidity addition object.
+    */
     estimateAddLiquidity(params) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.thorchainQuery.estimateAddLP(params);
         });
     }
     /**
-     * Wraps estimate withdraw from thorchain query
-     * @param params - estimate withdraw liquidity
-     * @returns - Estimate withdraw lp object
+     * Wraps the estimate from ThorchainQuery for withdrawing liquidity.
+     * @param params - The parameters for estimating withdrawing liquidity.
+     * @returns - The estimated liquidity withdrawal object.
      */
     estimateWithdrawLiquidity(params) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -938,9 +1012,9 @@ class ThorchainAMM {
         });
     }
     /**
-     *
-     * @param wallet - wallet class
-     * @param params - liquidity parameters
+     * If there is no existing liquidity position, it is created automatically.
+     * @param wallet - Wallet class
+     * @param params - Liquidity parameter
      * @returns
      */
     addLiquidityPosition(wallet, params) {
@@ -958,14 +1032,14 @@ class ThorchainAMM {
         });
     }
     /**
-     *
-     * @param params - liquidity parameters
-     * @param wallet - wallet needed to perform tx
-     * @return
+     * Withdraws liquidity from a position.
+     * @param params - The wallet to perform the transaction.
+     * @param wallet - The parameters for withdrawing liquidity.
+     * @return - The array of transaction submissions.
      */
     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.
+            // 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 yield wallet.withdrawLiquidity({
                 assetFee: withdrawParams.inbound.fees.asset,
@@ -979,9 +1053,9 @@ class ThorchainAMM {
         });
     }
     /**
-     *
-     * @param addAssetAmount
-     * @returns
+     * Estimates adding to a saver.
+     * @param addAssetAmount The amount to add to the saver.
+     * @returns The estimated addition to the saver object.
      */
     estimateAddSaver(addAssetAmount) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -989,9 +1063,9 @@ class ThorchainAMM {
         });
     }
     /**
-     *
-     * @param withdrawParams
-     * @returns
+     * Estimates withdrawing from a saver.
+     * @param withdrawParams The parameters for withdrawing from the saver.
+     * @returns The estimated withdrawal from the saver object.
      */
     estimateWithdrawSaver(withdrawParams) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -999,9 +1073,9 @@ class ThorchainAMM {
         });
     }
     /**
-     *
-     * @param getsaver
-     * @returns
+     * Retrieves the position of a saver.
+     * @param getsaver The parameters to retrieve the saver position.
+     * @returns The saver position object.
      */
     getSaverPosition(getsaver) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1009,10 +1083,10 @@ class ThorchainAMM {
         });
     }
     /**
-     *
+     * Adds assets to a saver.
      * @param wallet - wallet needed to execute tx
-     * @param addAssetAmount - asset amount being added to savers
-     * @returns - submitted tx
+     * @param addAssetAmount - The amount to add to the saver.
+     * @returns - The submitted transaction.
      */
     addSaver(wallet, addAssetAmount) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1023,10 +1097,10 @@ class ThorchainAMM {
         });
     }
     /**
-     *
-     * @param wallet - wallet to execute the transaction
-     * @param withdrawParams - params needed for withdraw
-     * @returns
+     * Withdraws assets from a saver.
+     * @param wallet - The wallet to perform the transaction.
+     * @param withdrawParams - The parameters for withdrawing from the saver.
+     * @returns The submitted transaction.
      */
     withdrawSaver(wallet, withdrawParams) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1037,9 +1111,9 @@ class ThorchainAMM {
         });
     }
     /**
-     *
-     * @param loanOpenParams
-     * @returns
+     * Retrieves a quote for opening a loan.
+     * @param loanOpenParams The parameters for opening the loan.
+     * @returns The quote for opening the loan.
      */
     getLoanQuoteOpen(loanOpenParams) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1047,9 +1121,9 @@ class ThorchainAMM {
         });
     }
     /**
-     *
-     * @param loanCloseParams
-     * @returns
+     * Retrieves a quote for closing a loan.
+     * @param loanCloseParams The parameters for closing the loan.
+     * @returns The quote for closing the loan.
      */
     getLoanQuoteClose(loanCloseParams) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1057,10 +1131,10 @@ class ThorchainAMM {
         });
     }
     /**
-     *
-     * @param wallet - wallet needed to execute transaction
-     * @param loanOpenParams - params needed to open the loan
-     * @returns - submitted tx
+     * Opens a loan.
+     * @param wallet - The wallet to perform the transaction.
+     * @param loanOpenParams - The parameters for opening the loan.
+     * @returns - The submitted transaction.
      */
     addLoan(wallet, loanOpenParams) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1075,16 +1149,19 @@ class ThorchainAMM {
         });
     }
     /**
-     *
-     * @param wallet - wallet to execute the transaction
-     * @param loanCloseParams - params needed for withdrawing the loan
-     * @returns
+     * Withdraws assets from a loan.
+     * @param wallet - The wallet to perform the transaction.
+     * @param loanCloseParams - The parameters for withdrawing from the loan.
+     * @returns The submitted transaction.
      */
     withdrawLoan(wallet, loanCloseParams) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Retrieves the quote for closing the loan
             const withdrawLoan = yield this.thorchainQuery.getLoanQuoteClose(loanCloseParams);
+            // Checks if there are any errors in the quote
             if (withdrawLoan.errors.length > 0)
                 throw Error(`${withdrawLoan.errors}`);
+            // Executes the loan close transaction
             return yield wallet.loanClose({
                 memo: `${withdrawLoan.memo}`,
                 amount: loanCloseParams.amount,
@@ -1093,9 +1170,9 @@ class ThorchainAMM {
         });
     }
     /**
-     * Get all Thornames and its data associated owned by an address
-     * @param address - address
-     * @returns thornames data
+     * Retrieves all Thornames and their associated data owned by an address.
+     * @param address - The address to retrieve Thornames for.
+     * @returns The Thornames data.
      */
     getThornamesByAddress(address) {
         return __awaiter(this, void 0, void 0, function* () {