@xchainjs/xchain-thorchain-amm 0.8.21 → 0.8.22

package/lib/thorchain-amm.d.ts

@@ -14,117 +14,118 @@ export type AmmEstimateSwapParams = QuoteSwapParams & {
 export declare class ThorchainAMM {
     private thorchainQuery;
     /**
-     * Contructor to create a ThorchainAMM
+     * Contructor to create a ThorchainAMM instance
      *
      * @param thorchainQuery - an instance of the ThorchainQuery
      * @returns ThorchainAMM
      */
     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)
-     *
-     * @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, affiliateBps, toleranceBps, wallet, walletIndex, }: AmmEstimateSwapParams): Promise<TxDetails>;
     /**
-     * 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: Wallet, params: AmmEstimateSwapParams): Promise<TxSubmitted>;
     /**
-     * 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: AddliquidityPosition): Promise<EstimateAddLP>;
     /**
-     * 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: WithdrawLiquidityPosition): Promise<EstimateWithdrawLP>;
     /**
-     *
-     * @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: Wallet, params: AddliquidityPosition): Promise<TxSubmitted[]>;
     /**
-     *
-     * @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: Wallet, params: WithdrawLiquidityPosition): Promise<TxSubmitted[]>;
     /**
-     *
-     * @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: CryptoAmount): Promise<EstimateAddSaver>;
     /**
-     *
-     * @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: SaversWithdraw): Promise<EstimateWithdrawSaver>;
     /**
-     *
-     * @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: getSaver): Promise<SaversPosition>;
     /**
-     *
+     * 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: Wallet, addAssetAmount: CryptoAmount): Promise<TxSubmitted>;
     /**
-     *
-     * @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: Wallet, withdrawParams: SaversWithdraw): Promise<TxSubmitted>;
     /**
-     *
-     * @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: LoanOpenParams): Promise<LoanOpenQuote>;
     /**
-     *
-     * @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: LoanCloseParams): Promise<LoanCloseQuote>;
     /**
-     *
-     * @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: Wallet, loanOpenParams: LoanOpenParams): Promise<TxSubmitted>;
     /**
-     *
-     * @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: Wallet, loanCloseParams: LoanCloseParams): Promise<TxSubmitted>;
     /**
-     * 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: string): Promise<import("@xchainjs/xchain-midgard/lib").ReverseTHORNames | undefined>;
 }

package/lib/types.d.ts

@@ -1,11 +1,17 @@
 import { Balance, FeeOption } from '@xchainjs/xchain-client';
 import { LiquidityPool } from '@xchainjs/xchain-thorchain-query';
 import { Address, Asset, BaseAmount, Chain, CryptoAmount } from '@xchainjs/xchain-util';
+/**
+ * Represents the balance information for all assets on a particular chain.
+ */
 export type AllBalances = {
     chain: Chain;
     address: string;
     balances: Balance[] | string;
 };
+/**
+ * Represents the parameters for executing a swap transaction.
+ */
 export type ExecuteSwap = {
     input: CryptoAmount;
     destinationAsset: Asset;
@@ -14,22 +20,34 @@ export type ExecuteSwap = {
     feeOption?: FeeOption;
     walletIndex: number;
 };
+/**
+ * Represents a submitted transaction.
+ */
 export type TxSubmitted = {
     hash: string;
     url: string;
 };
+/**
+ * Represents a liquidity position in a liquidity pool.
+ */
 export type LiquidityPosition = {
     assetPool: LiquidityPool;
     assetAmount: CryptoAmount;
     runeAmount: CryptoAmount;
     impermanentLossProtection: number;
 };
+/**
+ * Represents the parameters for adding liquidity to a pool.
+ */
 export type AddLiquidity = {
     asset: CryptoAmount;
     rune: CryptoAmount;
     waitTimeSeconds: number;
     assetPool: string;
 };
+/**
+ * Represents the parameters for withdrawing liquidity from a pool.
+ */
 export type WithdrawLiquidity = {
     assetFee: CryptoAmount;
     runeFee: CryptoAmount;
@@ -39,6 +57,9 @@ export type WithdrawLiquidity = {
     assetAddress?: string;
     runeAddress?: string;
 };
+/**
+ * Represents the parameters for depositing an asset.
+ */
 export type DepositParams = {
     walletIndex?: number;
     asset: Asset;
@@ -46,16 +67,25 @@ export type DepositParams = {
     feeOption: FeeOption;
     memo: string;
 };
+/**
+ * Represents the parameters for opening a loan.
+ */
 export type LoanOpenParams = {
     memo: string;
     amount: CryptoAmount;
     toAddress: Address;
 };
+/**
+ * Represents the parameters for closing a loan.
+ */
 export type LoanCloseParams = {
     memo: string;
     amount: CryptoAmount;
     toAddress: Address;
 };
+/**
+ * Represents the parameters for registering a THORName.
+ */
 export type RegisterThornameParams = {
     thorname: string;
     owner?: string;
@@ -64,6 +94,9 @@ export type RegisterThornameParams = {
     preferredAsset?: Asset;
     expirity?: Date;
 };
+/**
+ * Represents the parameters for updating a THORName.
+ */
 export type UpdateThornameParams = {
     thorname: string;
     owner?: string;

package/lib/wallet.d.ts

@@ -16,7 +16,13 @@ import { Address, CryptoAmount } from '@xchainjs/xchain-util';
 import { UtxoClientParams } from '@xchainjs/xchain-utxo';
 import { AddLiquidity, AllBalances, ExecuteSwap, LoanCloseParams, LoanOpenParams, RegisterThornameParams, TxSubmitted, UpdateThornameParams, WithdrawLiquidity } from './types';
 import { EvmHelper } from './utils/evm-helper';
+/**
+ * Represents the URLs for different network nodes.
+ */
 export type NodeUrls = Record<Network, string>;
+/**
+ * Represents configurations for different blockchain chains.
+ */
 export type ChainConfigs = Partial<{
     [BTCChain]: Omit<UtxoClientParams, 'phrase' | 'network'>;
     [BCHChain]: Omit<UtxoClientParams, 'phrase' | 'network'>;
@@ -40,75 +46,86 @@ export declare 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: string, thorchainQuery: ThorchainQuery, chainConfigs?: ChainConfigs);
     /**
-     * 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(): Promise<AllBalances[]>;
     /**
-     * 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: ExecuteSwap): Promise<TxSubmitted>;
-    /** 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: ExecuteSwap): Promise<string[]>;
+    /**
+    * Checks if a given string is a valid THORName.
+    * @param name - Name to check
+    * @returns Boolean indicating whether the name is a valid THORName
+    */
     private isThorname;
-    /** 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
      */
     private swapRuneTo;
-    /** 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
      */
     private swapNonRune;
-    /** 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: 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
+    /** 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: WithdrawLiquidity): Promise<TxSubmitted[]>;
     /**
-     *
-     * @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: CryptoAmount, memo: string, toAddress: Address): Promise<TxSubmitted>;
     /**
-     *
-     * @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: CryptoAmount, memo: string, toAddress: Address): Promise<TxSubmitted>;
+    /**
+    * Opens a new loan.
+    * @param params - Parameters required to open a loan.
+    * @returns An object containing transaction details and explorer URL.
+    */
     loanOpen(params: LoanOpenParams): Promise<TxSubmitted>;
-    loanClose(params: LoanCloseParams): Promise<TxSubmitted>;
     /**
+     * Closes an existing loan.
+     * @param params - Parameters required to close a loan.
+     * @returns An object containing transaction details and explorer URL.
+     */
+    loanClose(params: LoanCloseParams): Promise<TxSubmitted>;
+    /**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
@@ -121,7 +138,7 @@ export declare class Wallet {
      * @returns memo and value of deposit
      */
     registerThorname(params: RegisterThornameParams): Promise<string>;
-    /**
+    /**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
@@ -133,41 +150,52 @@ export declare class Wallet {
      * @returns memo and value of deposit
      */
     updateThorname(params: UpdateThornameParams): Promise<string>;
-    /** 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.
      */
     private addAssetLP;
-    /** 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.
      */
     private withdrawAssetLP;
-    /** 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.
      */
     private addRuneLP;
-    /** 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.
      */
     private withdrawRuneLP;
+    /**
+   * Checks if an asset is an ERC20 asset.
+   * @param asset - Asset to check.
+   * @returns - Boolean indicating whether the asset is an ERC20 asset.
+   */
     private isERC20Asset;
+    /**
+   * 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.
+   */
     private 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.
+   */
     private isUTXOChain;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-amm",
-  "version": "0.8.21",
+  "version": "0.8.22",
   "description": "module that exposes estimating & swappping cryptocurrency assets on thorchain",
   "keywords": [
     "THORChain",
@@ -39,8 +39,10 @@
     "@xchainjs/xchain-thorchain-query": "0.7.3",
     "@xchainjs/xchain-avax": "0.4.5",
     "@xchainjs/xchain-bsc": "0.4.6",
+    "@xchainjs/xchain-cosmos": "1.0.0",
     "@xchainjs/xchain-ethereum": "0.31.5",
-    "@xchainjs/xchain-thorchain": "^1.0.2"
+    "@xchainjs/xchain-thorchain": "1.0.3",
+    "@xchainjs/xchain-mayachain": "1.0.0"
   },
   "devDependencies": {
     "@binance-chain/javascript-sdk": "^4.2.0",
@@ -50,13 +52,11 @@
     "@xchainjs/xchain-bitcoin": "^0.23.10",
     "@xchainjs/xchain-bitcoincash": "^0.17.8",
     "@xchainjs/xchain-client": "^0.16.1",
-    "@xchainjs/xchain-cosmos": "^0.21.10",
     "@xchainjs/xchain-crypto": "^0.3.1",
     "@xchainjs/xchain-doge": "^0.7.10",
     "@xchainjs/xchain-thornode": "^0.3.10",
     "@xchainjs/xchain-evm": "^0.4.4",
     "@xchainjs/xchain-litecoin": "^0.13.9",
-    "@xchainjs/xchain-mayachain": "^0.2.16",
     "@xchainjs/xchain-midgard": "^0.5.2",
     "@xchainjs/xchain-util": "^0.13.1",
     "@xchainjs/xchain-utxo-providers": "^0.2.11",
@@ -81,13 +81,11 @@
     "@xchainjs/xchain-bitcoin": "^0.23.10",
     "@xchainjs/xchain-bitcoincash": "^0.17.8",
     "@xchainjs/xchain-client": "^0.16.1",
-    "@xchainjs/xchain-cosmos": "^0.21.10",
     "@xchainjs/xchain-crypto": "^0.3.1",
     "@xchainjs/xchain-doge": "^0.7.10",
     "@xchainjs/xchain-thornode": "^0.3.10",
     "@xchainjs/xchain-evm": "^0.4.4",
     "@xchainjs/xchain-litecoin": "^0.13.9",
-    "@xchainjs/xchain-mayachain": "^0.2.16",
     "@xchainjs/xchain-midgard": "^0.5.2",
     "@xchainjs/xchain-util": "^0.13.1",
     "@xchainjs/xchain-utxo-providers": "^0.2.11",