@uniswap/universal-router-sdk 4.4.0 → 4.4.2

package/dist/universal-router-sdk.esm.js

@@ -2,12 +2,12 @@ import invariant from 'tiny-invariant';
 import { abi } from '@uniswap/universal-router/artifacts/contracts/UniversalRouter.sol/UniversalRouter.json';
 import { Interface } from '@ethersproject/abi';
 import { BigNumber, ethers } from 'ethers';
-import { toHex, Trade as Trade$1, encodeRouteToPath, Pool, NonfungiblePositionManager, Route } from '@uniswap/v3-sdk';
-import { Trade as Trade$2, V4Planner, V4PositionManager, V4BaseActionsParser } from '@uniswap/v4-sdk';
+import { toHex, Trade as Trade$1, encodeRouteToPath, Pool as Pool$1, NonfungiblePositionManager, Route as Route$1 } from '@uniswap/v3-sdk';
+import { Pool, Trade as Trade$2, V4Planner, Route, Actions, encodeRouteToPath as encodeRouteToPath$1, V4PositionManager, V4BaseActionsParser } from '@uniswap/v4-sdk';
 import { TradeType, Percent, validateAndParseAddress, CHAIN_TO_ADDRESSES_MAP, CurrencyAmount, Ether, Token } from '@uniswap/sdk-core';
 import { defaultAbiCoder } from 'ethers/lib/utils';
-import { Trade, Pair, Route as Route$1 } from '@uniswap/v2-sdk';
-import { Protocol, MixedRouteTrade, partitionMixedRouteByProtocol, getOutputOfPools, MixedRouteSDK, MixedRoute, encodeMixedRouteToPath, Trade as Trade$3 } from '@uniswap/router-sdk';
+import { Trade, Pair, Route as Route$2 } from '@uniswap/v2-sdk';
+import { Protocol, MixedRouteTrade, partitionMixedRouteByProtocol, getOutputOfPools, MixedRoute, MixedRouteSDK, encodeMixedRouteToPath, Trade as Trade$3 } from '@uniswap/router-sdk';
 import 'jsbi';
 import 'bignumber.js';
 
@@ -366,6 +366,27 @@ function createCommand(type, parameters) {
   }
 }
 
+function getPathCurrency(currency, pool) {
+  // return currency if the currency matches a currency of the pool
+  if (pool.involvesToken(currency)) {
+    return currency;
+    // return if currency.wrapped if pool involves wrapped currency
+  } else if (pool.involvesToken(currency.wrapped)) {
+    return currency.wrapped;
+    // return native currency if pool involves native version of wrapped currency (only applies to V4)
+  } else if (pool instanceof Pool) {
+    if (pool.token0.wrapped.equals(currency)) {
+      return pool.token0;
+    } else if (pool.token1.wrapped.equals(currency)) {
+      return pool.token1;
+    }
+    // otherwise the token is invalid
+  } else {
+    throw new Error("Expected currency " + currency.symbol + " to be either " + pool.token0.symbol + " or " + pool.token1.symbol);
+  }
+  return currency; // this line needed for typescript to compile
+}
+
 var RouterActionType;
 (function (RouterActionType) {
   RouterActionType["UniswapTrade"] = "UniswapTrade";
@@ -557,8 +578,8 @@ var CHAIN_CONFIGS = (_CHAIN_CONFIGS = {}, _CHAIN_CONFIGS[1] = {
     address: '0x8909Dc15e40173Ff4699343b6eB8132c65e18eC6',
     creationBlock: 1241811
   }, _routerConfigs20[UniversalRouterVersion.V2_0] = {
-    address: '0x8909Dc15e40173Ff4699343b6eB8132c65e18eC6',
-    creationBlock: 1241811
+    address: '0xcA7577Afb670147c7b211C798B97118bd36058F3',
+    creationBlock: 1490973
   }, _routerConfigs20)
 }, _CHAIN_CONFIGS);
 var UNIVERSAL_ROUTER_ADDRESS = function UNIVERSAL_ROUTER_ADDRESS(version, chainId) {
@@ -621,7 +642,7 @@ var UniswapTrade = /*#__PURE__*/function () {
           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, performAggregatedSlippageCheck);
+          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);
@@ -743,7 +764,7 @@ function addV3Swap(planner, _ref2, tradeType, options, payerIsUser, routerMustCu
     planner.addCommand(CommandType.V3_SWAP_EXACT_OUT, [routerMustCustody ? ROUTER_AS_RECIPIENT : options.recipient, trade.minimumAmountOut(options.slippageTolerance).quotient.toString(), trade.maximumAmountIn(options.slippageTolerance).quotient.toString(), path, payerIsUser]);
   }
 }
-function addV4Swap(planner, _ref3, tradeType, options, payerIsUser, routerMustCustody, performAggregatedSlippageCheck) {
+function addV4Swap(planner, _ref3, tradeType, options, payerIsUser, routerMustCustody) {
   var _options$recipient;
   var route = _ref3.route,
     inputAmount = _ref3.inputAmount,
@@ -754,7 +775,7 @@ function addV4Swap(planner, _ref3, tradeType, options, payerIsUser, routerMustCu
     outputAmount: outputAmount,
     tradeType: tradeType
   });
-  var slippageToleranceOnSwap = performAggregatedSlippageCheck ? undefined : options.slippageTolerance;
+  var slippageToleranceOnSwap = routerMustCustody && tradeType == TradeType.EXACT_INPUT ? undefined : options.slippageTolerance;
   var inputWethFromRouter = inputAmount.currency.isNative && !route.input.isNative;
   if (inputWethFromRouter && !payerIsUser) throw new Error('Inconsistent payer');
   var v4Planner = new V4Planner();
@@ -766,13 +787,16 @@ function addV4Swap(planner, _ref3, tradeType, options, payerIsUser, routerMustCu
 }
 // encode a mixed route swap, i.e. including both v2 and v3 pools
 function addMixedSwap(planner, swap, tradeType, options, payerIsUser, routerMustCustody) {
-  var route = swap.route,
-    inputAmount = swap.inputAmount,
-    outputAmount = swap.outputAmount;
-  var tradeRecipient = routerMustCustody ? ROUTER_AS_RECIPIENT : options.recipient;
-  // single hop, so it can be reduced to plain v2 or v3 swap logic
+  var _options$recipient2;
+  var route = swap.route;
+  var inputAmount = swap.inputAmount;
+  var outputAmount = swap.outputAmount;
+  var tradeRecipient = routerMustCustody ? ROUTER_AS_RECIPIENT : (_options$recipient2 = options.recipient) != null ? _options$recipient2 : 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 Pool) {
+      return addV4Swap(planner, swap, tradeType, options, payerIsUser, routerMustCustody);
+    } else if (route.pools[0] instanceof Pool$1) {
       return addV3Swap(planner, swap, tradeType, options, payerIsUser, routerMustCustody);
     } else if (route.pools[0] instanceof Pair) {
       return addV2Swap(planner, swap, tradeType, options, payerIsUser, routerMustCustody);
@@ -794,32 +818,53 @@ function addMixedSwap(planner, swap, tradeType, options, payerIsUser, routerMust
   var isLastSectionInRoute = function isLastSectionInRoute(i) {
     return i === sections.length - 1;
   };
-  var outputToken;
-  var inputToken = route.input.wrapped;
+  var inputToken = route.pathInput;
   for (var i = 0; i < sections.length; i++) {
     var section = sections[i];
-    /// Now, we get output of this section
-    outputToken = getOutputOfPools(section, inputToken);
-    var newRouteOriginal = new MixedRouteSDK([].concat(section), section[0].token0.equals(inputToken) ? section[0].token0 : section[0].token1, outputToken);
-    var newRoute = new MixedRoute(newRouteOriginal);
-    /// Previous output is now input
-    inputToken = outputToken.wrapped;
-    var mixedRouteIsAllV3 = function mixedRouteIsAllV3(route) {
-      return route.pools.every(function (pool) {
-        return pool instanceof Pool;
-      });
-    };
-    if (mixedRouteIsAllV3(newRoute)) {
-      var path = encodeMixedRouteToPath(newRoute);
-      planner.addCommand(CommandType.V3_SWAP_EXACT_IN, [
-      // if not last section: send tokens directly to the first v2 pair of the next section
-      // note: because of the partitioning function we can be sure that the next section is v2
-      isLastSectionInRoute(i) ? tradeRecipient : sections[i + 1][0].liquidityToken.address, i == 0 ? amountIn : CONTRACT_BALANCE, !isLastSectionInRoute(i) ? 0 : amountOut, path, payerIsUser && i === 0]);
+    var routePool = section[0];
+    var outputToken = getOutputOfPools(section, inputToken);
+    var subRoute = new MixedRoute(new MixedRouteSDK([].concat(section), inputToken, outputToken));
+    var nextInputToken = void 0;
+    var swapRecipient = void 0;
+    if (isLastSectionInRoute(i)) {
+      nextInputToken = outputToken;
+      swapRecipient = tradeRecipient;
     } else {
-      planner.addCommand(CommandType.V2_SWAP_EXACT_IN, [isLastSectionInRoute(i) ? tradeRecipient : ROUTER_AS_RECIPIENT, i === 0 ? amountIn : CONTRACT_BALANCE, !isLastSectionInRoute(i) ? 0 : amountOut, newRoute.path.map(function (token) {
+      var nextPool = sections[i + 1][0];
+      nextInputToken = getPathCurrency(outputToken, nextPool);
+      var v2PoolIsSwapRecipient = nextPool instanceof Pair && outputToken.equals(nextInputToken);
+      swapRecipient = v2PoolIsSwapRecipient ? nextPool.liquidityToken.address : ROUTER_AS_RECIPIENT;
+    }
+    if (routePool instanceof Pool) {
+      var v4Planner = new V4Planner();
+      var v4SubRoute = new Route(section, subRoute.input, subRoute.output);
+      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: encodeRouteToPath$1(v4SubRoute),
+        amountIn: 0,
+        amountOutMinimum: !isLastSectionInRoute(i) ? 0 : amountOut
+      }]);
+      v4Planner.addTake(outputToken, swapRecipient);
+      planner.addCommand(CommandType.V4_SWAP, [v4Planner.finalize()]);
+    } else if (routePool instanceof Pool$1) {
+      planner.addCommand(CommandType.V3_SWAP_EXACT_IN, [swapRecipient, i == 0 ? amountIn : CONTRACT_BALANCE, !isLastSectionInRoute(i) ? 0 : amountOut, encodeMixedRouteToPath(subRoute), payerIsUser && i === 0]);
+    } else if (routePool instanceof Pair) {
+      planner.addCommand(CommandType.V2_SWAP_EXACT_IN, [swapRecipient, i === 0 ? amountIn : CONTRACT_BALANCE, !isLastSectionInRoute(i) ? 0 : amountOut, subRoute.path.map(function (token) {
         return token.wrapped.address;
       }), payerIsUser && i === 0]);
+    } 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]);
+      }
     }
+    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
@@ -977,6 +1022,7 @@ var PoolType;
 (function (PoolType) {
   PoolType["V2Pool"] = "v2-pool";
   PoolType["V3Pool"] = "v3-pool";
+  PoolType["V4Pool"] = "v4-pool";
 })(PoolType || (PoolType = {}));
 var isNativeCurrency = function isNativeCurrency(address) {
   return address.toLowerCase() === ETH_ADDRESS.toLowerCase() || address.toLowerCase() === E_ETH_ADDRESS.toLowerCase();
@@ -1013,8 +1059,8 @@ var RouterTradeAdapter = /*#__PURE__*/function () {
       var isOnlyV2 = RouterTradeAdapter.isVersionedRoute(PoolType.V2Pool, subRoute);
       var isOnlyV3 = RouterTradeAdapter.isVersionedRoute(PoolType.V3Pool, subRoute);
       return {
-        routev3: isOnlyV3 ? new Route(subRoute.map(RouterTradeAdapter.toPool), parsedCurrencyIn, parsedCurrencyOut) : null,
-        routev2: isOnlyV2 ? new Route$1(subRoute.map(RouterTradeAdapter.toPair), parsedCurrencyIn, parsedCurrencyOut) : null,
+        routev3: isOnlyV3 ? new Route$1(subRoute.map(RouterTradeAdapter.toPool), parsedCurrencyIn, parsedCurrencyOut) : null,
+        routev2: isOnlyV2 ? new Route$2(subRoute.map(RouterTradeAdapter.toPair), parsedCurrencyIn, parsedCurrencyOut) : null,
         mixedRoute: !isOnlyV3 && !isOnlyV2 ? new MixedRouteSDK(subRoute.map(RouterTradeAdapter.toPoolOrPair), parsedCurrencyIn, parsedCurrencyOut) : null,
         inputAmount: inputAmount,
         outputAmount: outputAmount
@@ -1075,7 +1121,7 @@ var RouterTradeAdapter = /*#__PURE__*/function () {
       tickCurrent = _ref.tickCurrent,
       tokenIn = _ref.tokenIn,
       tokenOut = _ref.tokenOut;
-    return new Pool(RouterTradeAdapter.toToken(tokenIn), RouterTradeAdapter.toToken(tokenOut), parseInt(fee), sqrtRatioX96, liquidity, parseInt(tickCurrent));
+    return new Pool$1(RouterTradeAdapter.toToken(tokenIn), RouterTradeAdapter.toToken(tokenOut), parseInt(fee), sqrtRatioX96, liquidity, parseInt(tickCurrent));
   };
   RouterTradeAdapter.isVersionedRoute = function isVersionedRoute(type, route) {
     return route.every(function (pool) {