test: maximum number of beneficiaries

Author: PavelNaydanov

README.md

@@ -66,3 +66,18 @@ $ forge --help
 $ anvil --help
 $ cast --help
 ```
+
+### Maximum number of beneficiaries
+
+The list of beneficiaries is determined at the moment of deploying the smart contract [VestingParams.sol](./src/tokenDistribution/vesting/VestingParams.sol) in the constructor. Therefore, it is important to understand the maximum number of beneficiaries that can be set in this way without exceeding the block gas limit.
+
+As of 2025, the block gas limit in the Ethereum network is 36 million. In the Arbitrum network, it is significantly higher, but according to the documentation, the practical working limit is 32 million.
+
+To determine the actual gas consumption, you can refer to the load test [MaxBeneficiaries.t.sol](./test/tokenDistribution/vesting/loadTests/MaxBeneficiaries.t.sol). Run the test with gas profiling using `forge test -vvv --mt test_deploy_moreBeneficiaries --gas-report`.
+
+The resulting table shows that for 401 beneficiaries, `19_448_973` gas will be consumed, which is optimal and will occupy approximately half of the block gas limit in Ethereum.
+
+![](./images/maxBeneficiariesLimit.png)
+
+Important! For deployment on other networks, it is necessary to check the documentation and review the block and transaction gas limits.
+

images/maxBeneficiariesLimit.png

@@ -27,7 +27,6 @@ contract VestingParams is IVestingParams {
         Beneficiary[] memory teamBeneficiaries,
         Beneficiary[] memory liquidityBeneficiaries
     ) {
-        // TODO: протестировать сколько можно запихать бенефициаров
         _validateAndStoreBeneficiaries(VestingType.TEAM, teamBeneficiaries, TEAM_TOTAL_AMOUNT);
         _validateAndStoreBeneficiaries(VestingType.LIQUIDITY, liquidityBeneficiaries, LIQUIDITY_TOTAL_AMOUNT);
     }

src/tokenDistribution/vesting/VestingParams.sol

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity 0.8.28;
+
+import {Test, console} from "forge-std/Test.sol";
+
+import {VestingParams, IVestingParams} from "src/tokenDistribution/vesting/VestingParams.sol";
+import {Beneficiary, VestingType, Schedule} from "src/tokenDistribution/utils/Common.sol";
+
+contract MaxBeneficiariesTest is Test {
+    VestingParams vestingParams;
+
+    /// @dev Deployment cost of 401 beneficiaries is equal 19_448_973 (≈ half a block gas limit)
+    /// Checked with the command:
+    /// `forge test -vvv --mt test_deploy_moreBeneficiaries --gas-report`
+    function test_maxBeneficiaries() external {
+        // Stage 0. Create liquidity beneficiaries
+        uint256 liquidityTotalAmount = 287_500_000e18; // equal vestingParams.LIQUIDITY_TOTAL_AMOUNT()
+        Beneficiary[] memory liquidityBeneficiaries = new Beneficiary[](1); // min number of beneficiary
+        liquidityBeneficiaries[0] = Beneficiary({
+            account: makeAddr("liquidityBeneficiary"),
+            amount: liquidityTotalAmount
+        });
+
+        // Stage 1. Create team beneficiary. Simulate 400 beneficiaries
+        uint256 teamBeneficiariesCount = 400;
+        uint256 teamTotalAmount = 100_000_000e18; // equal vestingParams.TEAM_TOTAL_AMOUNT()
+
+        Beneficiary[] memory teamBeneficiaries = new Beneficiary[](teamBeneficiariesCount);
+
+        for (uint256 i = 0; i < teamBeneficiariesCount; i++) {
+            teamBeneficiaries[i] = Beneficiary({
+                account: vm.addr(uint256(keccak256(abi.encodePacked("OneOfBeneficiary", i)))),
+                amount: teamTotalAmount / teamBeneficiariesCount
+            });
+        }
+
+        // Stage 2. Deploy VestingParams
+        vestingParams = new VestingParams(teamBeneficiaries, liquidityBeneficiaries);
+
+        assertEq(vestingParams.getBeneficiaries(VestingType.TEAM).length, teamBeneficiariesCount);
+    }
+}