@shapeshiftoss/swapper 17.8.0 → 19.0.0

package/dist/esm/swappers/RelaySwapper/utils/getRelayStepData.js

@@ -0,0 +1,193 @@
+import { fromChainId } from '@shapeshiftoss/caip';
+import { bnOrZero, contractAddressOrUndefined, isToken } from '@shapeshiftoss/utils';
+import { Err, Ok } from '@sniptt/monads';
+import { makeNetworkFeeEstimationFailedErr, makeTradeStepBuildFailedErr } from '../../../utils/index.js';
+import { getEvmNetworkFeeCryptoBaseUnit } from '../../../utils/evm/index.js';
+import { getSolanaNetworkFeeCryptoBaseUnit, omitComputeBudgetInstructions, withComputeUnitLimit, } from '../../../utils/solana/index.js';
+import { getUtxoNetworkFeeCryptoBaseUnit } from '../../../utils/utxo/index.js';
+import { getRelayPsbtRelayer } from './getRelayPsbtRelayer.js';
+import { convertRelaySolanaInstruction } from './helpers.js';
+import { isRelayQuoteEvmItemData, isRelayQuoteSolanaItemData, isRelayQuoteTronItemData, isRelayQuoteUtxoItemData, } from './types.js';
+// Bridge-out deposits measure constant compute consumption, but same-chain routes swap through
+// Jupiter where pool state moving between simulation and landing (CLMM tick crossings) measured
+// ~4% drift on a live route; 1.4 matches Jupiter's dynamicComputeUnitLimit margin
+export const RELAY_SOLANA_COMPUTE_BUDGET = { marginMultiplier: 1.4 };
+export async function getRelayStepData({ data, sellAsset, sellAmountCryptoBaseUnit, spenderAddress, orderId, from, xpub, type, input, fallbackNetworkFeeCryptoBaseUnit, deps, }) {
+    if (!data)
+        return Err(makeTradeStepBuildFailedErr('getRelayStepData'));
+    const supportsEIP1559 = 'supportsEIP1559' in input ? input.supportsEIP1559 : false;
+    if (isRelayQuoteEvmItemData(data)) {
+        const { data: callData, gas: relayGasLimit, to, value: _value } = data;
+        if (!to)
+            return Err(makeTradeStepBuildFailedErr('getRelayStepData'));
+        if (!callData)
+            return Err(makeTradeStepBuildFailedErr('getRelayStepData'));
+        const value = isToken(sellAsset.assetId) ? '0' : _value;
+        if (typeof value !== 'string')
+            return Err(makeTradeStepBuildFailedErr('getRelayStepData'));
+        const transactionData = {
+            type: 'evm',
+            chainId: Number(fromChainId(sellAsset.chainId).chainReference),
+            to,
+            value,
+            data: callData,
+            gasLimit: bnOrZero(relayGasLimit).gt(0) ? relayGasLimit : undefined,
+        };
+        const adapter = deps.assertGetEvmChainAdapter(sellAsset.chainId);
+        const stateOverride = {
+            sellAsset,
+            sellAmountCryptoBaseUnit,
+            spenderAddress,
+        };
+        if (type === 'rate') {
+            const networkFeeCryptoBaseUnit = await (async () => {
+                try {
+                    return await getEvmNetworkFeeCryptoBaseUnit({
+                        adapter,
+                        transactionData,
+                        from,
+                        supportsEIP1559,
+                        stateOverride,
+                    });
+                }
+                catch {
+                    return fallbackNetworkFeeCryptoBaseUnit;
+                }
+            })();
+            const stepData = { networkFeeCryptoBaseUnit };
+            return Ok(stepData);
+        }
+        // Execution needs the same fee data, so estimation failure fails the quote
+        try {
+            const networkFeeCryptoBaseUnit = await getEvmNetworkFeeCryptoBaseUnit({
+                adapter,
+                transactionData,
+                from,
+                supportsEIP1559,
+                stateOverride,
+            });
+            const stepData = { transactionData, networkFeeCryptoBaseUnit };
+            return Ok(stepData);
+        }
+        catch (error) {
+            return Err(makeNetworkFeeEstimationFailedErr('getRelayStepData', error));
+        }
+    }
+    if (isRelayQuoteUtxoItemData(data)) {
+        if (!data.psbt)
+            return Err(makeTradeStepBuildFailedErr('getRelayStepData'));
+        const relayer = getRelayPsbtRelayer(data.psbt, sellAmountCryptoBaseUnit);
+        if (!relayer)
+            return Err(makeTradeStepBuildFailedErr('getRelayStepData'));
+        if (!orderId)
+            return Err(makeTradeStepBuildFailedErr('getRelayStepData'));
+        const estimate = () => getUtxoNetworkFeeCryptoBaseUnit({
+            adapter: deps.assertGetUtxoChainAdapter(sellAsset.chainId),
+            pubkey: xpub,
+            to: relayer,
+            value: sellAmountCryptoBaseUnit,
+            opReturnData: orderId,
+        });
+        if (type === 'rate') {
+            const networkFeeCryptoBaseUnit = await (async () => {
+                try {
+                    const { networkFeeCryptoBaseUnit } = await estimate();
+                    return networkFeeCryptoBaseUnit;
+                }
+                catch {
+                    return fallbackNetworkFeeCryptoBaseUnit;
+                }
+            })();
+            const stepData = { networkFeeCryptoBaseUnit };
+            return Ok(stepData);
+        }
+        try {
+            const { networkFeeCryptoBaseUnit } = await estimate();
+            const stepData = {
+                transactionData: {
+                    type: 'utxo',
+                    to: relayer,
+                    opReturnData: orderId,
+                    value: sellAmountCryptoBaseUnit,
+                },
+                networkFeeCryptoBaseUnit,
+            };
+            return Ok(stepData);
+        }
+        catch (error) {
+            return Err(makeNetworkFeeEstimationFailedErr('getRelayStepData', error));
+        }
+    }
+    if (isRelayQuoteSolanaItemData(data)) {
+        const adapter = deps.assertGetSolanaChainAdapter(sellAsset.chainId);
+        const instructions = omitComputeBudgetInstructions(data.instructions?.map(convertRelaySolanaInstruction) ?? []);
+        const addressLookupTableAddresses = data.addressLookupTableAddresses ?? [];
+        if (type === 'rate') {
+            // No placeholder estimation for provider built routes - best effort with provider fee fallback
+            const networkFeeCryptoBaseUnit = await (async () => {
+                try {
+                    const { networkFeeCryptoBaseUnit } = await getSolanaNetworkFeeCryptoBaseUnit({
+                        adapter,
+                        from,
+                        instructions,
+                        addressLookupTableAddresses,
+                        tokenId: contractAddressOrUndefined(sellAsset.assetId),
+                    });
+                    return networkFeeCryptoBaseUnit;
+                }
+                catch {
+                    return fallbackNetworkFeeCryptoBaseUnit;
+                }
+            })();
+            const stepData = { networkFeeCryptoBaseUnit };
+            return Ok(stepData);
+        }
+        try {
+            const { networkFeeCryptoBaseUnit, feeData, includeComputeBudget } = await getSolanaNetworkFeeCryptoBaseUnit({
+                adapter,
+                from,
+                instructions,
+                addressLookupTableAddresses,
+                tokenId: contractAddressOrUndefined(sellAsset.assetId),
+            });
+            const stepData = {
+                transactionData: {
+                    type: 'solana_instructions',
+                    instructions: withComputeUnitLimit({
+                        instructions,
+                        computeUnits: feeData.chainSpecific.computeUnits,
+                        includeComputeBudget,
+                        computeBudget: RELAY_SOLANA_COMPUTE_BUDGET,
+                    }),
+                    addressLookupTableAddresses,
+                },
+                networkFeeCryptoBaseUnit,
+            };
+            return Ok(stepData);
+        }
+        catch (error) {
+            return Err(makeNetworkFeeEstimationFailedErr('getRelayStepData', error));
+        }
+    }
+    if (isRelayQuoteTronItemData(data)) {
+        const contractAddress = data.parameter?.contract_address;
+        const tronCallData = data.parameter?.data;
+        const isTronToken = isToken(sellAsset.assetId);
+        if (isTronToken && !contractAddress)
+            return Err(makeTradeStepBuildFailedErr('getRelayStepData'));
+        if (isTronToken && !tronCallData)
+            return Err(makeTradeStepBuildFailedErr('getRelayStepData'));
+        if (type === 'rate') {
+            const stepData = {
+                networkFeeCryptoBaseUnit: fallbackNetworkFeeCryptoBaseUnit,
+            };
+            return Ok(stepData);
+        }
+        const stepData = {
+            relayTransactionMetadata: { to: contractAddress, data: tronCallData },
+            networkFeeCryptoBaseUnit: fallbackNetworkFeeCryptoBaseUnit,
+        };
+        return Ok(stepData);
+    }
+    return Err(makeTradeStepBuildFailedErr('getRelayStepData'));
+}

package/dist/esm/swappers/RelaySwapper/utils/getRelayTradeContext.d.ts

@@ -0,0 +1,22 @@
+import type { Result } from '@sniptt/monads';
+import type { QuoteFeeData, SwapErrorRight, SwapperDeps, TradeCommon, TradeStepCommon } from '../../../types.js';
+import type { chainIdToRelayChainId as relayChainMapImplementation } from '../constant.js';
+import type { GetRelayStepDataArgs } from './getRelayStepData.js';
+import type { RelayQuoteItem, RelayTradeQuoteInput, RelayTradeRateInput } from './types.js';
+type RelayTradeContext = {
+    tradeCommon: TradeCommon;
+    stepCommon: Omit<TradeStepCommon, 'feeData' | 'allowanceContract'>;
+    protocolFees: QuoteFeeData['protocolFees'];
+    relayStepInputs: {
+        data: RelayQuoteItem['data'];
+        allowanceContract: string;
+    }[];
+    stepDataArgs: Omit<GetRelayStepDataArgs, 'type' | 'input' | 'data' | 'spenderAddress'>;
+    relayId: string;
+};
+export declare const getRelayTradeContext: ({ input, deps, relayChainMap, }: {
+    input: RelayTradeQuoteInput | RelayTradeRateInput;
+    deps: SwapperDeps;
+    relayChainMap: typeof relayChainMapImplementation;
+}) => Promise<Result<RelayTradeContext, SwapErrorRight>>;
+export {};

package/dist/esm/swappers/RelaySwapper/utils/getRelayTradeContext.js

@@ -0,0 +1,303 @@
+import { baseChainId, btcChainId, solanaChainId, tronChainId } from '@shapeshiftoss/caip';
+import { isEvmChainId } from '@shapeshiftoss/chain-adapters';
+import { bnOrZero, chainIdToFeeAssetId, convertBasisPointsToPercentage, convertDecimalPercentageToBasisPoints, convertPrecision, DAO_TREASURY_BASE, } from '@shapeshiftoss/utils';
+import { Err, Ok } from '@sniptt/monads';
+import axios from 'axios';
+import { zeroAddress } from 'viem';
+import { MixPanelEvent, SwapperName, TradeQuoteError } from '../../../types.js';
+import { getInputOutputRate, makeSwapErrorRight } from '../../../utils/index.js';
+import { buildAffiliateFee } from '../../../utils/affiliateFee.js';
+import { isNativeEvmAsset } from '../../../utils/helpers.js';
+import { MAXIMUM_SUPPORTED_RELAY_STEPS, relayErrorCodeToTradeQuoteError } from '../constant.js';
+import { getRelayAssetAddress } from '../utils/getRelayAssetAddress.js';
+import { relayTokenToAsset } from '../utils/relayTokenToAsset.js';
+import { relayTokenToAssetId } from '../utils/relayTokenToAssetId.js';
+import { fetchRelayTrade } from './fetchRelayTrade.js';
+import { assertValidTrade, getRelayAllowanceContract, resolveRelayAddresses } from './helpers.js';
+import { isRelayError } from './types.js';
+export const getRelayTradeContext = async ({ input, deps, relayChainMap, }) => {
+    const { sellAsset, buyAsset, sellAmountIncludingProtocolFeesCryptoBaseUnit, affiliateBps } = input;
+    const xpub = 'xpub' in input ? input.xpub : undefined;
+    const slippageToleranceBps = input.slippageTolerancePercentageDecimal
+        ? convertDecimalPercentageToBasisPoints(input.slippageTolerancePercentageDecimal).toFixed()
+        : undefined;
+    const assertion = assertValidTrade({ sellAsset, buyAsset, relayChainMap });
+    if (assertion.isErr())
+        return Err(assertion.unwrapErr());
+    const { sellRelayChainId, buyRelayChainId } = assertion.unwrap();
+    const { sendAddress, recipient, refundTo } = resolveRelayAddresses({
+        input,
+        sellChainId: sellAsset.chainId,
+        buyChainId: buyAsset.chainId,
+    });
+    const maybeQuote = await fetchRelayTrade({
+        originChainId: sellRelayChainId,
+        originCurrency: getRelayAssetAddress(sellAsset),
+        destinationChainId: buyRelayChainId,
+        destinationCurrency: getRelayAssetAddress(buyAsset),
+        tradeType: 'EXACT_INPUT',
+        amount: sellAmountIncludingProtocolFeesCryptoBaseUnit,
+        recipient,
+        user: sendAddress,
+        refundTo,
+        slippageTolerance: slippageToleranceBps,
+        refundOnOrigin: true,
+        referrer: 'shapeshift',
+        appFees: [
+            {
+                // Relay expects a BASE EVM address for affiliate fees
+                recipient: DAO_TREASURY_BASE,
+                fee: affiliateBps,
+            },
+        ],
+    }, deps.config);
+    if (maybeQuote.isErr()) {
+        const error = maybeQuote.unwrapErr();
+        if (!axios.isAxiosError(error.cause)) {
+            return Err(makeSwapErrorRight({ message: 'Unknown error', code: TradeQuoteError.UnknownError }));
+        }
+        const relayError = error.cause?.response?.data;
+        if (!isRelayError(relayError)) {
+            return Err(makeSwapErrorRight({ message: 'Unknown error', code: TradeQuoteError.UnknownError }));
+        }
+        const tradeQuoteErrorCode = relayErrorCodeToTradeQuoteError[relayError.errorCode];
+        if (tradeQuoteErrorCode) {
+            return Err(makeSwapErrorRight({ message: relayError.message, code: tradeQuoteErrorCode }));
+        }
+        // Fallback for unmapped error codes (shouldn't happen, but prevents crashes)
+        return Err(makeSwapErrorRight({
+            message: relayError.message || 'Unknown Relay error',
+            code: TradeQuoteError.UnknownError,
+        }));
+    }
+    const { data: quote } = maybeQuote.unwrap();
+    const orderId = quote.protocol?.v2?.orderId;
+    if (!orderId && sellAsset.chainId === btcChainId) {
+        return Err(makeSwapErrorRight({
+            message: 'Relay quote missing protocol.v2.orderId',
+            code: TradeQuoteError.UnknownError,
+        }));
+    }
+    const { slippageTolerance, currencyOut, timeEstimate } = quote.details;
+    const buyAmountAfterFeesCryptoBaseUnit = currencyOut.amount;
+    const rate = getInputOutputRate({
+        sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
+        buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
+        sellAsset,
+        buyAsset,
+    });
+    const { currency: relayToken } = currencyOut;
+    const swapSteps = quote.steps.filter(step => step.id !== 'approve');
+    if (swapSteps.length >= MAXIMUM_SUPPORTED_RELAY_STEPS) {
+        deps.mixPanel?.track(MixPanelEvent.RelayMultiHop);
+        return Err(makeSwapErrorRight({
+            message: `Relay quote with ${swapSteps.length} swap steps not supported (maximum ${MAXIMUM_SUPPORTED_RELAY_STEPS})`,
+            code: TradeQuoteError.UnsupportedTradePair,
+        }));
+    }
+    const swapStepsContainsMultipleItems = swapSteps.some(step => step.items?.length && step.items.length > 1);
+    // It's uncommon but can happen, log it to mixpanel to ensure we will investigate if it happens too much in the future
+    if (swapStepsContainsMultipleItems) {
+        deps.mixPanel?.track(MixPanelEvent.RelayStepMultipleItems);
+        return Err(makeSwapErrorRight({
+            message: `Relay quote with step containing multiple items not supported`,
+            code: TradeQuoteError.UnsupportedTradePair,
+        }));
+    }
+    if (swapSteps.some(step => !step.items?.[0])) {
+        return Err(makeSwapErrorRight({ message: 'Relay quote step contains no items' }));
+    }
+    const slippageTolerancePercentageDecimal = (() => {
+        if (input.slippageTolerancePercentageDecimal)
+            return input.slippageTolerancePercentageDecimal;
+        const destinationSlippageTolerancePercentageDecimal = bnOrZero(slippageTolerance.destination.percent);
+        if (destinationSlippageTolerancePercentageDecimal.gt(0)) {
+            return convertBasisPointsToPercentage(destinationSlippageTolerancePercentageDecimal).toFixed();
+        }
+        const originSlippageTolerancePercentageDecimal = bnOrZero(slippageTolerance.origin.percent);
+        return convertBasisPointsToPercentage(originSlippageTolerancePercentageDecimal).toFixed();
+    })();
+    const protocolAssetId = relayTokenToAssetId(relayToken);
+    const maybeProtocolAsset = relayTokenToAsset(relayToken, deps.assetsById);
+    if (maybeProtocolAsset.isErr())
+        return Err(maybeProtocolAsset.unwrapErr());
+    const protocolAsset = maybeProtocolAsset.unwrap();
+    const isCrossChain = sellAsset.chainId !== buyAsset.chainId;
+    const maybeAppFeesAsset = (() => {
+        // @TODO: when implementing fees, find if solana to solana assets are always showing empty app fees even if
+        // affiliate bps are set, if we remove this the quote fetching will fail because relayTokenToAsset will throw
+        if (sellAsset.chainId === solanaChainId &&
+            buyAsset.chainId === solanaChainId &&
+            quote.fees.app.currency.address === zeroAddress) {
+            return Ok(undefined);
+        }
+        return relayTokenToAsset(quote.fees.app.currency, deps.assetsById);
+    })();
+    const isNativeCurrencyInput = (() => {
+        if (maybeAppFeesAsset.isErr())
+            return false;
+        const appFeesAsset = maybeAppFeesAsset.unwrap();
+        if (!appFeesAsset)
+            return false;
+        if (isEvmChainId(sellAsset.chainId)) {
+            return isNativeEvmAsset(sellAsset.assetId) && sellAsset.chainId === appFeesAsset.chainId;
+        }
+        if (sellAsset.chainId === btcChainId)
+            return sellAsset.assetId === appFeesAsset.assetId;
+        if (sellAsset.chainId === solanaChainId)
+            return sellAsset.assetId === appFeesAsset.assetId;
+        if (sellAsset.chainId === tronChainId)
+            return sellAsset.assetId === appFeesAsset.assetId;
+        return false;
+    })();
+    const appFeesBaseUnit = (() => {
+        if (maybeAppFeesAsset.isErr())
+            return '0';
+        const appFeesAsset = maybeAppFeesAsset.unwrap();
+        if (!appFeesAsset)
+            return '0';
+        // For cross-chain: always add back app fees
+        // For same-chain: only add back if input is native currency
+        if (isCrossChain || isNativeCurrencyInput) {
+            if (buyAsset.assetId === appFeesAsset.assetId) {
+                return quote.fees.app.amount;
+            }
+            // if fee is in sell asset, convert to buy asset
+            if (appFeesAsset.assetId === sellAsset.assetId) {
+                return convertPrecision({
+                    value: quote.fees.app.amount,
+                    inputExponent: appFeesAsset.precision,
+                    outputExponent: buyAsset.precision,
+                })
+                    .times(rate)
+                    .toFixed(0);
+            }
+            // If fee is in a different asset, convert to buy asset
+            const feeAmountUsd = quote.fees.app.amountUsd;
+            const buyAssetUsd = currencyOut.amountUsd;
+            if (feeAmountUsd && buyAssetUsd && buyAmountAfterFeesCryptoBaseUnit) {
+                // Calculate the rate: (buyAssetAmount / buyAssetUsd) gives us "buy asset per USD"
+                // Then multiply by feeAmountUsd to get the equivalent buy asset amount
+                const buyAssetCryptoBaseUnitPerUsd = bnOrZero(buyAmountAfterFeesCryptoBaseUnit).div(buyAssetUsd);
+                const appFeesCryptoBaseUnit = bnOrZero(feeAmountUsd).times(buyAssetCryptoBaseUnitPerUsd);
+                return appFeesCryptoBaseUnit.toFixed(0);
+            }
+            return '0';
+        }
+        // cross-chain or same-chain with native currency as input are not applicable
+        return '0';
+    })();
+    // If same chain and not sellAsset as native currency, convert to protocol fee as native value is sent as well as erc20 tokens
+    // This is a edge case we never encountered before and it's more convenient to consider it as protocol fee as quickwin
+    const appFeesAsProtocolFee = (() => {
+        if (sellAsset.chainId !== buyAsset.chainId)
+            return {};
+        if (maybeAppFeesAsset.isErr())
+            return {};
+        const appFeesAsset = maybeAppFeesAsset.unwrap();
+        if (!appFeesAsset || isNativeCurrencyInput)
+            return {};
+        return {
+            [appFeesAsset.assetId]: {
+                amountCryptoBaseUnit: quote.fees.app.amount,
+                asset: appFeesAsset,
+                requiresBalance: false,
+            },
+        };
+    })();
+    const relayerFeeRelayToken = quote.fees.relayer.currency;
+    const maybeRelayerFeesAsset = relayTokenToAsset(relayerFeeRelayToken, deps.assetsById);
+    if (maybeRelayerFeesAsset.isErr()) {
+        return Err(maybeRelayerFeesAsset.unwrapErr());
+    }
+    const relayerFeesAsset = maybeRelayerFeesAsset.unwrap();
+    const relayerFeesBuyAssetCryptoBaseUnit = (() => {
+        const relayerFeeAmount = quote.fees.relayer.amount;
+        // If fee is already in buy asset, return as is
+        if (relayerFeesAsset.assetId === buyAsset.assetId) {
+            return relayerFeeAmount;
+        }
+        // if fee is in sell asset, convert to buy asset
+        if (relayerFeesAsset.assetId === sellAsset.assetId) {
+            return convertPrecision({
+                value: relayerFeeAmount,
+                inputExponent: relayerFeesAsset.precision,
+                outputExponent: buyAsset.precision,
+            })
+                .times(rate)
+                .toFixed(0);
+        }
+        // If fee is in a different asset, convert to buy asset
+        const feeAmountUsd = quote.fees.relayer.amountUsd;
+        const buyAssetUsd = currencyOut.amountUsd;
+        const buyAssetAmountBaseUnit = currencyOut.amount;
+        if (feeAmountUsd && buyAssetUsd && buyAssetAmountBaseUnit) {
+            // Calculate the rate: (buyAssetAmount / buyAssetUsd) gives us "buy asset per USD"
+            // Then multiply by feeAmountUsd to get the equivalent buy asset amount
+            const buyAssetCryptoBaseUnitPerUsd = bnOrZero(buyAssetAmountBaseUnit).div(buyAssetUsd);
+            const buyAssetFeesCryptoBaseUnit = bnOrZero(feeAmountUsd).times(buyAssetCryptoBaseUnitPerUsd);
+            return buyAssetFeesCryptoBaseUnit.toFixed(0);
+        }
+        return '0';
+    })();
+    // Add back relayer service and gas fees (relayer is including both) since they are downsides,
+    // and add appFees — these are quote-level and identical across every step
+    const buyAmountBeforeFeesCryptoBaseUnit = bnOrZero(currencyOut.amount)
+        .plus(relayerFeesBuyAssetCryptoBaseUnit)
+        .plus(appFeesBaseUnit)
+        .toFixed();
+    const relayId = quote.steps[0].requestId;
+    const relayStepInputs = swapSteps.map(step => {
+        const data = step.items?.[0]?.data;
+        return { data, allowanceContract: getRelayAllowanceContract(data) };
+    });
+    return Ok({
+        tradeCommon: {
+            id: relayId,
+            rate,
+            swapperName: SwapperName.Relay,
+            affiliateBps,
+            slippageTolerancePercentageDecimal,
+        },
+        stepCommon: {
+            rate,
+            buyAmountBeforeFeesCryptoBaseUnit,
+            buyAmountAfterFeesCryptoBaseUnit,
+            sellAmountIncludingProtocolFeesCryptoBaseUnit,
+            buyAsset,
+            sellAsset,
+            source: SwapperName.Relay,
+            estimatedExecutionTimeMs: timeEstimate * 1000,
+            affiliateFee: buildAffiliateFee({
+                strategy: 'fixed_asset',
+                affiliateBps,
+                sellAsset,
+                buyAsset,
+                sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
+                buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
+                fixedAssetId: chainIdToFeeAssetId(baseChainId),
+                fixedAsset: deps.assetsById[chainIdToFeeAssetId(baseChainId)],
+                isEstimate: true,
+            }),
+        },
+        protocolFees: {
+            [protocolAssetId]: {
+                amountCryptoBaseUnit: quote.fees.relayer.amount,
+                asset: protocolAsset,
+                requiresBalance: false,
+            },
+            ...appFeesAsProtocolFee,
+        },
+        relayStepInputs,
+        stepDataArgs: {
+            sellAsset,
+            sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
+            orderId,
+            from: sendAddress,
+            xpub,
+            fallbackNetworkFeeCryptoBaseUnit: quote.fees.gas.amount,
+            deps,
+        },
+        relayId,
+    });
+};

package/dist/esm/swappers/RelaySwapper/utils/helpers.d.ts

@@ -0,0 +1,26 @@
+import type { ChainId } from '@shapeshiftoss/caip';
+import type { Asset } from '@shapeshiftoss/types';
+import type { Result } from '@sniptt/monads';
+import type { TransactionInstruction } from '@solana/web3.js';
+import type { SwapErrorRight } from '../../../types.js';
+import type { chainIdToRelayChainId as relayChainMapImplementation } from '../constant.js';
+import type { RelayQuoteItem, RelaySolanaInstruction, RelayTradeQuoteInput, RelayTradeRateInput } from './types.js';
+export declare const assertValidTrade: ({ sellAsset, buyAsset, relayChainMap, }: {
+    sellAsset: Asset;
+    buyAsset: Asset;
+    relayChainMap: typeof relayChainMapImplementation;
+}) => Result<{
+    sellRelayChainId: number;
+    buyRelayChainId: number;
+}, SwapErrorRight>;
+export declare const resolveRelayAddresses: ({ input, sellChainId, buyChainId, }: {
+    input: RelayTradeQuoteInput | RelayTradeRateInput;
+    sellChainId: ChainId;
+    buyChainId: ChainId;
+}) => {
+    sendAddress: string;
+    recipient: string;
+    refundTo: string;
+};
+export declare const getRelayAllowanceContract: (data: RelayQuoteItem['data']) => string;
+export declare const convertRelaySolanaInstruction: (instruction: RelaySolanaInstruction) => TransactionInstruction;

package/dist/esm/swappers/RelaySwapper/utils/helpers.js

@@ -0,0 +1,73 @@
+import { btcChainId, solanaChainId, tronChainId } from '@shapeshiftoss/caip';
+import { isEvmChainId } from '@shapeshiftoss/chain-adapters';
+import { Err, Ok } from '@sniptt/monads';
+import { PublicKey } from '@solana/web3.js';
+import { TradeQuoteError } from '../../../types.js';
+import { makeSwapErrorRight } from '../../../utils/index.js';
+import { getRelayDefaultUserAddress } from './getRelayDefaultUserAddress.js';
+import { isRelayQuoteEvmItemData, isRelayQuoteTronItemData } from './types.js';
+const isSupportedRelayChainId = (chainId) => isEvmChainId(chainId) ||
+    chainId === btcChainId ||
+    chainId === solanaChainId ||
+    chainId === tronChainId;
+export const assertValidTrade = ({ sellAsset, buyAsset, relayChainMap, }) => {
+    if (!isSupportedRelayChainId(sellAsset.chainId)) {
+        return Err(makeSwapErrorRight({
+            message: `asset '${sellAsset.name}' on chainId '${sellAsset.chainId}' not supported`,
+            code: TradeQuoteError.UnsupportedTradePair,
+        }));
+    }
+    if (!isSupportedRelayChainId(buyAsset.chainId)) {
+        return Err(makeSwapErrorRight({
+            message: `asset '${buyAsset.name}' on chainId '${buyAsset.chainId}' not supported`,
+            code: TradeQuoteError.UnsupportedTradePair,
+        }));
+    }
+    const sellRelayChainId = relayChainMap[sellAsset.chainId];
+    const buyRelayChainId = relayChainMap[buyAsset.chainId];
+    if (sellRelayChainId === undefined) {
+        return Err(makeSwapErrorRight({
+            message: `asset '${sellAsset.name}' on chainId '${sellAsset.chainId}' not supported`,
+            code: TradeQuoteError.UnsupportedTradePair,
+        }));
+    }
+    if (buyRelayChainId === undefined) {
+        return Err(makeSwapErrorRight({
+            message: `asset '${buyAsset.name}' on chainId '${buyAsset.chainId}' not supported`,
+            code: TradeQuoteError.UnsupportedTradePair,
+        }));
+    }
+    return Ok({ sellRelayChainId, buyRelayChainId });
+};
+// BTC swaps must use the default user address for the fetch — a real address may not hold enough in a
+// single UTXO (the swap is funded from multiple UTXOs), so relay's estimation would fail. Rates default
+// every unset address; quotes carry the real ones (guarded upstream) so the `?? default` is inert there,
+// except refundTo which keeps the real send address even for BTC quotes.
+export const resolveRelayAddresses = ({ input, sellChainId, buyChainId, }) => {
+    const sendAddress = sellChainId === btcChainId
+        ? getRelayDefaultUserAddress(sellChainId)
+        : input.sendAddress ?? getRelayDefaultUserAddress(sellChainId);
+    const recipient = input.receiveAddress ?? getRelayDefaultUserAddress(buyChainId);
+    const refundTo = input.sendAddress ?? getRelayDefaultUserAddress(sellChainId);
+    return { sendAddress, recipient, refundTo };
+};
+// The spender to approve: EVM routes approve the router (data.to); Tron approves the token contract;
+// UTXO/Solana need no allowance. Derived from the provider route, not the built transactionData.
+export const getRelayAllowanceContract = (data) => {
+    if (!data)
+        return '';
+    if (isRelayQuoteEvmItemData(data))
+        return data.to ?? '';
+    if (isRelayQuoteTronItemData(data))
+        return data.parameter?.contract_address ?? '';
+    return '';
+};
+export const convertRelaySolanaInstruction = (instruction) => ({
+    ...instruction,
+    keys: instruction.keys.map(account => ({
+        ...account,
+        pubkey: new PublicKey(account.pubkey),
+    })),
+    data: Buffer.from(instruction.data, 'hex'),
+    programId: new PublicKey(instruction.programId),
+});

package/dist/esm/swappers/RelaySwapper/utils/notifyTransactionIndexing.js

@@ -1,4 +1,4 @@
-import { relayService } from './relayService.js';
+import { getRelayRequestConfig, relayService } from './relayService.js';
 export const notifyTransactionIndexing = async (params, config) => {
-    return await relayService.post(`${config.VITE_RELAY_API_URL}/transactions/single`, params);
+    return await relayService.post(`${config.VITE_RELAY_API_URL}/transactions/single`, params, getRelayRequestConfig(config));
 };

package/dist/esm/swappers/RelaySwapper/utils/relayService.d.ts

@@ -1,5 +1,8 @@
+import type { AxiosRequestConfig } from 'axios';
+import type { SwapperConfig } from '../../../types.js';
 export declare const relayService: {
-    get: <T = any>(url: string, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("@sniptt/monads").Result<import("axios").AxiosResponse<T, any, {}>, import("../../../index.js").SwapErrorRight>>;
-    post: <T_1 = any>(url: string, data: any, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("@sniptt/monads").Result<import("axios").AxiosResponse<T_1, any, {}>, import("../../../index.js").SwapErrorRight>>;
-    delete: <T_2 = any>(url: string, data: any, config?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("@sniptt/monads").Result<import("axios").AxiosResponse<T_2, any, {}>, import("../../../index.js").SwapErrorRight>>;
+    get: <T = any>(url: string, config?: AxiosRequestConfig<any> | undefined) => Promise<import("@sniptt/monads").Result<import("axios").AxiosResponse<T, any, {}>, import("../../../types.js").SwapErrorRight>>;
+    post: <T_1 = any>(url: string, data: any, config?: AxiosRequestConfig<any> | undefined) => Promise<import("@sniptt/monads").Result<import("axios").AxiosResponse<T_1, any, {}>, import("../../../types.js").SwapErrorRight>>;
+    delete: <T_2 = any>(url: string, data: any, config?: AxiosRequestConfig<any> | undefined) => Promise<import("@sniptt/monads").Result<import("axios").AxiosResponse<T_2, any, {}>, import("../../../types.js").SwapErrorRight>>;
 };
+export declare const getRelayRequestConfig: (config: SwapperConfig) => AxiosRequestConfig | undefined;

package/dist/esm/swappers/RelaySwapper/utils/relayService.js

@@ -1,4 +1,4 @@
-import { createCache, makeSwapperAxiosServiceMonadic } from '../../../utils.js';
+import { createCache, makeSwapperAxiosServiceMonadic } from '../../../utils/index.js';
 const maxAgeMillis = 15 * 1000;
 const cachedUrls = [];
 const axiosConfig = {
@@ -10,3 +10,4 @@ const axiosConfig = {
 };
 const relayServiceBase = createCache(maxAgeMillis, cachedUrls, axiosConfig);
 export const relayService = makeSwapperAxiosServiceMonadic(relayServiceBase);
+export const getRelayRequestConfig = (config) => config.VITE_RELAY_API_KEY ? { headers: { 'x-api-key': config.VITE_RELAY_API_KEY } } : undefined;

package/dist/esm/swappers/RelaySwapper/utils/relayTokenToAsset.js

@@ -1,5 +1,5 @@
 import { Err, Ok } from '@sniptt/monads';
-import { makeSwapErrorRight } from '../../../utils.js';
+import { makeSwapErrorRight } from '../../../utils/index.js';
 import { relayTokenToAssetId } from './relayTokenToAssetId.js';
 export const relayTokenToAsset = (relayToken, assets) => {
     const assetId = relayTokenToAssetId(relayToken);