@shapeshiftoss/swapper 20.2.0 → 20.4.0

package/dist/cjs/swappers/BobGatewaySwapper/utils/getBobGatewayStepData.test.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const caip_1 = require("@shapeshiftoss/caip");
+const monads_1 = require("@sniptt/monads");
+const vitest_1 = require("vitest");
+const assets_1 = require("../../../utils/test-data/assets");
+const getBobGatewayStepData_1 = require("./getBobGatewayStepData");
+const helpers_1 = require("./helpers");
+vitest_1.vi.mock('./helpers', () => ({ createBobGatewayOrder: vitest_1.vi.fn() }));
+const USDT_TRON = {
+    ...assets_1.ETH,
+    assetId: `${caip_1.tronChainId}/trc20:TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t`,
+    chainId: caip_1.tronChainId,
+};
+const FROM = 'TT2T17KZhoDu47i2E4FWxfG79zdkEWkU9N';
+// BOB returns the AllowanceHolder as 0x-prefixed 41-hex (TAfbit1ENsRmtZbPQfYU3srURpfYuWYS7K)
+const ALLOWANCE_HOLDER_HEX = '0x4107a39ae4c49dee86e892450b20881f32cd5d500d';
+const tronTx = { type: 'tron', to: ALLOWANCE_HOLDER_HEX, data: '0x2213bc0b', value: '0' };
+const tronAdapter = ({ txFee = '45600000', allowance = '0' } = {}) => ({
+    getFeeData: vitest_1.vi.fn().mockResolvedValue({ fast: { txFee } }),
+    httpProvider: {
+        getChainPrices: () => Promise.resolve({ energyPrice: 100, bandwidthPrice: 1000 }),
+        getTrc20Allowance: vitest_1.vi.fn().mockResolvedValue(allowance),
+        getTrc20Balance: vitest_1.vi.fn().mockResolvedValue('100000000'),
+        getContractEnergyShare: vitest_1.vi.fn().mockResolvedValue({
+            callerPercent: 100,
+            originEnergyLimit: 0,
+            originEnergyAvailable: 0,
+        }),
+    },
+});
+const makeDeps = (tron) => ({ config: {}, assertGetTronChainAdapter: () => tron });
+const quote = {};
+(0, vitest_1.describe)('getBobGatewayStepData', () => {
+    (0, vitest_1.describe)('tron', () => {
+        (0, vitest_1.it)('prices a rate from the measured default energy and bandwidth at the gateway share', async () => {
+            const adapter = tronAdapter();
+            const actual = await (0, getBobGatewayStepData_1.getBobGatewayStepData)({
+                type: 'rate',
+                input: {},
+                deps: makeDeps(adapter),
+                quote,
+                sellAsset: USDT_TRON,
+                sellAmountCryptoBaseUnit: '100000000',
+                spenderAddress: 'TAfbit1ENsRmtZbPQfYU3srURpfYuWYS7K',
+            });
+            // 420000 energy * 1.2 margin * 100 sun + 4000 bytes * 1000 sun
+            (0, vitest_1.expect)(actual.unwrap()).toEqual({ networkFeeCryptoBaseUnit: '54400000' });
+            (0, vitest_1.expect)(adapter.httpProvider.getContractEnergyShare).toHaveBeenCalledWith('TAfbit1ENsRmtZbPQfYU3srURpfYuWYS7K');
+        });
+        (0, vitest_1.it)('simulates the real gateway call for a quote', async () => {
+            vitest_1.vi.mocked(helpers_1.createBobGatewayOrder).mockResolvedValue((0, monads_1.Ok)({ offramp: { orderId: 'order-1', tx: tronTx } }));
+            const adapter = tronAdapter();
+            const actual = await (0, getBobGatewayStepData_1.getBobGatewayStepData)({
+                type: 'quote',
+                input: {},
+                deps: makeDeps(adapter),
+                quote,
+                sellAsset: USDT_TRON,
+                sellAmountCryptoBaseUnit: '100000000',
+                spenderAddress: '',
+                from: FROM,
+            });
+            (0, vitest_1.expect)(adapter.getFeeData).toHaveBeenCalledWith({
+                to: ALLOWANCE_HOLDER_HEX,
+                value: '0',
+                chainSpecific: { from: FROM, data: '0x2213bc0b', requireEnergyShare: true },
+            });
+            (0, vitest_1.expect)(actual.unwrap()).toEqual({
+                orderId: 'order-1',
+                transactionData: { type: 'tron', to: ALLOWANCE_HOLDER_HEX, data: '0x2213bc0b', value: '0' },
+                networkFeeCryptoBaseUnit: '45600000',
+            });
+        });
+        (0, vitest_1.it)('prices the measured worst case when the allowance is not granted yet', async () => {
+            vitest_1.vi.mocked(helpers_1.createBobGatewayOrder).mockResolvedValue((0, monads_1.Ok)({ offramp: { orderId: 'order-1', tx: tronTx } }));
+            const adapter = tronAdapter({ allowance: '0' });
+            adapter.getFeeData.mockRejectedValue(new Error('REVERT opcode executed'));
+            const actual = await (0, getBobGatewayStepData_1.getBobGatewayStepData)({
+                type: 'quote',
+                input: {},
+                deps: makeDeps(adapter),
+                quote,
+                sellAsset: USDT_TRON,
+                sellAmountCryptoBaseUnit: '100000000',
+                spenderAddress: 'TAfbit1ENsRmtZbPQfYU3srURpfYuWYS7K',
+                from: FROM,
+            });
+            // 420000 energy * 1.2 margin * 100 sun + (4 calldata + 279 envelope) bytes * 1000 sun
+            (0, vitest_1.expect)(actual.unwrap()).toMatchObject({
+                orderId: 'order-1',
+                networkFeeCryptoBaseUnit: '50683000',
+            });
+            (0, vitest_1.expect)(adapter.httpProvider.getTrc20Allowance).toHaveBeenCalledWith({
+                contractAddress: 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t',
+                owner: FROM,
+                spender: 'TAfbit1ENsRmtZbPQfYU3srURpfYuWYS7K',
+            });
+        });
+        (0, vitest_1.it)('fails the quote when the simulation reverts with the allowance in place', async () => {
+            vitest_1.vi.mocked(helpers_1.createBobGatewayOrder).mockResolvedValue((0, monads_1.Ok)({ offramp: { orderId: 'order-1', tx: tronTx } }));
+            const adapter = tronAdapter({ allowance: '100000000' });
+            adapter.getFeeData.mockRejectedValue(new Error('REVERT opcode executed'));
+            const actual = await (0, getBobGatewayStepData_1.getBobGatewayStepData)({
+                type: 'quote',
+                input: {},
+                deps: makeDeps(adapter),
+                quote,
+                sellAsset: USDT_TRON,
+                sellAmountCryptoBaseUnit: '100000000',
+                spenderAddress: 'TAfbit1ENsRmtZbPQfYU3srURpfYuWYS7K',
+                from: FROM,
+            });
+            (0, vitest_1.expect)(actual.isErr()).toBe(true);
+        });
+    });
+});

package/dist/cjs/swappers/BobGatewaySwapper/utils/getBobGatewayTradeContext.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getBobGatewayTradeContext = void 0;
-const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
 const monads_1 = require("@sniptt/monads");
 const uuid_1 = require("uuid");
 const types_1 = require("../../../types");
@@ -61,7 +60,7 @@ const getBobGatewayTradeContext = async ({ input, deps, sender, recipient, refun
             quote,
             sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
             sellAsset,
-            spenderAddress: (0, chain_adapters_1.isEvmChainId)(sellAsset.chainId) ? allowanceContract : '',
+            spenderAddress: allowanceContract,
             deps,
         },
     });

package/dist/cjs/swappers/BobGatewaySwapper/utils/helpers.d.ts

@@ -1,4 +1,4 @@
-import type { GatewayOrderStatusV3, GatewayQuoteV3, GetQuoteParams } from '@gobob/bob-sdk';
+import type { GatewayOrderStatusV3, GatewayQuoteV4, GetQuoteParams } from '@gobob/bob-sdk';
 import { GatewaySDK } from '@gobob/bob-sdk';
 import type { AssetId, ChainId } from '@shapeshiftoss/caip';
 import type { Asset, AssetsByIdPartial } from '@shapeshiftoss/types';
@@ -8,7 +8,6 @@ import type { SwapErrorRight, SwapperConfig } from '../../../types';
 import type { BobGatewayChainName } from './constants';
 export declare const dummyAddressForChainId: (chainId: ChainId) => string;
 export declare const getBobGatewayClient: (config: SwapperConfig) => GatewaySDK;
-export declare const toTronBase58: (address: string) => string;
 export declare const assetIdToBobGatewayToken: (assetId: string) => string;
 export declare const getBobGatewayAffiliates: (affiliateBps: string) => GetQuoteParams['affiliates'];
 export declare const getBobGatewayQuote: ({ config, sellAsset, buyAsset, sellChainName, buyChainName, sender, recipient, refundAddress, amount, affiliateBps, slippageTolerancePercentageDecimal, }: {
@@ -23,23 +22,21 @@ export declare const getBobGatewayQuote: ({ config, sellAsset, buyAsset, sellCha
     amount: string;
     affiliateBps: string;
     slippageTolerancePercentageDecimal: string | undefined;
-}) => Promise<Result<GatewayQuoteV3, SwapErrorRight>>;
-export declare const createBobGatewayOrder: (config: SwapperConfig, quote: GatewayQuoteV3) => Promise<import("@sniptt/monads/build/result/result").ResOk<import("@gobob/bob-sdk").GatewayCreateOrderV3, never> | import("@sniptt/monads/build/result/result").ResErr<unknown, SwapErrorRight>>;
-export declare const registerBobGatewayTx: ({ config, orderId, txHash, sellAsset, buyAsset, }: {
+}) => Promise<Result<GatewayQuoteV4, SwapErrorRight>>;
+export declare const createBobGatewayOrder: (config: SwapperConfig, quote: GatewayQuoteV4) => Promise<import("@sniptt/monads/build/result/result").ResOk<import("@gobob/bob-sdk").GatewayCreateOrderV3, never> | import("@sniptt/monads/build/result/result").ResErr<unknown, SwapErrorRight>>;
+export declare const submitBobGatewayBtcDeposit: ({ config, orderId, bitcoinTxHex, }: {
     config: SwapperConfig;
     orderId: string;
-    txHash: string;
-    sellAsset: Asset;
-    buyAsset: Asset;
-}) => Promise<void>;
+    bitcoinTxHex: string;
+}) => Promise<string>;
 export declare const mapBobGatewayOrderStatusToTxStatus: (status: GatewayOrderStatusV3) => TxStatus;
-export declare const parseBobGatewayQuote: (quote: GatewayQuoteV3, buyAsset: Asset, assetsById: AssetsByIdPartial) => {
+export declare const parseBobGatewayQuote: (quote: GatewayQuoteV4, buyAsset: Asset, assetsById: AssetsByIdPartial) => {
     buyAmountBeforeFeesCryptoBaseUnit: string;
     buyAmountAfterFeesCryptoBaseUnit: string;
     protocolFees: Partial<Record<AssetId, import("../../../types").ProtocolFee>>;
     estimatedExecutionTimeMs: number | undefined;
 };
-export declare const getBobGatewayAllowanceContract: (quote: GatewayQuoteV3, sellAsset: Asset) => string;
+export declare const getBobGatewayAllowanceContract: (quote: GatewayQuoteV4, sellAsset: Asset) => string;
 export declare const assertValidTrade: ({ sellAsset, buyAsset, }: {
     sellAsset: Asset;
     buyAsset: Asset;

package/dist/cjs/swappers/BobGatewaySwapper/utils/helpers.js

@@ -1,24 +1,48 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertValidTrade = exports.getBobGatewayAllowanceContract = exports.parseBobGatewayQuote = exports.mapBobGatewayOrderStatusToTxStatus = exports.registerBobGatewayTx = exports.createBobGatewayOrder = exports.getBobGatewayQuote = exports.getBobGatewayAffiliates = exports.assetIdToBobGatewayToken = exports.toTronBase58 = exports.getBobGatewayClient = exports.dummyAddressForChainId = void 0;
+exports.assertValidTrade = exports.getBobGatewayAllowanceContract = exports.parseBobGatewayQuote = exports.mapBobGatewayOrderStatusToTxStatus = exports.submitBobGatewayBtcDeposit = exports.createBobGatewayOrder = exports.getBobGatewayQuote = exports.getBobGatewayAffiliates = exports.assetIdToBobGatewayToken = exports.getBobGatewayClient = exports.dummyAddressForChainId = void 0;
 const bob_sdk_1 = require("@gobob/bob-sdk");
+const bitcoin = __importStar(require("@shapeshiftoss/bitcoinjs-lib"));
 const caip_1 = require("@shapeshiftoss/caip");
 const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
 const unchained_client_1 = require("@shapeshiftoss/unchained-client");
 const utils_1 = require("@shapeshiftoss/utils");
 const monads_1 = require("@sniptt/monads");
-const tronweb_1 = require("tronweb");
 const viem_1 = require("viem");
 const constants_1 = require("../../../constants");
 const types_1 = require("../../../types");
 const utils_2 = require("../../../utils");
 const helpers_1 = require("../../../utils/helpers");
+const tron_1 = require("../../../utils/tron");
 const constants_2 = require("./constants");
 const dummyAddressForChainId = (chainId) => {
     if (chainId === caip_1.btcChainId)
         return constants_2.DUMMY_BTC_ADDRESS;
     if (chainId === caip_1.tronChainId)
-        return constants_2.DUMMY_TRON_ADDRESS;
+        return tron_1.TRON_PLACEHOLDER_ADDRESS;
     return constants_2.DUMMY_EVM_ADDRESS;
 };
 exports.dummyAddressForChainId = dummyAddressForChainId;
@@ -26,14 +50,6 @@ const getBobGatewayClient = (config) => {
     return new bob_sdk_1.GatewaySDK({ basePath: constants_2.BOB_GATEWAY_BASE_URL, apiKey: config.VITE_BOB_GATEWAY_API_KEY });
 };
 exports.getBobGatewayClient = getBobGatewayClient;
-const toTronBase58 = (address) => {
-    if (address.startsWith('T'))
-        return address;
-    if (address.startsWith('0x'))
-        return tronweb_1.TronWeb.address.fromHex(address.slice(2));
-    return tronweb_1.TronWeb.address.fromHex(address);
-};
-exports.toTronBase58 = toTronBase58;
 const assetIdToBobGatewayToken = (assetId) => {
     // BOB Gateway uses the zero address as the token address for native assets
     if (!(0, utils_1.isToken)(assetId))
@@ -62,7 +78,6 @@ const getBobGatewayQuote = async ({ config, sellAsset, buyAsset, sellChainName,
             toUserAddress: recipient,
             amount,
             maxSlippage: Number(slippage),
-            ownerAddress: sellChainName === 'bitcoin' ? recipient : sender,
             refundAddress,
             affiliates: (0, exports.getBobGatewayAffiliates)(affiliateBps),
         });
@@ -108,7 +123,7 @@ const getBobGatewayQuote = async ({ config, sellAsset, buyAsset, sellChainName,
 exports.getBobGatewayQuote = getBobGatewayQuote;
 const createBobGatewayOrder = async (config, quote) => {
     try {
-        const order = await (0, exports.getBobGatewayClient)(config).api.createOrderV3({ gatewayQuoteV3: quote });
+        const order = await (0, exports.getBobGatewayClient)(config).api.createOrderV4({ gatewayQuoteV4: quote });
         return (0, monads_1.Ok)(order);
     }
     catch (err) {
@@ -127,23 +142,13 @@ const createBobGatewayOrder = async (config, quote) => {
     }
 };
 exports.createBobGatewayOrder = createBobGatewayOrder;
-const registerBobGatewayTx = async ({ config, orderId, txHash, sellAsset, buyAsset, }) => {
-    const registerTxV3 = (() => {
-        const sellChainName = constants_2.chainIdToBobGatewayChainName[sellAsset.chainId];
-        // BTC→EVM
-        if (sellChainName === 'bitcoin') {
-            return { onramp: { orderId, bitcoinTxid: txHash } };
-        }
-        // EVM→BTC
-        if (constants_2.chainIdToBobGatewayChainName[buyAsset.chainId] === 'bitcoin') {
-            return { offramp: { orderId, srcChain: sellChainName, srcTxHash: txHash } };
-        }
-        // EVM→EVM
-        return { tokenSwap: { orderId, srcChain: sellChainName, srcTxHash: txHash } };
-    })();
-    await (0, exports.getBobGatewayClient)(config).api.registerTxV3({ registerTxV3 });
+const submitBobGatewayBtcDeposit = async ({ config, orderId, bitcoinTxHex, }) => {
+    await (0, exports.getBobGatewayClient)(config).api.registerTxV4({
+        registerTxV4: { onramp: { orderId, bitcoinTxHex } },
+    });
+    return bitcoin.Transaction.fromHex(bitcoinTxHex).getId();
 };
-exports.registerBobGatewayTx = registerBobGatewayTx;
+exports.submitBobGatewayBtcDeposit = submitBobGatewayBtcDeposit;
 const mapBobGatewayOrderStatusToTxStatus = (status) => {
     if ('inProgress' in status)
         return unchained_client_1.TxStatus.Pending;
@@ -166,7 +171,7 @@ const bobGatewayFeeToAssetId = (fee) => {
         return (0, caip_1.toAssetId)({
             chainId,
             assetNamespace: caip_1.ASSET_NAMESPACE.trc20,
-            assetReference: (0, exports.toTronBase58)(fee.address),
+            assetReference: chain_adapters_1.tron.toTronBase58(fee.address),
         });
     }
     return (0, caip_1.toAssetId)({
@@ -240,7 +245,7 @@ const getBobGatewayAllowanceContract = (quote, sellAsset) => {
     if (!txTo)
         return '';
     if (isTron)
-        return (0, exports.toTronBase58)(txTo);
+        return chain_adapters_1.tron.toTronBase58(txTo);
     return txTo;
 };
 exports.getBobGatewayAllowanceContract = getBobGatewayAllowanceContract;

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

@@ -7,7 +7,6 @@ const monads_1 = require("@sniptt/monads");
 const constants_1 = require("../../../constants");
 const types_1 = require("../../../types");
 const utils_2 = require("../../../utils");
-const helpers_1 = require("../../../utils/helpers");
 const getButterSwapStepData_1 = require("../utils/getButterSwapStepData");
 const getButterSwapTradeContext_1 = require("../utils/getButterSwapTradeContext");
 const xhr_1 = require("../xhr");
@@ -59,20 +58,18 @@ const getTradeQuote = async (input, deps) => {
     });
     if (maybeStepData.isErr())
         return (0, monads_1.Err)(maybeStepData.unwrapErr());
-    const { networkFeeCryptoBaseUnit, transactionData, butterSwapTransactionMetadata } = maybeStepData.unwrap();
+    const { networkFeeCryptoBaseUnit, transactionData } = maybeStepData.unwrap();
     const tradeQuote = {
         ...tradeCommon,
         quoteOrRate: 'quote',
-        deadline: Date.now() + helpers_1.FALLBACK_QUOTE_DEADLINE_MS,
         receiveAddress,
         steps: [
             {
                 ...stepCommon,
                 accountNumber,
-                // Tron exec still builds from legacy metadata whose spender is the buildTx target
+                // Tron routes pull the sell token from the buildTx target
                 allowanceContract: sellAsset.chainId === caip_1.tronChainId ? buildTx.to : stepCommon.allowanceContract,
                 transactionData,
-                butterSwapTransactionMetadata,
                 feeData: { networkFeeCryptoBaseUnit, protocolFees },
             },
         ],

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

@@ -2,17 +2,6 @@ import type { Hex } from 'viem';
 import type { GetEvmTradeQuoteInput, GetEvmTradeRateInput, GetSolanaTradeQuoteInput, GetSolanaTradeRateInput, GetTronTradeQuoteInput, GetTronTradeRateInput } from '../../types';
 export type ButterSwapTradeQuoteInput = GetEvmTradeQuoteInput | GetSolanaTradeQuoteInput | GetTronTradeQuoteInput;
 export type ButterSwapTradeRateInput = GetEvmTradeRateInput | 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/constants.d.ts

@@ -1 +1,3 @@
+export declare const BUTTERSWAP_TRON_FALLBACK_SWAP_ENERGY = "1000000";
+export declare const BUTTERSWAP_TRON_DEFAULT_BANDWIDTH_BYTES = 2400;
 export declare const makeButterSwapAffiliate: (affiliateBps: string) => string | undefined;

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

@@ -1,8 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeButterSwapAffiliate = void 0;
+exports.makeButterSwapAffiliate = exports.BUTTERSWAP_TRON_DEFAULT_BANDWIDTH_BYTES = exports.BUTTERSWAP_TRON_FALLBACK_SWAP_ENERGY = void 0;
 const utils_1 = require("@shapeshiftoss/utils");
 const BUTTERSWAP_AFFILIATE = 'shapeshift';
+// The router's total energy per swap, before its deployer's share comes off
+exports.BUTTERSWAP_TRON_FALLBACK_SWAP_ENERGY = '1000000';
+exports.BUTTERSWAP_TRON_DEFAULT_BANDWIDTH_BYTES = 2400;
 // Format is `<nickname>[:rate]`, where rate is in basis points (e.g. `shapeshift:60` = 0.6%).
 const makeButterSwapAffiliate = (affiliateBps) => {
     if ((0, utils_1.bnOrZero)(affiliateBps).lte(0))

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

@@ -2,7 +2,7 @@ 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';
+import type { BuildTxSuccessItem, RouteSuccessItem } from '../types';
 export declare const BUTTERSWAP_SOLANA_COMPUTE_BUDGET: SolanaComputeBudgetOptions;
 type BaseArgs = {
     route: RouteSuccessItem;
@@ -19,8 +19,7 @@ type ButterSwapRateStepData = {
     networkFeeCryptoBaseUnit: string;
 };
 type ButterSwapQuoteStepData = {
-    transactionData?: TxBuildData;
-    butterSwapTransactionMetadata?: ButterSwapTransactionMetadata;
+    transactionData: TxBuildData;
     networkFeeCryptoBaseUnit: string;
 };
 export declare function getButterSwapStepData(args: Extract<GetButterSwapStepDataArgs, {

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

@@ -10,6 +10,8 @@ const types_1 = require("../../../types");
 const utils_2 = require("../../../utils");
 const evm_1 = require("../../../utils/evm");
 const solana_1 = require("../../../utils/solana");
+const tron_1 = require("../../../utils/tron");
+const constants_1 = require("./constants");
 const helpers_1 = require("./helpers");
 // 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
@@ -117,26 +119,52 @@ async function getButterSwapStepData(args) {
                 return (0, monads_1.Err)((0, utils_2.makeTradeStepBuildFailedErr)('getButterSwapStepData', error));
             }
         }
-        // Not yet migrated to a TxBuildData variant - exec still builds from legacy metadata
         case caip_1.CHAIN_NAMESPACE.Tron: {
-            const networkFeeCryptoBaseUnit = (0, helpers_1.getProviderNetworkFeeCryptoBaseUnit)({ route, feeAsset });
+            const adapter = deps.assertGetTronChainAdapter(sellAsset.chainId);
             if (args.type === 'rate') {
+                // Butter's gasFee is a fraction of what the router burns, so rates price the measured swap at the router's share
+                const networkFeeCryptoBaseUnit = await (async () => {
+                    if (!route.contract)
+                        return (0, helpers_1.getProviderNetworkFeeCryptoBaseUnit)({ route, feeAsset });
+                    try {
+                        return await (0, tron_1.getTronContractCallFallbackFeeCryptoBaseUnit)({
+                            adapter,
+                            energy: constants_1.BUTTERSWAP_TRON_FALLBACK_SWAP_ENERGY,
+                            bandwidthBytes: constants_1.BUTTERSWAP_TRON_DEFAULT_BANDWIDTH_BYTES,
+                            contractAddress: route.contract,
+                        });
+                    }
+                    catch {
+                        return (0, helpers_1.getProviderNetworkFeeCryptoBaseUnit)({ route, feeAsset });
+                    }
+                })();
                 const stepData = { networkFeeCryptoBaseUnit };
                 return (0, monads_1.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,
+            const { buildTx, from } = args;
+            const call = {
+                to: buildTx.to,
+                data: buildTx.data,
+                value: (0, viem_1.fromHex)(buildTx.value, 'bigint').toString(),
             };
-            return (0, monads_1.Ok)(stepData);
+            try {
+                const stepData = {
+                    transactionData: { type: 'tron', ...call },
+                    networkFeeCryptoBaseUnit: await (0, tron_1.getTronContractCallNetworkFeeCryptoBaseUnit)({
+                        adapter,
+                        transactionData: call,
+                        from,
+                        sellAsset,
+                        sellAmountCryptoBaseUnit,
+                        spenderAddress: buildTx.to,
+                        fallbackEnergy: constants_1.BUTTERSWAP_TRON_FALLBACK_SWAP_ENERGY,
+                    }),
+                };
+                return (0, monads_1.Ok)(stepData);
+            }
+            catch (error) {
+                return (0, monads_1.Err)((0, utils_2.makeNetworkFeeEstimationFailedErr)('getButterSwapStepData', error));
+            }
         }
         default:
             return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({

package/dist/cjs/swappers/ButterSwap/utils/getButterSwapStepData.test.js

@@ -17,6 +17,11 @@ const route = routeQuote_1.ROUTE_QUOTE.data[0];
 const PROVIDER_GAS_FEE_BASE_UNIT = '1333043669759539'; // 0.001333043669759539 ETH
 const SOL = { ...assets_1.ETH, assetId: `${caip_1.solanaChainId}/slip44:501`, chainId: caip_1.solanaChainId };
 const TRX = { ...assets_1.ETH, assetId: `${caip_1.tronChainId}/slip44:195`, chainId: caip_1.tronChainId };
+const USDT_TRON = {
+    ...assets_1.ETH,
+    assetId: `${caip_1.tronChainId}/trc20:TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t`,
+    chainId: caip_1.tronChainId,
+};
 const evmBuildTx = {
     to: '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE',
     data: '0xdeadbeef',
@@ -27,6 +32,7 @@ const makeDeps = (adapters) => ({
     assertGetEvmChainAdapter: () => adapters.evm,
     assertGetUtxoChainAdapter: () => adapters.utxo,
     assertGetSolanaChainAdapter: () => adapters.solana,
+    assertGetTronChainAdapter: () => adapters.tron,
 });
 const evmAdapter = ({ gasPrice = '1000000000', estimatedGasLimit = '500000', throwOnGasFeeData = false, throwOnFeeData = false, } = {}) => ({
     getGasFeeData: () => {
@@ -155,36 +161,133 @@ const evmQuoteInput = { supportsEIP1559: false };
         });
     });
     (0, vitest_1.describe)('tron', () => {
-        (0, vitest_1.it)('returns legacy metadata rather than transaction data, since exec still builds from it', async () => {
-            const buildTx = {
-                ...evmBuildTx,
+        const tronBuildTx = { ...evmBuildTx, to: 'TRouterAddress' };
+        const tronAdapter = ({ txFee = '9000000', allowance = '0' } = {}) => ({
+            getFeeData: vitest_1.vi.fn().mockResolvedValue({ fast: { txFee } }),
+            httpProvider: {
+                getChainPrices: () => Promise.resolve({ energyPrice: 100, bandwidthPrice: 1000 }),
+                getTrc20Allowance: vitest_1.vi.fn().mockResolvedValue(allowance),
+                getTrc20Balance: vitest_1.vi.fn().mockResolvedValue('100000000'),
+                getContractEnergyShare: vitest_1.vi.fn().mockResolvedValue({
+                    callerPercent: 100,
+                    originEnergyLimit: 0,
+                    originEnergyAvailable: 0,
+                }),
+            },
+        });
+        (0, vitest_1.it)('carries the router call as transactionData and simulates it', async () => {
+            const adapter = tronAdapter();
+            const actual = await (0, getButterSwapStepData_1.getButterSwapStepData)({
+                type: 'quote',
+                input: {},
+                from: 'TSenderAddress',
+                buildTx: tronBuildTx,
+                deps: makeDeps({ tron: adapter }),
+                route,
+                sellAsset: TRX,
+                feeAsset: TRX,
+                sellAmountCryptoBaseUnit: '1000000',
+                spenderAddress: '',
+            });
+            // Butter's value is the native amount to send: the sell amount for a native sell, 0 for a token
+            const transactionData = {
+                type: 'tron',
                 to: 'TRouterAddress',
-                method: 'swapAndCall',
-                args: [{ type: 'address', value: 'TSpender' }],
+                data: evmBuildTx.data,
+                value: '100000000000000000',
             };
+            (0, vitest_1.expect)(actual.unwrap()).toEqual({ transactionData, networkFeeCryptoBaseUnit: '9000000' });
+            (0, vitest_1.expect)(adapter.getFeeData).toHaveBeenCalledWith({
+                to: 'TRouterAddress',
+                value: '100000000000000000',
+                chainSpecific: { from: 'TSenderAddress', data: evmBuildTx.data, requireEnergyShare: true },
+            });
+        });
+        (0, vitest_1.it)('uses the provider value for a token sell', async () => {
             const actual = await (0, getButterSwapStepData_1.getButterSwapStepData)({
                 type: 'quote',
                 input: {},
                 from: 'TSenderAddress',
-                buildTx,
-                deps: {},
+                buildTx: { ...tronBuildTx, value: '0x00' },
+                deps: makeDeps({ tron: tronAdapter() }),
+                route,
+                sellAsset: USDT_TRON,
+                feeAsset: TRX,
+                sellAmountCryptoBaseUnit: '1000000',
+                spenderAddress: '',
+            });
+            (0, vitest_1.expect)(actual.unwrap().transactionData).toMatchObject({ value: '0' });
+        });
+        (0, vitest_1.it)('fails a native quote when the simulation fails', async () => {
+            const adapter = tronAdapter();
+            adapter.getFeeData.mockRejectedValue(new Error('REVERT opcode executed'));
+            const actual = await (0, getButterSwapStepData_1.getButterSwapStepData)({
+                type: 'quote',
+                input: {},
+                from: 'TSenderAddress',
+                buildTx: tronBuildTx,
+                deps: makeDeps({ tron: adapter }),
                 route,
                 sellAsset: TRX,
                 feeAsset: TRX,
                 sellAmountCryptoBaseUnit: '1000000',
                 spenderAddress: '',
             });
-            (0, vitest_1.expect)(actual.unwrap()).toEqual({
-                networkFeeCryptoBaseUnit: PROVIDER_GAS_FEE_BASE_UNIT,
-                butterSwapTransactionMetadata: {
-                    to: 'TRouterAddress',
-                    data: evmBuildTx.data,
-                    value: evmBuildTx.value,
-                    method: 'swapAndCall',
-                    args: [{ type: 'address', value: 'TSpender' }],
-                    memo: undefined,
-                },
+            (0, vitest_1.expect)(actual.isErr()).toBe(true);
+        });
+        (0, vitest_1.it)('prices the measured worst case when a token allowance is not granted yet', async () => {
+            const adapter = tronAdapter({ allowance: '0' });
+            adapter.getFeeData.mockRejectedValue(new Error('REVERT opcode executed'));
+            const actual = await (0, getButterSwapStepData_1.getButterSwapStepData)({
+                type: 'quote',
+                input: {},
+                from: 'TSenderAddress',
+                buildTx: { ...tronBuildTx, value: '0x00' },
+                deps: makeDeps({ tron: adapter }),
+                route,
+                sellAsset: USDT_TRON,
+                feeAsset: TRX,
+                sellAmountCryptoBaseUnit: '1000000',
+                spenderAddress: '',
+            });
+            // 1000000 energy * 1.2 margin * 100 sun + (4 calldata + 279 envelope) bytes * 1000 sun
+            (0, vitest_1.expect)(actual.unwrap().networkFeeCryptoBaseUnit).toBe('120283000');
+        });
+        (0, vitest_1.it)('rates price the measured swap at the router share', async () => {
+            const adapter = tronAdapter();
+            adapter.httpProvider.getContractEnergyShare.mockResolvedValue({
+                callerPercent: 5,
+                originEnergyLimit: 10_000_000,
+                originEnergyAvailable: 5_000_000,
+            });
+            const actual = await (0, getButterSwapStepData_1.getButterSwapStepData)({
+                type: 'rate',
+                input: {},
+                deps: makeDeps({ tron: adapter }),
+                route: { ...route, contract: 'TRouterAddress' },
+                sellAsset: TRX,
+                feeAsset: TRX,
+                sellAmountCryptoBaseUnit: '1000000',
+                spenderAddress: '',
+            });
+            // 1000000 * 5% caller energy * 1.2 margin * 100 sun + 2400 bytes * 1000 sun
+            (0, vitest_1.expect)(actual.unwrap()).toEqual({ networkFeeCryptoBaseUnit: '8400000' });
+            (0, vitest_1.expect)(adapter.httpProvider.getContractEnergyShare).toHaveBeenCalledWith('TRouterAddress');
+        });
+        (0, vitest_1.it)('rates fall back to the provider fee when the worst case cannot be priced', async () => {
+            const adapter = tronAdapter();
+            adapter.httpProvider.getContractEnergyShare.mockRejectedValue(new Error('429'));
+            const actual = await (0, getButterSwapStepData_1.getButterSwapStepData)({
+                type: 'rate',
+                input: {},
+                deps: makeDeps({ tron: adapter }),
+                route: { ...route, contract: 'TRouterAddress' },
+                sellAsset: TRX,
+                feeAsset: TRX,
+                sellAmountCryptoBaseUnit: '1000000',
+                spenderAddress: '',
             });
+            (0, vitest_1.expect)(actual.unwrap()).toEqual({ networkFeeCryptoBaseUnit: PROVIDER_GAS_FEE_BASE_UNIT });
         });
     });
     (0, vitest_1.it)('errors on an unsupported chain namespace', async () => {