Add wrap, unwrap functionality (#369)

* add wrap unwrap

* checkpoint

* fix addresses

* remove test

* eth-weth update

* comments

* add decode fuzz test

* fmt

* wrap tests

* unwrap tests

* use amount

* final comments

* update comment

* test naming update

---------

Co-authored-by: dianakocsis <[email protected]>
Co-authored-by: marktoda <[email protected]>

.forge-snapshots/PositionManager_burn_empty.snap

@@ -1 +1 @@
-50446
+50481

.forge-snapshots/PositionManager_burn_empty_native.snap

@@ -1 +1 @@
-50446
+50481

.forge-snapshots/PositionManager_burn_nonEmpty_native_withClose.snap

@@ -1 +1 @@
-125624
+125659

.forge-snapshots/PositionManager_burn_nonEmpty_native_withTakePair.snap

@@ -1 +1 @@
-125106
+125141

.forge-snapshots/PositionManager_burn_nonEmpty_withClose.snap

@@ -1 +1 @@
-132486
+132521

.forge-snapshots/PositionManager_burn_nonEmpty_withTakePair.snap

@@ -1 +1 @@
-131968
+132004

.forge-snapshots/PositionManager_collect_native.snap

@@ -1 +1 @@
-146344
+146388

.forge-snapshots/PositionManager_collect_sameRange.snap

@@ -1 +1 @@
-154922
+154966

.forge-snapshots/PositionManager_collect_withClose.snap

@@ -1 +1 @@
-154922
+154966

.forge-snapshots/PositionManager_collect_withTakePair.snap

@@ -1 +1 @@
-154287
+154331

.forge-snapshots/PositionManager_decreaseLiquidity_native.snap

@@ -1 +1 @@
-112020
+112056

.forge-snapshots/PositionManager_decreaseLiquidity_withClose.snap

@@ -1 +1 @@
-119803
+119847

.forge-snapshots/PositionManager_decreaseLiquidity_withTakePair.snap

@@ -1 +1 @@
-119168
+119212

.forge-snapshots/PositionManager_decrease_burnEmpty.snap

@@ -1 +1 @@
-135283
+135318

.forge-snapshots/PositionManager_decrease_burnEmpty_native.snap

@@ -1 +1 @@
-128420
+128456

.forge-snapshots/PositionManager_decrease_sameRange_allLiquidity.snap

@@ -1 +1 @@
-132490
+132534

.forge-snapshots/PositionManager_decrease_take_take.snap

@@ -1 +1 @@
-120423
+120467

.forge-snapshots/PositionManager_increaseLiquidity_erc20_withClose.snap

@@ -1 +1 @@
-159083
+159127

.forge-snapshots/PositionManager_increaseLiquidity_erc20_withSettlePair.snap

@@ -1 +1 @@
-158035
+158079

.forge-snapshots/PositionManager_increaseLiquidity_native.snap

@@ -1 +1 @@
-140898
+140942

.forge-snapshots/PositionManager_increase_autocompoundExactUnclaimedFees.snap

@@ -1 +1 @@
-136359
+136403

.forge-snapshots/PositionManager_increase_autocompoundExcessFeesCredit.snap

@@ -1 +1 @@
-177414
+177458

.forge-snapshots/PositionManager_increase_autocompound_clearExcess.snap

@@ -1 +1 @@
-148040
+148084

.forge-snapshots/PositionManager_mint_native.snap

@@ -1 +1 @@
-364771
+364815

.forge-snapshots/PositionManager_mint_nativeWithSweep_withClose.snap

@@ -1 +1 @@
-373294
+373334

.forge-snapshots/PositionManager_mint_nativeWithSweep_withSettlePair.snap

@@ -1 +1 @@
-372529
+372569

.forge-snapshots/PositionManager_mint_onSameTickLower.snap

@@ -1 +1 @@
-317643
+317687

.forge-snapshots/PositionManager_mint_onSameTickUpper.snap

@@ -1 +1 @@
-318313
+318357

.forge-snapshots/PositionManager_mint_sameRange.snap

@@ -1 +1 @@
-243882
+243926

.forge-snapshots/PositionManager_mint_settleWithBalance_sweep.snap

@@ -1 +1 @@
-419098
+419134

.forge-snapshots/PositionManager_mint_warmedPool_differentRange.snap

@@ -1 +1 @@
-323674
+323718

.forge-snapshots/PositionManager_mint_withClose.snap

@@ -1 +1 @@
-420196
+420240

.forge-snapshots/PositionManager_mint_withSettlePair.snap

@@ -1 +1 @@
-419266
+419310

.forge-snapshots/PositionManager_multicall_initialize_mint.snap

@@ -1 +1 @@
-456001
+456088

.forge-snapshots/PositionManager_permit_twice.snap

@@ -1 +1 @@
-44852
+44876

.forge-snapshots/PositionManager_unsubscribe.snap

@@ -1 +1 @@
-59238
+59260

script/DeployPosm.s.sol

@@ -10,6 +10,7 @@ import {PositionManager} from "../src/PositionManager.sol";
 import {IAllowanceTransfer} from "permit2/src/interfaces/IAllowanceTransfer.sol";
 import {IPositionDescriptor} from "../src/interfaces/IPositionDescriptor.sol";
 import {PositionDescriptor} from "../src/PositionDescriptor.sol";
+import {IWETH9} from "../src/interfaces/external/IWETH9.sol";
 
 contract DeployPosmTest is Script {
     function setUp() public {}
@@ -30,7 +31,8 @@ contract DeployPosmTest is Script {
             IPoolManager(poolManager),
             IAllowanceTransfer(permit2),
             unsubscribeGasLimit,
-            IPositionDescriptor(address(positionDescriptor))
+            IPositionDescriptor(address(positionDescriptor)),
+            IWETH9(wrappedNative)
         );
         console2.log("PositionManager", address(posm));
 

src/PositionManager.sol

@@ -4,7 +4,7 @@ pragma solidity 0.8.26;
 import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
 import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
 import {PoolIdLibrary} from "@uniswap/v4-core/src/types/PoolId.sol";
-import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
+import {Currency, CurrencyLibrary} from "@uniswap/v4-core/src/types/Currency.sol";
 import {BalanceDelta} from "@uniswap/v4-core/src/types/BalanceDelta.sol";
 import {SafeCast} from "@uniswap/v4-core/src/libraries/SafeCast.sol";
 import {Position} from "@uniswap/v4-core/src/libraries/Position.sol";
@@ -26,6 +26,8 @@ import {CalldataDecoder} from "./libraries/CalldataDecoder.sol";
 import {Permit2Forwarder} from "./base/Permit2Forwarder.sol";
 import {SlippageCheck} from "./libraries/SlippageCheck.sol";
 import {PositionInfo, PositionInfoLibrary} from "./libraries/PositionInfoLibrary.sol";
+import {NativeWrapper} from "./base/NativeWrapper.sol";
+import {IWETH9} from "./interfaces/external/IWETH9.sol";
 
 //                                           444444444
 //                                444444444444      444444
@@ -102,7 +104,8 @@ contract PositionManager is
     ReentrancyLock,
     BaseActionsRouter,
     Notifier,
-    Permit2Forwarder
+    Permit2Forwarder,
+    NativeWrapper
 {
     using PoolIdLibrary for PoolKey;
     using StateLibrary for IPoolManager;
@@ -126,12 +129,14 @@ contract PositionManager is
         IPoolManager _poolManager,
         IAllowanceTransfer _permit2,
         uint256 _unsubscribeGasLimit,
-        IPositionDescriptor _tokenDescriptor
+        IPositionDescriptor _tokenDescriptor,
+        IWETH9 _weth9
     )
         BaseActionsRouter(_poolManager)
         Permit2Forwarder(_permit2)
         ERC721Permit_v4("Uniswap v4 Positions NFT", "UNI-V4-POSM")
         Notifier(_unsubscribeGasLimit)
+        NativeWrapper(_weth9)
     {
         tokenDescriptor = _tokenDescriptor;
     }
@@ -242,6 +247,14 @@ contract PositionManager is
                 (Currency currency, address to) = params.decodeCurrencyAndAddress();
                 _sweep(currency, _mapRecipient(to));
                 return;
+            } else if (action == Actions.WRAP) {
+                uint256 amount = params.decodeUint256();
+                _wrap(_mapWrapUnwrapAmount(CurrencyLibrary.ADDRESS_ZERO, amount, Currency.wrap(address(WETH9))));
+                return;
+            } else if (action == Actions.UNWRAP) {
+                uint256 amount = params.decodeUint256();
+                _unwrap(_mapWrapUnwrapAmount(Currency.wrap(address(WETH9)), amount, CurrencyLibrary.ADDRESS_ZERO));
+                return;
             }
         }
         revert UnsupportedAction(action);

src/base/DeltaResolver.sol

@@ -16,6 +16,8 @@ abstract contract DeltaResolver is ImmutableState {
     error DeltaNotPositive(Currency currency);
     /// @notice Emitted trying to take a negative delta.
     error DeltaNotNegative(Currency currency);
+    /// @notice Emitted when the contract does not have enough balance to wrap or unwrap.
+    error InsufficientBalance();
 
     /// @notice Take an amount of currency out of the PoolManager
     /// @param currency Currency to take
@@ -91,4 +93,30 @@ abstract contract DeltaResolver is ImmutableState {
             return amount;
         }
     }
+
+    /// @notice Calculates the sanitized amount before wrapping/unwrapping.
+    /// @param inputCurrency The currency, either native or wrapped native, that this contract holds
+    /// @param amount The amount to wrap or unwrap. Can be CONTRACT_BALANCE, OPEN_DELTA or a specific amount
+    /// @param outputCurrency The currency after the wrap/unwrap that the user may owe a balance in on the poolManager
+    function _mapWrapUnwrapAmount(Currency inputCurrency, uint256 amount, Currency outputCurrency)
+        internal
+        view
+        returns (uint256)
+    {
+        // if wrapping, the balance in this contract is in ETH
+        // if unwrapping, the balance in this contract is in WETH
+        uint256 balance = inputCurrency.balanceOf(address(this));
+        if (amount == ActionConstants.CONTRACT_BALANCE) {
+            // return early to avoid unnecessary balance check
+            return balance;
+        }
+        if (amount == ActionConstants.OPEN_DELTA) {
+            // if wrapping, the open currency on the PoolManager is WETH.
+            // if unwrapping, the open currency on the PoolManager is ETH.
+            // note that we use the DEBT amount. Positive deltas can be taken and then wrapped.
+            amount = _getFullDebt(outputCurrency);
+        }
+        if (amount > balance) revert InsufficientBalance();
+        return amount;
+    }
 }

src/base/NativeWrapper.sol

@@ -0,0 +1,34 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.0;
+
+import {IWETH9} from "../interfaces/external/IWETH9.sol";
+import {ActionConstants} from "../libraries/ActionConstants.sol";
+import {ImmutableState} from "./ImmutableState.sol";
+
+/// @title Native Wrapper
+/// @notice Used for wrapping and unwrapping native
+abstract contract NativeWrapper is ImmutableState {
+    /// @notice The address for WETH9
+    IWETH9 public immutable WETH9;
+
+    /// @notice Thrown when an unexpected address sends ETH to this contract
+    error InvalidEthSender();
+
+    constructor(IWETH9 _weth9) {
+        WETH9 = _weth9;
+    }
+
+    /// @dev The amount should already be <= the current balance in this contract.
+    function _wrap(uint256 amount) internal {
+        if (amount > 0) WETH9.deposit{value: amount}();
+    }
+
+    /// @dev The amount should already be <= the current balance in this contract.
+    function _unwrap(uint256 amount) internal {
+        if (amount > 0) WETH9.withdraw(amount);
+    }
+
+    receive() external payable {
+        if (msg.sender != address(WETH9) && msg.sender != address(poolManager)) revert InvalidEthSender();
+    }
+}

src/interfaces/external/IWETH9.sol

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.0;
+
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+/// @title Interface for WETH9
+interface IWETH9 is IERC20 {
+    /// @notice Deposit ether to get wrapped ether
+    function deposit() external payable;
+
+    /// @notice Withdraw wrapped ether to get ether
+    function withdraw(uint256) external;
+}

src/libraries/Actions.sol

@@ -33,8 +33,10 @@ library Actions {
     uint256 constant CLOSE_CURRENCY = 0x17;
     uint256 constant CLEAR_OR_TAKE = 0x18;
     uint256 constant SWEEP = 0x19;
+    uint256 constant WRAP = 0x20;
+    uint256 constant UNWRAP = 0x21;
 
     // minting/burning 6909s to close deltas
-    uint256 constant MINT_6909 = 0x20;
-    uint256 constant BURN_6909 = 0x21;
+    uint256 constant MINT_6909 = 0x22;
+    uint256 constant BURN_6909 = 0x23;
 }

src/libraries/CalldataDecoder.sol

@@ -241,6 +241,13 @@ library CalldataDecoder {
         }
     }
 
+    /// @dev equivalent to: abi.decode(params, (uint256)) in calldata
+    function decodeUint256(bytes calldata params) internal pure returns (uint256 amount) {
+        assembly ("memory-safe") {
+            amount := calldataload(params.offset)
+        }
+    }
+
     /// @dev equivalent to: abi.decode(params, (Currency, uint256, bool)) in calldata
     function decodeCurrencyUint256AndBool(bytes calldata params)
         internal

test/PositionDescriptor.t.sol

@@ -122,7 +122,7 @@ contract PositionDescriptorTest is Test, PosmTestSetup, GasSnapshot {
         assertEq(token.name, "Uniswap - 0.3% - TEST/TEST - 1.0060<>1.0121");
         assertEq(
             token.description,
-            unicode"This NFT represents a liquidity position in a Uniswap v4 TEST-TEST pool. The owner of this NFT can modify or redeem the position.\n\nPool Manager Address: 0x5615deb798bb3e4dfa0139dfa1b3d433cc23b72f\nTEST Address: 0x5991a2df15a8f6a256d3ec51e99254cd3fb576a9\nTEST Address: 0x2e234dae75c793f67a35089c9d99245e1c58470b\nHook Address: No Hook\nFee Tier: 0.3%\nToken ID: 1\n\n⚠️ DISCLAIMER: Due diligence is imperative when assessing this NFT. Make sure currency addresses match the expected currencies, as currency symbols may be imitated."
+            unicode"This NFT represents a liquidity position in a Uniswap v4 TEST-TEST pool. The owner of this NFT can modify or redeem the position.\n\nPool Manager Address: 0x2e234dae75c793f67a35089c9d99245e1c58470b\nTEST Address: 0xf62849f9a0b5bf2913b396098f7c7019b51a820a\nTEST Address: 0xc7183455a4c133ae270771860664b6b7ec320bb1\nHook Address: No Hook\nFee Tier: 0.3%\nToken ID: 1\n\n⚠️ DISCLAIMER: Due diligence is imperative when assessing this NFT. Make sure currency addresses match the expected currencies, as currency symbols may be imitated."
         );
     }
 

test/libraries/CalldataDecoder.t.sol

@@ -232,6 +232,13 @@ contract CalldataDecoderTest is Test {
         assertEq(amount, _amount);
     }
 
+    function test_fuzz_decodeUint256(uint256 _amount) public {
+        bytes memory params = abi.encode(_amount);
+        uint256 amount = decoder.decodeUint256(params);
+
+        assertEq(amount, _amount);
+    }
+
     function _assertEq(PathKey[] memory path1, PathKey[] memory path2) internal pure {
         assertEq(path1.length, path2.length);
         for (uint256 i = 0; i < path1.length; i++) {