@shapeshiftoss/swapper 20.0.0 → 20.1.1

package/dist/cjs/swappers/PortalsSwapper/utils/getPortalsStepData.js

@@ -2,8 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPortalsStepData = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
+const utils_1 = require("@shapeshiftoss/utils");
 const monads_1 = require("@sniptt/monads");
-const utils_1 = require("../../../utils");
+const utils_2 = require("../../../utils");
 const evm_1 = require("../../../utils/evm");
 const fetchPortalsTradeOrder_1 = require("./fetchPortalsTradeOrder");
 async function getPortalsStepData(args) {
@@ -13,7 +14,7 @@ async function getPortalsStepData(args) {
     if (args.type === 'rate') {
         try {
             // No placeholder estimation for provider built routes - overridden estimation (approval
-            // state need not exist yet) with the Portals estimate endpoint as fallback
+            // state need not exist yet) with the Portals order and estimate endpoint as fallbacks
             const gasLimit = await (async () => {
                 try {
                     const gasLimit = await (0, evm_1.estimateGasWithStateOverride)({
@@ -28,6 +29,10 @@ async function getPortalsStepData(args) {
                     return gasLimit;
                 }
                 catch {
+                    // Portals only carry a tx gas limit on the bridge routes their estimate endpoint zeroes
+                    const { gasLimit: txGasLimit } = tx;
+                    if (txGasLimit && (0, utils_1.bnOrZero)(txGasLimit).gt(0))
+                        return txGasLimit;
                     const quoteEstimateResponse = await (0, fetchPortalsTradeOrder_1.fetchPortalsTradeEstimate)({
                         inputToken: args.inputToken,
                         outputToken: args.outputToken,
@@ -35,7 +40,10 @@ async function getPortalsStepData(args) {
                         slippageTolerancePercentage: args.slippageTolerancePercentage,
                         swapperConfig: deps.config,
                     });
-                    return quoteEstimateResponse.context.gasLimit.toString();
+                    const estimatedGasLimit = quoteEstimateResponse.context.gasLimit.toString();
+                    if ((0, utils_1.bnOrZero)(estimatedGasLimit).lte(0))
+                        throw new Error('no Portals gas limit');
+                    return estimatedGasLimit;
                 }
             })();
             const networkFeeCryptoBaseUnit = await (0, evm_1.getEvmNetworkFeeCryptoBaseUnit)({
@@ -47,7 +55,7 @@ async function getPortalsStepData(args) {
             return (0, monads_1.Ok)(stepData);
         }
         catch (error) {
-            return (0, monads_1.Err)((0, utils_1.makeNetworkFeeEstimationFailedErr)('getPortalsStepData', error));
+            return (0, monads_1.Err)((0, utils_2.makeNetworkFeeEstimationFailedErr)('getPortalsStepData', error));
         }
     }
     const transactionData = {
@@ -76,7 +84,7 @@ async function getPortalsStepData(args) {
         return (0, monads_1.Ok)(stepData);
     }
     catch (error) {
-        return (0, monads_1.Err)((0, utils_1.makeNetworkFeeEstimationFailedErr)('getPortalsStepData', error));
+        return (0, monads_1.Err)((0, utils_2.makeNetworkFeeEstimationFailedErr)('getPortalsStepData', error));
     }
 }
 exports.getPortalsStepData = getPortalsStepData;

package/dist/cjs/swappers/PortalsSwapper/utils/getPortalsStepData.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/swappers/PortalsSwapper/utils/getPortalsStepData.test.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const evm_1 = require("../../../utils/evm");
+const assets_1 = require("../../../utils/test-data/assets");
+const fetchPortalsTradeOrder_1 = require("./fetchPortalsTradeOrder");
+const getPortalsStepData_1 = require("./getPortalsStepData");
+vitest_1.vi.mock('../../../utils/evm', async (importOriginal) => ({
+    ...(await importOriginal()),
+    estimateGasWithStateOverride: vitest_1.vi.fn(),
+}));
+vitest_1.vi.mock('./fetchPortalsTradeOrder', async (importOriginal) => ({
+    ...(await importOriginal()),
+    fetchPortalsTradeEstimate: vitest_1.vi.fn(),
+}));
+const GAS_PRICE = '1000000000';
+const deps = {
+    assertGetEvmChainAdapter: () => ({
+        getGasFeeData: () => Promise.resolve({
+            average: { gasPrice: GAS_PRICE, maxFeePerGas: '0', maxPriorityFeePerGas: '0' },
+        }),
+    }),
+    config: {},
+};
+const tx = (gasLimit) => ({
+    to: '0x4cd00e387622c35bddb9b4c962c136462338bc31',
+    from: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045',
+    data: '0xdeadbeef',
+    value: '0',
+    gasLimit,
+});
+const rate = (portalsTx) => (0, getPortalsStepData_1.getPortalsStepData)({
+    type: 'rate',
+    input: { supportsEIP1559: false },
+    deps,
+    tx: portalsTx,
+    sellAsset: assets_1.USDC_MAINNET,
+    sellAmountCryptoBaseUnit: '1000000000',
+    spenderAddress: '0x4cd00e387622c35bddb9b4c962c136462338bc31',
+    inputToken: 'ethereum:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+    outputToken: 'arbitrum:0xaf88d065e77c8cc2239327c5edb3a432268e5831',
+    inputAmount: '1000000000',
+    slippageTolerancePercentage: 2.5,
+});
+const estimateEndpointGasLimit = (gasLimit) => vitest_1.vi.mocked(fetchPortalsTradeOrder_1.fetchPortalsTradeEstimate).mockResolvedValue({
+    context: { gasLimit },
+});
+(0, vitest_1.describe)('getPortalsStepData rate gas limit', () => {
+    (0, vitest_1.beforeEach)(() => vitest_1.vi.clearAllMocks());
+    (0, vitest_1.it)('falls back to the order gas limit on bridge routes the estimate endpoint zeroes', async () => {
+        vitest_1.vi.mocked(evm_1.estimateGasWithStateOverride).mockRejectedValue(new Error('execution reverted'));
+        estimateEndpointGasLimit(0);
+        const actual = await rate(tx('76384'));
+        (0, vitest_1.expect)(actual.unwrap()).toEqual({ networkFeeCryptoBaseUnit: '76384000000000' });
+        (0, vitest_1.expect)(fetchPortalsTradeOrder_1.fetchPortalsTradeEstimate).not.toHaveBeenCalled();
+    });
+    (0, vitest_1.it)('falls back to the estimate endpoint when the order carries no gas limit', async () => {
+        vitest_1.vi.mocked(evm_1.estimateGasWithStateOverride).mockRejectedValue(new Error('execution reverted'));
+        estimateEndpointGasLimit(273203);
+        const actual = await rate(tx(undefined));
+        (0, vitest_1.expect)(actual.unwrap()).toEqual({ networkFeeCryptoBaseUnit: '273203000000000' });
+    });
+    (0, vitest_1.it)('errors rather than pricing a zero gas limit as a free trade', async () => {
+        vitest_1.vi.mocked(evm_1.estimateGasWithStateOverride).mockRejectedValue(new Error('execution reverted'));
+        estimateEndpointGasLimit(0);
+        const actual = await rate(tx(undefined));
+        (0, vitest_1.expect)(actual.isErr()).toBe(true);
+        (0, vitest_1.expect)(actual.unwrapErr().message).toContain('getPortalsStepData');
+    });
+});

package/dist/cjs/swappers/PortalsSwapper/utils/getPortalsTradeContext.d.ts

@@ -15,12 +15,12 @@ type PortalsTradeContext = {
         tx: PortalsTx;
     };
 };
-export declare const getPortalsTradeContext: ({ input, deps, sellChainId, inputToken, orderContext, tx, }: {
+export declare const getPortalsTradeContext: ({ input, deps, sellChainId, orderContext, outputToken, tx, }: {
     input: PortalsTradeQuoteInput | PortalsTradeRateInput;
     deps: SwapperDeps;
     sellChainId: PortalsSupportedChainId;
-    inputToken: string;
     orderContext: PortalsTradeOrderResponse['context'];
+    outputToken: string;
     tx: PortalsTx;
 }) => Result<PortalsTradeContext, SwapErrorRight>;
 export {};

package/dist/cjs/swappers/PortalsSwapper/utils/getPortalsTradeContext.js

@@ -7,11 +7,26 @@ const types_1 = require("../../../types");
 const utils_2 = require("../../../utils");
 const affiliateFee_1 = require("../../../utils/affiliateFee");
 const helpers_1 = require("./helpers");
-const getPortalsTradeContext = ({ input, deps, sellChainId, inputToken, orderContext, tx, }) => {
-    const { sellAsset, buyAsset, affiliateBps, sellAmountIncludingProtocolFeesCryptoBaseUnit } = input;
-    const { orderId, outputAmount, minOutputAmount, target, feeAmount, feeToken } = orderContext;
+const getPortalsTradeContext = ({ input, deps, sellChainId, orderContext, outputToken, tx, }) => {
+    const { sellAsset, buyAsset, affiliateBps } = input;
+    const { orderId, inputAmount, outputAmount, minOutputAmount, target, feeAmount, feeToken, slippageTolerancePercentage, } = orderContext;
+    // Portals can fill less than we asked for - price against what the transaction actually spends
+    const sellAmountIncludingProtocolFeesCryptoBaseUnit = inputAmount;
     const isCrossChain = sellAsset.chainId !== buyAsset.chainId;
-    const buyAmountAfterFeesCryptoBaseUnit = isCrossChain ? minOutputAmount : outputAmount;
+    // Portals report the slippage they applied, not the one we requested - bridge routes apply none
+    const appliedSlippageDecimal = (0, utils_1.bnOrZero)(slippageTolerancePercentage).div(100);
+    // Unvalidated orders report the post-slippage minimum in both amount fields
+    const hasSlippageBuffer = (0, utils_1.bnOrZero)(outputAmount).gt(minOutputAmount);
+    const preSlippageOutputAmount = (0, utils_1.bnOrZero)(minOutputAmount)
+        .div((0, utils_1.bn)(1).minus(appliedSlippageDecimal))
+        .toFixed(0);
+    const buyAmountAfterFeesCryptoBaseUnit = hasSlippageBuffer
+        ? outputAmount
+        : preSlippageOutputAmount;
+    const bufferSlippageDecimal = hasSlippageBuffer
+        ? (0, utils_1.bnOrZero)(outputAmount).minus(minOutputAmount).div(outputAmount)
+        : appliedSlippageDecimal;
+    const slippageTolerancePercentageDecimal = utils_1.BigNumber.max(appliedSlippageDecimal, bufferSlippageDecimal).toString();
     const rate = (0, utils_2.getInputOutputRate)({
         sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
         buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
@@ -27,16 +42,13 @@ const getPortalsTradeContext = ({ input, deps, sellChainId, inputToken, orderCon
             details: { chainId: sellChainId },
         }));
     }
-    // Portals reports the slippage we requested, not what it applied — recover the actual buffer from the amounts
-    const actualBufferDecimal = (0, utils_1.bnOrZero)(buyAmountAfterFeesCryptoBaseUnit)
-        .minus(minOutputAmount)
-        .div(buyAmountAfterFeesCryptoBaseUnit)
-        .toString();
-    // Reverse the buffer to recover the expected output (minOutput / (1 - buffer) = output)
-    const buyAmountBeforeFeesCryptoBaseUnit = (0, utils_1.bnOrZero)(minOutputAmount)
-        .div((0, utils_1.bn)(1).minus(actualBufferDecimal))
-        .toFixed(0);
-    const protocolFeeAsset = feeToken === inputToken ? sellAsset : buyAsset;
+    // Portals lower-case echoed tokens, and take their fee in the sell asset on ERC20 sells
+    const isBuyAssetFee = feeToken?.toLowerCase() === outputToken.toLowerCase();
+    const protocolFeeAsset = isBuyAssetFee ? buyAsset : sellAsset;
+    // Portals report an output already net of their fee
+    const buyAmountBeforeFeesCryptoBaseUnit = isBuyAssetFee && feeAmount
+        ? (0, utils_1.bnOrZero)(buyAmountAfterFeesCryptoBaseUnit).plus(feeAmount).toFixed(0)
+        : buyAmountAfterFeesCryptoBaseUnit;
     const protocolFees = (() => {
         if (!feeToken || !feeAmount)
             return;
@@ -54,7 +66,7 @@ const getPortalsTradeContext = ({ input, deps, sellChainId, inputToken, orderCon
             rate,
             swapperName: types_1.SwapperName.Portals,
             affiliateBps,
-            slippageTolerancePercentageDecimal: actualBufferDecimal,
+            slippageTolerancePercentageDecimal,
         },
         stepCommon: {
             estimatedExecutionTimeMs: isCrossChain ? 300000 : 0,

package/dist/cjs/swappers/PortalsSwapper/utils/getPortalsTradeContext.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/swappers/PortalsSwapper/utils/getPortalsTradeContext.test.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const assets_1 = require("../../../utils/test-data/assets");
+const getPortalsTradeContext_1 = require("./getPortalsTradeContext");
+const deps = {};
+const tx = {
+    to: '0x4cd00e387622c35bddb9b4c962c136462338bc31',
+    from: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045',
+    data: '0xdeadbeef',
+    value: '0',
+};
+const makeInput = (buyAsset = assets_1.USDC_ARBITRUM) => ({
+    sellAsset: assets_1.USDC_MAINNET,
+    buyAsset,
+    affiliateBps: '0',
+    sellAmountIncludingProtocolFeesCryptoBaseUnit: '4631313795',
+});
+const makeOrderContext = (overrides) => ({
+    orderId: 'eaae8ea5-30af-4463-97ab-1c5b1fe7def4',
+    target: '0x4cd00e387622c35bddb9b4c962c136462338bc31',
+    inputAmount: '4631313795',
+    ...overrides,
+});
+const unwrap = (args) => (0, getPortalsTradeContext_1.getPortalsTradeContext)(args).unwrap();
+(0, vitest_1.describe)('getPortalsTradeContext', () => {
+    (0, vitest_1.it)('does not gross up a bridge route Portals applied no slippage to', () => {
+        const { stepCommon, tradeCommon } = unwrap({
+            input: makeInput(),
+            deps,
+            sellChainId: assets_1.USDC_MAINNET.chainId,
+            orderContext: makeOrderContext({
+                outputAmount: '4616564490',
+                minOutputAmount: '4616564490',
+                slippageTolerancePercentage: 0,
+            }),
+            outputToken: 'arbitrum:0xaf88d065e77c8cc2239327c5edb3a432268e5831',
+            tx,
+        });
+        (0, vitest_1.expect)(stepCommon.buyAmountAfterFeesCryptoBaseUnit).toBe('4616564490');
+        (0, vitest_1.expect)(tradeCommon.slippageTolerancePercentageDecimal).toBe('0');
+    });
+    (0, vitest_1.it)('reverses the applied slippage on an unvalidated order collapsed to its minimum', () => {
+        const { stepCommon, tradeCommon } = unwrap({
+            input: makeInput(assets_1.USDC_MAINNET),
+            deps,
+            sellChainId: assets_1.USDC_MAINNET.chainId,
+            orderContext: makeOrderContext({
+                outputAmount: '2360574345',
+                minOutputAmount: '2360574345',
+                slippageTolerancePercentage: 2.5,
+            }),
+            outputToken: 'ethereum:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+            tx,
+        });
+        // Within 0.01% of the 2420957576 the same order returns when validated
+        (0, vitest_1.expect)(stepCommon.buyAmountAfterFeesCryptoBaseUnit).toBe('2421101892');
+        (0, vitest_1.expect)(tradeCommon.slippageTolerancePercentageDecimal).toBe('0.025');
+    });
+    (0, vitest_1.it)('keeps the reported output of a validated order and advertises the wider buffer', () => {
+        const { stepCommon, tradeCommon } = unwrap({
+            input: makeInput(assets_1.USDC_MAINNET),
+            deps,
+            sellChainId: assets_1.USDC_MAINNET.chainId,
+            orderContext: makeOrderContext({
+                outputAmount: '2420957576',
+                minOutputAmount: '2360574345',
+                slippageTolerancePercentage: 2.5,
+            }),
+            outputToken: 'ethereum:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+            tx,
+        });
+        (0, vitest_1.expect)(stepCommon.buyAmountAfterFeesCryptoBaseUnit).toBe('2420957576');
+        (0, vitest_1.expect)(tradeCommon.slippageTolerancePercentageDecimal).toBe('0.025');
+    });
+    (0, vitest_1.it)('prices against the input amount Portals filled rather than the one requested', () => {
+        const { stepCommon } = unwrap({
+            input: makeInput(),
+            deps,
+            sellChainId: assets_1.USDC_MAINNET.chainId,
+            orderContext: makeOrderContext({
+                // Portals withhold 0.01% of the requested 4631313795 on cross-chain orders
+                inputAmount: '4630850664',
+                outputAmount: '4616564490',
+                minOutputAmount: '4616564490',
+                slippageTolerancePercentage: 0,
+            }),
+            outputToken: 'arbitrum:0xaf88d065e77c8cc2239327c5edb3a432268e5831',
+            tx,
+        });
+        (0, vitest_1.expect)(stepCommon.sellAmountIncludingProtocolFeesCryptoBaseUnit).toBe('4630850664');
+    });
+});

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

@@ -14,6 +14,7 @@ const getTradeRate_1 = require("./getTradeRate/getTradeRate");
 const getLatestRelayStatusMessage_1 = require("./utils/getLatestRelayStatusMessage");
 const notifyTransactionIndexing_1 = require("./utils/notifyTransactionIndexing");
 const relayService_1 = require("./utils/relayService");
+const relayStatus_1 = require("./utils/relayStatus");
 // Keep track of the trades we already notified the relay indexer about
 const txIndexingMap = new Map();
 exports.relayApi = {
@@ -69,7 +70,7 @@ exports.relayApi = {
         }
         // relay.link tracks the swap by its origin chain transaction
         const swapperTxId = txHash;
-        const swapperTxLink = `https://relay.link/transaction/${txHash}`;
+        const swapperTxLink = (0, relayStatus_1.getRelayTrackingLink)(txHash);
         const maybeStatusResponse = await relayService_1.relayService.get(`${config.VITE_RELAY_API_URL}/intents/status/v3?requestId=${relayMetadata.relayId}`, (0, relayService_1.getRelayRequestConfig)(config));
         if (maybeStatusResponse.isErr()) {
             return {
@@ -81,23 +82,7 @@ exports.relayApi = {
             };
         }
         const { data: statusResponse } = maybeStatusResponse.unwrap();
-        const status = (() => {
-            switch (statusResponse.status) {
-                case 'success':
-                    return unchained_client_1.TxStatus.Confirmed;
-                case 'waiting':
-                case 'delayed':
-                case 'pending':
-                case 'depositing':
-                case 'submitted':
-                    return unchained_client_1.TxStatus.Pending;
-                case 'failure':
-                case 'refund':
-                    return unchained_client_1.TxStatus.Failed;
-                default:
-                    return unchained_client_1.TxStatus.Unknown;
-            }
-        })();
+        const status = (0, relayStatus_1.relayStatusToTxStatus)(statusResponse.status);
         // Relay refers to in Txs as "inTxHashes" but to out Txs as simply "txHashes" when they really mean "outTxHashes"
         // One thing to note is that for same-chain Txs, there is no "out Tx" per se since the in Tx *is* the out Tx
         const outTxHashes = statusResponse.txHashes;

package/dist/cjs/swappers/RelaySwapper/utils/relayStatus.d.ts

@@ -0,0 +1,8 @@
+import { TxStatus } from '@shapeshiftoss/unchained-client';
+import type { Result } from '@sniptt/monads';
+import type { SwapErrorRight, SwapperConfig } from '../../../types';
+import type { RelayRequest, RelayStatus } from './types';
+export declare const getRelayTrackingLink: (txHash: string) => string;
+export declare const relayStatusToTxStatus: (status: RelayStatus['status'] | undefined) => TxStatus;
+export declare const fetchRelayRequestByTxHash: (txHash: string, config: SwapperConfig) => Promise<Result<RelayRequest | undefined, SwapErrorRight>>;
+export declare const getRelayRequestFailureMessage: (request: RelayRequest) => string;

package/dist/cjs/swappers/RelaySwapper/utils/relayStatus.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRelayRequestFailureMessage = exports.fetchRelayRequestByTxHash = exports.relayStatusToTxStatus = exports.getRelayTrackingLink = void 0;
+const unchained_client_1 = require("@shapeshiftoss/unchained-client");
+const relayService_1 = require("./relayService");
+const getRelayTrackingLink = (txHash) => `https://relay.link/transaction/${txHash}`;
+exports.getRelayTrackingLink = getRelayTrackingLink;
+const relayStatusToTxStatus = (status) => {
+    switch (status) {
+        case 'success':
+            return unchained_client_1.TxStatus.Confirmed;
+        case 'waiting':
+        case 'delayed':
+        case 'pending':
+        case 'depositing':
+        case 'submitted':
+            return unchained_client_1.TxStatus.Pending;
+        case 'failure':
+        case 'refund':
+            return unchained_client_1.TxStatus.Failed;
+        default:
+            return unchained_client_1.TxStatus.Unknown;
+    }
+};
+exports.relayStatusToTxStatus = relayStatusToTxStatus;
+// Relay index requests by origin tx hash, resolving a swap we hold no relayId for
+const fetchRelayRequestByTxHash = async (txHash, config) => {
+    const maybeResponse = await relayService_1.relayService.get(`${config.VITE_RELAY_API_URL}/requests/v2?hash=${txHash}`, (0, relayService_1.getRelayRequestConfig)(config));
+    // Match the origin tx ourselves rather than trusting the listing to have filtered on it
+    return maybeResponse.map(({ data }) => data.requests?.find(({ data: request }) => request?.inTxs?.some(({ hash }) => hash?.toLowerCase() === txHash.toLowerCase())));
+};
+exports.fetchRelayRequestByTxHash = fetchRelayRequestByTxHash;
+const getRelayRequestFailureMessage = (request) => {
+    const { failReason, refundFailReason } = request.data ?? {};
+    // Relay report 'N/A' rather than omitting the reason when there isn't one
+    const reason = [failReason, refundFailReason].find(value => value && value !== 'N/A');
+    return reason ?? 'Bridge failed';
+};
+exports.getRelayRequestFailureMessage = getRelayRequestFailureMessage;

package/dist/cjs/swappers/RelaySwapper/utils/types.d.ts

@@ -12,6 +12,20 @@ export type RelayMetadata = {
     relayId: string;
     data?: string;
 };
+export type RelayRequestTransaction = {
+    hash?: string;
+    chainId?: number;
+};
+export type RelayRequestData = {
+    failReason?: string;
+    refundFailReason?: string;
+    inTxs?: RelayRequestTransaction[];
+    outTxs?: RelayRequestTransaction[];
+};
+export type RelayRequest = {
+    status?: RelayStatus['status'];
+    data?: RelayRequestData;
+};
 export type RelayStatus = {
     status: 'success' | 'failure' | 'pending' | 'submitted' | 'depositing' | 'refund' | 'delayed' | 'waiting';
     details?: string;

package/dist/cjs/swappers/ThorchainSwapper/generated/generatedThorLongtailTokens.json

@@ -1016,6 +1016,7 @@
     "eip155:1/erc20:0x826180541412d574cf1336d22c0c0a287822678a",
     "eip155:1/erc20:0x2c06ba9e7f0daccbc1f6a33ea67e85bb68fbee3a",
     "eip155:1/erc20:0xcbb8f1bda10b9696c57e13bc128fe674769dcec0",
+    "eip155:1/erc20:0x72dfb2e44f59c5ad2bafe84314e5b99a7cd5075e",
     "eip155:43114/erc20:0xc891eb4cbdeff6e073e859e987815ed1505c2acd",
     "eip155:43114/erc20:0xd24c2ad096400b6fbcd2ad8b24e7acbc21a1da64",
     "eip155:43114/erc20:0x47c3118ad183712acd42648e9e522e13690f29a0",

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

@@ -30,7 +30,7 @@ const fetchFromZrx = async ({ quoteOrRate, buyAsset, sellAsset, sellAmountInclud
             swapFeeToken: (0, helpers_2.assetIdToZrxToken)(buyAsset.assetId),
             slippageBps: (0, utils_1.convertDecimalPercentageToBasisPoints)(slippageTolerancePercentageDecimal).toNumber(),
             swapFeeRecipient: maybeTreasuryAddress,
-            feeRecipientTradeSurplus: maybeTreasuryAddress, // Where trade surplus is sent
+            tradeSurplusRecipient: maybeTreasuryAddress, // Where trade surplus is sent
         },
     });
     if (maybeZrxPriceResponse.isErr()) {

package/dist/cjs/types.d.ts

@@ -574,6 +574,7 @@ export type CheckTradeStatusInput = {
 export type TradeStatus = {
     status: TxStatus;
     buyTxHash: string | undefined;
+    sellTxHash?: string | undefined;
     swapperTxId?: string | undefined;
     swapperTxLink?: string | undefined;
     message: string | [string, InterpolationOptions] | undefined;
@@ -583,6 +584,7 @@ export type TradeQuoteResult = Result<TradeQuote[], SwapErrorRight>;
 export type TradeRateResult = Result<TradeRate[], SwapErrorRight>;
 export type EvmMessageToSign = CowMessageToSign;
 export type Swapper = {
+    supportsExternalPayment?: boolean;
     executeEvmTransaction?: (txToSign: SignTx<EvmChainId>, callbacks: EvmTransactionExecutionProps) => Promise<string>;
     executeEvmMessage?: (txMetaToSign: EvmMessageToSign, callbacks: EvmMessageExecutionProps, config: SwapperConfig) => Promise<string>;
     executeUtxoTransaction?: (txToSign: SignTx<UtxoChainId>, callbacks: UtxoTransactionExecutionProps) => Promise<string>;

package/dist/cjs/utils/cowswap/index.d.ts

@@ -1,4 +1,5 @@
-import type { OrderClass1 } from '@cowprotocol/app-data/dist/generatedTypes/v1.3.0';
+import type { AppDataRootSchema as AppDataRootSchemaLegacy } from '@cowprotocol/app-data/dist/generatedTypes/v0.4.0';
+import type { AppDataRootSchema as AppDataRootSchemaLatest, OrderClass1 } from '@cowprotocol/app-data/dist/generatedTypes/v1.3.0';
 import type { ChainId } from '@shapeshiftoss/caip';
 import type { EvmChainAdapter } from '@shapeshiftoss/chain-adapters';
 import type { HDWallet } from '@shapeshiftoss/hdwallet-core';
@@ -22,3 +23,5 @@ export declare const getFullAppData: (slippageTolerancePercentage: string, affil
     appDataHash: string;
     appData: string;
 }>;
+export type ParsedAppData = AppDataRootSchemaLatest | AppDataRootSchemaLegacy;
+export declare const isLegacyAppData: (appData: ParsedAppData) => appData is AppDataRootSchemaLegacy;

package/dist/cjs/utils/cowswap/index.js

@@ -14,7 +14,7 @@ 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.getFullAppData = exports.getAffiliateAppDataFragmentByChainId = exports.cowSwapTokenToAssetId = exports.signCowOrderCancellation = exports.signCowOrder = exports.signCowMessage = exports.assertGetCowNetwork = exports.getCowNetwork = void 0;
+exports.isLegacyAppData = exports.getFullAppData = exports.getAffiliateAppDataFragmentByChainId = exports.cowSwapTokenToAssetId = exports.signCowOrderCancellation = exports.signCowOrder = exports.signCowMessage = exports.assertGetCowNetwork = exports.getCowNetwork = void 0;
 const app_data_1 = require("@cowprotocol/app-data");
 const caip_1 = require("@shapeshiftoss/caip");
 const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
@@ -183,3 +183,7 @@ const getFullAppData = async (slippageTolerancePercentage, affiliateAppDataFragm
     return { appDataHash: appDataKeccak256, appData: fullAppData };
 };
 exports.getFullAppData = getFullAppData;
+const isLegacyAppData = (appData) => {
+    return appData.version === '0.4.0';
+};
+exports.isLegacyAppData = isLegacyAppData;

package/dist/cjs/utils/helpers.d.ts

@@ -1,5 +1,6 @@
 import type { AssetId, ChainId } from '@shapeshiftoss/caip';
-import type { TradeAmount } from '../types';
+import type { TradeAmount, TradeStepCommon } from '../types';
+import { SwapperName } from '../types';
 export declare const FALLBACK_QUOTE_DEADLINE_MS = 60000;
 export declare const getTradeAmount: (input: {
     sellAmountIncludingProtocolFeesCryptoBaseUnit: string;
@@ -9,3 +10,5 @@ export declare const getTradeAmount: (input: {
 export declare const normalizeEpochToMs: (value: number) => number;
 export declare const isNativeEvmAsset: (assetId: AssetId) => boolean;
 export declare const getTreasuryAddressFromChainId: (chainId: ChainId) => string;
+export type DepositAddressStep = Pick<TradeStepCommon, 'chainflipSpecific' | 'swapperMetadata'>;
+export declare const getDepositAddress: (step: DepositAddressStep, swapperName: SwapperName) => string | undefined;

package/dist/cjs/utils/helpers.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTreasuryAddressFromChainId = exports.isNativeEvmAsset = exports.normalizeEpochToMs = exports.getTradeAmount = exports.FALLBACK_QUOTE_DEADLINE_MS = void 0;
+exports.getDepositAddress = exports.getTreasuryAddressFromChainId = exports.isNativeEvmAsset = exports.normalizeEpochToMs = exports.getTradeAmount = exports.FALLBACK_QUOTE_DEADLINE_MS = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
 const types_1 = require("@shapeshiftoss/types");
 const utils_1 = require("@shapeshiftoss/utils");
+const types_2 = require("../types");
 // Deadline for providers without their own expiry - short enough to keep priced amounts honest
 exports.FALLBACK_QUOTE_DEADLINE_MS = 60_000;
 const getTradeAmount = (input) => 'buyAmountCryptoBaseUnit' in input
@@ -78,3 +79,20 @@ const getTreasuryAddressFromChainId = (chainId) => {
     return treasuryAddress;
 };
 exports.getTreasuryAddressFromChainId = getTreasuryAddressFromChainId;
+const getDepositAddress = (step, swapperName) => {
+    switch (swapperName) {
+        case types_2.SwapperName.Chainflip:
+            return step.chainflipSpecific?.depositAddress || undefined;
+        case types_2.SwapperName.NearIntents: {
+            if (step.swapperMetadata?.name !== 'nearIntents')
+                return;
+            const { depositAddress, depositMemo } = step.swapperMetadata;
+            if (depositMemo)
+                return;
+            return depositAddress || undefined;
+        }
+        default:
+            return;
+    }
+};
+exports.getDepositAddress = getDepositAddress;

package/dist/cjs/utils/helpers.test.js

@@ -4,6 +4,8 @@ const caip_1 = require("@shapeshiftoss/caip");
 const types_1 = require("@shapeshiftoss/types");
 const utils_1 = require("@shapeshiftoss/utils");
 const vitest_1 = require("vitest");
+const constants_1 = require("../constants");
+const types_2 = require("../types");
 const helpers_1 = require("./helpers");
 (0, vitest_1.describe)('getTreasuryAddressFromChainId', () => {
     // Affiliate and fee recipient addresses for every swapper flow through here, so pin the values
@@ -49,3 +51,42 @@ const helpers_1 = require("./helpers");
         (0, vitest_1.expect)((0, helpers_1.normalizeEpochToMs)(epochMs * 1e6)).toBe(epochMs);
     });
 });
+const makeStep = (step) => step;
+(0, vitest_1.describe)('getDepositAddress', () => {
+    (0, vitest_1.it)('reads the chainflip deposit address', () => {
+        const step = makeStep({ chainflipSpecific: { depositAddress: 'bc1qdeposit' } });
+        (0, vitest_1.expect)((0, helpers_1.getDepositAddress)(step, types_2.SwapperName.Chainflip)).toBe('bc1qdeposit');
+    });
+    (0, vitest_1.it)('returns undefined when chainflip has no deposit address', () => {
+        (0, vitest_1.expect)((0, helpers_1.getDepositAddress)(makeStep({}), types_2.SwapperName.Chainflip)).toBeUndefined();
+    });
+    (0, vitest_1.it)('reads the near intents deposit address', () => {
+        const step = makeStep({
+            swapperMetadata: { name: 'nearIntents', depositAddress: '0xdeposit' },
+        });
+        (0, vitest_1.expect)((0, helpers_1.getDepositAddress)(step, types_2.SwapperName.NearIntents)).toBe('0xdeposit');
+    });
+    (0, vitest_1.it)('rejects a memo-bound near intents deposit address', () => {
+        const step = makeStep({
+            swapperMetadata: { name: 'nearIntents', depositAddress: 'EQdeposit', depositMemo: '12345' },
+        });
+        (0, vitest_1.expect)((0, helpers_1.getDepositAddress)(step, types_2.SwapperName.NearIntents)).toBeUndefined();
+    });
+    (0, vitest_1.it)('rejects an empty near intents deposit address', () => {
+        const step = makeStep({ swapperMetadata: { name: 'nearIntents', depositAddress: '' } });
+        (0, vitest_1.expect)((0, helpers_1.getDepositAddress)(step, types_2.SwapperName.NearIntents)).toBeUndefined();
+    });
+    (0, vitest_1.it)('returns undefined for swappers that do not use deposit addresses', () => {
+        const step = makeStep({ chainflipSpecific: { depositAddress: 'bc1qdeposit' } });
+        (0, vitest_1.expect)((0, helpers_1.getDepositAddress)(step, types_2.SwapperName.Relay)).toBeUndefined();
+    });
+});
+(0, vitest_1.describe)('supportsExternalPayment', () => {
+    (0, vitest_1.it)('is flagged on exactly the externally paid swappers', () => {
+        const flagged = Object.entries(constants_1.swappers)
+            .filter(([, swapper]) => swapper?.supportsExternalPayment)
+            .map(([name]) => name)
+            .sort();
+        (0, vitest_1.expect)(flagged).toEqual([types_2.SwapperName.Chainflip, types_2.SwapperName.NearIntents].sort());
+    });
+});