@shapeshiftoss/swapper 6.0.1 → 6.2.1

package/dist/api.d.ts

@@ -58,11 +58,11 @@ export declare type CommonTradeInput = {
     buyAsset: Asset;
     sellAmount: string;
     sendMax: boolean;
-    sellAssetAccountId: string;
+    sellAssetAccountNumber: number;
 };
 export declare type GetTradeQuoteInput = CommonTradeInput;
 export declare type BuildTradeInput = CommonTradeInput & {
-    buyAssetAccountId: string;
+    buyAssetAccountNumber: number;
     slippage?: string;
     wallet: HDWallet;
 };
@@ -74,7 +74,7 @@ interface TradeBase<C extends SupportedChainIds> {
     sources: Array<SwapSource>;
     buyAsset: Asset;
     sellAsset: Asset;
-    sellAssetAccountId: string;
+    sellAssetAccountNumber: number;
 }
 export interface TradeQuote<C extends SupportedChainIds> extends TradeBase<C> {
     allowanceContract: string;
@@ -155,7 +155,8 @@ export declare enum SwapErrorTypes {
     UNSUPPORTED_CHAIN = "UNSUPPORTED_CHAIN",
     VALIDATION_FAILED = "VALIDATION_FAILED",
     MAKE_MEMO_FAILED = "MAKE_MEMO_FAILED",
-    PRICE_RATIO_FAILED = "PRICE_RATIO_FAILED"
+    PRICE_RATIO_FAILED = "PRICE_RATIO_FAILED",
+    POOL_NOT_FOUND = "POOL_NOT_FOUND"
 }
 export interface Swapper {
     /** perform any necessary async initialization */

package/dist/api.js

@@ -31,4 +31,5 @@ var SwapErrorTypes;
     SwapErrorTypes["VALIDATION_FAILED"] = "VALIDATION_FAILED";
     SwapErrorTypes["MAKE_MEMO_FAILED"] = "MAKE_MEMO_FAILED";
     SwapErrorTypes["PRICE_RATIO_FAILED"] = "PRICE_RATIO_FAILED";
+    SwapErrorTypes["POOL_NOT_FOUND"] = "POOL_NOT_FOUND";
 })(SwapErrorTypes = exports.SwapErrorTypes || (exports.SwapErrorTypes = {}));

package/dist/manager/SwapperManager.d.ts

@@ -30,6 +30,6 @@ export declare class SwapperManager {
      * @returns {SwapperType}
      */
     getSwappersByPair(pair: ByPairInput): Swapper[];
-    getSupportedBuyAssetIdsFromSellId(args: BuyAssetBySellIdInput): string[];
-    getSupportedSellableAssetIds(args: SupportedSellAssetsInput): string[];
+    getSupportedBuyAssetIdsFromSellId(args: BuyAssetBySellIdInput): import("@shapeshiftoss/caip").AssetId[];
+    getSupportedSellableAssetIds(args: SupportedSellAssetsInput): import("@shapeshiftoss/caip").AssetId[];
 }

package/dist/swappercli.js

@@ -95,7 +95,7 @@ const main = async () => {
             sellAsset,
             buyAsset,
             sellAmount: sellAmountBase,
-            sellAssetAccountId: '0',
+            sellAssetAccountNumber: 0,
             sendMax: false
         });
     }
@@ -115,8 +115,8 @@ const main = async () => {
             sendMax: false,
             sellAmount: sellAmountBase,
             sellAsset,
-            sellAssetAccountId: '0',
-            buyAssetAccountId: '0'
+            sellAssetAccountNumber: 0,
+            buyAssetAccountNumber: 0
         });
         const txid = await swapper.executeTrade({ trade, wallet });
         console.info('broadcast tx with id: ', txid);

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

@@ -1,6 +1,6 @@
 import { AssetId } from '@shapeshiftoss/caip';
 import { Asset, SupportedChainIds } from '@shapeshiftoss/types';
-import { ApprovalNeededOutput, BuyAssetBySellIdInput, Swapper, SwapperType, Trade, TradeQuote, TradeResult, TradeTxs } from '../../api';
+import { ApprovalNeededOutput, BuyAssetBySellIdInput, ExecuteTradeInput, Swapper, SwapperType, Trade, TradeQuote, TradeResult, TradeTxs } from '../../api';
 import { ThorchainSwapperDeps } from './types';
 export declare class ThorchainSwapper implements Swapper {
     private swapSupportedChainIds;
@@ -16,6 +16,6 @@ export declare class ThorchainSwapper implements Swapper {
     filterAssetIdsBySellable(): AssetId[];
     buildTrade(): Promise<Trade<SupportedChainIds>>;
     getTradeQuote(): Promise<TradeQuote<SupportedChainIds>>;
-    executeTrade(): Promise<TradeResult>;
+    executeTrade(args: ExecuteTradeInput<SupportedChainIds>): Promise<TradeResult>;
     getTradeTxs(): Promise<TradeTxs>;
 }

package/dist/swappers/thorchain/ThorchainSwapper.js

@@ -58,8 +58,21 @@ class ThorchainSwapper {
     async getTradeQuote() {
         throw new Error('ThorchainSwapper: getTradeQuote unimplemented');
     }
-    async executeTrade() {
-        throw new Error('ThorchainSwapper: executeTrade unimplemented');
+    async executeTrade(args) {
+        const { trade, wallet } = args;
+        const adapter = await this.deps.adapterManager.byChainId(trade.sellAsset.chainId);
+        if (trade.sellAsset.chainId === 'eip155:1') {
+            const thorTradeEth = trade;
+            const signedTx = await adapter.signTransaction({ txToSign: thorTradeEth.txData, wallet });
+            const txid = await adapter.broadcastTransaction(signedTx);
+            return { tradeId: txid };
+        }
+        else {
+            throw new api_1.SwapError('[executeTrade]: unsupported trade', {
+                code: api_1.SwapErrorTypes.SIGN_AND_BROADCAST_FAILED,
+                fn: 'executeTrade'
+            });
+        }
     }
     async getTradeTxs() {
         throw new Error('ThorchainSwapper: executeTrade unimplemented');

package/dist/swappers/thorchain/utils/getTradeRate/getTradeRate.d.ts

@@ -0,0 +1,4 @@
+import { AssetId } from '@shapeshiftoss/caip';
+import { Asset } from '@shapeshiftoss/types';
+import { ThorchainSwapperDeps } from '../../types';
+export declare const getTradeRate: (sellAsset: Asset, buyAssetId: AssetId, sellAmount: string, deps: ThorchainSwapperDeps) => Promise<string>;

package/dist/swappers/thorchain/utils/getTradeRate/getTradeRate.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTradeRate = void 0;
+const caip_1 = require("@shapeshiftoss/caip");
+const api_1 = require("../../../../api");
+const bignumber_1 = require("../../../utils/bignumber");
+const makeTradeTx_1 = require("../ethereum/makeTradeTx");
+const thorService_1 = require("../thorService");
+const THOR_PRECISION = 8;
+const getSwapOutput = (inputAmount, poolData, toRune) => {
+    const x = inputAmount;
+    const X = toRune ? poolData.assetBalance : poolData.runeBalance;
+    const Y = toRune ? poolData.runeBalance : poolData.assetBalance;
+    const numerator = x.times(X).times(Y);
+    const denominator = x.plus(X).pow(2);
+    return numerator.div(denominator);
+};
+const getDoubleSwapOutput = (input, inputPool, outputPool) => {
+    const runeToOutput = getSwapOutput(input, inputPool, true);
+    return getSwapOutput(runeToOutput, outputPool, false);
+};
+// https://docs.thorchain.org/how-it-works/prices
+// TODO this does not support swaps between native "RUNE"
+// Rune swaps use a different calculation because its 1 hop between pools instead of 2
+const getTradeRate = async (sellAsset, buyAssetId, sellAmount, deps) => {
+    const buyPoolId = caip_1.adapters.assetIdToPoolAssetId({ assetId: buyAssetId });
+    const sellPoolId = caip_1.adapters.assetIdToPoolAssetId({ assetId: sellAsset.assetId });
+    if (!buyPoolId || !sellPoolId)
+        throw new api_1.SwapError(`[getPriceRatio]: No thorchain pool found`, {
+            code: api_1.SwapErrorTypes.POOL_NOT_FOUND,
+            fn: 'getPriceRatio',
+            details: { buyPoolId, sellPoolId }
+        });
+    const { data: responseData } = await thorService_1.thorService.get(`${deps.midgardUrl}/pools`);
+    const buyPool = responseData.find((response) => response.asset === buyPoolId);
+    const sellPool = responseData.find((response) => response.asset === sellPoolId);
+    if (!buyPool || !sellPool)
+        throw new api_1.SwapError(`[getPriceRatio]: no pools found for`, {
+            code: api_1.SwapErrorTypes.POOL_NOT_FOUND,
+            fn: 'getPriceRatio',
+            details: { buyPoolId, sellPoolId }
+        });
+    // All thorchain pool amounts are base 8 regardless of token precision
+    const sellBaseAmount = (0, bignumber_1.bn)((0, makeTradeTx_1.toBaseUnit)((0, makeTradeTx_1.fromBaseUnit)(sellAmount, sellAsset.precision), THOR_PRECISION));
+    const sellAssetPoolData = {
+        assetBalance: (0, bignumber_1.bn)(sellPool.assetDepth),
+        runeBalance: (0, bignumber_1.bn)(sellPool.runeDepth)
+    };
+    const buyAssetPoolData = {
+        assetBalance: (0, bignumber_1.bn)(buyPool.assetDepth),
+        runeBalance: (0, bignumber_1.bn)(buyPool.runeDepth)
+    };
+    const outputAmountBase8 = getDoubleSwapOutput(sellBaseAmount, sellAssetPoolData, buyAssetPoolData);
+    const outputAmount = (0, makeTradeTx_1.fromBaseUnit)(outputAmountBase8, THOR_PRECISION);
+    return (0, bignumber_1.bn)(outputAmount).div((0, makeTradeTx_1.fromBaseUnit)(sellAmount, sellAsset.precision)).toString();
+};
+exports.getTradeRate = getTradeRate;

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

@@ -4,3 +4,4 @@ export declare const WETH: Asset;
 export declare const FOX: Asset;
 export declare const WBTC: Asset;
 export declare const ETH: Asset;
+export declare const UNSUPPORTED: Asset;

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ETH = exports.WBTC = exports.FOX = exports.WETH = exports.BTC = void 0;
+exports.UNSUPPORTED = exports.ETH = exports.WBTC = exports.FOX = exports.WETH = exports.BTC = void 0;
 const types_1 = require("@shapeshiftoss/types");
 exports.BTC = {
     assetId: 'bip122:000000000019d6689c085ae165831e93/slip44:0',
@@ -72,3 +72,17 @@ exports.ETH = {
     explorerTxLink: 'https://etherscan.io/tx/',
     explorerAddressLink: 'https://etherscan.io/address/'
 };
+exports.UNSUPPORTED = {
+    assetId: 'eip155:1/slip44:420',
+    chainId: 'eip155:1',
+    chain: types_1.ChainTypes.Ethereum,
+    network: types_1.NetworkTypes.MAINNET,
+    symbol: 'ETH',
+    name: 'Ethereum',
+    precision: 18,
+    color: '#FFFFFF',
+    icon: 'https://assets.coincap.io/assets/icons/eth@2x.png',
+    explorer: 'https://etherscan.io',
+    explorerTxLink: 'https://etherscan.io/tx/',
+    explorerAddressLink: 'https://etherscan.io/address/'
+};

package/dist/swappers/zrx/ZrxApprovalNeeded/ZrxApprovalNeeded.js

@@ -21,7 +21,7 @@ async function ZrxApprovalNeeded({ adapterManager, web3 }, { quote, wallet }) {
         if (sellAsset.assetId === (0, caip_1.getFeeAssetIdFromAssetId)(sellAsset.assetId)) {
             return { approvalNeeded: false };
         }
-        const accountNumber = (0, bignumber_1.bnOrZero)(quote.sellAssetAccountId).toNumber();
+        const accountNumber = quote.sellAssetAccountNumber;
         const adapter = await adapterManager.byChainId(sellAsset.chainId);
         const bip44Params = adapter.buildBIP44Params({ accountNumber });
         const receiveAddress = await adapter.getAddress({ wallet, bip44Params });

package/dist/swappers/zrx/getZrxTradeQuote/getZrxTradeQuote.js

@@ -11,7 +11,7 @@ const zrxService_1 = require("../utils/zrxService");
 async function getZrxTradeQuote(input) {
     var _a;
     try {
-        const { sellAsset, buyAsset, sellAmount, sellAssetAccountId } = input;
+        const { sellAsset, buyAsset, sellAmount, sellAssetAccountNumber } = input;
         if (buyAsset.chainId !== 'eip155:1' || sellAsset.chainId !== 'eip155:1') {
             throw new api_1.SwapError('[getZrxTradeQuote] - Both assets need to be on the Ethereum chain to use Zrx', {
                 code: api_1.SwapErrorTypes.UNSUPPORTED_PAIR,
@@ -65,7 +65,7 @@ async function getZrxTradeQuote(input) {
             allowanceContract: data.allowanceTarget,
             buyAsset,
             sellAsset,
-            sellAssetAccountId
+            sellAssetAccountNumber
         };
     }
     catch (e) {

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

@@ -99,7 +99,7 @@ const grantAllowance = async ({ quote, wallet, adapterManager, erc20Abi, web3 })
         const approveTx = erc20Contract.methods
             .approve(quote.allowanceContract, quote.sellAmount)
             .encodeABI();
-        const accountNumber = (0, bignumber_1.bnOrZero)(quote.sellAssetAccountId).toNumber();
+        const accountNumber = quote.sellAssetAccountNumber;
         const bip44Params = adapter.buildBIP44Params({ accountNumber });
         const { txToSign } = await adapter.buildSendTransaction({
             wallet,

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

@@ -21,8 +21,8 @@ export declare const setupBuildTrade: () => {
         buyAmount: string;
         buyAsset: Asset;
         sendMax: boolean;
-        sellAssetAccountId: string;
-        buyAssetAccountId: string;
+        sellAssetAccountNumber: number;
+        buyAssetAccountNumber: number;
         sellAsset: Asset;
     };
     buyAsset: Asset;
@@ -40,7 +40,7 @@ export declare const setupExecuteTrade: () => {
         buyAsset: Asset;
         sellAsset: Asset;
         sendMax: boolean;
-        sellAssetAccountId: string;
+        sellAssetAccountNumber: number;
         txData: string;
         depositAddress: string;
         receiveAddress: string;

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

@@ -11,7 +11,7 @@ const setupQuote = () => {
         sellAsset,
         buyAsset,
         allowanceContract: 'allowanceContractAddress',
-        sellAssetAccountId: '0',
+        sellAssetAccountNumber: 0,
         minimum: '0',
         maximum: '999999999999',
         feeData: { fee: '0', tradeFee: '0', chainSpecific: {} },
@@ -22,7 +22,7 @@ const setupQuote = () => {
         sellAmount: '1000000000000000000',
         sellAsset,
         buyAsset,
-        sellAssetAccountId: '0',
+        sellAssetAccountNumber: 0,
         sendMax: false
     };
     return { quoteInput, tradeQuote, buyAsset, sellAsset };
@@ -56,8 +56,8 @@ const setupBuildTrade = () => {
         buyAmount: '',
         buyAsset,
         sendMax: false,
-        sellAssetAccountId: '0',
-        buyAssetAccountId: '0',
+        sellAssetAccountNumber: 0,
+        buyAssetAccountNumber: 0,
         sellAsset
     };
     return { buildTradeInput, buyAsset, sellAsset };
@@ -77,7 +77,7 @@ const setupExecuteTrade = () => {
         buyAsset,
         sellAsset,
         sendMax: false,
-        sellAssetAccountId: '0',
+        sellAssetAccountNumber: 0,
         txData: '0x0',
         depositAddress: '0x0',
         receiveAddress: '0x0',

package/dist/swappers/zrx/zrxBuildTrade/zrxBuildTrade.js

@@ -35,7 +35,7 @@ const helpers_1 = require("../utils/helpers/helpers");
 const zrxService_1 = require("../utils/zrxService");
 async function zrxBuildTrade({ adapterManager, web3 }, input) {
     var _a, _b, _c;
-    const { sellAsset, buyAsset, sellAmount, slippage, sellAssetAccountId, buyAssetAccountId, wallet } = input;
+    const { sellAsset, buyAsset, sellAmount, slippage, sellAssetAccountNumber, buyAssetAccountNumber, wallet } = input;
     try {
         const { assetReference: buyAssetErc20Address, assetNamespace: buyAssetNamespace } = (0, caip_1.fromAssetId)(buyAsset.assetId);
         const { assetReference: sellAssetErc20Address, assetNamespace: sellAssetNamespace } = (0, caip_1.fromAssetId)(sellAsset.assetId);
@@ -48,7 +48,7 @@ async function zrxBuildTrade({ adapterManager, web3 }, input) {
             });
         }
         const adapter = await adapterManager.byChainId(buyAsset.chainId);
-        const bip44Params = adapter.buildBIP44Params({ accountNumber: Number(buyAssetAccountId) });
+        const bip44Params = adapter.buildBIP44Params({ accountNumber: buyAssetAccountNumber });
         const receiveAddress = await adapter.getAddress({ wallet, bip44Params });
         const slippagePercentage = slippage ? (0, bignumber_1.bnOrZero)(slippage).div(100).toString() : constants_1.DEFAULT_SLIPPAGE;
         /**
@@ -92,7 +92,7 @@ async function zrxBuildTrade({ adapterManager, web3 }, input) {
         const trade = {
             sellAsset,
             buyAsset,
-            sellAssetAccountId,
+            sellAssetAccountNumber,
             receiveAddress,
             rate: data.price,
             depositAddress: data.to,

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

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.zrxExecuteTrade = void 0;
 const web3_utils_1 = require("web3-utils");
 const api_1 = require("../../../api");
-const bignumber_1 = require("../../utils/bignumber");
 async function zrxExecuteTrade({ adapterManager }, { trade, wallet }) {
     var _a, _b, _c, _d, _e, _f;
     const zrxTrade = trade;
@@ -13,7 +12,7 @@ async function zrxExecuteTrade({ adapterManager }, { trade, wallet }) {
         const value = sellAsset.assetId === 'eip155:1/slip44:60' ? trade.sellAmount : '0';
         const adapter = await adapterManager.byChainId(sellAsset.chainId);
         const bip44Params = adapter.buildBIP44Params({
-            accountNumber: (0, bignumber_1.bnOrZero)(trade.sellAssetAccountId).toNumber()
+            accountNumber: trade.sellAssetAccountNumber
         });
         const buildTxResponse = await adapter.buildSendTransaction({
             value,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "6.0.1",
+  "version": "6.2.1",
   "description": "TODO: description",
   "repository": "https://github.com/shapeshift/lib",
   "license": "MIT",