@shapeshiftoss/swapper 5.1.0 → 5.1.3

package/dist/api.d.ts

@@ -79,9 +79,11 @@ export interface TradeQuote<C extends SupportedChainIds> extends TradeBase<C> {
     maximum: string;
 }
 export interface Trade<C extends SupportedChainIds> extends TradeBase<C> {
+    receiveAddress: string;
+}
+export interface ZrxTrade<C extends SupportedChainIds> extends Trade<C> {
     txData: string;
     depositAddress: string;
-    receiveAddress: string;
 }
 export declare type ExecuteTradeInput<C extends SupportedChainIds> = {
     trade: Trade<C>;

package/dist/manager/SwapperManager.d.ts

@@ -14,6 +14,7 @@ export declare class SwapperManager {
      *
      * @param swapperType swapper type {SwapperType|string}
      * @returns {Swapper}
+     * @deprecated this will be removed, currently used in swapper tests
      */
     getSwapper(swapperType: SwapperType): Swapper;
     /**
@@ -22,7 +23,7 @@ export declare class SwapperManager {
      * @returns {SwapperManager}
      */
     removeSwapper(swapperType: SwapperType): this;
-    getBestSwapper(args: ByPairInput): Promise<Swapper>;
+    getBestSwapper(args: ByPairInput): Promise<Swapper | undefined>;
     /**
      *
      * @param pair type {GetQuoteInput}

package/dist/manager/SwapperManager.js

@@ -38,6 +38,7 @@ class SwapperManager {
      *
      * @param swapperType swapper type {SwapperType|string}
      * @returns {Swapper}
+     * @deprecated this will be removed, currently used in swapper tests
      */
     getSwapper(swapperType) {
         const swapper = this.swappers.get(swapperType);

package/dist/swappercli.js

@@ -84,7 +84,12 @@ const main = async () => {
     const manager = new SwapperManager_1.SwapperManager();
     const zrxSwapper = new ZrxSwapper_1.ZrxSwapper(zrxSwapperDeps);
     manager.addSwapper(types_1.SwapperType.Zrx, zrxSwapper);
-    const swapper = manager.getSwapper(types_1.SwapperType.Zrx);
+    const swapper = await manager.getBestSwapper({
+        sellAssetId: 'eip155:1/slip44:60',
+        buyAssetId: 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d'
+    });
+    if (!swapper)
+        return;
     const sellAmountBase = toBaseUnit(sellAmount, sellAsset.precision);
     let quote;
     try {

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

@@ -2,7 +2,7 @@ import { AssetId } from '@shapeshiftoss/caip';
 import { ChainAdapterManager } from '@shapeshiftoss/chain-adapters';
 import { ApprovalNeededOutput, Asset, ExecQuoteOutput, GetMinMaxInput, MinMaxOutput, SupportedChainIds, SwapperType } from '@shapeshiftoss/types';
 import Web3 from 'web3';
-import { ApprovalNeededInput, ApproveInfiniteInput, BuildTradeInput, BuyAssetBySellIdInput, ExecuteTradeInput, GetTradeQuoteInput, Swapper, Trade, TradeQuote } from '../../api';
+import { ApprovalNeededInput, ApproveInfiniteInput, BuildTradeInput, BuyAssetBySellIdInput, ExecuteTradeInput, GetTradeQuoteInput, Swapper, TradeQuote, ZrxTrade } from '../../api';
 export declare type ZrxSwapperDeps = {
     adapterManager: ChainAdapterManager;
     web3: Web3;
@@ -12,7 +12,7 @@ export declare class ZrxSwapper implements Swapper {
     deps: ZrxSwapperDeps;
     constructor(deps: ZrxSwapperDeps);
     getType(): SwapperType;
-    buildTrade(args: BuildTradeInput): Promise<Trade<SupportedChainIds>>;
+    buildTrade(args: BuildTradeInput): Promise<ZrxTrade<SupportedChainIds>>;
     getTradeQuote(input: GetTradeQuoteInput): Promise<TradeQuote<SupportedChainIds>>;
     getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
     getMinMax(input: GetMinMaxInput): Promise<MinMaxOutput>;

package/dist/swappers/zrx/ZrxSwapper.js

@@ -4,6 +4,7 @@ exports.ZrxSwapper = void 0;
 const types_1 = require("@shapeshiftoss/types");
 const getZrxMinMax_1 = require("./getZrxMinMax/getZrxMinMax");
 const getZrxTradeQuote_1 = require("./getZrxTradeQuote/getZrxTradeQuote");
+const blacklist_1 = require("./utils/blacklist");
 const helpers_1 = require("./utils/helpers/helpers");
 const ZrxApprovalNeeded_1 = require("./ZrxApprovalNeeded/ZrxApprovalNeeded");
 const ZrxApproveInfinite_1 = require("./ZrxApproveInfinite/ZrxApproveInfinite");
@@ -39,10 +40,12 @@ class ZrxSwapper {
     }
     filterBuyAssetsBySellAssetId(args) {
         const { assetIds = [], sellAssetId } = args;
-        return assetIds.filter((id) => id.startsWith('eip155:1') && (sellAssetId === null || sellAssetId === void 0 ? void 0 : sellAssetId.startsWith('eip155:1')));
+        return assetIds.filter((id) => id.startsWith('eip155:1') &&
+            (sellAssetId === null || sellAssetId === void 0 ? void 0 : sellAssetId.startsWith('eip155:1')) &&
+            !blacklist_1.UNSUPPORTED_ASSETS.includes(id));
     }
     filterAssetIdsBySellable(assetIds = []) {
-        return assetIds.filter((id) => id.startsWith('eip155:1'));
+        return assetIds.filter((id) => id.startsWith('eip155:1') && !blacklist_1.UNSUPPORTED_ASSETS.includes(id));
     }
 }
 exports.ZrxSwapper = ZrxSwapper;

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

@@ -22,7 +22,7 @@ async function getZrxTradeQuote(input) {
         const sellToken = sellAsset.tokenId || sellAsset.symbol;
         const { minimum, maximum } = await (0, getZrxMinMax_1.getZrxMinMax)(sellAsset, buyAsset);
         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)(sellAmount).eq(0) ? minQuoteSellAmount.toString() : sellAmount);
+        const normalizedSellAmount = (0, helpers_1.normalizeAmount)((0, bignumber_1.bnOrZero)(sellAmount).eq(0) ? minQuoteSellAmount : sellAmount);
         /**
          * /swap/v1/price
          * params: {

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

@@ -0,0 +1 @@
+export declare const UNSUPPORTED_ASSETS: readonly string[];

package/dist/swappers/zrx/utils/blacklist.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UNSUPPORTED_ASSETS = void 0;
+// Zrx doesnt have an easily accessible master assets list.
+// We assume all erc20's are supported and remove these explicitely unsupported assets
+exports.UNSUPPORTED_ASSETS = Object.freeze([
+    // Foxy token unsupported by zrx
+    'eip155:1/erc20:0xdc49108ce5c57bc3408c3a5e95f3d864ec386ed3'
+]);

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

@@ -35,7 +35,7 @@ declare type GrantAllowanceArgs = {
  * ETH or ERC20, we still keep 7 decimal places.
  * @param amount
  */
-export declare const normalizeAmount: (amount: string | undefined) => string | undefined;
+export declare const normalizeAmount: (amount: string | number | BigNumber) => string;
 export declare const getERC20Allowance: ({ erc20AllowanceAbi, web3, tokenId, ownerAddress, spenderAddress }: GetERC20AllowanceArgs) => Promise<any>;
 export declare const getAllowanceRequired: ({ receiveAddress, allowanceContract, sellAsset, sellAmount, web3, erc20AllowanceAbi }: GetAllowanceRequiredArgs) => Promise<BigNumber>;
 export declare const getUsdRate: (input: Pick<Asset, 'symbol' | 'tokenId'>) => Promise<string>;

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

@@ -14,8 +14,6 @@ const zrxService_1 = require("../zrxService");
  * @param amount
  */
 const normalizeAmount = (amount) => {
-    if (!amount)
-        return;
     return (0, bignumber_1.bnOrZero)(amount).toNumber().toLocaleString('fullwide', { useGrouping: false });
 };
 exports.normalizeAmount = normalizeAmount;

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

@@ -1,4 +1,4 @@
 import { SupportedChainIds } from '@shapeshiftoss/types';
-import { BuildTradeInput, Trade } from '../../..';
+import { BuildTradeInput, ZrxTrade } from '../../..';
 import { ZrxSwapperDeps } from '../ZrxSwapper';
-export declare function zrxBuildTrade({ adapterManager, web3 }: ZrxSwapperDeps, input: BuildTradeInput): Promise<Trade<SupportedChainIds>>;
+export declare function zrxBuildTrade({ adapterManager, web3 }: ZrxSwapperDeps, input: BuildTradeInput): Promise<ZrxTrade<SupportedChainIds>>;

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

@@ -77,7 +77,7 @@ async function zrxBuildTrade({ adapterManager, web3 }, input) {
             params: {
                 buyToken,
                 sellToken,
-                sellAmount: (0, helpers_1.normalizeAmount)(sellAmount === null || sellAmount === void 0 ? void 0 : sellAmount.toString()),
+                sellAmount: (0, helpers_1.normalizeAmount)(sellAmount),
                 takerAddress: receiveAddress,
                 slippagePercentage,
                 skipValidation: false,

package/dist/swappers/zrx/zrxExecuteTrade/zrxExecuteTrade.js

@@ -6,7 +6,8 @@ const api_1 = require("../../../api");
 const bignumber_1 = require("../utils/bignumber");
 async function zrxExecuteTrade({ adapterManager }, { trade, wallet }) {
     var _a, _b, _c, _d, _e, _f;
-    const { sellAsset } = trade;
+    const zrxTrade = trade;
+    const { sellAsset } = zrxTrade;
     try {
         // value is 0 for erc20s
         const value = sellAsset.assetId === 'eip155:1/slip44:60' ? trade.sellAmount : '0';
@@ -17,7 +18,7 @@ async function zrxExecuteTrade({ adapterManager }, { trade, wallet }) {
         const buildTxResponse = await adapter.buildSendTransaction({
             value,
             wallet,
-            to: trade.depositAddress,
+            to: zrxTrade.depositAddress,
             chainSpecific: {
                 gasPrice: (0, web3_utils_1.numberToHex)(((_b = (_a = trade.feeData) === null || _a === void 0 ? void 0 : _a.chainSpecific) === null || _b === void 0 ? void 0 : _b.gasPrice) || 0),
                 gasLimit: (0, web3_utils_1.numberToHex)(((_d = (_c = trade.feeData) === null || _c === void 0 ? void 0 : _c.chainSpecific) === null || _d === void 0 ? void 0 : _d.estimatedGas) || 0)
@@ -25,7 +26,7 @@ async function zrxExecuteTrade({ adapterManager }, { trade, wallet }) {
             bip44Params
         });
         const { txToSign } = buildTxResponse;
-        const txWithQuoteData = { ...txToSign, data: (_e = trade.txData) !== null && _e !== void 0 ? _e : '' };
+        const txWithQuoteData = { ...txToSign, data: (_e = zrxTrade.txData) !== null && _e !== void 0 ? _e : '' };
         if (wallet.supportsOfflineSigning()) {
             const signedTx = await adapter.signTransaction({ txToSign: txWithQuoteData, wallet });
             const txid = await adapter.broadcastTransaction(signedTx);

package/package.json

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