refactor: proxy and calldata

Author: kupermind

contracts/pol/LiquidityManagerCore.sol

@@ -21,6 +21,9 @@ error ZeroAddress();
 /// @dev Zero value when it has to be different from zero.
 error ZeroValue();
 
+/// @dev The contract is already initialized.
+error AlreadyInitialized();
+
 /// @dev Value overflow.
 /// @param provided Overflow value.
 /// @param max Maximum possible value.
@@ -41,11 +44,24 @@ error RangeBounds(int24 low, int24 center, int24 high);
 error ReentrancyGuard();
 
 interface INeighborhoodScanner {
+    /// @dev Optimizes liquidity amounts by widening up provided ticks using binary search + neighborhood search.
+    /// @notice 1. Adjusts extreme boundaries, if required.
+    ///         2. Looks for correct boundaries and adjusts tick spacings accordingly.
+    ///         3. Fixes one of ticks and executed binary + neighborhood search if scan option is true.
+    /// Ensures non-zero intermediate for amount0 formula without linear loops.
+    /// @param sqrtP Center sqrt price.
+    /// @param ticks Ticks array.
+    /// @param tickSpacing Tick spacing.
+    /// @param initialAmounts Initial amounts array.
+    /// @param scan True if binary and neighborhood ticks search for optimal liquidity is requested, false otherwise.
+    /// @return loHi Optimized ticks.
+    /// @return liquidity Corresponding liquidity.
+    /// @return amountsDesired Corresponding desired amounts.
     function optimizeLiquidityAmounts(
-        uint160 centerSqrtPriceX96,
+        uint160 sqrtP,
         int24[] memory ticks,
         int24 tickSpacing,
-        uint256[] memory balances,
+        uint256[] memory initialAmounts,
         bool scan
     ) external pure returns (int24[] memory loHi, uint128 liquidity, uint256[] memory amountsDesired);
 }
@@ -57,6 +73,7 @@ interface INeighborhoodScanner {
 abstract contract LiquidityManagerCore is ERC721TokenReceiver {
     event OwnerUpdated(address indexed owner);
     event ImplementationUpdated(address indexed implementation);
+    event MaxSlippageUpdated(uint256 maxSlippage);
     event ConvertedToV3(address indexed pool, uint256 indexed positionId, address[] tokens, uint256[] amounts, uint256 liquidiy, bool scan);
     event RangesChanged(address indexed pool, uint256 indexed positionId, address[] tokens, uint256[] amounts, uint256 liquidiy, bool scan);
     event UtilityAmountsManaged(address indexed olas, address indexed token, uint256 olasAmount, uint256 tokenAmount, bool olasBurnOrTransfer);
@@ -114,39 +131,30 @@ abstract contract LiquidityManagerCore is ERC721TokenReceiver {
     /// @param _positionManagerV3 Uniswap V3 position manager address.
     /// @param _neighborhoodScanner Neighborhood ticks scanner.
     /// @param _observationCardinality Observation cardinality for fresh pools.
-    /// @param _maxSlippage Max slippage for operations.
     constructor(
         address _olas,
         address _treasury,
         address _positionManagerV3,
         address _neighborhoodScanner,
-        uint16 _observationCardinality,
-        uint16 _maxSlippage
+        uint16 _observationCardinality
     ) {
-        owner = msg.sender;
-
         // Check for zero addresses
         if (_olas == address(0) || _treasury == address(0) || _positionManagerV3 == address(0) ||
             _neighborhoodScanner == address(0))
         {
             revert ZeroAddress();
         }
 
-        // Check for zero values
-        if (_maxSlippage == 0 || _observationCardinality == 0) {
+        // Check for zero value
+        if (_observationCardinality == 0) {
             revert ZeroValue();
         }
-        // Check for max value
-        if (_maxSlippage > MAX_BPS) {
-            revert Overflow(_maxSlippage, MAX_BPS);
-        }
 
         olas = _olas;
         treasury = _treasury;
         positionManagerV3 = _positionManagerV3;
         neighborhoodScanner = _neighborhoodScanner;
         observationCardinality = _observationCardinality;
-        maxSlippage = _maxSlippage;
 
         // Get V3 factory address
         factoryV3 = IUniswapV3(positionManagerV3).factory();
@@ -475,8 +483,24 @@ abstract contract LiquidityManagerCore is ERC721TokenReceiver {
     }
 
     /// @dev Initialization function.
-    function initialize() external {
+    /// @param _maxSlippage Max slippage for operations.
+    function initialize(uint16 _maxSlippage) external {
+        if (owner != address(0)) {
+            revert AlreadyInitialized();
+        }
+
+        // Check for zero value
+        if (_maxSlippage == 0) {
+            revert ZeroValue();
+        }
+        // Check for max value
+        if (_maxSlippage > MAX_BPS) {
+            revert Overflow(_maxSlippage, MAX_BPS);
+        }
 
+        maxSlippage = _maxSlippage;
+
+        owner = msg.sender;
     }
 
     /// @dev Changes the owner address.
@@ -517,6 +541,23 @@ abstract contract LiquidityManagerCore is ERC721TokenReceiver {
         emit ImplementationUpdated(implementation);
     }
 
+    /// @dev Changes max slippage value.
+    /// @param newMaxSlippage New max slippage value.
+    function changeMaxSlippage(uint16 newMaxSlippage) external {
+        // Check for the contract ownership
+        if (msg.sender != owner) {
+            revert OwnerOnly(msg.sender, owner);
+        }
+
+        // Check for zero value
+        if (newMaxSlippage == 0) {
+            revert ZeroValue();
+        }
+
+        maxSlippage = newMaxSlippage;
+        emit MaxSlippageUpdated(newMaxSlippage);
+    }
+
     /// @dev Converts token amounts to V3 liquidity: from balances, or from V2 liquidity, or both.
     /// @param tokens Token addresses.
     /// @param v2Pool V2 pool hash / address.

contracts/pol/LiquidityManagerETH.sol

@@ -133,7 +133,6 @@ contract LiquidityManagerETH is LiquidityManagerCore {
     /// @param _positionManagerV3 Uniswap V3 position manager address.
     /// @param _neighborhoodScanner Neighborhood ticks scanner.
     /// @param _observationCardinality Observation cardinality for fresh pools.
-    /// @param _maxSlippage Max slippage for operations.
     /// @param _oracleV2 V2 pool related oracle address.
     /// @param _routerV2 Uniswap V2 Router address.
     constructor(
@@ -142,10 +141,9 @@ contract LiquidityManagerETH is LiquidityManagerCore {
         address _positionManagerV3,
         address _neighborhoodScanner,
         uint16 _observationCardinality,
-        uint16 _maxSlippage,
         address _oracleV2,
         address _routerV2
-    ) LiquidityManagerCore(_olas, _treasury, _positionManagerV3, _neighborhoodScanner, _observationCardinality, _maxSlippage)
+    ) LiquidityManagerCore(_olas, _treasury, _positionManagerV3, _neighborhoodScanner, _observationCardinality)
     {
         // Check for zero addresses
         if (_oracleV2 == address(0) || _routerV2 == address(0)) {

contracts/pol/LiquidityManagerOptimism.sol

@@ -191,7 +191,6 @@ contract LiquidityManagerOptimism is LiquidityManagerCore {
     /// @param _positionManagerV3 Uniswap V3 position manager address.
     /// @param _neighborhoodScanner Neighborhood ticks scanner.
     /// @param _observationCardinality Observation cardinality for fresh pools.
-    /// @param _maxSlippage Max slippage for operations.
     /// @param _oracleV2 V2 pool related oracle address.
     /// @param _balancerVault Balancer vault address.
     /// @param _bridge2Burner Bridge to Burner address.
@@ -201,11 +200,10 @@ contract LiquidityManagerOptimism is LiquidityManagerCore {
         address _positionManagerV3,
         address _neighborhoodScanner,
         uint16 _observationCardinality,
-        uint16 _maxSlippage,
         address _oracleV2,
         address _balancerVault,
         address _bridge2Burner
-    ) LiquidityManagerCore(_olas, _treasury, _positionManagerV3, _neighborhoodScanner, _observationCardinality, _maxSlippage)
+    ) LiquidityManagerCore(_olas, _treasury, _positionManagerV3, _neighborhoodScanner, _observationCardinality)
     {
         // Check for zero address
         if (_oracleV2 == address(0) || _balancerVault == address(0) || _bridge2Burner == address(0)) {

test/LiquidityManagerBase.t.sol

@@ -4,6 +4,7 @@ import {Test, console} from "forge-std/Test.sol";
 import {Utils} from "./utils/Utils.sol";
 import {FixedPointMathLib} from "../lib/solmate/src/utils/FixedPointMathLib.sol";
 import {LiquidityManagerOptimism} from "../contracts/pol/LiquidityManagerOptimism.sol";
+import {LiquidityManagerProxy} from "../contracts/proxies/LiquidityManagerProxy.sol";
 import {NeighborhoodScanner} from "../contracts/pol/NeighborhoodScanner.sol";
 import {BalancerPriceOracle} from "../contracts/oracles/BalancerPriceOracle.sol";
 import {IToken} from "../contracts/interfaces/IToken.sol";
@@ -111,15 +112,28 @@ contract BaseSetup is Test {
         dev = users[1];
         vm.label(dev, "Developer");
 
+        // Deploy V2 oracle
         oracleV2 = new BalancerPriceOracle(OLAS, WETH, uint256(maxSlippage / 100), minUpdateTimePeriod, BALANCER_VAULT,
             POOL_V2_BYTES32);
 
         // Advance some time such that oracle has a time difference between last updated price
         vm.warp(block.timestamp + 100);
 
+        // Deploy neighborhood scanner
         neighborhoodScanner = new NeighborhoodScanner();
-        liquidityManager = new LiquidityManagerOptimism(OLAS, TIMELOCK, POSITION_MANAGER_V3, address(neighborhoodScanner),
-            observationCardinality, maxSlippage, address(oracleV2), BALANCER_VAULT, TIMELOCK);
+
+        // Deploy LiquidityManagerOptimism implementation
+        LiquidityManagerOptimism liquidityManagerImplementation = new LiquidityManagerOptimism(OLAS, TIMELOCK,
+            POSITION_MANAGER_V3, address(neighborhoodScanner), observationCardinality, address(oracleV2),
+            BALANCER_VAULT, TIMELOCK);
+
+        // Deploy LiquidityManagerProxy
+        bytes memory initPayload = abi.encodeWithSignature("initialize(uint16)", maxSlippage);
+        LiquidityManagerProxy liquidityManagerProxy =
+            new LiquidityManagerProxy(address(liquidityManagerImplementation), initPayload);
+
+        // Wrap proxy into implementation
+        liquidityManager = LiquidityManagerOptimism(address(liquidityManagerProxy));
 
         // Get pool total supply
         uint256 totalSupply = IToken(POOL_V2).totalSupply();

test/LiquidityManagerETH.t.sol

@@ -4,6 +4,7 @@ import {Test, console} from "forge-std/Test.sol";
 import {Utils} from "./utils/Utils.sol";
 import {FixedPointMathLib} from "../lib/solmate/src/utils/FixedPointMathLib.sol";
 import {LiquidityManagerETH} from "../contracts/pol/LiquidityManagerETH.sol";
+import {LiquidityManagerProxy} from "../contracts/proxies/LiquidityManagerProxy.sol";
 import {NeighborhoodScanner} from "../contracts/pol/NeighborhoodScanner.sol";
 import {UniswapPriceOracle} from "../contracts/oracles/UniswapPriceOracle.sol";
 import {IToken} from "../contracts/interfaces/IToken.sol";
@@ -73,10 +74,23 @@ contract BaseSetup is Test {
         dev = users[1];
         vm.label(dev, "Developer");
 
+        // Deploy V2 oracle
         oracleV2 = new UniswapPriceOracle(WETH, uint256(maxSlippage / 100), PAIR_V2);
+
+        // Deploy neighborhood scanner
         neighborhoodScanner = new NeighborhoodScanner();
-        liquidityManager = new LiquidityManagerETH(OLAS, TIMELOCK, POSITION_MANAGER_V3, address(neighborhoodScanner),
-            observationCardinality, maxSlippage, address(oracleV2), ROUTER_V2);
+
+        // Deploy LiquidityManagerETH implementation
+        LiquidityManagerETH liquidityManagerImplementation = new LiquidityManagerETH(OLAS, TIMELOCK, POSITION_MANAGER_V3,
+            address(neighborhoodScanner), observationCardinality, address(oracleV2), ROUTER_V2);
+
+        // Deploy LiquidityManagerProxy
+        bytes memory initPayload = abi.encodeWithSignature("initialize(uint16)", maxSlippage);
+        LiquidityManagerProxy liquidityManagerProxy =
+            new LiquidityManagerProxy(address(liquidityManagerImplementation), initPayload);
+
+        // Wrap proxy into implementation
+        liquidityManager = LiquidityManagerETH(address(liquidityManagerProxy));
 
         // Get V2 pool balance
         uint256 v2Liquidity = IToken(PAIR_V2).balanceOf(TREASURY);