@shapeshiftoss/swapper 4.0.2 → 4.0.3

package/dist/api.d.ts

@@ -1,6 +1,6 @@
 import { AssetId } from '@shapeshiftoss/caip';
 import { HDWallet } from '@shapeshiftoss/hdwallet-core';
-import { ApprovalNeededOutput, Asset, chainAdapters, ChainTypes, ExecQuoteOutput, GetQuoteInput, MinMaxOutput, Quote, SwapperType } from '@shapeshiftoss/types';
+import { ApprovalNeededOutput, Asset, chainAdapters, ChainTypes, ExecQuoteOutput, GetMinMaxInput, MinMaxOutput, SwapperType } from '@shapeshiftoss/types';
 export declare type SupportedAssetInput = {
     assetIds: AssetId[];
 };
@@ -18,8 +18,7 @@ export declare type SupportedSellAssetsInput = {
 export declare type CommonTradeInput = {
     sellAsset: Asset;
     buyAsset: Asset;
-    sellAmount?: string;
-    buyAmount?: string;
+    sellAmount: string;
     sendMax: boolean;
     sellAssetAccountId: string;
 };
@@ -63,11 +62,11 @@ export declare type SwapSource = {
     proportion: string;
 };
 export declare type ApproveInfiniteInput<C extends ChainTypes> = {
-    quote: Quote<C> | TradeQuote<C>;
+    quote: TradeQuote<C>;
     wallet: HDWallet;
 };
 export declare type ApprovalNeededInput<C extends ChainTypes> = {
-    quote: Quote<C> | TradeQuote<C>;
+    quote: TradeQuote<C>;
     wallet: HDWallet;
 };
 export declare class SwapError extends Error {
@@ -90,7 +89,7 @@ export interface Swapper {
     /**
      * Get the minimum and maximum trade value of the sellAsset and buyAsset
      */
-    getMinMax(input: GetQuoteInput): Promise<MinMaxOutput>;
+    getMinMax(input: GetMinMaxInput): Promise<MinMaxOutput>;
     /**
      * Execute a trade built with buildTrade by signing and broadcasting
      */

package/dist/swappers/test/TestSwapper.d.ts

@@ -1,5 +1,5 @@
 import { AssetId } from '@shapeshiftoss/caip';
-import { ApprovalNeededOutput, Asset, ChainTypes, ExecQuoteOutput, GetQuoteInput, MinMaxOutput, SwapperType } from '@shapeshiftoss/types';
+import { ApprovalNeededOutput, Asset, ChainTypes, ExecQuoteOutput, GetMinMaxInput, MinMaxOutput, SwapperType } from '@shapeshiftoss/types';
 import { BuyAssetBySellIdInput, Swapper, Trade, TradeQuote } from '../../api';
 /**
  * Playground for testing different scenarios of multiple swappers in the manager.
@@ -10,7 +10,7 @@ export declare class TestSwapper implements Swapper {
     getType(): SwapperType;
     constructor();
     getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
-    getMinMax(input: GetQuoteInput): Promise<MinMaxOutput>;
+    getMinMax(input: GetMinMaxInput): Promise<MinMaxOutput>;
     approvalNeeded(): Promise<ApprovalNeededOutput>;
     approveInfinite(): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): AssetId[];

package/dist/swappers/thorchain/ThorchainSwapper.d.ts

@@ -1,10 +1,10 @@
 import { AssetId } from '@shapeshiftoss/caip';
-import { ApprovalNeededOutput, Asset, ChainTypes, ExecQuoteOutput, GetQuoteInput, MinMaxOutput, SwapperType } from '@shapeshiftoss/types';
+import { ApprovalNeededOutput, Asset, ChainTypes, ExecQuoteOutput, GetMinMaxInput, MinMaxOutput, SwapperType } from '@shapeshiftoss/types';
 import { Swapper, Trade, TradeQuote } from '../../api';
 export declare class ThorchainSwapper implements Swapper {
     getType(): SwapperType;
     getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
-    getMinMax(input: GetQuoteInput): Promise<MinMaxOutput>;
+    getMinMax(input: GetMinMaxInput): Promise<MinMaxOutput>;
     approvalNeeded(): Promise<ApprovalNeededOutput>;
     approveInfinite(): Promise<string>;
     filterBuyAssetsBySellAssetId(): AssetId[];

package/dist/swappers/zrx/ZrxSwapper.d.ts

@@ -1,6 +1,6 @@
 import { AssetId } from '@shapeshiftoss/caip';
 import { ChainAdapterManager } from '@shapeshiftoss/chain-adapters';
-import { ApprovalNeededOutput, Asset, ChainTypes, ExecQuoteOutput, GetQuoteInput, MinMaxOutput, SwapperType } from '@shapeshiftoss/types';
+import { ApprovalNeededOutput, Asset, ChainTypes, ExecQuoteOutput, GetMinMaxInput, MinMaxOutput, SwapperType } from '@shapeshiftoss/types';
 import Web3 from 'web3';
 import { ApprovalNeededInput, ApproveInfiniteInput, BuildTradeInput, BuyAssetBySellIdInput, ExecuteTradeInput, GetTradeQuoteInput, Swapper, Trade, TradeQuote } from '../../api';
 export declare type ZrxSwapperDeps = {
@@ -18,7 +18,7 @@ export declare class ZrxSwapper implements Swapper {
     buildTrade(args: BuildTradeInput): Promise<Trade<ChainTypes>>;
     getTradeQuote(input: GetTradeQuoteInput): Promise<TradeQuote<ChainTypes>>;
     getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
-    getMinMax(input: GetQuoteInput): Promise<MinMaxOutput>;
+    getMinMax(input: GetMinMaxInput): Promise<MinMaxOutput>;
     executeTrade(args: ExecuteTradeInput<ChainTypes>): Promise<ExecQuoteOutput>;
     approvalNeeded(args: ApprovalNeededInput<ChainTypes>): Promise<ApprovalNeededOutput>;
     approveInfinite(args: ApproveInfiniteInput<ChainTypes>): Promise<string>;

package/dist/swappers/zrx/ZrxSwapper.js

@@ -33,7 +33,7 @@ class ZrxSwapper {
         return (0, helpers_1.getUsdRate)(input);
     }
     async getMinMax(input) {
-        return (0, getZrxMinMax_1.getZrxMinMax)(input);
+        return (0, getZrxMinMax_1.getZrxMinMax)(input.sellAsset, input.buyAsset);
     }
     async executeTrade(args) {
         return (0, zrxExecuteTrade_1.zrxExecuteTrade)(this.deps, args);

package/dist/swappers/zrx/getZrxMinMax/getZrxMinMax.d.ts

@@ -1,2 +1,2 @@
-import { GetQuoteInput, MinMaxOutput } from '@shapeshiftoss/types';
-export declare const getZrxMinMax: (input: Pick<GetQuoteInput, 'sellAsset' | 'buyAsset'>) => Promise<MinMaxOutput>;
+import { Asset, MinMaxOutput } from '@shapeshiftoss/types';
+export declare const getZrxMinMax: (sellAsset: Asset, buyAsset: Asset) => Promise<MinMaxOutput>;

package/dist/swappers/zrx/getZrxMinMax/getZrxMinMax.js

@@ -6,8 +6,7 @@ const bignumber_1 = require("../utils/bignumber");
 const constants_1 = require("../utils/constants");
 const helpers_1 = require("../utils/helpers/helpers");
 const ZrxSwapper_1 = require("../ZrxSwapper");
-const getZrxMinMax = async (input) => {
-    const { sellAsset, buyAsset } = input;
+const getZrxMinMax = async (sellAsset, buyAsset) => {
     if (sellAsset.chain !== types_1.ChainTypes.Ethereum || buyAsset.chain !== types_1.ChainTypes.Ethereum) {
         throw new ZrxSwapper_1.ZrxError('getZrxMinMax - must be eth assets');
     }
@@ -15,7 +14,7 @@ const getZrxMinMax = async (input) => {
         symbol: sellAsset.symbol,
         tokenId: sellAsset.tokenId
     });
-    const minimum = (0, bignumber_1.bnOrZero)(1).dividedBy((0, bignumber_1.bnOrZero)(usdRate)).toString();
+    const minimum = (0, bignumber_1.bn)(1).dividedBy((0, bignumber_1.bnOrZero)(usdRate)).toString();
     return {
         minimum,
         maximum: constants_1.MAX_ZRX_TRADE // Arbitrarily large value. 10e+28 here.

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

@@ -10,7 +10,7 @@ const zrxService_1 = require("../utils/zrxService");
 const ZrxSwapper_1 = require("../ZrxSwapper");
 async function getZrxTradeQuote(input) {
     var _a, _b, _c, _d, _e, _f, _g;
-    const { sellAsset, buyAsset, sellAmount, buyAmount, sellAssetAccountId } = input;
+    const { sellAsset, buyAsset, sellAmount, sellAssetAccountId } = input;
     if (!buyAsset) {
         throw new ZrxSwapper_1.ZrxError('getQuote - Missing buyAsset');
     }
@@ -20,24 +20,12 @@ async function getZrxTradeQuote(input) {
     if (buyAsset.chain !== types_1.ChainTypes.Ethereum || sellAsset.chain !== types_1.ChainTypes.Ethereum) {
         throw new ZrxSwapper_1.ZrxError('getQuote - Both assets need to be on the Ethereum chain to use Zrx');
     }
-    if (!sellAmount && !buyAmount) {
-        throw new ZrxSwapper_1.ZrxError('getQuote - sellAmount or buyAmount amount is required');
-    }
     const useSellAmount = !!sellAmount;
     const buyToken = buyAsset.tokenId || buyAsset.symbol;
     const sellToken = sellAsset.tokenId || sellAsset.symbol;
-    const { minimum: minQuoteSellAmount, maximum: maxSellAmount } = await (0, getZrxMinMax_1.getZrxMinMax)(input);
-    const minQuoteSellAmountWei = (0, bignumber_1.bnOrZero)(minQuoteSellAmount).times((0, bignumber_1.bnOrZero)(10).exponentiatedBy(sellAsset.precision));
-    const amount = useSellAmount ? { sellAmount } : { buyAmount };
-    const amountKey = Object.keys(amount)[0];
-    const amountValue = Object.values(amount)[0];
-    let normalizedAmount = (0, helpers_1.normalizeAmount)(amountValue);
-    if (!normalizedAmount || normalizedAmount === '0') {
-        normalizedAmount = (0, helpers_1.normalizeAmount)(minQuoteSellAmountWei === null || minQuoteSellAmountWei === void 0 ? void 0 : minQuoteSellAmountWei.toString());
-    }
-    if (!normalizedAmount || normalizedAmount === '0') {
-        throw new ZrxSwapper_1.ZrxError('getQuote - Must have valid sellAmount, buyAmount or minimum amount');
-    }
+    const { minimum, maximum } = await (0, getZrxMinMax_1.getZrxMinMax)(buyAsset, sellAsset);
+    const minQuoteSellAmount = (0, bignumber_1.bnOrZero)(minimum).times((0, bignumber_1.bn)(10).exponentiatedBy(sellAsset.precision));
+    const normalizedSellAmount = (0, helpers_1.normalizeAmount)((0, bignumber_1.bnOrZero)(minimum).lt(minQuoteSellAmount) ? minQuoteSellAmount.toString() : sellAmount);
     try {
         /**
          * /swap/v1/price
@@ -52,7 +40,7 @@ async function getZrxTradeQuote(input) {
             params: {
                 sellToken,
                 buyToken,
-                [amountKey]: normalizedAmount
+                sellAmount: normalizedSellAmount
             }
         });
         const { data } = quoteResponse;
@@ -62,8 +50,8 @@ async function getZrxTradeQuote(input) {
             success: true,
             statusReason: '',
             rate,
-            minimum: minQuoteSellAmount,
-            maximum: maxSellAmount,
+            minimum,
+            maximum,
             feeData: {
                 fee: (0, bignumber_1.bnOrZero)(estimatedGas).multipliedBy((0, bignumber_1.bnOrZero)(data.gasPrice)).toString(),
                 chainSpecific: {

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

@@ -1,9 +1,10 @@
 import { ChainAdapter } from '@shapeshiftoss/chain-adapters';
 import { HDWallet } from '@shapeshiftoss/hdwallet-core';
-import { Asset, ChainTypes, Quote } from '@shapeshiftoss/types';
+import { Asset, ChainTypes } from '@shapeshiftoss/types';
 import BigNumber from 'bignumber.js';
 import Web3 from 'web3';
 import { AbiItem } from 'web3-utils';
+import { TradeQuote } from '../../../../api';
 export declare type GetAllowanceRequiredArgs = {
     receiveAddress: string;
     allowanceContract: string;
@@ -20,7 +21,7 @@ export declare type GetERC20AllowanceArgs = {
     spenderAddress: string;
 };
 declare type GrantAllowanceArgs = {
-    quote: Quote<ChainTypes>;
+    quote: TradeQuote<ChainTypes>;
     wallet: HDWallet;
     adapter: ChainAdapter<ChainTypes.Ethereum>;
     erc20Abi: AbiItem[];

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

@@ -12,6 +12,15 @@ export declare const setupQuote: () => {
         sellAssetAccountId: string;
         buyAssetAccountId: string;
         sendMax: boolean;
+        minimum: string;
+        maximum: string;
+        statusReason: string;
+        buyAmount: string;
+        feeData: {
+            fee: string;
+        };
+        rate: string;
+        sources: never[];
     };
     buyAsset: Asset;
     sellAsset: Asset;

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

@@ -15,7 +15,14 @@ const setupQuote = () => {
         receiveAddress: 'receiveAddress',
         sellAssetAccountId: '0',
         buyAssetAccountId: '0',
-        sendMax: false
+        sendMax: false,
+        minimum: '0',
+        maximum: '999999999999',
+        statusReason: '',
+        buyAmount: '',
+        feeData: { fee: '0' },
+        rate: '1',
+        sources: []
     };
     return { quoteInput, buyAsset, sellAsset };
 };

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

@@ -35,10 +35,7 @@ const helpers_1 = require("../utils/helpers/helpers");
 const zrxService_1 = require("../utils/zrxService");
 async function zrxBuildTrade({ adapterManager, web3 }, input) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-    const { sellAsset, buyAsset, sellAmount, buyAmount, slippage, sellAssetAccountId, buyAssetAccountId, wallet } = input;
-    if ((buyAmount && sellAmount) || (!buyAmount && !sellAmount)) {
-        throw new __1.SwapError('ZrxSwapper:ZrxBuildTrade Exactly one of buyAmount or sellAmount is required');
-    }
+    const { sellAsset, buyAsset, sellAmount, slippage, sellAssetAccountId, buyAssetAccountId, wallet } = input;
     if (!sellAssetAccountId || !buyAssetAccountId) {
         throw new __1.SwapError('ZrxSwapper:ZrxBuildTrade Both sellAssetAccountId and buyAssetAccountId are required');
     }
@@ -67,7 +64,6 @@ async function zrxBuildTrade({ adapterManager, web3 }, input) {
          *   sellToken: contract address (or symbol) of token to sell
          *   buyToken: contractAddress (or symbol) of token to buy
          *   sellAmount?: integer string value of the smallest increment of the sell token
-         *   buyAmount?: integer string value of the smallest incremtent of the buy token
          * }
          */
         const zrxRetry = (0, applyAxiosRetry_1.applyAxiosRetry)(zrxService_1.zrxService, {
@@ -92,7 +88,6 @@ async function zrxBuildTrade({ adapterManager, web3 }, input) {
                 buyToken,
                 sellToken,
                 sellAmount: (0, helpers_1.normalizeAmount)(sellAmount === null || sellAmount === void 0 ? void 0 : sellAmount.toString()),
-                buyAmount: (0, helpers_1.normalizeAmount)(buyAmount === null || buyAmount === void 0 ? void 0 : buyAmount.toString()),
                 takerAddress: receiveAddress,
                 slippagePercentage,
                 skipValidation: false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "description": "TODO: description",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",