@uniswap/universal-router-sdk 4.5.1 → 4.6.0

package/dist/swapRouter.d.ts

@@ -26,7 +26,7 @@ export declare abstract class SwapRouter {
      *   - input pool and output pool must have the same tokens
      *   - V3 NFT must be approved, or valid inputV3NFTPermit must be provided with UR as spender
      */
-    static migrateV3ToV4CallParameters(options: MigrateV3ToV4Options): MethodParameters;
+    static migrateV3ToV4CallParameters(options: MigrateV3ToV4Options, positionManagerOverride?: string): MethodParameters;
     /**
      * Encodes a planned route into a method name and parameters for the Router contract.
      * @param planner the planned route

package/dist/test/utils/addresses.d.ts

@@ -1,8 +1,5 @@
-export declare const MAINNET_ROUTER_ADDRESS: string;
-export declare const FORGE_ROUTER_ADDRESS = "0xe808c1cfeebb6cb36b537b82fa7c9eef31415a05";
-export declare const FORGE_PERMIT2_ADDRESS = "0x4a873bdd49f7f9cc0a5458416a12973fab208f8d";
+export declare const FORGE_V4_POSITION_MANAGER = "0x2e234DAe75C793f67A35089C9d99245E1C58470b";
 export declare const FORGE_SENDER_ADDRESS = "0xcf03dd0a894ef79cb5b601a43c4b25e3ae4c67ed";
 export declare const TEST_RECIPIENT_ADDRESS = "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
 export declare const TEST_FEE_RECIPIENT_ADDRESS = "0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb";
-export declare const PERMIT2_ADDRESS: any;
-export declare const ROUTER_ADDRESS: string;
+export declare const PERMIT2_ADDRESS = "0x000000000022D473030F116dDEE9F6B43aC78BA3";

package/dist/universal-router-sdk.cjs.development.js

@@ -99,7 +99,8 @@ var _COMMAND_DEFINITION;
   CommandType[CommandType["V4_SWAP"] = 16] = "V4_SWAP";
   CommandType[CommandType["V3_POSITION_MANAGER_PERMIT"] = 17] = "V3_POSITION_MANAGER_PERMIT";
   CommandType[CommandType["V3_POSITION_MANAGER_CALL"] = 18] = "V3_POSITION_MANAGER_CALL";
-  CommandType[CommandType["V4_POSITION_CALL"] = 19] = "V4_POSITION_CALL";
+  CommandType[CommandType["V4_INITIALIZE_POOL"] = 19] = "V4_INITIALIZE_POOL";
+  CommandType[CommandType["V4_POSITION_MANAGER_CALL"] = 20] = "V4_POSITION_MANAGER_CALL";
   CommandType[CommandType["EXECUTE_SUB_PLAN"] = 33] = "EXECUTE_SUB_PLAN";
 })(exports.CommandType || (exports.CommandType = {}));
 (function (Subparser) {
@@ -115,6 +116,7 @@ var ALLOW_REVERT_FLAG = 0x80;
 var REVERTIBLE_COMMANDS = /*#__PURE__*/new Set([exports.CommandType.EXECUTE_SUB_PLAN]);
 var PERMIT_STRUCT = '((address token,uint160 amount,uint48 expiration,uint48 nonce) details,address spender,uint256 sigDeadline)';
 var PERMIT_BATCH_STRUCT = '((address token,uint160 amount,uint48 expiration,uint48 nonce)[] details,address spender,uint256 sigDeadline)';
+var POOL_KEY_STRUCT = '(address currency0,address currency1,uint24 fee,int24 tickSpacing,address hooks)';
 var PERMIT2_TRANSFER_FROM_STRUCT = '(address from,address to,uint160 amount,address token)';
 var PERMIT2_TRANSFER_FROM_BATCH_STRUCT = PERMIT2_TRANSFER_FROM_STRUCT + '[]';
 var COMMAND_DEFINITION = (_COMMAND_DEFINITION = {}, _COMMAND_DEFINITION[exports.CommandType.EXECUTE_SUB_PLAN] = {
@@ -304,11 +306,20 @@ var COMMAND_DEFINITION = (_COMMAND_DEFINITION = {}, _COMMAND_DEFINITION[exports.
     name: 'minBalance',
     type: 'uint256'
   }]
+}, _COMMAND_DEFINITION[exports.CommandType.V4_INITIALIZE_POOL] = {
+  parser: exports.Parser.Abi,
+  params: [{
+    name: 'poolKey',
+    type: POOL_KEY_STRUCT
+  }, {
+    name: 'sqrtPriceX96',
+    type: 'uint160'
+  }]
 }, _COMMAND_DEFINITION[exports.CommandType.V3_POSITION_MANAGER_PERMIT] = {
   parser: exports.Parser.V3Actions
 }, _COMMAND_DEFINITION[exports.CommandType.V3_POSITION_MANAGER_CALL] = {
   parser: exports.Parser.V3Actions
-}, _COMMAND_DEFINITION[exports.CommandType.V4_POSITION_CALL] = {
+}, _COMMAND_DEFINITION[exports.CommandType.V4_POSITION_MANAGER_CALL] = {
   parser: exports.Parser.V4Actions
 }, _COMMAND_DEFINITION);
 var RoutePlanner = /*#__PURE__*/function () {
@@ -936,31 +947,53 @@ var SwapRouter = /*#__PURE__*/function () {
    *   - input pool and output pool must have the same tokens
    *   - V3 NFT must be approved, or valid inputV3NFTPermit must be provided with UR as spender
    */;
-  SwapRouter.migrateV3ToV4CallParameters = function migrateV3ToV4CallParameters(options) {
+  SwapRouter.migrateV3ToV4CallParameters = function migrateV3ToV4CallParameters(options, positionManagerOverride) {
+    var v4Pool = options.outputPosition.pool;
     var token0 = options.inputPosition.pool.token0;
     var token1 = options.inputPosition.pool.token1;
-    var v4PositionManagerAddress = sdkCore.CHAIN_TO_ADDRESSES_MAP[options.outputPosition.pool.chainId].v4PositionManagerAddress;
-    !(token0 === options.outputPosition.pool.token0) ?  invariant(false, 'TOKEN0_MISMATCH')  : void 0;
-    !(token1 === options.outputPosition.pool.token1) ?  invariant(false, 'TOKEN1_MISMATCH')  : void 0;
+    var v4PositionManagerAddress = positionManagerOverride != null ? positionManagerOverride : sdkCore.CHAIN_TO_ADDRESSES_MAP[v4Pool.chainId].v4PositionManagerAddress;
+    // validate the parameters
+    !(token0 === v4Pool.token0) ?  invariant(false, 'TOKEN0_MISMATCH')  : void 0;
+    !(token1 === v4Pool.token1) ?  invariant(false, 'TOKEN1_MISMATCH')  : void 0;
     !options.v3RemoveLiquidityOptions.liquidityPercentage.equalTo(new sdkCore.Percent(100, 100)) ?  invariant(false, 'FULL_REMOVAL_REQUIRED')  : void 0;
     !(options.v3RemoveLiquidityOptions.burnToken == true) ?  invariant(false, 'BURN_TOKEN_REQUIRED')  : void 0;
     !(options.v3RemoveLiquidityOptions.collectOptions.recipient === v4PositionManagerAddress) ?  invariant(false, 'RECIPIENT_NOT_POSITION_MANAGER')  : void 0;
     !isMint(options.v4AddLiquidityOptions) ?  invariant(false, 'MINT_REQUIRED')  : void 0;
     !options.v4AddLiquidityOptions.migrate ?  invariant(false, 'MIGRATE_REQUIRED')  : void 0;
     var planner = new RoutePlanner();
+    // to prevent reentrancy by the pool hook, we initialize the v4 pool before moving funds
+    if (options.v4AddLiquidityOptions.createPool) {
+      var poolKey = v4Sdk.Pool.getPoolKey(v4Pool.currency0, v4Pool.currency1, v4Pool.fee, v4Pool.tickSpacing, v4Pool.hooks);
+      planner.addCommand(exports.CommandType.V4_INITIALIZE_POOL, [poolKey, v4Pool.sqrtRatioX96.toString()]);
+      // remove createPool setting, so that it doesnt get encoded again later
+      delete options.v4AddLiquidityOptions.createPool;
+    }
+    // add position permit to the universal router planner
     if (options.v3RemoveLiquidityOptions.permit) {
       // permit spender should be UR
       var universalRouterAddress = UNIVERSAL_ROUTER_ADDRESS(exports.UniversalRouterVersion.V2_0, options.inputPosition.pool.chainId);
       !(universalRouterAddress == options.v3RemoveLiquidityOptions.permit.spender) ?  invariant(false, 'INVALID_SPENDER')  : void 0;
       // don't need to transfer it because v3posm uses isApprovedOrOwner()
       encodeV3PositionPermit(planner, options.v3RemoveLiquidityOptions.permit, options.v3RemoveLiquidityOptions.tokenId);
+      // remove permit so that multicall doesnt add it again
+      delete options.v3RemoveLiquidityOptions.permit;
     }
     // encode v3 withdraw
     var v3RemoveParams = v3Sdk.NonfungiblePositionManager.removeCallParameters(options.inputPosition, options.v3RemoveLiquidityOptions);
-    planner.addCommand(exports.CommandType.V3_POSITION_MANAGER_CALL, [v3RemoveParams.calldata]);
+    var v3Calls = v3Sdk.Multicall.decodeMulticall(v3RemoveParams.calldata);
+    for (var _iterator = _createForOfIteratorHelperLoose(v3Calls), _step; !(_step = _iterator()).done;) {
+      var v3Call = _step.value;
+      // slice selector - 0x + 4 bytes = 10 characters
+      var _selector = v3Call.slice(0, 10);
+      !(_selector == v3Sdk.NonfungiblePositionManager.INTERFACE.getSighash('collect') || _selector == v3Sdk.NonfungiblePositionManager.INTERFACE.getSighash('decreaseLiquidity') || _selector == v3Sdk.NonfungiblePositionManager.INTERFACE.getSighash('burn')) ?  invariant(false, 'INVALID_V3_CALL: ' + _selector)  : void 0;
+      planner.addCommand(exports.CommandType.V3_POSITION_MANAGER_CALL, [v3Call]);
+    }
     // encode v4 mint
     var v4AddParams = v4Sdk.V4PositionManager.addCallParameters(options.outputPosition, options.v4AddLiquidityOptions);
-    planner.addCommand(exports.CommandType.V4_POSITION_CALL, [v4AddParams.calldata]);
+    // only modifyLiquidities can be called by the UniversalRouter
+    var selector = v4AddParams.calldata.slice(0, 10);
+    !(selector == v4Sdk.V4PositionManager.INTERFACE.getSighash('modifyLiquidities')) ?  invariant(false, 'INVALID_V4_CALL: ' + selector)  : void 0;
+    planner.addCommand(exports.CommandType.V4_POSITION_MANAGER_CALL, [v4AddParams.calldata]);
     return SwapRouter.encodePlan(planner, ethers.BigNumber.from(0), {
       deadline: ethers.BigNumber.from(options.v4AddLiquidityOptions.deadline)
     });