You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
54 lines
2.0 KiB
54 lines
2.0 KiB
// SPDX-License-Identifier: MIT
|
|
// OpenZeppelin Contracts (last updated v5.1.0) (finance/VestingWalletCliff.sol)
|
|
|
|
pragma solidity ^0.8.20;
|
|
|
|
import {SafeCast} from "../utils/math/SafeCast.sol";
|
|
import {VestingWallet} from "./VestingWallet.sol";
|
|
|
|
/**
|
|
* @dev Extension of {VestingWallet} that adds a cliff to the vesting schedule.
|
|
*
|
|
* _Available since v5.1._
|
|
*/
|
|
abstract contract VestingWalletCliff is VestingWallet {
|
|
using SafeCast for *;
|
|
|
|
uint64 private immutable _cliff;
|
|
|
|
/// @dev The specified cliff duration is larger than the vesting duration.
|
|
error InvalidCliffDuration(uint64 cliffSeconds, uint64 durationSeconds);
|
|
|
|
/**
|
|
* @dev Set the duration of the cliff, in seconds. The cliff starts vesting schedule (see {VestingWallet}'s
|
|
* constructor) and ends `cliffSeconds` later.
|
|
*/
|
|
constructor(uint64 cliffSeconds) {
|
|
if (cliffSeconds > duration()) {
|
|
revert InvalidCliffDuration(cliffSeconds, duration().toUint64());
|
|
}
|
|
_cliff = start().toUint64() + cliffSeconds;
|
|
}
|
|
|
|
/**
|
|
* @dev Getter for the cliff timestamp.
|
|
*/
|
|
function cliff() public view virtual returns (uint256) {
|
|
return _cliff;
|
|
}
|
|
|
|
/**
|
|
* @dev Virtual implementation of the vesting formula. This returns the amount vested, as a function of time, for
|
|
* an asset given its total historical allocation. Returns 0 if the {cliff} timestamp is not met.
|
|
*
|
|
* IMPORTANT: The cliff not only makes the schedule return 0, but it also ignores every possible side
|
|
* effect from calling the inherited implementation (i.e. `super._vestingSchedule`). Carefully consider
|
|
* this caveat if the overridden implementation of this function has any (e.g. writing to memory or reverting).
|
|
*/
|
|
function _vestingSchedule(
|
|
uint256 totalAllocation,
|
|
uint64 timestamp
|
|
) internal view virtual override returns (uint256) {
|
|
return timestamp < cliff() ? 0 : super._vestingSchedule(totalAllocation, timestamp);
|
|
}
|
|
}
|
|
|