@shapeshiftoss/swapper 17.8.0 → 18.1.0

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

@@ -2,80 +2,36 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTradeQuote = 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 web3_js_1 = require("@solana/web3.js");
 const constants_1 = require("../../../constants");
 const types_1 = require("../../../types");
 const utils_2 = require("../../../utils");
-const affiliateFee_1 = require("../../utils/affiliateFee");
-const constants_2 = require("../utils/constants");
+const getButterSwapStepData_1 = require("../utils/getButterSwapStepData");
+const getButterSwapTradeContext_1 = require("../utils/getButterSwapTradeContext");
 const xhr_1 = require("../xhr");
-const getTradeQuote = async (input, _deps) => {
-    const { sellAsset, buyAsset, sellAmountIncludingProtocolFeesCryptoBaseUnit, receiveAddress, sendAddress, slippageTolerancePercentageDecimal, accountNumber, affiliateBps, } = input;
-    if (!(0, chain_adapters_1.isEvmChainId)(sellAsset.chainId) &&
-        sellAsset.chainId !== caip_1.btcChainId &&
-        sellAsset.chainId !== caip_1.solanaChainId &&
-        sellAsset.chainId !== caip_1.tronChainId) {
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-            message: `Unsupported chain`,
-            code: types_1.TradeQuoteError.UnsupportedChain,
-        }));
-    }
-    // TODO: Debug why same-chain Tron swaps revert (swapAndCall method works on EVM but 0 successful on Tron)
-    if (!sendAddress) {
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-            message: '[getTradeQuote] sendAddress is required for ButterSwap',
-            code: types_1.TradeQuoteError.UnknownError,
-        }));
-    }
+// TODO: Debug why same-chain Tron swaps revert (swapAndCall method works on EVM but 0 successful on Tron)
+const getTradeQuote = async (input, deps) => {
+    const { sellAsset, receiveAddress, accountNumber, slippageTolerancePercentageDecimal } = input;
+    const maybeAddresses = (0, utils_2.assertQuoteAddresses)(input);
+    if (maybeAddresses.isErr())
+        return (0, monads_1.Err)(maybeAddresses.unwrapErr());
+    const { sendAddress } = maybeAddresses.unwrap();
     const slippageDecimal = slippageTolerancePercentageDecimal ??
         (0, constants_1.getDefaultSlippageDecimalPercentageForSwapper)(types_1.SwapperName.ButterSwap);
-    const slippage = (0, utils_1.convertDecimalPercentageToBasisPoints)(slippageDecimal).toString();
-    // Call ButterSwap /route API
-    const routeResult = await (0, xhr_1.getButterRoute)({
-        sellAsset,
-        buyAsset,
-        sellAmountCryptoPrecision: utils_1.BigAmount.fromBaseUnit({
-            value: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-            precision: sellAsset.precision,
-        }).toPrecision(),
-        slippage,
-        affiliate: (0, constants_2.makeButterSwapAffiliate)(affiliateBps),
+    const maybeContext = await (0, getButterSwapTradeContext_1.getButterSwapTradeContext)({
+        input,
+        deps,
+        slippageTolerancePercentageDecimal: slippageDecimal,
     });
-    if (routeResult.isErr())
-        return (0, monads_1.Err)(routeResult.unwrapErr());
-    const routeResponse = routeResult.unwrap();
-    if (!(0, xhr_1.isRouteSuccess)(routeResponse)) {
-        if (routeResponse.errno === xhr_1.ButterSwapErrorCode.InsufficientAmount) {
-            const minAmountCryptoBaseUnit = utils_1.BigAmount.fromPrecision({
-                value: routeResponse.minAmount,
-                precision: sellAsset.precision,
-            }).toBaseUnit();
-            return (0, monads_1.Err)((0, utils_2.createTradeAmountTooSmallErr)({
-                minAmountCryptoBaseUnit,
-                assetId: sellAsset.assetId,
-            }));
-        }
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-            message: `[getTradeQuote] ${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: '[getTradeQuote] No route found',
-            code: types_1.TradeQuoteError.NoRouteFound,
-        }));
-    }
-    // Call ButterSwap /swap API to get calldata and contract info
+    if (maybeContext.isErr())
+        return (0, monads_1.Err)(maybeContext.unwrapErr());
+    const { tradeCommon, stepCommon, protocolFees, route, stepDataArgs } = maybeContext.unwrap();
     const buildTxResult = await (0, xhr_1.fetchTxData)({
         hash: route.hash,
-        slippage,
+        slippage: (0, utils_1.convertDecimalPercentageToBasisPoints)(slippageDecimal).toString(),
         from: sendAddress,
-        receiver: receiveAddress, // receiver (destination chain address)
+        receiver: receiveAddress,
     });
     if (buildTxResult.isErr())
         return (0, monads_1.Err)(buildTxResult.unwrapErr());
@@ -93,127 +49,31 @@ const getTradeQuote = async (input, _deps) => {
             code: types_1.TradeQuoteError.QueryFailed,
         }));
     }
-    // Fee asset for network fees
-    const feeAsset = _deps.assetsById[(0, utils_1.chainIdToFeeAssetId)(sellAsset.chainId)];
-    if (!feeAsset) {
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-            message: `[getTradeQuote] Fee asset not found for chainId ${sellAsset.chainId}`,
-            code: types_1.TradeQuoteError.UnsupportedChain,
-        }));
-    }
-    // Map gasFee.amount to networkFeeCryptoBaseUnit using fee asset precision
-    const networkFeeCryptoBaseUnit = utils_1.BigAmount.fromPrecision({
-        value: (0, utils_1.bnOrZero)(route.gasFee?.amount),
-        precision: feeAsset.precision,
-    }).toBaseUnit();
-    // 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 = utils_1.BigAmount.fromPrecision({
-        value: outputAmount,
-        precision: buyAsset.precision,
-    }).toBaseUnit();
-    const rate = (0, utils_2.getInputOutputRate)({
-        sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-        buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-        sellAsset,
-        buyAsset,
+    const maybeStepData = await (0, getButterSwapStepData_1.getButterSwapStepData)({
+        ...stepDataArgs,
+        type: 'quote',
+        input,
+        buildTx,
+        from: sendAddress,
     });
-    // Extract Solana transaction metadata from versioned transaction, to allow building an unsigned Tx later on at getUnsignedSolanaTransaction time
-    const maybeSolanaTransactionMetadata = await (async () => {
-        if (sellAsset.chainId !== caip_1.solanaChainId)
-            return (0, monads_1.Ok)(undefined);
-        const txData = buildTx.data.startsWith('0x') ? buildTx.data.slice(2) : buildTx.data;
-        const txBytes = Buffer.from(txData, 'hex');
-        // Solana transactions are limited to 1232 bytes. If Butter returns a larger tx,
-        // we need to split it into a Jito bundle (2 txs with tip in the last one).
-        const SOLANA_TX_SIZE_LIMIT = 1232;
-        const isOversized = txBytes.length > SOLANA_TX_SIZE_LIMIT;
-        const versionedTransaction = web3_js_1.VersionedTransaction.deserialize(new Uint8Array(txBytes));
-        const adapter = _deps.assertGetSolanaChainAdapter(sellAsset.chainId);
-        try {
-            const addressLookupTableAccountKeys = versionedTransaction.message.addressTableLookups.map(lookup => lookup.accountKey.toString());
-            const addressLookupTableAccountsInfos = await adapter.getAddressLookupTableAccounts(addressLookupTableAccountKeys);
-            const addressLookupTableAccounts = addressLookupTableAccountsInfos.map(info => new web3_js_1.AddressLookupTableAccount({
-                key: new web3_js_1.PublicKey(info.key),
-                state: web3_js_1.AddressLookupTableAccount.deserialize(new Uint8Array(info.data)),
-            }));
-            // Decompile VersionedMessage with address lookup tables to get instructions
-            // This is required to properly resolve all account addresses in the transaction
-            // Without lookup tables, the transaction would fail during execution
-            // Reference: https://dev.jup.ag/docs/old/additional-topics/composing-with-versioned-transaction
-            const instructions = web3_js_1.TransactionMessage.decompile(versionedTransaction.message, {
-                addressLookupTableAccounts,
-            }).instructions;
-            return (0, monads_1.Ok)({
-                instructions,
-                addressLookupTableAddresses: addressLookupTableAccountKeys,
-                isOversized,
-            });
-        }
-        catch (error) {
-            return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-                message: `[getTradeQuote] Error decompiling VersionedMessage: ${error}`,
-                code: types_1.TradeQuoteError.UnknownError,
-            }));
-        }
-    })();
-    if (sellAsset.chainId === caip_1.solanaChainId && maybeSolanaTransactionMetadata?.isErr()) {
-        return (0, monads_1.Err)(maybeSolanaTransactionMetadata.unwrapErr());
-    }
-    const solanaTransactionMetadata = maybeSolanaTransactionMetadata?.unwrap();
-    const step = {
-        buyAmountBeforeFeesCryptoBaseUnit: utils_1.BigAmount.fromPrecision({
-            value: outputAmount,
-            precision: buyAsset.precision,
-        }).toBaseUnit(),
-        buyAmountAfterFeesCryptoBaseUnit,
-        sellAmountIncludingProtocolFeesCryptoBaseUnit,
-        feeData: {
-            networkFeeCryptoBaseUnit,
-            protocolFees: undefined,
-        },
-        rate,
-        source: types_1.SwapperName.ButterSwap,
-        buyAsset,
-        sellAsset,
-        accountNumber,
-        allowanceContract: sellAsset.chainId === caip_1.tronChainId ? buildTx.to : route.contract ?? '0x0',
-        estimatedExecutionTimeMs: route.timeEstimated * 1000,
-        butterSwapTransactionMetadata: {
-            to: buildTx.to,
-            data: buildTx.data,
-            value: buildTx.value,
-            gasLimit: (0, utils_1.bnOrZero)(route.gasEstimatedTarget).toFixed(),
-            method: buildTx.method,
-            args: buildTx.args,
-            memo: buildTx.memo,
-        },
-        ...(solanaTransactionMetadata && {
-            solanaTransactionMetadata,
-        }),
-        affiliateFee: (0, affiliateFee_1.buildAffiliateFee)({
-            strategy: 'buy_asset',
-            affiliateBps,
-            sellAsset,
-            buyAsset,
-            sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-            buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-            isEstimate: true,
-        }),
-    };
+    if (maybeStepData.isErr())
+        return (0, monads_1.Err)(maybeStepData.unwrapErr());
+    const { networkFeeCryptoBaseUnit, transactionData, butterSwapTransactionMetadata } = maybeStepData.unwrap();
     const tradeQuote = {
-        id: route.hash,
-        rate,
-        receiveAddress,
-        affiliateBps,
-        isStreaming: false,
+        ...tradeCommon,
         quoteOrRate: 'quote',
-        swapperName: types_1.SwapperName.ButterSwap,
-        slippageTolerancePercentageDecimal: slippageDecimal,
-        steps: [step],
+        receiveAddress,
+        steps: [
+            {
+                ...stepCommon,
+                accountNumber,
+                // Tron exec still builds from legacy metadata whose spender is the buildTx target
+                allowanceContract: sellAsset.chainId === caip_1.tronChainId ? buildTx.to : stepCommon.allowanceContract,
+                transactionData,
+                butterSwapTransactionMetadata,
+                feeData: { networkFeeCryptoBaseUnit, protocolFees },
+            },
+        ],
     };
     return (0, monads_1.Ok)([tradeQuote]);
 };

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

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const types_1 = require("@shapeshiftoss/types");
 const monads_1 = require("@sniptt/monads");
 const vitest_1 = require("vitest");
-const assets_1 = require("../../utils/test-data/assets");
+const assets_1 = require("../../../utils/test-data/assets");
 const routeQuote_1 = require("../test-data/routeQuote");
 const getTradeQuote_1 = require("./getTradeQuote");
 vitest_1.vi.mock('../xhr', () => ({
@@ -23,12 +24,30 @@ vitest_1.vi.mock('../xhr', () => ({
     isRouteSuccess: () => true,
     isBuildTxSuccess: () => true,
 }));
+// The override path reads live chain state - resolve to no override so estimation exercises the
+// mocked adapter
+vitest_1.vi.mock('../../../utils/evm/stateOverride', async (importOriginal) => ({
+    ...(await importOriginal()),
+    getMinimalStateOverride: vitest_1.vi.fn().mockResolvedValue(undefined),
+}));
+const mockEvmChainAdapter = {
+    getGasFeeData: () => Promise.resolve({
+        average: {
+            gasPrice: '1000000000',
+            maxFeePerGas: '2000000000',
+            maxPriorityFeePerGas: '1000000000',
+        },
+    }),
+    getFeeData: () => Promise.resolve({
+        average: { chainSpecific: { gasLimit: '500000', gasPrice: '1000000000' } },
+    }),
+};
 (0, vitest_1.describe)('getTradeQuote', () => {
     (0, vitest_1.it)('should return a trade quote', async () => {
         const deps = {
             assetsById: { [assets_1.ETH.assetId]: assets_1.ETH },
             assertGetChainAdapter: () => vitest_1.vi.fn(),
-            assertGetEvmChainAdapter: () => vitest_1.vi.fn(),
+            assertGetEvmChainAdapter: () => mockEvmChainAdapter,
             assertGetUtxoChainAdapter: () => vitest_1.vi.fn(),
             assertGetCosmosSdkChainAdapter: () => vitest_1.vi.fn(),
             assertGetSolanaChainAdapter: () => vitest_1.vi.fn(),
@@ -53,13 +72,23 @@ vitest_1.vi.mock('../xhr', () => ({
             affiliateBps: '0',
             allowMultiHop: true,
             quoteOrRate: 'quote',
+            chainId: types_1.KnownChainIds.EthereumMainnet,
+            supportsEIP1559: false,
         };
         const result = await (0, getTradeQuote_1.getTradeQuote)(input, deps);
         (0, vitest_1.expect)(result.isOk()).toBe(true);
         const tradeQuote = result.unwrap();
-        // Use the actual returned value for the expected rate
-        (0, vitest_1.expect)(tradeQuote[0].rate).toBe('2296.409699');
-        // 1 WETH in base units
-        (0, vitest_1.expect)(tradeQuote[0].steps[0].sellAmountIncludingProtocolFeesCryptoBaseUnit).toBe('1000000000000000000');
+        // The built swap tx is what distinguishes a quote from a rate - see
+        // getButterSwapStepData.test.ts for the per-namespace build and fee behaviour
+        (0, vitest_1.expect)(tradeQuote[0].steps[0].transactionData).toEqual({
+            type: 'evm',
+            chainId: 1,
+            to: '0xContractAddress',
+            data: '0xCalldata',
+            value: '0',
+            gasLimit: '600000',
+        });
+        // The route contract, since this is not the tron path that spends via the buildTx target
+        (0, vitest_1.expect)(tradeQuote[0].steps[0].allowanceContract).toBe('0xEE030ec6F4307411607E55aCD08e628Ae6655B86');
     });
 });

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

@@ -1,3 +1,4 @@
 import type { Result } from '@sniptt/monads';
-import type { GetTradeRateInput, SwapErrorRight, SwapperDeps, TradeRate } from '../../../types';
-export declare const getTradeRate: (input: GetTradeRateInput, _deps: SwapperDeps) => Promise<Result<TradeRate[], SwapErrorRight>>;
+import type { SwapErrorRight, SwapperDeps, TradeRate } from '../../../types';
+import type { ButterSwapTradeRateInput } from '../types';
+export declare const getTradeRate: (input: ButterSwapTradeRateInput, deps: SwapperDeps) => Promise<Result<TradeRate[], SwapErrorRight>>;

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

@@ -1,135 +1,37 @@
 "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 affiliateFee_1 = require("../../utils/affiliateFee");
-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 &&
-        sellAsset.chainId !== caip_1.tronChainId) {
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-            message: `Unsupported chain`,
-            code: types_1.TradeQuoteError.UnsupportedChain,
-        }));
-    }
-    const amount = utils_1.BigAmount.fromBaseUnit({
-        value: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-        precision: sellAsset.precision,
-    }).toPrecision();
-    const feeAssetId = (0, utils_1.chainIdToFeeAssetId)(sellAsset.chainId);
+const getButterSwapStepData_1 = require("../utils/getButterSwapStepData");
+const getButterSwapTradeContext_1 = require("../utils/getButterSwapTradeContext");
+const getTradeRate = async (input, deps) => {
+    const { accountNumber, receiveAddress } = input;
     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,
-        sellAmountCryptoPrecision: 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 = utils_1.BigAmount.fromPrecision({
-                value: routeResponse.minAmount,
-                precision: sellAsset.precision,
-            }).toBaseUnit();
-            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 = utils_1.BigAmount.fromPrecision({
-        value: outputAmount,
-        precision: buyAsset.precision,
-    }).toBaseUnit();
-    const rate = (0, utils_2.getInputOutputRate)({
-        sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-        buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-        sellAsset,
-        buyAsset,
+    const maybeContext = await (0, getButterSwapTradeContext_1.getButterSwapTradeContext)({
+        input,
+        deps,
+        slippageTolerancePercentageDecimal,
     });
-    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)
-        ? utils_1.BigAmount.fromPrecision({
-            value: route.gasFee.amount,
-            precision: feeAsset.precision,
-        }).toBaseUnit()
-        : '0';
-    // Always a single step
-    const step = {
-        rate,
-        buyAmountBeforeFeesCryptoBaseUnit: utils_1.BigAmount.fromPrecision({
-            value: outputAmount,
-            precision: buyAsset.precision,
-        }).toBaseUnit(),
-        buyAmountAfterFeesCryptoBaseUnit,
-        sellAmountIncludingProtocolFeesCryptoBaseUnit,
-        feeData: {
-            networkFeeCryptoBaseUnit,
-            protocolFees: undefined,
-        },
-        source: types_1.SwapperName.ButterSwap,
-        buyAsset,
-        sellAsset,
-        accountNumber,
-        allowanceContract: route.contract ?? '0x0',
-        estimatedExecutionTimeMs: route.timeEstimated * 1000,
-        affiliateFee: (0, affiliateFee_1.buildAffiliateFee)({
-            strategy: 'buy_asset',
-            affiliateBps,
-            sellAsset,
-            buyAsset,
-            sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-            buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-            isEstimate: true,
-        }),
-    };
+    if (maybeContext.isErr())
+        return (0, monads_1.Err)(maybeContext.unwrapErr());
+    const { tradeCommon, stepCommon, protocolFees, stepDataArgs } = maybeContext.unwrap();
+    const maybeStepData = await (0, getButterSwapStepData_1.getButterSwapStepData)({ ...stepDataArgs, type: 'rate', input });
+    if (maybeStepData.isErr())
+        return (0, monads_1.Err)(maybeStepData.unwrapErr());
+    const { networkFeeCryptoBaseUnit } = maybeStepData.unwrap();
     const tradeRate = {
-        id: route.hash,
-        rate,
-        swapperName: types_1.SwapperName.ButterSwap,
-        receiveAddress,
-        affiliateBps,
-        slippageTolerancePercentageDecimal,
+        ...tradeCommon,
         quoteOrRate: 'rate',
-        steps: [step],
+        receiveAddress,
+        steps: [
+            {
+                ...stepCommon,
+                accountNumber,
+                feeData: { networkFeeCryptoBaseUnit, protocolFees },
+            },
+        ],
     };
     return (0, monads_1.Ok)([tradeRate]);
 };

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

@@ -7,7 +7,7 @@ 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 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");
@@ -17,12 +17,21 @@ vitest_1.vi.mock('../utils/butterSwapService', () => ({
         get: vitest_1.vi.fn(),
     },
 }));
+const mockEvmChainAdapter = {
+    getGasFeeData: () => Promise.resolve({
+        average: {
+            gasPrice: '1000000000',
+            maxFeePerGas: '2000000000',
+            maxPriorityFeePerGas: '1000000000',
+        },
+    }),
+};
 (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(),
+            assertGetEvmChainAdapter: () => mockEvmChainAdapter,
             assertGetUtxoChainAdapter: () => vitest_1.vi.fn(),
             assertGetCosmosSdkChainAdapter: () => vitest_1.vi.fn(),
             assertGetSolanaChainAdapter: () => vitest_1.vi.fn(),
@@ -59,7 +68,7 @@ vitest_1.vi.mock('../utils/butterSwapService', () => ({
         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(),
+            assertGetEvmChainAdapter: () => mockEvmChainAdapter,
             assertGetUtxoChainAdapter: () => vitest_1.vi.fn(),
             assertGetCosmosSdkChainAdapter: () => vitest_1.vi.fn(),
             assertGetSolanaChainAdapter: () => vitest_1.vi.fn(),

package/dist/cjs/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';
+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/cjs/swappers/ButterSwap/utils/butterSwapHistoryService.js

@@ -6,10 +6,7 @@ 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 = (0, utils_1.createCache)(maxAge, cachedUrls, axiosConfig);

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

@@ -6,10 +6,7 @@ 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 = (0, utils_1.createCache)(maxAge, cachedUrls, axiosConfig);

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

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeButterSwapAffiliate = void 0;
+const utils_1 = require("@shapeshiftoss/utils");
 const BUTTERSWAP_AFFILIATE = 'shapeshift';
+// Format is `<nickname>[:rate]`, where rate is in basis points (e.g. `shapeshift:60` = 0.6%).
 const makeButterSwapAffiliate = (affiliateBps) => {
-    if (!BUTTERSWAP_AFFILIATE)
+    if ((0, utils_1.bnOrZero)(affiliateBps).lte(0))
         return undefined;
     return `${BUTTERSWAP_AFFILIATE}:${affiliateBps}`;
 };

package/dist/cjs/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';
+import type { SolanaComputeBudgetOptions } from '../../../utils/solana';
+import type { BuildTxSuccessItem, ButterSwapTransactionMetadata, RouteSuccessItem } from '../types';
+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 {};