TokenTimelock.sol 1.8 KB

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