@shapeshiftoss/swapper 17.7.3 → 18.1.0

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

@@ -1,86 +1,21 @@
-import { BuyTokenDestination, SellTokenSource, SigningScheme } from '@shapeshiftoss/types';
 import { TxStatus } from '@shapeshiftoss/unchained-client';
-import { bn } from '@shapeshiftoss/utils';
-import { v4 as uuid } from 'uuid';
-import { getDefaultSlippageDecimalPercentageForSwapper } from '../../constants.js';
-import { assertGetCowNetwork, getAffiliateAppDataFragmentByChainId, getFullAppData, } from '../../cowswap-utils/index.js';
-import { SwapperName } from '../../types.js';
-import { checkSafeTransactionStatus, getExecutableTradeStep, getHopByIndex, isExecutableTradeQuote, } from '../../utils.js';
+import { checkSafeTransactionStatus, getExecutableTradeStep, isExecutableTradeQuote, } from '../../utils/index.js';
+import { assertGetCowNetwork } from '../../utils/cowswap/index.js';
 import { CowStatusMessage } from './constants.js';
 import { getCowSwapTradeQuote } from './getCowSwapTradeQuote/getCowSwapTradeQuote.js';
 import { getCowSwapTradeRate } from './getCowSwapTradeRate/getCowSwapTradeRate.js';
 import { cowService } from './utils/cowService.js';
-import { getValuesFromQuoteResponse } from './utils/helpers/helpers.js';
-const tradeQuoteMetadata = new Map();
 export const cowApi = {
-    getTradeQuote: async (input, { config }) => {
-        const tradeQuoteResult = await getCowSwapTradeQuote(input, config);
-        return tradeQuoteResult.map(tradeQuote => {
-            // A quote always has a first step
-            const firstStep = getHopByIndex(tradeQuote, 0);
-            const id = uuid();
-            tradeQuoteMetadata.set(id, { chainId: firstStep?.sellAsset.chainId });
-            return [tradeQuote];
-        });
-    },
-    getTradeRate: async (input, { config }) => {
-        const tradeRateResult = await getCowSwapTradeRate(input, config);
-        return tradeRateResult.map(tradeRate => {
-            // A rate always has a first step
-            const firstStep = getHopByIndex(tradeRate, 0);
-            const id = uuid();
-            tradeQuoteMetadata.set(id, { chainId: firstStep?.sellAsset.chainId });
-            return [tradeRate];
-        });
-    },
-    getUnsignedEvmMessage: async ({ tradeQuote, stepIndex }) => {
+    getTradeQuote: (input, deps) => getCowSwapTradeQuote(input, deps),
+    getTradeRate: (input, deps) => getCowSwapTradeRate(input, deps),
+    getUnsignedEvmMessage: ({ tradeQuote, stepIndex }) => {
         if (!isExecutableTradeQuote(tradeQuote))
             throw new Error('Unable to execute a trade rate quote');
-        const step = getExecutableTradeStep(tradeQuote, stepIndex);
-        const { cowswapQuoteResponse, sellAsset, buyAsset } = step;
-        if (!cowswapQuoteResponse)
-            throw new Error('CowSwap quote data is required');
-        const { slippageTolerancePercentageDecimal = getDefaultSlippageDecimalPercentageForSwapper(SwapperName.CowSwap), } = tradeQuote;
-        // Check the chainId is supported for paranoia
-        assertGetCowNetwork(sellAsset.chainId);
-        const affiliateAppDataFragment = getAffiliateAppDataFragmentByChainId({
-            affiliateBps: tradeQuote.affiliateBps,
-            chainId: sellAsset.chainId,
-        });
-        const { appDataHash } = await getFullAppData(slippageTolerancePercentageDecimal, affiliateAppDataFragment, 'market');
-        const { id, quote } = cowswapQuoteResponse;
-        // Note: While CowSwap returns us a quote, and we have slippageBips and `partnerFee.bps` in the appData, this isn't enough.
-        // For the min out to actually to be reliable, the final message to be signed needs to have slippage and fee bps deducted.
-        // This actually matches what CoW uses as a minimum for a given quote - failure to do so means orders may take forever to be filled, or never be filled at all.
-        const { buyAmountAfterFeesCryptoBaseUnit } = getValuesFromQuoteResponse({
-            buyAsset,
-            sellAsset,
-            response: cowswapQuoteResponse,
-            affiliateBps: tradeQuote.affiliateBps,
-            slippageTolerancePercentageDecimal,
-        });
-        // CoW API and flow is weird - same idea as the mutation above, we need to incorporate protocol fees into the order
-        // This was previously working as-is with fees being deducted from the sell amount at protocol-level, but we now we need to add them into the order
-        // In other words, this means what was previously CoW being "feeless" as far as we're concerned
-        // i.e no additional fees to account for when doing balance checks, no longer holds true
-        //
-        // This also makes CoW the first and currently *only* swapper where max token swaps aren't full balance
-        const sellAmountPlusProtocolFees = bn(quote.sellAmount).plus(quote.feeAmount);
-        const orderToSign = {
-            ...quote,
-            // Another mutation from the original quote to go around the fact that CoW API flow is weird
-            // they return us a quote with fees, but we have to zero them out when sending the order
-            feeAmount: '0',
-            buyAmount: buyAmountAfterFeesCryptoBaseUnit,
-            sellAmount: sellAmountPlusProtocolFees.toFixed(0),
-            // from,
-            sellTokenBalance: SellTokenSource.ERC20,
-            buyTokenBalance: BuyTokenDestination.ERC20,
-            quoteId: id,
-            appDataHash,
-            signingScheme: SigningScheme.EIP712,
-        };
-        return { chainId: sellAsset.chainId, orderToSign };
+        const { transactionData } = getExecutableTradeStep(tradeQuote, stepIndex);
+        if (transactionData?.type !== 'cowswap')
+            throw new Error('CowSwap order data is required');
+        const { chainId, orderToSign } = transactionData;
+        return Promise.resolve({ chainId, orderToSign });
     },
     getEvmTransactionFees: () => {
         // No transaction fees for CoW
@@ -98,6 +33,9 @@ export const cowApi = {
         if (maybeSafeTransactionStatus)
             return maybeSafeTransactionStatus;
         const network = assertGetCowNetwork(chainId);
+        // txHash is the order uid - the cow explorer order page is the swap's tracker
+        const swapperTxId = txHash;
+        const swapperTxLink = `https://explorer.cow.fi/orders/${txHash}`;
         // with cow we aren't able to get the tx hash until it's already completed, so we must use the
         // order uid to fetch the trades and use their existence as indicating "complete"
         // https://docs.cow.fi/tutorials/how-to-submit-orders-via-the-api/6.-checking-order-status
@@ -111,6 +49,8 @@ export const cowApi = {
                 return {
                     status: TxStatus.Confirmed,
                     buyTxHash,
+                    swapperTxId,
+                    swapperTxLink,
                     message: CowStatusMessage.Fulfilled,
                 };
             }
@@ -125,12 +65,16 @@ export const cowApi = {
                     return {
                         status: TxStatus.Failed,
                         buyTxHash: undefined,
+                        swapperTxId,
+                        swapperTxLink,
                         message: CowStatusMessage.Cancelled,
                     };
                 case 'expired':
                     return {
                         status: TxStatus.Failed,
                         buyTxHash: undefined,
+                        swapperTxId,
+                        swapperTxLink,
                         message: CowStatusMessage.Expired,
                     };
                 default:
@@ -139,6 +83,8 @@ export const cowApi = {
         return {
             status: TxStatus.Pending,
             buyTxHash: undefined,
+            swapperTxId,
+            swapperTxLink,
             message: CowStatusMessage.Open,
         };
     },

package/dist/esm/swappers/CowSwapper/getCowSwapTradeQuote/getCowSwapTradeQuote.d.ts

@@ -1,3 +1,4 @@
 import type { Result } from '@sniptt/monads';
-import type { GetEvmTradeQuoteInputBase, SwapErrorRight, SwapperConfig, TradeQuote } from '../../../types.js';
-export declare function getCowSwapTradeQuote(input: GetEvmTradeQuoteInputBase, config: SwapperConfig): Promise<Result<TradeQuote, SwapErrorRight>>;
+import type { SwapErrorRight, SwapperDeps, TradeQuote } from '../../../types.js';
+import type { CowSwapTradeQuoteInput } from '../types.js';
+export declare const getCowSwapTradeQuote: (input: CowSwapTradeQuoteInput, deps: SwapperDeps) => Promise<Result<TradeQuote[], SwapErrorRight>>;

package/dist/esm/swappers/CowSwapper/getCowSwapTradeQuote/getCowSwapTradeQuote.js

@@ -1,134 +1,43 @@
-import { fromAssetId } from '@shapeshiftoss/caip';
-import { OrderKind } from '@shapeshiftoss/types';
-import { bn } from '@shapeshiftoss/utils';
 import { Err, Ok } from '@sniptt/monads';
-import { zeroAddress } from 'viem';
-import { getDefaultSlippageDecimalPercentageForSwapper } from '../../../constants.js';
-import { getAffiliateAppDataFragmentByChainId, getCowNetwork, getFullAppData, } from '../../../cowswap-utils/index.js';
-import { COW_SWAP_NATIVE_ASSET_MARKER_ADDRESS, COW_SWAP_VAULT_RELAYER_ADDRESS, SUPPORTED_CHAIN_IDS, } from '../../../cowswap-utils/constants.js';
-import { SwapperName, TradeQuoteError } from '../../../types.js';
-import { createTradeAmountTooSmallErr, getInputOutputRate, makeSwapErrorRight, } from '../../../utils.js';
-import { buildAffiliateFee } from '../../utils/affiliateFee.js';
-import { isNativeEvmAsset } from '../../utils/helpers/helpers.js';
-import { cowService } from '../utils/cowService.js';
-import { assertValidTrade, getNowPlusThirtyMinutesTimestamp, getValuesFromQuoteResponse, } from '../utils/helpers/helpers.js';
-export async function getCowSwapTradeQuote(input, config) {
-    const { sellAsset, buyAsset, accountNumber, chainId, receiveAddress, sellAmountIncludingProtocolFeesCryptoBaseUnit, affiliateBps, } = input;
-    const slippageTolerancePercentageDecimal = input.slippageTolerancePercentageDecimal ??
-        getDefaultSlippageDecimalPercentageForSwapper(SwapperName.CowSwap);
-    const assertion = assertValidTrade({
-        buyAsset,
-        sellAsset,
-        supportedChainIds: SUPPORTED_CHAIN_IDS,
-    });
-    if (assertion.isErr())
-        return Err(assertion.unwrapErr());
-    const buyToken = !isNativeEvmAsset(buyAsset.assetId)
-        ? fromAssetId(buyAsset.assetId).assetReference
-        : COW_SWAP_NATIVE_ASSET_MARKER_ADDRESS;
-    const maybeNetwork = getCowNetwork(chainId);
-    if (!maybeNetwork)
-        return Err(makeSwapErrorRight({
-            message: `[CowSwap: getCowSwapTradeQuote] - Unsupported chainId`,
-            code: TradeQuoteError.UnsupportedChain,
-            details: { chainId },
-        }));
-    const network = maybeNetwork;
-    const affiliateAppDataFragment = getAffiliateAppDataFragmentByChainId({
-        affiliateBps,
-        chainId: sellAsset.chainId,
-    });
-    const { appData, appDataHash } = await getFullAppData(slippageTolerancePercentageDecimal, affiliateAppDataFragment, 'market');
-    // https://api.cow.fi/docs/#/default/post_api_v1_quote
-    const maybeQuoteResponse = await cowService.post(`${config.VITE_COWSWAP_BASE_URL}/${network}/api/v1/quote`, {
-        sellToken: fromAssetId(sellAsset.assetId).assetReference,
-        buyToken,
-        receiver: receiveAddress,
-        validTo: getNowPlusThirtyMinutesTimestamp(),
-        appData,
-        appDataHash,
-        partiallyFillable: false,
-        from: receiveAddress ?? zeroAddress,
-        kind: OrderKind.SELL,
-        sellAmountBeforeFee: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-    });
-    if (maybeQuoteResponse.isErr()) {
-        const err = maybeQuoteResponse.unwrapErr();
-        const errData = err.cause?.response?.data;
-        if (err.cause?.isAxiosError &&
-            errData?.errorType === 'SellAmountDoesNotCoverFee') {
-            return Err(createTradeAmountTooSmallErr({
-                assetId: sellAsset.assetId,
-                minAmountCryptoBaseUnit: bn((errData?.data).fee_amount ?? '0x0', 16).toFixed(),
-            }));
-        }
-        return Err(maybeQuoteResponse.unwrapErr());
-    }
-    const { data: cowswapQuoteResponse } = maybeQuoteResponse.unwrap();
-    const { feeAmount: feeAmountInSellTokenCryptoBaseUnit } = cowswapQuoteResponse.quote;
-    const { buyAmountAfterFeesCryptoBaseUnit, buyAmountBeforeFeesCryptoBaseUnit } = getValuesFromQuoteResponse({
-        buyAsset,
-        sellAsset,
-        response: cowswapQuoteResponse,
-        affiliateBps,
-        slippageTolerancePercentageDecimal,
+import { assertQuoteAddresses } from '../../../utils/index.js';
+import { getCowSwapStepData } from '../utils/getCowSwapStepData.js';
+import { getCowSwapTradeContext } from '../utils/getCowSwapTradeContext.js';
+export const getCowSwapTradeQuote = async (input, deps) => {
+    const { accountNumber } = input;
+    const maybeAddresses = assertQuoteAddresses(input);
+    if (maybeAddresses.isErr())
+        return Err(maybeAddresses.unwrapErr());
+    const { sendAddress, receiveAddress } = maybeAddresses.unwrap();
+    const maybeContext = await getCowSwapTradeContext({
+        input,
+        deps,
+        senderAddress: sendAddress,
+        receiveAddress,
     });
-    const rate = getInputOutputRate({
-        sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-        buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-        sellAsset,
-        buyAsset,
+    if (maybeContext.isErr())
+        return Err(maybeContext.unwrapErr());
+    const { tradeCommon, stepCommon, protocolFees, stepDataArgs } = maybeContext.unwrap();
+    const maybeStepData = getCowSwapStepData({
+        ...stepDataArgs,
+        type: 'quote',
+        input,
+        from: sendAddress,
     });
-    const id = cowswapQuoteResponse.id?.toString();
-    if (!id) {
-        return Err(makeSwapErrorRight({
-            message: `[CowSwap: getCowSwapTradeQuote] - missing quote ID`,
-            code: TradeQuoteError.InvalidResponse,
-        }));
-    }
-    const quote = {
-        id,
+    if (maybeStepData.isErr())
+        return Err(maybeStepData.unwrapErr());
+    const { transactionData, networkFeeCryptoBaseUnit } = maybeStepData.unwrap();
+    const tradeQuote = {
+        ...tradeCommon,
         quoteOrRate: 'quote',
         receiveAddress,
-        affiliateBps,
-        rate,
-        slippageTolerancePercentageDecimal,
-        swapperName: SwapperName.CowSwap,
         steps: [
             {
-                estimatedExecutionTimeMs: undefined,
-                allowanceContract: COW_SWAP_VAULT_RELAYER_ADDRESS,
-                rate,
-                feeData: {
-                    networkFeeCryptoBaseUnit: '0',
-                    protocolFees: {
-                        [sellAsset.assetId]: {
-                            amountCryptoBaseUnit: feeAmountInSellTokenCryptoBaseUnit,
-                            // Technically does, but we deduct it off the sell amount
-                            requiresBalance: false,
-                            asset: sellAsset,
-                        },
-                    },
-                },
-                sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                buyAmountBeforeFeesCryptoBaseUnit,
-                buyAmountAfterFeesCryptoBaseUnit,
-                source: SwapperName.CowSwap,
-                affiliateFee: buildAffiliateFee({
-                    strategy: 'buy_asset',
-                    affiliateBps,
-                    sellAsset,
-                    buyAsset,
-                    sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                    buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-                    isEstimate: true,
-                }),
-                buyAsset,
-                sellAsset,
+                ...stepCommon,
                 accountNumber,
-                cowswapQuoteResponse,
+                feeData: { networkFeeCryptoBaseUnit, protocolFees },
+                transactionData,
             },
         ],
     };
-    return Ok(quote);
-}
+    return Ok([tradeQuote]);
+};

package/dist/esm/swappers/CowSwapper/getCowSwapTradeRate/getCowSwapTradeRate.d.ts

@@ -1,3 +1,4 @@
 import type { Result } from '@sniptt/monads';
-import type { GetEvmTradeRateInput, SwapErrorRight, SwapperConfig, TradeRate } from '../../../types.js';
-export declare function getCowSwapTradeRate(input: GetEvmTradeRateInput, config: SwapperConfig): Promise<Result<TradeRate, SwapErrorRight>>;
+import type { SwapErrorRight, SwapperDeps, TradeRate } from '../../../types.js';
+import type { CowSwapTradeRateInput } from '../types.js';
+export declare const getCowSwapTradeRate: (input: CowSwapTradeRateInput, deps: SwapperDeps) => Promise<Result<TradeRate[], SwapErrorRight>>;

package/dist/esm/swappers/CowSwapper/getCowSwapTradeRate/getCowSwapTradeRate.js

@@ -1,132 +1,34 @@
-import { fromAssetId } from '@shapeshiftoss/caip';
-import { OrderKind } from '@shapeshiftoss/types';
-import { bn } from '@shapeshiftoss/utils';
 import { Err, Ok } from '@sniptt/monads';
 import { zeroAddress } from 'viem';
-import { getDefaultSlippageDecimalPercentageForSwapper } from '../../../constants.js';
-import { getAffiliateAppDataFragmentByChainId, getCowNetwork, getFullAppData, } from '../../../cowswap-utils/index.js';
-import { COW_SWAP_NATIVE_ASSET_MARKER_ADDRESS, COW_SWAP_VAULT_RELAYER_ADDRESS, SUPPORTED_CHAIN_IDS, } from '../../../cowswap-utils/constants.js';
-import { SwapperName, TradeQuoteError } from '../../../types.js';
-import { createTradeAmountTooSmallErr, getInputOutputRate, makeSwapErrorRight, } from '../../../utils.js';
-import { buildAffiliateFee } from '../../utils/affiliateFee.js';
-import { isNativeEvmAsset } from '../../utils/helpers/helpers.js';
-import { cowService } from '../utils/cowService.js';
-import { assertValidTrade, getNowPlusThirtyMinutesTimestamp, getValuesFromQuoteResponse, } from '../utils/helpers/helpers.js';
-export async function getCowSwapTradeRate(input, config) {
-    const { sellAsset, buyAsset, accountNumber, chainId, receiveAddress, sellAmountIncludingProtocolFeesCryptoBaseUnit, affiliateBps, } = input;
-    const slippageTolerancePercentageDecimal = input.slippageTolerancePercentageDecimal ??
-        getDefaultSlippageDecimalPercentageForSwapper(SwapperName.CowSwap);
-    const assertion = assertValidTrade({
-        buyAsset,
-        sellAsset,
-        supportedChainIds: SUPPORTED_CHAIN_IDS,
-    });
-    if (assertion.isErr())
-        return Err(assertion.unwrapErr());
-    const buyToken = !isNativeEvmAsset(buyAsset.assetId)
-        ? fromAssetId(buyAsset.assetId).assetReference
-        : COW_SWAP_NATIVE_ASSET_MARKER_ADDRESS;
-    const maybeNetwork = getCowNetwork(chainId);
-    if (!maybeNetwork)
-        return Err(makeSwapErrorRight({
-            message: `[CowSwap: getCowSwapTradeRate] - Unsupported chainId`,
-            code: TradeQuoteError.UnsupportedChain,
-            details: { chainId },
-        }));
-    const network = maybeNetwork;
-    const affiliateAppDataFragment = getAffiliateAppDataFragmentByChainId({
-        affiliateBps,
-        chainId: sellAsset.chainId,
-    });
-    const { appData, appDataHash } = await getFullAppData(slippageTolerancePercentageDecimal, affiliateAppDataFragment, 'market');
-    // https://api.cow.fi/docs/#/default/post_api_v1_quote
-    const maybeQuoteResponse = await cowService.post(`${config.VITE_COWSWAP_BASE_URL}/${network}/api/v1/quote`, {
-        sellToken: fromAssetId(sellAsset.assetId).assetReference,
-        buyToken,
-        receiver: receiveAddress,
-        validTo: getNowPlusThirtyMinutesTimestamp(),
-        appData,
-        appDataHash,
-        partiallyFillable: false,
-        from: zeroAddress,
-        kind: OrderKind.SELL,
-        sellAmountBeforeFee: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-    });
-    if (maybeQuoteResponse.isErr()) {
-        const err = maybeQuoteResponse.unwrapErr();
-        const errData = err.cause?.response?.data;
-        if (err.cause?.isAxiosError &&
-            errData?.errorType === 'SellAmountDoesNotCoverFee') {
-            return Err(createTradeAmountTooSmallErr({
-                assetId: sellAsset.assetId,
-                minAmountCryptoBaseUnit: bn((errData?.data).fee_amount ?? '0x0', 16).toFixed(),
-            }));
-        }
-        return Err(maybeQuoteResponse.unwrapErr());
-    }
-    const { data: cowswapQuoteResponse } = maybeQuoteResponse.unwrap();
-    const { feeAmount: feeAmountInSellTokenCryptoBaseUnit } = cowswapQuoteResponse.quote;
-    const { buyAmountAfterFeesCryptoBaseUnit, buyAmountBeforeFeesCryptoBaseUnit } = getValuesFromQuoteResponse({
-        buyAsset,
-        sellAsset,
-        response: cowswapQuoteResponse,
-        affiliateBps,
-        slippageTolerancePercentageDecimal,
-    });
-    const rate = getInputOutputRate({
-        sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-        buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-        sellAsset,
-        buyAsset,
+import { getCowSwapStepData } from '../utils/getCowSwapStepData.js';
+import { getCowSwapTradeContext } from '../utils/getCowSwapTradeContext.js';
+export const getCowSwapTradeRate = async (input, deps) => {
+    const { accountNumber, receiveAddress } = input;
+    const maybeContext = await getCowSwapTradeContext({
+        input,
+        deps,
+        // The signer is only known at execution - the CoW quote is simulated from the zero address
+        senderAddress: zeroAddress,
+        receiveAddress,
     });
-    const id = cowswapQuoteResponse.id?.toString();
-    if (!id) {
-        return Err(makeSwapErrorRight({
-            message: `[CowSwap: getCowSwapTradeRate] - missing quote ID`,
-            code: TradeQuoteError.InvalidResponse,
-        }));
-    }
-    const quote = {
-        id,
+    if (maybeContext.isErr())
+        return Err(maybeContext.unwrapErr());
+    const { tradeCommon, stepCommon, protocolFees, stepDataArgs } = maybeContext.unwrap();
+    const maybeStepData = getCowSwapStepData({ ...stepDataArgs, type: 'rate', input });
+    if (maybeStepData.isErr())
+        return Err(maybeStepData.unwrapErr());
+    const { networkFeeCryptoBaseUnit } = maybeStepData.unwrap();
+    const tradeRate = {
+        ...tradeCommon,
         quoteOrRate: 'rate',
         receiveAddress,
-        affiliateBps,
-        rate,
-        slippageTolerancePercentageDecimal,
-        swapperName: SwapperName.CowSwap,
         steps: [
             {
-                estimatedExecutionTimeMs: undefined,
-                allowanceContract: COW_SWAP_VAULT_RELAYER_ADDRESS,
-                rate,
-                feeData: {
-                    networkFeeCryptoBaseUnit: '0',
-                    protocolFees: {
-                        [sellAsset.assetId]: {
-                            amountCryptoBaseUnit: feeAmountInSellTokenCryptoBaseUnit,
-                            // Technically does, but we deduct it off the sell amount
-                            requiresBalance: false,
-                            asset: sellAsset,
-                        },
-                    },
-                },
-                sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                buyAmountBeforeFeesCryptoBaseUnit,
-                buyAmountAfterFeesCryptoBaseUnit,
-                source: SwapperName.CowSwap,
-                affiliateFee: buildAffiliateFee({
-                    strategy: 'buy_asset',
-                    affiliateBps,
-                    sellAsset,
-                    buyAsset,
-                    sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                    buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-                }),
-                buyAsset,
-                sellAsset,
+                ...stepCommon,
                 accountNumber,
+                feeData: { networkFeeCryptoBaseUnit, protocolFees },
             },
         ],
     };
-    return Ok(quote);
-}
+    return Ok([tradeRate]);
+};

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

@@ -1 +1,3 @@
 export * from './types.js';
+export { cowApi } from './endpoints.js';
+export { cowSwapper } from './CowSwapper.js';

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

@@ -1 +1,3 @@
 export * from './types.js';
+export { cowApi } from './endpoints.js';
+export { cowSwapper } from './CowSwapper.js';

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

@@ -1,5 +1,8 @@
 import type { ChainId } from '@shapeshiftoss/caip';
 import type { OrderCreation } from '@shapeshiftoss/types';
+import type { GetEvmTradeQuoteInput, GetEvmTradeRateInput } from '../../types.js';
+export type CowSwapTradeQuoteInput = GetEvmTradeQuoteInput;
+export type CowSwapTradeRateInput = GetEvmTradeRateInput;
 export type CowSwapGetTradesResponse = {
     txHash: string;
 }[];

package/dist/esm/swappers/CowSwapper/utils/cowService.js

@@ -1,4 +1,4 @@
-import { createCache, makeSwapperAxiosServiceMonadic } from '../../../utils.js';
+import { createCache, makeSwapperAxiosServiceMonadic } from '../../../utils/index.js';
 const maxAge = 5 * 1000; // 5 seconds
 const cachedUrls = ['/mainnet/api/v1/quote', '/xdai/api/v1/quote'];
 const axiosConfig = {

package/dist/esm/swappers/CowSwapper/utils/getCowSwapStepData.d.ts

@@ -0,0 +1,23 @@
+import type { OrderQuoteResponse } from '@shapeshiftoss/types';
+import type { Result } from '@sniptt/monads';
+import type { StepDataArgs, SwapErrorRight, TxBuildData } from '../../../types.js';
+type CowSwapStepDataBase = {
+    cowswapQuoteResponse: OrderQuoteResponse;
+    appDataHash: string;
+    buyAmountAfterFeesCryptoBaseUnit: string;
+};
+export type GetCowSwapStepDataArgs = StepDataArgs<CowSwapStepDataBase>;
+type CowSwapRateStepData = {
+    networkFeeCryptoBaseUnit: string;
+};
+type CowSwapQuoteStepData = {
+    transactionData: TxBuildData;
+    networkFeeCryptoBaseUnit: string;
+};
+export declare function getCowSwapStepData(args: Extract<GetCowSwapStepDataArgs, {
+    type: 'rate';
+}>): Result<CowSwapRateStepData, SwapErrorRight>;
+export declare function getCowSwapStepData(args: Extract<GetCowSwapStepDataArgs, {
+    type: 'quote';
+}>): Result<CowSwapQuoteStepData, SwapErrorRight>;
+export {};

package/dist/esm/swappers/CowSwapper/utils/getCowSwapStepData.js

@@ -0,0 +1,34 @@
+import { BuyTokenDestination, SellTokenSource, SigningScheme } from '@shapeshiftoss/types';
+import { bn } from '@shapeshiftoss/utils';
+import { Ok } from '@sniptt/monads';
+export function getCowSwapStepData(args) {
+    // CowSwap is gasless - the solver pays execution, so there is no miner fee on either arm
+    if (args.type === 'rate') {
+        const stepData = { networkFeeCryptoBaseUnit: '0' };
+        return Ok(stepData);
+    }
+    const { sellAsset, cowswapQuoteResponse, appDataHash, buyAmountAfterFeesCryptoBaseUnit } = args;
+    const { id, quote } = cowswapQuoteResponse;
+    // The signed order deducts slippage and fees off buyAmount and folds protocol fees back into sellAmount -
+    // this matches CoW's own minimum for the quote, else orders may take forever to fill or never fill
+    const sellAmountPlusProtocolFees = bn(quote.sellAmount).plus(quote.feeAmount);
+    const orderToSign = {
+        ...quote,
+        // CoW returns a quote with fees, but they must be zeroed out when sending the order
+        feeAmount: '0',
+        buyAmount: buyAmountAfterFeesCryptoBaseUnit,
+        sellAmount: sellAmountPlusProtocolFees.toFixed(0),
+        sellTokenBalance: SellTokenSource.ERC20,
+        buyTokenBalance: BuyTokenDestination.ERC20,
+        quoteId: id,
+        appDataHash,
+        signingScheme: SigningScheme.EIP712,
+    };
+    const transactionData = {
+        type: 'cowswap',
+        chainId: sellAsset.chainId,
+        orderToSign,
+    };
+    const stepData = { transactionData, networkFeeCryptoBaseUnit: '0' };
+    return Ok(stepData);
+}

package/dist/esm/swappers/CowSwapper/utils/getCowSwapStepData.test.js

@@ -0,0 +1,81 @@
+import { describe, expect, it } from 'vitest';
+import { FOX_MAINNET } from '../../../utils/test-data/assets.js';
+import { getCowSwapStepData } from './getCowSwapStepData.js';
+const cowswapQuoteResponse = {
+    quote: {
+        sellToken: '0xc770eefad204b5180df6a14ee197d99d808ee52d',
+        buyToken: '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee',
+        receiver: '0x90a48d5cf7343b08da12e067680b4c6dbfe551be',
+        sellAmount: '9755648144619063874259',
+        buyAmount: '289305614806369753',
+        validTo: 1712259433,
+        appData: '{"appCode":"shapeshift","metadata":{"orderClass":{"orderClass":"market"},"quote":{"slippageBips":50}},"version":"1.3.0"}',
+        appDataHash: '0x41fffc0127f56060cc551652721d84c336f87649a20c51fcff5b8841dfeabe5b',
+        feeAmount: '184116879335769833472',
+        kind: 'sell',
+        partiallyFillable: false,
+        sellTokenBalance: 'erc20',
+        buyTokenBalance: 'erc20',
+        signingScheme: 'eip712',
+    },
+    from: '0x90a48d5cf7343b08da12e067680b4c6dbfe551be',
+    expiration: '2024-04-04T19:09:12.792412370Z',
+    id: 474006349,
+    verified: false,
+};
+const commonArgs = {
+    deps: {},
+    sellAsset: FOX_MAINNET,
+    cowswapQuoteResponse,
+    appDataHash: '0x41fffc0127f56060cc551652721d84c336f87649a20c51fcff5b8841dfeabe5b',
+    // quoted buyAmount less 0.5% slippage, as returned by getValuesFromQuoteResponse
+    buyAmountAfterFeesCryptoBaseUnit: '287859086732337904',
+};
+describe('getCowSwapStepData', () => {
+    describe('quote', () => {
+        it('should return the order to sign', () => {
+            const args = {
+                ...commonArgs,
+                type: 'quote',
+                input: {},
+                from: '0x90a48d5cf7343b08da12e067680b4c6dbfe551be',
+            };
+            const actual = getCowSwapStepData(args).unwrap();
+            expect(actual).toEqual({
+                networkFeeCryptoBaseUnit: '0',
+                transactionData: {
+                    type: 'cowswap',
+                    chainId: 'eip155:1',
+                    orderToSign: {
+                        sellToken: '0xc770eefad204b5180df6a14ee197d99d808ee52d',
+                        buyToken: '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee',
+                        receiver: '0x90a48d5cf7343b08da12e067680b4c6dbfe551be',
+                        sellAmount: '9939765023954833707731',
+                        buyAmount: '287859086732337904',
+                        validTo: 1712259433,
+                        appData: '{"appCode":"shapeshift","metadata":{"orderClass":{"orderClass":"market"},"quote":{"slippageBips":50}},"version":"1.3.0"}',
+                        appDataHash: '0x41fffc0127f56060cc551652721d84c336f87649a20c51fcff5b8841dfeabe5b',
+                        feeAmount: '0',
+                        kind: 'sell',
+                        partiallyFillable: false,
+                        sellTokenBalance: 'erc20',
+                        buyTokenBalance: 'erc20',
+                        signingScheme: 'eip712',
+                        quoteId: 474006349,
+                    },
+                },
+            });
+        });
+    });
+    describe('rate', () => {
+        it('should return a zero network fee and no transaction data', () => {
+            const args = {
+                ...commonArgs,
+                type: 'rate',
+                input: {},
+            };
+            const actual = getCowSwapStepData(args).unwrap();
+            expect(actual).toEqual({ networkFeeCryptoBaseUnit: '0' });
+        });
+    });
+});