@shapeshiftoss/swapper 2.2.0 → 2.3.0

package/dist/api.d.ts

@@ -1,6 +1,6 @@
 import { CAIP19 } from '@shapeshiftoss/caip';
 import { HDWallet } from '@shapeshiftoss/hdwallet-core';
-import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, Asset, BuildQuoteTxInput, ChainTypes, ExecQuoteInput, ExecQuoteOutput, GetQuoteInput, MinMaxOutput, Quote, SendMaxAmountInput, SwapperType } from '@shapeshiftoss/types';
+import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, Asset, BuildQuoteTxInput, ChainTypes, ExecQuoteInput, ExecQuoteOutput, GetQuoteInput, MinMaxOutput, Quote, SwapperType } from '@shapeshiftoss/types';
 export declare type SupportedAssetInput = {
     assetIds: CAIP19[];
 };
@@ -52,10 +52,6 @@ export interface Swapper {
      * Get the txid of an approve infinite transaction
      */
     approveInfinite(args: ApproveInfiniteInput<ChainTypes, SwapperType>): Promise<string>;
-    /**
-     * Get max swap balance (minus fees) for sell asset
-     */
-    getSendMaxAmount(args: SendMaxAmountInput): Promise<string>;
     /**
      * Get supported buyAssetId's by sellAssetId
      */

package/dist/manager/SwapperManager.d.ts

@@ -1,4 +1,4 @@
-import { GetQuoteInput, SwapperType } from '@shapeshiftoss/types';
+import { SwapperType } from '@shapeshiftoss/types';
 import { BuyAssetBySellIdInput, ByPairInput, SupportedSellAssetsInput, Swapper } from '..';
 export declare class SwapperError extends Error {
     constructor(message: string);
@@ -25,7 +25,7 @@ export declare class SwapperManager {
      * @returns {SwapperManager}
      */
     removeSwapper(swapperType: SwapperType): this;
-    getBestSwapper(quoteParams: GetQuoteInput): Promise<SwapperType>;
+    getBestSwapper(args: ByPairInput): Promise<Swapper>;
     /**
      *
      * @param pair type {GetQuoteInput}

package/dist/manager/SwapperManager.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SwapperManager = exports.SwapperError = void 0;
-const types_1 = require("@shapeshiftoss/types");
 const uniq_1 = __importDefault(require("lodash/uniq"));
 class SwapperError extends Error {
     constructor(message) {
@@ -59,9 +58,10 @@ class SwapperManager {
         this.swappers.delete(swapperType);
         return this;
     }
-    async getBestSwapper(quoteParams) {
-        quoteParams; // noop to shut up linter
-        return types_1.SwapperType.Zrx; // TODO: implement getBestSwapper
+    async getBestSwapper(args) {
+        // TODO: This will eventually have logic to determine the best swapper.
+        // For now we return the first swapper we get from getSwappersByPair
+        return this.getSwappersByPair(args)[0];
     }
     /**
      *

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

@@ -17,7 +17,6 @@ export declare class TestSwapper implements Swapper {
     getDefaultPair(): [CAIP19, CAIP19];
     approvalNeeded(): Promise<ApprovalNeededOutput>;
     approveInfinite(): Promise<string>;
-    getSendMaxAmount(): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): CAIP19[];
     filterAssetIdsBySellable(): CAIP19[];
 }

package/dist/swappers/test/TestSwapper.js

@@ -43,9 +43,6 @@ class TestSwapper {
     async approveInfinite() {
         throw new Error('TestSwapper: approveInfinite unimplemented');
     }
-    async getSendMaxAmount() {
-        throw new Error('TestSwapper: getSendMaxAmount unimplemented');
-    }
     filterBuyAssetsBySellAssetId(args) {
         const { sellAssetId } = args;
         if (!this.supportAssets.includes(sellAssetId))

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

@@ -11,7 +11,6 @@ export declare class ThorchainSwapper implements Swapper {
     getDefaultPair(): [CAIP19, CAIP19];
     approvalNeeded(): Promise<ApprovalNeededOutput>;
     approveInfinite(): Promise<string>;
-    getSendMaxAmount(): Promise<string>;
     filterBuyAssetsBySellAssetId(): CAIP19[];
     filterAssetIdsBySellable(): CAIP19[];
 }

package/dist/swappers/thorchain/ThorchainSwapper.js

@@ -32,9 +32,6 @@ class ThorchainSwapper {
     async approveInfinite() {
         throw new Error('ThorchainSwapper: approveInfinite unimplemented');
     }
-    async getSendMaxAmount() {
-        throw new Error('ThorchainSwapper: getSendMaxAmount unimplemented');
-    }
     filterBuyAssetsBySellAssetId() {
         return [];
     }

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

@@ -1,6 +1,6 @@
 import { CAIP19 } from '@shapeshiftoss/caip';
 import { ChainAdapterManager } from '@shapeshiftoss/chain-adapters';
-import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, Asset, BuildQuoteTxInput, ChainTypes, ExecQuoteInput, ExecQuoteOutput, GetQuoteInput, MinMaxOutput, Quote, SendMaxAmountInput, SwapperType } from '@shapeshiftoss/types';
+import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, Asset, BuildQuoteTxInput, ChainTypes, ExecQuoteInput, ExecQuoteOutput, GetQuoteInput, MinMaxOutput, Quote, SwapperType } from '@shapeshiftoss/types';
 import Web3 from 'web3';
 import { BuyAssetBySellIdInput, Swapper } from '../../api';
 export declare type ZrxSwapperDeps = {
@@ -23,7 +23,6 @@ export declare class ZrxSwapper implements Swapper {
     executeQuote(args: ExecQuoteInput<ChainTypes, SwapperType>): Promise<ExecQuoteOutput>;
     approvalNeeded(args: ApprovalNeededInput<ChainTypes, SwapperType>): Promise<ApprovalNeededOutput>;
     approveInfinite(args: ApproveInfiniteInput<ChainTypes, SwapperType>): Promise<string>;
-    getSendMaxAmount(args: SendMaxAmountInput): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): CAIP19[];
     filterAssetIdsBySellable(assetIds: CAIP19[]): CAIP19[];
 }

package/dist/swappers/zrx/ZrxSwapper.js

@@ -4,7 +4,6 @@ exports.ZrxSwapper = exports.ZrxError = void 0;
 const types_1 = require("@shapeshiftoss/types");
 const getZrxMinMax_1 = require("./getZrxMinMax/getZrxMinMax");
 const getZrxQuote_1 = require("./getZrxQuote/getZrxQuote");
-const getZrxSendMaxAmount_1 = require("./getZrxSendMaxAmount/getZrxSendMaxAmount");
 const helpers_1 = require("./utils/helpers/helpers");
 const ZrxApprovalNeeded_1 = require("./ZrxApprovalNeeded/ZrxApprovalNeeded");
 const ZrxApproveInfinite_1 = require("./ZrxApproveInfinite/ZrxApproveInfinite");
@@ -50,9 +49,6 @@ class ZrxSwapper {
     async approveInfinite(args) {
         return (0, ZrxApproveInfinite_1.ZrxApproveInfinite)(this.deps, args);
     }
-    async getSendMaxAmount(args) {
-        return (0, getZrxSendMaxAmount_1.getZrxSendMaxAmount)(this.deps, args);
-    }
     filterBuyAssetsBySellAssetId(args) {
         const { assetIds, sellAssetId } = args;
         // TODO: pending changes to caip lib, we may want to import caip2 value instead.

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

@@ -4,6 +4,8 @@ exports.FOX = exports.WETH = exports.BTC = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
 const types_1 = require("@shapeshiftoss/types");
 exports.BTC = {
+    assetId: 'bip122:000000000019d6689c085ae165831e93/slip44:0',
+    chainId: 'bip122:000000000019d6689c085ae165831e93',
     caip19: 'bip122:000000000019d6689c085ae165831e93/slip44:0',
     caip2: 'bip122:000000000019d6689c085ae165831e93',
     name: 'bitcoin',
@@ -24,6 +26,8 @@ exports.BTC = {
     symbol: 'BTC'
 };
 exports.WETH = {
+    assetId: 'eip155:1/erc20:0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+    chainId: 'eip155:1',
     caip19: 'eip155:1/erc20:0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
     caip2: 'eip155:1',
     name: 'WETH',
@@ -45,6 +49,8 @@ exports.WETH = {
     symbol: 'WETH'
 };
 exports.FOX = {
+    assetId: 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d',
+    chainId: 'eip155:1',
     caip19: 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d',
     caip2: 'eip155:1',
     name: 'FOX',

package/package.json

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

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

@@ -1,3 +0,0 @@
-import { SendMaxAmountInput } from '@shapeshiftoss/types';
-import { ZrxSwapperDeps } from '../ZrxSwapper';
-export declare function getZrxSendMaxAmount({ adapterManager }: ZrxSwapperDeps, { wallet, quote, sellAssetAccountId, feeEstimateKey }: SendMaxAmountInput): Promise<string>;

package/dist/swappers/zrx/getZrxSendMaxAmount/getZrxSendMaxAmount.js

@@ -1,63 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getZrxSendMaxAmount = void 0;
-const caip_1 = require("@shapeshiftoss/caip");
-const types_1 = require("@shapeshiftoss/types");
-const bignumber_js_1 = __importDefault(require("bignumber.js"));
-const api_1 = require("../../../api");
-const bignumber_1 = require("../utils/bignumber");
-const constants_1 = require("../utils/constants");
-async function getZrxSendMaxAmount({ adapterManager }, { wallet, quote, sellAssetAccountId, feeEstimateKey = types_1.chainAdapters.FeeDataKey.Average }) {
-    var _a, _b, _c;
-    const adapter = adapterManager.byChain(types_1.ChainTypes.Ethereum);
-    const bip44Params = adapter.buildBIP44Params({
-        accountNumber: (0, bignumber_1.bnOrZero)(sellAssetAccountId).toNumber()
-    });
-    const ethAddress = await adapter.getAddress({ wallet, bip44Params });
-    const account = await adapter.getAccount(ethAddress);
-    if (!quote.sellAsset) {
-        throw new api_1.SwapError('quote.sellAsset is required');
-    }
-    const tokenId = (_a = quote.sellAsset) === null || _a === void 0 ? void 0 : _a.tokenId;
-    let balance;
-    if (tokenId) {
-        balance = (_c = (_b = account.chainSpecific.tokens) === null || _b === void 0 ? void 0 : _b.find((token) => {
-            return caip_1.caip19.fromCAIP19(token.caip19).assetReference === tokenId.toLowerCase();
-        })) === null || _c === void 0 ? void 0 : _c.balance;
-    }
-    else {
-        balance = account.balance;
-    }
-    if (!balance) {
-        throw new api_1.SwapError(`No balance found for ${tokenId ? quote.sellAsset.symbol : 'ETH'}`);
-    }
-    // return the erc20 token balance. No need to subtract the fee.
-    if (tokenId && new bignumber_js_1.default(balance).gt(0)) {
-        return balance;
-    }
-    if (!quote.txData) {
-        throw new api_1.SwapError('quote.txData is required to get correct fee estimate');
-    }
-    const feeEstimates = await adapter.getFeeData({
-        to: quote.depositAddress,
-        value: (0, bignumber_1.bnOrZero)(quote.sellAmount).toString(),
-        chainSpecific: {
-            from: ethAddress,
-            contractData: quote.txData
-        }
-    });
-    const estimatedFee = feeEstimates[feeEstimateKey].txFee;
-    // (ryankk) We need to pad the fee for ETH max sends because the fee estimate is based off
-    // of a minimum quote value (quote.sellAmount) and not the users full ETH balance.
-    const paddedFee = new bignumber_js_1.default(estimatedFee).times(constants_1.ETH_FEE_ESTIMATE_PADDING);
-    const sendMaxAmount = new bignumber_js_1.default(balance).minus(paddedFee);
-    // gte covers if sendMaxAmount is NaN
-    if (!sendMaxAmount.gte(0)) {
-        throw new api_1.SwapError('ETH balance is less than estimated fee');
-    }
-    return sendMaxAmount.toString();
-}
-exports.getZrxSendMaxAmount = getZrxSendMaxAmount;