@shapeshiftoss/swapper 2.1.0 → 2.2.2

package/dist/api.d.ts

@@ -1,12 +1,19 @@
 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[];
+};
+export declare type ByPairInput = {
+    sellAssetId: CAIP19;
+    buyAssetId: CAIP19;
+};
 export declare type BuyAssetBySellIdInput = {
     sellAssetId: CAIP19;
-    buyAssetIds: CAIP19[];
+    assetIds: CAIP19[];
 };
 export declare type SupportedSellAssetsInput = {
-    sellAssetIds: CAIP19[];
+    assetIds: CAIP19[];
 };
 export declare class SwapError extends Error {
 }
@@ -45,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,6 +1,5 @@
-import { GetQuoteInput, SwapperType } from '@shapeshiftoss/types';
-import { Swapper } from '..';
-import { BuyAssetBySellIdInput, SupportedSellAssetsInput } from '../api';
+import { SwapperType } from '@shapeshiftoss/types';
+import { BuyAssetBySellIdInput, ByPairInput, SupportedSellAssetsInput, Swapper } from '..';
 export declare class SwapperError extends Error {
     constructor(message: string);
 }
@@ -26,7 +25,13 @@ export declare class SwapperManager {
      * @returns {SwapperManager}
      */
     removeSwapper(swapperType: SwapperType): this;
-    getBestSwapper(quoteParams: GetQuoteInput): Promise<SwapperType>;
-    getSupportedBuyAssetsFromSellId(args: BuyAssetBySellIdInput): string[];
-    getSupportedSellAssets(args: SupportedSellAssetsInput): string[];
+    getBestSwapper(args: ByPairInput): Promise<Swapper>;
+    /**
+     *
+     * @param pair type {GetQuoteInput}
+     * @returns {SwapperType}
+     */
+    getSwappersByPair(pair: ByPairInput): Swapper[];
+    getSupportedBuyAssetIdsFromSellId(args: BuyAssetBySellIdInput): string[];
+    getSupportedSellableAssetIds(args: SupportedSellAssetsInput): string[];
 }

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,16 +58,26 @@ 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];
     }
-    getSupportedBuyAssetsFromSellId(args) {
+    /**
+     *
+     * @param pair type {GetQuoteInput}
+     * @returns {SwapperType}
+     */
+    getSwappersByPair(pair) {
+        const { sellAssetId, buyAssetId } = pair;
+        return Array.from(this.swappers.values()).filter((swapper) => swapper.filterBuyAssetsBySellAssetId({ sellAssetId, assetIds: [buyAssetId] }).length);
+    }
+    getSupportedBuyAssetIdsFromSellId(args) {
         return (0, uniq_1.default)(Array.from(this.swappers.values()).flatMap((swapper) => swapper.filterBuyAssetsBySellAssetId(args)));
     }
-    getSupportedSellAssets(args) {
-        const { sellAssetIds } = args;
-        return (0, uniq_1.default)(Array.from(this.swappers.values()).flatMap((swapper) => swapper.filterAssetIdsBySellable(sellAssetIds)));
+    getSupportedSellableAssetIds(args) {
+        const { assetIds } = args;
+        return (0, uniq_1.default)(Array.from(this.swappers.values()).flatMap((swapper) => swapper.filterAssetIdsBySellable(assetIds)));
     }
 }
 exports.SwapperManager = SwapperManager;

package/dist/swappers/index.d.ts

@@ -1,2 +1,3 @@
 export * from './zrx/ZrxSwapper';
 export * from './thorchain/ThorchainSwapper';
+export * from './test/TestSwapper';

package/dist/swappers/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./zrx/ZrxSwapper"), exports);
 __exportStar(require("./thorchain/ThorchainSwapper"), exports);
+__exportStar(require("./test/TestSwapper"), exports);

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

@@ -0,0 +1,22 @@
+import { CAIP19 } from '@shapeshiftoss/caip';
+import { ApprovalNeededOutput, Asset, ChainTypes, ExecQuoteOutput, GetQuoteInput, MinMaxOutput, Quote, SwapperType } from '@shapeshiftoss/types';
+import { BuyAssetBySellIdInput, Swapper } from '../../api';
+/**
+ * Playground for testing different scenarios of multiple swappers in the manager.
+ * Meant for local testing only
+ */
+export declare class TestSwapper implements Swapper {
+    supportAssets: string[];
+    getType(): SwapperType;
+    constructor();
+    getQuote(): Promise<Quote<ChainTypes, SwapperType>>;
+    buildQuoteTx(): Promise<Quote<ChainTypes, SwapperType>>;
+    getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
+    getMinMax(input: GetQuoteInput): Promise<MinMaxOutput>;
+    executeQuote(): Promise<ExecQuoteOutput>;
+    getDefaultPair(): [CAIP19, CAIP19];
+    approvalNeeded(): Promise<ApprovalNeededOutput>;
+    approveInfinite(): Promise<string>;
+    filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): CAIP19[];
+    filterAssetIdsBySellable(): CAIP19[];
+}

package/dist/swappers/test/TestSwapper.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestSwapper = void 0;
+const types_1 = require("@shapeshiftoss/types");
+/**
+ * Playground for testing different scenarios of multiple swappers in the manager.
+ * Meant for local testing only
+ */
+class TestSwapper {
+    constructor() {
+        this.supportAssets = [
+            'bip122:000000000933ea01ad0ee984209779ba/slip44:0',
+            'cosmos:cosmoshub-4/slip44:118',
+            'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d'
+        ];
+    }
+    getType() {
+        return types_1.SwapperType.Test;
+    }
+    async getQuote() {
+        throw new Error('TestSwapper: getQuote unimplemented');
+    }
+    async buildQuoteTx() {
+        throw new Error('TestSwapper: getQuote unimplemented');
+    }
+    getUsdRate(input) {
+        console.info(input);
+        throw new Error('TestSwapper: getUsdRate unimplemented');
+    }
+    getMinMax(input) {
+        console.info(input);
+        throw new Error('TestSwapper: getMinMax unimplemented');
+    }
+    async executeQuote() {
+        throw new Error('TestSwapper: executeQuote unimplemented');
+    }
+    getDefaultPair() {
+        throw new Error('TestSwapper: getDefaultPair unimplemented');
+    }
+    async approvalNeeded() {
+        throw new Error('TestSwapper: approvalNeeded unimplemented');
+    }
+    async approveInfinite() {
+        throw new Error('TestSwapper: approveInfinite unimplemented');
+    }
+    filterBuyAssetsBySellAssetId(args) {
+        const { sellAssetId } = args;
+        if (!this.supportAssets.includes(sellAssetId))
+            return [];
+        return this.supportAssets;
+    }
+    filterAssetIdsBySellable() {
+        return this.supportAssets;
+    }
+}
+exports.TestSwapper = TestSwapper;

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,14 +32,11 @@ class ThorchainSwapper {
     async approveInfinite() {
         throw new Error('ThorchainSwapper: approveInfinite unimplemented');
     }
-    async getSendMaxAmount() {
-        throw new Error('ThorchainSwapper: getSendMaxAmount unimplemented');
-    }
     filterBuyAssetsBySellAssetId() {
-        throw new Error('ThorchainSwapper: filterBuyAssetsBySellAssetId unimplemented');
+        return [];
     }
     filterAssetIdsBySellable() {
-        throw new Error('ThorchainSwapper: filterAssetIdsBySellable unimplemented');
+        return [];
     }
 }
 exports.ThorchainSwapper = ThorchainSwapper;

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,17 +49,13 @@ 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 { buyAssetIds } = args;
+        const { assetIds, sellAssetId } = args;
         // TODO: pending changes to caip lib, we may want to import caip2 value instead.
-        return buyAssetIds.filter((id) => id.startsWith('eip155:1'));
+        return assetIds.filter((id) => id.startsWith('eip155:1') && sellAssetId.startsWith('eip155:1'));
     }
     filterAssetIdsBySellable(assetIds) {
-        // reusing logic to avoid potential bugs from changing one and not the other
-        return this.filterBuyAssetsBySellAssetId({ buyAssetIds: assetIds, sellAssetId: '' });
+        return assetIds.filter((id) => id.startsWith('eip155:1'));
     }
 }
 exports.ZrxSwapper = ZrxSwapper;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "2.1.0",
+  "version": "2.2.2",
   "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;