npm - @shapeshiftoss/swapper - Versions diffs - 11.5.0 → 11.5.2 - Mend

@shapeshiftoss/swapper 11.5.0 → 11.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/dist/swappers/thorchain/constants.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export declare const RUNE_OUTBOUND_TRANSACTION_FEE_CRYPTO_HUMAN: import("bignumber.js").default;
2	+ export declare const MINIMUM_USD_TRADE_AMOUNT: import("bignumber.js").default;

package/dist/swappers/thorchain/constants.js ADDED Viewed

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MINIMUM_USD_TRADE_AMOUNT = exports.RUNE_OUTBOUND_TRANSACTION_FEE_CRYPTO_HUMAN = void 0;
+const bignumber_1 = require("../utils/bignumber");
+// TODO: read from https://daemon.thorchain.shapeshift.com/lcd/thorchain/constants
+exports.RUNE_OUTBOUND_TRANSACTION_FEE_CRYPTO_HUMAN = (0, bignumber_1.bn)('0.02');
+exports.MINIMUM_USD_TRADE_AMOUNT = (0, bignumber_1.bn)(1);

package/dist/swappers/thorchain/getThorTradeQuote/getTradeQuote.js CHANGED Viewed

@@ -5,17 +5,18 @@ const caip_1 = require("@shapeshiftoss/caip");
 const api_1 = require("../../../api");
 const bignumber_1 = require("../../utils/bignumber");
 const constants_1 = require("../../utils/constants");
+const constants_2 = require("../constants");
 const getThorTxData_1 = require("../utils/bitcoin/utils/getThorTxData");
-const constants_2 = require("../utils/constants");
-const estimateTradeFee_1 = require("../utils/estimateTradeFee/estimateTradeFee");
+const constants_3 = require("../utils/constants");
+const estimateBuyAssetTradeFeeCrypto_1 = require("../utils/estimateBuyAssetTradeFeeCrypto/estimateBuyAssetTradeFeeCrypto");
 const getThorTxData_2 = require("../utils/ethereum/utils/getThorTxData");
 const getTradeRate_1 = require("../utils/getTradeRate/getTradeRate");
 const getUsdRate_1 = require("../utils/getUsdRate/getUsdRate");
+const isRune_1 = require("../utils/isRune/isRune");
 const getBtcTxFees_1 = require("../utils/txFeeHelpers/btcTxFees/getBtcTxFees");
 const getEthTxFees_1 = require("../utils/txFeeHelpers/ethTxFees/getEthTxFees");
-const MINIMUM_USD_TRADE_AMOUNT = (0, bignumber_1.bn)(1);
 const getThorTradeQuote = async ({ deps, input }) => {
-    const { sellAsset, buyAsset, sellAmount, bip44Params, chainId, receiveAddress } = input;
+    const { sellAsset, buyAsset, sellAmount: sellAmountCryptoPrecision, bip44Params, chainId, receiveAddress, } = input;
     if (!bip44Params) {
         throw new Error('bip44Params required in getThorTradeQuote');
     }
@@ -27,28 +28,41 @@ const getThorTradeQuote = async ({ deps, input }) => {
                 code: api_1.SwapErrorTypes.UNSUPPORTED_CHAIN,
                 details: { chainId },
             });
-        const rate = await (0, getTradeRate_1.getTradeRate)(sellAsset, buyAsset.assetId, sellAmount, deps);
-        const buyAmount = (0, bignumber_1.toBaseUnit)((0, bignumber_1.bnOrZero)((0, bignumber_1.fromBaseUnit)(sellAmount, sellAsset.precision)).times(rate), buyAsset.precision);
-        const estimatedTradeFee = await (0, estimateTradeFee_1.estimateTradeFee)(deps, buyAsset);
+        const rate = await (0, getTradeRate_1.getTradeRate)(sellAsset, buyAsset.assetId, sellAmountCryptoPrecision, deps);
+        const buyAmountCryptoPrecision = (0, bignumber_1.toBaseUnit)((0, bignumber_1.bnOrZero)((0, bignumber_1.fromBaseUnit)(sellAmountCryptoPrecision, sellAsset.precision)).times(rate), buyAsset.precision);
+        const estimatedBuyAssetTradeFeeCryptoHuman = await (0, estimateBuyAssetTradeFeeCrypto_1.estimateBuyAssetTradeFeeCrypto)(deps, buyAsset);
         const buyAssetUsdRate = await (0, getUsdRate_1.getUsdRate)({ deps, input: { assetId: buyAsset.assetId } });
-        const minTradeFeeAmount = MINIMUM_USD_TRADE_AMOUNT.div(buyAssetUsdRate);
-        const buyAssetTradeFeeUsd = minTradeFeeAmount.gt(estimatedTradeFee)
-            ? minTradeFeeAmount.toString()
-            : estimatedTradeFee;
-        const sellAssetTradeFee = (0, bignumber_1.bnOrZero)(buyAssetTradeFeeUsd).dividedBy((0, bignumber_1.bnOrZero)(rate));
+        const sellAssetUsdRate = await (0, getUsdRate_1.getUsdRate)({ deps, input: { assetId: sellAsset.assetId } });
+        const estimatedBuyAssetTradeFeeUsd = (0, bignumber_1.bn)(buyAssetUsdRate)
+            .times(estimatedBuyAssetTradeFeeCryptoHuman)
+            .toString();
+        const buyAssetTradeFeeUsdOrMinimum = constants_2.MINIMUM_USD_TRADE_AMOUNT.gt(estimatedBuyAssetTradeFeeUsd)
+            ? constants_2.MINIMUM_USD_TRADE_AMOUNT.toString()
+            : estimatedBuyAssetTradeFeeUsd;
+        const sellAssetTradeFeeCryptoHuman = (() => {
+            // The 1$ minimum doesn't apply for swaps to RUNE, use OutboundTransactionFee in human value instead
+            if ((0, isRune_1.isRune)(buyAsset === null || buyAsset === void 0 ? void 0 : buyAsset.assetId))
+                return constants_2.RUNE_OUTBOUND_TRANSACTION_FEE_CRYPTO_HUMAN;
+            return (0, bignumber_1.bnOrZero)(buyAssetTradeFeeUsdOrMinimum).div(sellAssetUsdRate);
+        })();
         // minimum is tradeFee padded by an amount to be sure they get something back
         // usually it will be slightly more than the amount because sellAssetTradeFee is already a high estimate
-        const minimum = (0, bignumber_1.bnOrZero)(sellAssetTradeFee).times(constants_2.THOR_MINIMUM_PADDING).toString();
+        const minimumCryptoHuman = (0, bignumber_1.bnOrZero)(sellAssetTradeFeeCryptoHuman)
+            .times(constants_3.THOR_MINIMUM_PADDING)
+            .toString();
+        const buyAssetTradeFeeUsdOrDefault = (0, isRune_1.isRune)(buyAsset === null || buyAsset === void 0 ? void 0 : buyAsset.assetId)
+            ? (0, bignumber_1.bn)(buyAssetUsdRate).times(constants_2.RUNE_OUTBOUND_TRANSACTION_FEE_CRYPTO_HUMAN).toString()
+            : buyAssetTradeFeeUsdOrMinimum;
         const commonQuoteFields = {
             rate,
-            maximum: constants_2.MAX_THORCHAIN_TRADE,
-            sellAmount,
-            buyAmount,
+            maximum: constants_3.MAX_THORCHAIN_TRADE,
+            sellAmount: sellAmountCryptoPrecision,
+            buyAmount: buyAmountCryptoPrecision,
             sources: [{ name: 'thorchain', proportion: '1' }],
             buyAsset,
             sellAsset,
             bip44Params,
-            minimum,
+            minimum: minimumCryptoHuman,
         };
         const { chainNamespace } = (0, caip_1.fromAssetId)(sellAsset.assetId);
         switch (chainNamespace) {
@@ -58,15 +72,15 @@ const getThorTradeQuote = async ({ deps, input }) => {
                         deps,
                         sellAsset,
                         buyAsset,
-                        sellAmount,
+                        sellAmount: sellAmountCryptoPrecision,
                         slippageTolerance: constants_1.DEFAULT_SLIPPAGE,
                         destinationAddress: receiveAddress,
-                        buyAssetTradeFeeUsd,
+                        buyAssetTradeFeeUsd: buyAssetTradeFeeUsdOrMinimum,
                     });
                     const feeData = await (0, getEthTxFees_1.getEthTxFees)({
                         adapterManager: deps.adapterManager,
                         sellAssetReference,
-                        buyAssetTradeFeeUsd,
+                        buyAssetTradeFeeUsd: buyAssetTradeFeeUsdOrMinimum,
                     });
                     return {
                         ...commonQuoteFields,
@@ -80,19 +94,19 @@ const getThorTradeQuote = async ({ deps, input }) => {
                         deps,
                         sellAsset,
                         buyAsset,
-                        sellAmount,
+                        sellAmount: sellAmountCryptoPrecision,
                         slippageTolerance: constants_1.DEFAULT_SLIPPAGE,
                         destinationAddress: receiveAddress,
                         xpub: input.xpub,
-                        buyAssetTradeFeeUsd,
+                        buyAssetTradeFeeUsd: buyAssetTradeFeeUsdOrMinimum,
                     });
                     const feeData = await (0, getBtcTxFees_1.getBtcTxFees)({
-                        sellAmount,
+                        sellAmount: sellAmountCryptoPrecision,
                         vault,
                         opReturnData,
                         pubkey,
                         sellAdapter: sellAdapter,
-                        buyAssetTradeFeeUsd,
+                        buyAssetTradeFeeUsd: buyAssetTradeFeeUsdOrMinimum,
                     });
                     return {
                         ...commonQuoteFields,
@@ -109,8 +123,8 @@ const getThorTradeQuote = async ({ deps, input }) => {
                         feeData: {
                             fee: feeData.fast.txFee,
                             networkFee: feeData.fast.txFee,
-                            tradeFee: buyAssetTradeFeeUsd,
-                            buyAssetTradeFeeUsd,
+                            tradeFee: buyAssetTradeFeeUsdOrDefault,
+                            buyAssetTradeFeeUsd: buyAssetTradeFeeUsdOrDefault,
                             sellAssetTradeFeeUsd: '0',
                             chainSpecific: { estimatedGas: feeData.fast.chainSpecific.gasLimit },
                         },

package/dist/swappers/thorchain/utils/estimateBuyAssetTradeFeeCrypto/estimateBuyAssetTradeFeeCrypto.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { Asset } from '@shapeshiftoss/asset-service';
+import { ThorchainSwapperDeps } from '../../types';
+export declare const estimateBuyAssetTradeFeeCrypto: (deps: ThorchainSwapperDeps, buyAsset: Asset) => Promise<string>;

package/dist/swappers/thorchain/utils/{estimateTradeFee/estimateTradeFee.js → estimateBuyAssetTradeFeeCrypto/estimateBuyAssetTradeFeeCrypto.js} RENAMED Viewed

@@ -1,20 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.estimateTradeFee = void 0;
+exports.estimateBuyAssetTradeFeeCrypto = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
 const api_1 = require("../../../../api");
-const constants_1 = require("../constants");
+const constants_1 = require("../../constants");
+const constants_2 = require("../constants");
 const getPriceRatio_1 = require("../getPriceRatio/getPriceRatio");
 const isRune_1 = require("../isRune/isRune");
 const thorService_1 = require("../thorService");
-// TODO rename this estimateOutboundFee or similar
-const estimateTradeFee = async (deps, buyAsset) => {
+const estimateBuyAssetTradeFeeCrypto = async (deps, buyAsset) => {
     if ((0, isRune_1.isRune)(buyAsset.assetId)) {
-        return '0.02'; // todo - read from TC mimir/constants
+        return constants_1.RUNE_OUTBOUND_TRANSACTION_FEE_CRYPTO_HUMAN.toString();
     }
     const thorId = caip_1.adapters.assetIdToPoolAssetId({ assetId: buyAsset.assetId });
     if (!thorId)
-        throw new api_1.SwapError('[estimateTradeFee] - undefined thorId for given buyAssetId', {
+        throw new api_1.SwapError('[estimateBuyAssetTradeFeeCrypto] - undefined thorId for given buyAssetId', {
             code: api_1.SwapErrorTypes.VALIDATION_FAILED,
             details: { buyAssetId: buyAsset.assetId },
         });
@@ -22,7 +22,7 @@ const estimateTradeFee = async (deps, buyAsset) => {
     const { data: inboundAddresses } = await thorService_1.thorService.get(`${deps.daemonUrl}/lcd/thorchain/inbound_addresses`);
     const inboundInfo = inboundAddresses.find((inbound) => inbound.chain === thorPoolChainId);
     if (!inboundInfo)
-        throw new api_1.SwapError('[estimateTradeFee] - unable to locate inbound pool info', {
+        throw new api_1.SwapError('[estimateBuyAssetTradeFeeCrypto] - unable to locate inbound pool info', {
             code: api_1.SwapErrorTypes.VALIDATION_FAILED,
             details: { thorPoolChainId },
         });
@@ -30,13 +30,13 @@ const estimateTradeFee = async (deps, buyAsset) => {
     const { chainId: buyChainId } = (0, caip_1.fromAssetId)(buyAsset.assetId);
     const buyAdapter = deps.adapterManager.get(buyChainId);
     if (!buyAdapter)
-        throw new api_1.SwapError('[estimateTradeFee] - unable to get buy asset adapter', {
+        throw new api_1.SwapError('[estimateBuyAssetTradeFeeCrypto] - unable to get buy asset adapter', {
             code: api_1.SwapErrorTypes.VALIDATION_FAILED,
             details: { buyChainId },
         });
     const buyFeeAssetId = buyAdapter.getFeeAssetId();
     if (!buyFeeAssetId)
-        throw new api_1.SwapError('[estimateTradeFee] - no fee assetId', {
+        throw new api_1.SwapError('[estimateBuyAssetTradeFeeCrypto] - no fee assetId', {
             code: api_1.SwapErrorTypes.VALIDATION_FAILED,
             details: { buyAssetId: buyAsset.assetId },
         });
@@ -46,11 +46,11 @@ const estimateTradeFee = async (deps, buyAsset) => {
             buyAssetId: buyFeeAssetId,
         })
         : '1';
-    if (!constants_1.THOR_TRADE_FEE_MULTIPLIERS[buyChainId])
-        throw new api_1.SwapError('[estimateTradeFee] - no trade fee multiplier', {
+    if (!constants_2.THOR_TRADE_FEE_MULTIPLIERS[buyChainId])
+        throw new api_1.SwapError('[estimateBuyAssetTradeFeeCrypto] - no trade fee multiplier', {
             code: api_1.SwapErrorTypes.VALIDATION_FAILED,
             details: { buyChainId },
         });
-    return constants_1.THOR_TRADE_FEE_MULTIPLIERS[buyChainId].times(buyFeeAssetRatio).times(gasRate).toString();
+    return constants_2.THOR_TRADE_FEE_MULTIPLIERS[buyChainId].times(buyFeeAssetRatio).times(gasRate).toString();
 };
-exports.estimateTradeFee = estimateTradeFee;
+exports.estimateBuyAssetTradeFeeCrypto = estimateBuyAssetTradeFeeCrypto;

package/dist/swappers/thorchain/utils/getLimit/getLimit.js CHANGED Viewed

@@ -5,19 +5,21 @@ const api_1 = require("../../../../api");
 const bignumber_1 = require("../../../utils/bignumber");
 const constants_1 = require("../constants");
 const getTradeRate_1 = require("../getTradeRate/getTradeRate");
+const getUsdRate_1 = require("../getUsdRate/getUsdRate");
 const getLimit = async ({ sellAsset, buyAsset, sellAmount, deps, slippageTolerance, buyAssetTradeFeeUsd, }) => {
     const tradeRate = await (0, getTradeRate_1.getTradeRate)(sellAsset, buyAsset.assetId, sellAmount, deps);
-    const expectedBuyAmountPrecision8 = (0, bignumber_1.toBaseUnit)((0, bignumber_1.fromBaseUnit)((0, bignumber_1.bnOrZero)(sellAmount).times(tradeRate), sellAsset.precision), constants_1.THORCHAIN_FIXED_PRECISION);
+    const buyAssetUsdRate = await (0, getUsdRate_1.getUsdRate)({ deps, input: { assetId: buyAsset.assetId } });
+    const expectedBuyAmountCryptoPrecision8 = (0, bignumber_1.toBaseUnit)((0, bignumber_1.fromBaseUnit)((0, bignumber_1.bnOrZero)(sellAmount).times(tradeRate), sellAsset.precision), constants_1.THORCHAIN_FIXED_PRECISION);
     const isValidSlippageRange = (0, bignumber_1.bnOrZero)(slippageTolerance).gte(0) && (0, bignumber_1.bnOrZero)(slippageTolerance).lte(1);
-    if ((0, bignumber_1.bnOrZero)(expectedBuyAmountPrecision8).lt(0) || !isValidSlippageRange)
+    if ((0, bignumber_1.bnOrZero)(expectedBuyAmountCryptoPrecision8).lt(0) || !isValidSlippageRange)
         throw new api_1.SwapError('[getThorTxInfo]: bad expected buy amount or bad slippage tolerance', {
             code: api_1.SwapErrorTypes.BUILD_TRADE_FAILED,
-            details: { expectedBuyAmountPrecision8, slippageTolerance },
+            details: { expectedBuyAmountCryptoPrecision8, slippageTolerance },
         });
-    const tradeFeePrecision8 = (0, bignumber_1.toBaseUnit)((0, bignumber_1.bnOrZero)(buyAssetTradeFeeUsd), constants_1.THORCHAIN_FIXED_PRECISION);
-    return (0, bignumber_1.bnOrZero)(expectedBuyAmountPrecision8)
+    const tradeFeeCryptoPrecision8 = (0, bignumber_1.toBaseUnit)((0, bignumber_1.bnOrZero)(buyAssetTradeFeeUsd).div(buyAssetUsdRate), constants_1.THORCHAIN_FIXED_PRECISION);
+    return (0, bignumber_1.bnOrZero)(expectedBuyAmountCryptoPrecision8)
         .times((0, bignumber_1.bn)(1).minus(slippageTolerance))
-        .minus((0, bignumber_1.bnOrZero)(tradeFeePrecision8))
+        .minus((0, bignumber_1.bnOrZero)(tradeFeeCryptoPrecision8))
         .decimalPlaces(0)
         .toString();
 };

package/dist/swappers/zrx/zrxBuildTrade/zrxBuildTrade.js CHANGED Viewed

@@ -36,7 +36,7 @@ const constants_2 = require("../utils/constants");
 const helpers_2 = require("../utils/helpers/helpers");
 const zrxService_1 = require("../utils/zrxService");
 async function zrxBuildTrade({ adapter, web3 }, input) {
-    var _a, _b, _c;
+    var _a;
     const { sellAsset, buyAsset, sellAmount, slippage, bip44Params, receiveAddress } = input;
     try {
         const { assetReference: buyAssetErc20Address, assetNamespace: buyAssetNamespace } = (0, caip_1.fromAssetId)(buyAsset.assetId);
@@ -92,6 +92,18 @@ async function zrxBuildTrade({ adapter, web3 }, input) {
         const { data } = quoteResponse;
         const estimatedGas = (0, bignumber_1.bnOrZero)(data.gas || 0);
         const networkFee = (0, bignumber_1.bnOrZero)(estimatedGas).multipliedBy((0, bignumber_1.bnOrZero)(data.gasPrice)).toString();
+        const allowanceRequired = await (0, helpers_1.getAllowanceRequired)({
+            adapter,
+            sellAsset,
+            allowanceContract: data.allowanceTarget,
+            receiveAddress,
+            sellAmount: data.sellAmount,
+            web3,
+            erc20AllowanceAbi: erc20Allowance_abi_1.erc20AllowanceAbi,
+        });
+        const approvalFee = (0, bignumber_1.bnOrZero)(constants_1.APPROVAL_GAS_LIMIT)
+            .multipliedBy((0, bignumber_1.bnOrZero)(data.gasPrice))
+            .toString();
         const trade = {
             sellAsset,
             buyAsset,
@@ -104,6 +116,7 @@ async function zrxBuildTrade({ adapter, web3 }, input) {
                 chainSpecific: {
                     estimatedGas: estimatedGas.toString(),
                     gasPrice: data.gasPrice,
+                    approvalFee: allowanceRequired.gt(0) ? approvalFee : undefined,
                 },
                 tradeFee: '0',
                 networkFee,
@@ -115,27 +128,6 @@ async function zrxBuildTrade({ adapter, web3 }, input) {
             buyAmount: data.buyAmount,
             sources: ((_a = data.sources) === null || _a === void 0 ? void 0 : _a.filter((s) => parseFloat(s.proportion) > 0)) || constants_2.DEFAULT_SOURCE,
         };
-        const allowanceRequired = await (0, helpers_1.getAllowanceRequired)({
-            adapter,
-            sellAsset,
-            allowanceContract: data.allowanceTarget,
-            receiveAddress,
-            sellAmount: data.sellAmount,
-            web3,
-            erc20AllowanceAbi: erc20Allowance_abi_1.erc20AllowanceAbi,
-        });
-        if (allowanceRequired) {
-            trade.feeData = {
-                fee: ((_b = trade.feeData) === null || _b === void 0 ? void 0 : _b.fee) || '0',
-                chainSpecific: {
-                    ...(_c = trade.feeData) === null || _c === void 0 ? void 0 : _c.chainSpecific,
-                    approvalFee: (0, bignumber_1.bnOrZero)(constants_1.APPROVAL_GAS_LIMIT)
-                        .multipliedBy((0, bignumber_1.bnOrZero)(data.gasPrice))
-                        .toString(),
-                },
-                tradeFee: '0',
-            };
-        }
         return trade;
     }
     catch (e) {

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "11.5.0",
+  "version": "11.5.2",
   "description": "An interface and implementations to trade coins via various protocols",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",

package/dist/swappers/thorchain/utils/estimateTradeFee/estimateTradeFee.d.ts DELETED Viewed

@@ -1,3 +0,0 @@
-import { Asset } from '@shapeshiftoss/asset-service';
-import { ThorchainSwapperDeps } from '../../types';
-export declare const estimateTradeFee: (deps: ThorchainSwapperDeps, buyAsset: Asset) => Promise<string>;