test: vesting tests

Author: PavelNaydanov

.gitignore

@@ -12,3 +12,6 @@ docs/
 
 # Dotenv file
 .env
+
+# Test coverage
+lcov.info

README.md

@@ -1,3 +1,5 @@
+// TODO: Уточнить, что не подходит для реализации вестинга ребейз токенов
+
 ## Foundry
 
 **Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**

src/tokenDistribution/MetaTokenDistributor.sol

@@ -43,10 +43,12 @@ contract MetaTokenDistributor is IMetaTokenDistributor {
     }
 
     function startVesting(VestingType vestingType) external returns (address vesting) {
+        // TODO: механизм, который позволит создавать вестинг для каждого типа единожды
         if (block.timestamp < _vestingStartTime) {
             revert VestingStartTimeHasNotArrived();
         }
 
+        // TODO: Может быть клонировано с Clones.cloneWithImmutableArgs
         vesting = Clones.clone(_vestingImpl);
 
         // TODO: Можно две функции объединить
@@ -58,6 +60,7 @@ contract MetaTokenDistributor is IMetaTokenDistributor {
         (uint256 vestingAmount,,,,) = _vestingParams.getVestingParams(vestingType);
 
         _META.safeTransfer(address(vesting), vestingAmount);
+
         IVesting(vesting).initialize(_META, schedule, beneficiaries);
 
         emit VestingStarted(vesting);

src/tokenDistribution/vesting/Vesting.sol

@@ -7,8 +7,6 @@ import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.s
 import {IVesting} from "./interfaces/IVesting.sol";
 import {Schedule, Period, Beneficiary} from "../utils/Common.sol";
 
-// TODO: Проверить отчет на предмет замечаний
-
 /**
  * @title Vesting contract of the base token
  * @dev Each new vesting instance is created through a factory using the Minimal Clones pattern.
@@ -64,13 +62,8 @@ contract Vesting is IVesting, Initializable {
      * @dev The claimed amount will be store in _released mapping
      */
     function claim() external {
-        Schedule memory schedule = _schedule;
-
-        if (block.timestamp < schedule.startTime) {
-            revert VestingHasNotStarted();
-        }
-
         uint256 unlockedAmount = availableToClaim(msg.sender);
+
         if (unlockedAmount > 0) {
             _released[msg.sender] += unlockedAmount;
             _baseToken.safeTransfer(msg.sender, unlockedAmount);
@@ -98,6 +91,9 @@ contract Vesting is IVesting, Initializable {
 
     /// @notice Returns the total amount of locked tokens
     function totalLocked() external view returns (uint256) {
+        // TODO: заменить на
+        // uint256 initialTotalLocked = _initialTotalLocked;
+        // return initialTotalLocked - _computeUnlocked(initialTotalLocked);
         return _initialTotalLocked - totalUnlocked();
     }
 
@@ -108,6 +104,9 @@ contract Vesting is IVesting, Initializable {
 
     /// @notice Returns the amount of locked tokens for a specific account
     function lockedOf(address account) external view returns (uint256) {
+        // TODO: заменить на
+        // uint256 initialLocked = _initialLocked[account];
+        // return initialLocked - _computeUnlocked(initialLocked);
         return _initialLocked[account] - unlockedOf(account);
     }
 
@@ -191,6 +190,7 @@ contract Vesting is IVesting, Initializable {
             }
 
             _initialLocked[beneficiary.account] = beneficiary.amount;
+            // TODO: переделать на чтение из memory и последующая запись в storage
             _initialTotalLocked += beneficiary.amount;
         }
 
@@ -207,6 +207,7 @@ contract Vesting is IVesting, Initializable {
      * @return unlockedAmount The total amount of unlocked tokens
      */
     function _computeUnlocked(uint256 initialLockedAmount) private view returns (uint256 unlockedAmount) {
+        // TODO: добавить _schedule в memory
         if (block.timestamp < _schedule.startTime) {
             return 0;
         }

src/tokenDistribution/vesting/interfaces/IVesting.sol

@@ -33,9 +33,6 @@ interface IVesting {
     /// @dev Each new end period time must be greater then prev
     error IncorrectPeriodTime();
 
-    /// @dev Not available if vesting has not been started
-    error VestingHasNotStarted();
-
     /// @dev Emitted when vesting schedule params has been initialized
     event ScheduleInitialized(Schedule schedule);
 

test/MetaToken.t.sol

@@ -28,4 +28,15 @@ contract MetaTokenTest is Test {
 
         assertEq(META.balanceOf(distributor), expectedTotalSupply);
     }
+
+    function test_transfer() external {
+        address recipient = makeAddr("recipient");
+        uint256 totalSupply = META.totalSupply();
+
+        vm.prank(distributor);
+        META.transfer(recipient, totalSupply);
+
+        assertEq(META.balanceOf(recipient), META.totalSupply());
+        assertEq(META.balanceOf(distributor), 0);
+    }
 }