TokenTimelock.sol 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. // SPDX-License-Identifier: MIT
  2. // OpenZeppelin Contracts v4.4.0-rc.0 (token/ERC20/utils/TokenTimelock.sol)
  3. pragma solidity ^0.8.0;
  4. import "./SafeERC20.sol";
  5. /**
  6. * @dev A token holder contract that will allow a beneficiary to extract the
  7. * tokens after a given release time.
  8. *
  9. * Useful for simple vesting schedules like "advisors get all of their tokens
  10. * after 1 year".
  11. */
  12. contract TokenTimelock {
  13. using SafeERC20 for IERC20;
  14. // ERC20 basic token contract being held
  15. IERC20 private immutable _token;
  16. // beneficiary of tokens after they are released
  17. address private immutable _beneficiary;
  18. // timestamp when token release is enabled
  19. uint256 private immutable _releaseTime;
  20. constructor(
  21. IERC20 token_,
  22. address beneficiary_,
  23. uint256 releaseTime_
  24. ) {
  25. require(releaseTime_ > block.timestamp, "TokenTimelock: release time is before current time");
  26. _token = token_;
  27. _beneficiary = beneficiary_;
  28. _releaseTime = releaseTime_;
  29. }
  30. /**
  31. * @return the token being held.
  32. */
  33. function token() public view virtual returns (IERC20) {
  34. return _token;
  35. }
  36. /**
  37. * @return the beneficiary of the tokens.
  38. */
  39. function beneficiary() public view virtual returns (address) {
  40. return _beneficiary;
  41. }
  42. /**
  43. * @return the time when the tokens are released.
  44. */
  45. function releaseTime() public view virtual returns (uint256) {
  46. return _releaseTime;
  47. }
  48. /**
  49. * @notice Transfers tokens held by timelock to beneficiary.
  50. */
  51. function release() public virtual {
  52. require(block.timestamp >= releaseTime(), "TokenTimelock: current time is before release time");
  53. uint256 amount = token().balanceOf(address(this));
  54. require(amount > 0, "TokenTimelock: no tokens to release");
  55. token().safeTransfer(beneficiary(), amount);
  56. }
  57. }