@shapeshiftoss/swapper 17.8.0 → 19.0.0

package/dist/esm/swappers/ChainflipSwapper/utils/getChainflipStepData.js

@@ -0,0 +1,182 @@
+import { CHAIN_NAMESPACE, fromAssetId, fromChainId } from '@shapeshiftoss/caip';
+import { evm } from '@shapeshiftoss/chain-adapters';
+import { bn, contractAddressOrUndefined } from '@shapeshiftoss/utils';
+import { Err, Ok } from '@sniptt/monads';
+import { TradeQuoteError } from '../../../types.js';
+import { makeNetworkFeeEstimationFailedErr, makeSwapErrorRight } from '../../../utils/index.js';
+import { getEvmNetworkFeeCryptoBaseUnit } from '../../../utils/evm/index.js';
+import { isNativeEvmAsset } from '../../../utils/helpers.js';
+import { ATA_RENT_LAMPORTS, getSolanaNetworkFeeCryptoBaseUnit, SOLANA_PLACEHOLDER_ADDRESS, withComputeUnitLimit, } from '../../../utils/solana/index.js';
+import { getUtxoNetworkFeeCryptoBaseUnit, UTXO_PLACEHOLDER_ADDRESS } from '../../../utils/utxo/index.js';
+// Deposits are plain transfers - 21k intrinsic for natives, tokens measured ~50-65k to a fresh
+// deposit address across the supported set (usdc/usdt/flip)
+const SAFE_NATIVE_TRANSFER_GAS_LIMIT = '21000';
+const SAFE_TOKEN_TRANSFER_GAS_LIMIT = '65000';
+// Deposits are plain (token) transfers with constant measured compute consumption (max 15394 CU
+// with ata creation), so the margin is safety only; the floor guarantees the limit covers full
+// ata recreation if the deposit ata is closed between simulation and landing (a no-op create
+// simulates ~3x cheaper than a real one)
+export const CHAINFLIP_SOLANA_COMPUTE_BUDGET = {
+    marginMultiplier: 1.1,
+    minComputeUnits: 20_000,
+};
+export async function getChainflipStepData(args) {
+    const { deps, type, input, sellAsset, sellAmountCryptoBaseUnit, depositAddress, from } = args;
+    const { chainNamespace } = fromAssetId(sellAsset.assetId);
+    switch (chainNamespace) {
+        case CHAIN_NAMESPACE.Evm: {
+            const adapter = deps.assertGetEvmChainAdapter(sellAsset.chainId);
+            const supportsEIP1559 = 'supportsEIP1559' in input ? input.supportsEIP1559 : false;
+            if (type === 'rate') {
+                try {
+                    const networkFeeCryptoBaseUnit = await getEvmNetworkFeeCryptoBaseUnit({
+                        adapter,
+                        supportsEIP1559,
+                        gasLimit: isNativeEvmAsset(sellAsset.assetId)
+                            ? SAFE_NATIVE_TRANSFER_GAS_LIMIT
+                            : SAFE_TOKEN_TRANSFER_GAS_LIMIT,
+                    });
+                    const stepData = { networkFeeCryptoBaseUnit };
+                    return Ok(stepData);
+                }
+                catch (error) {
+                    return Err(makeNetworkFeeEstimationFailedErr('getChainflipStepData', error));
+                }
+            }
+            const contractAddress = contractAddressOrUndefined(sellAsset.assetId);
+            const data = evm.getErc20Data(depositAddress, sellAmountCryptoBaseUnit, contractAddress);
+            const transactionData = {
+                type: 'evm',
+                chainId: Number(fromChainId(sellAsset.chainId).chainReference),
+                to: contractAddress ?? depositAddress,
+                data: data || '0x',
+                value: isNativeEvmAsset(sellAsset.assetId) ? sellAmountCryptoBaseUnit : '0',
+            };
+            try {
+                // The deposit is a plain (token) transfer with no approval involved, but estimation
+                // still reverts for an unfunded sender - override the missing balance only
+                const networkFeeCryptoBaseUnit = await getEvmNetworkFeeCryptoBaseUnit({
+                    adapter,
+                    transactionData,
+                    from,
+                    supportsEIP1559,
+                    stateOverride: { sellAsset, sellAmountCryptoBaseUnit },
+                });
+                const stepData = { transactionData, networkFeeCryptoBaseUnit };
+                return Ok(stepData);
+            }
+            catch (error) {
+                return Err(makeNetworkFeeEstimationFailedErr('getChainflipStepData', error));
+            }
+        }
+        case CHAIN_NAMESPACE.Utxo: {
+            const adapter = deps.assertGetUtxoChainAdapter(sellAsset.chainId);
+            try {
+                const { networkFeeCryptoBaseUnit } = await getUtxoNetworkFeeCryptoBaseUnit({
+                    adapter,
+                    pubkey: 'xpub' in input ? input.xpub : undefined,
+                    to: depositAddress ?? UTXO_PLACEHOLDER_ADDRESS,
+                    value: sellAmountCryptoBaseUnit,
+                });
+                if (type === 'rate') {
+                    const stepData = { networkFeeCryptoBaseUnit };
+                    return Ok(stepData);
+                }
+                const transactionData = {
+                    type: 'utxo',
+                    to: depositAddress,
+                    value: sellAmountCryptoBaseUnit,
+                };
+                const stepData = { transactionData, networkFeeCryptoBaseUnit };
+                return Ok(stepData);
+            }
+            catch (error) {
+                return Err(makeNetworkFeeEstimationFailedErr('getChainflipStepData', error));
+            }
+        }
+        case CHAIN_NAMESPACE.Solana: {
+            const adapter = deps.assertGetSolanaChainAdapter(sellAsset.chainId);
+            const tokenId = contractAddressOrUndefined(sellAsset.assetId);
+            try {
+                if (type === 'rate') {
+                    // No deposit channel yet - estimate via a self transfer (placeholder sender when walletless),
+                    // plus static ATA rent for token sells since the transfer omits the deposit ATA creation
+                    const address = from ?? SOLANA_PLACEHOLDER_ADDRESS;
+                    const instructions = await adapter.buildTransferInstructions({
+                        from: address,
+                        to: address,
+                        tokenId: from ? tokenId : undefined,
+                        value: from ? sellAmountCryptoBaseUnit : '1',
+                    });
+                    const { networkFeeCryptoBaseUnit } = await getSolanaNetworkFeeCryptoBaseUnit({
+                        adapter,
+                        from: address,
+                        instructions,
+                        tokenId,
+                    });
+                    const stepData = {
+                        networkFeeCryptoBaseUnit: bn(networkFeeCryptoBaseUnit)
+                            .plus(tokenId ? ATA_RENT_LAMPORTS : 0)
+                            .toString(),
+                    };
+                    return Ok(stepData);
+                }
+                const instructions = await adapter.buildTransferInstructions({
+                    from,
+                    to: depositAddress,
+                    tokenId,
+                    value: sellAmountCryptoBaseUnit,
+                });
+                const { networkFeeCryptoBaseUnit, feeData, includeComputeBudget } = await getSolanaNetworkFeeCryptoBaseUnit({
+                    adapter,
+                    from,
+                    instructions,
+                    tokenId,
+                });
+                const transactionData = {
+                    type: 'solana_instructions',
+                    instructions: withComputeUnitLimit({
+                        instructions,
+                        computeUnits: feeData.chainSpecific.computeUnits,
+                        includeComputeBudget,
+                        computeBudget: CHAINFLIP_SOLANA_COMPUTE_BUDGET,
+                    }),
+                    addressLookupTableAddresses: [],
+                };
+                const stepData = { transactionData, networkFeeCryptoBaseUnit };
+                return Ok(stepData);
+            }
+            catch (error) {
+                return Err(makeNetworkFeeEstimationFailedErr('getChainflipStepData', error));
+            }
+        }
+        // Un-migrated - exec builds its tx from chainflipSpecific.depositAddress, so no transactionData is carried
+        case CHAIN_NAMESPACE.Tron: {
+            const to = depositAddress ?? from;
+            if (!to || !from) {
+                const stepData = { networkFeeCryptoBaseUnit: undefined };
+                return Ok(stepData);
+            }
+            try {
+                const { fast } = await deps.assertGetTronChainAdapter(sellAsset.chainId).getFeeData({
+                    to,
+                    value: sellAmountCryptoBaseUnit,
+                    chainSpecific: {
+                        from,
+                        contractAddress: contractAddressOrUndefined(sellAsset.assetId),
+                    },
+                });
+                const stepData = { networkFeeCryptoBaseUnit: fast.txFee };
+                return Ok(stepData);
+            }
+            catch (error) {
+                return Err(makeNetworkFeeEstimationFailedErr('getChainflipStepData', error));
+            }
+        }
+        default:
+            return Err(makeSwapErrorRight({
+                message: `[getChainflipStepData] unsupported chainNamespace: ${chainNamespace}`,
+                code: TradeQuoteError.UnsupportedChain,
+            }));
+    }
+}

package/dist/esm/swappers/ChainflipSwapper/utils/getChainflipTradeContexts.d.ts

@@ -0,0 +1,19 @@
+import type { Result } from '@sniptt/monads';
+import type { QuoteFeeData, SwapErrorRight, SwapperDeps, TradeCommon, TradeStepCommon } from '../../../types.js';
+import type { ChainflipTradeQuoteInput, ChainflipTradeRateInput } from '../types.js';
+import type { GetChainflipStepDataArgs } from './getChainflipStepData.js';
+export type ChainflipTradeContext = {
+    tradeCommon: TradeCommon;
+    stepCommon: Omit<TradeStepCommon, 'feeData'>;
+    protocolFees: QuoteFeeData['protocolFees'];
+    stepDataArgs: Omit<GetChainflipStepDataArgs, 'type' | 'input' | 'depositAddress' | 'from'>;
+    channelParams: {
+        sourceAsset: string;
+        destinationAsset: string;
+        maxBoostFee: number;
+        numberOfChunks: number | undefined;
+        chunkIntervalBlocks: number | undefined;
+        buyAmountAfterFeesCryptoBaseUnit: string;
+    };
+};
+export declare const getChainflipTradeContexts: (input: ChainflipTradeQuoteInput | ChainflipTradeRateInput, deps: SwapperDeps) => Promise<Result<ChainflipTradeContext[], SwapErrorRight>>;

package/dist/esm/swappers/ChainflipSwapper/utils/getChainflipTradeContexts.js

@@ -0,0 +1,137 @@
+import { BigAmount, 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 { createTradeAmountTooSmallErr, makeSwapErrorRight } from '../../../utils/index.js';
+import { buildAffiliateFee } from '../../../utils/affiliateFee.js';
+import { CHAINFLIP_DCA_QUOTE } from '../constants.js';
+import { chainflipService } from './chainflipService.js';
+import { assertValidTrade, getChainFlipIdFromAssetId, getChainflipRate, getMaxBoostFee, getProtocolFees, getSwapSource, } from './helpers.js';
+export const getChainflipTradeContexts = async (input, deps) => {
+    const brokerUrl = deps.config.VITE_CHAINFLIP_API_URL;
+    const apiKey = deps.config.VITE_CHAINFLIP_API_KEY;
+    const { sellAsset, buyAsset, sellAmountIncludingProtocolFeesCryptoBaseUnit, affiliateBps } = input;
+    const assertion = assertValidTrade({ sellAsset, buyAsset });
+    if (assertion.isErr())
+        return Err(assertion.unwrapErr());
+    const maybeSourceAsset = await getChainFlipIdFromAssetId({
+        assetId: sellAsset.assetId,
+        brokerUrl,
+    });
+    if (maybeSourceAsset.isErr())
+        return Err(maybeSourceAsset.unwrapErr());
+    const sourceAsset = maybeSourceAsset.unwrap();
+    const maybeDestinationAsset = await getChainFlipIdFromAssetId({
+        assetId: buyAsset.assetId,
+        brokerUrl,
+    });
+    if (maybeDestinationAsset.isErr())
+        return Err(maybeDestinationAsset.unwrapErr());
+    const destinationAsset = maybeDestinationAsset.unwrap();
+    const maybeQuoteResponse = await chainflipService.get(`${brokerUrl}/quotes-native` +
+        `?apiKey=${apiKey}` +
+        `&sourceAsset=${sourceAsset}` +
+        `&destinationAsset=${destinationAsset}` +
+        `&amount=${sellAmountIncludingProtocolFeesCryptoBaseUnit}` +
+        `&commissionBps=${parseInt(affiliateBps)}`);
+    if (maybeQuoteResponse.isErr()) {
+        const error = maybeQuoteResponse.unwrapErr();
+        const cause = error.cause;
+        const minAmountCryptoBaseUnit = cause?.response?.data?.errors?.minimalAmountNative?.[0];
+        if (cause?.response?.status === 400 && minAmountCryptoBaseUnit !== undefined) {
+            return Err(createTradeAmountTooSmallErr({ assetId: sellAsset.assetId, minAmountCryptoBaseUnit }));
+        }
+        return Err(makeSwapErrorRight({ message: 'Quote request failed', code: TradeQuoteError.NoRouteFound }));
+    }
+    const { data: quotes } = maybeQuoteResponse.unwrap();
+    const slippageTolerancePercentageDecimal = input.slippageTolerancePercentageDecimal ??
+        getDefaultSlippageDecimalPercentageForSwapper(SwapperName.Chainflip);
+    const tradeContexts = [];
+    for (const quote of quotes) {
+        if (!quote.type) {
+            return Err(makeSwapErrorRight({
+                message: '[getChainflipTradeContext] Missing quote type',
+                code: TradeQuoteError.InvalidResponse,
+            }));
+        }
+        const quoteType = quote.type;
+        const isStreaming = quoteType === CHAINFLIP_DCA_QUOTE;
+        if (isStreaming && !deps.config.VITE_FEATURE_CHAINFLIP_SWAP_DCA)
+            continue;
+        // estimatedPrice and type only exist on the parent quote, not the boost variant
+        const buildTradeContext = (variantQuote, isBoosted) => {
+            const rate = getChainflipRate({
+                sellAmountCryptoBaseUnit: variantQuote.ingressAmountNative,
+                buyAmountCryptoBaseUnit: variantQuote.egressAmountNative,
+                sellAsset,
+                buyAsset,
+            });
+            const buyAmountAfterFeesCryptoBaseUnit = variantQuote.egressAmountNative ?? '0';
+            const variantSellAmountCryptoBaseUnit = variantQuote.ingressAmountNative ?? '0';
+            const streamingChunkValue = (value) => isStreaming ? value ?? undefined : undefined;
+            const protocolFees = getProtocolFees({
+                quote: variantQuote,
+                sellAsset,
+                buyAsset,
+                sourceAsset,
+                destinationAsset,
+            });
+            return {
+                tradeCommon: {
+                    id: uuid(),
+                    rate,
+                    affiliateBps,
+                    isStreaming,
+                    slippageTolerancePercentageDecimal,
+                    swapperName: SwapperName.Chainflip,
+                },
+                stepCommon: {
+                    // Not a real pre-fee amount, but an input/output calc prorated to the buy asset price to determine price impact
+                    buyAmountBeforeFeesCryptoBaseUnit: BigAmount.fromPrecision({
+                        value: bnOrZero(variantQuote.ingressAmount).times(bnOrZero(quote.estimatedPrice)),
+                        precision: buyAsset.precision,
+                    }).toBaseUnit(),
+                    buyAmountAfterFeesCryptoBaseUnit,
+                    sellAmountIncludingProtocolFeesCryptoBaseUnit: variantSellAmountCryptoBaseUnit,
+                    rate,
+                    source: getSwapSource(quoteType, isBoosted),
+                    buyAsset,
+                    sellAsset,
+                    allowanceContract: '',
+                    estimatedExecutionTimeMs: ((variantQuote.estimatedDurationsSeconds?.deposit ?? 0) +
+                        (variantQuote.estimatedDurationsSeconds?.swap ?? 0)) *
+                        1000,
+                    affiliateFee: buildAffiliateFee({
+                        strategy: 'buy_asset',
+                        affiliateBps,
+                        sellAsset,
+                        buyAsset,
+                        sellAmountCryptoBaseUnit: variantSellAmountCryptoBaseUnit,
+                        buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
+                    }),
+                },
+                protocolFees,
+                stepDataArgs: {
+                    deps,
+                    sellAsset,
+                    sellAmountCryptoBaseUnit: variantSellAmountCryptoBaseUnit,
+                },
+                channelParams: {
+                    sourceAsset,
+                    destinationAsset,
+                    maxBoostFee: isBoosted ? getMaxBoostFee(sellAsset.assetId) : 0,
+                    numberOfChunks: streamingChunkValue(variantQuote.numberOfChunks),
+                    chunkIntervalBlocks: streamingChunkValue(variantQuote.chunkIntervalBlocks),
+                    buyAmountAfterFeesCryptoBaseUnit,
+                },
+            };
+        };
+        const { boostQuote } = quote;
+        if (boostQuote && boostQuote.ingressAmountNative && boostQuote.egressAmountNative) {
+            tradeContexts.push(buildTradeContext(boostQuote, true));
+        }
+        tradeContexts.push(buildTradeContext(quote, false));
+    }
+    return Ok(tradeContexts);
+};

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

@@ -2,8 +2,9 @@ import type { AssetId, ChainId } from '@shapeshiftoss/caip';
 import type { Asset } from '@shapeshiftoss/types';
 import type { Result } from '@sniptt/monads';
 import type { AxiosResponse } from 'axios';
-import type { SwapErrorRight } from '../../../types.js';
-import type { ChainflipBaasSwapDepositAddress } from '../models/index.js';
+import type { ProtocolFee, SwapErrorRight, SwapSource } from '../../../types.js';
+import { CHAINFLIP_DCA_QUOTE, CHAINFLIP_REGULAR_QUOTE } from '../constants.js';
+import type { ChainflipBaasQuoteQuote, ChainflipBaasSwapDepositAddress } from '../models/index.js';
 type ChainFlipBrokerBaseArgs = {
     brokerUrl: string;
     apiKey: string;
@@ -22,6 +23,10 @@ type GetChainFlipSwapArgs = ChainFlipBrokerBaseArgs & {
 };
 export declare const isSupportedChainId: (chainId: ChainId) => chainId is import("@shapeshiftoss/types").KnownChainIds.EthereumMainnet | import("@shapeshiftoss/types").KnownChainIds.ArbitrumMainnet | import("@shapeshiftoss/types").KnownChainIds.BitcoinMainnet | import("@shapeshiftoss/types").KnownChainIds.SolanaMainnet | import("@shapeshiftoss/types").KnownChainIds.TronMainnet;
 export declare const isSupportedAssetId: (chainId: ChainId, assetId: AssetId) => chainId is import("@shapeshiftoss/types").KnownChainIds.EthereumMainnet | import("@shapeshiftoss/types").KnownChainIds.ArbitrumMainnet | import("@shapeshiftoss/types").KnownChainIds.BitcoinMainnet | import("@shapeshiftoss/types").KnownChainIds.SolanaMainnet | import("@shapeshiftoss/types").KnownChainIds.TronMainnet;
+export declare const assertValidTrade: ({ sellAsset, buyAsset, }: {
+    sellAsset: Asset;
+    buyAsset: Asset;
+}) => Result<boolean, SwapErrorRight>;
 export declare const calculateChainflipMinPrice: ({ sellAmountIncludingProtocolFeesCryptoBaseUnit, buyAmountAfterFeesCryptoBaseUnit, slippageTolerancePercentageDecimal, sellAsset, buyAsset, }: {
     sellAmountIncludingProtocolFeesCryptoBaseUnit: string;
     buyAmountAfterFeesCryptoBaseUnit: string;
@@ -33,4 +38,19 @@ export declare const getChainFlipSwap: ({ brokerUrl, apiKey, sourceAsset, destin
 export declare const getChainFlipIdFromAssetId: ({ assetId, brokerUrl, }: Omit<ChainFlipBrokerBaseArgs, "apiKey"> & {
     assetId: AssetId;
 }) => Promise<Result<string, SwapErrorRight>>;
+export declare const getChainflipRate: ({ sellAmountCryptoBaseUnit, buyAmountCryptoBaseUnit, sellAsset, buyAsset, }: {
+    sellAmountCryptoBaseUnit: string | null | undefined;
+    buyAmountCryptoBaseUnit: string | null | undefined;
+    sellAsset: Asset;
+    buyAsset: Asset;
+}) => string;
+export declare const getSwapSource: (swapType: typeof CHAINFLIP_REGULAR_QUOTE | typeof CHAINFLIP_DCA_QUOTE, isBoosted: boolean) => SwapSource;
+export declare const getMaxBoostFee: (assetId: AssetId) => number;
+export declare const getProtocolFees: ({ quote, sellAsset, buyAsset, sourceAsset, destinationAsset, }: {
+    quote: ChainflipBaasQuoteQuote;
+    sellAsset: Asset;
+    buyAsset: Asset;
+    sourceAsset: string;
+    destinationAsset: string;
+}) => Record<AssetId, ProtocolFee>;
 export {};

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

@@ -1,9 +1,9 @@
-import { fromAssetId } from '@shapeshiftoss/caip';
-import { BigAmount, bn, bnOrZero, isToken } from '@shapeshiftoss/utils';
+import { CHAIN_NAMESPACE, fromAssetId } from '@shapeshiftoss/caip';
+import { assertUnreachable, BigAmount, bn, bnOrZero, isToken } from '@shapeshiftoss/utils';
 import { Err, Ok } from '@sniptt/monads';
 import { TradeQuoteError } from '../../../types.js';
-import { makeSwapErrorRight } from '../../../utils.js';
-import { ChainflipSupportedAssetIdsByChainId, ChainflipSupportedChainIds, chainIdToChainflipNetwork, } from '../constants.js';
+import { getInputOutputRate, makeSwapErrorRight } from '../../../utils/index.js';
+import { CHAINFLIP_BOOST_SWAP_SOURCE, CHAINFLIP_DCA_BOOST_SWAP_SOURCE, CHAINFLIP_DCA_QUOTE, CHAINFLIP_DCA_SWAP_SOURCE, CHAINFLIP_REGULAR_QUOTE, CHAINFLIP_SWAP_SOURCE, ChainflipSupportedAssetIdsByChainId, ChainflipSupportedChainIds, chainIdToChainflipNetwork, usdcAsset, } from '../constants.js';
 import { chainflipService } from './chainflipService.js';
 export const isSupportedChainId = (chainId) => {
     return ChainflipSupportedChainIds.includes(chainId);
@@ -14,6 +14,37 @@ export const isSupportedAssetId = (chainId, assetId) => {
         return false;
     return supportedAssetIds.includes(assetId);
 };
+export const assertValidTrade = ({ sellAsset, buyAsset, }) => {
+    if (!isSupportedChainId(sellAsset.chainId)) {
+        return Err(makeSwapErrorRight({
+            message: `unsupported chainId`,
+            code: TradeQuoteError.UnsupportedChain,
+            details: { chainId: sellAsset.chainId },
+        }));
+    }
+    if (!isSupportedChainId(buyAsset.chainId)) {
+        return Err(makeSwapErrorRight({
+            message: `unsupported chainId`,
+            code: TradeQuoteError.UnsupportedChain,
+            details: { chainId: buyAsset.chainId },
+        }));
+    }
+    if (!isSupportedAssetId(sellAsset.chainId, sellAsset.assetId)) {
+        return Err(makeSwapErrorRight({
+            message: `asset '${sellAsset.name}' on chainId '${sellAsset.chainId}' not supported`,
+            code: TradeQuoteError.UnsupportedTradePair,
+            details: { chainId: sellAsset.chainId, assetId: sellAsset.assetId },
+        }));
+    }
+    if (!isSupportedAssetId(buyAsset.chainId, buyAsset.assetId)) {
+        return Err(makeSwapErrorRight({
+            message: `asset '${buyAsset.name}' on chainId '${buyAsset.chainId}' not supported`,
+            code: TradeQuoteError.UnsupportedTradePair,
+            details: { chainId: buyAsset.chainId, assetId: buyAsset.assetId },
+        }));
+    }
+    return Ok(true);
+};
 export const calculateChainflipMinPrice = ({ sellAmountIncludingProtocolFeesCryptoBaseUnit, buyAmountAfterFeesCryptoBaseUnit, slippageTolerancePercentageDecimal, sellAsset, buyAsset, }) => {
     const sellAmountCryptoPrecision = BigAmount.fromBaseUnit({
         value: sellAmountIncludingProtocolFeesCryptoBaseUnit,
@@ -81,3 +112,67 @@ export const getChainFlipIdFromAssetId = async ({ assetId, brokerUrl, }) => {
         }));
     return Ok(chainflipAsset.id);
 };
+export const getChainflipRate = ({ sellAmountCryptoBaseUnit, buyAmountCryptoBaseUnit, sellAsset, buyAsset, }) => {
+    if (!sellAmountCryptoBaseUnit || !buyAmountCryptoBaseUnit)
+        return '0';
+    return getInputOutputRate({
+        sellAmountCryptoBaseUnit,
+        buyAmountCryptoBaseUnit,
+        sellAsset,
+        buyAsset,
+    });
+};
+export const getSwapSource = (swapType, isBoosted) => {
+    if (swapType === CHAINFLIP_REGULAR_QUOTE) {
+        return isBoosted ? CHAINFLIP_BOOST_SWAP_SOURCE : CHAINFLIP_SWAP_SOURCE;
+    }
+    if (swapType === CHAINFLIP_DCA_QUOTE) {
+        return isBoosted ? CHAINFLIP_DCA_BOOST_SWAP_SOURCE : CHAINFLIP_DCA_SWAP_SOURCE;
+    }
+    return assertUnreachable(swapType);
+};
+export const getMaxBoostFee = (assetId) => {
+    const { chainNamespace } = fromAssetId(assetId);
+    switch (chainNamespace) {
+        case CHAIN_NAMESPACE.Utxo:
+            return 10;
+        case CHAIN_NAMESPACE.Evm:
+        case CHAIN_NAMESPACE.Solana:
+        case CHAIN_NAMESPACE.Tron:
+            return 0;
+        default:
+            throw new Error('Unsupported chainNamespace');
+    }
+};
+export const getProtocolFees = ({ quote, sellAsset, buyAsset, sourceAsset, destinationAsset, }) => {
+    const protocolFees = {};
+    for (const fee of quote.includedFees ?? []) {
+        if (fee.type === 'broker')
+            continue;
+        const asset = (() => {
+            if (fee.type === 'ingress' || fee.type === 'boost')
+                return sellAsset;
+            if (fee.type === 'egress')
+                return buyAsset;
+            if (fee.type === 'liquidity' && fee.asset === sourceAsset)
+                return sellAsset;
+            if (fee.type === 'liquidity' && fee.asset === destinationAsset)
+                return buyAsset;
+            if (fee.type === 'liquidity' && fee.asset === 'usdc.eth')
+                return usdcAsset;
+            if (fee.type === 'network')
+                return usdcAsset;
+        })();
+        if (!asset)
+            continue;
+        if (!(asset.assetId in protocolFees)) {
+            protocolFees[asset.assetId] = {
+                amountCryptoBaseUnit: '0',
+                requiresBalance: false,
+                asset,
+            };
+        }
+        protocolFees[asset.assetId].amountCryptoBaseUnit = (BigInt(protocolFees[asset.assetId].amountCryptoBaseUnit) + BigInt(fee.amountNative ?? '0')).toString();
+    }
+    return protocolFees;
+};

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

@@ -1,5 +1,5 @@
 import { SigningScheme } from '@shapeshiftoss/types';
-import { assertGetCowNetwork, signCowOrder } from '../../cowswap-utils/index.js';
+import { assertGetCowNetwork, signCowOrder } from '../../utils/cowswap/index.js';
 import { cowService } from './utils/cowService.js';
 export const cowSwapper = {
     executeEvmMessage: async ({ chainId, orderToSign }, { signMessage }, config) => {

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>>;