@shapeshiftoss/swapper 15.8.0 → 16.0.0

package/dist/api.d.ts

@@ -73,9 +73,15 @@ export declare type ByPairInput = {
     sellAssetId: AssetId;
     buyAssetId: AssetId;
 };
-export declare type GetBestSwapperArgs = GetTradeQuoteInput & {
+export declare type GetSwappersWithQuoteMetadataArgs = GetTradeQuoteInput & {
     feeAsset: Asset;
 };
+export declare type SwapperWithQuoteMetadata = {
+    swapper: Swapper<ChainId>;
+    quote: TradeQuote<ChainId>;
+    inputOutputRatio: number | undefined;
+};
+export declare type GetSwappersWithQuoteMetadataReturn = SwapperWithQuoteMetadata[];
 export declare type BuyAssetBySellIdInput = {
     sellAssetId: AssetId;
     assetIds: AssetId[];

package/dist/manager/SwapperManager.d.ts

@@ -1,5 +1,5 @@
 import { ChainId } from '@shapeshiftoss/caip';
-import { BuyAssetBySellIdInput, ByPairInput, GetBestSwapperArgs, SupportedSellAssetsInput, Swapper } from '..';
+import { BuyAssetBySellIdInput, ByPairInput, GetSwappersWithQuoteMetadataArgs, GetSwappersWithQuoteMetadataReturn, SupportedSellAssetsInput, Swapper } from '..';
 import { SwapperType } from '../api';
 export declare class SwapperManager {
     swappers: Map<SwapperType, Swapper<ChainId>>;
@@ -24,10 +24,12 @@ export declare class SwapperManager {
     removeSwapper(swapperType: SwapperType): this;
     /**
      *
-     * @param args {GetBestSwapperArgs}
-     * @returns {Promise<Swapper<ChainId> | undefined>}
+     * Returns an ordered list of SwapperWithQuoteMetadata objects, descending from best to worst input output ratios
+     *
+     * @param args {GetSwappersWithQuoteMetadataArgs}
+     * @returns {Promise<GetSwappersWithQuoteMetadataReturn>}
      */
-    getBestSwapper(args: GetBestSwapperArgs): Promise<Swapper<ChainId> | undefined>;
+    getSwappersWithQuoteMetadata(args: GetSwappersWithQuoteMetadataArgs): Promise<GetSwappersWithQuoteMetadataReturn>;
     /**
      *
      * @param pair type {GetQuoteInput}

package/dist/manager/SwapperManager.js

@@ -62,47 +62,32 @@ class SwapperManager {
     }
     /**
      *
-     * @param args {GetBestSwapperArgs}
-     * @returns {Promise<Swapper<ChainId> | undefined>}
+     * Returns an ordered list of SwapperWithQuoteMetadata objects, descending from best to worst input output ratios
+     *
+     * @param args {GetSwappersWithQuoteMetadataArgs}
+     * @returns {Promise<GetSwappersWithQuoteMetadataReturn>}
      */
-    async getBestSwapper(args) {
+    async getSwappersWithQuoteMetadata(args) {
         const { sellAsset, buyAsset, feeAsset } = args;
         // Get all swappers that support the pair
         const supportedSwappers = this.getSwappersByPair({
             sellAssetId: sellAsset.assetId,
             buyAssetId: buyAsset.assetId,
         });
-        // Get quotes from all swappers that support the pair
-        const quotePromises = supportedSwappers.map(async (swapper) => [swapper, await swapper.getTradeQuote(args)]);
-        const settledQuoteRequests = await Promise.allSettled(quotePromises);
-        // For each swapper, get receive amount/(input amount + gas fee), where all values are in fiat
-        const fulfilledQuoteTuples = settledQuoteRequests
+        const settledSwapperDetailRequests = await Promise.allSettled(supportedSwappers.map(async (swapper) => {
+            const quote = await swapper.getTradeQuote(args);
+            const ratio = await (0, utils_1.getRatioFromQuote)(quote, swapper, feeAsset);
+            return {
+                swapper,
+                quote,
+                inputOutputRatio: ratio,
+            };
+        }));
+        // Swappers with quote and ratio details, sorted by descending input output ratio (best to worst)
+        const swappersWithDetail = (0, lodash_1.sortBy)(settledSwapperDetailRequests
             .filter(typeGuards_1.isFulfilled)
-            .map((quoteRequest) => quoteRequest.value);
-        // The best swapper is the one with the highest ratio
-        const bestQuoteTuple = await fulfilledQuoteTuples.reduce(async (acc, currentQuoteTuple) => {
-            const resolvedAcc = await acc;
-            const [currentSwapper, currentQuote] = currentQuoteTuple;
-            const currentRatio = await (0, utils_1.getRatioFromQuote)(currentQuote, currentSwapper, feeAsset);
-            // It's our first iteration, so we just return the current SwapperQuoteTuple
-            if (!resolvedAcc)
-                return Promise.resolve([currentSwapper, currentRatio]);
-            const [, bestRatio] = resolvedAcc;
-            const isCurrentSwapperBestSwapper = (() => {
-                // Happy path - no div by 0's in getRatioFromQuote evaluations so we have both ratios
-                if (!(0, lodash_1.isUndefined)(currentRatio) && !(0, lodash_1.isUndefined)(bestRatio))
-                    return currentRatio > bestRatio;
-                // We don't know, neither has a ratio, so we can't compare (big edge case div by 0 scenario)
-                if ((0, lodash_1.isUndefined)(currentRatio) && (0, lodash_1.isUndefined)(bestRatio))
-                    return false;
-                // We don't have a best, but we do have a current, so current is the new best
-                return !(0, lodash_1.isUndefined)(currentRatio);
-            })();
-            const currentSwapperRatioTuple = [currentSwapper, currentRatio];
-            return Promise.resolve(isCurrentSwapperBestSwapper ? currentSwapperRatioTuple : resolvedAcc);
-        }, undefined);
-        const bestSwapper = bestQuoteTuple === null || bestQuoteTuple === void 0 ? void 0 : bestQuoteTuple[0];
-        return bestSwapper;
+            .map((swapperDetailRequest) => swapperDetailRequest.value), ['inputOutputRatio']).reverse();
+        return swappersWithDetail;
     }
     /**
      *

package/dist/swappercli.js

@@ -105,10 +105,11 @@ const main = async () => {
         explorerTxLink: 'https://etherscan.io/tx/',
     };
     const { quoteInput } = (0, setupSwapQuote_1.setupQuote)();
-    const swapper = await swapManager.getBestSwapper({
+    const swappersWithQuoteMetadata = await swapManager.getSwappersWithQuoteMetadata({
         ...quoteInput,
         feeAsset: ethereumAsset,
     });
+    const swapper = swappersWithQuoteMetadata[0].swapper;
     console.info(`using swapper ${swapper === null || swapper === void 0 ? void 0 : swapper.getType()}`);
     if (!swapper) {
         console.warn(`no swapper found for specified assets`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "15.8.0",
+  "version": "16.0.0",
   "description": "An interface and implementations to trade coins via various protocols",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",