Optimization/suggestions from audit part2 (#115)

* chore: [internal-s11] pragma version

* docs: [internal-s12] docsstring

* optimization: [internal-s15] add error parameter for better debugging

* optimization: [internal-s13] a collection of modifications according audit feedback

* optimization: [internal-s16] wrap external call errors inside our custom error

* feat: Revert if contract size exceeds limit (#112)

* feat: Remove duplicate import (#114)

* Internal Audit (#113)

* feat: add indexed keyword for ProtocolFeeControllerUpdated

* optimization: add name for parameters in mapping

* optimization: add visibility modifier for constant variables

* optimization: readability

* optimization: remove unused code

* docs: better naming for IProtocolFees

* docs: better docstring for IVaultToken

* fix: tag missing memory-safe for assembly block

* docs: aligns IVaultToken interfaces with actually implementation

* chore: resolving issues

* docs

* test: added test cases to make sure revert reason bubble up when doing external hook call

---------

Co-authored-by: Chef Snoopy <[email protected]>

.forge-snapshots/BinHookTest#testInitializeSucceedsWithHook.snap

@@ -1 +1 @@
-247817
+247837

.forge-snapshots/BinPoolManagerBytecodeSize.snap

@@ -1 +1 @@
-23506
+23620

.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap

@@ -1 +1 @@
-133718
+133834

.forge-snapshots/BinPoolManagerTest#testFuzzUpdateDynamicLPFee.snap

@@ -1 +1 @@
-32345
+32347

.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap

@@ -1 +1 @@
-142521
+142745

.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap

@@ -1 +1 @@
-288323
+288502

.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap

@@ -1 +1 @@
-126826
+127005

.forge-snapshots/BinPoolManagerTest#testGasDonate.snap

@@ -1 +1 @@
-114436
+114439

.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap

@@ -1 +1 @@
-171727
+171842

.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap

@@ -1 +1 @@
-177608
+177723

.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap

@@ -1 +1 @@
-132594
+132709

.forge-snapshots/BinPoolManagerTest#testInitialize_gasCheck_withoutHooks.snap

@@ -1 +1 @@
-162332
+162352

.forge-snapshots/CLPoolManagerBytecodeSize.snap

@@ -1 +1 @@
-22555
+22712

.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap

@@ -1 +1 @@
-352369
+352371

.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap

@@ -1 +1 @@
-167810
+167812

.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap

@@ -1 +1 @@
-239189
+239219

.forge-snapshots/CLPoolManagerTest#donateBothTokens.snap

@@ -1 +1 @@
-164628
+164624

.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap

@@ -1 +1 @@
-109453
+109451

.forge-snapshots/CLPoolManagerTest#initializeWithoutHooks.snap

@@ -1 +1 @@
-150070
+150114

.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap

@@ -1 +1 @@
-115732
+115846

.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap

@@ -1 +1 @@
-132492
+132270

.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap

@@ -1 +1 @@
-165173
+164836

.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap

@@ -1 +1 @@
-152527
+152376

.forge-snapshots/CLPoolManagerTest#swap_simple.snap

@@ -1 +1 @@
-72726
+72718

.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap

@@ -1 +1 @@
-144720
+144569

.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap

@@ -1 +1 @@
-88821
+88813

.forge-snapshots/CLPoolManagerTest#swap_withNative.snap

@@ -1 +1 @@
-72729
+72721

.forge-snapshots/CLPoolManagerTest#testFuzzUpdateDynamicLPFee.snap

@@ -1 +1 @@
-32081
+32083

.forge-snapshots/VaultBytecodeSize.snap

@@ -1 +1 @@
-7208
+7403

.forge-snapshots/VaultTest#collectFee.snap

@@ -1 +1 @@
-25351
+25466

.forge-snapshots/VaultTest#lockSettledWhenFlashloan.snap

@@ -1 +1 @@
-118602
+119050

.forge-snapshots/VaultTest#lockSettledWhenMultiHopSwap.snap

@@ -1 +1 @@
-42803
+42915

.forge-snapshots/VaultTest#lockSettledWhenSwap.snap

@@ -1 +1 @@
-42799
+42911

.forge-snapshots/nextInitializedTickWithinOneWord_lteFalse_gasCostForEntireWord.snap

@@ -1 +1 @@
-2273
+2267

.forge-snapshots/nextInitializedTickWithinOneWord_lteTrue_gasCostJustBelowBoundary.snap

@@ -1 +1 @@
-2614
+2246

README.md

@@ -1,6 +1,6 @@
 # Pancake v4 Core
 
-1. `0.8.24` in `foundry.toml` as we need `tload/tstore` support
+1. `0.8.26` in `foundry.toml` as it provides better gas optimization
 2. `.prettierrc` explictly set `singleQuote: false` to overwrite any local dev's settings
 
 ## Running test

src/Extsload.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 // Copyright (C) 2024 PancakeSwap
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
 /// @notice This code is adapted from
 // https://github.com/RageTrade/core/blob/main/contracts/utils/Extsload.sol

src/PausableRole.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 // Copyright (C) 2024 PancakeSwap
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
 import {IPausableRole} from "./interfaces/IPausableRole.sol";
 import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";

src/ProtocolFees.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 // Copyright (C) 2024 PancakeSwap
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
 import {PausableRole} from "./PausableRole.sol";
 import {Currency} from "./types/Currency.sol";
@@ -15,9 +15,13 @@ abstract contract ProtocolFees is IProtocolFees, PausableRole {
     using PoolIdLibrary for PoolKey;
     using ProtocolFeeLibrary for uint24;
 
+    /// @inheritdoc IProtocolFees
     mapping(Currency currency => uint256 amount) public protocolFeesAccrued;
 
+    /// @inheritdoc IProtocolFees
     IProtocolFeeController public protocolFeeController;
+
+    /// @inheritdoc IProtocolFees
     IVault public immutable vault;
 
     uint256 private immutable controllerGasLimit;
@@ -32,7 +36,7 @@ abstract contract ProtocolFees is IProtocolFees, PausableRole {
     /// @inheritdoc IProtocolFees
     function setProtocolFee(PoolKey memory key, uint24 newProtocolFee) external virtual {
         if (msg.sender != address(protocolFeeController)) revert InvalidCaller();
-        if (!newProtocolFee.validate()) revert FeeTooLarge();
+        if (!newProtocolFee.validate()) revert ProtocolFeeTooLarge(newProtocolFee);
         PoolId id = key.toId();
         _setProtocolFee(id, newProtocolFee);
         emit ProtocolFeeUpdated(id, newProtocolFee);

src/Vault.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 // Copyright (C) 2024 PancakeSwap
-pragma solidity ^0.8.24;
+pragma solidity 0.8.26;
 
 import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
 import {IVault, IVaultToken} from "./interfaces/IVault.sol";

src/VaultToken.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 // Copyright (C) 2024 PancakeSwap
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
 import {Currency} from "./types/Currency.sol";
 import {IVaultToken} from "./interfaces/IVaultToken.sol";

src/interfaces/IERC20Minimal.sol

@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
 /// @title Minimal ERC20 interface for PancakeSwap
 /// @notice Contains a subset of the full ERC20 interface that is used in PancakeSwap V3

src/interfaces/IExtsload.sol

@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
 interface IExtsload {
     /// @notice Called by external contracts to access granular pool state

src/interfaces/IHooks.sol

@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
 interface IHooks {
     function getHooksRegistrationBitmap() external view returns (uint16);

src/interfaces/ILockCallback.sol

@@ -1,6 +1,7 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
+/// @notice Interface for the callback executed when an address locks the vault
 interface ILockCallback {
     /// @notice Called by the pool manager on `msg.sender` when a lock is acquired
     /// @param data The data that was passed to the call to lock

src/interfaces/IPausableRole.sol

@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
 interface IPausableRole {
     /// @notice Thrown when the caller does not have the pausable role or is not owner

src/interfaces/IPoolManager.sol

@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
 import {IHooks} from "./IHooks.sol";
 import {PoolKey} from "../types/PoolKey.sol";
@@ -11,7 +11,7 @@ interface IPoolManager {
     error PoolNotInitialized();
 
     /// @notice PoolKey must have currencies where address(currency0) < address(currency1)
-    error CurrenciesInitializedOutOfOrder();
+    error CurrenciesInitializedOutOfOrder(address currency0, address currency1);
 
     /// @notice Thrown when a call to updateDynamicLPFee is made by an address that is not the hook,
     /// or on a pool is not a dynamic fee pool.

src/interfaces/IProtocolFeeController.sol

@@ -1,11 +1,14 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
 import {PoolKey} from "../types/PoolKey.sol";
 
 interface IProtocolFeeController {
-    /// @notice Returns the protocol fee for a pool given the conditions of this contract
+    /// @notice Get the protocol fee for a pool given the conditions of this contract
     /// @param poolKey The pool key to identify the pool. The controller may want to use attributes on the pool
     ///   to determine the protocol fee, hence the entire key is needed.
-    function protocolFeeForPool(PoolKey memory poolKey) external view returns (uint24);
+    /// @return protocolFee The pool's protocol fee, expressed in hundredths of a bip. The upper 12 bits are for 1->0
+    /// and the lower 12 are for 0->1. The maximum is 1000 - meaning the maximum protocol fee is 0.1%.
+    /// the protocolFee is taken from the input first, then the lpFee is taken from the remaining input
+    function protocolFeeForPool(PoolKey memory poolKey) external view returns (uint24 protocolFee);
 }

src/interfaces/IProtocolFees.sol

@@ -1,14 +1,15 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
 import {Currency} from "../types/Currency.sol";
 import {IProtocolFeeController} from "./IProtocolFeeController.sol";
 import {PoolId} from "../types/PoolId.sol";
 import {PoolKey} from "../types/PoolKey.sol";
+import {IVault} from "./IVault.sol";
 
 interface IProtocolFees {
     /// @notice Thrown when the protocol fee exceeds the upper limit.
-    error FeeTooLarge();
+    error ProtocolFeeTooLarge(uint24 fee);
     /// @notice Thrown when not enough gas is provided to look up the protocol fee
     error ProtocolFeeCannotBeFetched();
     /// @notice Thrown when user not authorized to set or collect protocol fee
@@ -29,6 +30,10 @@ interface IProtocolFees {
     /// @return amount The amount of protocol fees accrued in the given currency
     function protocolFeesAccrued(Currency currency) external view returns (uint256 amount);
 
+    /// @notice Returns the current protocol fee controller address
+    /// @return IProtocolFeeController The currency protocol fee controller
+    function protocolFeeController() external view returns (IProtocolFeeController);
+
     /// @notice Sets the protocol's swap fee for the given pool
     /// @param key The pool key for which to set the protocol fee
     /// @param newProtocolFee The new protocol fee to set
@@ -46,4 +51,8 @@ interface IProtocolFees {
     function collectProtocolFees(address recipient, Currency currency, uint256 amount)
         external
         returns (uint256 amountCollected);
+
+    /// @notice Returns the vault where the protocol fees are safely stored
+    /// @return IVault The address of the vault
+    function vault() external view returns (IVault);
 }

src/interfaces/IVault.sol

@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
 import {Currency} from "../types/Currency.sol";
 import {PoolId} from "../types/PoolId.sol";

src/interfaces/IVaultToken.sol

@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.0;
 
 import {PoolId} from "../types/PoolId.sol";
 import {PoolKey} from "../types/PoolKey.sol";