feat: updated universal router dependencies (#29)

* feat: update universal router with new action and position call protection

* test: fix test case

* feat: reduce optimizer runs

* cleanup: remove unused code

* refactor 3: move v3 position manager refactoring to v3tov4migrator

* refactor 4: tweak permit2 call

* feat: updated test from latest periphery

* updated pancake-v4-periphery dependency

* feat: bump foundry to 20_000 runs to reduce gas

* feat: updated gas cost

* doc: update command comments

.forge-snapshots/BinNativePancakeSwapV4Test#test_v4BinSwap_ExactInSingle_NativeIn.snap

@@ -1 +1 @@
-146493
+146600

.forge-snapshots/BinNativePancakeSwapV4Test#test_v4BinSwap_ExactInSingle_NativeOut_RouterRecipient.snap

@@ -1 +1 @@
-123551
+123658

.forge-snapshots/BinNativePancakeSwapV4Test#test_v4BinSwap_v4InitializeBinPool.snap

@@ -1 +1 @@
-138896
+138516

.forge-snapshots/BinPancakeSwapV4Test#test_v4BinSwap_ExactInSingle.snap

@@ -1 +1 @@
-147458
+147526

.forge-snapshots/BinPancakeSwapV4Test#test_v4BinSwap_ExactIn_MultiHop.snap

@@ -1 +1 @@
-178619
+178993

.forge-snapshots/BinPancakeSwapV4Test#test_v4BinSwap_ExactIn_SingleHop.snap

@@ -1 +1 @@
-149260
+149328

.forge-snapshots/BinPancakeSwapV4Test#test_v4BinSwap_ExactOut_MultiHop.snap

@@ -1 +1 @@
-182464
+182832

.forge-snapshots/BinPancakeSwapV4Test#test_v4BinSwap_ExactOut_SingleHop.snap

@@ -1 +1 @@
-153635
+153700

.forge-snapshots/BinPancakeSwapV4Test#test_v4BinSwap_InitializeBinPool.snap

@@ -1 +1 @@
-159086
+158706

.forge-snapshots/BinPancakeSwapV4Test#test_v4ClSwap_ExactOutSingle.snap

@@ -1 +1 @@
-151835
+151900

.forge-snapshots/CLNativePancakeSwapV4Test#test_v4ClSwap_ExactInSingle_NativeIn.snap

@@ -1 +1 @@
-172172
+171287

.forge-snapshots/CLNativePancakeSwapV4Test#test_v4ClSwap_ExactInSingle_NativeOut.snap

@@ -1 +1 @@
-174498
+173679

.forge-snapshots/CLNativePancakeSwapV4Test#test_v4ClSwap_v4InitializeClPool.snap

@@ -1 +1 @@
-140202
+139286

.forge-snapshots/CLPancakeSwapV4Test#test_v4ClSwap_ExactInSingle.snap

@@ -1 +1 @@
-181612
+180567

.forge-snapshots/CLPancakeSwapV4Test#test_v4ClSwap_ExactIn_MultiHop.snap

@@ -1 +1 @@
-246440
+245086

.forge-snapshots/CLPancakeSwapV4Test#test_v4ClSwap_ExactIn_SingleHop.snap

@@ -1 +1 @@
-183158
+182362

.forge-snapshots/CLPancakeSwapV4Test#test_v4ClSwap_ExactOutSingle.snap

@@ -1 +1 @@
-185947
+184903

.forge-snapshots/CLPancakeSwapV4Test#test_v4ClSwap_ExactOut_MultiHop.snap

@@ -1 +1 @@
-250199
+248853

.forge-snapshots/CLPancakeSwapV4Test#test_v4ClSwap_ExactOut_SingleHop.snap

@@ -1 +1 @@
-187490
+186698

.forge-snapshots/CLPancakeSwapV4Test#test_v4ClSwap_v4InitializeClPool.snap

@@ -1 +1 @@
-160342
+159426

.forge-snapshots/PancakeSwapV2Test#test_v2Swap_exactInput0For1.snap

@@ -1 +1 @@
-100185
+100167

.forge-snapshots/PancakeSwapV2Test#test_v2Swap_exactOutput0For1.snap

@@ -1 +1 @@
-100797
+100791

.forge-snapshots/PancakeSwapV3Test#test_v3Swap_ExactInput0For1_ContractBalance.snap

@@ -1 +1 @@
-154817
+154811

.forge-snapshots/StableSwapTest#test_stableSwap_ExactInput0For1.snap

@@ -1 +1 @@
-194002
+193988

.forge-snapshots/StableSwapTest#test_stableSwap_ExactInput1For0.snap

@@ -1 +1 @@
-194070
+194056

.forge-snapshots/UniversalRouterBytecodeSize.snap

@@ -1 +1 @@
-24246
+24429

.forge-snapshots/UniversalRouterTest#test_sweep_token.snap

@@ -1 +1 @@
-55435
+55429

.forge-snapshots/V3ToV4MigrationNativeTest#test_v4CLPositionmanager_Mint_Native.snap

@@ -1 +1 @@
-561379
+561167

.forge-snapshots/V3ToV4MigrationTest#test_v3PositionManager_burn.snap

@@ -1 +1 @@
-291572
+291562

.forge-snapshots/V3ToV4MigrationTest#test_v4BinPositionmanager_BinAddLiquidity.snap

@@ -1 +1 @@
-597025
+596229

.forge-snapshots/V3ToV4MigrationTest#test_v4BinPositionmanager_BinAddLiquidity_Native.snap

@@ -1 +1 @@
-572739
+572106

.forge-snapshots/V3ToV4MigrationTest#test_v4CLPositionmanager_Mint.snap

@@ -1 +1 @@
-585675
+585306

foundry.toml

@@ -3,7 +3,7 @@ src = "src"
 out = 'foundry-out'
 libs = ["lib"]
 via_ir = true
-optimizer_runs = 10_000
+optimizer_runs = 20_000
 ffi = true
 fs_permissions = [
     { access = "read-write", path = ".forge-snapshots/" },

src/base/Dispatcher.sol

@@ -290,21 +290,17 @@ abstract contract Dispatcher is
                         poolKey := inputs.offset
                         sqrtPriceX96 := calldataload(add(inputs.offset, 0xc0)) // poolKey has 6 variable, so it takes 192 space = 0xc0
                     }
-                    // <wip> remove "" hookData once we updated universal-router dependencies
-                    (success, output) = address(clPoolManager).call(
-                        abi.encodeCall(ICLPoolManager.initialize, (poolKey, sqrtPriceX96, ""))
-                    );
+                    (success, output) =
+                        address(clPoolManager).call(abi.encodeCall(ICLPoolManager.initialize, (poolKey, sqrtPriceX96)));
                 } else if (command == Commands.V4_BIN_INITIALIZE_POOL) {
                     PoolKey calldata poolKey;
                     uint24 activeId;
                     assembly {
                         poolKey := inputs.offset
                         activeId := calldataload(add(inputs.offset, 0xc0)) // poolKey has 6 variable, so it takes 192 space = 0xc0
                     }
-                    // <wip> remove "" hookData once we updated universal-router dependencies
-                    (success, output) = address(binPoolManager).call(
-                        abi.encodeCall(IBinPoolManager.initialize, (poolKey, activeId, ""))
-                    );
+                    (success, output) =
+                        address(binPoolManager).call(abi.encodeCall(IBinPoolManager.initialize, (poolKey, activeId)));
                 } else if (command == Commands.V4_CL_POSITION_CALL) {
                     _checkV4ClPositionManagerCall(inputs);
                     (success, output) = address(V4_CL_POSITION_MANAGER).call{value: address(this).balance}(inputs);

src/libraries/Commands.sol

@@ -39,7 +39,7 @@ library Commands {
     uint256 constant V4_BIN_INITIALIZE_POOL = 0x14;
     uint256 constant V4_CL_POSITION_CALL = 0x15;
     uint256 constant V4_BIN_POSITION_CALL = 0x16;
-    // COMMAND_PLACEHOLDER = 0x15 -> 0x20
+    // COMMAND_PLACEHOLDER = 0x17 -> 0x20
 
     // Command Types where 0x21<=value<=0x3f
     uint256 constant EXECUTE_SUB_PLAN = 0x21;

test/UniversalRouter.crossVersion.t.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.15;
 import {Test, console} from "forge-std/Test.sol";
 import {GasSnapshot} from "forge-gas-snapshot/GasSnapshot.sol";
 import {IAllowanceTransfer} from "permit2/src/interfaces/IAllowanceTransfer.sol";
+import {IWETH9} from "pancake-v4-periphery/src/interfaces/external/IWETH9.sol";
 import {WETH} from "solmate/src/tokens/WETH.sol";
 import {MockERC20} from "solmate/src/test/utils/mocks/MockERC20.sol";
 
@@ -21,6 +22,7 @@ import {CLPoolParametersHelper} from "pancake-v4-core/src/pool-cl/libraries/CLPo
 import {BinPoolParametersHelper} from "pancake-v4-core/src/pool-bin/libraries/BinPoolParametersHelper.sol";
 import {ActionConstants} from "pancake-v4-periphery/src/libraries/ActionConstants.sol";
 import {Plan, Planner} from "pancake-v4-periphery/src/libraries/Planner.sol";
+import {CLPositionDescriptorOffChain} from "pancake-v4-periphery/src/pool-cl/CLPositionDescriptorOffChain.sol";
 import {CLPositionManager} from "pancake-v4-periphery/src/pool-cl/CLPositionManager.sol";
 import {BinPositionManager} from "pancake-v4-periphery/src/pool-bin/BinPositionManager.sol";
 import {Actions} from "pancake-v4-periphery/src/libraries/Actions.sol";
@@ -112,8 +114,10 @@ contract UniversalRouterCrossVersionTest is BasePancakeSwapV4, OldVersionHelper,
         vault.registerApp(address(binPoolManager));
         vault.registerApp(address(clPoolManager));
 
-        binPositionManager = new BinPositionManager(vault, binPoolManager, permit2);
-        clPositionManager = new CLPositionManager(vault, clPoolManager, permit2, 100_000);
+        binPositionManager = new BinPositionManager(vault, binPoolManager, permit2, IWETH9(address(weth)));
+        CLPositionDescriptorOffChain pd =
+            new CLPositionDescriptorOffChain("https://pancakeswap.finance/v4/pool-cl/positions/");
+        clPositionManager = new CLPositionManager(vault, clPoolManager, permit2, 100_000, pd, IWETH9(address(weth)));
 
         ///////////////////////////////////
         //////////// Router setup /////////////
@@ -204,8 +208,6 @@ contract UniversalRouterCrossVersionTest is BasePancakeSwapV4, OldVersionHelper,
             // OPEN_DELTA indicates using the amount from vault delta
             amountIn: ActionConstants.OPEN_DELTA,
             amountOutMinimum: 0.8 ether,
-            // TODO: price limit is removed in next version
-            sqrtPriceLimitX96: TickMath.MIN_SQRT_RATIO + 1,
             hookData: new bytes(0)
         });
         planner.add(Actions.CL_SWAP_EXACT_IN_SINGLE, abi.encode(params));
@@ -276,8 +278,6 @@ contract UniversalRouterCrossVersionTest is BasePancakeSwapV4, OldVersionHelper,
             // OPEN_DELTA indicates using the amount from vault delta
             amountIn: ActionConstants.OPEN_DELTA,
             amountOutMinimum: 0.8 ether,
-            // TODO: price limit is removed in next version
-            sqrtPriceLimitX96: zeroForOne ? TickMath.MIN_SQRT_RATIO + 1 : TickMath.MAX_SQRT_RATIO - 1,
             hookData: new bytes(0)
         });
         planner.add(Actions.CL_SWAP_EXACT_IN_SINGLE, abi.encode(params));
@@ -335,8 +335,6 @@ contract UniversalRouterCrossVersionTest is BasePancakeSwapV4, OldVersionHelper,
             amountIn: 1 ether,
             // we only need to check at the very end
             amountOutMinimum: 0,
-            // TODO: price limit is removed in next version
-            sqrtPriceLimitX96: TickMath.MAX_SQRT_RATIO - 1,
             hookData: new bytes(0)
         });
         planner.add(Actions.CL_SWAP_EXACT_IN_SINGLE, abi.encode(params));
@@ -418,8 +416,6 @@ contract UniversalRouterCrossVersionTest is BasePancakeSwapV4, OldVersionHelper,
             amountIn: 1 ether,
             // we only need to check at the very end
             amountOutMinimum: 0,
-            // TODO: price limit is removed in next version
-            sqrtPriceLimitX96: zeroForOne ? TickMath.MIN_SQRT_RATIO + 1 : TickMath.MAX_SQRT_RATIO - 1,
             hookData: new bytes(0)
         });
         planner.add(Actions.CL_SWAP_EXACT_IN_SINGLE, abi.encode(params));
@@ -516,7 +512,7 @@ contract UniversalRouterCrossVersionTest is BasePancakeSwapV4, OldVersionHelper,
             fee: uint24(LP_FEE),
             parameters: bytes32(0).setTickSpacing(10)
         });
-        clPoolManager.initialize(key, SQRT_PRICE_1_1, new bytes(0));
+        clPoolManager.initialize(key, SQRT_PRICE_1_1);
 
         // prep position manager action to mint liquidity
         Plan memory planner = Planner.init();

test/V3ToV4Migration.t.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.15;
 import {Test, console} from "forge-std/Test.sol";
 import {GasSnapshot} from "forge-gas-snapshot/GasSnapshot.sol";
 import {IAllowanceTransfer} from "permit2/src/interfaces/IAllowanceTransfer.sol";
+import {IWETH9} from "pancake-v4-periphery/src/interfaces/external/IWETH9.sol";
 import {WETH} from "solmate/src/tokens/WETH.sol";
 import {MockERC20} from "solmate/src/test/utils/mocks/MockERC20.sol";
 
@@ -22,6 +23,7 @@ import {BinPoolParametersHelper} from "pancake-v4-core/src/pool-bin/libraries/Bi
 import {ActionConstants} from "pancake-v4-periphery/src/libraries/ActionConstants.sol";
 import {Plan, Planner} from "pancake-v4-periphery/src/libraries/Planner.sol";
 import {CLPositionManager} from "pancake-v4-periphery/src/pool-cl/CLPositionManager.sol";
+import {CLPositionDescriptorOffChain} from "pancake-v4-periphery/src/pool-cl/CLPositionDescriptorOffChain.sol";
 import {BinPositionManager} from "pancake-v4-periphery/src/pool-bin/BinPositionManager.sol";
 import {Actions} from "pancake-v4-periphery/src/libraries/Actions.sol";
 import {IV3NonfungiblePositionManager} from
@@ -119,11 +121,13 @@ contract V3ToV4MigrationTest is BasePancakeSwapV4, OldVersionHelper, BinLiquidit
         vault.registerApp(address(binPoolManager));
         vault.registerApp(address(clPoolManager));
 
-        binPositionManager = new BinPositionManager(vault, binPoolManager, permit2);
+        binPositionManager = new BinPositionManager(vault, binPoolManager, permit2, IWETH9(address(weth)));
         _approvePermit2ForCurrency(address(this), currency0, address(binPositionManager), permit2);
         _approvePermit2ForCurrency(address(this), currency1, address(binPositionManager), permit2);
 
-        clPositionManager = new CLPositionManager(vault, clPoolManager, permit2, 100_000);
+        CLPositionDescriptorOffChain pd =
+            new CLPositionDescriptorOffChain("https://pancakeswap.finance/v4/pool-cl/positions/");
+        clPositionManager = new CLPositionManager(vault, clPoolManager, permit2, 100_000, pd, IWETH9(address(weth)));
         _approvePermit2ForCurrency(address(this), currency0, address(clPositionManager), permit2);
         _approvePermit2ForCurrency(address(this), currency1, address(clPositionManager), permit2);
 
@@ -135,7 +139,7 @@ contract V3ToV4MigrationTest is BasePancakeSwapV4, OldVersionHelper, BinLiquidit
             fee: uint24(3000),
             parameters: bytes32(0).setTickSpacing(10)
         });
-        clPoolManager.initialize(clPoolKey, SQRT_PRICE_1_1, new bytes(0));
+        clPoolManager.initialize(clPoolKey, SQRT_PRICE_1_1);
 
         binPoolKey = PoolKey({
             currency0: currency0,
@@ -145,7 +149,7 @@ contract V3ToV4MigrationTest is BasePancakeSwapV4, OldVersionHelper, BinLiquidit
             fee: uint24(3000),
             parameters: bytes32(0).setBinStep(10)
         });
-        binPoolManager.initialize(binPoolKey, ACTIVE_ID_1_1, new bytes(0));
+        binPoolManager.initialize(binPoolKey, ACTIVE_ID_1_1);
 
         ///////////////////////////////////
         //////////// Router setup /////////////

test/V3ToV4MigrationNative.t.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.15;
 import {Test, console} from "forge-std/Test.sol";
 import {GasSnapshot} from "forge-gas-snapshot/GasSnapshot.sol";
 import {IAllowanceTransfer} from "permit2/src/interfaces/IAllowanceTransfer.sol";
+import {IWETH9} from "pancake-v4-periphery/src/interfaces/external/IWETH9.sol";
 import {WETH} from "solmate/src/tokens/WETH.sol";
 import {MockERC20} from "solmate/src/test/utils/mocks/MockERC20.sol";
 
@@ -22,6 +23,7 @@ import {BinPoolParametersHelper} from "pancake-v4-core/src/pool-bin/libraries/Bi
 import {ActionConstants} from "pancake-v4-periphery/src/libraries/ActionConstants.sol";
 import {Plan, Planner} from "pancake-v4-periphery/src/libraries/Planner.sol";
 import {CLPositionManager} from "pancake-v4-periphery/src/pool-cl/CLPositionManager.sol";
+import {CLPositionDescriptorOffChain} from "pancake-v4-periphery/src/pool-cl/CLPositionDescriptorOffChain.sol";
 import {BinPositionManager} from "pancake-v4-periphery/src/pool-bin/BinPositionManager.sol";
 import {Actions} from "pancake-v4-periphery/src/libraries/Actions.sol";
 import {IV3NonfungiblePositionManager} from
@@ -88,10 +90,12 @@ contract V3ToV4MigrationNativeTest is BasePancakeSwapV4, OldVersionHelper, BinLi
         vault.registerApp(address(binPoolManager));
         vault.registerApp(address(clPoolManager));
 
-        binPositionManager = new BinPositionManager(vault, binPoolManager, permit2);
+        binPositionManager = new BinPositionManager(vault, binPoolManager, permit2, IWETH9(address(weth)));
         _approvePermit2ForCurrency(address(this), currency1, address(binPositionManager), permit2);
 
-        clPositionManager = new CLPositionManager(vault, clPoolManager, permit2, 100_000);
+        CLPositionDescriptorOffChain pd =
+            new CLPositionDescriptorOffChain("https://pancakeswap.finance/v4/pool-cl/positions/");
+        clPositionManager = new CLPositionManager(vault, clPoolManager, permit2, 100_000, pd, IWETH9(address(weth)));
         _approvePermit2ForCurrency(address(this), currency1, address(clPositionManager), permit2);
 
         clPoolKey = PoolKey({
@@ -102,7 +106,7 @@ contract V3ToV4MigrationNativeTest is BasePancakeSwapV4, OldVersionHelper, BinLi
             fee: uint24(3000),
             parameters: bytes32(0).setTickSpacing(10)
         });
-        clPoolManager.initialize(clPoolKey, SQRT_PRICE_1_1, new bytes(0));
+        clPoolManager.initialize(clPoolKey, SQRT_PRICE_1_1);
 
         binPoolKey = PoolKey({
             currency0: CurrencyLibrary.NATIVE,
@@ -112,7 +116,7 @@ contract V3ToV4MigrationNativeTest is BasePancakeSwapV4, OldVersionHelper, BinLi
             fee: uint24(3000),
             parameters: bytes32(0).setBinStep(10)
         });
-        binPoolManager.initialize(binPoolKey, ACTIVE_ID_1_1, new bytes(0));
+        binPoolManager.initialize(binPoolKey, ACTIVE_ID_1_1);
 
         ///////////////////////////////////
         //////////// Router setup /////////////