@shapeshiftoss/swapper 17.6.3 → 17.6.5

package/dist/cjs/swappers/ButterSwap/swapperApi/getTradeRate.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTradeRate = void 0;
+const caip_1 = require("@shapeshiftoss/caip");
+const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
+const utils_1 = require("@shapeshiftoss/utils");
+const monads_1 = require("@sniptt/monads");
+const constants_1 = require("../../../constants");
+const types_1 = require("../../../types");
+const utils_2 = require("../../../utils");
+const constants_2 = require("../utils/constants");
+const xhr_1 = require("../xhr");
+const getTradeRate = async (input, _deps) => {
+    const { sellAsset, buyAsset, affiliateBps, accountNumber, receiveAddress, sellAmountIncludingProtocolFeesCryptoBaseUnit, } = input;
+    if (!(0, chain_adapters_1.isEvmChainId)(sellAsset.chainId) &&
+        sellAsset.chainId !== caip_1.btcChainId &&
+        sellAsset.chainId !== caip_1.solanaChainId) {
+        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
+            message: `Unsupported chain`,
+            code: types_1.TradeQuoteError.UnsupportedChain,
+        }));
+    }
+    // Yes, this is supposed to be supported as per checks above, but currently, Butter doesn't yield any quotes for BTC sells
+    if (sellAsset.assetId === caip_1.btcAssetId) {
+        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
+            message: `BTC sells are currently unsupported`,
+            code: types_1.TradeQuoteError.UnsupportedChain,
+        }));
+    }
+    const amount = (0, utils_1.bn)(sellAmountIncludingProtocolFeesCryptoBaseUnit)
+        .shiftedBy(-sellAsset.precision)
+        .toString();
+    const feeAssetId = (0, utils_1.chainIdToFeeAssetId)(sellAsset.chainId);
+    const slippageTolerancePercentageDecimal = (0, constants_1.getDefaultSlippageDecimalPercentageForSwapper)(types_1.SwapperName.ButterSwap);
+    const slippage = (0, utils_1.convertDecimalPercentageToBasisPoints)(slippageTolerancePercentageDecimal).toString();
+    const result = await (0, xhr_1.getButterRoute)({
+        sellAsset,
+        buyAsset,
+        sellAmountCryptoBaseUnit: amount,
+        slippage,
+        affiliate: (0, constants_2.makeButterSwapAffiliate)(affiliateBps),
+    });
+    if (result.isErr()) {
+        return (0, monads_1.Err)(result.unwrapErr());
+    }
+    const routeResponse = result.unwrap();
+    if (!(0, xhr_1.isRouteSuccess)(routeResponse)) {
+        if (routeResponse.errno === xhr_1.ButterSwapErrorCode.InsufficientAmount) {
+            const minAmountCryptoBaseUnit = (0, utils_1.toBaseUnit)(routeResponse.minAmount, sellAsset.precision);
+            return (0, monads_1.Err)((0, utils_2.createTradeAmountTooSmallErr)({
+                minAmountCryptoBaseUnit,
+                assetId: sellAsset.assetId,
+            }));
+        }
+        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
+            message: `[getTradeRate] ${routeResponse.message}`,
+            code: (0, xhr_1.butterSwapErrorToTradeQuoteError)(routeResponse.errno),
+        }));
+    }
+    const route = routeResponse.data[0];
+    if (!route) {
+        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
+            message: '[getTradeRate] No route found',
+            code: types_1.TradeQuoteError.NoRouteFound,
+        }));
+    }
+    // Use destination receive amount as a priority if present and defined
+    // It won't for same-chain swaps, so we fall back to the source chain receive amount (i.e source chain *is* the destination chain)
+    const outputAmount = route.dstChain?.totalAmountOut ?? route.srcChain.totalAmountOut;
+    // TODO: affiliate fees not yet here, gut feel is that Butter won't do the swap output - fees logic for us here
+    // Sanity check me when affiliates are implemented, and do the math ourselves if needed
+    const buyAmountAfterFeesCryptoBaseUnit = (0, utils_1.toBaseUnit)(outputAmount, buyAsset.precision);
+    const rate = (0, utils_2.getInputOutputRate)({
+        sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
+        buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
+        sellAsset,
+        buyAsset,
+    });
+    const feeAsset = _deps.assetsById[feeAssetId];
+    if (!feeAsset) {
+        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
+            message: `[getTradeRate] Fee asset not found for chainId ${sellAsset.chainId}`,
+            code: types_1.TradeQuoteError.UnsupportedChain,
+        }));
+    }
+    // Map gasFee.amount to networkFeeCryptoBaseUnit using fee asset precision
+    const networkFeeCryptoBaseUnit = (0, utils_1.bnOrZero)(route.gasFee?.amount).gt(0)
+        ? (0, utils_1.toBaseUnit)(route.gasFee.amount, feeAsset.precision)
+        : '0';
+    // Always a single step
+    const step = {
+        rate,
+        buyAmountBeforeFeesCryptoBaseUnit: (0, utils_1.toBaseUnit)(outputAmount, buyAsset.precision),
+        buyAmountAfterFeesCryptoBaseUnit,
+        sellAmountIncludingProtocolFeesCryptoBaseUnit,
+        feeData: {
+            networkFeeCryptoBaseUnit,
+            protocolFees: undefined,
+        },
+        source: types_1.SwapperName.ButterSwap,
+        buyAsset,
+        sellAsset,
+        accountNumber,
+        allowanceContract: route.contract ?? '0x0',
+        estimatedExecutionTimeMs: route.timeEstimated * 1000,
+    };
+    const tradeRate = {
+        id: route.hash,
+        rate,
+        swapperName: types_1.SwapperName.ButterSwap,
+        receiveAddress,
+        affiliateBps,
+        slippageTolerancePercentageDecimal,
+        quoteOrRate: 'rate',
+        steps: [step],
+    };
+    return (0, monads_1.Ok)([tradeRate]);
+};
+exports.getTradeRate = getTradeRate;

package/dist/cjs/swappers/ButterSwap/swapperApi/getTradeRate.test.d.ts

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

package/dist/cjs/swappers/ButterSwap/swapperApi/getTradeRate.test.js

@@ -0,0 +1,95 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_1 = require("@shapeshiftoss/types");
+const utils_1 = require("@shapeshiftoss/utils");
+const monads_1 = require("@sniptt/monads");
+const vitest_1 = require("vitest");
+const assets_1 = require("../../utils/test-data/assets");
+const eth_btc_json_1 = __importDefault(require("../test-data/eth-btc.json"));
+const routeQuote_1 = require("../test-data/routeQuote");
+const butterSwapService_1 = require("../utils/butterSwapService");
+const getTradeRate_1 = require("./getTradeRate");
+vitest_1.vi.mock('../utils/butterSwapService', () => ({
+    butterService: {
+        get: vitest_1.vi.fn(),
+    },
+}));
+(0, vitest_1.describe)('getTradeRate', () => {
+    (0, vitest_1.it)('should return a trade rate', async () => {
+        const deps = {
+            assetsById: { [assets_1.ETH.assetId]: assets_1.ETH },
+            assertGetChainAdapter: () => vitest_1.vi.fn(),
+            assertGetEvmChainAdapter: () => vitest_1.vi.fn(),
+            assertGetUtxoChainAdapter: () => vitest_1.vi.fn(),
+            assertGetCosmosSdkChainAdapter: () => vitest_1.vi.fn(),
+            assertGetSolanaChainAdapter: () => vitest_1.vi.fn(),
+            config: {
+                VITE_BUTTERSWAP_CLIENT_ID: 'test',
+            },
+            mixPanel: undefined,
+            fetchIsSmartContractAddressQuery: vitest_1.vi.fn(),
+        };
+        const input = {
+            sellAsset: assets_1.WETH,
+            buyAsset: assets_1.USDC_MAINNET,
+            sellAmountIncludingProtocolFeesCryptoBaseUnit: (0, utils_1.bn)(1).shiftedBy(18).toString(),
+            affiliateBps: '0',
+            allowMultiHop: true,
+            receiveAddress: '0x123',
+            accountNumber: undefined,
+            quoteOrRate: 'rate',
+            chainId: types_1.KnownChainIds.EthereumMainnet,
+            supportsEIP1559: false, // TODO - upstream type bug? this is a literal false in the type def
+        };
+        vitest_1.vi.mocked(butterSwapService_1.butterService.get).mockResolvedValue((0, monads_1.Ok)({ data: routeQuote_1.ROUTE_QUOTE }));
+        const result = await (0, getTradeRate_1.getTradeRate)(input, deps);
+        (0, vitest_1.expect)(result.isOk()).toBe(true);
+        const tradeRate = result.unwrap();
+        (0, vitest_1.expect)(tradeRate[0].rate).toBe('2296.409699');
+    });
+    (0, vitest_1.it)('should return a correct trade rate and steps for a multi-hop ETH->BTC route', async () => {
+        const deps = {
+            assetsById: { [assets_1.ETH.assetId]: assets_1.ETH, [assets_1.BTC.assetId]: assets_1.BTC },
+            assertGetChainAdapter: () => vitest_1.vi.fn(),
+            assertGetEvmChainAdapter: () => vitest_1.vi.fn(),
+            assertGetUtxoChainAdapter: () => vitest_1.vi.fn(),
+            assertGetCosmosSdkChainAdapter: () => vitest_1.vi.fn(),
+            assertGetSolanaChainAdapter: () => vitest_1.vi.fn(),
+            config: {
+                VITE_BUTTERSWAP_CLIENT_ID: 'test',
+            },
+            mixPanel: undefined,
+            fetchIsSmartContractAddressQuery: vitest_1.vi.fn(),
+        };
+        const input = {
+            sellAsset: assets_1.ETH,
+            buyAsset: assets_1.BTC,
+            sellAmountIncludingProtocolFeesCryptoBaseUnit: (0, utils_1.bn)(1).shiftedBy(18).toString(),
+            affiliateBps: '0',
+            allowMultiHop: true,
+            receiveAddress: '0x123',
+            accountNumber: undefined,
+            quoteOrRate: 'rate',
+            chainId: types_1.KnownChainIds.EthereumMainnet,
+            supportsEIP1559: false,
+        };
+        // Use the first route in the eth-btc.json data
+        vitest_1.vi.mocked(butterSwapService_1.butterService.get).mockResolvedValue((0, monads_1.Ok)({ data: eth_btc_json_1.default }));
+        const result = await (0, getTradeRate_1.getTradeRate)(input, deps);
+        (0, vitest_1.expect)(result.isOk()).toBe(true);
+        const tradeRate = result.unwrap()[0];
+        (0, vitest_1.expect)(tradeRate).toBeDefined();
+        // The expected rate is dstChain.totalAmountOut / srcChain.totalAmountIn
+        (0, vitest_1.expect)(tradeRate.rate).toBe('0.02284418');
+        // Should have a single step
+        (0, vitest_1.expect)(tradeRate.steps).toBeDefined();
+        (0, vitest_1.expect)(tradeRate.steps.length).toBe(1);
+        // The step should have the correct rate
+        (0, vitest_1.expect)(tradeRate.steps[0]?.rate).toBe('0.02284418');
+        // The buyAmountAfterFeesCryptoBaseUnit of the step should match the output in base units
+        (0, vitest_1.expect)(tradeRate.steps[0]?.buyAmountAfterFeesCryptoBaseUnit).toBe('2284418'); // 0.02284418 BTC in base units
+    });
+});