Merge branch 'main' into minimal-balances

.forge-snapshots/before swap hook, already cached dynamic fee.snap

@@ -0,0 +1 @@
+85275

.forge-snapshots/cached dynamic fee, no hooks.snap

@@ -0,0 +1 @@
+82459

.forge-snapshots/donate gas with 1 token.snap

@@ -1 +1 @@
-95904
+95882

.forge-snapshots/donate gas with 2 tokens.snap

@@ -1 +1 @@
-153268
+153224

.forge-snapshots/initialize.snap

@@ -1 +1 @@
-37987
+38101

.forge-snapshots/mint with empty hook.snap

@@ -1 +1 @@
-306991
+306969

.forge-snapshots/mint.snap

@@ -1 +1 @@
-293657
+293635

.forge-snapshots/poolManager bytecode size.snap

@@ -0,0 +1 @@
+24850

.forge-snapshots/simple swap.snap

@@ -1 +1 @@
-49640
+49691

.forge-snapshots/swap against liquidity with native token.snap

@@ -1 +1 @@
-124891
+124942

.forge-snapshots/swap against liquidity.snap

@@ -1 +1 @@
-109601
+109630

.forge-snapshots/swap burn claim for input.snap

@@ -1 +1 @@
-126307
+126402

.forge-snapshots/swap mint 1155 as output.snap

@@ -0,0 +1 @@
+169533

.forge-snapshots/swap mint output as claim.snap

@@ -1 +1 @@
-166338
+166355

.forge-snapshots/swap with 1155 as input.snap

@@ -0,0 +1 @@
+155963

.forge-snapshots/swap with dynamic fee.snap

@@ -1 +1 @@
-91422
+84384

.forge-snapshots/swap with hooks.snap

@@ -1 +1 @@
-49611
+49662

.forge-snapshots/swap with native.snap

@@ -1 +1 @@
-49640
+49691

.forge-snapshots/update dynamic fee in before swap.snap

@@ -0,0 +1 @@
+91100

.github/workflows/tests.yml

@@ -7,30 +7,6 @@ on:
   pull_request:
 
 jobs:
-  unit-tests:
-    name: Hardhat Unit Tests
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          submodules: recursive
-
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          cache: 'yarn'
-
-      - name: Install dependencies
-        run: yarn install --frozen-lockfile
-
-      # This is required separately from yarn test because it generates the typechain definitions
-      - name: Compile
-        run: yarn compile
-
-      - name: Run unit tests
-        run: yarn test
-
   forge-tests:
     name: Forge Tests
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -32,7 +32,7 @@ Finally, before opening a pull request please do the following:
 - Run the tests and snapshots. Commands are outlined in the [tests](#tests) section.
 - Document any new functions, structs, or interfaces following the natspec standard.
 - Add tests! For smaller contributions, they should be tested with unit tests, and fuzz tests where possible. For bigger contributions, they should be tested with integration tests and invariant tests where possible.
-- Make sure all commits are [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) 
+- Make sure all commits are [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
 
 ## Standards
 
@@ -46,28 +46,14 @@ All contributions must follow the below standards. Maintainers will close out PR
 
 ## Setup
 
-`yarn install` to install dependencies for hardhat
-
-`yarn compile` to compile contracts for hardhat
-
 `forge build` to get contract artifacts and dependencies for forge
 
 ## Tests
 
-This repo currently uses hardhat and forge tests. Please run both test suites before opening a PR.
-
-`yarn snapshots` to update the hardhat gas snapshots
-
-`yarn test` to run hardhat tests
-
-`yarn prettier` to run the formatter (runs both typescript and solidity formatting)
-
 `forge snapshot`to update the forge gas snapshots
 
 `forge test` to run forge tests
 
-Any new tests that you add should be written with forge, as the repo is undergoing a full migration to the forge test suite.
-
 ## Code of Conduct
 
 Above all else, please be respectful of the people behind the code. Any kind of aggressive or disrespectful comments, issues, and language will be removed.

contracts/Fees.sol

@@ -9,13 +9,17 @@ import {FeeLibrary} from "./libraries/FeeLibrary.sol";
 import {Pool} from "./libraries/Pool.sol";
 import {PoolKey} from "./types/PoolKey.sol";
 import {Owned} from "./Owned.sol";
+import {IDynamicFeeManager} from "./interfaces/IDynamicFeeManager.sol";
 
 abstract contract Fees is IFees, Owned {
     using FeeLibrary for uint24;
     using CurrencyLibrary for Currency;
 
     uint8 public constant MIN_PROTOCOL_FEE_DENOMINATOR = 4;
 
+    // the swap fee is represented in hundredths of a bip, so the max is 100%
+    uint24 public constant MAX_SWAP_FEE = 1000000;
+
     mapping(Currency currency => uint256) public protocolFeesAccrued;
 
     mapping(address hookAddress => mapping(Currency currency => uint256)) public hookFeesAccrued;
@@ -61,6 +65,11 @@ abstract contract Fees is IFees, Owned {
         }
     }
 
+    function _fetchDynamicSwapFee(PoolKey memory key) internal view returns (uint24 dynamicSwapFee) {
+        dynamicSwapFee = IDynamicFeeManager(address(key.hooks)).getFee(msg.sender, key);
+        if (dynamicSwapFee >= MAX_SWAP_FEE) revert FeeTooLarge();
+    }
+
     /// @dev Only the lower 12 bits are used here to encode the fee denominator.
     function _checkProtocolFee(uint16 fee) internal pure {
         if (fee != 0) {

contracts/PoolManager.sol

@@ -108,7 +108,7 @@ contract PoolManager is IPoolManager, Fees, NoDelegateCall, MinimalBalance {
         // see TickBitmap.sol for overflow conditions that can arise from tick spacing being too large
         if (key.tickSpacing > MAX_TICK_SPACING) revert TickSpacingTooLarge();
         if (key.tickSpacing < MIN_TICK_SPACING) revert TickSpacingTooSmall();
-        if (key.currency0 > key.currency1) revert CurrenciesInitializedOutOfOrder();
+        if (key.currency0 >= key.currency1) revert CurrenciesInitializedOutOfOrder();
         if (!key.hooks.isValidHookAddress(key.fee)) revert Hooks.HookAddressNotValid(address(key.hooks));
 
         if (key.hooks.shouldCallBeforeInitialize()) {
@@ -119,9 +119,10 @@ contract PoolManager is IPoolManager, Fees, NoDelegateCall, MinimalBalance {
         }
 
         PoolId id = key.toId();
-        uint24 protocolFees = _fetchProtocolFees(key);
-        uint24 hookFees = _fetchHookFees(key);
-        tick = pools[id].initialize(sqrtPriceX96, protocolFees, hookFees);
+
+        uint24 swapFee = key.fee.isDynamicFee() ? _fetchDynamicSwapFee(key) : key.fee.getStaticFee();
+
+        tick = pools[id].initialize(sqrtPriceX96, _fetchProtocolFees(key), _fetchHookFees(key), swapFee);
 
         if (key.hooks.shouldCallAfterInitialize()) {
             if (
@@ -132,6 +133,7 @@ contract PoolManager is IPoolManager, Fees, NoDelegateCall, MinimalBalance {
             }
         }
 
+        // On intitalize we emit the key's fee, which tells us all fee settings a pool can have: either a static swap fee or dynamic swap fee and if the hook has enabled swap or withdraw fees.
         emit Initialize(id, key.currency0, key.currency1, key.fee, key.tickSpacing, key.hooks);
     }
 
@@ -250,23 +252,14 @@ contract PoolManager is IPoolManager, Fees, NoDelegateCall, MinimalBalance {
             }
         }
 
-        // Set the total swap fee, either through the hook or as the static fee set an initialization.
-        uint24 totalSwapFee;
-        if (key.fee.isDynamicFee()) {
-            totalSwapFee = IDynamicFeeManager(address(key.hooks)).getFee(msg.sender, key, params, hookData);
-            if (totalSwapFee >= 1000000) revert FeeTooLarge();
-        } else {
-            // clear the top 4 bits since they may be flagged for hook fees
-            totalSwapFee = key.fee.getStaticFee();
-        }
+        PoolId id = key.toId();
 
         uint256 feeForProtocol;
         uint256 feeForHook;
+        uint24 swapFee;
         Pool.SwapState memory state;
-        PoolId id = key.toId();
-        (delta, feeForProtocol, feeForHook, state) = pools[id].swap(
+        (delta, feeForProtocol, feeForHook, swapFee, state) = pools[id].swap(
             Pool.SwapParams({
-                fee: totalSwapFee,
                 tickSpacing: key.tickSpacing,
                 zeroForOne: params.zeroForOne,
                 amountSpecified: params.amountSpecified,
@@ -293,14 +286,7 @@ contract PoolManager is IPoolManager, Fees, NoDelegateCall, MinimalBalance {
         }
 
         emit Swap(
-            id,
-            msg.sender,
-            delta.amount0(),
-            delta.amount1(),
-            state.sqrtPriceX96,
-            state.liquidity,
-            state.tick,
-            totalSwapFee
+            id, msg.sender, delta.amount0(), delta.amount1(), state.sqrtPriceX96, state.liquidity, state.tick, swapFee
         );
     }
 
@@ -387,6 +373,17 @@ contract PoolManager is IPoolManager, Fees, NoDelegateCall, MinimalBalance {
         emit HookFeeUpdated(id, newHookFees);
     }
 
+    function updateDynamicSwapFee(PoolKey memory key) external {
+        if (key.fee.isDynamicFee()) {
+            uint24 newDynamicSwapFee = _fetchDynamicSwapFee(key);
+            PoolId id = key.toId();
+            pools[id].setSwapFee(newDynamicSwapFee);
+            emit DynamicSwapFeeUpdated(id, newDynamicSwapFee);
+        } else {
+            revert FeeNotDynamic();
+        }
+    }
+
     function extsload(bytes32 slot) external view returns (bytes32 value) {
         /// @solidity memory-safe-assembly
         assembly {

contracts/interfaces/IDynamicFeeManager.sol

@@ -7,7 +7,5 @@ import {IPoolManager} from "./IPoolManager.sol";
 /// @notice The dynamic fee manager determines fees for pools
 /// @dev note that this pool is only called if the PoolKey fee value is equal to the DYNAMIC_FEE magic value
 interface IDynamicFeeManager {
-    function getFee(address sender, PoolKey calldata key, IPoolManager.SwapParams calldata params, bytes calldata data)
-        external
-        returns (uint24);
+    function getFee(address sender, PoolKey calldata key) external view returns (uint24);
 }

contracts/interfaces/IFees.sol

@@ -8,6 +8,8 @@ interface IFees {
     error FeeTooLarge();
     /// @notice Thrown when not enough gas is provided to look up the protocol fee
     error ProtocolFeeCannotBeFetched();
+    /// @notice Thrown when a pool does not have a dynamic fee.
+    error FeeNotDynamic();
 
     event ProtocolFeeControllerUpdated(address protocolFeeController);
 

contracts/interfaces/IPoolManager.sol

@@ -81,6 +81,8 @@ interface IPoolManager is IFees {
 
     event HookFeeUpdated(PoolId indexed id, uint24 hookFees);
 
+    event DynamicSwapFeeUpdated(PoolId indexed id, uint24 dynamicSwapFee);
+
     /// @notice Returns the constant representing the maximum tickSpacing for an initialized pool key
     function MAX_TICK_SPACING() external view returns (int24);
 
@@ -192,6 +194,9 @@ interface IPoolManager is IFees {
     /// @notice Sets the hook's swap and withdrawal fees for the given pool
     function setHookFees(PoolKey memory key) external;
 
+    /// @notice Updates the pools swap fees for the a pool that has enabled dynamic swap fees.
+    function updateDynamicSwapFee(PoolKey memory key) external;
+
     /// @notice Called by external contracts to access granular pool state
     /// @param slot Key of slot to sload
     /// @return value The value of the slot as bytes32

contracts/libraries/Pool.sol

@@ -74,8 +74,9 @@ library Pool {
         int24 tick;
         uint24 protocolFees;
         uint24 hookFees;
+        // used for the swap fee, either static at initialize or dynamic via hook
+        uint24 swapFee;
     }
-    // 24 bits left!
 
     // info stored for each initialized individual tick
     struct TickInfo {
@@ -107,15 +108,21 @@ library Pool {
         if (tickUpper > TickMath.MAX_TICK) revert TickUpperOutOfBounds(tickUpper);
     }
 
-    function initialize(State storage self, uint160 sqrtPriceX96, uint24 protocolFees, uint24 hookFees)
+    function initialize(State storage self, uint160 sqrtPriceX96, uint24 protocolFees, uint24 hookFees, uint24 swapFee)
         internal
         returns (int24 tick)
     {
         if (self.slot0.sqrtPriceX96 != 0) revert PoolAlreadyInitialized();
 
         tick = TickMath.getTickAtSqrtRatio(sqrtPriceX96);
 
-        self.slot0 = Slot0({sqrtPriceX96: sqrtPriceX96, tick: tick, protocolFees: protocolFees, hookFees: hookFees});
+        self.slot0 = Slot0({
+            sqrtPriceX96: sqrtPriceX96,
+            tick: tick,
+            protocolFees: protocolFees,
+            hookFees: hookFees,
+            swapFee: swapFee
+        });
     }
 
     function getSwapFee(uint24 feesStorage) internal pure returns (uint16) {
@@ -138,6 +145,12 @@ library Pool {
         self.slot0.hookFees = hookFees;
     }
 
+    /// @notice Only dynamic fee pools may update the swap fee.
+    function setSwapFee(State storage self, uint24 swapFee) internal {
+        if (self.slot0.sqrtPriceX96 == 0) revert PoolNotInitialized();
+        self.slot0.swapFee = swapFee;
+    }
+
     struct ModifyPositionParams {
         // the address that owns the position
         address owner;
@@ -367,7 +380,6 @@ library Pool {
     }
 
     struct SwapParams {
-        uint24 fee;
         int24 tickSpacing;
         bool zeroForOne;
         int256 amountSpecified;
@@ -377,11 +389,18 @@ library Pool {
     /// @dev Executes a swap against the state, and returns the amount deltas of the pool
     function swap(State storage self, SwapParams memory params)
         internal
-        returns (BalanceDelta result, uint256 feeForProtocol, uint256 feeForHook, SwapState memory state)
+        returns (
+            BalanceDelta result,
+            uint256 feeForProtocol,
+            uint256 feeForHook,
+            uint24 swapFee,
+            SwapState memory state
+        )
     {
         if (params.amountSpecified == 0) revert SwapAmountCannotBeZero();
 
         Slot0 memory slot0Start = self.slot0;
+        swapFee = slot0Start.swapFee;
         if (slot0Start.sqrtPriceX96 == 0) revert PoolNotInitialized();
         if (params.zeroForOne) {
             if (params.sqrtPriceLimitX96 >= slot0Start.sqrtPriceX96) {
@@ -446,7 +465,7 @@ library Pool {
                 ) ? params.sqrtPriceLimitX96 : step.sqrtPriceNextX96,
                 state.liquidity,
                 state.amountSpecifiedRemaining,
-                params.fee
+                swapFee
             );
 
             if (exactInput) {