@xchainjs/xchain-thorchain-amm 0.3.7 → 0.3.9

package/README.md

@@ -21,45 +21,49 @@ Following peer dependencies have to be installed into your project. These are no
     "@xchainjs/xchain-binance": "^5.6.0",
     "@xchainjs/xchain-bitcoin": "^0.20.0",
     "@xchainjs/xchain-bitcoincash": "^0.15.0",
-    "@xchainjs/xchain-client": "^0.13.0",
+    "@xchainjs/xchain-client": "^0.13.2",
     "@xchainjs/xchain-cosmos": "^0.20.0",
     "@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.3",
-    "@xchainjs/xchain-midgard": "^0.1.0",
-    "@xchainjs/xchain-terra": "^0.3.0",
-    "@xchainjs/xchain-thorchain": "^0.26.0",
-    "@xchainjs/xchain-thorchain-query": "^0.1.2",
-    "@xchainjs/xchain-thornode": "^0.1.0",
-    "@xchainjs/xchain-util": "^0.9.0",
-    "axios": "^0.27.2",
-    "axios-retry": "^3.3.1",
+    "@xchainjs/xchain-evm": "^0.1.0",
+    "@xchainjs/xchain-avax": "^0.1.0",
+    "@xchainjs/xchain-litecoin": "^0.10.5",
+    "@xchainjs/xchain-midgard": "0.3.0",
+    "@xchainjs/xchain-thorchain": "^0.27.2",
+    "@xchainjs/xchain-thorchain-query": "^0.1.8",
+    "@xchainjs/xchain-thornode": "^0.1.2",
+    "@xchainjs/xchain-util": "^0.11.0",
+    "axios": "^0.25.0",
+    "axios-retry": "^3.2.5",
     "bchaddrjs": "^0.5.2",
+    "bech32": "^2.0.0",
     "bech32-buffer": "^0.2.0",
-    "bitcoinjs-lib": "^6.0.1",
+    "bignumber.js": "^9.0.0",
+    "bitcoinjs-lib": "^5.2.0",
     "dotenv": "^16.0.0",
-    "ethers": "^5.6.2"
+    "coininfo": "^5.1.0",
+    "coinselect": "^3.1.12",
+    "ethers": "^5.6.6",
+    "wif": "^2.0.6"
   }
 
 ```
 
-## Examples
+## 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 \
+Add Savers & withdraw Savers: https://replit.com/@thorchain/saversTs#index.ts
 
 ## Documentation
 
-[xchain thorchain-amm](http://docs.xchainjs.org/xchain-thorchain-amm/)
+[xchain-thorchain-amm](http://docs.xchainjs.org/xchain-thorchain-amm/) \
 [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)
-
-##
+## Compiler options
 
 tsconfig compiler options
 

package/lib/index.esm.js

@@ -827,6 +827,110 @@ class Wallet {
             }
         });
     }
+    /**
+     *
+     * @param assetAmount - amount to add
+     * @param memo - memo required
+     * @param waitTimeSeconds - expected wait for the transaction to be processed
+     * @returns
+     */
+    addSavers(assetAmount, memo, toAddress, waitTimeSeconds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const assetClient = this.clients[assetAmount.asset.chain];
+            if (assetAmount.asset.chain === Chain.Ethereum) {
+                const addParams = {
+                    wallIndex: 0,
+                    asset: assetAmount.asset,
+                    amount: assetAmount.baseAmount,
+                    feeOption: FeeOption.Fast,
+                    memo: memo,
+                };
+                const hash = yield this.ethHelper.sendDeposit(addParams);
+                return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
+            }
+            else if (assetAmount.asset.chain === Chain.Avalanche) {
+                const addParams = {
+                    wallIndex: 0,
+                    asset: assetAmount.asset,
+                    amount: assetAmount.baseAmount,
+                    feeOption: FeeOption.Fast,
+                    memo: memo,
+                };
+                const evmHelper = new EvmHelper(this.clients.AVAX, this.thorchainQuery.thorchainCache);
+                const hash = yield evmHelper.sendDeposit(addParams);
+                return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
+            }
+            else {
+                const addParams = {
+                    wallIndex: 0,
+                    asset: assetAmount.asset,
+                    amount: assetAmount.baseAmount,
+                    recipient: toAddress,
+                    memo: memo,
+                };
+                try {
+                    const hash = yield assetClient.transfer(addParams);
+                    return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
+                }
+                catch (err) {
+                    const hash = JSON.stringify(err);
+                    return { hash, url: assetClient.getExplorerAddressUrl(assetClient.getAddress()), waitTimeSeconds };
+                }
+            }
+        });
+    }
+    /**
+     *
+     * @param assetAmount - amount to withdraw
+     * @param memo - memo required
+     * @param waitTimeSeconds - expected wait for the transaction to be processed
+     * @returns
+     */
+    withdrawSavers(dustAssetAmount, memo, toAddress, waitTimeSeconds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const assetClient = this.clients[dustAssetAmount.asset.chain];
+            if (dustAssetAmount.asset.chain === Chain.Ethereum) {
+                const addParams = {
+                    wallIndex: 0,
+                    asset: dustAssetAmount.asset,
+                    amount: dustAssetAmount.baseAmount,
+                    feeOption: FeeOption.Fast,
+                    memo: memo,
+                };
+                const hash = yield this.ethHelper.sendDeposit(addParams);
+                return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
+            }
+            else if (dustAssetAmount.asset.chain === Chain.Avalanche) {
+                const addParams = {
+                    wallIndex: 0,
+                    asset: dustAssetAmount.asset,
+                    amount: dustAssetAmount.baseAmount,
+                    feeOption: FeeOption.Fast,
+                    memo: memo,
+                };
+                const evmHelper = new EvmHelper(this.clients.AVAX, this.thorchainQuery.thorchainCache);
+                const hash = yield evmHelper.sendDeposit(addParams);
+                return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
+            }
+            else {
+                const addParams = {
+                    wallIndex: 0,
+                    asset: dustAssetAmount.asset,
+                    amount: dustAssetAmount.baseAmount,
+                    recipient: toAddress,
+                    memo: memo,
+                };
+                try {
+                    const hash = yield assetClient.transfer(addParams);
+                    return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
+                }
+                catch (err) {
+                    const hash = JSON.stringify(err);
+                    return { hash, url: assetClient.getExplorerAddressUrl(assetClient.getAddress()), waitTimeSeconds };
+                }
+            }
+        });
+    }
     /** Function handles liquidity add for all non rune assets
      *
      * @param params - parameters for add liquidity
@@ -1093,6 +1197,32 @@ class ThorchainAMM {
             });
         });
     }
+    /**
+     *
+     * @param wallet - wallet needed to execute tx
+     * @param addAssetAmount - asset amount being added to savers
+     * @returns - submitted tx
+     */
+    addSaver(wallet, addAssetAmount) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const addEstimate = yield this.thorchainQuery.estimateAddSaver(addAssetAmount);
+            if (!addEstimate.canAddSaver)
+                throw Error(`Cannot add to savers`);
+            return yield wallet.addSavers(addEstimate.assetAmount, addEstimate.memo, addEstimate.toAddress, addEstimate.estimatedWaitTime);
+        });
+    }
+    /**
+     *
+     * @param wallet - wallet to execute the transaction
+     * @param withdrawParams - params needed for withdraw
+     * @returns
+     */
+    withdrawSaver(wallet, withdrawParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const withdrawEstimate = yield this.thorchainQuery.estimateWithdrawSaver(withdrawParams);
+            return yield wallet.withdrawSavers(withdrawEstimate.dustAmount, withdrawEstimate.memo, withdrawEstimate.toAddress, withdrawEstimate.estimatedWaitTime);
+        });
+    }
 }
 
 export { ThorchainAMM, Wallet };

package/lib/index.js

@@ -831,6 +831,110 @@ class Wallet {
             }
         });
     }
+    /**
+     *
+     * @param assetAmount - amount to add
+     * @param memo - memo required
+     * @param waitTimeSeconds - expected wait for the transaction to be processed
+     * @returns
+     */
+    addSavers(assetAmount, memo, toAddress, waitTimeSeconds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const assetClient = this.clients[assetAmount.asset.chain];
+            if (assetAmount.asset.chain === xchainUtil.Chain.Ethereum) {
+                const addParams = {
+                    wallIndex: 0,
+                    asset: assetAmount.asset,
+                    amount: assetAmount.baseAmount,
+                    feeOption: xchainClient.FeeOption.Fast,
+                    memo: memo,
+                };
+                const hash = yield this.ethHelper.sendDeposit(addParams);
+                return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
+            }
+            else if (assetAmount.asset.chain === xchainUtil.Chain.Avalanche) {
+                const addParams = {
+                    wallIndex: 0,
+                    asset: assetAmount.asset,
+                    amount: assetAmount.baseAmount,
+                    feeOption: xchainClient.FeeOption.Fast,
+                    memo: memo,
+                };
+                const evmHelper = new EvmHelper(this.clients.AVAX, this.thorchainQuery.thorchainCache);
+                const hash = yield evmHelper.sendDeposit(addParams);
+                return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
+            }
+            else {
+                const addParams = {
+                    wallIndex: 0,
+                    asset: assetAmount.asset,
+                    amount: assetAmount.baseAmount,
+                    recipient: toAddress,
+                    memo: memo,
+                };
+                try {
+                    const hash = yield assetClient.transfer(addParams);
+                    return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
+                }
+                catch (err) {
+                    const hash = JSON.stringify(err);
+                    return { hash, url: assetClient.getExplorerAddressUrl(assetClient.getAddress()), waitTimeSeconds };
+                }
+            }
+        });
+    }
+    /**
+     *
+     * @param assetAmount - amount to withdraw
+     * @param memo - memo required
+     * @param waitTimeSeconds - expected wait for the transaction to be processed
+     * @returns
+     */
+    withdrawSavers(dustAssetAmount, memo, toAddress, waitTimeSeconds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const assetClient = this.clients[dustAssetAmount.asset.chain];
+            if (dustAssetAmount.asset.chain === xchainUtil.Chain.Ethereum) {
+                const addParams = {
+                    wallIndex: 0,
+                    asset: dustAssetAmount.asset,
+                    amount: dustAssetAmount.baseAmount,
+                    feeOption: xchainClient.FeeOption.Fast,
+                    memo: memo,
+                };
+                const hash = yield this.ethHelper.sendDeposit(addParams);
+                return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
+            }
+            else if (dustAssetAmount.asset.chain === xchainUtil.Chain.Avalanche) {
+                const addParams = {
+                    wallIndex: 0,
+                    asset: dustAssetAmount.asset,
+                    amount: dustAssetAmount.baseAmount,
+                    feeOption: xchainClient.FeeOption.Fast,
+                    memo: memo,
+                };
+                const evmHelper = new EvmHelper(this.clients.AVAX, this.thorchainQuery.thorchainCache);
+                const hash = yield evmHelper.sendDeposit(addParams);
+                return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
+            }
+            else {
+                const addParams = {
+                    wallIndex: 0,
+                    asset: dustAssetAmount.asset,
+                    amount: dustAssetAmount.baseAmount,
+                    recipient: toAddress,
+                    memo: memo,
+                };
+                try {
+                    const hash = yield assetClient.transfer(addParams);
+                    return { hash, url: assetClient.getExplorerTxUrl(hash), waitTimeSeconds };
+                }
+                catch (err) {
+                    const hash = JSON.stringify(err);
+                    return { hash, url: assetClient.getExplorerAddressUrl(assetClient.getAddress()), waitTimeSeconds };
+                }
+            }
+        });
+    }
     /** Function handles liquidity add for all non rune assets
      *
      * @param params - parameters for add liquidity
@@ -1097,6 +1201,32 @@ class ThorchainAMM {
             });
         });
     }
+    /**
+     *
+     * @param wallet - wallet needed to execute tx
+     * @param addAssetAmount - asset amount being added to savers
+     * @returns - submitted tx
+     */
+    addSaver(wallet, addAssetAmount) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const addEstimate = yield this.thorchainQuery.estimateAddSaver(addAssetAmount);
+            if (!addEstimate.canAddSaver)
+                throw Error(`Cannot add to savers`);
+            return yield wallet.addSavers(addEstimate.assetAmount, addEstimate.memo, addEstimate.toAddress, addEstimate.estimatedWaitTime);
+        });
+    }
+    /**
+     *
+     * @param wallet - wallet to execute the transaction
+     * @param withdrawParams - params needed for withdraw
+     * @returns
+     */
+    withdrawSaver(wallet, withdrawParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const withdrawEstimate = yield this.thorchainQuery.estimateWithdrawSaver(withdrawParams);
+            return yield wallet.withdrawSavers(withdrawEstimate.dustAmount, withdrawEstimate.memo, withdrawEstimate.toAddress, withdrawEstimate.estimatedWaitTime);
+        });
+    }
 }
 
 exports.ThorchainAMM = ThorchainAMM;

package/lib/thorchain-amm.d.ts

@@ -1,4 +1,4 @@
-import { AddliquidityPosition, EstimateAddLP, EstimateSwapParams, EstimateWithdrawLP, ThorchainQuery, TxDetails, WithdrawLiquidityPosition } from '@xchainjs/xchain-thorchain-query';
+import { AddliquidityPosition, CryptoAmount, EstimateAddLP, EstimateSwapParams, EstimateWithdrawLP, SaversWithdraw, ThorchainQuery, TxDetails, WithdrawLiquidityPosition } from '@xchainjs/xchain-thorchain-query';
 import { TxSubmitted } from './types';
 import { Wallet } from './wallet';
 /**
@@ -58,4 +58,18 @@ export declare class ThorchainAMM {
      * @return
      */
     withdrawLiquidityPosition(wallet: Wallet, params: WithdrawLiquidityPosition): Promise<TxSubmitted[]>;
+    /**
+     *
+     * @param wallet - wallet needed to execute tx
+     * @param addAssetAmount - asset amount being added to savers
+     * @returns - submitted tx
+     */
+    addSaver(wallet: Wallet, addAssetAmount: CryptoAmount): Promise<TxSubmitted>;
+    /**
+     *
+     * @param wallet - wallet to execute the transaction
+     * @param withdrawParams - params needed for withdraw
+     * @returns
+     */
+    withdrawSaver(wallet: Wallet, withdrawParams: SaversWithdraw): Promise<TxSubmitted>;
 }

package/lib/wallet.d.ts

@@ -1,6 +1,6 @@
 import { Balance, XChainClient } from '@xchainjs/xchain-client';
-import { ThorchainQuery } from '@xchainjs/xchain-thorchain-query';
-import { Chain } from '@xchainjs/xchain-util';
+import { CryptoAmount, ThorchainQuery } from '@xchainjs/xchain-thorchain-query';
+import { Address, Chain } from '@xchainjs/xchain-util';
 import { AddLiquidity, ExecuteSwap, TxSubmitted, WithdrawLiquidity } from './types';
 declare type AllBalances = {
     chain: Chain;
@@ -66,6 +66,22 @@ export declare class Wallet {
      * @returns object with tx response, url and wait time in seconds
      */
     withdrawLiquidity(params: WithdrawLiquidity): Promise<TxSubmitted[]>;
+    /**
+     *
+     * @param assetAmount - amount to add
+     * @param memo - memo required
+     * @param waitTimeSeconds - expected wait for the transaction to be processed
+     * @returns
+     */
+    addSavers(assetAmount: CryptoAmount, memo: string, toAddress: Address, waitTimeSeconds: number): Promise<TxSubmitted>;
+    /**
+     *
+     * @param assetAmount - amount to withdraw
+     * @param memo - memo required
+     * @param waitTimeSeconds - expected wait for the transaction to be processed
+     * @returns
+     */
+    withdrawSavers(dustAssetAmount: CryptoAmount, memo: string, toAddress: Address, waitTimeSeconds: number): Promise<TxSubmitted>;
     /** Function handles liquidity add for all non rune assets
      *
      * @param params - parameters for add liquidity

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-amm",
-  "version": "0.3.7",
+  "version": "0.3.9",
   "description": "module that exposes estimating & swappping cryptocurrency assets on thorchain",
   "keywords": [
     "THORChain",
@@ -39,22 +39,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-client": "^0.13.2",
-    "@xchainjs/xchain-cosmos": "^0.20.0",
+    "@xchainjs/xchain-binance": "^5.6.5",
+    "@xchainjs/xchain-bitcoin": "^0.20.5",
+    "@xchainjs/xchain-bitcoincash": "^0.15.4",
+    "@xchainjs/xchain-client": "^0.13.3",
+    "@xchainjs/xchain-cosmos": "^0.20.4",
     "@xchainjs/xchain-crypto": "^0.2.6",
-    "@xchainjs/xchain-doge": "^0.5.0",
-    "@xchainjs/xchain-ethereum": "^0.27.0",
-    "@xchainjs/xchain-evm": "^0.1.0",
-    "@xchainjs/xchain-avax": "^0.1.0",
-    "@xchainjs/xchain-litecoin": "^0.10.5",
-    "@xchainjs/xchain-midgard": "0.2.0",
-    "@xchainjs/xchain-thorchain": "^0.27.2",
-    "@xchainjs/xchain-thorchain-query": "^0.1.6",
-    "@xchainjs/xchain-thornode": "^0.1.1",
+    "@xchainjs/xchain-doge": "^0.5.5",
+    "@xchainjs/xchain-ethereum": "^0.27.4",
+    "@xchainjs/xchain-evm": "^0.1.1",
+    "@xchainjs/xchain-avax": "^0.1.1",
+    "@xchainjs/xchain-litecoin": "^0.10.6",
+    "@xchainjs/xchain-midgard": "0.3.0",
+    "@xchainjs/xchain-thorchain": "^0.27.4",
+    "@xchainjs/xchain-thorchain-query": "^0.1.9",
+    "@xchainjs/xchain-thornode": "^0.1.2",
     "@xchainjs/xchain-util": "^0.11.0",
     "axios": "^0.25.0",
     "axios-retry": "^3.2.5",
@@ -73,21 +72,21 @@
     "@binance-chain/javascript-sdk": "^4.2.0",
     "@cosmos-client/core": "0.45.13",
     "@psf/bitcoincashjs-lib": "^4.0.2",
-    "@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.3",
+    "@xchainjs/xchain-binance": "^5.6.5",
+    "@xchainjs/xchain-bitcoin": "^0.20.5",
+    "@xchainjs/xchain-bitcoincash": "^0.15.4",
+    "@xchainjs/xchain-client": "^0.13.3",
+    "@xchainjs/xchain-cosmos": "^0.20.4",
     "@xchainjs/xchain-crypto": "^0.2.6",
-    "@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.27.1",
-    "@xchainjs/xchain-thorchain-query": "^0.1.2",
+    "@xchainjs/xchain-doge": "^0.5.5",
+    "@xchainjs/xchain-ethereum": "^0.27.4",
+    "@xchainjs/xchain-evm": "^0.1.1",
+    "@xchainjs/xchain-avax": "^0.1.1",
+    "@xchainjs/xchain-litecoin": "^0.10.6",
+    "@xchainjs/xchain-midgard": "0.3.0",
+    "@xchainjs/xchain-thorchain": "^0.27.4",
+    "@xchainjs/xchain-thorchain-query": "^0.1.9",
+    "@xchainjs/xchain-thornode": "^0.1.2",
     "@xchainjs/xchain-util": "^0.11.0",
     "axios": "^0.25.0",
     "axios-retry": "^3.2.5",