@shapeshiftoss/swapper 12.1.0 → 13.0.0

package/dist/api.d.ts

@@ -62,10 +62,6 @@ export declare type QuoteFeeData<T extends ChainId> = {
     networkFee: string;
     buyAssetTradeFeeUsd: string;
     sellAssetTradeFeeUsd?: string;
-    /** @deprecated Use networkFee instead */
-    fee: string;
-    /** @deprecated Use sellAssetTradeFeeUsd instead */
-    tradeFee: string;
 } & ChainSpecificQuoteFeeData<T>;
 export declare type ByPairInput = {
     sellAssetId: AssetId;

package/dist/swappers/cow/cowBuildTrade/cowBuildTrade.js

@@ -79,13 +79,11 @@ async function cowBuildTrade(deps, input) {
         const trade = {
             rate,
             feeData: {
-                fee: '0',
                 networkFee: '0',
                 chainSpecific: {
                     estimatedGas: feeData.chainSpecific.gasLimit,
                     gasPrice: feeData.chainSpecific.gasPrice,
                 },
-                tradeFee: '0',
                 buyAssetTradeFeeUsd: '0',
                 sellAssetTradeFeeUsd,
             },
@@ -99,7 +97,7 @@ async function cowBuildTrade(deps, input) {
             feeAmountInSellToken: quote.feeAmount,
             sellAmountWithoutFee: quote.sellAmount,
         };
-        const allowanceRequired = await (0, helpers_1.getAllowanceRequired)({
+        const approvalRequired = await (0, helpers_1.isApprovalRequired)({
             adapter,
             sellAsset,
             allowanceContract: constants_1.COW_SWAP_VAULT_RELAYER_ADDRESS,
@@ -108,7 +106,7 @@ async function cowBuildTrade(deps, input) {
             web3: deps.web3,
             erc20AllowanceAbi: erc20Allowance_abi_1.erc20AllowanceAbi,
         });
-        if (!allowanceRequired.isZero()) {
+        if (approvalRequired) {
             trade.feeData.chainSpecific.approvalFee = (0, bignumber_1.bnOrZero)(feeData.chainSpecific.gasLimit)
                 .multipliedBy((0, bignumber_1.bnOrZero)(feeData.chainSpecific.gasPrice))
                 .toString();

package/dist/swappers/cow/getCowSwapTradeQuote/getCowSwapTradeQuote.js

@@ -96,7 +96,6 @@ async function getCowSwapTradeQuote(deps, input) {
             minimum,
             maximum,
             feeData: {
-                fee: '0',
                 networkFee: '0',
                 chainSpecific: {
                     estimatedGas: feeData.chainSpecific.gasLimit,
@@ -105,7 +104,6 @@ async function getCowSwapTradeQuote(deps, input) {
                         .multipliedBy((0, bignumber_1.bnOrZero)(feeData.chainSpecific.gasPrice))
                         .toString(),
                 },
-                tradeFee: '0',
                 buyAssetTradeFeeUsd: '0',
                 sellAssetTradeFeeUsd,
             },

package/dist/swappers/osmosis/OsmosisSwapper.js

@@ -107,8 +107,6 @@ class OsmosisSwapper {
             buyAmount,
             buyAsset,
             feeData: {
-                fee,
-                tradeFee: buyAssetTradeFeeUsd,
                 networkFee: fee,
                 sellAssetTradeFeeUsd: '0',
                 buyAssetTradeFeeUsd,
@@ -140,8 +138,6 @@ class OsmosisSwapper {
         return {
             buyAsset,
             feeData: {
-                fee,
-                tradeFee: buyAssetTradeFeeUsd,
                 networkFee: fee,
                 sellAssetTradeFeeUsd: '0',
                 buyAssetTradeFeeUsd,

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

@@ -126,9 +126,7 @@ const getThorTradeQuote = async ({ deps, input }) => {
                         ...commonQuoteFields,
                         allowanceContract: '0x0',
                         feeData: {
-                            fee: feeData.fast.txFee,
                             networkFee: feeData.fast.txFee,
-                            tradeFee: buyAssetTradeFeeUsdOrDefault,
                             buyAssetTradeFeeUsd: buyAssetTradeFeeUsdOrDefault,
                             sellAssetTradeFeeUsd: '0',
                             chainSpecific: { estimatedGas: feeData.fast.chainSpecific.gasLimit },

package/dist/swappers/thorchain/utils/cosmos/cosmosTxData.js

@@ -40,7 +40,7 @@ const cosmosTxData = async (input) => {
             wallet,
             memo,
             gas: quote.feeData.chainSpecific.estimatedGas,
-            fee: quote.feeData.fee,
+            fee: quote.feeData.networkFee,
         });
         return buildTxResponse.txToSign;
     }
@@ -58,7 +58,7 @@ const cosmosTxData = async (input) => {
         memo,
         chainSpecific: {
             gas: quote.feeData.chainSpecific.estimatedGas,
-            fee: quote.feeData.fee,
+            fee: quote.feeData.networkFee,
         },
     });
     return buildTxResponse.txToSign;

package/dist/swappers/thorchain/utils/txFeeHelpers/btcTxFees/getBtcTxFees.js

@@ -23,9 +23,7 @@ const getBtcTxFees = async ({ opReturnData, vault, sellAmount, sellAdapter, pubk
         const networkFee = feeMultiplier.times(feeData.txFee).dp(0).toString();
         const satsPerByte = feeMultiplier.times(feeData.chainSpecific.satoshiPerByte).dp(0).toString();
         return {
-            fee: networkFee,
             networkFee,
-            tradeFee: buyAssetTradeFeeUsd,
             buyAssetTradeFeeUsd,
             sellAssetTradeFeeUsd: '0',
             chainSpecific: {

package/dist/swappers/thorchain/utils/txFeeHelpers/ethTxFees/getEthTxFees.js

@@ -31,7 +31,6 @@ const getEthTxFees = async ({ adapterManager, sellAssetReference, buyAssetTradeF
         };
         const feeData = feeDataOptions['fast'];
         return {
-            fee: feeData.txFee,
             networkFee: feeData.txFee,
             chainSpecific: {
                 estimatedGas: feeData.chainSpecific.gasLimit,
@@ -41,7 +40,6 @@ const getEthTxFees = async ({ adapterManager, sellAssetReference, buyAssetTradeF
                         .multipliedBy((0, bignumber_1.bnOrZero)(feeData.chainSpecific.gasPrice))
                         .toString(),
             },
-            tradeFee: buyAssetTradeFeeUsd,
             buyAssetTradeFeeUsd,
             sellAssetTradeFeeUsd: '0',
         };

package/dist/swappers/utils/helpers/helpers.d.ts

@@ -1,11 +1,10 @@
 import { Asset } from '@shapeshiftoss/asset-service';
 import { HDWallet } from '@shapeshiftoss/hdwallet-core';
-import BigNumber from 'bignumber.js';
 import Web3 from 'web3';
 import { AbiItem } from 'web3-utils';
 import { EvmSupportedChainAdapters, EvmSupportedChainIds, TradeQuote } from '../../../api';
 import { BN } from '../bignumber';
-export declare type GetAllowanceRequiredArgs = {
+export declare type IsApprovalRequiredArgs = {
     adapter: EvmSupportedChainAdapters;
     receiveAddress: string;
     allowanceContract: string;
@@ -34,7 +33,7 @@ declare type GrantAllowanceArgs<T extends EvmSupportedChainIds> = {
     web3: Web3;
 };
 export declare const getERC20Allowance: ({ erc20AllowanceAbi, web3, sellAssetErc20Address, ownerAddress, spenderAddress, }: GetERC20AllowanceArgs) => Promise<any>;
-export declare const getAllowanceRequired: ({ adapter, receiveAddress, allowanceContract, sellAsset, sellAmount, web3, erc20AllowanceAbi, }: GetAllowanceRequiredArgs) => Promise<BigNumber>;
+export declare const isApprovalRequired: ({ adapter, receiveAddress, allowanceContract, sellAsset, sellAmount, web3, erc20AllowanceAbi, }: IsApprovalRequiredArgs) => Promise<boolean>;
 export declare const grantAllowance: <T extends EvmSupportedChainIds>({ quote, wallet, adapter, erc20Abi, web3, }: GrantAllowanceArgs<T>) => Promise<string>;
 /**
  * This function keeps 17 significant digits, so even if we try to trade 1 Billion of an

package/dist/swappers/utils/helpers/helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getApproveContractData = exports.normalizeIntegerAmount = exports.normalizeAmount = exports.grantAllowance = exports.getAllowanceRequired = exports.getERC20Allowance = void 0;
+exports.getApproveContractData = exports.normalizeIntegerAmount = exports.normalizeAmount = exports.grantAllowance = exports.isApprovalRequired = exports.getERC20Allowance = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
 const web3_utils_1 = require("web3-utils");
 const api_1 = require("../../../api");
@@ -12,10 +12,10 @@ const getERC20Allowance = async ({ erc20AllowanceAbi, web3, sellAssetErc20Addres
     return erc20Contract.methods.allowance(ownerAddress, spenderAddress).call();
 };
 exports.getERC20Allowance = getERC20Allowance;
-const getAllowanceRequired = async ({ adapter, receiveAddress, allowanceContract, sellAsset, sellAmount, web3, erc20AllowanceAbi, }) => {
+const isApprovalRequired = async ({ adapter, receiveAddress, allowanceContract, sellAsset, sellAmount, web3, erc20AllowanceAbi, }) => {
     try {
         if (sellAsset.assetId === adapter.getFeeAssetId()) {
-            return (0, bignumber_1.bn)(0);
+            return false;
         }
         const ownerAddress = receiveAddress;
         const spenderAddress = allowanceContract;
@@ -27,27 +27,27 @@ const getAllowanceRequired = async ({ adapter, receiveAddress, allowanceContract
             spenderAddress,
             sellAssetErc20Address,
         });
-        if (allowanceOnChain === '0')
-            return (0, bignumber_1.bnOrZero)(sellAmount);
         if (!allowanceOnChain) {
-            throw new api_1.SwapError(`[getAllowanceRequired] - No allowance data`, {
+            throw new api_1.SwapError(`[isApprovalRequired] - No allowance data`, {
                 details: { allowanceContract, receiveAddress },
                 code: api_1.SwapErrorTypes.RESPONSE_ERROR,
             });
         }
+        if ((0, bignumber_1.bn)(allowanceOnChain).isZero())
+            return true;
         const allowanceRequired = (0, bignumber_1.bnOrZero)(sellAmount).minus(allowanceOnChain);
-        return allowanceRequired.lt(0) ? (0, bignumber_1.bn)(0) : allowanceRequired;
+        return allowanceRequired.gt(0);
     }
     catch (e) {
         if (e instanceof api_1.SwapError)
             throw e;
-        throw new api_1.SwapError('[getAllowanceRequired]', {
+        throw new api_1.SwapError('[isApprovalRequired]', {
             cause: e,
             code: api_1.SwapErrorTypes.ALLOWANCE_REQUIRED_FAILED,
         });
     }
 };
-exports.getAllowanceRequired = getAllowanceRequired;
+exports.isApprovalRequired = isApprovalRequired;
 const grantAllowance = async ({ quote, wallet, adapter, erc20Abi, web3, }) => {
     var _a, _b, _c, _d, _e;
     try {

package/dist/swappers/utils/test-data/setupSwapQuote.js

@@ -16,8 +16,6 @@ const setupQuote = () => {
         minimum: '0',
         maximum: '999999999999',
         feeData: {
-            fee: '0',
-            tradeFee: '0',
             chainSpecific: {},
             sellAssetTradeFeeUsd: '0',
             networkFee: '0',

package/dist/swappers/zrx/getZrxTradeQuote/getZrxTradeQuote.js

@@ -58,13 +58,11 @@ async function getZrxTradeQuote(input) {
             minimum,
             maximum,
             feeData: {
-                fee,
                 chainSpecific: {
                     estimatedGas: estimatedGas.toString(),
                     gasPrice,
                     approvalFee,
                 },
-                tradeFee: '0',
                 networkFee: fee,
                 buyAssetTradeFeeUsd: '0',
                 sellAssetTradeFeeUsd: '0',

package/dist/swappers/zrx/utils/test-data/setupZrxSwapQuote.d.ts

@@ -26,9 +26,7 @@ export declare const setupExecuteTrade: () => {
         depositAddress: string;
         receiveAddress: string;
         feeData: {
-            fee: string;
             chainSpecific: {};
-            tradeFee: string;
             buyAssetTradeFeeUsd: string;
             sellAssetTradeFeeUsd: string;
             networkFee: string;

package/dist/swappers/zrx/utils/test-data/setupZrxSwapQuote.js

@@ -38,9 +38,7 @@ const setupExecuteTrade = () => {
         depositAddress: '0x0',
         receiveAddress: '0x0',
         feeData: {
-            fee: '0',
             chainSpecific: {},
-            tradeFee: '0',
             buyAssetTradeFeeUsd: '0',
             sellAssetTradeFeeUsd: '0',
             networkFee: '0',

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

@@ -92,7 +92,7 @@ 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)({
+        const approvalRequired = await (0, helpers_1.isApprovalRequired)({
             adapter,
             sellAsset,
             allowanceContract: data.allowanceTarget,
@@ -112,13 +112,11 @@ async function zrxBuildTrade({ adapter, web3 }, input) {
             rate: data.price,
             depositAddress: data.to,
             feeData: {
-                fee: networkFee,
                 chainSpecific: {
                     estimatedGas: estimatedGas.toString(),
                     gasPrice: data.gasPrice,
-                    approvalFee: allowanceRequired.gt(0) ? approvalFee : undefined,
+                    approvalFee: approvalRequired ? approvalFee : undefined,
                 },
-                tradeFee: '0',
                 networkFee,
                 buyAssetTradeFeeUsd: '0',
                 sellAssetTradeFeeUsd: '0',

package/package.json

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