@shapeshiftoss/swapper 5.10.0 → 5.11.0

package/dist/api.d.ts

@@ -33,9 +33,14 @@ declare type ChainSpecificQuoteFeeData<T1> = ChainSpecific<T1, {
         approvalFee?: string;
         totalFee?: string;
     };
+    'bip122:000000000019d6689c085ae165831e93': {
+        byteCount: string;
+        satsPerByte: string;
+    };
 }>;
 export declare type QuoteFeeData<T1 extends SupportedChainIds> = {
     fee: string;
+    tradeFee: string;
 } & ChainSpecificQuoteFeeData<T1>;
 export declare type ByPairInput = {
     sellAssetId: AssetId;
@@ -62,8 +67,6 @@ export declare type BuildTradeInput = CommonTradeInput & {
     wallet: HDWallet;
 };
 interface TradeBase<C extends SupportedChainIds> {
-    success: boolean;
-    statusReason: string;
     buyAmount: string;
     sellAmount: string;
     feeData: QuoteFeeData<C>;

package/dist/swappercli.js

@@ -106,10 +106,6 @@ const main = async () => {
         return;
     }
     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') {

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

@@ -3,6 +3,7 @@ import { Asset, SupportedChainIds } from '@shapeshiftoss/types';
 import { ApprovalNeededOutput, BuyAssetBySellIdInput, Swapper, SwapperType, Trade, TradeQuote, TradeResult, TradeTxs } from '../../api';
 import { ThorchainSwapperDeps } from './types';
 export declare class ThorchainSwapper implements Swapper {
+    private swapSupportedChainIds;
     private supportedAssetIds;
     deps: ThorchainSwapperDeps;
     constructor(deps: ThorchainSwapperDeps);

package/dist/swappers/thorchain/ThorchainSwapper.js

@@ -7,6 +7,10 @@ const getUsdRate_1 = require("./utils/getUsdRate/getUsdRate");
 const thorService_1 = require("./utils/thorService");
 class ThorchainSwapper {
     constructor(deps) {
+        this.swapSupportedChainIds = {
+            'eip155:1': true,
+            'bip122:000000000019d6689c085ae165831e93': true
+        };
         this.supportedAssetIds = [];
         this.deps = deps;
     }
@@ -15,7 +19,7 @@ class ThorchainSwapper {
             const { data: responseData } = await thorService_1.thorService.get(`${this.deps.midgardUrl}/pools`);
             const supportedAssetIds = responseData.reduce((acc, midgardPool) => {
                 const assetId = caip_1.adapters.poolAssetIdToAssetId(midgardPool.asset);
-                if (!assetId)
+                if (!assetId || !this.swapSupportedChainIds[(0, caip_1.fromAssetId)(assetId).chainId])
                     return acc;
                 acc.push(assetId);
                 return acc;

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

@@ -1,5 +1,5 @@
 import { ChainAdapterManager } from '@shapeshiftoss/chain-adapters';
-export declare type MidgardResponse = {
+export declare type PoolResponse = {
     asset: string;
     assetDepth: string;
     assetPrice: string;

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

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

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

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.estimateTradeFee = void 0;
+const caip_1 = require("@shapeshiftoss/caip");
+const api_1 = require("../../../../api");
+const bignumber_1 = require("../../../zrx/utils/bignumber");
+const thorService_1 = require("../thorService");
+const gweiGasPrecision = 9;
+// https://docs.thorchain.org/how-it-works/fees#outbound-fee
+// estimatedTradeFee = `3 * estimatedFeeOutboundFee`
+// eth txs from thorchain use approx 38383 gas
+const ethEstimate = (gasRate) => (0, bignumber_1.bnOrZero)(gasRate).times(38383).times(3).times((0, bignumber_1.bn)(10).exponentiatedBy(gweiGasPrecision)).toString();
+// erc20 txs from thorchain use approx 70996 gas
+const erc20Estimate = (gasRate) => (0, bignumber_1.bnOrZero)(gasRate).times(70996).times(3).times((0, bignumber_1.bn)(10).exponentiatedBy(gweiGasPrecision)).toString();
+// BTC utxo transactions from thorchain are approx 303 bytes long
+const btcEstimate = (gasRate) => (0, bignumber_1.bnOrZero)(gasRate).times(303).times(3).toString();
+const estimateTradeFee = async (deps, buyAssetId) => {
+    const thorId = caip_1.adapters.assetIdToPoolAssetId({ assetId: buyAssetId });
+    if (!thorId)
+        throw new api_1.SwapError('[estimateTradeFee] - undefined thorId for given buyAssetId', {
+            code: api_1.SwapErrorTypes.VALIDATION_FAILED,
+            details: { buyAssetId }
+        });
+    const thorPoolChainId = thorId.slice(0, thorId.indexOf('.'));
+    const { data: inboundAddresses } = await thorService_1.thorService.get(`${deps.midgardUrl}/thorchain/inbound_addresses`);
+    const inboundInfo = inboundAddresses.find((inbound) => inbound.chain === thorPoolChainId);
+    if (!inboundInfo)
+        throw new api_1.SwapError('[estimateTradeFee] - unable to locate inbound pool info', {
+            code: api_1.SwapErrorTypes.VALIDATION_FAILED,
+            details: { thorPoolChainId }
+        });
+    const gasRate = inboundInfo.gas_rate;
+    const { chainId, assetNamespace } = (0, caip_1.fromAssetId)(buyAssetId);
+    switch (chainId) {
+        case 'bip122:000000000019d6689c085ae165831e93':
+            return btcEstimate(gasRate);
+        case 'eip155:1':
+            switch (assetNamespace) {
+                case 'slip44':
+                    return ethEstimate(gasRate);
+                case 'erc20':
+                    return erc20Estimate(gasRate);
+                default:
+                    throw new api_1.SwapError('[estimateTradeFee] - unsupported asset namespace', {
+                        code: api_1.SwapErrorTypes.VALIDATION_FAILED,
+                        details: { assetNamespace }
+                    });
+            }
+        default:
+            throw new api_1.SwapError('[estimateTradeFee] - unsupported chain id', {
+                code: api_1.SwapErrorTypes.VALIDATION_FAILED,
+                details: { chainId }
+            });
+    }
+};
+exports.estimateTradeFee = estimateTradeFee;

package/dist/swappers/thorchain/utils/test-data/midgardResponse.d.ts

@@ -1,5 +1,6 @@
-import { MidgardResponse } from '../../types';
-export declare const btcMidgardPool: MidgardResponse;
-export declare const ethMidgardPool: MidgardResponse;
-export declare const foxMidgardPool: MidgardResponse;
-export declare const midgardResponse: MidgardResponse[];
+import { InboundResponse, PoolResponse } from '../../types';
+export declare const btcMidgardPool: PoolResponse;
+export declare const ethMidgardPool: PoolResponse;
+export declare const foxMidgardPool: PoolResponse;
+export declare const mockInboundAdresses: InboundResponse[];
+export declare const poolResponse: PoolResponse[];

package/dist/swappers/thorchain/utils/test-data/midgardResponse.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.midgardResponse = exports.foxMidgardPool = exports.ethMidgardPool = exports.btcMidgardPool = void 0;
+exports.poolResponse = exports.mockInboundAdresses = exports.foxMidgardPool = exports.ethMidgardPool = exports.btcMidgardPool = void 0;
 exports.btcMidgardPool = {
     asset: 'BTC.BTC',
     assetDepth: '91027798705',
@@ -43,4 +43,56 @@ exports.foxMidgardPool = {
     units: '10568061707512',
     volume24h: '251596933033'
 };
-exports.midgardResponse = [exports.btcMidgardPool, exports.ethMidgardPool, exports.foxMidgardPool];
+exports.mockInboundAdresses = [
+    {
+        chain: 'BCH',
+        pub_key: 'thorpub1addwnpepqfyppkehky2hn2gy26y8jqyj9fz0rnvau2r7yueawzvc662w0x9s7n4ypra',
+        address: 'qp5a6rn8zmamgmsyspqsl0p6ktk4hrheggdjdvntv0',
+        halted: false,
+        gas_rate: '3'
+    },
+    {
+        chain: 'BNB',
+        pub_key: 'thorpub1addwnpepqfyppkehky2hn2gy26y8jqyj9fz0rnvau2r7yueawzvc662w0x9s7n4ypra',
+        address: 'bnb1d8wsuecklw6xupyqgy8mcw4ja4dca72z7nvqzw',
+        halted: false,
+        gas_rate: '11250'
+    },
+    {
+        chain: 'BTC',
+        pub_key: 'thorpub1addwnpepqfyppkehky2hn2gy26y8jqyj9fz0rnvau2r7yueawzvc662w0x9s7n4ypra',
+        address: 'bc1qd8wsuecklw6xupyqgy8mcw4ja4dca72z2dd88d',
+        halted: false,
+        gas_rate: '18'
+    },
+    {
+        chain: 'DOGE',
+        pub_key: 'thorpub1addwnpepqfyppkehky2hn2gy26y8jqyj9fz0rnvau2r7yueawzvc662w0x9s7n4ypra',
+        address: 'DEnrJfAjC4KMsLsGtoTGSmYaFZLPunWw9q',
+        halted: false,
+        gas_rate: '550384'
+    },
+    {
+        chain: 'ETH',
+        pub_key: 'thorpub1addwnpepqfyppkehky2hn2gy26y8jqyj9fz0rnvau2r7yueawzvc662w0x9s7n4ypra',
+        address: '0x78e4e10dcacb0a8261eb3d5e57ffb98ae8d4dff1',
+        router: '0x3624525075b88B24ecc29CE226b0CEc1fFcB6976',
+        halted: false,
+        gas_rate: '280'
+    },
+    {
+        chain: 'LTC',
+        pub_key: 'thorpub1addwnpepqfyppkehky2hn2gy26y8jqyj9fz0rnvau2r7yueawzvc662w0x9s7n4ypra',
+        address: 'ltc1qd8wsuecklw6xupyqgy8mcw4ja4dca72zw3hrla',
+        halted: false,
+        gas_rate: '60'
+    },
+    {
+        chain: 'TERRA',
+        pub_key: 'thorpub1addwnpepqfyppkehky2hn2gy26y8jqyj9fz0rnvau2r7yueawzvc662w0x9s7n4ypra',
+        address: 'terra1d8wsuecklw6xupyqgy8mcw4ja4dca72z6nfvpq',
+        halted: true,
+        gas_rate: '182523800'
+    }
+];
+exports.poolResponse = [exports.btcMidgardPool, exports.ethMidgardPool, exports.foxMidgardPool];

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

@@ -1,4 +1,3 @@
-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>;
+export declare function ZrxApprovalNeeded({ adapterManager, web3 }: ZrxSwapperDeps, { quote, wallet }: ApprovalNeededInput<'eip155:1'>): Promise<ApprovalNeededOutput>;

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

@@ -16,8 +16,8 @@ export declare class ZrxSwapper implements Swapper {
     buildTrade(args: BuildTradeInput): Promise<ZrxTrade<SupportedChainIds>>;
     getTradeQuote(input: GetTradeQuoteInput): Promise<TradeQuote<SupportedChainIds>>;
     getUsdRate(input: Asset): Promise<string>;
-    executeTrade(args: ExecuteTradeInput<SupportedChainIds>): Promise<TradeResult>;
-    approvalNeeded(args: ApprovalNeededInput<SupportedChainIds>): Promise<ApprovalNeededOutput>;
+    executeTrade(args: ExecuteTradeInput<'eip155:1'>): Promise<TradeResult>;
+    approvalNeeded(args: ApprovalNeededInput<'eip155:1'>): Promise<ApprovalNeededOutput>;
     approveInfinite(args: ApproveInfiniteInput<SupportedChainIds>): Promise<string>;
     filterBuyAssetsBySellAssetId(args: BuyAssetBySellIdInput): AssetId[];
     filterAssetIdsBySellable(assetIds?: AssetId[]): AssetId[];

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

@@ -46,8 +46,6 @@ async function getZrxTradeQuote(input) {
         const estimatedGas = (0, bignumber_1.bnOrZero)(data.estimatedGas).times(1.5);
         const rate = useSellAmount ? data.price : (0, bignumber_1.bn)(1).div(data.price).toString();
         return {
-            success: true,
-            statusReason: '',
             rate,
             minimum,
             maximum,
@@ -58,7 +56,8 @@ async function getZrxTradeQuote(input) {
                     gasPrice: data.gasPrice,
                     approvalFee: sellAssetErc20Address &&
                         (0, bignumber_1.bnOrZero)(constants_1.APPROVAL_GAS_LIMIT).multipliedBy((0, bignumber_1.bnOrZero)(data.gasPrice)).toString()
-                }
+                },
+                tradeFee: '0'
             },
             sellAmount: data.sellAmount,
             buyAmount: data.buyAmount,

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

@@ -3,7 +3,7 @@ import { TradeQuote } from '../../../../api';
 import { ZrxQuoteResponse } from '../../types';
 export declare const setupQuote: () => {
     quoteInput: import("../../../../api").CommonTradeInput;
-    tradeQuote: TradeQuote<"eip155:1" | "bip122:000000000019d6689c085ae165831e93" | "cosmos:cosmoshub-4" | "cosmos:osmosis-1">;
+    tradeQuote: TradeQuote<"eip155:1">;
     buyAsset: Asset;
     sellAsset: Asset;
 };
@@ -44,11 +44,10 @@ export declare const setupExecuteTrade: () => {
         txData: string;
         depositAddress: string;
         receiveAddress: string;
-        success: boolean;
-        statusReason: string;
         feeData: {
             fee: string;
             chainSpecific: {};
+            tradeFee: string;
         };
         rate: string;
         allowanceContract: string;

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

@@ -6,8 +6,6 @@ const setupQuote = () => {
     const sellAsset = { ...assets_1.FOX };
     const buyAsset = { ...assets_1.WETH };
     const tradeQuote = {
-        success: true,
-        statusReason: '',
         buyAmount: '',
         sellAmount: '1000000000000000000',
         sellAsset,
@@ -16,7 +14,7 @@ const setupQuote = () => {
         sellAssetAccountId: '0',
         minimum: '0',
         maximum: '999999999999',
-        feeData: { fee: '0' },
+        feeData: { fee: '0', tradeFee: '0', chainSpecific: {} },
         rate: '1',
         sources: []
     };
@@ -83,9 +81,7 @@ const setupExecuteTrade = () => {
         txData: '0x0',
         depositAddress: '0x0',
         receiveAddress: '0x0',
-        success: true,
-        statusReason: '',
-        feeData: { fee: '0', chainSpecific: {} },
+        feeData: { fee: '0', chainSpecific: {}, tradeFee: '0' },
         rate: '0',
         allowanceContract: '0x0',
         sources: []

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

@@ -92,8 +92,6 @@ async function zrxBuildTrade({ adapterManager, web3 }, input) {
         const trade = {
             sellAsset,
             buyAsset,
-            success: true,
-            statusReason: '',
             sellAssetAccountId,
             receiveAddress,
             rate: data.price,
@@ -103,7 +101,8 @@ async function zrxBuildTrade({ adapterManager, web3 }, input) {
                 chainSpecific: {
                     estimatedGas: estimatedGas.toString(),
                     gasPrice: data.gasPrice
-                }
+                },
+                tradeFee: '0'
             },
             txData: data.data,
             sellAmount: data.sellAmount,
@@ -125,7 +124,8 @@ async function zrxBuildTrade({ adapterManager, web3 }, input) {
                 chainSpecific: {
                     ...(_c = trade.feeData) === null || _c === void 0 ? void 0 : _c.chainSpecific,
                     approvalFee: (0, bignumber_1.bnOrZero)(constants_1.APPROVAL_GAS_LIMIT).multipliedBy((0, bignumber_1.bnOrZero)(data.gasPrice)).toString()
-                }
+                },
+                tradeFee: '0'
             };
         }
         return trade;

package/package.json

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