@shapeshiftoss/swapper 17.8.0 → 19.0.0

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

@@ -1,89 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cowApi = void 0;
-const types_1 = require("@shapeshiftoss/types");
 const unchained_client_1 = require("@shapeshiftoss/unchained-client");
-const utils_1 = require("@shapeshiftoss/utils");
-const uuid_1 = require("uuid");
-const constants_1 = require("../../constants");
-const cowswap_utils_1 = require("../../cowswap-utils");
-const types_2 = require("../../types");
-const utils_2 = require("../../utils");
-const constants_2 = require("./constants");
+const utils_1 = require("../../utils");
+const cowswap_1 = require("../../utils/cowswap");
+const constants_1 = require("./constants");
 const getCowSwapTradeQuote_1 = require("./getCowSwapTradeQuote/getCowSwapTradeQuote");
 const getCowSwapTradeRate_1 = require("./getCowSwapTradeRate/getCowSwapTradeRate");
 const cowService_1 = require("./utils/cowService");
-const helpers_1 = require("./utils/helpers/helpers");
-const tradeQuoteMetadata = new Map();
 exports.cowApi = {
-    getTradeQuote: async (input, { config }) => {
-        const tradeQuoteResult = await (0, getCowSwapTradeQuote_1.getCowSwapTradeQuote)(input, config);
-        return tradeQuoteResult.map(tradeQuote => {
-            // A quote always has a first step
-            const firstStep = (0, utils_2.getHopByIndex)(tradeQuote, 0);
-            const id = (0, uuid_1.v4)();
-            tradeQuoteMetadata.set(id, { chainId: firstStep?.sellAsset.chainId });
-            return [tradeQuote];
-        });
-    },
-    getTradeRate: async (input, { config }) => {
-        const tradeRateResult = await (0, getCowSwapTradeRate_1.getCowSwapTradeRate)(input, config);
-        return tradeRateResult.map(tradeRate => {
-            // A rate always has a first step
-            const firstStep = (0, utils_2.getHopByIndex)(tradeRate, 0);
-            const id = (0, uuid_1.v4)();
-            tradeQuoteMetadata.set(id, { chainId: firstStep?.sellAsset.chainId });
-            return [tradeRate];
-        });
-    },
-    getUnsignedEvmMessage: async ({ tradeQuote, stepIndex }) => {
-        if (!(0, utils_2.isExecutableTradeQuote)(tradeQuote))
+    getTradeQuote: (input, deps) => (0, getCowSwapTradeQuote_1.getCowSwapTradeQuote)(input, deps),
+    getTradeRate: (input, deps) => (0, getCowSwapTradeRate_1.getCowSwapTradeRate)(input, deps),
+    getUnsignedEvmMessage: ({ tradeQuote, stepIndex }) => {
+        if (!(0, utils_1.isExecutableTradeQuote)(tradeQuote))
             throw new Error('Unable to execute a trade rate quote');
-        const step = (0, utils_2.getExecutableTradeStep)(tradeQuote, stepIndex);
-        const { cowswapQuoteResponse, sellAsset, buyAsset } = step;
-        if (!cowswapQuoteResponse)
-            throw new Error('CowSwap quote data is required');
-        const { slippageTolerancePercentageDecimal = (0, constants_1.getDefaultSlippageDecimalPercentageForSwapper)(types_2.SwapperName.CowSwap), } = tradeQuote;
-        // Check the chainId is supported for paranoia
-        (0, cowswap_utils_1.assertGetCowNetwork)(sellAsset.chainId);
-        const affiliateAppDataFragment = (0, cowswap_utils_1.getAffiliateAppDataFragmentByChainId)({
-            affiliateBps: tradeQuote.affiliateBps,
-            chainId: sellAsset.chainId,
-        });
-        const { appDataHash } = await (0, cowswap_utils_1.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 } = (0, helpers_1.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 = (0, utils_1.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: types_1.SellTokenSource.ERC20,
-            buyTokenBalance: types_1.BuyTokenDestination.ERC20,
-            quoteId: id,
-            appDataHash,
-            signingScheme: types_1.SigningScheme.EIP712,
-        };
-        return { chainId: sellAsset.chainId, orderToSign };
+        const { transactionData } = (0, utils_1.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
@@ -91,7 +26,7 @@ exports.cowApi = {
     },
     checkTradeStatus: async ({ txHash, // TODO: this is not a tx hash, its an ID
     chainId, address, fetchIsSmartContractAddressQuery, assertGetEvmChainAdapter, config, }) => {
-        const maybeSafeTransactionStatus = await (0, utils_2.checkSafeTransactionStatus)({
+        const maybeSafeTransactionStatus = await (0, utils_1.checkSafeTransactionStatus)({
             txHash,
             chainId,
             assertGetEvmChainAdapter,
@@ -100,7 +35,10 @@ exports.cowApi = {
         });
         if (maybeSafeTransactionStatus)
             return maybeSafeTransactionStatus;
-        const network = (0, cowswap_utils_1.assertGetCowNetwork)(chainId);
+        const network = (0, cowswap_1.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
@@ -114,7 +52,9 @@ exports.cowApi = {
                 return {
                     status: unchained_client_1.TxStatus.Confirmed,
                     buyTxHash,
-                    message: constants_2.CowStatusMessage.Fulfilled,
+                    swapperTxId,
+                    swapperTxLink,
+                    message: constants_1.CowStatusMessage.Fulfilled,
                 };
             }
         }
@@ -128,13 +68,17 @@ exports.cowApi = {
                     return {
                         status: unchained_client_1.TxStatus.Failed,
                         buyTxHash: undefined,
-                        message: constants_2.CowStatusMessage.Cancelled,
+                        swapperTxId,
+                        swapperTxLink,
+                        message: constants_1.CowStatusMessage.Cancelled,
                     };
                 case 'expired':
                     return {
                         status: unchained_client_1.TxStatus.Failed,
                         buyTxHash: undefined,
-                        message: constants_2.CowStatusMessage.Expired,
+                        swapperTxId,
+                        swapperTxLink,
+                        message: constants_1.CowStatusMessage.Expired,
                     };
                 default:
             }
@@ -142,7 +86,9 @@ exports.cowApi = {
         return {
             status: unchained_client_1.TxStatus.Pending,
             buyTxHash: undefined,
-            message: constants_2.CowStatusMessage.Open,
+            swapperTxId,
+            swapperTxLink,
+            message: constants_1.CowStatusMessage.Open,
         };
     },
 };

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

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

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

@@ -1,138 +1,48 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCowSwapTradeQuote = void 0;
-const caip_1 = require("@shapeshiftoss/caip");
-const types_1 = require("@shapeshiftoss/types");
-const utils_1 = require("@shapeshiftoss/utils");
 const monads_1 = require("@sniptt/monads");
-const viem_1 = require("viem");
-const constants_1 = require("../../../constants");
-const cowswap_utils_1 = require("../../../cowswap-utils");
-const constants_2 = require("../../../cowswap-utils/constants");
-const types_2 = require("../../../types");
-const utils_2 = require("../../../utils");
-const affiliateFee_1 = require("../../utils/affiliateFee");
-const helpers_1 = require("../../utils/helpers/helpers");
-const cowService_1 = require("../utils/cowService");
-const helpers_2 = require("../utils/helpers/helpers");
-async function getCowSwapTradeQuote(input, config) {
-    const { sellAsset, buyAsset, accountNumber, chainId, receiveAddress, sellAmountIncludingProtocolFeesCryptoBaseUnit, affiliateBps, } = input;
-    const slippageTolerancePercentageDecimal = input.slippageTolerancePercentageDecimal ??
-        (0, constants_1.getDefaultSlippageDecimalPercentageForSwapper)(types_2.SwapperName.CowSwap);
-    const assertion = (0, helpers_2.assertValidTrade)({
-        buyAsset,
-        sellAsset,
-        supportedChainIds: constants_2.SUPPORTED_CHAIN_IDS,
-    });
-    if (assertion.isErr())
-        return (0, monads_1.Err)(assertion.unwrapErr());
-    const buyToken = !(0, helpers_1.isNativeEvmAsset)(buyAsset.assetId)
-        ? (0, caip_1.fromAssetId)(buyAsset.assetId).assetReference
-        : constants_2.COW_SWAP_NATIVE_ASSET_MARKER_ADDRESS;
-    const maybeNetwork = (0, cowswap_utils_1.getCowNetwork)(chainId);
-    if (!maybeNetwork)
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-            message: `[CowSwap: getCowSwapTradeQuote] - Unsupported chainId`,
-            code: types_2.TradeQuoteError.UnsupportedChain,
-            details: { chainId },
-        }));
-    const network = maybeNetwork;
-    const affiliateAppDataFragment = (0, cowswap_utils_1.getAffiliateAppDataFragmentByChainId)({
-        affiliateBps,
-        chainId: sellAsset.chainId,
-    });
-    const { appData, appDataHash } = await (0, cowswap_utils_1.getFullAppData)(slippageTolerancePercentageDecimal, affiliateAppDataFragment, 'market');
-    // https://api.cow.fi/docs/#/default/post_api_v1_quote
-    const maybeQuoteResponse = await cowService_1.cowService.post(`${config.VITE_COWSWAP_BASE_URL}/${network}/api/v1/quote`, {
-        sellToken: (0, caip_1.fromAssetId)(sellAsset.assetId).assetReference,
-        buyToken,
-        receiver: receiveAddress,
-        validTo: (0, helpers_2.getNowPlusThirtyMinutesTimestamp)(),
-        appData,
-        appDataHash,
-        partiallyFillable: false,
-        from: receiveAddress ?? viem_1.zeroAddress,
-        kind: types_1.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 (0, monads_1.Err)((0, utils_2.createTradeAmountTooSmallErr)({
-                assetId: sellAsset.assetId,
-                minAmountCryptoBaseUnit: (0, utils_1.bn)((errData?.data).fee_amount ?? '0x0', 16).toFixed(),
-            }));
-        }
-        return (0, monads_1.Err)(maybeQuoteResponse.unwrapErr());
-    }
-    const { data: cowswapQuoteResponse } = maybeQuoteResponse.unwrap();
-    const { feeAmount: feeAmountInSellTokenCryptoBaseUnit } = cowswapQuoteResponse.quote;
-    const { buyAmountAfterFeesCryptoBaseUnit, buyAmountBeforeFeesCryptoBaseUnit } = (0, helpers_2.getValuesFromQuoteResponse)({
-        buyAsset,
-        sellAsset,
-        response: cowswapQuoteResponse,
-        affiliateBps,
-        slippageTolerancePercentageDecimal,
+const utils_1 = require("../../../utils");
+const getCowSwapStepData_1 = require("../utils/getCowSwapStepData");
+const getCowSwapTradeContext_1 = require("../utils/getCowSwapTradeContext");
+const getCowSwapTradeQuote = async (input, deps) => {
+    const { accountNumber } = input;
+    const maybeAddresses = (0, utils_1.assertQuoteAddresses)(input);
+    if (maybeAddresses.isErr())
+        return (0, monads_1.Err)(maybeAddresses.unwrapErr());
+    const { sendAddress, receiveAddress } = maybeAddresses.unwrap();
+    const maybeContext = await (0, getCowSwapTradeContext_1.getCowSwapTradeContext)({
+        input,
+        deps,
+        senderAddress: sendAddress,
+        receiveAddress,
     });
-    const rate = (0, utils_2.getInputOutputRate)({
-        sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-        buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-        sellAsset,
-        buyAsset,
+    if (maybeContext.isErr())
+        return (0, monads_1.Err)(maybeContext.unwrapErr());
+    const { tradeCommon, stepCommon, protocolFees, stepDataArgs } = maybeContext.unwrap();
+    const maybeStepData = (0, getCowSwapStepData_1.getCowSwapStepData)({
+        ...stepDataArgs,
+        type: 'quote',
+        input,
+        from: sendAddress,
     });
-    const id = cowswapQuoteResponse.id?.toString();
-    if (!id) {
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-            message: `[CowSwap: getCowSwapTradeQuote] - missing quote ID`,
-            code: types_2.TradeQuoteError.InvalidResponse,
-        }));
-    }
-    const quote = {
-        id,
+    if (maybeStepData.isErr())
+        return (0, monads_1.Err)(maybeStepData.unwrapErr());
+    const { transactionData, networkFeeCryptoBaseUnit } = maybeStepData.unwrap();
+    const tradeQuote = {
+        ...tradeCommon,
         quoteOrRate: 'quote',
+        deadline: stepDataArgs.cowswapQuoteResponse.quote.validTo * 1000,
         receiveAddress,
-        affiliateBps,
-        rate,
-        slippageTolerancePercentageDecimal,
-        swapperName: types_2.SwapperName.CowSwap,
         steps: [
             {
-                estimatedExecutionTimeMs: undefined,
-                allowanceContract: constants_2.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: types_2.SwapperName.CowSwap,
-                affiliateFee: (0, affiliateFee_1.buildAffiliateFee)({
-                    strategy: 'buy_asset',
-                    affiliateBps,
-                    sellAsset,
-                    buyAsset,
-                    sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                    buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-                    isEstimate: true,
-                }),
-                buyAsset,
-                sellAsset,
+                ...stepCommon,
                 accountNumber,
-                cowswapQuoteResponse,
+                feeData: { networkFeeCryptoBaseUnit, protocolFees },
+                transactionData,
             },
         ],
     };
-    return (0, monads_1.Ok)(quote);
-}
+    return (0, monads_1.Ok)([tradeQuote]);
+};
 exports.getCowSwapTradeQuote = getCowSwapTradeQuote;

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

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

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

@@ -1,136 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCowSwapTradeRate = void 0;
-const caip_1 = require("@shapeshiftoss/caip");
-const types_1 = require("@shapeshiftoss/types");
-const utils_1 = require("@shapeshiftoss/utils");
 const monads_1 = require("@sniptt/monads");
 const viem_1 = require("viem");
-const constants_1 = require("../../../constants");
-const cowswap_utils_1 = require("../../../cowswap-utils");
-const constants_2 = require("../../../cowswap-utils/constants");
-const types_2 = require("../../../types");
-const utils_2 = require("../../../utils");
-const affiliateFee_1 = require("../../utils/affiliateFee");
-const helpers_1 = require("../../utils/helpers/helpers");
-const cowService_1 = require("../utils/cowService");
-const helpers_2 = require("../utils/helpers/helpers");
-async function getCowSwapTradeRate(input, config) {
-    const { sellAsset, buyAsset, accountNumber, chainId, receiveAddress, sellAmountIncludingProtocolFeesCryptoBaseUnit, affiliateBps, } = input;
-    const slippageTolerancePercentageDecimal = input.slippageTolerancePercentageDecimal ??
-        (0, constants_1.getDefaultSlippageDecimalPercentageForSwapper)(types_2.SwapperName.CowSwap);
-    const assertion = (0, helpers_2.assertValidTrade)({
-        buyAsset,
-        sellAsset,
-        supportedChainIds: constants_2.SUPPORTED_CHAIN_IDS,
-    });
-    if (assertion.isErr())
-        return (0, monads_1.Err)(assertion.unwrapErr());
-    const buyToken = !(0, helpers_1.isNativeEvmAsset)(buyAsset.assetId)
-        ? (0, caip_1.fromAssetId)(buyAsset.assetId).assetReference
-        : constants_2.COW_SWAP_NATIVE_ASSET_MARKER_ADDRESS;
-    const maybeNetwork = (0, cowswap_utils_1.getCowNetwork)(chainId);
-    if (!maybeNetwork)
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-            message: `[CowSwap: getCowSwapTradeRate] - Unsupported chainId`,
-            code: types_2.TradeQuoteError.UnsupportedChain,
-            details: { chainId },
-        }));
-    const network = maybeNetwork;
-    const affiliateAppDataFragment = (0, cowswap_utils_1.getAffiliateAppDataFragmentByChainId)({
-        affiliateBps,
-        chainId: sellAsset.chainId,
-    });
-    const { appData, appDataHash } = await (0, cowswap_utils_1.getFullAppData)(slippageTolerancePercentageDecimal, affiliateAppDataFragment, 'market');
-    // https://api.cow.fi/docs/#/default/post_api_v1_quote
-    const maybeQuoteResponse = await cowService_1.cowService.post(`${config.VITE_COWSWAP_BASE_URL}/${network}/api/v1/quote`, {
-        sellToken: (0, caip_1.fromAssetId)(sellAsset.assetId).assetReference,
-        buyToken,
-        receiver: receiveAddress,
-        validTo: (0, helpers_2.getNowPlusThirtyMinutesTimestamp)(),
-        appData,
-        appDataHash,
-        partiallyFillable: false,
-        from: viem_1.zeroAddress,
-        kind: types_1.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 (0, monads_1.Err)((0, utils_2.createTradeAmountTooSmallErr)({
-                assetId: sellAsset.assetId,
-                minAmountCryptoBaseUnit: (0, utils_1.bn)((errData?.data).fee_amount ?? '0x0', 16).toFixed(),
-            }));
-        }
-        return (0, monads_1.Err)(maybeQuoteResponse.unwrapErr());
-    }
-    const { data: cowswapQuoteResponse } = maybeQuoteResponse.unwrap();
-    const { feeAmount: feeAmountInSellTokenCryptoBaseUnit } = cowswapQuoteResponse.quote;
-    const { buyAmountAfterFeesCryptoBaseUnit, buyAmountBeforeFeesCryptoBaseUnit } = (0, helpers_2.getValuesFromQuoteResponse)({
-        buyAsset,
-        sellAsset,
-        response: cowswapQuoteResponse,
-        affiliateBps,
-        slippageTolerancePercentageDecimal,
-    });
-    const rate = (0, utils_2.getInputOutputRate)({
-        sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-        buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-        sellAsset,
-        buyAsset,
+const getCowSwapStepData_1 = require("../utils/getCowSwapStepData");
+const getCowSwapTradeContext_1 = require("../utils/getCowSwapTradeContext");
+const getCowSwapTradeRate = async (input, deps) => {
+    const { accountNumber, receiveAddress } = input;
+    const maybeContext = await (0, getCowSwapTradeContext_1.getCowSwapTradeContext)({
+        input,
+        deps,
+        // The signer is only known at execution - the CoW quote is simulated from the zero address
+        senderAddress: viem_1.zeroAddress,
+        receiveAddress,
     });
-    const id = cowswapQuoteResponse.id?.toString();
-    if (!id) {
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-            message: `[CowSwap: getCowSwapTradeRate] - missing quote ID`,
-            code: types_2.TradeQuoteError.InvalidResponse,
-        }));
-    }
-    const quote = {
-        id,
+    if (maybeContext.isErr())
+        return (0, monads_1.Err)(maybeContext.unwrapErr());
+    const { tradeCommon, stepCommon, protocolFees, stepDataArgs } = maybeContext.unwrap();
+    const maybeStepData = (0, getCowSwapStepData_1.getCowSwapStepData)({ ...stepDataArgs, type: 'rate', input });
+    if (maybeStepData.isErr())
+        return (0, monads_1.Err)(maybeStepData.unwrapErr());
+    const { networkFeeCryptoBaseUnit } = maybeStepData.unwrap();
+    const tradeRate = {
+        ...tradeCommon,
         quoteOrRate: 'rate',
         receiveAddress,
-        affiliateBps,
-        rate,
-        slippageTolerancePercentageDecimal,
-        swapperName: types_2.SwapperName.CowSwap,
         steps: [
             {
-                estimatedExecutionTimeMs: undefined,
-                allowanceContract: constants_2.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: types_2.SwapperName.CowSwap,
-                affiliateFee: (0, affiliateFee_1.buildAffiliateFee)({
-                    strategy: 'buy_asset',
-                    affiliateBps,
-                    sellAsset,
-                    buyAsset,
-                    sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                    buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-                }),
-                buyAsset,
-                sellAsset,
+                ...stepCommon,
                 accountNumber,
+                feeData: { networkFeeCryptoBaseUnit, protocolFees },
             },
         ],
     };
-    return (0, monads_1.Ok)(quote);
-}
+    return (0, monads_1.Ok)([tradeRate]);
+};
 exports.getCowSwapTradeRate = getCowSwapTradeRate;

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

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

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

@@ -14,4 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.cowSwapper = exports.cowApi = void 0;
 __exportStar(require("./types"), exports);
+var endpoints_1 = require("./endpoints");
+Object.defineProperty(exports, "cowApi", { enumerable: true, get: function () { return endpoints_1.cowApi; } });
+var CowSwapper_1 = require("./CowSwapper");
+Object.defineProperty(exports, "cowSwapper", { enumerable: true, get: function () { return CowSwapper_1.cowSwapper; } });

package/dist/cjs/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';
+export type CowSwapTradeQuoteInput = GetEvmTradeQuoteInput;
+export type CowSwapTradeRateInput = GetEvmTradeRateInput;
 export type CowSwapGetTradesResponse = {
     txHash: string;
 }[];

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

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCowSwapStepData = void 0;
+const types_1 = require("@shapeshiftoss/types");
+const utils_1 = require("@shapeshiftoss/utils");
+const monads_1 = require("@sniptt/monads");
+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 (0, monads_1.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 = (0, utils_1.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: types_1.SellTokenSource.ERC20,
+        buyTokenBalance: types_1.BuyTokenDestination.ERC20,
+        quoteId: id,
+        appDataHash,
+        signingScheme: types_1.SigningScheme.EIP712,
+    };
+    const transactionData = {
+        type: 'cowswap',
+        chainId: sellAsset.chainId,
+        orderToSign,
+    };
+    const stepData = { transactionData, networkFeeCryptoBaseUnit: '0' };
+    return (0, monads_1.Ok)(stepData);
+}
+exports.getCowSwapStepData = getCowSwapStepData;