@shapeshiftoss/swapper 17.7.3 → 18.1.0

package/dist/esm/swappers/ThorchainSwapper/utils/getLongtailRate.js

@@ -1,66 +1,36 @@
-import { ethChainId } from '@shapeshiftoss/caip';
-import { TS_AGGREGATOR_TOKEN_TRANSFER_PROXY_CONTRACT_MAINNET, viemClientByChainId, } from '@shapeshiftoss/contracts';
-import { Err, Ok } from '@sniptt/monads';
-import assert from 'assert';
-import { getL1RateOrQuote, TradeType } from '../../../thorchain-utils/index.js';
-import { TradeQuoteError } from '../../../types.js';
-import { makeSwapErrorRight } from '../../../utils.js';
+import { TS_AGGREGATOR_TOKEN_TRANSFER_PROXY_CONTRACT_MAINNET } from '@shapeshiftoss/contracts';
+import { Err } from '@sniptt/monads';
+import { getThorL1TradeRate, TradeType } from '../../../utils/thorchain/index.js';
+import { assertValidLongtailToL1Trade } from './assertValidLongtailTrade.js';
 import { getBestAggregator } from './getBestAggregator.js';
 import { getTokenFromAsset, getWrappedToken } from './longTailHelpers.js';
 // This just uses UniswapV3 to get the longtail quote for now.
 export const getLongtailToL1Rate = async (input, deps, streamingInterval, swapperName) => {
     const { sellAsset, sellAmountIncludingProtocolFeesCryptoBaseUnit } = input;
-    /*
-      We only support ethereum longtail -> L1 swaps for now.
-      We can later add BSC via UniV3, or Avalanche (e.g. via PancakeSwap)
-    */
-    if (sellAsset.chainId !== ethChainId) {
-        return Err(makeSwapErrorRight({
-            message: `[getThorTradeQuote] - Unsupported chainId ${sellAsset.chainId}.`,
-            code: TradeQuoteError.UnsupportedChain,
-            details: { sellAssetChainId: sellAsset.chainId },
-        }));
-    }
-    const sellChainId = sellAsset.chainId;
-    const buyAssetFeeAssetId = deps.assertGetChainAdapter(sellChainId)?.getFeeAssetId();
-    const buyAssetFeeAsset = buyAssetFeeAssetId ? deps.assetsById[buyAssetFeeAssetId] : undefined;
-    if (!buyAssetFeeAsset) {
-        return Err(makeSwapErrorRight({
-            message: `[getThorTradeQuote] - No native buy asset found for ${sellChainId}.`,
-            code: TradeQuoteError.InternalError,
-            details: { sellAssetChainId: sellChainId },
-        }));
-    }
-    // TODO: use more than just UniswapV3, and also consider trianglar routes.
-    const publicClient = viemClientByChainId[sellChainId];
-    assert(publicClient !== undefined, `no public client found for chainId '${sellChainId}'`);
+    const assertion = assertValidLongtailToL1Trade({ sellAsset, deps });
+    if (assertion.isErr())
+        return Err(assertion.unwrapErr());
+    const { buyAssetFeeAsset } = assertion.unwrap();
     const maybeBestAggregator = await getBestAggregator(buyAssetFeeAsset, getTokenFromAsset(sellAsset), getWrappedToken(buyAssetFeeAsset), sellAmountIncludingProtocolFeesCryptoBaseUnit);
     if (maybeBestAggregator.isErr()) {
         return Err(maybeBestAggregator.unwrapErr());
     }
-    const { bestAggregator, quotedAmountOut } = maybeBestAggregator.unwrap();
+    const { quotedAmountOut } = maybeBestAggregator.unwrap();
     const l1Tol1QuoteInput = {
         ...input,
         sellAsset: buyAssetFeeAsset,
         sellAmountIncludingProtocolFeesCryptoBaseUnit: quotedAmountOut.toString(),
     };
-    const thorchainRates = await getL1RateOrQuote(l1Tol1QuoteInput, deps, streamingInterval, TradeType.LongTailToL1, swapperName);
-    return thorchainRates.andThen(rates => {
-        const updatedRates = rates.map(q => ({
-            ...q,
-            aggregator: bestAggregator,
-            // This logic will need to be updated to support multi-hop, if that's ever implemented for THORChain
-            steps: q.steps.map(s => ({
-                ...s,
-                sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                sellAsset,
-                allowanceContract: TS_AGGREGATOR_TOKEN_TRANSFER_PROXY_CONTRACT_MAINNET,
-            })),
-            isLongtail: true,
-            longtailData: {
-                longtailToL1ExpectedAmountOut: quotedAmountOut.toString(),
-            },
-        }));
-        return Ok(updatedRates);
-    });
+    const maybeL1Rates = await getThorL1TradeRate(l1Tol1QuoteInput, deps, streamingInterval, TradeType.LongTailToL1, swapperName);
+    return maybeL1Rates.map(rates => rates.map(rate => ({
+        ...rate,
+        // This logic will need to be updated to support multi-hop, if that's ever implemented for THORChain
+        steps: rate.steps.map(s => ({
+            ...s,
+            sellAmountIncludingProtocolFeesCryptoBaseUnit,
+            sellAsset,
+            allowanceContract: TS_AGGREGATOR_TOKEN_TRANSFER_PROXY_CONTRACT_MAINNET,
+        })),
+        isLongtail: true,
+    })));
 };

package/dist/esm/swappers/ThorchainSwapper/utils/getShortenedFinalAssetLimit/getShortenedFinalAssetLimit.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { addFinalAssetLimitToMemo } from '../../../../thorchain-utils/index.js';
+import { addFinalAssetLimitToMemo } from '../../../../utils/thorchain/index.js';
 import { THORCHAIN_AFFILIATE_NAME } from '../../constants.js';
 import { getShortenedFinalAssetLimit } from './getShortenedFinalAssetLimit.js';
 const RECEIVE_ADDRESS = '0x32DBc9Cf9E8FbCebE1e0a2ecF05Ed86Ca3096Cb6';

package/dist/esm/swappers/ThorchainSwapper/utils/longTailHelpers.d.ts

@@ -3,8 +3,8 @@ import type { Asset } from '@shapeshiftoss/types';
 import { Token } from '@uniswap/sdk-core';
 import { FeeAmount } from '@uniswap/v3-sdk';
 import type { Address, GetContractReturnType, PublicClient } from 'viem';
-import type { ThornodePoolResponse } from '../../../thorchain-utils/index.js';
-import { TradeType } from '../../../thorchain-utils/index.js';
+import type { ThornodePoolResponse } from '../../../utils/thorchain/index.js';
+import { TradeType } from '../../../utils/thorchain/index.js';
 export declare const getWrappedToken: (nativeAsset: Asset) => Token;
 export declare const getTokenFromAsset: (asset: Asset) => Token;
 export declare function getTradeType(sellAssetPool: ThornodePoolResponse | undefined, buyAssetPool: ThornodePoolResponse | undefined, sellPoolId: string | undefined, buyPoolId: string | undefined): TradeType | undefined;

package/dist/esm/swappers/ThorchainSwapper/utils/longTailHelpers.js

@@ -3,7 +3,7 @@ import { I_UNISWAP_V3_POOL_ABI } from '@shapeshiftoss/contracts';
 import { Token } from '@uniswap/sdk-core';
 import { computePoolAddress, FeeAmount } from '@uniswap/v3-sdk';
 import { getAddress, getContract } from 'viem';
-import { TradeType } from '../../../thorchain-utils/index.js';
+import { TradeType } from '../../../utils/thorchain/index.js';
 import { WAVAX_TOKEN, WBNB_TOKEN, WETH_TOKEN } from './constants.js';
 export const getWrappedToken = (nativeAsset) => {
     switch (nativeAsset.chainId) {

package/dist/esm/swappers/ThorchainSwapper/utils/test-data/responses.d.ts

@@ -1,4 +1,4 @@
-import type { InboundAddressResponse, ThornodePoolResponse } from '../../../../thorchain-utils/index.js';
+import type { InboundAddressResponse, ThornodePoolResponse } from '../../../../utils/thorchain/index.js';
 export declare const btcThornodePool: ThornodePoolResponse;
 export declare const ethThornodePool: ThornodePoolResponse;
 export declare const foxThornodePool: ThornodePoolResponse;

package/dist/esm/swappers/ThorchainSwapper/utils/test-data/setupThorswapDeps.js

@@ -8,6 +8,10 @@ const feeData = {
         chainSpecific: { approvalFeeCryptoBaseUnit: '1', gasLimit: '1', gasPrice: '1' },
         tradeFee: '2',
     },
+    average: {
+        txFee: '400000',
+        chainSpecific: { gasLimit: '100000', gasPrice: '4' },
+    },
 };
 export const mockEvmChainAdapter = {
     getAddress: vi.fn(() => Promise.resolve('0xthisIsMyAddress')),

package/dist/esm/swappers/ZrxSwapper/ZrxSwapper.js

@@ -1,4 +1,4 @@
-import { executeEvmTransaction } from '../../utils.js';
+import { executeEvmTransaction } from '../../utils/index.js';
 export const zrxSwapper = {
     executeEvmTransaction,
 };

package/dist/esm/swappers/ZrxSwapper/endpoints.js

@@ -1,72 +1,11 @@
-import { evm } from '@shapeshiftoss/chain-adapters';
-import BigNumber from 'bignumber.js';
-import { concat, numberToHex, size } from 'viem';
-import { checkEvmSwapStatus, getExecutableTradeStep, isExecutableTradeQuote } from '../../utils.js';
+import { checkEvmSwapStatus } from '../../utils/index.js';
+import { getEvmTransactionFees, getUnsignedEvmTransaction } from '../../utils/evm/index.js';
 import { getZrxTradeQuote } from './getZrxTradeQuote/getZrxTradeQuote.js';
 import { getZrxTradeRate } from './getZrxTradeRate/getZrxTradeRate.js';
 export const zrxApi = {
-    getTradeQuote: async (input, { assertGetEvmChainAdapter, assetsById, config }) => {
-        const tradeQuoteResult = await getZrxTradeQuote(input, assertGetEvmChainAdapter, assetsById, config.VITE_ZRX_BASE_URL);
-        return tradeQuoteResult.map(tradeQuote => [tradeQuote]);
-    },
-    getTradeRate: async (input, { assetsById, config }) => {
-        const tradeRateResult = await getZrxTradeRate(input, assetsById, config.VITE_ZRX_BASE_URL);
-        return tradeRateResult.map(tradeRate => [tradeRate]);
-    },
-    getUnsignedEvmTransaction: async ({ from, stepIndex, tradeQuote, permit2Signature, supportsEIP1559, assertGetEvmChainAdapter, }) => {
-        if (!isExecutableTradeQuote(tradeQuote))
-            throw new Error('Unable to execute a trade rate quote');
-        const step = getExecutableTradeStep(tradeQuote, stepIndex);
-        const { accountNumber, sellAsset, zrxTransactionMetadata } = step;
-        if (!zrxTransactionMetadata)
-            throw new Error('Transaction metadata is required');
-        const { value, to } = zrxTransactionMetadata;
-        const data = (() => {
-            if (!permit2Signature)
-                return zrxTransactionMetadata.data;
-            // Append the signature to the calldata
-            // https://0x.org/docs/0x-swap-api/guides/swap-tokens-with-0x-swap-api#5-append-signature-length-and-signature-data-to-transactiondata
-            const signatureLengthInHex = numberToHex(size(permit2Signature), {
-                signed: false,
-                size: 32,
-            });
-            return concat([zrxTransactionMetadata.data, signatureLengthInHex, permit2Signature]);
-        })();
-        const adapter = assertGetEvmChainAdapter(sellAsset.chainId);
-        const feeData = await evm.getFees({ adapter, data, to, value, from, supportsEIP1559 });
-        return adapter.buildCustomApiTx({
-            accountNumber,
-            data,
-            from,
-            to,
-            value,
-            ...feeData,
-            // Use the higher amount of the node or the API, as the node doesn't always provide enough gas padding for total gas used.
-            gasLimit: BigNumber.max(feeData.gasLimit, zrxTransactionMetadata.gas ?? '0').toFixed(),
-        });
-    },
-    getEvmTransactionFees: async ({ from, stepIndex, tradeQuote, permit2Signature, supportsEIP1559, assertGetEvmChainAdapter, }) => {
-        if (!isExecutableTradeQuote(tradeQuote))
-            throw new Error('Unable to execute a trade rate quote');
-        const step = getExecutableTradeStep(tradeQuote, stepIndex);
-        const { sellAsset, zrxTransactionMetadata } = step;
-        if (!zrxTransactionMetadata)
-            throw new Error('Transaction metadata is required');
-        const { value, to } = zrxTransactionMetadata;
-        const data = (() => {
-            if (!permit2Signature)
-                return zrxTransactionMetadata.data;
-            // Append the signature to the calldata
-            // https://0x.org/docs/0x-swap-api/guides/swap-tokens-with-0x-swap-api#5-append-signature-length-and-signature-data-to-transactiondata
-            const signatureLengthInHex = numberToHex(size(permit2Signature), {
-                signed: false,
-                size: 32,
-            });
-            return concat([zrxTransactionMetadata.data, signatureLengthInHex, permit2Signature]);
-        })();
-        const adapter = assertGetEvmChainAdapter(sellAsset.chainId);
-        const feeData = await evm.getFees({ adapter, data, to, value, from, supportsEIP1559 });
-        return feeData.networkFeeCryptoBaseUnit;
-    },
+    getTradeQuote: (input, deps) => getZrxTradeQuote(input, deps),
+    getTradeRate: (input, deps) => getZrxTradeRate(input, deps),
+    getUnsignedEvmTransaction,
+    getEvmTransactionFees,
     checkTradeStatus: checkEvmSwapStatus,
 };

package/dist/esm/swappers/ZrxSwapper/getZrxTradeQuote/getZrxTradeQuote.d.ts

@@ -1,6 +1,4 @@
-import type { ChainId } from '@shapeshiftoss/caip';
-import type { EvmChainAdapter } from '@shapeshiftoss/chain-adapters';
-import type { AssetsByIdPartial } from '@shapeshiftoss/types';
 import type { Result } from '@sniptt/monads';
-import type { GetEvmTradeQuoteInputBase, SwapErrorRight, TradeQuote } from '../../../types.js';
-export declare function getZrxTradeQuote(input: GetEvmTradeQuoteInputBase, assertGetEvmChainAdapter: (chainId: ChainId) => EvmChainAdapter, assetsById: AssetsByIdPartial, zrxBaseUrl: string): Promise<Result<TradeQuote, SwapErrorRight>>;
+import type { SwapErrorRight, SwapperDeps, TradeQuote } from '../../../types.js';
+import type { ZrxTradeQuoteInput } from '../types.js';
+export declare const getZrxTradeQuote: (input: ZrxTradeQuoteInput, deps: SwapperDeps) => Promise<Result<TradeQuote[], SwapErrorRight>>;

package/dist/esm/swappers/ZrxSwapper/getZrxTradeQuote/getZrxTradeQuote.js

@@ -1,17 +1,25 @@
-import { evm } from '@shapeshiftoss/chain-adapters';
-import { PERMIT2_CONTRACT } from '@shapeshiftoss/contracts';
-import { bnOrZero } from '@shapeshiftoss/utils';
 import { Err, Ok } from '@sniptt/monads';
-import { v4 as uuid } from 'uuid';
 import { getDefaultSlippageDecimalPercentageForSwapper } from '../../../constants.js';
 import { SwapperName, TradeQuoteError } from '../../../types.js';
-import { makeSwapErrorRight } from '../../../utils.js';
-import { buildAffiliateFee } from '../../utils/affiliateFee.js';
-import { isNativeEvmAsset } from '../../utils/helpers/helpers.js';
+import { assertQuoteAddresses, makeSwapErrorRight } from '../../../utils/index.js';
+import { isNativeEvmAsset } from '../../../utils/helpers.js';
 import { fetchZrxQuote } from '../utils/fetchFromZrx.js';
-import { assertValidTrade, calculateBuyAmountBeforeFeesCryptoBaseUnit, calculateRate, getProtocolFees, } from '../utils/helpers/helpers.js';
-export async function getZrxTradeQuote(input, assertGetEvmChainAdapter, assetsById, zrxBaseUrl) {
-    const { sellAsset, buyAsset, accountNumber, receiveAddress, affiliateBps, chainId, supportsEIP1559, sellAmountIncludingProtocolFeesCryptoBaseUnit, } = input;
+import { getZrxStepData } from '../utils/getZrxStepData.js';
+import { getZrxTradeContext } from '../utils/getZrxTradeContext.js';
+import { assertValidTrade, isWrappedNativeSell } from '../utils/helpers.js';
+export const getZrxTradeQuote = async (input, deps) => {
+    const { sellAsset, buyAsset, accountNumber, affiliateBps, sellAmountIncludingProtocolFeesCryptoBaseUnit, } = input;
+    const maybeAddresses = assertQuoteAddresses(input);
+    if (maybeAddresses.isErr())
+        return Err(maybeAddresses.unwrapErr());
+    const { sendAddress, receiveAddress } = maybeAddresses.unwrap();
+    // The 0x order binds taker, so a quote for a different receive address is not executable by the sender
+    if (sendAddress !== receiveAddress) {
+        return Err(makeSwapErrorRight({
+            message: 'Cross-account trade not supported for ZRX',
+            code: TradeQuoteError.UnsupportedTradePair,
+        }));
+    }
     const assertion = assertValidTrade({ buyAsset, sellAsset });
     if (assertion.isErr())
         return Err(assertion.unwrapErr());
@@ -25,15 +33,13 @@ export async function getZrxTradeQuote(input, assertGetEvmChainAdapter, assetsBy
         sellAddress: receiveAddress,
         affiliateBps,
         slippageTolerancePercentageDecimal,
-        zrxBaseUrl,
+        zrxBaseUrl: deps.config.VITE_ZRX_BASE_URL,
     });
     if (maybeZrxQuoteResponse.isErr())
         return Err(maybeZrxQuoteResponse.unwrapErr());
-    const zrxQuoteResponse = maybeZrxQuoteResponse.unwrap();
-    const { sellAmount, buyAmount, fees, permit2, transaction, route } = zrxQuoteResponse;
+    const { sellAmount, buyAmount, fees, permit2, transaction, route } = maybeZrxQuoteResponse.unwrap();
     const permit2Eip712 = permit2?.eip712;
-    const isWrappedNative = route.fills.some(fill => fill.source === 'Wrapped_Native' && fill.proportionBps === '10000');
-    if (!isNativeEvmAsset(sellAsset.assetId) && !isWrappedNative && !permit2Eip712) {
+    if (!isNativeEvmAsset(sellAsset.assetId) && !isWrappedNativeSell(route) && !permit2Eip712) {
         return Err(makeSwapErrorRight({
             message: 'Missing required Permit2 metadata from 0x response',
             code: TradeQuoteError.InvalidResponse,
@@ -47,75 +53,38 @@ export async function getZrxTradeQuote(input, assertGetEvmChainAdapter, assetsBy
             details: { transaction, permit2Eip712 },
         }));
     }
-    const transactionMetadata = {
-        to: transaction.to,
-        data: transaction.data,
-        gasPrice: transaction.gasPrice || undefined,
-        gas: transaction.gas || undefined,
-        value: transaction.value,
-    };
-    const rate = calculateRate({ buyAmount, sellAmount, buyAsset, sellAsset });
-    const buyAmountBeforeFeesCryptoBaseUnit = calculateBuyAmountBeforeFeesCryptoBaseUnit({
-        buyAmount,
-        fees,
-        buyAsset,
-        sellAsset,
+    const maybeContext = getZrxTradeContext({
+        input,
+        deps,
+        slippageTolerancePercentageDecimal,
+        normalizedQuote: { buyAmount, sellAmount, fees, route },
     });
-    try {
-        const adapter = assertGetEvmChainAdapter(chainId);
-        const { average } = await adapter.getGasFeeData();
-        const networkFeeCryptoBaseUnit = evm.calcNetworkFeeCryptoBaseUnit({
-            ...average,
-            supportsEIP1559: Boolean(supportsEIP1559),
-            // add gas limit buffer to account for the fact we perform all of our validation on the trade quote estimations
-            // which are inaccurate and not what we use for the tx to broadcast
-            gasLimit: bnOrZero(transaction.gas).times(1.2).toFixed(),
-        });
-        return Ok({
-            id: uuid(),
-            quoteOrRate: 'quote',
-            receiveAddress,
-            affiliateBps,
-            // Slippage protection is always enabled for 0x api v2 unlike api v1 which was only supported on specific pairs.
-            slippageTolerancePercentageDecimal,
-            rate,
-            swapperName: SwapperName.Zrx,
-            steps: [
-                {
-                    // Assume instant execution since this is a same-chain AMM Tx which will happen within the same block
-                    estimatedExecutionTimeMs: 0,
-                    allowanceContract: isNativeEvmAsset(sellAsset.assetId) || isWrappedNative ? undefined : PERMIT2_CONTRACT,
-                    buyAsset,
-                    sellAsset,
-                    accountNumber,
-                    rate,
-                    feeData: {
-                        protocolFees: getProtocolFees({ fees, sellAsset, assetsById }),
-                        networkFeeCryptoBaseUnit,
-                    },
-                    buyAmountBeforeFeesCryptoBaseUnit,
-                    buyAmountAfterFeesCryptoBaseUnit: buyAmount,
-                    sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                    source: SwapperName.Zrx,
-                    affiliateFee: buildAffiliateFee({
-                        strategy: 'buy_asset',
-                        affiliateBps,
-                        sellAsset,
-                        buyAsset,
-                        sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                        buyAmountCryptoBaseUnit: buyAmount,
-                    }),
-                    permit2Eip712: permit2Eip712,
-                    zrxTransactionMetadata: transactionMetadata,
-                },
-            ],
-        });
-    }
-    catch (err) {
-        return Err(makeSwapErrorRight({
-            message: 'failed to get fee data',
-            cause: err,
-            code: TradeQuoteError.NetworkFeeEstimationFailed,
-        }));
-    }
-}
+    if (maybeContext.isErr())
+        return Err(maybeContext.unwrapErr());
+    const { tradeCommon, stepCommon, protocolFees, stepDataArgs } = maybeContext.unwrap();
+    const maybeStepData = await getZrxStepData({
+        ...stepDataArgs,
+        type: 'quote',
+        input,
+        transaction,
+        permit2Eip712,
+        from: receiveAddress,
+    });
+    if (maybeStepData.isErr())
+        return Err(maybeStepData.unwrapErr());
+    const { transactionData, networkFeeCryptoBaseUnit } = maybeStepData.unwrap();
+    const tradeQuote = {
+        ...tradeCommon,
+        quoteOrRate: 'quote',
+        receiveAddress,
+        steps: [
+            {
+                ...stepCommon,
+                accountNumber,
+                transactionData,
+                feeData: { networkFeeCryptoBaseUnit, protocolFees },
+            },
+        ],
+    };
+    return Ok([tradeQuote]);
+};

package/dist/esm/swappers/ZrxSwapper/getZrxTradeRate/getZrxTradeRate.d.ts

@@ -1,4 +1,4 @@
-import type { AssetsByIdPartial } from '@shapeshiftoss/types';
 import type { Result } from '@sniptt/monads';
-import type { GetEvmTradeRateInput, SwapErrorRight, TradeRate } from '../../../types.js';
-export declare function getZrxTradeRate(input: GetEvmTradeRateInput, assetsById: AssetsByIdPartial, zrxBaseUrl: string): Promise<Result<TradeRate, SwapErrorRight>>;
+import type { SwapErrorRight, SwapperDeps, TradeRate } from '../../../types.js';
+import type { ZrxTradeRateInput } from '../types.js';
+export declare const getZrxTradeRate: (input: ZrxTradeRateInput, deps: SwapperDeps) => Promise<Result<TradeRate[], SwapErrorRight>>;

package/dist/esm/swappers/ZrxSwapper/getZrxTradeRate/getZrxTradeRate.js

@@ -1,14 +1,12 @@
-import { PERMIT2_CONTRACT } from '@shapeshiftoss/contracts';
 import { Err, Ok } from '@sniptt/monads';
-import { v4 as uuid } from 'uuid';
 import { getDefaultSlippageDecimalPercentageForSwapper } from '../../../constants.js';
 import { SwapperName } from '../../../types.js';
-import { buildAffiliateFee } from '../../utils/affiliateFee.js';
-import { isNativeEvmAsset } from '../../utils/helpers/helpers.js';
 import { fetchZrxPrice } from '../utils/fetchFromZrx.js';
-import { assertValidTrade, calculateBuyAmountBeforeFeesCryptoBaseUnit, calculateRate, getProtocolFees, } from '../utils/helpers/helpers.js';
-export async function getZrxTradeRate(input, assetsById, zrxBaseUrl) {
-    const { sellAsset, buyAsset, accountNumber, receiveAddress, affiliateBps, sellAmountIncludingProtocolFeesCryptoBaseUnit, } = input;
+import { getZrxStepData } from '../utils/getZrxStepData.js';
+import { getZrxTradeContext } from '../utils/getZrxTradeContext.js';
+import { assertValidTrade } from '../utils/helpers.js';
+export const getZrxTradeRate = async (input, deps) => {
+    const { accountNumber, sellAsset, buyAsset, receiveAddress, affiliateBps, sellAmountIncludingProtocolFeesCryptoBaseUnit, } = input;
     const assertion = assertValidTrade({ buyAsset, sellAsset });
     if (assertion.isErr())
         return Err(assertion.unwrapErr());
@@ -22,56 +20,40 @@ export async function getZrxTradeRate(input, assetsById, zrxBaseUrl) {
         sellAddress: receiveAddress,
         affiliateBps,
         slippageTolerancePercentageDecimal,
-        zrxBaseUrl,
+        zrxBaseUrl: deps.config.VITE_ZRX_BASE_URL,
     });
     if (maybeZrxPriceResponse.isErr())
         return Err(maybeZrxPriceResponse.unwrapErr());
-    const zrxPriceResponse = maybeZrxPriceResponse.unwrap();
-    const { buyAmount, sellAmount, fees, totalNetworkFee, route } = zrxPriceResponse;
-    const isWrappedNative = route.fills.some(fill => fill.source === 'Wrapped_Native' && fill.proportionBps === '10000');
-    const rate = calculateRate({ buyAmount, sellAmount, buyAsset, sellAsset });
-    const buyAmountBeforeFeesCryptoBaseUnit = calculateBuyAmountBeforeFeesCryptoBaseUnit({
-        buyAmount,
-        fees,
-        buyAsset,
-        sellAsset,
+    const { buyAmount, sellAmount, fees, totalNetworkFee, route } = maybeZrxPriceResponse.unwrap();
+    const maybeContext = getZrxTradeContext({
+        input,
+        deps,
+        slippageTolerancePercentageDecimal,
+        normalizedQuote: { buyAmount, sellAmount, fees, route },
+    });
+    if (maybeContext.isErr())
+        return Err(maybeContext.unwrapErr());
+    const { tradeCommon, stepCommon, protocolFees, stepDataArgs } = maybeContext.unwrap();
+    const maybeStepData = await getZrxStepData({
+        ...stepDataArgs,
+        type: 'rate',
+        input,
+        totalNetworkFee,
     });
-    return Ok({
-        id: uuid(),
+    if (maybeStepData.isErr())
+        return Err(maybeStepData.unwrapErr());
+    const { networkFeeCryptoBaseUnit } = maybeStepData.unwrap();
+    const tradeRate = {
+        ...tradeCommon,
         quoteOrRate: 'rate',
-        accountNumber: undefined,
         receiveAddress,
-        affiliateBps,
-        // Slippage protection is always enabled for 0x api v2 unlike api v1 which was only supported on specific pairs.
-        slippageTolerancePercentageDecimal,
-        rate,
-        swapperName: SwapperName.Zrx,
         steps: [
             {
-                // Assume instant execution since this is a same-chain AMM Tx which will happen within the same block
-                estimatedExecutionTimeMs: 0,
-                allowanceContract: isNativeEvmAsset(sellAsset.assetId) || isWrappedNative ? undefined : PERMIT2_CONTRACT,
-                buyAsset,
-                sellAsset,
+                ...stepCommon,
                 accountNumber,
-                rate,
-                feeData: {
-                    protocolFees: getProtocolFees({ fees, sellAsset, assetsById }),
-                    networkFeeCryptoBaseUnit: totalNetworkFee,
-                },
-                buyAmountBeforeFeesCryptoBaseUnit,
-                buyAmountAfterFeesCryptoBaseUnit: buyAmount,
-                sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                source: SwapperName.Zrx,
-                affiliateFee: buildAffiliateFee({
-                    strategy: 'buy_asset',
-                    affiliateBps,
-                    sellAsset,
-                    buyAsset,
-                    sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                    buyAmountCryptoBaseUnit: buyAmount,
-                }),
+                feeData: { networkFeeCryptoBaseUnit, protocolFees },
             },
         ],
-    });
-}
+    };
+    return Ok([tradeRate]);
+};

package/dist/esm/swappers/ZrxSwapper/index.d.ts

@@ -0,0 +1,2 @@
+export { zrxApi } from './endpoints.js';
+export { zrxSwapper } from './ZrxSwapper.js';

package/dist/esm/swappers/ZrxSwapper/index.js

@@ -0,0 +1,2 @@
+export { zrxApi } from './endpoints.js';
+export { zrxSwapper } from './ZrxSwapper.js';

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

@@ -1,5 +1,8 @@
 import { KnownChainIds } from '@shapeshiftoss/types';
 import type { Address, TypedData } from 'viem';
+import type { GetEvmTradeQuoteInput, GetEvmTradeRateInput } from '../../types.js';
+export type ZrxTradeQuoteInput = GetEvmTradeQuoteInput;
+export type ZrxTradeRateInput = GetEvmTradeRateInput;
 export declare const zrxSupportedChainIds: readonly [KnownChainIds.EthereumMainnet, KnownChainIds.AvalancheMainnet, KnownChainIds.OptimismMainnet, KnownChainIds.BnbSmartChainMainnet, KnownChainIds.PolygonMainnet, KnownChainIds.ArbitrumMainnet, KnownChainIds.BaseMainnet];
 export type ZrxSupportedChainId = (typeof zrxSupportedChainIds)[number];
 type ZrxFee = {

package/dist/esm/swappers/ZrxSwapper/utils/fetchFromZrx.js

@@ -1,8 +1,8 @@
 import { viemNetworkIdByChainId } from '@shapeshiftoss/contracts';
 import { bn, convertDecimalPercentageToBasisPoints } from '@shapeshiftoss/utils';
 import { Err, Ok } from '@sniptt/monads';
-import { getTreasuryAddressFromChainId } from '../../utils/helpers/helpers.js';
-import { assetIdToZrxToken } from './helpers/helpers.js';
+import { getTreasuryAddressFromChainId } from '../../../utils/helpers.js';
+import { assetIdToZrxToken } from './helpers.js';
 import { zrxServiceFactory } from './zrxService.js';
 const fetchFromZrx = async ({ quoteOrRate, buyAsset, sellAsset, sellAmountIncludingProtocolFeesCryptoBaseUnit, sellAddress, affiliateBps, slippageTolerancePercentageDecimal, zrxBaseUrl, }) => {
     const zrxService = zrxServiceFactory({ baseUrl: zrxBaseUrl });

package/dist/esm/swappers/ZrxSwapper/utils/getZrxStepData.d.ts

@@ -0,0 +1,23 @@
+import type { Result } from '@sniptt/monads';
+import type { StepDataArgs, SwapErrorRight, TxBuildData } from '../../../types.js';
+import type { ZrxQuoteResponse } from '../types.js';
+export type GetZrxStepDataArgs = StepDataArgs<unknown, {
+    totalNetworkFee: string | null;
+}, {
+    transaction: ZrxQuoteResponse['transaction'];
+    permit2Eip712: NonNullable<ZrxQuoteResponse['permit2']>['eip712'] | undefined;
+}>;
+type ZrxRateStepData = {
+    networkFeeCryptoBaseUnit: string;
+};
+type ZrxQuoteStepData = {
+    transactionData: TxBuildData;
+    networkFeeCryptoBaseUnit: string;
+};
+export declare function getZrxStepData(args: Extract<GetZrxStepDataArgs, {
+    type: 'rate';
+}>): Promise<Result<ZrxRateStepData, SwapErrorRight>>;
+export declare function getZrxStepData(args: Extract<GetZrxStepDataArgs, {
+    type: 'quote';
+}>): Promise<Result<ZrxQuoteStepData, SwapErrorRight>>;
+export {};

package/dist/esm/swappers/ZrxSwapper/utils/getZrxStepData.js

@@ -0,0 +1,42 @@
+import { fromChainId } from '@shapeshiftoss/caip';
+import { bnOrZero } from '@shapeshiftoss/utils';
+import { Err, Ok } from '@sniptt/monads';
+import { makeNetworkFeeEstimationFailedErr } from '../../../utils/index.js';
+import { getEvmNetworkFeeCryptoBaseUnit } from '../../../utils/evm/index.js';
+export async function getZrxStepData(args) {
+    if (args.type === 'rate') {
+        const stepData = {
+            networkFeeCryptoBaseUnit: bnOrZero(args.totalNetworkFee).toFixed(),
+        };
+        return Ok(stepData);
+    }
+    const { sellAsset, transaction, permit2Eip712, from, input, deps } = args;
+    const transactionData = {
+        type: 'evm',
+        chainId: Number(fromChainId(sellAsset.chainId).chainReference),
+        to: transaction.to,
+        data: transaction.data,
+        value: transaction.value,
+        // 0x simulate with a valid permit2 signature, which can't be reproduced before signing, so trust their gas limit
+        gasLimit: transaction.gas || undefined,
+        ...(permit2Eip712 && {
+            signatureRequired: {
+                type: 'permit2',
+                eip712: permit2Eip712,
+            },
+        }),
+    };
+    try {
+        const networkFeeCryptoBaseUnit = await getEvmNetworkFeeCryptoBaseUnit({
+            adapter: deps.assertGetEvmChainAdapter(sellAsset.chainId),
+            transactionData,
+            from,
+            supportsEIP1559: 'supportsEIP1559' in input ? input.supportsEIP1559 : false,
+        });
+        const stepData = { transactionData, networkFeeCryptoBaseUnit };
+        return Ok(stepData);
+    }
+    catch (error) {
+        return Err(makeNetworkFeeEstimationFailedErr('getZrxStepData', error));
+    }
+}