@shapeshiftoss/swapper 5.1.5 → 5.2.2

package/dist/api.d.ts

@@ -1,6 +1,6 @@
 import { AssetId } from '@shapeshiftoss/caip';
 import { HDWallet } from '@shapeshiftoss/hdwallet-core';
-import { ApprovalNeededOutput, Asset, ChainSpecific, ExecQuoteOutput, GetMinMaxInput, MinMaxOutput, SupportedChainIds, SwapperType } from '@shapeshiftoss/types';
+import { Asset, ChainSpecific, SupportedChainIds } from '@shapeshiftoss/types';
 export declare const SwapError: {
     new <V extends {
         cause?: unknown;
@@ -90,11 +90,7 @@ export declare type ExecuteTradeInput<C extends SupportedChainIds> = {
     wallet: HDWallet;
 };
 export declare type TradeResult = {
-    txid: string;
-};
-export declare type SwapSource = {
-    name: string;
-    proportion: string;
+    tradeId: string;
 };
 export declare type ApproveInfiniteInput<C extends SupportedChainIds> = {
     quote: TradeQuote<C>;
@@ -104,6 +100,32 @@ export declare type ApprovalNeededInput<C extends SupportedChainIds> = {
     quote: TradeQuote<C>;
     wallet: HDWallet;
 };
+export declare type SwapSource = {
+    name: string;
+    proportion: string;
+};
+export interface MinMaxOutput {
+    minimum: string;
+    maximum: string;
+}
+export declare type GetMinMaxInput = {
+    sellAsset: Asset;
+    buyAsset: Asset;
+};
+export declare type ApprovalNeededOutput = {
+    approvalNeeded: boolean;
+    gas?: string;
+    gasPrice?: string;
+};
+export declare enum SwapperType {
+    Zrx = "0x",
+    Thorchain = "Thorchain",
+    Test = "Test"
+}
+export declare type TradeTxs = {
+    sellTxid: string;
+    buyTxid?: string;
+};
 export declare enum SwapErrorTypes {
     ALLOWANCE_REQUIRED_FAILED = "ALLOWANCE_REQUIRED_FAILED",
     APPROVE_INFINITE_FAILED = "APPROVE_INFINITE_FAILED",
@@ -122,6 +144,8 @@ export declare enum SwapErrorTypes {
     VALIDATION_FAILED = "VALIDATION_FAILED"
 }
 export interface Swapper {
+    /** perform any necessary async initialization */
+    initialize(): Promise<void>;
     /** Returns the swapper type */
     getType(): SwapperType;
     /**
@@ -143,7 +167,7 @@ export interface Swapper {
     /**
      * Execute a trade built with buildTrade by signing and broadcasting
      */
-    executeTrade(args: ExecuteTradeInput<SupportedChainIds>): Promise<ExecQuoteOutput>;
+    executeTrade(args: ExecuteTradeInput<SupportedChainIds>): Promise<TradeResult>;
     /**
      * Get a boolean if a quote needs approval
      */
@@ -160,5 +184,6 @@ export interface Swapper {
      * Get supported sell assetIds
      */
     filterAssetIdsBySellable(assetIds: AssetId[]): AssetId[];
+    getTradeTxs(tradeResult: TradeResult): Promise<TradeTxs>;
 }
 export {};

package/dist/api.js

@@ -1,8 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SwapErrorTypes = exports.SwapError = void 0;
+exports.SwapErrorTypes = exports.SwapperType = exports.SwapError = void 0;
 const errors_1 = require("@shapeshiftoss/errors");
 exports.SwapError = (0, errors_1.createErrorClass)('SwapError');
+var SwapperType;
+(function (SwapperType) {
+    SwapperType["Zrx"] = "0x";
+    SwapperType["Thorchain"] = "Thorchain";
+    SwapperType["Test"] = "Test";
+})(SwapperType = exports.SwapperType || (exports.SwapperType = {}));
 // Swap Errors
 var SwapErrorTypes;
 (function (SwapErrorTypes) {

package/dist/manager/SwapperManager.d.ts

@@ -1,5 +1,5 @@
-import { SwapperType } from '@shapeshiftoss/types';
 import { BuyAssetBySellIdInput, ByPairInput, SupportedSellAssetsInput, Swapper } from '..';
+import { SwapperType } from '../api';
 export declare class SwapperManager {
     swappers: Map<SwapperType, Swapper>;
     constructor();

package/dist/swappercli.js

@@ -11,6 +11,7 @@ const bignumber_js_1 = __importDefault(require("bignumber.js"));
 const dotenv_1 = __importDefault(require("dotenv"));
 const readline_sync_1 = __importDefault(require("readline-sync"));
 const web3_1 = __importDefault(require("web3"));
+const api_1 = require("./api");
 const SwapperManager_1 = require("./manager/SwapperManager");
 const ZrxSwapper_1 = require("./swappers/zrx/ZrxSwapper");
 dotenv_1.default.config();
@@ -83,7 +84,7 @@ const main = async () => {
     const zrxSwapperDeps = { wallet, adapterManager, web3 };
     const manager = new SwapperManager_1.SwapperManager();
     const zrxSwapper = new ZrxSwapper_1.ZrxSwapper(zrxSwapperDeps);
-    manager.addSwapper(types_1.SwapperType.Zrx, zrxSwapper);
+    manager.addSwapper(api_1.SwapperType.Zrx, zrxSwapper);
     const swapper = await manager.getBestSwapper({
         sellAssetId: 'eip155:1/slip44:60',
         buyAssetId: 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d'

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

@@ -1,12 +1,13 @@
 import { AssetId } from '@shapeshiftoss/caip';
-import { ApprovalNeededOutput, Asset, ExecQuoteOutput, GetMinMaxInput, MinMaxOutput, SupportedChainIds, SwapperType } from '@shapeshiftoss/types';
-import { BuyAssetBySellIdInput, Swapper, Trade, TradeQuote } from '../../api';
+import { Asset, SupportedChainIds } from '@shapeshiftoss/types';
+import { ApprovalNeededOutput, BuyAssetBySellIdInput, GetMinMaxInput, MinMaxOutput, Swapper, SwapperType, Trade, TradeQuote, TradeResult, TradeTxs } 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[];
+    initialize(): Promise<void>;
     getType(): SwapperType;
     constructor();
     getUsdRate(input: Pick<Asset, 'symbol' | 'assetId'>): Promise<string>;
@@ -17,5 +18,6 @@ export declare class TestSwapper implements Swapper {
     filterAssetIdsBySellable(): AssetId[];
     buildTrade(): Promise<Trade<SupportedChainIds>>;
     getTradeQuote(): Promise<TradeQuote<SupportedChainIds>>;
-    executeTrade(): Promise<ExecQuoteOutput>;
+    executeTrade(): Promise<TradeResult>;
+    getTradeTxs(): Promise<TradeTxs>;
 }

package/dist/swappers/test/TestSwapper.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TestSwapper = void 0;
-const types_1 = require("@shapeshiftoss/types");
+const api_1 = require("../../api");
 /**
  * Playground for testing different scenarios of multiple swappers in the manager.
  * Meant for local testing only
@@ -14,8 +14,11 @@ class TestSwapper {
             'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d'
         ];
     }
+    // noop for test
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    async initialize() { }
     getType() {
-        return types_1.SwapperType.Test;
+        return api_1.SwapperType.Test;
     }
     getUsdRate(input) {
         console.info(input);
@@ -49,5 +52,8 @@ class TestSwapper {
     async executeTrade() {
         throw new Error('TestSwapper: executeTrade unimplemented');
     }
+    async getTradeTxs() {
+        throw new Error('TestSwapper: executeTrade unimplemented');
+    }
 }
 exports.TestSwapper = TestSwapper;

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

@@ -1,8 +1,9 @@
 import { AssetId } from '@shapeshiftoss/caip';
-import { ApprovalNeededOutput, Asset, ExecQuoteOutput, GetMinMaxInput, MinMaxOutput, SupportedChainIds, SwapperType } from '@shapeshiftoss/types';
-import { Swapper, Trade, TradeQuote } from '../../api';
+import { Asset, SupportedChainIds } from '@shapeshiftoss/types';
+import { ApprovalNeededOutput, GetMinMaxInput, MinMaxOutput, Swapper, SwapperType, Trade, TradeQuote, TradeResult, TradeTxs } from '../../api';
 export declare class ThorchainSwapper implements Swapper {
     getType(): SwapperType;
+    initialize(): Promise<void>;
     getUsdRate(input: Pick<Asset, 'symbol' | 'assetId'>): Promise<string>;
     getMinMax(input: GetMinMaxInput): Promise<MinMaxOutput>;
     approvalNeeded(): Promise<ApprovalNeededOutput>;
@@ -11,5 +12,6 @@ export declare class ThorchainSwapper implements Swapper {
     filterAssetIdsBySellable(): AssetId[];
     buildTrade(): Promise<Trade<SupportedChainIds>>;
     getTradeQuote(): Promise<TradeQuote<SupportedChainIds>>;
-    executeTrade(): Promise<ExecQuoteOutput>;
+    executeTrade(): Promise<TradeResult>;
+    getTradeTxs(): Promise<TradeTxs>;
 }

package/dist/swappers/thorchain/ThorchainSwapper.js

@@ -1,11 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThorchainSwapper = void 0;
-const types_1 = require("@shapeshiftoss/types");
+const api_1 = require("../../api");
 class ThorchainSwapper {
     getType() {
-        return types_1.SwapperType.Thorchain;
+        return api_1.SwapperType.Thorchain;
     }
+    // TODO populate supported assets from midgard
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    async initialize() { }
     getUsdRate(input) {
         console.info(input);
         throw new Error('ThorchainSwapper: getUsdRate unimplemented');
@@ -35,5 +38,8 @@ class ThorchainSwapper {
     async executeTrade() {
         throw new Error('ThorchainSwapper: executeTrade unimplemented');
     }
+    async getTradeTxs() {
+        throw new Error('ThorchainSwapper: executeTrade unimplemented');
+    }
 }
 exports.ThorchainSwapper = ThorchainSwapper;

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

@@ -1,4 +1,4 @@
-import { ApprovalNeededOutput, SupportedChainIds } from '@shapeshiftoss/types';
-import { ApprovalNeededInput } from '../../../api';
+import { SupportedChainIds } from '@shapeshiftoss/types';
+import { ApprovalNeededInput, ApprovalNeededOutput } from '../../../api';
 import { ZrxSwapperDeps } from '../ZrxSwapper';
 export declare function ZrxApprovalNeeded({ adapterManager, web3 }: ZrxSwapperDeps, { quote, wallet }: ApprovalNeededInput<SupportedChainIds>): Promise<ApprovalNeededOutput>;

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

@@ -1,8 +1,8 @@
 import { AssetId } from '@shapeshiftoss/caip';
 import { ChainAdapterManager } from '@shapeshiftoss/chain-adapters';
-import { ApprovalNeededOutput, Asset, ExecQuoteOutput, GetMinMaxInput, MinMaxOutput, SupportedChainIds, SwapperType } from '@shapeshiftoss/types';
+import { Asset, SupportedChainIds } from '@shapeshiftoss/types';
 import Web3 from 'web3';
-import { ApprovalNeededInput, ApproveInfiniteInput, BuildTradeInput, BuyAssetBySellIdInput, ExecuteTradeInput, GetTradeQuoteInput, Swapper, TradeQuote, ZrxTrade } from '../../api';
+import { ApprovalNeededInput, ApprovalNeededOutput, ApproveInfiniteInput, BuildTradeInput, BuyAssetBySellIdInput, ExecuteTradeInput, GetMinMaxInput, GetTradeQuoteInput, MinMaxOutput, Swapper, SwapperType, TradeQuote, TradeResult, TradeTxs, ZrxTrade } from '../../api';
 export declare type ZrxSwapperDeps = {
     adapterManager: ChainAdapterManager;
     web3: Web3;
@@ -11,14 +11,16 @@ export declare class ZrxSwapper implements Swapper {
     static swapperName: string;
     deps: ZrxSwapperDeps;
     constructor(deps: ZrxSwapperDeps);
+    initialize(): Promise<void>;
     getType(): SwapperType;
     buildTrade(args: BuildTradeInput): Promise<ZrxTrade<SupportedChainIds>>;
     getTradeQuote(input: GetTradeQuoteInput): Promise<TradeQuote<SupportedChainIds>>;
     getUsdRate(input: Pick<Asset, 'symbol' | 'assetId'>): Promise<string>;
     getMinMax(input: GetMinMaxInput): Promise<MinMaxOutput>;
-    executeTrade(args: ExecuteTradeInput<SupportedChainIds>): Promise<ExecQuoteOutput>;
+    executeTrade(args: ExecuteTradeInput<SupportedChainIds>): Promise<TradeResult>;
     approvalNeeded(args: ApprovalNeededInput<SupportedChainIds>): Promise<ApprovalNeededOutput>;
     approveInfinite(args: ApproveInfiniteInput<SupportedChainIds>): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): AssetId[];
     filterAssetIdsBySellable(assetIds?: AssetId[]): AssetId[];
+    getTradeTxs(tradeResult: TradeResult): Promise<TradeTxs>;
 }

package/dist/swappers/zrx/ZrxSwapper.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZrxSwapper = void 0;
-const types_1 = require("@shapeshiftoss/types");
+const api_1 = require("../../api");
 const getZrxMinMax_1 = require("./getZrxMinMax/getZrxMinMax");
 const getZrxTradeQuote_1 = require("./getZrxTradeQuote/getZrxTradeQuote");
 const blacklist_1 = require("./utils/blacklist");
@@ -14,8 +14,11 @@ class ZrxSwapper {
     constructor(deps) {
         this.deps = deps;
     }
+    // noop for zrx
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    async initialize() { }
     getType() {
-        return types_1.SwapperType.Zrx;
+        return api_1.SwapperType.Zrx;
     }
     async buildTrade(args) {
         return (0, zrxBuildTrade_1.zrxBuildTrade)(this.deps, args);
@@ -47,6 +50,12 @@ class ZrxSwapper {
     filterAssetIdsBySellable(assetIds = []) {
         return assetIds.filter((id) => id.startsWith('eip155:1') && !blacklist_1.UNSUPPORTED_ASSETS.includes(id));
     }
+    async getTradeTxs(tradeResult) {
+        return {
+            sellTxid: tradeResult.tradeId,
+            buyTxid: tradeResult.tradeId
+        };
+    }
 }
 exports.ZrxSwapper = ZrxSwapper;
 ZrxSwapper.swapperName = 'ZrxSwapper';

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

@@ -1,2 +1,3 @@
-import { Asset, MinMaxOutput } from '@shapeshiftoss/types';
+import { Asset } from '@shapeshiftoss/types';
+import { MinMaxOutput } from '../../../api';
 export declare const getZrxMinMax: (sellAsset: Asset, buyAsset: Asset) => Promise<MinMaxOutput>;

package/dist/swappers/zrx/zrxExecuteTrade/zrxExecuteTrade.js

@@ -30,14 +30,14 @@ async function zrxExecuteTrade({ adapterManager }, { trade, wallet }) {
         if (wallet.supportsOfflineSigning()) {
             const signedTx = await adapter.signTransaction({ txToSign: txWithQuoteData, wallet });
             const txid = await adapter.broadcastTransaction(signedTx);
-            return { txid };
+            return { tradeId: txid };
         }
         else if (wallet.supportsBroadcast() && adapter.signAndBroadcastTransaction) {
             const txid = await ((_f = adapter.signAndBroadcastTransaction) === null || _f === void 0 ? void 0 : _f.call(adapter, {
                 txToSign: txWithQuoteData,
                 wallet
             }));
-            return { txid };
+            return { tradeId: txid };
         }
         else {
             throw new api_1.SwapError('[zrxExecuteTrade]', {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "5.1.5",
+  "version": "5.2.2",
   "description": "TODO: description",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",
@@ -30,19 +30,19 @@
     "web3": "^1.6.1"
   },
   "peerDependencies": {
-    "@shapeshiftoss/asset-service": "^3.0.0",
+    "@shapeshiftoss/asset-service": "^4.2.4",
     "@shapeshiftoss/caip": "^5.0.0",
-    "@shapeshiftoss/chain-adapters": "^4.0.0",
+    "@shapeshiftoss/chain-adapters": "^4.3.3",
     "@shapeshiftoss/hdwallet-core": "1.20.0",
-    "@shapeshiftoss/types": "^4.0.0",
+    "@shapeshiftoss/types": "^4.3.1",
     "@shapeshiftoss/errors": "^1.1.0"
   },
   "devDependencies": {
-    "@shapeshiftoss/asset-service": "^3.0.0",
+    "@shapeshiftoss/asset-service": "^4.2.4",
     "@shapeshiftoss/caip": "^5.0.0",
-    "@shapeshiftoss/chain-adapters": "^4.0.0",
+    "@shapeshiftoss/chain-adapters": "^4.3.3",
     "@shapeshiftoss/hdwallet-core": "^1.20.0",
-    "@shapeshiftoss/types": "^4.1.0",
+    "@shapeshiftoss/types": "^4.3.1",
     "@shapeshiftoss/errors": "^1.1.0",
     "@types/readline-sync": "^1.4.4",
     "readline-sync": "^1.4.10",