@xchainjs/xchain-thorchain-amm 0.3.6 → 0.3.8

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
@@ -997,14 +1101,16 @@ class ThorchainAMM {
      * @returns The SwapEstimate
      */
     estimateSwap({ input, destinationAsset, destinationAddress, affiliateAddress = '', interfaceID = `555`, affiliateFeeBasisPoints = 0, slipLimit, }) {
-        return this.thorchainQuery.estimateSwap({
-            input,
-            destinationAsset,
-            destinationAddress,
-            affiliateAddress,
-            interfaceID,
-            affiliateFeeBasisPoints,
-            slipLimit,
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.thorchainQuery.estimateSwap({
+                input,
+                destinationAsset,
+                destinationAddress,
+                affiliateAddress,
+                interfaceID,
+                affiliateFeeBasisPoints,
+                slipLimit,
+            });
         });
     }
     /**
@@ -1037,7 +1143,7 @@ class ThorchainAMM {
      */
     estimateAddLiquidity(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.thorchainQuery.estimateAddLP(params);
+            return yield this.thorchainQuery.estimateAddLP(params);
         });
     }
     /**
@@ -1047,7 +1153,7 @@ class ThorchainAMM {
      */
     estimateWithdrawLiquidity(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.thorchainQuery.estimateWithdrawLP(params);
+            return yield this.thorchainQuery.estimateWithdrawLP(params);
         });
     }
     /**
@@ -1062,7 +1168,7 @@ class ThorchainAMM {
             const checkLPAdd = yield this.thorchainQuery.estimateAddLP(params);
             if (!checkLPAdd.canAdd)
                 throw Error(`${checkLPAdd.errors}`);
-            return wallet.addLiquidity({
+            return yield wallet.addLiquidity({
                 asset: params.asset,
                 rune: params.rune,
                 waitTimeSeconds: checkLPAdd.estimatedWaitSeconds,
@@ -1080,7 +1186,7 @@ class ThorchainAMM {
         return __awaiter(this, void 0, void 0, function* () {
             // Caution Dust Limits: BTC,BCH,LTC chains 10k sats; DOGE 1m Sats; ETH 0 wei; THOR 0 RUNE.
             const withdrawParams = yield this.thorchainQuery.estimateWithdrawLP(params);
-            return wallet.withdrawLiquidity({
+            return yield wallet.withdrawLiquidity({
                 assetFee: withdrawParams.inbound.fees.asset,
                 runeFee: withdrawParams.inbound.fees.rune,
                 waitTimeSeconds: withdrawParams.estimatedWaitSeconds,
@@ -1091,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
@@ -1001,14 +1105,16 @@ class ThorchainAMM {
      * @returns The SwapEstimate
      */
     estimateSwap({ input, destinationAsset, destinationAddress, affiliateAddress = '', interfaceID = `555`, affiliateFeeBasisPoints = 0, slipLimit, }) {
-        return this.thorchainQuery.estimateSwap({
-            input,
-            destinationAsset,
-            destinationAddress,
-            affiliateAddress,
-            interfaceID,
-            affiliateFeeBasisPoints,
-            slipLimit,
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.thorchainQuery.estimateSwap({
+                input,
+                destinationAsset,
+                destinationAddress,
+                affiliateAddress,
+                interfaceID,
+                affiliateFeeBasisPoints,
+                slipLimit,
+            });
         });
     }
     /**
@@ -1041,7 +1147,7 @@ class ThorchainAMM {
      */
     estimateAddLiquidity(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.thorchainQuery.estimateAddLP(params);
+            return yield this.thorchainQuery.estimateAddLP(params);
         });
     }
     /**
@@ -1051,7 +1157,7 @@ class ThorchainAMM {
      */
     estimateWithdrawLiquidity(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.thorchainQuery.estimateWithdrawLP(params);
+            return yield this.thorchainQuery.estimateWithdrawLP(params);
         });
     }
     /**
@@ -1066,7 +1172,7 @@ class ThorchainAMM {
             const checkLPAdd = yield this.thorchainQuery.estimateAddLP(params);
             if (!checkLPAdd.canAdd)
                 throw Error(`${checkLPAdd.errors}`);
-            return wallet.addLiquidity({
+            return yield wallet.addLiquidity({
                 asset: params.asset,
                 rune: params.rune,
                 waitTimeSeconds: checkLPAdd.estimatedWaitSeconds,
@@ -1084,7 +1190,7 @@ class ThorchainAMM {
         return __awaiter(this, void 0, void 0, function* () {
             // Caution Dust Limits: BTC,BCH,LTC chains 10k sats; DOGE 1m Sats; ETH 0 wei; THOR 0 RUNE.
             const withdrawParams = yield this.thorchainQuery.estimateWithdrawLP(params);
-            return wallet.withdrawLiquidity({
+            return yield wallet.withdrawLiquidity({
                 assetFee: withdrawParams.inbound.fees.asset,
                 runeFee: withdrawParams.inbound.fees.rune,
                 waitTimeSeconds: withdrawParams.estimatedWaitSeconds,
@@ -1095,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.6",
+  "version": "0.3.8",
   "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.5",
-    "@xchainjs/xchain-midgard": "0.2.0",
+    "@xchainjs/xchain-midgard": "0.3.0",
     "@xchainjs/xchain-thorchain": "^0.27.2",
-    "@xchainjs/xchain-thorchain-query": "^0.1.6",
-    "@xchainjs/xchain-thornode": "^0.1.1",
+    "@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",