Update vault.accountAppBalanceDelta logic flow from app

.forge-snapshots/BinHookTest#testBurnSucceedsWithHook.snap

@@ -1 +1 @@
-178172
+178124

.forge-snapshots/BinHookTest#testMintSucceedsWithHook.snap

@@ -1 +1 @@
-311226
+311244

.forge-snapshots/BinHookTest#testSwapSucceedsWithHook.snap

@@ -1 +1 @@
-189430
+189464

.forge-snapshots/BinPoolManagerBytecodeSize.snap

@@ -1 +1 @@
-24175
+24467

.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap

@@ -1 +1 @@
-133811
+133795

.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap

@@ -1 +1 @@
-142616
+142596

.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap

@@ -1 +1 @@
-289602
+289586

.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap

@@ -1 +1 @@
-126984
+126968

.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap

@@ -1 +1 @@
-968244
+968262

.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap

@@ -1 +1 @@
-327556
+327574

.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap

@@ -1 +1 @@
-337280
+337298

.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap

@@ -1 +1 @@
-139831
+139849

.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap

@@ -1 +1 @@
-172918
+172952

.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap

@@ -1 +1 @@
-178946
+178980

.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap

@@ -1 +1 @@
-132949
+132983

.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap

@@ -1 +1 @@
-304363
+304381

.forge-snapshots/CLPoolManagerBytecodeSize.snap

@@ -1 +1 @@
-21103
+22048

.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap

@@ -1 +1 @@
-347359
+347387

.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap

@@ -1 +1 @@
-162820
+162848

.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap

@@ -1 +1 @@
-238365
+238393

.forge-snapshots/CLPoolManagerTest#donateBothTokens.snap

@@ -1 +1 @@
-163100
+163103

.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap

@@ -1 +1 @@
-108172
+108175

.forge-snapshots/CLPoolManagerTest#initializeWithoutHooks.snap

@@ -1 +1 @@
-149202
+149205

.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap

@@ -1 +1 @@
-112713
+112740

.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap

@@ -1 +1 @@
-130739
+130768

.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap

@@ -1 +1 @@
-163100
+163129

.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap

@@ -1 +1 @@
-148519
+148548

.forge-snapshots/CLPoolManagerTest#swap_simple.snap

@@ -1 +1 @@
-71220
+71249

.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap

@@ -1 +1 @@
-143103
+143132

.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap

@@ -1 +1 @@
-87408
+87442

.forge-snapshots/CLPoolManagerTest#swap_withNative.snap

@@ -1 +1 @@
-71223
+71252

.forge-snapshots/CLPoolManagerTest#testFuzzUpdateDynamicLPFee.snap

@@ -1 +1 @@
-31953
+31956

.forge-snapshots/ExtsloadTest#extsload.snap

@@ -1 +1 @@
-7315
+7318

.forge-snapshots/ExtsloadTest#extsloadInBatch.snap

@@ -1 +1 @@
-10977
+10980

src/libraries/VaultAppDeltaSettlement.sol

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+// Copyright (C) 2024 PancakeSwap
+pragma solidity ^0.8.0;
+
+import {BalanceDelta, BalanceDeltaLibrary} from "../types/BalanceDelta.sol";
+import {PoolKey} from "../types/PoolKey.sol";
+import {IVault} from "../interfaces/IVault.sol";
+
+/// @notice Library for handling AppDeltaSettlement for the apps (eg. CL, Bin etc..)
+library VaultAppDeltaSettlement {
+    /// @notice helper method to call `vault.accountAppBalanceDelta`
+    /// @dev Vault maintains a `reserveOfApp` to protect against exploits in one app from accessing funds in another.
+    /// To prevent underflow in `reserveOfApp`, it is essential to handle `appDelta` and `hookDelta` in a specific order.
+    function accountAppDeltaWithHookDelta(
+        IVault vault,
+        PoolKey memory key,
+        BalanceDelta delta,
+        BalanceDelta hookDelta,
+        address settler
+    ) internal {
+        if (hookDelta == BalanceDeltaLibrary.ZERO_DELTA) {
+            /// @dev default case when no hook return delta is set
+            vault.accountAppBalanceDelta(key.currency0, key.currency1, delta, settler);
+        } else {
+            /// @dev if hookDelta is not 0, call vault.accountAppBalanceDelta with negative delta first
+            /// negative delta means user/hook owes vault money, so reservesOfApp in vault will not underflow
+            (int128 hookDelta0, int128 hookDelta1) = (hookDelta.amount0(), hookDelta.amount1());
+            (int128 delta0, int128 delta1) = (delta.amount0(), delta.amount1());
+
+            if (hookDelta0 < 0) {
+                vault.accountAppBalanceDelta(key.currency0, hookDelta0, address(key.hooks));
+                if (delta0 != 0) vault.accountAppBalanceDelta(key.currency0, delta0, settler);
+            } else {
+                if (delta0 != 0) vault.accountAppBalanceDelta(key.currency0, delta0, settler);
+                if (hookDelta0 != 0) vault.accountAppBalanceDelta(key.currency0, hookDelta0, address(key.hooks));
+            }
+
+            if (hookDelta1 < 0) {
+                vault.accountAppBalanceDelta(key.currency1, hookDelta1, address(key.hooks));
+                if (delta1 != 0) vault.accountAppBalanceDelta(key.currency1, delta1, settler);
+            } else {
+                if (delta1 != 0) vault.accountAppBalanceDelta(key.currency1, delta1, settler);
+                if (hookDelta1 != 0) vault.accountAppBalanceDelta(key.currency1, hookDelta1, address(key.hooks));
+            }
+        }
+    }
+}

src/pool-bin/BinPoolManager.sol

@@ -23,6 +23,7 @@ import {PriceHelper} from "./libraries/PriceHelper.sol";
 import {BeforeSwapDelta} from "../types/BeforeSwapDelta.sol";
 import "./interfaces/IBinHooks.sol";
 import {BinSlot0} from "./types/BinSlot0.sol";
+import {VaultAppDeltaSettlement} from "../libraries/VaultAppDeltaSettlement.sol";
 
 /// @notice Holds the state for all bin pools
 contract BinPoolManager is IBinPoolManager, ProtocolFees, Extsload {
@@ -32,6 +33,7 @@ contract BinPoolManager is IBinPoolManager, ProtocolFees, Extsload {
     using LPFeeLibrary for uint24;
     using PackedUint128Math for bytes32;
     using Hooks for bytes32;
+    using VaultAppDeltaSettlement for IVault;
 
     /// @inheritdoc IBinPoolManager
     uint16 public constant override MIN_BIN_STEP = 1;
@@ -181,11 +183,7 @@ contract BinPoolManager is IBinPoolManager, ProtocolFees, Extsload {
         BalanceDelta hookDelta;
         (delta, hookDelta) = BinHooks.afterSwap(key, swapForY, amountSpecified, delta, hookData, beforeSwapDelta);
 
-        if (hookDelta != BalanceDeltaLibrary.ZERO_DELTA) {
-            vault.accountAppBalanceDelta(key.currency0, key.currency1, hookDelta, address(key.hooks));
-        }
-
-        vault.accountAppBalanceDelta(key.currency0, key.currency1, delta, msg.sender);
+        vault.accountAppDeltaWithHookDelta(key, delta, hookDelta, msg.sender);
     }
 
     /// @inheritdoc IBinPoolManager
@@ -229,10 +227,7 @@ contract BinPoolManager is IBinPoolManager, ProtocolFees, Extsload {
         BalanceDelta hookDelta;
         (delta, hookDelta) = BinHooks.afterMint(key, params, delta, hookData);
 
-        if (hookDelta != BalanceDeltaLibrary.ZERO_DELTA) {
-            vault.accountAppBalanceDelta(key.currency0, key.currency1, hookDelta, address(key.hooks));
-        }
-        vault.accountAppBalanceDelta(key.currency0, key.currency1, delta, msg.sender);
+        vault.accountAppDeltaWithHookDelta(key, delta, hookDelta, msg.sender);
     }
 
     /// @inheritdoc IBinPoolManager
@@ -264,10 +259,7 @@ contract BinPoolManager is IBinPoolManager, ProtocolFees, Extsload {
         BalanceDelta hookDelta;
         (delta, hookDelta) = BinHooks.afterBurn(key, params, delta, hookData);
 
-        if (hookDelta != BalanceDeltaLibrary.ZERO_DELTA) {
-            vault.accountAppBalanceDelta(key.currency0, key.currency1, hookDelta, address(key.hooks));
-        }
-        vault.accountAppBalanceDelta(key.currency0, key.currency1, delta, msg.sender);
+        vault.accountAppDeltaWithHookDelta(key, delta, hookDelta, msg.sender);
     }
 
     function donate(PoolKey memory key, uint128 amount0, uint128 amount1, bytes calldata hookData)

src/pool-cl/CLPoolManager.sol

@@ -25,6 +25,7 @@ import {BeforeSwapDelta} from "../types/BeforeSwapDelta.sol";
 import {Currency} from "../types/Currency.sol";
 import {TickMath} from "./libraries/TickMath.sol";
 import {CLSlot0} from "./types/CLSlot0.sol";
+import {VaultAppDeltaSettlement} from "../libraries/VaultAppDeltaSettlement.sol";
 
 contract CLPoolManager is ICLPoolManager, ProtocolFees, Extsload {
     using SafeCast for int256;
@@ -34,6 +35,7 @@ contract CLPoolManager is ICLPoolManager, ProtocolFees, Extsload {
     using CLPool for *;
     using CLPosition for mapping(bytes32 => CLPosition.Info);
     using CLPoolGetters for CLPool.State;
+    using VaultAppDeltaSettlement for IVault;
 
     mapping(PoolId id => CLPool.State poolState) private pools;
 
@@ -154,10 +156,7 @@ contract CLPoolManager is ICLPoolManager, ProtocolFees, Extsload {
         // notice that both generated delta and feeDelta (from lpFee) will both be counted on the user
         (delta, hookDelta) = CLHooks.afterModifyLiquidity(key, params, delta + feeDelta, feeDelta, hookData);
 
-        if (hookDelta != BalanceDeltaLibrary.ZERO_DELTA) {
-            vault.accountAppBalanceDelta(key.currency0, key.currency1, hookDelta, address(key.hooks));
-        }
-        vault.accountAppBalanceDelta(key.currency0, key.currency1, delta, msg.sender);
+        vault.accountAppDeltaWithHookDelta(key, delta, hookDelta, msg.sender);
     }
 
     /// @inheritdoc ICLPoolManager
@@ -206,15 +205,11 @@ contract CLPoolManager is ICLPoolManager, ProtocolFees, Extsload {
         );
 
         BalanceDelta hookDelta;
-        (delta, hookDelta) = CLHooks.afterSwap(key, params, delta, hookData, beforeSwapDelta);
-
-        if (hookDelta != BalanceDeltaLibrary.ZERO_DELTA) {
-            vault.accountAppBalanceDelta(key.currency0, key.currency1, hookDelta, address(key.hooks));
-        }
 
         /// @dev delta already includes protocol fee
-        /// all tokens go into the vault
-        vault.accountAppBalanceDelta(key.currency0, key.currency1, delta, msg.sender);
+        (delta, hookDelta) = CLHooks.afterSwap(key, params, delta, hookData, beforeSwapDelta);
+
+        vault.accountAppDeltaWithHookDelta(key, delta, hookDelta, msg.sender);
     }
 
     /// @inheritdoc ICLPoolManager