@shapeshiftoss/swapper 15.7.0 → 16.0.0

package/dist/api.d.ts

@@ -1,6 +1,6 @@
 import { Asset } from '@shapeshiftoss/asset-service';
 import { AssetId, ChainId } from '@shapeshiftoss/caip';
-import { avalanche, cosmos, ethereum, osmosis } from '@shapeshiftoss/chain-adapters';
+import { avalanche, cosmos, ethereum, optimism, osmosis } from '@shapeshiftoss/chain-adapters';
 import { HDWallet } from '@shapeshiftoss/hdwallet-core';
 import { ChainSpecific, KnownChainIds, UtxoAccountType } from '@shapeshiftoss/types';
 export declare const SwapError: {
@@ -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[];
@@ -91,9 +97,9 @@ declare type CommonTradeInput = {
     receiveAddress: string;
     accountNumber: number;
 };
-export declare type EvmSupportedChainIds = KnownChainIds.EthereumMainnet | KnownChainIds.AvalancheMainnet;
+export declare type EvmSupportedChainIds = KnownChainIds.EthereumMainnet | KnownChainIds.AvalancheMainnet | KnownChainIds.OptimismMainnet;
 export declare type CosmosSdkSupportedChainIds = KnownChainIds.CosmosMainnet | KnownChainIds.OsmosisMainnet | KnownChainIds.ThorchainMainnet;
-export declare type EvmSupportedChainAdapter = ethereum.ChainAdapter | avalanche.ChainAdapter;
+export declare type EvmSupportedChainAdapter = ethereum.ChainAdapter | avalanche.ChainAdapter | optimism.ChainAdapter;
 export declare type CosmosSdkSupportedChainAdapters = cosmos.ChainAdapter | osmosis.ChainAdapter;
 export declare type UtxoSupportedChainIds = KnownChainIds.BitcoinMainnet | KnownChainIds.DogecoinMainnet | KnownChainIds.LitecoinMainnet | KnownChainIds.BitcoinCashMainnet;
 export declare type GetEvmTradeQuoteInput = CommonTradeInput & {
@@ -174,6 +180,7 @@ export declare enum SwapperName {
 export declare enum SwapperType {
     ZrxEthereum = "0xEthereum",
     ZrxAvalanche = "0xAvalanche",
+    ZrxOptimism = "0xOptimism",
     Thorchain = "Thorchain",
     Osmosis = "Osmosis",
     CowSwap = "CoW Swap",

package/dist/api.js

@@ -16,6 +16,7 @@ var SwapperType;
 (function (SwapperType) {
     SwapperType["ZrxEthereum"] = "0xEthereum";
     SwapperType["ZrxAvalanche"] = "0xAvalanche";
+    SwapperType["ZrxOptimism"] = "0xOptimism";
     SwapperType["Thorchain"] = "Thorchain";
     SwapperType["Osmosis"] = "Osmosis";
     SwapperType["CowSwap"] = "CoW Swap";

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/manager/testData.d.ts

@@ -3,6 +3,7 @@ import { TradeQuote } from '../api';
 import { CowSwapper, ThorchainSwapper, ZrxSwapper } from '../swappers';
 export declare const getZrxEthereumSwapper: () => ZrxSwapper<import("../api").EvmSupportedChainIds>;
 export declare const getZrxAvalancheSwapper: () => ZrxSwapper<import("../api").EvmSupportedChainIds>;
+export declare const getZrxOptimismSwapper: () => ZrxSwapper<import("../api").EvmSupportedChainIds>;
 export declare const getCowSwapper: () => CowSwapper;
 export declare const getThorchainSwapper: () => ThorchainSwapper;
 export declare const tradeQuote: TradeQuote<KnownChainIds.EthereumMainnet>;

package/dist/manager/testData.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.badTradeQuote = exports.goodTradeQuote = exports.tradeQuote = exports.getThorchainSwapper = exports.getCowSwapper = exports.getZrxAvalancheSwapper = exports.getZrxEthereumSwapper = void 0;
+exports.badTradeQuote = exports.goodTradeQuote = exports.tradeQuote = exports.getThorchainSwapper = exports.getCowSwapper = exports.getZrxOptimismSwapper = exports.getZrxAvalancheSwapper = exports.getZrxEthereumSwapper = void 0;
 const types_1 = require("@shapeshiftoss/types");
 const api_1 = require("../api");
 const swappers_1 = require("../swappers");
@@ -21,6 +21,14 @@ const zrxAvalancheSwapperDeps = {
 };
 const getZrxAvalancheSwapper = () => new swappers_1.ZrxSwapper(zrxAvalancheSwapperDeps);
 exports.getZrxAvalancheSwapper = getZrxAvalancheSwapper;
+const zrxOptimismSwapperDeps = {
+    web3: {},
+    adapter: {
+        getChainId: () => types_1.KnownChainIds.OptimismMainnet,
+    },
+};
+const getZrxOptimismSwapper = () => new swappers_1.ZrxSwapper(zrxOptimismSwapperDeps);
+exports.getZrxOptimismSwapper = getZrxOptimismSwapper;
 const cowSwapperDeps = {
     apiUrl: 'https://api.cow.fi/mainnet/api/',
     adapter: {

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/dist/swappers/thorchain/types.d.ts

@@ -62,7 +62,7 @@ export interface BtcThorTrade<C extends ChainId> extends Trade<C> {
     txData: BTCSignTx;
 }
 export interface EvmThorTrade<C extends ChainId> extends Trade<C> {
-    chainId: KnownChainIds.EthereumMainnet | KnownChainIds.AvalancheMainnet;
+    chainId: KnownChainIds.EthereumMainnet | KnownChainIds.AvalancheMainnet | KnownChainIds.OptimismMainnet;
     txData: ETHSignTx;
 }
 export interface CosmosThorTrade<C extends ChainId> extends Trade<C> {

package/dist/swappers/utils/test-data/assets.d.ts

@@ -7,4 +7,5 @@ export declare const ETH: Asset;
 export declare const UNSUPPORTED: Asset;
 export declare const USDC: Asset;
 export declare const AVAX: Asset;
+export declare const OPTIMISM: Asset;
 export declare const RUNE: Asset;

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RUNE = exports.AVAX = exports.USDC = exports.UNSUPPORTED = exports.ETH = exports.WBTC = exports.FOX = exports.WETH = exports.BTC = void 0;
+exports.RUNE = exports.OPTIMISM = exports.AVAX = exports.USDC = exports.UNSUPPORTED = exports.ETH = exports.WBTC = exports.FOX = exports.WETH = exports.BTC = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
 exports.BTC = {
     assetId: 'bip122:000000000019d6689c085ae165831e93/slip44:0',
@@ -98,6 +98,21 @@ exports.AVAX = {
     explorerAddressLink: 'https://snowtrace.io/address/',
     explorerTxLink: 'https://snowtrace.io/tx/',
 };
+exports.OPTIMISM = {
+    assetId: caip_1.optimismAssetId,
+    chainId: caip_1.optimismChainId,
+    name: 'Ethereum',
+    networkName: 'Optimism',
+    symbol: 'ETH',
+    precision: 18,
+    color: '#5C6BC0',
+    networkColor: '#FC0424',
+    icon: 'https://assets.coincap.io/assets/icons/256/eth.png',
+    networkIcon: 'https://assets.coingecko.com/coins/images/25244/thumb/Optimism.png?1660904599',
+    explorer: 'https://optimistic.etherscan.io',
+    explorerAddressLink: 'https://optimistic.etherscan.io/address/',
+    explorerTxLink: 'https://optimistic.etherscan.io/tx/',
+};
 exports.RUNE = {
     assetId: caip_1.thorchainAssetId,
     chainId: caip_1.thorchainChainId,

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

@@ -7,7 +7,7 @@ export declare class ZrxSwapper<T extends EvmSupportedChainIds> implements Swapp
     deps: ZrxSwapperDeps;
     chainId: ChainId;
     constructor(deps: ZrxSwapperDeps);
-    getType(): SwapperType.ZrxEthereum | SwapperType.ZrxAvalanche;
+    getType(): SwapperType.ZrxEthereum | SwapperType.ZrxAvalanche | SwapperType.ZrxOptimism;
     buildTrade(args: BuildTradeInput): Promise<ZrxTrade<T>>;
     getTradeQuote(input: GetEvmTradeQuoteInput): Promise<TradeQuote<T>>;
     getUsdRate(input: Asset): Promise<string>;

package/dist/swappers/zrx/ZrxSwapper.js

@@ -23,6 +23,8 @@ class ZrxSwapper {
                 return api_1.SwapperType.ZrxEthereum;
             case types_1.KnownChainIds.AvalancheMainnet:
                 return api_1.SwapperType.ZrxAvalanche;
+            case types_1.KnownChainIds.OptimismMainnet:
+                return api_1.SwapperType.ZrxOptimism;
             default:
                 throw new api_1.SwapError('[getType]', {
                     code: api_1.SwapErrorType.UNSUPPORTED_CHAIN,

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

@@ -8,11 +8,12 @@ const bignumber_1 = require("../../../utils/bignumber");
 const zrxService_1 = require("../zrxService");
 const baseUrlFromChainId = (chainId) => {
     switch (chainId) {
-        case types_1.KnownChainIds.EthereumMainnet: {
+        case types_1.KnownChainIds.EthereumMainnet:
             return 'https://api.0x.org/';
-        }
         case types_1.KnownChainIds.AvalancheMainnet:
             return 'https://avalanche.api.0x.org/';
+        case types_1.KnownChainIds.OptimismMainnet:
+            return 'https://optimism.api.0x.org/';
         default:
             throw new api_1.SwapError(`baseUrlFromChainId] - Unsupported chainId: ${chainId}`, {
                 code: api_1.SwapErrorType.UNSUPPORTED_CHAIN,
@@ -22,11 +23,12 @@ const baseUrlFromChainId = (chainId) => {
 exports.baseUrlFromChainId = baseUrlFromChainId;
 const usdcContractFromChainId = (chainId) => {
     switch (chainId) {
-        case types_1.KnownChainIds.EthereumMainnet: {
+        case types_1.KnownChainIds.EthereumMainnet:
             return '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48';
-        }
         case types_1.KnownChainIds.AvalancheMainnet:
             return '0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e';
+        case types_1.KnownChainIds.OptimismMainnet:
+            return '0x7f5c764cbc14f9669b88837ca1490cca17c31607';
         default:
             throw new api_1.SwapError(`usdcContractFromChainId] - Unsupported chainId: ${chainId}`, {
                 code: api_1.SwapErrorType.UNSUPPORTED_CHAIN,
@@ -41,6 +43,8 @@ const isNativeEvmAsset = (assetId) => {
             return assetId === caip_1.ethAssetId;
         case types_1.KnownChainIds.AvalancheMainnet:
             return assetId === caip_1.avalancheAssetId;
+        case types_1.KnownChainIds.OptimismMainnet:
+            return assetId === caip_1.optimismAssetId;
         default:
             return false;
     }

package/package.json

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