Internal audit1 (#15)

* refactor: [internal-s1] delete subscriber before notifyUnsubscribe * refactor: [internal-s2] replace encodeWithSelector with encodeCall * refactor: [internal-s3] code styles * feat: [internal-s4] support revoke nonce * chore: add missing
pancakeswap · Sep 9, 2024 · 5bc5fb5 · 5bc5fb5
1 parent d4ad2d2
commit 5bc5fb5
Show file tree

Hide file tree

Showing 71 changed files with 150 additions and 91 deletions.
diff --git a/.forge-snapshots/BinPositionManager_NativeTokenTest#test_addLiquidity.snap b/.forge-snapshots/BinPositionManager_NativeTokenTest#test_addLiquidity.snap
@@ -1 +1 @@
-867056
+867055
diff --git a/.forge-snapshots/CLMigratorFromPancakeswapV2Test#testCLMigrateFromV2IncludingInit.snap b/.forge-snapshots/CLMigratorFromPancakeswapV2Test#testCLMigrateFromV2IncludingInit.snap
@@ -1 +1 @@
-795924
+795990
diff --git a/.forge-snapshots/CLMigratorFromPancakeswapV2Test#testCLMigrateFromV2WithoutInit.snap b/.forge-snapshots/CLMigratorFromPancakeswapV2Test#testCLMigrateFromV2WithoutInit.snap
@@ -1 +1 @@
-680323
+680367
diff --git a/.forge-snapshots/CLMigratorFromPancakeswapV2Test#testCLMigrateFromV2WithoutNativeToken.snap b/.forge-snapshots/CLMigratorFromPancakeswapV2Test#testCLMigrateFromV2WithoutNativeToken.snap
@@ -1 +1 @@
-752123
+752167
diff --git a/.forge-snapshots/CLMigratorFromPancakeswapV3Test#testCLMigrateFromV3IncludingInit.snap b/.forge-snapshots/CLMigratorFromPancakeswapV3Test#testCLMigrateFromV3IncludingInit.snap
@@ -1 +1 @@
-846293
+846359
diff --git a/.forge-snapshots/CLMigratorFromPancakeswapV3Test#testCLMigrateFromV3WithoutInit.snap b/.forge-snapshots/CLMigratorFromPancakeswapV3Test#testCLMigrateFromV3WithoutInit.snap
@@ -1 +1 @@
-733247
+733291
diff --git a/.forge-snapshots/CLMigratorFromPancakeswapV3Test#testCLMigrateFromV3WithoutNativeToken.snap b/.forge-snapshots/CLMigratorFromPancakeswapV3Test#testCLMigrateFromV3WithoutNativeToken.snap
@@ -1 +1 @@
-802534
+802578
diff --git a/.forge-snapshots/CLMigratorFromUniswapV2Test#testCLMigrateFromV2IncludingInit.snap b/.forge-snapshots/CLMigratorFromUniswapV2Test#testCLMigrateFromV2IncludingInit.snap
@@ -1 +1 @@
-795936
+796002
diff --git a/.forge-snapshots/CLMigratorFromUniswapV2Test#testCLMigrateFromV2WithoutInit.snap b/.forge-snapshots/CLMigratorFromUniswapV2Test#testCLMigrateFromV2WithoutInit.snap
@@ -1 +1 @@
-680335
+680379
diff --git a/.forge-snapshots/CLMigratorFromUniswapV2Test#testCLMigrateFromV2WithoutNativeToken.snap b/.forge-snapshots/CLMigratorFromUniswapV2Test#testCLMigrateFromV2WithoutNativeToken.snap
@@ -1 +1 @@
-752123
+752167
diff --git a/.forge-snapshots/CLMigratorFromUniswapV3Test#testCLMigrateFromV3IncludingInit.snap b/.forge-snapshots/CLMigratorFromUniswapV3Test#testCLMigrateFromV3IncludingInit.snap
@@ -1 +1 @@
-844275
+844341
diff --git a/.forge-snapshots/CLMigratorFromUniswapV3Test#testCLMigrateFromV3WithoutInit.snap b/.forge-snapshots/CLMigratorFromUniswapV3Test#testCLMigrateFromV3WithoutInit.snap
@@ -1 +1 @@
-731229
+731273
diff --git a/.forge-snapshots/CLMigratorFromUniswapV3Test#testCLMigrateFromV3WithoutNativeToken.snap b/.forge-snapshots/CLMigratorFromUniswapV3Test#testCLMigrateFromV3WithoutNativeToken.snap
@@ -1 +1 @@
-800516
+800560
diff --git a/.forge-snapshots/CLPositionManager_burn_empty.snap b/.forge-snapshots/CLPositionManager_burn_empty.snap
@@ -1 +1 @@
-57949
+57984
diff --git a/.forge-snapshots/CLPositionManager_burn_empty_native.snap b/.forge-snapshots/CLPositionManager_burn_empty_native.snap
@@ -1 +1 @@
-57757
+57792
diff --git a/.forge-snapshots/CLPositionManager_burn_nonEmpty_native_withClose.snap b/.forge-snapshots/CLPositionManager_burn_nonEmpty_native_withClose.snap
@@ -1 +1 @@
-177568
+177604
diff --git a/.forge-snapshots/CLPositionManager_burn_nonEmpty_native_withTakePair.snap b/.forge-snapshots/CLPositionManager_burn_nonEmpty_native_withTakePair.snap
@@ -1 +1 @@
-177109
+177144
diff --git a/.forge-snapshots/CLPositionManager_burn_nonEmpty_withClose.snap b/.forge-snapshots/CLPositionManager_burn_nonEmpty_withClose.snap
@@ -1 +1 @@
-184624
+184659
diff --git a/.forge-snapshots/CLPositionManager_burn_nonEmpty_withTakePair.snap b/.forge-snapshots/CLPositionManager_burn_nonEmpty_withTakePair.snap
@@ -1 +1 @@
-184164
+184200
diff --git a/.forge-snapshots/CLPositionManager_collect_native.snap b/.forge-snapshots/CLPositionManager_collect_native.snap
@@ -1 +1 @@
-200166
+200210
diff --git a/.forge-snapshots/CLPositionManager_collect_sameRange.snap b/.forge-snapshots/CLPositionManager_collect_sameRange.snap
@@ -1 +1 @@
-208985
+209029
diff --git a/.forge-snapshots/CLPositionManager_collect_withClose.snap b/.forge-snapshots/CLPositionManager_collect_withClose.snap
@@ -1 +1 @@
-208985
+209029
diff --git a/.forge-snapshots/CLPositionManager_collect_withTakePair.snap b/.forge-snapshots/CLPositionManager_collect_withTakePair.snap
@@ -1 +1 @@
-208423
+208467
diff --git a/.forge-snapshots/CLPositionManager_decreaseLiquidity_native.snap b/.forge-snapshots/CLPositionManager_decreaseLiquidity_native.snap
@@ -1 +1 @@
-165242
+165286
diff --git a/.forge-snapshots/CLPositionManager_decreaseLiquidity_withClose.snap b/.forge-snapshots/CLPositionManager_decreaseLiquidity_withClose.snap
@@ -1 +1 @@
-174061
+174105
diff --git a/.forge-snapshots/CLPositionManager_decreaseLiquidity_withTakePair.snap b/.forge-snapshots/CLPositionManager_decreaseLiquidity_withTakePair.snap
@@ -1 +1 @@
-173499
+173543
diff --git a/.forge-snapshots/CLPositionManager_decrease_burnEmpty.snap b/.forge-snapshots/CLPositionManager_decrease_burnEmpty.snap
@@ -1 +1 @@
-189024
+189060
diff --git a/.forge-snapshots/CLPositionManager_decrease_burnEmpty_native.snap b/.forge-snapshots/CLPositionManager_decrease_burnEmpty_native.snap
@@ -1 +1 @@
-181777
+181812
diff --git a/.forge-snapshots/CLPositionManager_decrease_sameRange_allLiquidity.snap b/.forge-snapshots/CLPositionManager_decrease_sameRange_allLiquidity.snap
@@ -1 +1 @@
-186730
+186774
diff --git a/.forge-snapshots/CLPositionManager_decrease_take_take.snap b/.forge-snapshots/CLPositionManager_decrease_take_take.snap
@@ -1 +1 @@
-174678
+174722
diff --git a/.forge-snapshots/CLPositionManager_increaseLiquidity_erc20_withClose.snap b/.forge-snapshots/CLPositionManager_increaseLiquidity_erc20_withClose.snap
@@ -1 +1 @@
-213500
+213544
diff --git a/.forge-snapshots/CLPositionManager_increaseLiquidity_erc20_withSettlePair.snap b/.forge-snapshots/CLPositionManager_increaseLiquidity_erc20_withSettlePair.snap
@@ -1 +1 @@
-212560
+212604
diff --git a/.forge-snapshots/CLPositionManager_increaseLiquidity_native.snap b/.forge-snapshots/CLPositionManager_increaseLiquidity_native.snap
@@ -1 +1 @@
-195082
+195126
diff --git a/.forge-snapshots/CLPositionManager_increase_autocompoundExactUnclaimedFees.snap b/.forge-snapshots/CLPositionManager_increase_autocompoundExactUnclaimedFees.snap
@@ -1 +1 @@
-158398
+158442
diff --git a/.forge-snapshots/CLPositionManager_increase_autocompoundExcessFeesCredit.snap b/.forge-snapshots/CLPositionManager_increase_autocompoundExcessFeesCredit.snap
@@ -1 +1 @@
-231569
+231613
diff --git a/.forge-snapshots/CLPositionManager_increase_autocompound_clearExcess.snap b/.forge-snapshots/CLPositionManager_increase_autocompound_clearExcess.snap
@@ -1 +1 @@
-202405
+202449
diff --git a/.forge-snapshots/CLPositionManager_mint_native.snap b/.forge-snapshots/CLPositionManager_mint_native.snap
@@ -1 +1 @@
-587542
+587586
diff --git a/.forge-snapshots/CLPositionManager_mint_nativeWithSweep_withClose.snap b/.forge-snapshots/CLPositionManager_mint_nativeWithSweep_withClose.snap
@@ -1 +1 @@
-596018
+596062
diff --git a/.forge-snapshots/CLPositionManager_mint_nativeWithSweep_withSettlePair.snap b/.forge-snapshots/CLPositionManager_mint_nativeWithSweep_withSettlePair.snap
@@ -1 +1 @@
-595362
+595406
diff --git a/.forge-snapshots/CLPositionManager_mint_onSameTickLower.snap b/.forge-snapshots/CLPositionManager_mint_onSameTickLower.snap
@@ -1 +1 @@
-442411
+442455
diff --git a/.forge-snapshots/CLPositionManager_mint_onSameTickUpper.snap b/.forge-snapshots/CLPositionManager_mint_onSameTickUpper.snap
@@ -1 +1 @@
-442848
+442892
diff --git a/.forge-snapshots/CLPositionManager_mint_sameRange.snap b/.forge-snapshots/CLPositionManager_mint_sameRange.snap
@@ -1 +1 @@
-351658
+351702
diff --git a/.forge-snapshots/CLPositionManager_mint_settleWithBalance_sweep.snap b/.forge-snapshots/CLPositionManager_mint_settleWithBalance_sweep.snap
@@ -1 +1 @@
-641844
+641888
diff --git a/.forge-snapshots/CLPositionManager_mint_warmedPool_differentRange.snap b/.forge-snapshots/CLPositionManager_mint_warmedPool_differentRange.snap
@@ -1 +1 @@
-448101
+448145
diff --git a/.forge-snapshots/CLPositionManager_mint_withClose.snap b/.forge-snapshots/CLPositionManager_mint_withClose.snap
@@ -1 +1 @@
-642960
+643004
diff --git a/.forge-snapshots/CLPositionManager_mint_withSettlePair.snap b/.forge-snapshots/CLPositionManager_mint_withSettlePair.snap
@@ -1 +1 @@
-642162
+642206
diff --git a/.forge-snapshots/CLPositionManager_multicall_initialize_mint.snap b/.forge-snapshots/CLPositionManager_multicall_initialize_mint.snap
@@ -1 +1 @@
-702482
+702570
diff --git a/.forge-snapshots/CLPositionManager_permit.snap b/.forge-snapshots/CLPositionManager_permit.snap
@@ -1 +1 @@
-79188
+79210
diff --git a/.forge-snapshots/CLPositionManager_permit_secondPosition.snap b/.forge-snapshots/CLPositionManager_permit_secondPosition.snap
@@ -1 +1 @@
-62088
+62110
diff --git a/.forge-snapshots/CLPositionManager_permit_twice.snap b/.forge-snapshots/CLPositionManager_permit_twice.snap
@@ -1 +1 @@
-44988
+45010
diff --git a/src/V4Router.sol b/src/V4Router.sol
@@ -6,7 +6,7 @@ import {ICLPoolManager} from "pancake-v4-core/src/pool-cl/interfaces/ICLPoolMana
 import {IBinPoolManager} from "pancake-v4-core/src/pool-bin/interfaces/IBinPoolManager.sol";
 import {BalanceDelta} from "pancake-v4-core/src/types/BalanceDelta.sol";
 import {PoolKey} from "pancake-v4-core/src/types/PoolKey.sol";
-import {Currency, CurrencyLibrary} from "pancake-v4-core/src/types/Currency.sol";
+import {Currency} from "pancake-v4-core/src/types/Currency.sol";
 import {BipsLibrary} from "./libraries/BipsLibrary.sol";
 import {CalldataDecoder} from "./libraries/CalldataDecoder.sol";
 import {IV4Router} from "./interfaces/IV4Router.sol";

diff --git a/src/base/BaseActionsRouter.sol b/src/base/BaseActionsRouter.sol
@@ -4,7 +4,6 @@ pragma solidity ^0.8.24;
 import {IVault} from "pancake-v4-core/src/interfaces/IVault.sol";
 import {SafeCallback} from "./SafeCallback.sol";
 import {CalldataDecoder} from "../libraries/CalldataDecoder.sol";
-import {Actions} from "../libraries/Actions.sol";
 import {ActionConstants} from "../libraries/ActionConstants.sol";
 
 /// @notice Abstract contract for performing a combination of actions on Pancakeswap v4.

diff --git a/src/base/DeltaResolver.sol b/src/base/DeltaResolver.sol
@@ -2,7 +2,6 @@
 pragma solidity ^0.8.24;
 
 import {Currency} from "pancake-v4-core/src/types/Currency.sol";
-import {IVault} from "pancake-v4-core/src/interfaces/IVault.sol";
 import {ImmutableState} from "./ImmutableState.sol";
 import {ActionConstants} from "../libraries/ActionConstants.sol";
 

diff --git a/src/interfaces/IPositionManager.sol b/src/interfaces/IPositionManager.sol
@@ -1,9 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.24;
 
-import {PoolKey} from "pancake-v4-core/src/types/PoolKey.sol";
-import {Currency} from "pancake-v4-core/src/types/Currency.sol";
-
 interface IPositionManager {
     error DeadlinePassed();
     error InvalidTokenID();

diff --git a/src/libraries/CalldataDecoder.sol b/src/libraries/CalldataDecoder.sol
@@ -12,7 +12,7 @@ library CalldataDecoder {
     /// @notice equivalent to SliceOutOfBounds.selector
     bytes4 constant SLICE_ERROR_SELECTOR = 0x3b99b53d;
 
-    /// @dev equivalent to: abi.decode(params, (uint256[], bytes[])) in calldata
+    /// @dev equivalent to: abi.decode(params, (bytes, bytes[])) in calldata
     function decodeActionsRouterParams(bytes calldata _bytes)
         internal
         pure

diff --git a/src/pool-bin/interfaces/IBinQuoter.sol b/src/pool-bin/interfaces/IBinQuoter.sol
@@ -42,7 +42,7 @@ interface IBinQuoter is IQuoter {
     /// hookData arbitrary hookData to pass into the associated hooks
     /// @return deltaAmounts Delta amounts resulted from the swap
     /// @return activeIdAfter The activeId of the pool after the swap
-    function quoteExactInputSingle(QuoteExactSingleParams calldata params)
+    function quoteExactInputSingle(QuoteExactSingleParams memory params)
         external
         returns (int128[] memory deltaAmounts, uint24 activeIdAfter);
 
@@ -65,7 +65,7 @@ interface IBinQuoter is IQuoter {
     /// hookData arbitrary hookData to pass into the associated hooks
     /// @return deltaAmounts Delta amounts resulted from the swap
     /// @return activeIdAfter The activeId of the pool after the swap
-    function quoteExactOutputSingle(QuoteExactSingleParams calldata params)
+    function quoteExactOutputSingle(QuoteExactSingleParams memory params)
         external
         returns (int128[] memory deltaAmounts, uint24 activeIdAfter);
 

diff --git a/src/pool-bin/lens/BinQuoter.sol b/src/pool-bin/lens/BinQuoter.sol
@@ -35,7 +35,7 @@ contract BinQuoter is Quoter, IBinQuoter {
         override
         returns (int128[] memory deltaAmounts, uint24 activeIdAfter)
     {
-        try vault.lock(abi.encodeWithSelector(this._quoteExactInputSingle.selector, params)) {}
+        try vault.lock(abi.encodeCall(this._quoteExactInputSingle, (params))) {}
         catch (bytes memory reason) {
             return _handleRevertSingle(reason);
         }
@@ -47,7 +47,7 @@ contract BinQuoter is Quoter, IBinQuoter {
         override
         returns (int128[] memory deltaAmounts, uint24[] memory activeIdAfterList)
     {
-        try vault.lock(abi.encodeWithSelector(this._quoteExactInput.selector, params)) {}
+        try vault.lock(abi.encodeCall(this._quoteExactInput, (params))) {}
         catch (bytes memory reason) {
             return _handleRevert(reason);
         }
@@ -59,7 +59,7 @@ contract BinQuoter is Quoter, IBinQuoter {
         override
         returns (int128[] memory deltaAmounts, uint24 activeIdAfter)
     {
-        try vault.lock(abi.encodeWithSelector(this._quoteExactOutputSingle.selector, params)) {}
+        try vault.lock(abi.encodeCall(this._quoteExactOutputSingle, (params))) {}
         catch (bytes memory reason) {
             delete amountOutCached;
             return _handleRevertSingle(reason);
@@ -72,7 +72,7 @@ contract BinQuoter is Quoter, IBinQuoter {
         override
         returns (int128[] memory deltaAmounts, uint24[] memory activeIdAfterList)
     {
-        try vault.lock(abi.encodeWithSelector(this._quoteExactOutput.selector, params)) {}
+        try vault.lock(abi.encodeCall(this._quoteExactOutput, (params))) {}
         catch (bytes memory reason) {
             return _handleRevert(reason);
         }

diff --git a/src/pool-cl/CLPositionManager.sol b/src/pool-cl/CLPositionManager.sol
@@ -51,6 +51,7 @@ contract CLPositionManager is
 
     ICLPoolManager public immutable override clPoolManager;
 
+    /// @inheritdoc ICLPositionManager
     /// @dev The ID of the next token that will be minted. Skips 0
     uint256 public nextTokenId = 1;
 
@@ -165,6 +166,7 @@ contract CLPositionManager is
         _executeActionsWithoutLock(actions, params);
     }
 
+    /// @inheritdoc BaseActionsRouter
     function msgSender() public view override returns (address) {
         return _getLocker();
     }