@uniswap/universal-router-sdk 4.34.2 → 4.35.0

package/dist/esm/src/entities/Command.js

@@ -0,0 +1,6 @@
+export var RouterActionType;
+(function (RouterActionType) {
+    RouterActionType["UniswapTrade"] = "UniswapTrade";
+    RouterActionType["UnwrapWETH"] = "UnwrapWETH";
+})(RouterActionType || (RouterActionType = {}));
+//# sourceMappingURL=Command.js.map

package/dist/esm/src/entities/Command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Command.js","sourceRoot":"","sources":["../../../../src/entities/Command.ts"],"names":[],"mappings":"AAMA,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iDAA6B,CAAA;IAC7B,6CAAyB,CAAA;AAC3B,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B"}

package/dist/esm/src/entities/actions/across.d.ts

@@ -0,0 +1,21 @@
+import { BigNumberish } from 'ethers';
+/**
+ * Parameters for Across V4 Deposit V3 command
+ * Used for cross-chain bridging via Across Protocol V3 SpokePool
+ */
+export type AcrossV4DepositV3Params = {
+    depositor: string;
+    recipient: string;
+    inputToken: string;
+    outputToken: string;
+    inputAmount: BigNumberish;
+    outputAmount: BigNumberish;
+    destinationChainId: number;
+    exclusiveRelayer: string;
+    quoteTimestamp: number;
+    fillDeadline: number;
+    exclusivityDeadline: number;
+    message: string;
+    useNative: boolean;
+};
+export { CONTRACT_BALANCE } from '../../utils/constants';

package/dist/esm/src/entities/actions/across.js

@@ -0,0 +1,3 @@
+// Export CONTRACT_BALANCE constant for convenience
+export { CONTRACT_BALANCE } from '../../utils/constants';
+//# sourceMappingURL=across.js.map

package/dist/esm/src/entities/actions/across.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"across.js","sourceRoot":"","sources":["../../../../../src/entities/actions/across.ts"],"names":[],"mappings":"AAsBA,mDAAmD;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA"}

package/dist/esm/src/entities/actions/index.d.ts

@@ -0,0 +1,3 @@
+export * from './uniswap';
+export * from './unwrapWETH';
+export * from './across';

package/dist/esm/src/entities/actions/index.js

@@ -0,0 +1,4 @@
+export * from './uniswap';
+export * from './unwrapWETH';
+export * from './across';
+//# sourceMappingURL=index.js.map

package/dist/esm/src/entities/actions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/entities/actions/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA;AAC5B,cAAc,UAAU,CAAA"}

package/dist/esm/src/entities/actions/uniswap.d.ts

@@ -0,0 +1,38 @@
+import { RoutePlanner } from '../../utils/routerCommands';
+import { URVersion } from '@uniswap/v4-sdk';
+import { Trade as RouterTrade, SwapOptions as RouterSwapOptions } from '@uniswap/router-sdk';
+import { Permit2Permit } from '../../utils/inputTokens';
+import { Currency, TradeType } from '@uniswap/sdk-core';
+import { Command, RouterActionType, TradeConfig } from '../Command';
+import { BigNumberish } from 'ethers';
+export type FlatFeeOptions = {
+    amount: BigNumberish;
+    recipient: string;
+};
+export declare enum TokenTransferMode {
+    Permit2 = "Permit2",
+    ApproveProxy = "ApproveProxy"
+}
+export type SwapOptions = Omit<RouterSwapOptions, 'inputTokenPermit'> & {
+    useRouterBalance?: boolean;
+    inputTokenPermit?: Permit2Permit;
+    flatFee?: FlatFeeOptions;
+    safeMode?: boolean;
+    urVersion?: URVersion;
+    tokenTransferMode?: TokenTransferMode;
+    chainId?: number;
+};
+export declare class UniswapTrade implements Command {
+    trade: RouterTrade<Currency, Currency, TradeType>;
+    options: SwapOptions;
+    readonly tradeType: RouterActionType;
+    readonly payerIsUser: boolean;
+    constructor(trade: RouterTrade<Currency, Currency, TradeType>, options: SwapOptions);
+    get isAllV4(): boolean;
+    get inputRequiresWrap(): boolean;
+    get inputRequiresUnwrap(): boolean;
+    get outputRequiresWrap(): boolean;
+    get outputRequiresUnwrap(): boolean;
+    get outputRequiresTransition(): boolean;
+    encode(planner: RoutePlanner, _config: TradeConfig): void;
+}

package/dist/esm/src/entities/actions/uniswap.js

@@ -0,0 +1,528 @@
+import { CommandType } from '../../utils/routerCommands';
+import { Trade as V2Trade, Pair } from '@uniswap/v2-sdk';
+import { Trade as V3Trade, Pool as V3Pool, encodeRouteToPath } from '@uniswap/v3-sdk';
+import { Route as V4Route, Trade as V4Trade, Pool as V4Pool, V4Planner, encodeRouteToPath as encodeV4RouteToPath, Actions, URVersion, isAtLeastV2_1_1, } from '@uniswap/v4-sdk';
+import { MixedRouteTrade, Protocol, MixedRouteSDK, MixedRoute, getOutputOfPools, encodeMixedRouteToPath, partitionMixedRouteByProtocol, } from '@uniswap/router-sdk';
+import { getPathCurrency } from '../../utils/pathCurrency';
+import { TradeType, Percent } from '@uniswap/sdk-core';
+import { RouterActionType } from '../Command';
+import { SENDER_AS_RECIPIENT, ROUTER_AS_RECIPIENT, CONTRACT_BALANCE, ETH_ADDRESS } from '../../utils/constants';
+import { getCurrencyAddress } from '../../utils/getCurrencyAddress';
+import { encodeFeeBips, encodeFee1e18 } from '../../utils/numbers';
+import { BigNumber } from 'ethers';
+// the existing router permit object doesn't include enough data for permit2
+// so we extend swap options with the permit2 permit
+// when safe mode is enabled, the SDK will add an extra ETH sweep for security
+// when useRouterBalance is enabled the SDK will use the balance in the router for the swap
+export var TokenTransferMode;
+(function (TokenTransferMode) {
+    TokenTransferMode["Permit2"] = "Permit2";
+    TokenTransferMode["ApproveProxy"] = "ApproveProxy";
+})(TokenTransferMode || (TokenTransferMode = {}));
+const REFUND_ETH_PRICE_IMPACT_THRESHOLD = new Percent(50, 100);
+// Wrapper for uniswap router-sdk trade entity to encode swaps for Universal Router
+// also translates trade objects from previous (v2, v3) SDKs
+export class UniswapTrade {
+    constructor(trade, options) {
+        this.trade = trade;
+        this.options = options;
+        this.tradeType = RouterActionType.UniswapTrade;
+        if (!!options.fee && !!options.flatFee)
+            throw new Error('Only one fee option permitted');
+        if (options.tokenTransferMode === TokenTransferMode.ApproveProxy) {
+            if (!options.recipient || options.recipient === SENDER_AS_RECIPIENT) {
+                throw new Error('Explicit recipient address required when using SwapProxy (SENDER_AS_RECIPIENT resolves to proxy)');
+            }
+            this.payerIsUser = false;
+        }
+        else if (this.inputRequiresWrap || this.inputRequiresUnwrap || this.options.useRouterBalance) {
+            this.payerIsUser = false;
+        }
+        else {
+            this.payerIsUser = true;
+        }
+    }
+    get isAllV4() {
+        let result = true;
+        for (const swap of this.trade.swaps) {
+            result = result && swap.route.protocol == Protocol.V4;
+        }
+        return result;
+    }
+    // this.trade.swaps is an array of swaps / trades.
+    // we are iterating over one swap (trade) at a time so length is 1
+    // route is either v2, v3, v4, or mixed
+    // pathInput and pathOutput are the currencies of the input and output of the route
+    // this.trade.inputAmount is the input currency of the trade (could be different from pathInput)
+    // this.trade.outputAmount is the output currency of the trade (could be different from pathOutput)
+    // each route can have multiple pools
+    get inputRequiresWrap() {
+        const swap = this.trade.swaps[0];
+        const route = swap.route;
+        const firstPool = route.pools[0];
+        if (firstPool instanceof V4Pool) {
+            // If first pool is a v4 pool and input currency is native and the path input currency in the route is not native, we need to wrap.
+            return (this.trade.inputAmount.currency.isNative &&
+                !this.trade.swaps[0].route.pathInput.isNative);
+        }
+        // If first pool is not a v4 pool and input currency is native, we need to wrap
+        return this.trade.inputAmount.currency.isNative;
+    }
+    get inputRequiresUnwrap() {
+        const swap = this.trade.swaps[0];
+        const route = swap.route;
+        const firstPool = route.pools[0];
+        if (firstPool instanceof V4Pool) {
+            // If the first pool is a v4 pool and input currency is not native and the path input currency is native, we need to unwrap
+            return (!this.trade.inputAmount.currency.isNative &&
+                this.trade.swaps[0].route.pathInput.isNative);
+        }
+        // If the first pool is not a v4 pool, we don't need to unwrap.
+        return false;
+    }
+    get outputRequiresWrap() {
+        const swap = this.trade.swaps[0];
+        const lastRoute = swap.route;
+        const lastPool = lastRoute.pools[lastRoute.pools.length - 1];
+        // if last pool is v4:
+        if (lastPool instanceof V4Pool) {
+            // If output currency is not native but path currency output is native, we need to wrap
+            if (!this.trade.outputAmount.currency.isNative) {
+                if (lastRoute.pathOutput.isNative) {
+                    // this means path output is native and we need to wrap
+                    return true;
+                }
+                else if (lastPool.currency1.equals(lastPool.currency0.wrapped) && lastRoute.pools.length > 1) {
+                    let poolBefore = lastRoute.pools[lastRoute.pools.length - 2];
+                    // this means last pool is eth-weth and pool before contains weth
+                    if (poolBefore instanceof V4Pool &&
+                        (poolBefore.currency0.equals(lastPool.currency1) || poolBefore.currency1.equals(lastPool.currency1))) {
+                        return true;
+                    }
+                    else if (poolBefore.token0.equals(lastPool.currency1) || poolBefore.token1.equals(lastPool.currency1)) {
+                        // same for v2 and v3 pools
+                        return true;
+                    }
+                }
+            }
+        }
+        // if last pool is not v4:
+        // we do not need to wrap because v2 and v3 pools already require wrapped tokens
+        return false;
+    }
+    get outputRequiresUnwrap() {
+        const swap = this.trade.swaps[0];
+        const lastRoute = swap.route;
+        const lastPool = lastRoute.pools[lastRoute.pools.length - 1];
+        // if last pool is v4:
+        if (lastPool instanceof V4Pool) {
+            // If output currency is native and path currency output is not native, we need to unwrap
+            if (this.trade.outputAmount.currency.isNative) {
+                if (!this.trade.swaps[0].route.pathOutput.isNative) {
+                    // this means path output is weth and we need to unwrap
+                    return true;
+                }
+                else if (lastRoute.pools.length > 1 &&
+                    lastRoute.pools[lastRoute.pools.length - 2] instanceof V4Pool &&
+                    lastRoute.pools[lastRoute.pools.length - 2].currency0.isNative &&
+                    lastPool.currency1.equals(lastPool.currency0.wrapped)) {
+                    // this means last pool is eth-weth and we need to unwrap
+                    return true;
+                }
+                else {
+                    return false;
+                }
+            }
+        }
+        // else: if path output currency is native, we need to unwrap because v2 and v3 pools already require wrapped tokens
+        return this.trade.outputAmount.currency.isNative;
+    }
+    get outputRequiresTransition() {
+        return this.outputRequiresWrap || this.outputRequiresUnwrap;
+    }
+    encode(planner, _config) {
+        var _a;
+        // If the input currency is the native currency, we need to wrap it with the router as the recipient
+        if (this.inputRequiresWrap) {
+            // TODO: optimize if only one v2 pool we can directly send this to the pool
+            planner.addCommand(CommandType.WRAP_ETH, [
+                ROUTER_AS_RECIPIENT,
+                this.trade.maximumAmountIn(this.options.slippageTolerance).quotient.toString(),
+            ]);
+        }
+        else if (this.inputRequiresUnwrap) {
+            if (this.options.tokenTransferMode !== TokenTransferMode.ApproveProxy) {
+                // send wrapped token to router to unwrap via Permit2
+                planner.addCommand(CommandType.PERMIT2_TRANSFER_FROM, [
+                    this.trade.inputAmount.currency.address,
+                    ROUTER_AS_RECIPIENT,
+                    this.trade.maximumAmountIn(this.options.slippageTolerance).quotient.toString(),
+                ]);
+            }
+            // In proxy mode, the proxy already transferred tokens to the UR; just unwrap
+            planner.addCommand(CommandType.UNWRAP_WETH, [ROUTER_AS_RECIPIENT, 0]);
+        }
+        // The overall recipient at the end of the trade, SENDER_AS_RECIPIENT uses the msg.sender
+        this.options.recipient = (_a = this.options.recipient) !== null && _a !== void 0 ? _a : SENDER_AS_RECIPIENT;
+        // flag for whether we want to perform slippage check on aggregate output of multiple routes
+        //   1. when there are >2 exact input trades. this is only a heuristic,
+        //      as it's still more gas-expensive even in this case, but has benefits
+        //      in that the reversion probability is lower
+        const performAggregatedSlippageCheck = this.trade.tradeType === TradeType.EXACT_INPUT && this.trade.routes.length > 2;
+        const routerMustCustody = performAggregatedSlippageCheck || this.outputRequiresTransition || hasFeeOption(this.options);
+        for (const swap of this.trade.swaps) {
+            switch (swap.route.protocol) {
+                case Protocol.V2:
+                    addV2Swap(planner, swap, this.trade.tradeType, this.options, this.payerIsUser, routerMustCustody);
+                    break;
+                case Protocol.V3:
+                    addV3Swap(planner, swap, this.trade.tradeType, this.options, this.payerIsUser, routerMustCustody);
+                    break;
+                case Protocol.V4:
+                    addV4Swap(planner, swap, this.trade.tradeType, this.options, this.payerIsUser, routerMustCustody);
+                    break;
+                case Protocol.MIXED:
+                    addMixedSwap(planner, swap, this.trade.tradeType, this.options, this.payerIsUser, routerMustCustody);
+                    break;
+                default:
+                    throw new Error('UNSUPPORTED_TRADE_PROTOCOL');
+            }
+        }
+        let minimumAmountOut = BigNumber.from(this.trade.minimumAmountOut(this.options.slippageTolerance).quotient.toString());
+        // The router custodies for 3 reasons: to unwrap, to take a fee, and/or to do a slippage check
+        if (routerMustCustody) {
+            const pools = this.trade.swaps[0].route.pools;
+            const pathOutputCurrencyAddress = getCurrencyAddress(getPathCurrency(this.trade.outputAmount.currency, pools[pools.length - 1]));
+            let feeDeduction = BigNumber.from(0);
+            // If there is a fee, that percentage is sent to the fee recipient
+            // In the case where ETH is the output currency, the fee is taken in WETH (for gas reasons)
+            if (!!this.options.fee) {
+                // UR >= V2_1_1 supports PAY_PORTION_FULL_PRECISION (1e18 precision),
+                // older versions only support PAY_PORTION (bips)
+                const useFullPrecision = this.options.urVersion !== undefined && this.options.urVersion >= URVersion.V2_1_1;
+                // Reject fractional bips fees on older UR versions to prevent silent precision loss
+                if (!useFullPrecision && !this.options.fee.fee.multiply(10000).remainder.equalTo(0)) {
+                    throw new Error('Fractional fee bips require Universal Router version V2_1_1 or higher');
+                }
+                if (useFullPrecision) {
+                    const fee1e18 = encodeFee1e18(this.options.fee.fee);
+                    planner.addCommand(CommandType.PAY_PORTION_FULL_PRECISION, [pathOutputCurrencyAddress, this.options.fee.recipient, fee1e18], false, this.options.urVersion);
+                    feeDeduction = minimumAmountOut.mul(fee1e18).div(BigNumber.from(10).pow(18));
+                }
+                else {
+                    const feeBips = encodeFeeBips(this.options.fee.fee);
+                    planner.addCommand(CommandType.PAY_PORTION, [pathOutputCurrencyAddress, this.options.fee.recipient, feeBips]);
+                    feeDeduction = minimumAmountOut.mul(feeBips).div(10000);
+                }
+            }
+            // If there is a flat fee, that absolute amount is sent to the fee recipient
+            // In the case where ETH is the output currency, the fee is taken in WETH (for gas reasons)
+            if (!!this.options.flatFee) {
+                const feeAmount = this.options.flatFee.amount;
+                if (minimumAmountOut.lt(feeAmount))
+                    throw new Error('Flat fee amount greater than minimumAmountOut');
+                planner.addCommand(CommandType.TRANSFER, [pathOutputCurrencyAddress, this.options.flatFee.recipient, feeAmount]);
+                feeDeduction = BigNumber.from(feeAmount);
+            }
+            // If the trade is exact output, and a fee was taken, we must adjust the amount out to be the amount after the fee
+            // Otherwise we continue as expected with the trade's normal expected output
+            if (this.trade.tradeType === TradeType.EXACT_OUTPUT) {
+                minimumAmountOut = minimumAmountOut.sub(feeDeduction);
+            }
+            // The remaining tokens that need to be sent to the user after the fee is taken will be caught
+            // by this if-else clause.
+            if (this.outputRequiresUnwrap) {
+                planner.addCommand(CommandType.UNWRAP_WETH, [this.options.recipient, minimumAmountOut]);
+            }
+            else if (this.outputRequiresWrap) {
+                planner.addCommand(CommandType.WRAP_ETH, [this.options.recipient, CONTRACT_BALANCE]);
+            }
+            else {
+                planner.addCommand(CommandType.SWEEP, [
+                    getCurrencyAddress(this.trade.outputAmount.currency),
+                    this.options.recipient,
+                    minimumAmountOut,
+                ]);
+            }
+        }
+        // for exactOutput swaps with native input or that perform an inputToken transition (wrap or unwrap)
+        // we need to send back the change to the user
+        if (this.trade.tradeType === TradeType.EXACT_OUTPUT || riskOfPartialFill(this.trade)) {
+            if (this.inputRequiresWrap) {
+                planner.addCommand(CommandType.UNWRAP_WETH, [this.options.recipient, 0]);
+            }
+            else if (this.inputRequiresUnwrap) {
+                planner.addCommand(CommandType.WRAP_ETH, [this.options.recipient, CONTRACT_BALANCE]);
+            }
+            else if (this.options.tokenTransferMode === TokenTransferMode.ApproveProxy) {
+                // Proxy pulled maximumAmountIn into the UR; sweep any unused input back to the user
+                planner.addCommand(CommandType.SWEEP, [
+                    getCurrencyAddress(this.trade.inputAmount.currency),
+                    this.options.recipient,
+                    0,
+                ]);
+            }
+            else if (this.trade.inputAmount.currency.isNative) {
+                // must refund extra native currency sent along for native v4 trades (no input transition)
+                planner.addCommand(CommandType.SWEEP, [ETH_ADDRESS, this.options.recipient, 0]);
+            }
+        }
+        if (this.options.safeMode)
+            planner.addCommand(CommandType.SWEEP, [ETH_ADDRESS, this.options.recipient, 0]);
+    }
+}
+// encode a uniswap v2 swap
+function addV2Swap(planner, { route, inputAmount, outputAmount, maxHopSlippage }, tradeType, options, payerIsUser, routerMustCustody) {
+    if ((maxHopSlippage === null || maxHopSlippage === void 0 ? void 0 : maxHopSlippage.length) && maxHopSlippage.length !== route.pools.length) {
+        throw new Error(`maxHopSlippage length (${maxHopSlippage.length}) must equal route.pools.length (${route.pools.length})`);
+    }
+    const trade = new V2Trade(route, tradeType == TradeType.EXACT_INPUT ? inputAmount : outputAmount, tradeType);
+    const useV2_1_1 = isAtLeastV2_1_1(options.urVersion);
+    if (tradeType == TradeType.EXACT_INPUT) {
+        const params = [
+            // if native, we have to unwrap so keep in the router for now
+            routerMustCustody ? ROUTER_AS_RECIPIENT : options.recipient,
+            trade.maximumAmountIn(options.slippageTolerance).quotient.toString(),
+            // if router will custody funds, we do aggregated slippage check from router
+            routerMustCustody ? 0 : trade.minimumAmountOut(options.slippageTolerance).quotient.toString(),
+            route.path.map((token) => token.wrapped.address),
+            payerIsUser,
+        ];
+        if (useV2_1_1)
+            params.push(maxHopSlippage !== null && maxHopSlippage !== void 0 ? maxHopSlippage : []);
+        planner.addCommand(CommandType.V2_SWAP_EXACT_IN, params, false, options.urVersion);
+    }
+    else if (tradeType == TradeType.EXACT_OUTPUT) {
+        const params = [
+            routerMustCustody ? ROUTER_AS_RECIPIENT : options.recipient,
+            trade.minimumAmountOut(options.slippageTolerance).quotient.toString(),
+            trade.maximumAmountIn(options.slippageTolerance).quotient.toString(),
+            route.path.map((token) => token.wrapped.address),
+            payerIsUser,
+        ];
+        if (useV2_1_1)
+            params.push(maxHopSlippage !== null && maxHopSlippage !== void 0 ? maxHopSlippage : []);
+        planner.addCommand(CommandType.V2_SWAP_EXACT_OUT, params, false, options.urVersion);
+    }
+}
+// encode a uniswap v3 swap
+function addV3Swap(planner, { route, inputAmount, outputAmount, maxHopSlippage }, tradeType, options, payerIsUser, routerMustCustody) {
+    if ((maxHopSlippage === null || maxHopSlippage === void 0 ? void 0 : maxHopSlippage.length) && maxHopSlippage.length !== route.pools.length) {
+        throw new Error(`maxHopSlippage length (${maxHopSlippage.length}) must equal route.pools.length (${route.pools.length})`);
+    }
+    const trade = V3Trade.createUncheckedTrade({
+        route: route,
+        inputAmount,
+        outputAmount,
+        tradeType,
+    });
+    const useV2_1_1 = isAtLeastV2_1_1(options.urVersion);
+    const path = encodeRouteToPath(route, trade.tradeType === TradeType.EXACT_OUTPUT);
+    if (tradeType == TradeType.EXACT_INPUT) {
+        const params = [
+            routerMustCustody ? ROUTER_AS_RECIPIENT : options.recipient,
+            trade.maximumAmountIn(options.slippageTolerance).quotient.toString(),
+            routerMustCustody ? 0 : trade.minimumAmountOut(options.slippageTolerance).quotient.toString(),
+            path,
+            payerIsUser,
+        ];
+        if (useV2_1_1)
+            params.push(maxHopSlippage !== null && maxHopSlippage !== void 0 ? maxHopSlippage : []);
+        planner.addCommand(CommandType.V3_SWAP_EXACT_IN, params, false, options.urVersion);
+    }
+    else if (tradeType == TradeType.EXACT_OUTPUT) {
+        const params = [
+            routerMustCustody ? ROUTER_AS_RECIPIENT : options.recipient,
+            trade.minimumAmountOut(options.slippageTolerance).quotient.toString(),
+            trade.maximumAmountIn(options.slippageTolerance).quotient.toString(),
+            path,
+            payerIsUser,
+        ];
+        if (useV2_1_1)
+            params.push(maxHopSlippage !== null && maxHopSlippage !== void 0 ? maxHopSlippage : []);
+        planner.addCommand(CommandType.V3_SWAP_EXACT_OUT, params, false, options.urVersion);
+    }
+}
+function addV4Swap(planner, { inputAmount, outputAmount, route, maxHopSlippage }, tradeType, options, payerIsUser, routerMustCustody) {
+    var _a, _b;
+    if ((maxHopSlippage === null || maxHopSlippage === void 0 ? void 0 : maxHopSlippage.length) && maxHopSlippage.length !== route.pools.length) {
+        throw new Error(`maxHopSlippage length (${maxHopSlippage.length}) must equal route.pools.length (${route.pools.length})`);
+    }
+    // create a deep copy of pools since v4Planner encoding tampers with array
+    const pools = route.pools.map((p) => p);
+    const v4Route = new V4Route(pools, inputAmount.currency, outputAmount.currency);
+    const trade = V4Trade.createUncheckedTrade({
+        route: v4Route,
+        inputAmount,
+        outputAmount,
+        tradeType,
+    });
+    const slippageToleranceOnSwap = routerMustCustody && tradeType == TradeType.EXACT_INPUT ? undefined : options.slippageTolerance;
+    const perHopSlippage = (_a = maxHopSlippage === null || maxHopSlippage === void 0 ? void 0 : maxHopSlippage.map((s) => BigNumber.from(s))) !== null && _a !== void 0 ? _a : [];
+    const v4Planner = new V4Planner();
+    v4Planner.addTrade(trade, slippageToleranceOnSwap, perHopSlippage, options.urVersion);
+    v4Planner.addSettle(trade.route.pathInput, payerIsUser);
+    // Handle split route output consistency:
+    // - If output is ETH and some routes output WETH: force all to output WETH, then unwrap
+    // - If output is WETH and some routes output ETH: force all to output ETH, then wrap
+    let pathOutputForTake = trade.route.pathOutput;
+    let lastPool = v4Route.pools[v4Route.pools.length - 1];
+    let ethWethPool = lastPool.currency1.equals(lastPool.currency0.wrapped);
+    if (ethWethPool && v4Route.pools.length > 1) {
+        let poolBefore = v4Route.pools[v4Route.pools.length - 2];
+        if (pathOutputForTake.isNative && poolBefore.currency0.isNative) {
+            pathOutputForTake = pathOutputForTake.wrapped;
+        }
+        else if (!pathOutputForTake.isNative &&
+            (poolBefore.currency0.equals(lastPool.currency1) || poolBefore.currency1.equals(lastPool.currency1))) {
+            pathOutputForTake = lastPool.currency0;
+        }
+    }
+    v4Planner.addTake(pathOutputForTake, routerMustCustody ? ROUTER_AS_RECIPIENT : (_b = options.recipient) !== null && _b !== void 0 ? _b : SENDER_AS_RECIPIENT);
+    planner.addCommand(CommandType.V4_SWAP, [v4Planner.finalize()]);
+}
+// encode a mixed route swap, i.e. including both v2 and v3 pools
+function addMixedSwap(planner, swap, tradeType, options, payerIsUser, routerMustCustody) {
+    var _a, _b, _c, _d;
+    const route = swap.route;
+    if (((_a = swap.maxHopSlippage) === null || _a === void 0 ? void 0 : _a.length) && swap.maxHopSlippage.length !== route.pools.length) {
+        throw new Error(`maxHopSlippage length (${swap.maxHopSlippage.length}) must equal route.pools.length (${route.pools.length})`);
+    }
+    const inputAmount = swap.inputAmount;
+    const outputAmount = swap.outputAmount;
+    const tradeRecipient = routerMustCustody ? ROUTER_AS_RECIPIENT : (_b = options.recipient) !== null && _b !== void 0 ? _b : SENDER_AS_RECIPIENT;
+    // single hop, so it can be reduced to plain swap logic for one protocol version
+    if (route.pools.length === 1) {
+        if (route.pools[0] instanceof V4Pool) {
+            return addV4Swap(planner, swap, tradeType, options, payerIsUser, routerMustCustody);
+        }
+        else if (route.pools[0] instanceof V3Pool) {
+            return addV3Swap(planner, swap, tradeType, options, payerIsUser, routerMustCustody);
+        }
+        else if (route.pools[0] instanceof Pair) {
+            return addV2Swap(planner, swap, tradeType, options, payerIsUser, routerMustCustody);
+        }
+        else {
+            throw new Error('Invalid route type');
+        }
+    }
+    const trade = MixedRouteTrade.createUncheckedTrade({
+        route: route,
+        inputAmount,
+        outputAmount,
+        tradeType,
+    });
+    const amountIn = trade.maximumAmountIn(options.slippageTolerance, inputAmount).quotient.toString();
+    const amountOut = routerMustCustody
+        ? 0
+        : trade.minimumAmountOut(options.slippageTolerance, outputAmount).quotient.toString();
+    // logic from
+    // https://github.com/Uniswap/router-sdk/blob/d8eed164e6c79519983844ca8b6a3fc24ebcb8f8/src/swapRouter.ts#L276
+    const sections = partitionMixedRouteByProtocol(route);
+    const isLastSectionInRoute = (i) => {
+        return i === sections.length - 1;
+    };
+    const useV2_1_1 = isAtLeastV2_1_1(options.urVersion);
+    let inputToken = route.pathInput;
+    let hopOffset = 0;
+    for (let i = 0; i < sections.length; i++) {
+        const section = sections[i];
+        const routePool = section[0];
+        const outputToken = getOutputOfPools(section, inputToken);
+        const subRoute = new MixedRoute(new MixedRouteSDK([...section], inputToken, outputToken));
+        // Slice this section's portion of maxHopSlippage from the flat array
+        const sectionHopSlippage = (_c = swap.maxHopSlippage) === null || _c === void 0 ? void 0 : _c.slice(hopOffset, hopOffset + section.length);
+        let nextInputToken;
+        let swapRecipient;
+        if (isLastSectionInRoute(i)) {
+            nextInputToken = outputToken;
+            swapRecipient = tradeRecipient;
+        }
+        else {
+            const nextPool = sections[i + 1][0];
+            nextInputToken = getPathCurrency(outputToken, nextPool);
+            const v2PoolIsSwapRecipient = nextPool instanceof Pair && outputToken.equals(nextInputToken);
+            swapRecipient = v2PoolIsSwapRecipient ? nextPool.liquidityToken.address : ROUTER_AS_RECIPIENT;
+        }
+        if (routePool instanceof V4Pool) {
+            const v4Planner = new V4Planner();
+            const v4SubRoute = new V4Route(section, subRoute.input, subRoute.output);
+            const v4SectionSlippage = (_d = sectionHopSlippage === null || sectionHopSlippage === void 0 ? void 0 : sectionHopSlippage.map((s) => BigNumber.from(s))) !== null && _d !== void 0 ? _d : [];
+            v4Planner.addSettle(inputToken, payerIsUser && i === 0, (i == 0 ? amountIn : CONTRACT_BALANCE));
+            v4Planner.addAction(Actions.SWAP_EXACT_IN, [
+                {
+                    currencyIn: inputToken.isNative ? ETH_ADDRESS : inputToken.address,
+                    path: encodeV4RouteToPath(v4SubRoute),
+                    maxHopSlippage: v4SectionSlippage,
+                    amountIn: 0,
+                    amountOutMinimum: !isLastSectionInRoute(i) ? 0 : amountOut,
+                },
+            ], options.urVersion);
+            // Handle split route output consistency for V4 sections in mixed routes
+            let outputTokenForTake = outputToken;
+            if (isLastSectionInRoute(i)) {
+                let lastPool = route.pools[route.pools.length - 1];
+                let v4Pool = lastPool instanceof V4Pool;
+                let ethWethPool = v4Pool ? lastPool.currency1.equals(lastPool.currency0.wrapped) : false;
+                let poolBefore = route.pools[route.pools.length - 2];
+                if (ethWethPool) {
+                    if (outputToken.isNative && poolBefore.token0.isNative) {
+                        outputTokenForTake = outputToken.wrapped;
+                    }
+                    else if (!outputToken.isNative &&
+                        (poolBefore.token0.equals(lastPool.token1) || poolBefore.token1.equals(lastPool.token1))) {
+                        outputTokenForTake = lastPool.token0;
+                    }
+                }
+            }
+            v4Planner.addTake(outputTokenForTake, swapRecipient);
+            planner.addCommand(CommandType.V4_SWAP, [v4Planner.finalize()]);
+        }
+        else if (routePool instanceof V3Pool) {
+            const v3Params = [
+                swapRecipient,
+                i == 0 ? amountIn : CONTRACT_BALANCE,
+                !isLastSectionInRoute(i) ? 0 : amountOut,
+                encodeMixedRouteToPath(subRoute),
+                payerIsUser && i === 0, // payerIsUser
+            ];
+            if (useV2_1_1)
+                v3Params.push(sectionHopSlippage !== null && sectionHopSlippage !== void 0 ? sectionHopSlippage : []);
+            planner.addCommand(CommandType.V3_SWAP_EXACT_IN, v3Params, false, options.urVersion);
+        }
+        else if (routePool instanceof Pair) {
+            const v2Params = [
+                swapRecipient,
+                i === 0 ? amountIn : CONTRACT_BALANCE,
+                !isLastSectionInRoute(i) ? 0 : amountOut,
+                subRoute.path.map((token) => token.wrapped.address),
+                payerIsUser && i === 0,
+            ];
+            if (useV2_1_1)
+                v2Params.push(sectionHopSlippage !== null && sectionHopSlippage !== void 0 ? sectionHopSlippage : []);
+            planner.addCommand(CommandType.V2_SWAP_EXACT_IN, v2Params, false, options.urVersion);
+        }
+        else {
+            throw new Error('Unexpected Pool Type');
+        }
+        // perform a token transition (wrap/unwrap if necessary)
+        if (!isLastSectionInRoute(i)) {
+            if (outputToken.isNative && !nextInputToken.isNative) {
+                planner.addCommand(CommandType.WRAP_ETH, [ROUTER_AS_RECIPIENT, CONTRACT_BALANCE]);
+            }
+            else if (!outputToken.isNative && nextInputToken.isNative) {
+                planner.addCommand(CommandType.UNWRAP_WETH, [ROUTER_AS_RECIPIENT, 0]);
+            }
+        }
+        hopOffset += section.length;
+        inputToken = nextInputToken;
+    }
+}
+// if price impact is very high, there's a chance of hitting max/min prices resulting in a partial fill of the swap
+function riskOfPartialFill(trade) {
+    return trade.priceImpact.greaterThan(REFUND_ETH_PRICE_IMPACT_THRESHOLD);
+}
+function hasFeeOption(swapOptions) {
+    return !!swapOptions.fee || !!swapOptions.flatFee;
+}
+//# sourceMappingURL=uniswap.js.map