@shapeshiftoss/swapper 17.8.0 → 18.1.0

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

@@ -1,132 +1,34 @@
-import { btcChainId, solanaChainId, tronChainId } from '@shapeshiftoss/caip';
-import { isEvmChainId } from '@shapeshiftoss/chain-adapters';
-import { BigAmount, bnOrZero, chainIdToFeeAssetId, convertDecimalPercentageToBasisPoints, } from '@shapeshiftoss/utils';
 import { Err, Ok } from '@sniptt/monads';
 import { getDefaultSlippageDecimalPercentageForSwapper } from '../../../constants.js';
-import { SwapperName, TradeQuoteError } from '../../../types.js';
-import { createTradeAmountTooSmallErr, getInputOutputRate, makeSwapErrorRight, } from '../../../utils.js';
-import { buildAffiliateFee } from '../../utils/affiliateFee.js';
-import { makeButterSwapAffiliate } from '../utils/constants.js';
-import { ButterSwapErrorCode, butterSwapErrorToTradeQuoteError, getButterRoute, isRouteSuccess, } from '../xhr.js';
-export const getTradeRate = async (input, _deps) => {
-    const { sellAsset, buyAsset, affiliateBps, accountNumber, receiveAddress, sellAmountIncludingProtocolFeesCryptoBaseUnit, } = input;
-    if (!isEvmChainId(sellAsset.chainId) &&
-        sellAsset.chainId !== btcChainId &&
-        sellAsset.chainId !== solanaChainId &&
-        sellAsset.chainId !== tronChainId) {
-        return Err(makeSwapErrorRight({
-            message: `Unsupported chain`,
-            code: TradeQuoteError.UnsupportedChain,
-        }));
-    }
-    const amount = BigAmount.fromBaseUnit({
-        value: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-        precision: sellAsset.precision,
-    }).toPrecision();
-    const feeAssetId = chainIdToFeeAssetId(sellAsset.chainId);
+import { SwapperName } from '../../../types.js';
+import { getButterSwapStepData } from '../utils/getButterSwapStepData.js';
+import { getButterSwapTradeContext } from '../utils/getButterSwapTradeContext.js';
+export const getTradeRate = async (input, deps) => {
+    const { accountNumber, receiveAddress } = input;
     const slippageTolerancePercentageDecimal = getDefaultSlippageDecimalPercentageForSwapper(SwapperName.ButterSwap);
-    const slippage = convertDecimalPercentageToBasisPoints(slippageTolerancePercentageDecimal).toString();
-    const result = await getButterRoute({
-        sellAsset,
-        buyAsset,
-        sellAmountCryptoPrecision: amount,
-        slippage,
-        affiliate: makeButterSwapAffiliate(affiliateBps),
-    });
-    if (result.isErr()) {
-        return Err(result.unwrapErr());
-    }
-    const routeResponse = result.unwrap();
-    if (!isRouteSuccess(routeResponse)) {
-        if (routeResponse.errno === ButterSwapErrorCode.InsufficientAmount) {
-            const minAmountCryptoBaseUnit = BigAmount.fromPrecision({
-                value: routeResponse.minAmount,
-                precision: sellAsset.precision,
-            }).toBaseUnit();
-            return Err(createTradeAmountTooSmallErr({
-                minAmountCryptoBaseUnit,
-                assetId: sellAsset.assetId,
-            }));
-        }
-        return Err(makeSwapErrorRight({
-            message: `[getTradeRate] ${routeResponse.message}`,
-            code: butterSwapErrorToTradeQuoteError(routeResponse.errno),
-        }));
-    }
-    const route = routeResponse.data[0];
-    if (!route) {
-        return Err(makeSwapErrorRight({
-            message: '[getTradeRate] No route found',
-            code: 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 = BigAmount.fromPrecision({
-        value: outputAmount,
-        precision: buyAsset.precision,
-    }).toBaseUnit();
-    const rate = getInputOutputRate({
-        sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-        buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-        sellAsset,
-        buyAsset,
+    const maybeContext = await getButterSwapTradeContext({
+        input,
+        deps,
+        slippageTolerancePercentageDecimal,
     });
-    const feeAsset = _deps.assetsById[feeAssetId];
-    if (!feeAsset) {
-        return Err(makeSwapErrorRight({
-            message: `[getTradeRate] Fee asset not found for chainId ${sellAsset.chainId}`,
-            code: TradeQuoteError.UnsupportedChain,
-        }));
-    }
-    // Map gasFee.amount to networkFeeCryptoBaseUnit using fee asset precision
-    const networkFeeCryptoBaseUnit = bnOrZero(route.gasFee?.amount).gt(0)
-        ? BigAmount.fromPrecision({
-            value: route.gasFee.amount,
-            precision: feeAsset.precision,
-        }).toBaseUnit()
-        : '0';
-    // Always a single step
-    const step = {
-        rate,
-        buyAmountBeforeFeesCryptoBaseUnit: BigAmount.fromPrecision({
-            value: outputAmount,
-            precision: buyAsset.precision,
-        }).toBaseUnit(),
-        buyAmountAfterFeesCryptoBaseUnit,
-        sellAmountIncludingProtocolFeesCryptoBaseUnit,
-        feeData: {
-            networkFeeCryptoBaseUnit,
-            protocolFees: undefined,
-        },
-        source: SwapperName.ButterSwap,
-        buyAsset,
-        sellAsset,
-        accountNumber,
-        allowanceContract: route.contract ?? '0x0',
-        estimatedExecutionTimeMs: route.timeEstimated * 1000,
-        affiliateFee: buildAffiliateFee({
-            strategy: 'buy_asset',
-            affiliateBps,
-            sellAsset,
-            buyAsset,
-            sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-            buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-            isEstimate: true,
-        }),
-    };
+    if (maybeContext.isErr())
+        return Err(maybeContext.unwrapErr());
+    const { tradeCommon, stepCommon, protocolFees, stepDataArgs } = maybeContext.unwrap();
+    const maybeStepData = await getButterSwapStepData({ ...stepDataArgs, type: 'rate', input });
+    if (maybeStepData.isErr())
+        return Err(maybeStepData.unwrapErr());
+    const { networkFeeCryptoBaseUnit } = maybeStepData.unwrap();
     const tradeRate = {
-        id: route.hash,
-        rate,
-        swapperName: SwapperName.ButterSwap,
-        receiveAddress,
-        affiliateBps,
-        slippageTolerancePercentageDecimal,
+        ...tradeCommon,
         quoteOrRate: 'rate',
-        steps: [step],
+        receiveAddress,
+        steps: [
+            {
+                ...stepCommon,
+                accountNumber,
+                feeData: { networkFeeCryptoBaseUnit, protocolFees },
+            },
+        ],
     };
     return Ok([tradeRate]);
 };

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

@@ -2,7 +2,7 @@ import { KnownChainIds } from '@shapeshiftoss/types';
 import { bn } from '@shapeshiftoss/utils';
 import { Ok } from '@sniptt/monads';
 import { describe, expect, it, vi } from 'vitest';
-import { BTC, ETH, USDC_MAINNET, WETH } from '../../utils/test-data/assets.js';
+import { BTC, ETH, USDC_MAINNET, WETH } from '../../../utils/test-data/assets.js';
 import ethBtcRoute from '../test-data/eth-btc.json';
 import { ROUTE_QUOTE } from '../test-data/routeQuote.js';
 import { butterService } from '../utils/butterSwapService.js';
@@ -12,12 +12,21 @@ vi.mock('../utils/butterSwapService', () => ({
         get: vi.fn(),
     },
 }));
+const mockEvmChainAdapter = {
+    getGasFeeData: () => Promise.resolve({
+        average: {
+            gasPrice: '1000000000',
+            maxFeePerGas: '2000000000',
+            maxPriorityFeePerGas: '1000000000',
+        },
+    }),
+};
 describe('getTradeRate', () => {
     it('should return a trade rate', async () => {
         const deps = {
             assetsById: { [ETH.assetId]: ETH },
             assertGetChainAdapter: () => vi.fn(),
-            assertGetEvmChainAdapter: () => vi.fn(),
+            assertGetEvmChainAdapter: () => mockEvmChainAdapter,
             assertGetUtxoChainAdapter: () => vi.fn(),
             assertGetCosmosSdkChainAdapter: () => vi.fn(),
             assertGetSolanaChainAdapter: () => vi.fn(),
@@ -54,7 +63,7 @@ describe('getTradeRate', () => {
         const deps = {
             assetsById: { [ETH.assetId]: ETH, [BTC.assetId]: BTC },
             assertGetChainAdapter: () => vi.fn(),
-            assertGetEvmChainAdapter: () => vi.fn(),
+            assertGetEvmChainAdapter: () => mockEvmChainAdapter,
             assertGetUtxoChainAdapter: () => vi.fn(),
             assertGetCosmosSdkChainAdapter: () => vi.fn(),
             assertGetSolanaChainAdapter: () => vi.fn(),

package/dist/esm/swappers/ButterSwap/types.d.ts

@@ -1,4 +1,18 @@
 import type { Hex } from 'viem';
+import type { GetEvmTradeQuoteInput, GetEvmTradeRateInput, GetSolanaTradeQuoteInput, GetSolanaTradeRateInput, GetTronTradeQuoteInput, GetTronTradeRateInput, GetUtxoTradeQuoteInput, GetUtxoTradeRateInput } from '../../types.js';
+export type ButterSwapTradeQuoteInput = GetEvmTradeQuoteInput | GetUtxoTradeQuoteInput | GetSolanaTradeQuoteInput | GetTronTradeQuoteInput;
+export type ButterSwapTradeRateInput = GetEvmTradeRateInput | GetUtxoTradeRateInput | GetSolanaTradeRateInput | GetTronTradeRateInput;
+export type ButterSwapTransactionMetadata = {
+    to: string;
+    data: string;
+    value: Hex;
+    method?: string;
+    args?: {
+        type: string;
+        value: unknown;
+    }[];
+    memo?: string;
+};
 export type ErrorType = {
     errno: number;
     message: string;

package/dist/esm/swappers/ButterSwap/utils/butterSwapHistoryService.js

@@ -1,12 +1,9 @@
-import { createCache, makeSwapperAxiosServiceMonadic } from '../../../utils.js';
+import { createCache, makeSwapperAxiosServiceMonadic } from '../../../utils/index.js';
 const maxAge = 5 * 1000; // 5 seconds
 const cachedUrls = [];
 const axiosConfig = {
     timeout: 10000,
-    headers: {
-        Accept: 'application/json',
-        'Content-Type': 'application/json',
-    },
+    headers: { Accept: 'application/json' },
     baseURL: 'https://bs-app-api.chainservice.io',
 };
 const butterHistoryServiceBase = createCache(maxAge, cachedUrls, axiosConfig);

package/dist/esm/swappers/ButterSwap/utils/butterSwapService.js

@@ -1,12 +1,9 @@
-import { createCache, makeSwapperAxiosServiceMonadic } from '../../../utils.js';
+import { createCache, makeSwapperAxiosServiceMonadic } from '../../../utils/index.js';
 const maxAge = 5 * 1000; // 5 seconds
 const cachedUrls = [];
 const axiosConfig = {
     timeout: 10000,
-    headers: {
-        Accept: 'application/json',
-        'Content-Type': 'application/json',
-    },
+    headers: { Accept: 'application/json' },
     baseURL: 'https://bs-router-v3.chainservice.io',
 };
 const butterServiceBase = createCache(maxAge, cachedUrls, axiosConfig);

package/dist/esm/swappers/ButterSwap/utils/constants.js

@@ -1,6 +1,8 @@
+import { bnOrZero } from '@shapeshiftoss/utils';
 const BUTTERSWAP_AFFILIATE = 'shapeshift';
+// Format is `<nickname>[:rate]`, where rate is in basis points (e.g. `shapeshift:60` = 0.6%).
 export const makeButterSwapAffiliate = (affiliateBps) => {
-    if (!BUTTERSWAP_AFFILIATE)
+    if (bnOrZero(affiliateBps).lte(0))
         return undefined;
     return `${BUTTERSWAP_AFFILIATE}:${affiliateBps}`;
 };

package/dist/esm/swappers/ButterSwap/utils/getButterSwapStepData.d.ts

@@ -0,0 +1,32 @@
+import type { Asset } from '@shapeshiftoss/types';
+import type { Result } from '@sniptt/monads';
+import type { StepDataArgs, SwapErrorRight, TxBuildData } from '../../../types.js';
+import type { SolanaComputeBudgetOptions } from '../../../utils/solana/index.js';
+import type { BuildTxSuccessItem, ButterSwapTransactionMetadata, RouteSuccessItem } from '../types.js';
+export declare const BUTTERSWAP_SOLANA_COMPUTE_BUDGET: SolanaComputeBudgetOptions;
+type BaseArgs = {
+    route: RouteSuccessItem;
+    feeAsset: Asset;
+    sellAmountCryptoBaseUnit: string;
+    spenderAddress: string;
+};
+export type GetButterSwapStepDataArgs = StepDataArgs<BaseArgs, {
+    buildTx?: undefined;
+}, {
+    buildTx: BuildTxSuccessItem;
+}>;
+type ButterSwapRateStepData = {
+    networkFeeCryptoBaseUnit: string;
+};
+type ButterSwapQuoteStepData = {
+    transactionData?: TxBuildData;
+    butterSwapTransactionMetadata?: ButterSwapTransactionMetadata;
+    networkFeeCryptoBaseUnit: string;
+};
+export declare function getButterSwapStepData(args: Extract<GetButterSwapStepDataArgs, {
+    type: 'rate';
+}>): Promise<Result<ButterSwapRateStepData, SwapErrorRight>>;
+export declare function getButterSwapStepData(args: Extract<GetButterSwapStepDataArgs, {
+    type: 'quote';
+}>): Promise<Result<ButterSwapQuoteStepData, SwapErrorRight>>;
+export {};

package/dist/esm/swappers/ButterSwap/utils/getButterSwapStepData.js

@@ -0,0 +1,195 @@
+import { CHAIN_NAMESPACE, fromChainId } from '@shapeshiftoss/caip';
+import { bnOrZero } from '@shapeshiftoss/utils';
+import { Err, Ok } from '@sniptt/monads';
+import { AddressLookupTableAccount, PublicKey, TransactionMessage, VersionedTransaction, } from '@solana/web3.js';
+import { fromHex } from 'viem';
+import { TradeQuoteError } from '../../../types.js';
+import { makeNetworkFeeEstimationFailedErr, makeSwapErrorRight, makeTradeStepBuildFailedErr, } from '../../../utils/index.js';
+import { getEvmNetworkFeeCryptoBaseUnit } from '../../../utils/evm/index.js';
+import { getSolanaNetworkFeeCryptoBaseUnit, omitComputeBudgetInstructions, withComputeUnitLimit, } from '../../../utils/solana/index.js';
+import { getUtxoNetworkFeeCryptoBaseUnit, UTXO_PLACEHOLDER_ADDRESS } from '../../../utils/utxo/index.js';
+import { getProviderNetworkFeeCryptoBaseUnit } from './helpers.js';
+// Jupiter swap legs can consume more units than simulated when pool state moves between
+// simulation and landing (CLMM tick crossings), 1.4 matches Jupiter's dynamicComputeUnitLimit margin
+export const BUTTERSWAP_SOLANA_COMPUTE_BUDGET = {
+    marginMultiplier: 1.4,
+};
+export async function getButterSwapStepData(args) {
+    const { input, route, sellAsset, feeAsset, sellAmountCryptoBaseUnit, spenderAddress, deps } = args;
+    const { chainNamespace, chainReference } = fromChainId(sellAsset.chainId);
+    switch (chainNamespace) {
+        case CHAIN_NAMESPACE.Evm: {
+            const adapter = deps.assertGetEvmChainAdapter(sellAsset.chainId);
+            const supportsEIP1559 = 'supportsEIP1559' in input ? input.supportsEIP1559 : false;
+            if (args.type === 'rate') {
+                const networkFeeCryptoBaseUnit = await (async () => {
+                    try {
+                        return await getEvmNetworkFeeCryptoBaseUnit({
+                            adapter,
+                            supportsEIP1559,
+                            gasLimit: bnOrZero(route.gasEstimatedTarget).toFixed(),
+                        });
+                    }
+                    catch {
+                        return getProviderNetworkFeeCryptoBaseUnit({ route, feeAsset });
+                    }
+                })();
+                const stepData = { networkFeeCryptoBaseUnit };
+                return Ok(stepData);
+            }
+            const { buildTx, from } = args;
+            const transactionData = {
+                type: 'evm',
+                chainId: Number(chainReference),
+                to: buildTx.to,
+                data: buildTx.data,
+                value: fromHex(buildTx.value, 'bigint').toString(),
+            };
+            try {
+                const networkFeeCryptoBaseUnit = await getEvmNetworkFeeCryptoBaseUnit({
+                    adapter,
+                    supportsEIP1559,
+                    transactionData,
+                    from,
+                    // Butter's gasEstimatedTarget lands short on chain (observed 24% under actual, causing
+                    // in-flight OOG/SWAP_FAIL reverts) - estimate ourselves instead
+                    stateOverride: {
+                        sellAsset,
+                        sellAmountCryptoBaseUnit,
+                        spenderAddress,
+                    },
+                });
+                const stepData = { transactionData, networkFeeCryptoBaseUnit };
+                return Ok(stepData);
+            }
+            catch (error) {
+                return Err(makeNetworkFeeEstimationFailedErr('getButterSwapStepData', error));
+            }
+        }
+        case CHAIN_NAMESPACE.Utxo: {
+            const adapter = deps.assertGetUtxoChainAdapter(sellAsset.chainId);
+            const pubkey = 'xpub' in input ? input.xpub : undefined;
+            if (args.type === 'rate') {
+                const networkFeeCryptoBaseUnit = await (async () => {
+                    try {
+                        const { networkFeeCryptoBaseUnit } = await getUtxoNetworkFeeCryptoBaseUnit({
+                            adapter,
+                            pubkey,
+                            to: input.sendAddress ?? UTXO_PLACEHOLDER_ADDRESS,
+                            value: sellAmountCryptoBaseUnit,
+                        });
+                        return networkFeeCryptoBaseUnit;
+                    }
+                    catch {
+                        return getProviderNetworkFeeCryptoBaseUnit({ route, feeAsset });
+                    }
+                })();
+                const stepData = { networkFeeCryptoBaseUnit };
+                return Ok(stepData);
+            }
+            const { buildTx } = args;
+            // opReturnData routes the bridge for BTC deposits
+            if (!buildTx.memo) {
+                return Err(makeSwapErrorRight({
+                    message: '[getButterSwapStepData] Missing memo (opReturnData)',
+                    code: TradeQuoteError.InvalidResponse,
+                }));
+            }
+            const transactionData = {
+                type: 'utxo',
+                to: buildTx.to,
+                opReturnData: buildTx.memo,
+                value: sellAmountCryptoBaseUnit,
+            };
+            try {
+                const { networkFeeCryptoBaseUnit } = await getUtxoNetworkFeeCryptoBaseUnit({
+                    adapter,
+                    pubkey,
+                    to: transactionData.to,
+                    value: transactionData.value,
+                    opReturnData: transactionData.opReturnData,
+                });
+                const stepData = { transactionData, networkFeeCryptoBaseUnit };
+                return Ok(stepData);
+            }
+            catch (error) {
+                return Err(makeNetworkFeeEstimationFailedErr('getButterSwapStepData', error));
+            }
+        }
+        case CHAIN_NAMESPACE.Solana: {
+            const adapter = deps.assertGetSolanaChainAdapter(sellAsset.chainId);
+            if (args.type === 'rate') {
+                // Swap instructions don't exist for rates - best effort with provider fee fallback
+                const networkFeeCryptoBaseUnit = getProviderNetworkFeeCryptoBaseUnit({ route, feeAsset });
+                const stepData = { networkFeeCryptoBaseUnit };
+                return Ok(stepData);
+            }
+            const { buildTx, from } = args;
+            try {
+                const txData = buildTx.data.startsWith('0x') ? buildTx.data.slice(2) : buildTx.data;
+                const txBytes = Buffer.from(txData, 'hex');
+                const versionedTransaction = VersionedTransaction.deserialize(new Uint8Array(txBytes));
+                const addressLookupTableAddresses = versionedTransaction.message.addressTableLookups.map(lookup => lookup.accountKey.toString());
+                const addressLookupTableAccountsInfos = await adapter.getAddressLookupTableAccounts(addressLookupTableAddresses);
+                const addressLookupTableAccounts = addressLookupTableAccountsInfos.map(info => new AddressLookupTableAccount({
+                    key: new PublicKey(info.key),
+                    state: AddressLookupTableAccount.deserialize(new Uint8Array(info.data)),
+                }));
+                const instructions = omitComputeBudgetInstructions(TransactionMessage.decompile(versionedTransaction.message, { addressLookupTableAccounts })
+                    .instructions);
+                try {
+                    const { networkFeeCryptoBaseUnit, feeData, includeComputeBudget } = await getSolanaNetworkFeeCryptoBaseUnit({
+                        adapter,
+                        from,
+                        instructions,
+                        addressLookupTableAddresses,
+                    });
+                    const transactionData = {
+                        type: 'solana_instructions',
+                        instructions: withComputeUnitLimit({
+                            instructions,
+                            computeUnits: feeData.chainSpecific.computeUnits,
+                            includeComputeBudget,
+                            computeBudget: BUTTERSWAP_SOLANA_COMPUTE_BUDGET,
+                        }),
+                        addressLookupTableAddresses,
+                    };
+                    const stepData = { transactionData, networkFeeCryptoBaseUnit };
+                    return Ok(stepData);
+                }
+                catch (error) {
+                    return Err(makeNetworkFeeEstimationFailedErr('getButterSwapStepData', error));
+                }
+            }
+            catch (error) {
+                return Err(makeTradeStepBuildFailedErr('getButterSwapStepData', error));
+            }
+        }
+        // Not yet migrated to a TxBuildData variant - exec still builds from legacy metadata
+        case CHAIN_NAMESPACE.Tron: {
+            const networkFeeCryptoBaseUnit = getProviderNetworkFeeCryptoBaseUnit({ route, feeAsset });
+            if (args.type === 'rate') {
+                const stepData = { networkFeeCryptoBaseUnit };
+                return Ok(stepData);
+            }
+            const { buildTx } = args;
+            const stepData = {
+                butterSwapTransactionMetadata: {
+                    to: buildTx.to,
+                    data: buildTx.data,
+                    value: buildTx.value,
+                    method: buildTx.method,
+                    args: buildTx.args,
+                    memo: buildTx.memo,
+                },
+                networkFeeCryptoBaseUnit,
+            };
+            return Ok(stepData);
+        }
+        default:
+            return Err(makeSwapErrorRight({
+                message: `[getButterSwapStepData] unsupported chain namespace: ${chainNamespace}`,
+                code: TradeQuoteError.UnsupportedChain,
+            }));
+    }
+}