@shapeshiftoss/swapper 5.0.1 → 5.1.2

package/dist/api.d.ts

@@ -104,20 +104,20 @@ export declare type ApprovalNeededInput<C extends SupportedChainIds> = {
 };
 export declare enum SwapErrorTypes {
     ALLOWANCE_REQUIRED_FAILED = "ALLOWANCE_REQUIRED_FAILED",
-    CHECK_APPROVAL_FAILED = "CHECK_APPROVAL_FAILED",
     APPROVE_INFINITE_FAILED = "APPROVE_INFINITE_FAILED",
     BUILD_TRADE_FAILED = "BUILD_TRADE_FAILED",
+    CHECK_APPROVAL_FAILED = "CHECK_APPROVAL_FAILED",
     EXECUTE_TRADE_FAILED = "EXECUTE_TRADE_FAILED",
     GRANT_ALLOWANCE_FAILED = "GRANT_ALLOWANCE_FAILED",
     MANAGER_ERROR = "MANAGER_ERROR",
     MIN_MAX_FAILED = "MIN_MAX_FAILED",
+    RESPONSE_ERROR = "RESPONSE_ERROR",
     SIGN_AND_BROADCAST_FAILED = "SIGN_AND_BROADCAST_FAILED",
     TRADE_QUOTE_FAILED = "TRADE_QUOTE_FAILED",
     UNSUPPORTED_PAIR = "UNSUPPORTED_PAIR",
     USD_RATE_FAILED = "USD_RATE_FAILED",
     UNSUPPORTED_CHAIN = "UNSUPPORTED_CHAIN",
-    VALIDATION_FAILED = "VALIDATION_FAILED",
-    RESPONSE_ERROR = "RESPONSE_ERROR"
+    VALIDATION_FAILED = "VALIDATION_FAILED"
 }
 export interface Swapper {
     /** Returns the swapper type */

package/dist/api.js

@@ -7,18 +7,18 @@ exports.SwapError = (0, errors_1.createErrorClass)('SwapError');
 var SwapErrorTypes;
 (function (SwapErrorTypes) {
     SwapErrorTypes["ALLOWANCE_REQUIRED_FAILED"] = "ALLOWANCE_REQUIRED_FAILED";
-    SwapErrorTypes["CHECK_APPROVAL_FAILED"] = "CHECK_APPROVAL_FAILED";
     SwapErrorTypes["APPROVE_INFINITE_FAILED"] = "APPROVE_INFINITE_FAILED";
     SwapErrorTypes["BUILD_TRADE_FAILED"] = "BUILD_TRADE_FAILED";
+    SwapErrorTypes["CHECK_APPROVAL_FAILED"] = "CHECK_APPROVAL_FAILED";
     SwapErrorTypes["EXECUTE_TRADE_FAILED"] = "EXECUTE_TRADE_FAILED";
     SwapErrorTypes["GRANT_ALLOWANCE_FAILED"] = "GRANT_ALLOWANCE_FAILED";
     SwapErrorTypes["MANAGER_ERROR"] = "MANAGER_ERROR";
     SwapErrorTypes["MIN_MAX_FAILED"] = "MIN_MAX_FAILED";
+    SwapErrorTypes["RESPONSE_ERROR"] = "RESPONSE_ERROR";
     SwapErrorTypes["SIGN_AND_BROADCAST_FAILED"] = "SIGN_AND_BROADCAST_FAILED";
     SwapErrorTypes["TRADE_QUOTE_FAILED"] = "TRADE_QUOTE_FAILED";
     SwapErrorTypes["UNSUPPORTED_PAIR"] = "UNSUPPORTED_PAIR";
     SwapErrorTypes["USD_RATE_FAILED"] = "USD_RATE_FAILED";
     SwapErrorTypes["UNSUPPORTED_CHAIN"] = "UNSUPPORTED_CHAIN";
     SwapErrorTypes["VALIDATION_FAILED"] = "VALIDATION_FAILED";
-    SwapErrorTypes["RESPONSE_ERROR"] = "RESPONSE_ERROR";
 })(SwapErrorTypes = exports.SwapErrorTypes || (exports.SwapErrorTypes = {}));

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/ZrxApprovalNeeded/ZrxApprovalNeeded.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZrxApprovalNeeded = void 0;
+const caip_1 = require("@shapeshiftoss/caip");
 const api_1 = require("../../../api");
 const erc20Allowance_abi_1 = require("../utils/abi/erc20Allowance-abi");
 const bignumber_1 = require("../utils/bignumber");
@@ -16,8 +17,8 @@ async function ZrxApprovalNeeded({ adapterManager, web3 }, { quote, wallet }) {
                 details: { chainId: sellAsset.chainId }
             });
         }
-        // No approval needed for trading eth itself
-        if (sellAsset.assetId === 'eip155:1/slip44:60') {
+        // No approval needed for selling a fee asset
+        if (sellAsset.assetId === (0, caip_1.getFeeAssetIdFromAssetId)(sellAsset.assetId)) {
             return { approvalNeeded: false };
         }
         const accountNumber = (0, bignumber_1.bnOrZero)(quote.sellAssetAccountId).toNumber();

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.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "5.0.1",
+  "version": "5.1.2",
   "description": "TODO: description",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",
@@ -31,7 +31,7 @@
   },
   "peerDependencies": {
     "@shapeshiftoss/asset-service": "^3.0.0",
-    "@shapeshiftoss/caip": "^4.0.0",
+    "@shapeshiftoss/caip": "^4.0.1",
     "@shapeshiftoss/chain-adapters": "^4.0.0",
     "@shapeshiftoss/hdwallet-core": "1.20.0",
     "@shapeshiftoss/types": "^4.0.0",
@@ -39,7 +39,7 @@
   },
   "devDependencies": {
     "@shapeshiftoss/asset-service": "^3.0.0",
-    "@shapeshiftoss/caip": "^4.0.0",
+    "@shapeshiftoss/caip": "^4.0.1",
     "@shapeshiftoss/chain-adapters": "^4.0.0",
     "@shapeshiftoss/hdwallet-core": "^1.20.0",
     "@shapeshiftoss/types": "^4.1.0",