@shapeshiftoss/swapper 2.2.2 → 3.0.1

package/dist/api.d.ts

@@ -23,11 +23,11 @@ export interface Swapper {
     /**
      * Get a Quote along with an unsigned transaction that can be signed and broadcast to execute the swap
      **/
-    buildQuoteTx(args: BuildQuoteTxInput): Promise<Quote<ChainTypes, SwapperType>>;
+    buildQuoteTx(args: BuildQuoteTxInput): Promise<Quote<ChainTypes>>;
     /**
      * Get a basic quote (rate) for a trading pair
      */
-    getQuote(input: GetQuoteInput, wallet?: HDWallet): Promise<Quote<ChainTypes, SwapperType>>;
+    getQuote(input: GetQuoteInput, wallet?: HDWallet): Promise<Quote<ChainTypes>>;
     /**
      * Get the usd rate from either the assets symbol or tokenId
      */
@@ -43,15 +43,15 @@ export interface Swapper {
     /**
      * Execute a quote built with buildQuoteTx by signing and broadcasting
      */
-    executeQuote(args: ExecQuoteInput<ChainTypes, SwapperType>): Promise<ExecQuoteOutput>;
+    executeQuote(args: ExecQuoteInput<ChainTypes>): Promise<ExecQuoteOutput>;
     /**
      * Get a boolean if a quote needs approval
      */
-    approvalNeeded(args: ApprovalNeededInput<ChainTypes, SwapperType>): Promise<ApprovalNeededOutput>;
+    approvalNeeded(args: ApprovalNeededInput<ChainTypes>): Promise<ApprovalNeededOutput>;
     /**
      * Get the txid of an approve infinite transaction
      */
-    approveInfinite(args: ApproveInfiniteInput<ChainTypes, SwapperType>): Promise<string>;
+    approveInfinite(args: ApproveInfiniteInput<ChainTypes>): Promise<string>;
     /**
      * Get supported buyAssetId's by sellAssetId
      */

package/dist/swappercli.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/swappercli.js

@@ -0,0 +1,111 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const asset_service_1 = require("@shapeshiftoss/asset-service");
+const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
+const hdwallet_native_1 = require("@shapeshiftoss/hdwallet-native");
+const types_1 = require("@shapeshiftoss/types");
+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 SwapperManager_1 = require("./manager/SwapperManager");
+const ZrxSwapper_1 = require("./swappers/zrx/ZrxSwapper");
+dotenv_1.default.config();
+const { UNCHAINED_HTTP_API = 'http://localhost:31300', UNCHAINED_WS_API = 'wss://localhost:31300', ETH_NODE_URL = 'http://localhost:3000', DEVICE_ID = 'device123', MNEMONIC = 'salon adapt foil saddle orient make page zero cheese marble test catalog' } = process.env;
+const toBaseUnit = (amount, precision) => {
+    return new bignumber_js_1.default(amount)
+        .multipliedBy(new bignumber_js_1.default(10).exponentiatedBy(new bignumber_js_1.default(precision)))
+        .toString();
+};
+const fromBaseUnit = (amount, precision) => {
+    return new bignumber_js_1.default(amount).times(new bignumber_js_1.default(10).exponentiatedBy(precision * -1)).toString();
+};
+const getWallet = async () => {
+    if (!MNEMONIC) {
+        throw new Error('Cannot init native wallet without mnemonic');
+    }
+    const nativeAdapterArgs = {
+        mnemonic: MNEMONIC,
+        deviceId: DEVICE_ID
+    };
+    const wallet = new hdwallet_native_1.NativeHDWallet(nativeAdapterArgs);
+    await wallet.initialize();
+    return wallet;
+};
+const main = async () => {
+    const [, , ...args] = process.argv;
+    const [sellSymbol, buySymbol, sellAmount] = args;
+    console.info(`sellSymbol: sell ${sellAmount} of ${sellSymbol} to ${buySymbol}`);
+    if (!sellAmount || !sellSymbol || !buySymbol) {
+        console.error(`
+      Usage:
+      swapcli [sellSymbol] [buySymbol] [sellAmount](denominated in sell asset, not wei)
+    `);
+        return;
+    }
+    const assetService = new asset_service_1.AssetService('');
+    await assetService.initialize();
+    const assets = assetService.byNetwork(types_1.NetworkTypes.MAINNET);
+    if (!assets) {
+        console.error('No assets found in asset service');
+        return;
+    }
+    const assetMap = assets.reduce((acc, val) => {
+        if (val) {
+            acc[val.symbol] = val;
+        }
+        return acc;
+    }, {});
+    const sellAsset = assetMap[sellSymbol];
+    const buyAsset = assetMap[buySymbol];
+    if (!sellAsset) {
+        console.error(`No asset ${sellSymbol} found in asset service`);
+        return;
+    }
+    if (!buyAsset) {
+        console.error(`No asset ${buySymbol} found in asset service`);
+        return;
+    }
+    // Swapper Deps
+    const wallet = await getWallet();
+    const unchainedUrls = {
+        [types_1.ChainTypes.Ethereum]: {
+            httpUrl: UNCHAINED_HTTP_API,
+            wsUrl: UNCHAINED_WS_API
+        }
+    };
+    const adapterManager = new chain_adapters_1.ChainAdapterManager(unchainedUrls);
+    const web3Provider = new web3_1.default.providers.HttpProvider(ETH_NODE_URL);
+    const web3 = new web3_1.default(web3Provider);
+    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);
+    const swapper = manager.getSwapper(types_1.SwapperType.Zrx);
+    const sellAmountBase = toBaseUnit(sellAmount, sellAsset.precision);
+    const quote = await swapper.buildQuoteTx({
+        input: {
+            sellAsset,
+            buyAsset,
+            sellAmount: sellAmountBase,
+            sellAssetAccountId: '0',
+            buyAssetAccountId: '0'
+        },
+        wallet
+    });
+    console.info('quote = ', JSON.stringify(quote));
+    if (!quote.success) {
+        console.error('Obtaining the quote failed: ', quote.statusReason);
+        return;
+    }
+    const buyAmount = fromBaseUnit(quote.buyAmount || '0', buyAsset.precision);
+    const answer = readline_sync_1.default.question(`Swap ${sellAmount} ${sellAsset.symbol} for ${buyAmount} ${buyAsset.symbol} on ${swapper.getType()}? (y/n): `);
+    if (answer === 'y') {
+        const txid = await swapper.executeQuote({ quote, wallet });
+        console.info('broadcast tx with id: ', txid);
+    }
+};
+main().then(() => console.info('Done'));

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

@@ -9,8 +9,8 @@ export declare class TestSwapper implements Swapper {
     supportAssets: string[];
     getType(): SwapperType;
     constructor();
-    getQuote(): Promise<Quote<ChainTypes, SwapperType>>;
-    buildQuoteTx(): Promise<Quote<ChainTypes, SwapperType>>;
+    getQuote(): Promise<Quote<ChainTypes>>;
+    buildQuoteTx(): Promise<Quote<ChainTypes>>;
     getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
     getMinMax(input: GetQuoteInput): Promise<MinMaxOutput>;
     executeQuote(): Promise<ExecQuoteOutput>;

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

@@ -3,8 +3,8 @@ import { ApprovalNeededOutput, Asset, ChainTypes, ExecQuoteOutput, GetQuoteInput
 import { Swapper } from '../../api';
 export declare class ThorchainSwapper implements Swapper {
     getType(): SwapperType;
-    getQuote(): Promise<Quote<ChainTypes, SwapperType>>;
-    buildQuoteTx(): Promise<Quote<ChainTypes, SwapperType>>;
+    getQuote(): Promise<Quote<ChainTypes>>;
+    buildQuoteTx(): Promise<Quote<ChainTypes>>;
     getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
     getMinMax(input: GetQuoteInput): Promise<MinMaxOutput>;
     executeQuote(): Promise<ExecQuoteOutput>;

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

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

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

@@ -1,3 +1,3 @@
-import { ApproveInfiniteInput, ChainTypes, SwapperType } from '@shapeshiftoss/types';
+import { ApproveInfiniteInput, ChainTypes } from '@shapeshiftoss/types';
 import { ZrxSwapperDeps } from '../ZrxSwapper';
-export declare function ZrxApproveInfinite({ adapterManager, web3 }: ZrxSwapperDeps, { quote, wallet }: ApproveInfiniteInput<ChainTypes, SwapperType>): Promise<string>;
+export declare function ZrxApproveInfinite({ adapterManager, web3 }: ZrxSwapperDeps, { quote, wallet }: ApproveInfiniteInput<ChainTypes>): Promise<string>;

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

@@ -1,3 +1,3 @@
-import { BuildQuoteTxInput, ChainTypes, Quote, SwapperType } from '@shapeshiftoss/types';
+import { BuildQuoteTxInput, ChainTypes, Quote } from '@shapeshiftoss/types';
 import { ZrxSwapperDeps } from '../ZrxSwapper';
-export declare function ZrxBuildQuoteTx({ adapterManager, web3 }: ZrxSwapperDeps, { input, wallet }: BuildQuoteTxInput): Promise<Quote<ChainTypes, SwapperType>>;
+export declare function ZrxBuildQuoteTx({ adapterManager, web3 }: ZrxSwapperDeps, { input, wallet }: BuildQuoteTxInput): Promise<Quote<ChainTypes>>;

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

@@ -1,3 +1,3 @@
-import { ChainTypes, ExecQuoteInput, ExecQuoteOutput, SwapperType } from '@shapeshiftoss/types';
+import { ChainTypes, ExecQuoteInput, ExecQuoteOutput } from '@shapeshiftoss/types';
 import { ZrxSwapperDeps } from '../ZrxSwapper';
-export declare function ZrxExecuteQuote({ adapterManager }: ZrxSwapperDeps, { quote, wallet }: ExecQuoteInput<ChainTypes.Ethereum, SwapperType>): Promise<ExecQuoteOutput>;
+export declare function ZrxExecuteQuote({ adapterManager }: ZrxSwapperDeps, { quote, wallet }: ExecQuoteInput<ChainTypes.Ethereum>): Promise<ExecQuoteOutput>;

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

@@ -15,14 +15,14 @@ export declare class ZrxSwapper implements Swapper {
     deps: ZrxSwapperDeps;
     constructor(deps: ZrxSwapperDeps);
     getType(): SwapperType;
-    buildQuoteTx(args: BuildQuoteTxInput): Promise<Quote<ChainTypes, SwapperType>>;
-    getQuote(input: GetQuoteInput): Promise<Quote<ChainTypes, SwapperType>>;
+    buildQuoteTx(args: BuildQuoteTxInput): Promise<Quote<ChainTypes>>;
+    getQuote(input: GetQuoteInput): Promise<Quote<ChainTypes>>;
     getUsdRate(input: Pick<Asset, 'symbol' | 'tokenId'>): Promise<string>;
     getMinMax(input: GetQuoteInput): Promise<MinMaxOutput>;
     getDefaultPair(): [CAIP19, CAIP19];
-    executeQuote(args: ExecQuoteInput<ChainTypes, SwapperType>): Promise<ExecQuoteOutput>;
-    approvalNeeded(args: ApprovalNeededInput<ChainTypes, SwapperType>): Promise<ApprovalNeededOutput>;
-    approveInfinite(args: ApproveInfiniteInput<ChainTypes, SwapperType>): Promise<string>;
+    executeQuote(args: ExecQuoteInput<ChainTypes>): Promise<ExecQuoteOutput>;
+    approvalNeeded(args: ApprovalNeededInput<ChainTypes>): Promise<ApprovalNeededOutput>;
+    approveInfinite(args: ApproveInfiniteInput<ChainTypes>): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): CAIP19[];
     filterAssetIdsBySellable(assetIds: CAIP19[]): CAIP19[];
 }

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

@@ -1,2 +1,2 @@
-import { ChainTypes, GetQuoteInput, Quote, SwapperType } from '@shapeshiftoss/types';
-export declare function getZrxQuote(input: GetQuoteInput): Promise<Quote<ChainTypes.Ethereum, SwapperType>>;
+import { ChainTypes, GetQuoteInput, Quote } from '@shapeshiftoss/types';
+export declare function getZrxQuote(input: GetQuoteInput): Promise<Quote<ChainTypes.Ethereum>>;

package/dist/swappers/zrx/utils/helpers/helpers.d.ts

@@ -1,11 +1,11 @@
 import { ChainAdapter } from '@shapeshiftoss/chain-adapters';
 import { HDWallet } from '@shapeshiftoss/hdwallet-core';
-import { Asset, ChainTypes, Quote, SwapperType } from '@shapeshiftoss/types';
+import { Asset, ChainTypes, Quote } from '@shapeshiftoss/types';
 import BigNumber from 'bignumber.js';
 import Web3 from 'web3';
 import { AbiItem } from 'web3-utils';
 export declare type GetAllowanceRequiredArgs = {
-    quote: Quote<ChainTypes, SwapperType>;
+    quote: Quote<ChainTypes>;
     web3: Web3;
     erc20AllowanceAbi: AbiItem[];
 };
@@ -17,7 +17,7 @@ export declare type GetERC20AllowanceArgs = {
     spenderAddress: string;
 };
 declare type GrantAllowanceArgs = {
-    quote: Quote<ChainTypes, SwapperType>;
+    quote: Quote<ChainTypes>;
     wallet: HDWallet;
     adapter: ChainAdapter<ChainTypes.Ethereum>;
     erc20Abi: AbiItem[];

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

@@ -4,6 +4,8 @@ exports.FOX = exports.WETH = exports.BTC = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
 const types_1 = require("@shapeshiftoss/types");
 exports.BTC = {
+    assetId: 'bip122:000000000019d6689c085ae165831e93/slip44:0',
+    chainId: 'bip122:000000000019d6689c085ae165831e93',
     caip19: 'bip122:000000000019d6689c085ae165831e93/slip44:0',
     caip2: 'bip122:000000000019d6689c085ae165831e93',
     name: 'bitcoin',
@@ -24,6 +26,8 @@ exports.BTC = {
     symbol: 'BTC'
 };
 exports.WETH = {
+    assetId: 'eip155:1/erc20:0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+    chainId: 'eip155:1',
     caip19: 'eip155:1/erc20:0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
     caip2: 'eip155:1',
     name: 'WETH',
@@ -45,6 +49,8 @@ exports.WETH = {
     symbol: 'WETH'
 };
 exports.FOX = {
+    assetId: 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d',
+    chainId: 'eip155:1',
     caip19: 'eip155:1/erc20:0xc770eefad204b5180df6a14ee197d99d808ee52d',
     caip2: 'eip155:1',
     name: 'FOX',

package/dist/swappers/zrx/utils/test-data/setupZrxDeps.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="jest" />
 import { ChainAdapterManager } from '@shapeshiftoss/chain-adapters';
 import Web3 from 'web3';
 export declare const chainAdapterMockFuncs: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "2.2.2",
+  "version": "3.0.1",
   "description": "TODO: description",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",
@@ -13,11 +13,13 @@
     "access": "public"
   },
   "scripts": {
-    "build": "yarn clean && tsc --project tsconfig.build.json",
+    "build": "yarn clean && yarn compile",
     "dev": "tsc --watch",
-    "clean": "rm -rf dist",
+    "clean": "rm -rf dist && rm -rf tsconfig.build.tsbuildinfo",
+    "compile": "tsc -p tsconfig.build.json",
+    "prepare": "yarn build",
     "test": "jest test",
-    "type-check": "tsc --project ./tsconfig.json --noEmit",
+    "type-check": "tsc --project ./tsconfig.build.json --noEmit",
     "swapcli": "yarn build && node ./dist/swappercli.js"
   },
   "dependencies": {
@@ -39,7 +41,7 @@
     "@shapeshiftoss/caip": "^2.0.0",
     "@shapeshiftoss/chain-adapters": "^2.0.0",
     "@shapeshiftoss/hdwallet-core": "^1.20.0",
-    "@shapeshiftoss/types": "^2.1.0",
+    "@shapeshiftoss/types": "^3.0.0",
     "@types/readline-sync": "^1.4.4",
     "readline-sync": "^1.4.10",
     "web3-utils": "^1.5.2"