Add transfer support

.forge-snapshots/PositionManager_burn_empty.snap

@@ -1 +1 @@
-50222
+49205

.forge-snapshots/PositionManager_burn_empty_native.snap

@@ -1 +1 @@
-50040
+49023

.forge-snapshots/PositionManager_burn_nonEmpty.snap

@@ -1 +1 @@
-135866
+134184

.forge-snapshots/PositionManager_burn_nonEmpty_native.snap

@@ -1 +1 @@
-128788
+127105

.forge-snapshots/PositionManager_collect.snap

@@ -1 +1 @@
-158157
+156278

.forge-snapshots/PositionManager_collect_native.snap

@@ -1 +1 @@
-149309
+147430

.forge-snapshots/PositionManager_collect_sameRange.snap

@@ -1 +1 @@
-158157
+156278

.forge-snapshots/PositionManager_decreaseLiquidity.snap

@@ -1 +1 @@
-123700
+121821

.forge-snapshots/PositionManager_decreaseLiquidity_native.snap

@@ -1 +1 @@
-114922
+113419

.forge-snapshots/PositionManager_decrease_burnEmpty.snap

@@ -1 +1 @@
-142193
+140280

.forge-snapshots/PositionManager_decrease_burnEmpty_native.snap

@@ -1 +1 @@
-134932
+133019

.forge-snapshots/PositionManager_decrease_sameRange_allLiquidity.snap

@@ -1 +1 @@
-136416
+134537

.forge-snapshots/PositionManager_increaseLiquidity_erc20.snap

@@ -1 +1 @@
-150444
+148697

.forge-snapshots/PositionManager_increaseLiquidity_native.snap

@@ -1 +1 @@
-135654
+133879

.forge-snapshots/PositionManager_increase_autocompoundExactUnclaimedFees.snap

@@ -1 +1 @@
-142305
+140501

.forge-snapshots/PositionManager_increase_autocompoundExcessFeesCredit.snap

@@ -1 +1 @@
-178459
+176655

.forge-snapshots/PositionManager_mint.snap

@@ -1 +1 @@
-370660
+368776

.forge-snapshots/PositionManager_mint_native.snap

@@ -1 +1 @@
-338770
+336858

.forge-snapshots/PositionManager_mint_nativeWithSweep.snap

@@ -1 +1 @@
-345708
+343796

.forge-snapshots/PositionManager_mint_onSameTickLower.snap

@@ -1 +1 @@
-313342
+311458

.forge-snapshots/PositionManager_mint_onSameTickUpper.snap

@@ -1 +1 @@
-313984
+312100

.forge-snapshots/PositionManager_mint_sameRange.snap

@@ -1 +1 @@
-239566
+237682

.forge-snapshots/PositionManager_mint_warmedPool_differentRange.snap

@@ -1 +1 @@
-319360
+317476

.forge-snapshots/PositionManager_multicall_initialize_mint.snap

@@ -1 +1 @@
-415150
+413266

src/PositionManager.sol

@@ -14,12 +14,14 @@ import {ERC20} from "solmate/src/tokens/ERC20.sol";
 
 import {ERC721Permit} from "./base/ERC721Permit.sol";
 import {ReentrancyLock} from "./base/ReentrancyLock.sol";
-import {IPositionManager, Actions} from "./interfaces/IPositionManager.sol";
+import {IPositionManager} from "./interfaces/IPositionManager.sol";
 import {SafeCallback} from "./base/SafeCallback.sol";
 import {Multicall} from "./base/Multicall.sol";
 import {PoolInitializer} from "./base/PoolInitializer.sol";
 import {DeltaResolver} from "./base/DeltaResolver.sol";
 import {PositionConfig, PositionConfigLibrary} from "./libraries/PositionConfig.sol";
+import {BaseActionsRouterReturns} from "./base/BaseActionsRouterReturns.sol";
+import {Actions} from "./libraries/Actions.sol";
 
 contract PositionManager is
     IPositionManager,
@@ -28,7 +30,8 @@ contract PositionManager is
     Multicall,
     SafeCallback,
     DeltaResolver,
-    ReentrancyLock
+    ReentrancyLock,
+    BaseActionsRouterReturns
 {
     using SafeTransferLib for *;
     using CurrencyLibrary for Currency;
@@ -44,8 +47,10 @@ contract PositionManager is
     /// @inheritdoc IPositionManager
     mapping(uint256 tokenId => bytes32 configId) public positionConfigs;
 
+    uint256 public constant FULL_DELTA = type(uint256).max;
+
     constructor(IPoolManager _poolManager)
-        SafeCallback(_poolManager)
+        BaseActionsRouterReturns(_poolManager)
         ERC721Permit("Uniswap V4 Positions NFT", "UNI-V4-POSM", "1")
     {}
 
@@ -63,41 +68,34 @@ contract PositionManager is
         checkDeadline(deadline)
         returns (bytes[] memory)
     {
-        // TODO: Edit the encoding/decoding.
-        return abi.decode(poolManager.unlock(unlockData), (bytes[]));
-    }
-
-    function _unlockCallback(bytes calldata payload) internal override returns (bytes memory) {
-        (Actions[] memory actions, bytes[] memory params) = abi.decode(payload, (Actions[], bytes[]));
-
-        bytes[] memory returnData = _dispatch(actions, params);
-
-        return abi.encode(returnData);
-    }
-
-    function _dispatch(Actions[] memory actions, bytes[] memory params) internal returns (bytes[] memory returnData) {
-        uint256 length = actions.length;
-        if (length != params.length) revert MismatchedLengths();
-        returnData = new bytes[](length);
-        for (uint256 i; i < length; i++) {
-            if (actions[i] == Actions.INCREASE) {
-                returnData[i] = _increase(params[i]);
-            } else if (actions[i] == Actions.DECREASE) {
-                returnData[i] = _decrease(params[i]);
-            } else if (actions[i] == Actions.MINT) {
-                // TODO: Mint will be coupled with increase.
-                returnData[i] = _mint(params[i]);
-            } else if (actions[i] == Actions.CLOSE_CURRENCY) {
-                returnData[i] = _close(params[i]);
-            } else if (actions[i] == Actions.BURN) {
-                // Will automatically decrease liquidity to 0 if the position is not already empty.
-                returnData[i] = _burn(params[i]);
-            } else {
-                revert UnsupportedAction();
-            }
+        // For now POSM will bubble up sub call return values.
+        return _executeActions(unlockData);
+    }
+
+    function _handleAction(uint256 action, bytes calldata params) internal override returns (bytes memory) {
+        if (action == Actions.INCREASE_LIQUIDITY) {
+            return _increase(params);
+        } else if (action == Actions.DECREASE_LIQUIDITY) {
+            return _decrease(params);
+        } else if (action == Actions.MINT_POSITION) {
+            return _mint(params);
+        } else if (action == Actions.CLOSE_CURRENCY) {
+            return _close(params);
+        } else if (action == Actions.BURN_POSITION) {
+            return _burn(params);
+        } else if (action == Actions.SETTLE_WITH_BALANCE) {
+            return _settleWithBalance(params);
+        } else if (action == Actions.SWEEP_ERC20_TO) {
+            _sweepERC20To(params);
+        } else {
+            revert UnsupportedAction(action);
         }
     }
 
+    function _msgSender() internal view override returns (address) {
+        return _getLocker();
+    }
+
     /// @param params is an encoding of uint256 tokenId, PositionConfig memory config, uint256 liquidity, bytes hookData
     /// @return returns an encoding of the BalanceDelta applied by this increase call, including credited fees.
     /// @dev Calling increase with 0 liquidity will credit the caller with any underlying fees of the position
@@ -118,7 +116,7 @@ contract PositionManager is
         (uint256 tokenId, PositionConfig memory config, uint256 liquidity, bytes memory hookData) =
             abi.decode(params, (uint256, PositionConfig, uint256, bytes));
 
-        if (!_isApprovedOrOwner(_getLocker(), tokenId)) revert NotApproved(_getLocker());
+        if (!_isApprovedOrOwner(_msgSender(), tokenId)) revert NotApproved(_msgSender());
         if (positionConfigs[tokenId] != config.toId()) revert IncorrectPositionConfigForTokenId(tokenId);
 
         // Note: the tokenId is used as the salt.
@@ -157,7 +155,7 @@ contract PositionManager is
         int256 currencyDelta = poolManager.currencyDelta(address(this), currency);
 
         // the locker is the payer or receiver
-        address caller = _getLocker();
+        address caller = _msgSender();
         if (currencyDelta < 0) {
             _settle(currency, caller, uint256(-currencyDelta));
 
@@ -170,13 +168,27 @@ contract PositionManager is
         return abi.encode(currencyDelta);
     }
 
+    /// @param params is an encoding of Currency, uint256 amount
+    /// @dev if amount == FULL_DELTA, it settles the full negative delta
+    /// @dev uses this addresses balance to settle a negative delta
+    /// @dev Should not be called for NATIVE settling bc does not sweep.
+    function _settleWithBalance(bytes memory params) internal returns (bytes memory) {
+        (Currency currency, uint256 amount) = abi.decode(params, (Currency, uint256));
+
+        amount = amount == FULL_DELTA ? _getFullSettleAmount(currency) : amount;
+
+        // set the payer to this address, performs a transfer.
+        _settle(currency, address(this), amount);
+        return abi.encode(amount);
+    }
+
     /// @param params is an encoding of uint256 tokenId, PositionConfig memory config, bytes hookData
     /// @dev this is overloaded with ERC721Permit._burn
     function _burn(bytes memory params) internal returns (bytes memory) {
         (uint256 tokenId, PositionConfig memory config, bytes memory hookData) =
             abi.decode(params, (uint256, PositionConfig, bytes));
 
-        if (!_isApprovedOrOwner(_getLocker(), tokenId)) revert NotApproved(_getLocker());
+        if (!_isApprovedOrOwner(_msgSender(), tokenId)) revert NotApproved(_msgSender());
         if (positionConfigs[tokenId] != config.toId()) revert IncorrectPositionConfigForTokenId(tokenId);
         uint256 liquidity = uint256(_getPositionLiquidity(config, tokenId));
 
@@ -225,9 +237,35 @@ contract PositionManager is
         if (nativeBalance > 0) recipient.safeTransferETH(nativeBalance);
     }
 
+    /// @param params an encoding of Currency, address
+    function _sweepERC20To(bytes calldata params) internal {
+        (Currency currency, address to) = abi.decode(params, (Currency, address));
+        uint256 tokenBalance = ERC20(Currency.unwrap(currency)).balanceOf(address(this));
+        if (tokenBalance > 0) currency.transfer(to, tokenBalance);
+    }
+
     // implementation of abstract function DeltaResolver._pay
-    function _pay(Currency token, address payer, uint256 amount) internal override {
-        // TODO this should use Permit2
-        ERC20(Currency.unwrap(token)).safeTransferFrom(payer, address(poolManager), amount);
+    function _pay(Currency currency, address payer, uint256 amount) internal override {
+        if (payer == address(this)) {
+            // TODO: This transfer no eth check. This is guaranteed to not be eth.
+            currency.transfer(address(poolManager), amount);
+        } else {
+            // TODO this should use Permit2
+            ERC20(Currency.unwrap(currency)).safeTransferFrom(payer, address(poolManager), amount);
+        }
+    }
+
+    function _getFullSettleAmount(Currency currency) private view returns (uint256 amount) {
+        int256 _amount = poolManager.currencyDelta(address(this), currency);
+        // If the amount is positive, it should be taken not settled for.
+        if (_amount > 0) revert IncorrectUseOfSettle();
+        amount = uint256(-_amount);
+    }
+
+    function _getFullTakeAmount(Currency currency) private view returns (uint256 amount) {
+        int256 _amount = poolManager.currencyDelta(address(this), currency);
+        // If the amount is negative, it should be settled not taken.
+        if (_amount < 0) revert IncorrectUseOfTake();
+        amount = uint256(_amount);
     }
 }

src/base/BaseActionsRouter.sol

@@ -20,8 +20,8 @@ abstract contract BaseActionsRouter is SafeCallback {
 
     /// @notice internal function that triggers the execution of a set of actions on v4
     /// @dev inheriting contracts should call this function to trigger execution
-    function _executeActions(bytes calldata params) internal {
-        poolManager.unlock(params);
+    function _executeActions(bytes calldata unlockData) internal {
+        poolManager.unlock(unlockData);
     }
 
     /// @notice function that is called by the PoolManager through the SafeCallback.unlockCallback

src/base/BaseActionsRouterReturns.sol

@@ -0,0 +1,55 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity ^0.8.24;
+
+import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
+import {SafeCallback} from "./SafeCallback.sol";
+import {CalldataDecoder} from "../libraries/CalldataDecoder.sol";
+
+/// @notice Abstract contract for performing a combination of actions on Uniswap v4.
+/// @dev Suggested uint256 action values are defined in Actions.sol, however any definition can be used
+/// @dev This contract handles return values from sub calls to _handleAction.
+abstract contract BaseActionsRouterReturns is SafeCallback {
+    using CalldataDecoder for bytes;
+
+    /// @notice emitted when different numbers of parameters and actions are provided
+    error LengthMismatch();
+
+    /// @notice emitted when an inheriting contract does not support an action
+    error UnsupportedAction(uint256 action);
+
+    constructor(IPoolManager _poolManager) SafeCallback(_poolManager) {}
+
+    /// @notice internal function that triggers the execution of a set of actions on v4
+    /// @dev inheriting contracts should call this function to trigger execution
+    function _executeActions(bytes calldata unlockData) internal returns (bytes[] memory) {
+        return abi.decode(poolManager.unlock(unlockData), (bytes[]));
+    }
+
+    /// @notice function that is called by the PoolManager through the SafeCallback.unlockCallback
+    function _unlockCallback(bytes calldata data) internal override returns (bytes memory) {
+        // abi.decode(data, (uint256[], bytes[]));
+        (uint256[] calldata actions, bytes[] calldata params) = data.decodeActionsRouterParams();
+
+        uint256 numActions = actions.length;
+        if (numActions != params.length) revert LengthMismatch();
+
+        bytes[] memory results = new bytes[](numActions);
+        for (uint256 actionIndex = 0; actionIndex < numActions; actionIndex++) {
+            uint256 action = actions[actionIndex];
+
+            results[actionIndex] = _handleAction(action, params[actionIndex]);
+        }
+
+        return abi.encode(results);
+    }
+
+    /// @notice function to handle the parsing and execution of an action and its parameters
+    function _handleAction(uint256 action, bytes calldata params) internal virtual returns (bytes memory);
+
+    /// @notice function that returns address considered executer of the actions
+    /// @dev The other context functions, _msgData and _msgValue, are not supported by this contract
+    /// In many contracts this will be the address that calls the initial entry point that calls `_executeActions`
+    /// `msg.sender` shouldnt be used, as this will be the v4 pool manager contract that calls `unlockCallback`
+    /// If using ReentrancyLock.sol, this function can return Locker.get() - locker of the contract
+    function _msgSender() internal view virtual returns (address);
+}