[Part 2 of 3] Increase optimizer runs (s41) (#75)

* feat: increase optimizer runs * [Part 3 of 3] Code factoring (s43, s48, s50) (#76) * s43: interface doc update * s48: use directive with global * s50: use internal keyword to make visibility obvious
pancakeswap · Jan 27, 2025 · 69ce492 · 69ce492
1 parent 8d22bfe
commit 69ce492
Show file tree

Hide file tree

Showing 69 changed files with 127 additions and 137 deletions.
diff --git a/foundry.toml b/foundry.toml
@@ -2,7 +2,7 @@
 src = 'src'
 out = 'foundry-out'
 solc_version = '0.8.26'
-optimizer_runs = 9000
+optimizer_runs = 1_000_000
 via_ir = true
 ffi = true
 gas_limit = "3000000000"
@@ -15,6 +15,14 @@ fs_permissions = [
 evm_version = 'cancun'
 bytecode_hash = "none"
 
+additional_compiler_profiles = [
+  { name = "clPosm", optimizer_runs = 9000 }
+]
+
+compilation_restrictions = [
+  { paths = "src/pool-cl/CLPositionManager.sol", optimizer_runs = 9000 }
+]
+
 [fuzz]
 runs = 5 # change this for higher number of fuzz runs locally
 

diff --git a/snapshots/BaseActionsRouterTest.json b/snapshots/BaseActionsRouterTest.json
@@ -1,3 +1,3 @@
 {
-  "mock10commands": "82833"
+  "mock10commands": "82785"
 }
diff --git a/snapshots/BinMigratorFromPancakeswapV2Test.json b/snapshots/BinMigratorFromPancakeswapV2Test.json
@@ -1,5 +1,5 @@
 {
-  "testMigrateFromV2IncludingInit": "1180066",
-  "testMigrateFromV2WithoutInit": "1049481",
-  "testMigrateFromV2WithoutNativeToken": "1090203"
+  "testMigrateFromV2IncludingInit": "1176442",
+  "testMigrateFromV2WithoutInit": "1046490",
+  "testMigrateFromV2WithoutNativeToken": "1087310"
 }
diff --git a/snapshots/BinMigratorFromPancakeswapV3Test.json b/snapshots/BinMigratorFromPancakeswapV3Test.json
@@ -1,6 +1,6 @@
 {
-  "BinMigratorBytecode size": "12601",
-  "testMigrateFromV3IncludingInit": "1252393",
-  "testMigrateFromV3WithoutInit": "1121789",
-  "testMigrateFromV3WithoutNativeToken": "1156506"
+  "BinMigratorBytecode size": "15187",
+  "testMigrateFromV3IncludingInit": "1248658",
+  "testMigrateFromV3WithoutInit": "1118687",
+  "testMigrateFromV3WithoutNativeToken": "1153511"
 }
diff --git a/snapshots/BinMigratorFromUniswapV2Test.json b/snapshots/BinMigratorFromUniswapV2Test.json
@@ -1,5 +1,5 @@
 {
-  "testMigrateFromV2IncludingInit": "1180066",
-  "testMigrateFromV2WithoutInit": "1049481",
-  "testMigrateFromV2WithoutNativeToken": "1090203"
+  "testMigrateFromV2IncludingInit": "1176442",
+  "testMigrateFromV2WithoutInit": "1046490",
+  "testMigrateFromV2WithoutNativeToken": "1087310"
 }
diff --git a/snapshots/BinMigratorFromUniswapV3Test.json b/snapshots/BinMigratorFromUniswapV3Test.json
@@ -1,6 +1,6 @@
 {
-  "BinMigratorBytecode size": "12601",
-  "testMigrateFromV3IncludingInit": "1250375",
-  "testMigrateFromV3WithoutInit": "1119771",
-  "testMigrateFromV3WithoutNativeToken": "1154488"
+  "BinMigratorBytecode size": "15187",
+  "testMigrateFromV3IncludingInit": "1246640",
+  "testMigrateFromV3WithoutInit": "1116669",
+  "testMigrateFromV3WithoutNativeToken": "1151493"
 }
diff --git a/snapshots/BinPositionManagerTest.json b/snapshots/BinPositionManagerTest.json
@@ -1,3 +1,3 @@
 {
-  "BinPositionManagerBytecode size": "15154"
+  "BinPositionManagerBytecode size": "17435"
 }
diff --git a/snapshots/BinPositionManager_ModifyLiquidityTest.json b/snapshots/BinPositionManager_ModifyLiquidityTest.json
@@ -1,7 +1,7 @@
 {
-  "test_addLiquidity_OutsideActiveId": "294827",
-  "test_addLiquidity_SingleBin": "533778",
-  "test_addLiquidity_ThreeBins": "908043",
-  "test_decreaseLiquidity_threeBins": "186051",
-  "test_decreaseLiquidity_threeBins_half": "205238"
+  "test_addLiquidity_OutsideActiveId": "292694",
+  "test_addLiquidity_SingleBin": "532073",
+  "test_addLiquidity_ThreeBins": "905930",
+  "test_decreaseLiquidity_threeBins": "184859",
+  "test_decreaseLiquidity_threeBins_half": "203748"
 }
diff --git a/snapshots/BinPositionManager_NativeTokenTest.json b/snapshots/BinPositionManager_NativeTokenTest.json
@@ -1,5 +1,5 @@
 {
-  "test_addLiquidity": "849375",
-  "test_addLiquidity_excessEth": "851136",
-  "test_decreaseLiquidity": "192695"
+  "test_addLiquidity": "847340",
+  "test_addLiquidity_excessEth": "849077",
+  "test_decreaseLiquidity": "191515"
 }
diff --git a/snapshots/BinQuoterTest.json b/snapshots/BinQuoterTest.json
@@ -1,3 +1,3 @@
 {
-  "BinQuoterBytecode size": "6299"
+  "BinQuoterBytecode size": "6839"
 }
diff --git a/snapshots/BinSwapRouterTest.json b/snapshots/BinSwapRouterTest.json
@@ -1,9 +1,9 @@
 {
-  "testExactInputSingle_DifferentRecipient": "137214",
-  "testExactInputSingle_EthPool_SwapEthForToken": "125543",
-  "testExactInputSingle_EthPool_SwapTokenForEth": "111288",
-  "testExactInput_MultiHopDifferentRecipient": "168754",
-  "testExactOutputSingle_DifferentRecipient": "141480",
-  "testExactOutput_MultiHopDifferentRecipient": "172390",
-  "testExactOutput_SingleHop": "143161"
+  "testExactInputSingle_DifferentRecipient": "136133",
+  "testExactInputSingle_EthPool_SwapEthForToken": "124501",
+  "testExactInputSingle_EthPool_SwapTokenForEth": "110210",
+  "testExactInput_MultiHopDifferentRecipient": "166964",
+  "testExactOutputSingle_DifferentRecipient": "140509",
+  "testExactOutput_MultiHopDifferentRecipient": "170820",
+  "testExactOutput_SingleHop": "142184"
 }
diff --git a/snapshots/CLPositionDescriptorOffChainTest.json b/snapshots/CLPositionDescriptorOffChainTest.json
@@ -1,3 +1,3 @@
 {
-  "CLPositionDescriptorOffChain size": "2568"
+  "CLPositionDescriptorOffChain size": "2958"
 }
diff --git a/snapshots/CLQuoterTest.json b/snapshots/CLQuoterTest.json
@@ -1,3 +1,3 @@
 {
-  "CLQuoterBytecode size": "6458"
+  "CLQuoterBytecode size": "6998"
 }
diff --git a/snapshots/CLSwapRouterTest.json b/snapshots/CLSwapRouterTest.json
@@ -1,6 +1,6 @@
 {
-  "testExactInputSingle_gas": "169788",
-  "testExactInput_gas": "234192",
-  "testExactOutputSingle_gas": "169491",
-  "testExactOutput_gas": "233092"
+  "testExactInputSingle_gas": "168817",
+  "testExactInput_gas": "232455",
+  "testExactOutputSingle_gas": "168510",
+  "testExactOutput_gas": "231337"
 }
diff --git a/src/interfaces/IBaseMigrator.sol b/src/interfaces/IBaseMigrator.sol
@@ -5,6 +5,8 @@ import {PoolKey} from "pancake-v4-core/src/types/PoolKey.sol";
 import {IMulticall_v4} from "./IMulticall_v4.sol";
 import {ISelfPermitERC721} from "./ISelfPermitERC721.sol";
 
+/// @title IBaseMigrator
+/// @notice Interface for the BaseMigrator contract
 interface IBaseMigrator is IMulticall_v4, ISelfPermitERC721 {
     error TOKEN_NOT_MATCH();
     error INVALID_ETHER_SENDER();

diff --git a/src/interfaces/IImmutableState.sol b/src/interfaces/IImmutableState.sol
@@ -3,7 +3,8 @@ pragma solidity ^0.8.0;
 
 import {IVault} from "pancake-v4-core/src/interfaces/IVault.sol";
 
-/// @title Interface for ImmutableState
+/// @title IImmutableState
+/// @notice Interface for the ImmutableState contract
 interface IImmutableState {
     /// @notice The Pancakeswap v4 Vault contract
     function vault() external view returns (IVault);

diff --git a/src/interfaces/IPoolManager.sol b/src/interfaces/IPoolManager.sol
@@ -3,6 +3,8 @@ pragma solidity ^0.8.24;
 
 import {IVault} from "pancake-v4-core/src/interfaces/IVault.sol";
 
+/// @title IPoolManager
+/// @notice Interface for the PoolManager contract
 interface IPoolManager {
     /// @notice Returns the vault contract
     /// @return IVault The address of the vault

diff --git a/src/interfaces/IPositionManager.sol b/src/interfaces/IPositionManager.sol
@@ -3,6 +3,8 @@ pragma solidity ^0.8.24;
 
 import {IImmutableState} from "./IImmutableState.sol";
 
+/// @title IPositionManager
+/// @notice Interface for the PositionManager contract
 interface IPositionManager is IImmutableState {
     /// @notice Thrown when the block.timestamp exceeds the user-provided deadline
     error DeadlinePassed(uint256 deadline);

diff --git a/src/interfaces/IPositionManagerPermit2.sol b/src/interfaces/IPositionManagerPermit2.sol
@@ -3,6 +3,8 @@ pragma solidity ^0.8.0;
 
 import {IAllowanceTransfer} from "permit2/src/interfaces/IAllowanceTransfer.sol";
 
+/// @title IPositionManagerPermit2
+/// @notice Interface for the IPositionManagerPermit2 contract
 interface IPositionManagerPermit2 {
     function permit2() external view returns (IAllowanceTransfer);
 }
diff --git a/src/interfaces/IQuoter.sol b/src/interfaces/IQuoter.sol
@@ -6,7 +6,7 @@ import {PathKey} from "../libraries/PathKey.sol";
 import {PoolKey} from "pancake-v4-core/src/types/PoolKey.sol";
 import {PoolId} from "pancake-v4-core/src/types/PoolId.sol";
 
-/// @title IQuoter Interface
+/// @title IQuoter
 /// @notice Supports quoting the delta amounts from exact input or exact output swaps.
 /// @dev These functions are not marked view because they rely on calling non-view functions and reverting
 /// to compute the result. They are also not gas efficient and should not be called on-chain.

diff --git a/src/interfaces/ISelfPermit.sol b/src/interfaces/ISelfPermit.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-/// @title Self Permit
+/// @title ISelfPermit
 /// @notice Functionality to call permit on any EIP-2612-compliant token for use in the route
 interface ISelfPermit {
     /// @notice Permits this contract to spend a given token from `msg.sender`

diff --git a/src/interfaces/ISelfPermitERC721.sol b/src/interfaces/ISelfPermitERC721.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-/// @title Self Permit For ERC721
+/// @title ISelfPermitERC721
 /// @notice Functionality to call permit on any EIP-2612-compliant token
 /// This is for PancakeSwapV3 styled Nonfungible Position Manager which supports permit extension
 interface ISelfPermitERC721 {

diff --git a/src/interfaces/external/IERC20PermitAllowed.sol b/src/interfaces/external/IERC20PermitAllowed.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 pragma solidity ^0.8.0;
 
-/// @title Interface for permit
+/// @title IERC20PermitAllowed
 /// @notice Interface used by DAI/CHAI for permit
 interface IERC20PermitAllowed {
     /// @notice Approve the spender to spend some tokens via the holder signature

diff --git a/src/interfaces/external/IPancakeFactory.sol b/src/interfaces/external/IPancakeFactory.sol
@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: GPL-3.0-or-later
 pragma solidity ^0.8.0;
 
+/// @title IPancakeFactory
+/// @notice Interface for the PancakeFactory contract
 interface IPancakeFactory {
     function getPair(address tokenA, address tokenB) external view returns (address pair);
     function createPair(address tokenA, address tokenB) external returns (address pair);

diff --git a/src/interfaces/external/IPancakePair.sol b/src/interfaces/external/IPancakePair.sol
@@ -1,7 +1,8 @@
 // SPDX-License-Identifier: GPL-3.0-or-later
 pragma solidity ^0.8.0;
 
-/// @notice Copying from PancakeSwap V2 Pair
+/// @title IPancakePair
+/// @notice Interface for the PancakeSwap V2 Pair
 /// https://github.com/pancakeswap/pancake-swap-core-v2/blob/master/contracts/interfaces/IPancakePair.sol
 interface IPancakePair {
     event Approval(address indexed owner, address indexed spender, uint256 value);

diff --git a/src/interfaces/external/IPancakeV3Factory.sol b/src/interfaces/external/IPancakeV3Factory.sol
@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 pragma solidity ^0.8.0;
 
+/// @title IPancakeV3Factory
+/// @notice Interface for the PancakeV3Factory contract
 interface IPancakeV3Factory {
     /// @notice Returns the pool address for a given pair of tokens and a fee, or address 0 if it does not exist
     /// @dev tokenA and tokenB may be passed in either token0/token1 or token1/token0 order

diff --git a/src/interfaces/external/IPancakeV3Pool.sol b/src/interfaces/external/IPancakeV3Pool.sol
@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 pragma solidity ^0.8.0;
 
+/// @title IPancakeV3Pool
+/// @notice Interface for the PancakeV3Pool contract
 interface IPancakeV3Pool {
     /// @notice The 0th storage slot in the pool stores many values, and is exposed as a single method to save gas
     /// when accessed externally.

diff --git a/src/interfaces/external/IPancakeV3SwapCallback.sol b/src/interfaces/external/IPancakeV3SwapCallback.sol
@@ -1,8 +1,9 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 pragma solidity ^0.8.0;
 
-/// @title Callback for IPancakeV3PoolActions#swap
-/// @notice Any contract that calls IPancakeV3PoolActions#swap must implement this interface
+/// @title IPancakeV3SwapCallback
+/// @notice Callback for IPancakeV3PoolActions#swap
+/// @dev Any contract that calls IPancakeV3PoolActions#swap must implement this interface.
 interface IPancakeV3SwapCallback {
     /// @notice Called to `msg.sender` after executing a swap via IPancakeV3Pool#swap.
     /// @dev In the implementation you must pay the pool tokens owed for the swap.

diff --git a/src/interfaces/external/IStableSwap.sol b/src/interfaces/external/IStableSwap.sol
@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 pragma solidity ^0.8.0;
 
+/// @title IStableSwap
+/// @notice Interface for the StableSwap contract
 interface IStableSwap {
     // solium-disable-next-line mixedcase
     function get_dy(uint256 i, uint256 j, uint256 dx) external view returns (uint256 dy);

diff --git a/src/interfaces/external/IStableSwapFactory.sol b/src/interfaces/external/IStableSwapFactory.sol
@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 pragma solidity ^0.8.0;
 
+/// @title IStableSwapFactory
+/// @notice Interface for the StableSwapFactory contract
 interface IStableSwapFactory {
     struct StableSwapPairInfo {
         address swapContract;

diff --git a/src/interfaces/external/IV3NonfungiblePositionManager.sol b/src/interfaces/external/IV3NonfungiblePositionManager.sol
@@ -3,7 +3,7 @@ pragma solidity ^0.8.0;
 
 import {IERC721Permit} from "../../pool-cl/interfaces/IERC721Permit.sol";
 
-/// @title Non-fungible token for positions
+/// @title IV3NonfungiblePositionManager
 /// @notice Wraps PancakeSwap V3 positions in a non-fungible token interface which allows for them to be transferred
 /// and authorized. Copying from PancakeSwap-V3
 /// https://github.com/pancakeswap/pancake-v3-contracts/blob/main/projects/v3-periphery/contracts/interfaces/INonfungiblePositionManager.sol

diff --git a/src/interfaces/external/IWETH9.sol b/src/interfaces/external/IWETH9.sol
@@ -3,7 +3,8 @@ pragma solidity ^0.8.0;
 
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
-/// @title Interface for WETH9
+/// @title IWETH9
+/// @notice Interface for WETH9
 interface IWETH9 is IERC20 {
     /// @notice Deposit ether to get wrapped ether
     function deposit() external payable;