@shapeshiftoss/swapper 2.0.2 → 2.2.0

package/dist/api.d.ts

@@ -1,6 +1,20 @@
 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';
+export declare type SupportedAssetInput = {
+    assetIds: CAIP19[];
+};
+export declare type ByPairInput = {
+    sellAssetId: CAIP19;
+    buyAssetId: CAIP19;
+};
+export declare type BuyAssetBySellIdInput = {
+    sellAssetId: CAIP19;
+    assetIds: CAIP19[];
+};
+export declare type SupportedSellAssetsInput = {
+    assetIds: CAIP19[];
+};
 export declare class SwapError extends Error {
 }
 export interface Swapper {
@@ -14,14 +28,6 @@ export interface Swapper {
      * Get a basic quote (rate) for a trading pair
      */
     getQuote(input: GetQuoteInput, wallet?: HDWallet): Promise<Quote<ChainTypes, SwapperType>>;
-    /**
-     * Get a list of available assets based on the array of assets you send it
-     */
-    getAvailableAssets(assets: Asset[]): Asset[];
-    /**
-     * Get a boolean if the trade pair will work
-     */
-    canTradePair(sellAsset: Asset, buyAsset: Asset): boolean;
     /**
      * Get the usd rate from either the assets symbol or tokenId
      */
@@ -50,4 +56,12 @@ export interface Swapper {
      * Get max swap balance (minus fees) for sell asset
      */
     getSendMaxAmount(args: SendMaxAmountInput): Promise<string>;
+    /**
+     * Get supported buyAssetId's by sellAssetId
+     */
+    filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): CAIP19[];
+    /**
+     * Get supported sell assetIds
+     */
+    filterAssetIdsBySellable(assetIds: CAIP19[]): CAIP19[];
 }

package/dist/manager/SwapperManager.d.ts

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

package/dist/manager/SwapperManager.js

@@ -1,7 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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) {
         super(message);
@@ -59,5 +63,21 @@ class SwapperManager {
         quoteParams; // noop to shut up linter
         return types_1.SwapperType.Zrx; // TODO: implement getBestSwapper
     }
+    /**
+     *
+     * @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)));
+    }
+    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,23 @@
+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>;
+    getSendMaxAmount(): Promise<string>;
+    filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): CAIP19[];
+    filterAssetIdsBySellable(): CAIP19[];
+}

package/dist/swappers/test/TestSwapper.js

@@ -0,0 +1,59 @@
+"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');
+    }
+    async getSendMaxAmount() {
+        throw new Error('TestSwapper: getSendMaxAmount 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

@@ -7,11 +7,11 @@ export declare class ThorchainSwapper implements Swapper {
     buildQuoteTx(): Promise<Quote<ChainTypes, SwapperType>>;
     getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
     getMinMax(input: GetQuoteInput): Promise<MinMaxOutput>;
-    getAvailableAssets(assets: Asset[]): Asset[];
-    canTradePair(sellAsset: Asset, buyAsset: Asset): boolean;
     executeQuote(): Promise<ExecQuoteOutput>;
     getDefaultPair(): [CAIP19, CAIP19];
     approvalNeeded(): Promise<ApprovalNeededOutput>;
     approveInfinite(): Promise<string>;
     getSendMaxAmount(): Promise<string>;
+    filterBuyAssetsBySellAssetId(): CAIP19[];
+    filterAssetIdsBySellable(): CAIP19[];
 }

package/dist/swappers/thorchain/ThorchainSwapper.js

@@ -20,14 +20,6 @@ class ThorchainSwapper {
         console.info(input);
         throw new Error('ThorchainSwapper: getMinMax unimplemented');
     }
-    getAvailableAssets(assets) {
-        console.info(assets);
-        throw new Error('ThorchainSwapper: getAvailableAssets unimplemented');
-    }
-    canTradePair(sellAsset, buyAsset) {
-        console.info(sellAsset, buyAsset);
-        throw new Error('ThorchainSwapper: canTradePair unimplemented');
-    }
     async executeQuote() {
         throw new Error('ThorchainSwapper: executeQuote unimplemented');
     }
@@ -43,5 +35,11 @@ class ThorchainSwapper {
     async getSendMaxAmount() {
         throw new Error('ThorchainSwapper: getSendMaxAmount unimplemented');
     }
+    filterBuyAssetsBySellAssetId() {
+        return [];
+    }
+    filterAssetIdsBySellable() {
+        return [];
+    }
 }
 exports.ThorchainSwapper = ThorchainSwapper;

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

@@ -2,7 +2,7 @@ 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 Web3 from 'web3';
-import { Swapper } from '../../api';
+import { BuyAssetBySellIdInput, Swapper } from '../../api';
 export declare type ZrxSwapperDeps = {
     adapterManager: ChainAdapterManager;
     web3: Web3;
@@ -19,11 +19,11 @@ export declare class ZrxSwapper implements Swapper {
     getQuote(input: GetQuoteInput): Promise<Quote<ChainTypes, SwapperType>>;
     getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
     getMinMax(input: GetQuoteInput): Promise<MinMaxOutput>;
-    getAvailableAssets(assets: Asset[]): Asset[];
-    canTradePair(sellAsset: Asset, buyAsset: Asset): boolean;
     getDefaultPair(): [CAIP19, CAIP19];
     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

@@ -36,13 +36,6 @@ class ZrxSwapper {
     async getMinMax(input) {
         return (0, getZrxMinMax_1.getZrxMinMax)(input);
     }
-    getAvailableAssets(assets) {
-        return assets.filter((asset) => asset.chain === types_1.ChainTypes.Ethereum);
-    }
-    canTradePair(sellAsset, buyAsset) {
-        const availableAssets = this.getAvailableAssets([sellAsset, buyAsset]);
-        return availableAssets.length === 2;
-    }
     getDefaultPair() {
         const ETH = 'eip155:1/slip44:60';
         const FOX = 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d';
@@ -60,6 +53,14 @@ class ZrxSwapper {
     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.
+        return assetIds.filter((id) => id.startsWith('eip155:1') && sellAssetId.startsWith('eip155:1'));
+    }
+    filterAssetIdsBySellable(assetIds) {
+        return assetIds.filter((id) => id.startsWith('eip155:1'));
+    }
 }
 exports.ZrxSwapper = ZrxSwapper;
 ZrxSwapper.swapperName = 'ZrxSwapper';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "2.0.2",
+  "version": "2.2.0",
   "description": "TODO: description",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",
@@ -23,6 +23,7 @@
   "dependencies": {
     "axios": "^0.26.0",
     "bignumber.js": "^9.0.1",
+    "lodash": "^4.17.21",
     "retry-axios": "^2.6.0",
     "web3": "^1.6.1"
   },
@@ -30,14 +31,14 @@
     "@shapeshiftoss/asset-service": "^2.0.0",
     "@shapeshiftoss/caip": "^2.0.0",
     "@shapeshiftoss/chain-adapters": "^2.0.0",
-    "@shapeshiftoss/hdwallet-core": "^1.18.2",
+    "@shapeshiftoss/hdwallet-core": "1.20.0",
     "@shapeshiftoss/types": "^2.1.0"
   },
   "devDependencies": {
     "@shapeshiftoss/asset-service": "^2.0.0",
     "@shapeshiftoss/caip": "^2.0.0",
     "@shapeshiftoss/chain-adapters": "^2.0.0",
-    "@shapeshiftoss/hdwallet-core": "^1.19.0",
+    "@shapeshiftoss/hdwallet-core": "^1.20.0",
     "@shapeshiftoss/types": "^2.1.0",
     "@types/readline-sync": "^1.4.4",
     "readline-sync": "^1.4.10",