Bips library (#367)

* update core and add bips library

* format

* tests

* format again

.forge-snapshots/PositionManager_burn_nonEmpty_native_withClose.snap

@@ -1 +1 @@
-125574
+125584

.forge-snapshots/PositionManager_burn_nonEmpty_native_withTakePair.snap

@@ -1 +1 @@
-125021
+125031

.forge-snapshots/PositionManager_burn_nonEmpty_withClose.snap

@@ -1 +1 @@
-132427
+132446

.forge-snapshots/PositionManager_burn_nonEmpty_withTakePair.snap

@@ -1 +1 @@
-131874
+131893

.forge-snapshots/PositionManager_collect_native.snap

@@ -1 +1 @@
-146282
+146294

.forge-snapshots/PositionManager_collect_sameRange.snap

@@ -1 +1 @@
-154848
+154872

.forge-snapshots/PositionManager_collect_withClose.snap

@@ -1 +1 @@
-154848
+154872

.forge-snapshots/PositionManager_collect_withTakePair.snap

@@ -1 +1 @@
-154169
+154193

.forge-snapshots/PositionManager_decreaseLiquidity_native.snap

@@ -1 +1 @@
-111971
+111980

.forge-snapshots/PositionManager_decreaseLiquidity_withClose.snap

@@ -1 +1 @@
-119729
+119753

.forge-snapshots/PositionManager_decreaseLiquidity_withTakePair.snap

@@ -1 +1 @@
-119050
+119074

.forge-snapshots/PositionManager_decrease_burnEmpty.snap

@@ -1 +1 @@
-135224
+135243

.forge-snapshots/PositionManager_decrease_burnEmpty_native.snap

@@ -1 +1 @@
-128371
+128380

.forge-snapshots/PositionManager_decrease_sameRange_allLiquidity.snap

@@ -1 +1 @@
-132416
+132440

.forge-snapshots/PositionManager_decrease_take_take.snap

@@ -1 +1 @@
-120305
+120329

.forge-snapshots/PositionManager_increaseLiquidity_erc20_withClose.snap

@@ -1 +1 @@
-159033
+159057

.forge-snapshots/PositionManager_increaseLiquidity_erc20_withSettlePair.snap

@@ -1 +1 @@
-157973
+157997

.forge-snapshots/PositionManager_increaseLiquidity_native.snap

@@ -1 +1 @@
-140860
+140872

.forge-snapshots/PositionManager_increase_autocompoundExcessFeesCredit.snap

@@ -1 +1 @@
-177340
+177364

.forge-snapshots/PositionManager_increase_autocompound_clearExcess.snap

@@ -1 +1 @@
-148016
+148040

.forge-snapshots/PositionManager_mint_native.snap

@@ -1 +1 @@
-364721
+364745

.forge-snapshots/PositionManager_mint_nativeWithSweep_withClose.snap

@@ -1 +1 @@
-373244
+373268

.forge-snapshots/PositionManager_mint_nativeWithSweep_withSettlePair.snap

@@ -1 +1 @@
-372467
+372491

.forge-snapshots/PositionManager_mint_onSameTickLower.snap

@@ -1 +1 @@
-317569
+317617

.forge-snapshots/PositionManager_mint_onSameTickUpper.snap

@@ -1 +1 @@
-318239
+318287

.forge-snapshots/PositionManager_mint_sameRange.snap

@@ -1 +1 @@
-243808
+243856

.forge-snapshots/PositionManager_mint_settleWithBalance_sweep.snap

@@ -1 +1 @@
-418988
+419060

.forge-snapshots/PositionManager_mint_warmedPool_differentRange.snap

@@ -1 +1 @@
-323600
+323648

.forge-snapshots/PositionManager_mint_withClose.snap

@@ -1 +1 @@
-420122
+420170

.forge-snapshots/PositionManager_mint_withSettlePair.snap

@@ -1 +1 @@
-419180
+419228

.forge-snapshots/PositionManager_multicall_initialize_mint.snap

@@ -1 +1 @@
-463927
+455975

.forge-snapshots/PositionManager_permit_twice.snap

@@ -1 +1 @@
-44876
+44852

src/V4Router.sol

@@ -7,7 +7,6 @@ import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
 import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
 import {TickMath} from "@uniswap/v4-core/src/libraries/TickMath.sol";
 import {SafeCast} from "@uniswap/v4-core/src/libraries/SafeCast.sol";
-import {BipsLibrary} from "@uniswap/v4-core/src/libraries/BipsLibrary.sol";
 
 import {PathKey, PathKeyLibrary} from "./libraries/PathKey.sol";
 import {CalldataDecoder} from "./libraries/CalldataDecoder.sol";
@@ -16,6 +15,7 @@ import {BaseActionsRouter} from "./base/BaseActionsRouter.sol";
 import {DeltaResolver} from "./base/DeltaResolver.sol";
 import {Actions} from "./libraries/Actions.sol";
 import {ActionConstants} from "./libraries/ActionConstants.sol";
+import {BipsLibrary} from "./libraries/BipsLibrary.sol";
 
 /// @title UniswapV4Router
 /// @notice Abstract contract that contains all internal logic needed for routing through Uniswap v4 pools

src/libraries/BipsLibrary.sol

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+pragma solidity ^0.8.0;
+
+/// @title For calculating a percentage of an amount, using bips
+library BipsLibrary {
+    uint256 internal constant BPS_DENOMINATOR = 10_000;
+
+    /// @notice emitted when an invalid percentage is provided
+    error InvalidBips();
+
+    /// @param amount The total amount to calculate a percentage of
+    /// @param bips The percentage to calculate, in bips
+    function calculatePortion(uint256 amount, uint256 bips) internal pure returns (uint256) {
+        if (bips > BPS_DENOMINATOR) revert InvalidBips();
+        return (amount * bips) / BPS_DENOMINATOR;
+    }
+}

test/libraries/BipsLibrary.t.sol

@@ -0,0 +1,51 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.24;
+
+import "forge-std/Test.sol";
+import {BipsLibrary} from "../../src/libraries/BipsLibrary.sol";
+
+contract BipsLibraryTest is Test {
+    using BipsLibrary for uint256;
+
+    // The block gas limit set in foundry config is 300_000_000 (300M) for testing purposes
+    uint256 BLOCK_GAS_LIMIT;
+
+    function setUp() public {
+        BLOCK_GAS_LIMIT = block.gaslimit;
+    }
+
+    function test_fuzz_calculatePortion(uint256 amount, uint256 bips) public {
+        amount = bound(amount, 0, uint256(type(uint128).max));
+        if (bips > BipsLibrary.BPS_DENOMINATOR) {
+            vm.expectRevert(BipsLibrary.InvalidBips.selector);
+            amount.calculatePortion(bips);
+        } else {
+            assertEq(amount.calculatePortion(bips), amount * bips / BipsLibrary.BPS_DENOMINATOR);
+        }
+    }
+
+    function test_fuzz_gasLimit(uint256 bips) public {
+        if (bips > BipsLibrary.BPS_DENOMINATOR) {
+            vm.expectRevert(BipsLibrary.InvalidBips.selector);
+            block.gaslimit.calculatePortion(bips);
+        } else {
+            assertEq(block.gaslimit.calculatePortion(bips), BLOCK_GAS_LIMIT * bips / BipsLibrary.BPS_DENOMINATOR);
+        }
+    }
+
+    function test_gasLimit_100_percent() public view {
+        assertEq(block.gaslimit, block.gaslimit.calculatePortion(10_000));
+    }
+
+    function test_gasLimit_1_percent() public view {
+        // 100 bps = 1%
+        // 1% of 30M is 300K
+        assertEq(BLOCK_GAS_LIMIT / 100, block.gaslimit.calculatePortion(100));
+    }
+
+    function test_gasLimit_1BP() public view {
+        // 1bp is 0.01%
+        // 0.01% of 30M is 300
+        assertEq(BLOCK_GAS_LIMIT / 10000, block.gaslimit.calculatePortion(1));
+    }
+}

test/router/Payments.t.sol

@@ -3,13 +3,13 @@ pragma solidity ^0.8.19;
 
 import {GasSnapshot} from "forge-gas-snapshot/GasSnapshot.sol";
 import {Currency, CurrencyLibrary} from "@uniswap/v4-core/src/types/Currency.sol";
-import {BipsLibrary} from "@uniswap/v4-core/src/libraries/BipsLibrary.sol";
 
 import {IV4Router} from "../../src/interfaces/IV4Router.sol";
 import {RoutingTestHelpers} from "../shared/RoutingTestHelpers.sol";
 import {Plan, Planner} from "../shared/Planner.sol";
 import {Actions} from "../../src/libraries/Actions.sol";
 import {ActionConstants} from "../../src/libraries/ActionConstants.sol";
+import {BipsLibrary} from "../../src/libraries/BipsLibrary.sol";
 
 contract PaymentsTests is RoutingTestHelpers, GasSnapshot {
     using CurrencyLibrary for Currency;