pancakeswap · ChefMist · Nov 7, 2024 · Nov 5, 2024 · Nov 6, 2024 · Nov 6, 2024
diff --git a/.forge-snapshots/BinCustomCurveHookTest#test_Swap_CustomCurve.snap b/.forge-snapshots/BinCustomCurveHookTest#test_Swap_CustomCurve.snap
@@ -0,0 +1 @@
+142390
diff --git a/.forge-snapshots/BinHookTest#testBurnSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testBurnSucceedsWithHook.snap
@@ -1 +1 @@
-178172
+178130
diff --git a/.forge-snapshots/BinHookTest#testMintSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testMintSucceedsWithHook.snap
@@ -1 +1 @@
-311226
+311254
diff --git a/.forge-snapshots/BinHookTest#testSwapSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testSwapSucceedsWithHook.snap
@@ -1 +1 @@
-189430
+189473
diff --git a/.forge-snapshots/BinMintBurnFeeHookTest#test_Burn.snap b/.forge-snapshots/BinMintBurnFeeHookTest#test_Burn.snap
@@ -0,0 +1 @@
+170035
diff --git a/.forge-snapshots/BinMintBurnFeeHookTest#test_Mint.snap b/.forge-snapshots/BinMintBurnFeeHookTest#test_Mint.snap
@@ -0,0 +1 @@
+410226
diff --git a/.forge-snapshots/BinPoolManagerBytecodeSize.snap b/.forge-snapshots/BinPoolManagerBytecodeSize.snap
@@ -1 +1 @@
-24175
+23296
diff --git a/.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap b/.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap
@@ -1 +1 @@
-133811
+133857
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap
@@ -1 +1 @@
-142616
+142673
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap
@@ -1 +1 @@
-289602
+289648
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap
@@ -1 +1 @@
-126984
+127029
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap b/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap
@@ -1 +1 @@
-118513
+118628
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap
@@ -1 +1 @@
-968244
+968387
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap
@@ -1 +1 @@
-327556
+327699
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap
@@ -1 +1 @@
-337280
+337423
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap
@@ -1 +1 @@
-139831
+139974
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap
@@ -1 +1 @@
-172918
+173054
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap
@@ -1 +1 @@
-178946
+179082
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap
@@ -1 +1 @@
-132949
+133085
diff --git a/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap b/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap
@@ -1 +1 @@
-304363
+304484
diff --git a/.forge-snapshots/CLCustomCurveHookTest#test_Swap_CustomCurve.snap b/.forge-snapshots/CLCustomCurveHookTest#test_Swap_CustomCurve.snap
@@ -0,0 +1 @@
+149600
diff --git a/.forge-snapshots/CLMintBurnFeeHookTest#test_Burn.snap b/.forge-snapshots/CLMintBurnFeeHookTest#test_Burn.snap
@@ -0,0 +1 @@
+170881
diff --git a/.forge-snapshots/CLMintBurnFeeHookTest#test_Mint.snap b/.forge-snapshots/CLMintBurnFeeHookTest#test_Mint.snap
@@ -0,0 +1 @@
+421255
diff --git a/.forge-snapshots/CLPoolManagerBytecodeSize.snap b/.forge-snapshots/CLPoolManagerBytecodeSize.snap
@@ -1 +1 @@
-21103
+20745
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap
@@ -1 +1 @@
-347359
+347480
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap
@@ -1 +1 @@
-162820
+162941
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap
@@ -1 +1 @@
-238365
+238442
diff --git a/.forge-snapshots/CLPoolManagerTest#donateBothTokens.snap b/.forge-snapshots/CLPoolManagerTest#donateBothTokens.snap
@@ -1 +1 @@
-163100
+163218
diff --git a/.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap b/.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap
@@ -1 +1 @@
-108172
+108268
diff --git a/.forge-snapshots/CLPoolManagerTest#initializeWithoutHooks.snap b/.forge-snapshots/CLPoolManagerTest#initializeWithoutHooks.snap
@@ -1 +1 @@
-149202
+149205
diff --git a/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap
@@ -1 +1 @@
-112713
+112784
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap
@@ -1 +1 @@
-130739
+130830
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap b/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap
@@ -1 +1 @@
-163100
+163213
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap
@@ -1 +1 @@
-148519
+148610
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_simple.snap b/.forge-snapshots/CLPoolManagerTest#swap_simple.snap
@@ -1 +1 @@
-71220
+71289
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap b/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap
@@ -1 +1 @@
-143103
+143194
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap b/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap
@@ -1 +1 @@
-87408
+87479
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap b/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap
@@ -1 +1 @@
-71223
+71292
diff --git a/.forge-snapshots/CLPoolManagerTest#testFuzzUpdateDynamicLPFee.snap b/.forge-snapshots/CLPoolManagerTest#testFuzzUpdateDynamicLPFee.snap
@@ -1 +1 @@
-31953
+31956
diff --git a/.forge-snapshots/ExtsloadTest#extsload.snap b/.forge-snapshots/ExtsloadTest#extsload.snap
@@ -1 +1 @@
-7315
+7318
diff --git a/.forge-snapshots/ExtsloadTest#extsloadInBatch.snap b/.forge-snapshots/ExtsloadTest#extsloadInBatch.snap
@@ -1 +1 @@
-10977
+10980
diff --git a/.forge-snapshots/VaultBytecodeSize.snap b/.forge-snapshots/VaultBytecodeSize.snap
@@ -1 +1 @@
-7792
+8131
diff --git a/.forge-snapshots/VaultTest#testVault_clear_successWithNonZeroExistingDelta.snap b/.forge-snapshots/VaultTest#testVault_clear_successWithNonZeroExistingDelta.snap
@@ -1 +1 @@
-2854
+2876
diff --git a/.forge-snapshots/VaultTest#testVault_clear_successWithZeroExistingDelta.snap b/.forge-snapshots/VaultTest#testVault_clear_successWithZeroExistingDelta.snap
@@ -1 +1 @@
-1858
+1880
diff --git a/src/Vault.sol b/src/Vault.sol
@@ -72,6 +72,30 @@ contract Vault is IVault, VaultToken, Ownable {
         SettlementGuard.setLocker(address(0));
     }
 
+    /// @inheritdoc IVault
+    function accountAppBalanceDelta(
+        Currency currency0,
+        Currency currency1,
+        BalanceDelta delta,
+        address settler,
+        BalanceDelta hookDelta,
+        address hook
+    ) external override isLocked onlyRegisteredApp {
+        (int128 delta0, int128 delta1) = (delta.amount0(), delta.amount1());
+        (int128 hookDelta0, int128 hookDelta1) = (hookDelta.amount0(), hookDelta.amount1());
+
+        /// @dev call _accountDeltaForApp once with both delta/hookDelta to save gas and prevent
+        /// reservesOfApp from underflow when it deduct before addition
+        _accountDeltaForApp(currency0, delta0 + hookDelta0);
+        _accountDeltaForApp(currency1, delta1 + hookDelta1);
+
+        // keep track of the balance on vault level
+        SettlementGuard.accountDelta(settler, currency0, delta0);
+        SettlementGuard.accountDelta(settler, currency1, delta1);
+        SettlementGuard.accountDelta(hook, currency0, hookDelta0);
+        SettlementGuard.accountDelta(hook, currency1, hookDelta1);
+    }
+
     /// @inheritdoc IVault
     function accountAppBalanceDelta(Currency currency0, Currency currency1, BalanceDelta delta, address settler)
         external

diff --git a/src/interfaces/IVault.sol b/src/interfaces/IVault.sol
@@ -56,6 +56,24 @@ interface IVault is IVaultToken {
     /// @return The data returned by the call to `ILockCallback(msg.sender).lockCallback(data)`
     function lock(bytes calldata data) external returns (bytes memory);
 
+    /// @notice Called by registered app to account for a change in the pool balance,
+    /// convenient for AMM pool manager, typically after modifyLiquidity, swap, donate,
+    /// include the case where hookDelta is involved
+    /// @param currency0 The PoolKey currency0 to update
+    /// @param currency1 The PoolKey currency1 to update
+    /// @param delta The change in the pool's balance
+    /// @param settler The address whose delta will be updated
+    /// @param hookDelta The change in the pool's balance from hook
+    /// @param hook The address whose hookDelta will be updated
+    function accountAppBalanceDelta(
+        Currency currency0,
+        Currency currency1,
+        BalanceDelta delta,
+        address settler,
+        BalanceDelta hookDelta,
+        address hook
+    ) external;
+
     /// @notice Called by registered app to account for a change in the pool balance,
     /// convenient for AMM pool manager, typically after modifyLiquidity, swap, donate
     /// @param currency0 The PoolKey currency0 to update

diff --git a/src/libraries/VaultAppDeltaSettlement.sol b/src/libraries/VaultAppDeltaSettlement.sol
@@ -0,0 +1,22 @@
+// 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`
+    function accountAppDeltaWithHookDelta(IVault vault, PoolKey memory key, BalanceDelta delta, BalanceDelta hookDelta)
+        internal
+    {
+        if (hookDelta == BalanceDeltaLibrary.ZERO_DELTA) {
+            /// @dev default case when no hook return delta is set
+            vault.accountAppBalanceDelta(key.currency0, key.currency1, delta, msg.sender);
+        } else {
+            vault.accountAppBalanceDelta(key.currency0, key.currency1, delta, msg.sender, hookDelta, address(key.hooks));
+        }
+    }
+}
diff --git a/src/pool-bin/BinPoolManager.sol b/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);
     }
 
     /// @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);
     }
 
     /// @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);
     }
 
     function donate(PoolKey memory key, uint128 amount0, uint128 amount1, bytes calldata hookData)

diff --git a/src/pool-cl/CLPoolManager.sol b/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);
     }
 
     /// @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);
     }
 
     /// @inheritdoc ICLPoolManager