// SPDX-License-Identifier: MIT
// File: contracts/Context.sol
pragma solidity ^0.8.0;
/*
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
}
// File: contracts/Ownable.sol
// OpenZeppelin Contracts v4.4.0 (access/Ownable.sol)
pragma solidity ^0.8.0;
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
_;
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
require(newOwner != address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// File: contracts/IERC20.sol
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `recipient`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address recipient, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `sender` to `recipient` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(
address sender,
address recipient,
uint256 amount
) external returns (bool);
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
}
// File: contracts/MultiBeneficiaryLock.sol
pragma solidity ^0.8.0;
/**
* A gas optimized implementation of a vesting contract for tokens according to a predetermined vesting schedule
* for multiple beneficiaries. Beneficiaries can choose how often they invoke release() to receive the unlocked
* tokens. There are several steps to use this contract
* - construction with token address, length of vesting period, and release interval
* - init of the beneficiaries with their respective amounts
* - launch of the contract when the launch date is known and after enough tokens are received.
*/
contract MultiBeneficiaryLock is Ownable {
IERC20 private immutable token;
uint32 private immutable period;
uint32 private immutable interval;
uint256 private start;
uint256 private totalTokens;
struct Balance {
uint256 released;
uint256 total;
}
mapping(address => Balance) private balance;
modifier notLaunched {
require(start == 0, "MBL01");
_;
}
modifier launched {
require(start > 0, "MBL02");
_;
}
/**
* Construct a MultiBeneficiary lock contract that has the specified vesting period in days
* and a release interval in days when new tokens prorata become available.
*/
constructor(IERC20 tokenAddress, uint32 periodDays, uint32 intervalDays) {
require(intervalDays <= periodDays, "MBL03");
token = tokenAddress;
period = periodDays;
interval = intervalDays;
}
/**
* Initialize beneficiaries. Provide the list of beneficiaries for this lock contract and their respective
* balances. Only the owner can call this function.
* As this is a gas intensive method for large arrays, check for duplicate addresses is left out. It is the
* responsibility of the owner to prevent duplicates which can be validated by calling checkInitBeneficiaries upfront.
*/
function initBeneficiaries(address[] calldata addresses,
uint256[] calldata amounts) external onlyOwner notLaunched {
require(totalTokens == 0, "MBL04");
require(addresses.length == amounts.length, "MBL05");
uint256 total = 0;
for (uint256 i=0; i < addresses.length; i++) {
total = total + amounts[i];
balance[addresses[i]] = Balance(0, amounts[i]);
}
totalTokens = total;
}
/**
* Check that the given list of beneficiaries is sane. Gasless check which can be called before initBeneficiaries.
*/
function checkInitBeneficiaries(address[] calldata addresses, uint256[] calldata amounts) external view onlyOwner notLaunched returns (uint256){
require(totalTokens == 0, "MBL04");
require(addresses.length == amounts.length, "MBL05");
uint256 total = 0;
for (uint256 i=0; i < addresses.length; i++) {
total = total + amounts[i];
require(amounts[i] > 0, "MBL06");
for (uint256 j = i + 1; j < addresses.length; j++) {
require(addresses[i] != addresses[j], "MBL07");
}
}
return total;
}
/**
* Return the minium amount of tokens that is required for the contract to be launched
* only relevant after init.
*/
function tokenCountOnLaunch() external view returns (uint256) {
return totalTokens;
}
/**
* Return if all preconditions are met for the lock contract to launch:
* not launched yet, initialized and token balance enough.
*/
function readyForLaunch() external view returns (bool) {
return (start == 0) && (totalTokens > 0) && (token.balanceOf(address(this)) >= totalTokens);
}
/**
* Launch the contract given a start block time as the basis for the vesting period.
* when blocktime reaches startBlocktime, the first interval wait for release starts.
* blocktime in seconds since epoch.
*/
function launch(uint256 startBlocktime) external notLaunched onlyOwner {
require(startBlocktime > 0, "MBL08");
require(totalTokens > 0, "MBL09");
require(token.balanceOf(address(this)) >= totalTokens, "MBL10");
start = startBlocktime;
}
/**
* @return the token being held.
*/
function erc20() external view returns (IERC20) {
return token;
}
/**
* @return number of tokens still locked up for a particular beneficiary
*/
function locked(address holder) external view returns (uint256){
return balance[holder].total - balance[holder].released - amountCanRelease(holder);
}
/**
* @return the amount of tokens that have already been released for a particular beneficiary
*/
function released(address holder) external view returns (uint256){
return balance[holder].released;
}
/**
* @return block.timestamp
*/
function blocktime() internal virtual view returns (uint256){
return block.timestamp;
}
/**
* @return number of days since contract's launchdate
* Only relevant when launched.
*/
function calculateDaysSinceStart() private view returns (uint256){
uint256 ts = blocktime();
if (ts < start) return 0;
return (ts - start) / (1 days);
}
/**
* @return the amount of tokens that can be released to the beneficiary at this time
*/
function amountCanRelease(address holder) public view returns (uint256){
// not launched
if (start == 0) return 0;
Balance memory beneficiaryBalance = balance[holder];
uint256 amount = beneficiaryBalance.total - beneficiaryBalance.released;
if (amount == 0) return 0;
uint256 daysSinceStart = calculateDaysSinceStart();
if (daysSinceStart > period) return amount;
uint256 amountPerDay = beneficiaryBalance.total / period;
uint256 daysStartToLastRelease = beneficiaryBalance.released / amountPerDay;
// starttime to last release date's interval start date
uint256 daysSinceLastRelease = daysSinceStart - daysStartToLastRelease;
if (daysSinceLastRelease < interval) return 0;
return (daysSinceLastRelease / interval * interval) * amountPerDay;
}
/**
* Release all tokens that can be released for a particular beneficiary. Invoker pays the gas.
* Anyone can invoke.
*/
function releaseFor(address holder) public launched {
uint256 amountToRelease = amountCanRelease(holder);
require(amountToRelease > 0);
assert(balance[holder].total - balance[holder].released >= amountToRelease);
balance[holder].released += amountToRelease;
require(token.transfer(holder, amountToRelease), "MBL11");
}
/**
* Release all tokens that can be released for msg.sender.
*/
function release() external {
releaseFor(msg.sender);
}
}
{
"compilationTarget": {
"MultiBeneficiaryLock.sol": "MultiBeneficiaryLock"
},
"evmVersion": "london",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 200
},
"remappings": []
}
[{"inputs":[{"internalType":"contract IERC20","name":"tokenAddress","type":"address"},{"internalType":"uint32","name":"periodDays","type":"uint32"},{"internalType":"uint32","name":"intervalDays","type":"uint32"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"inputs":[{"internalType":"address","name":"holder","type":"address"}],"name":"amountCanRelease","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address[]","name":"addresses","type":"address[]"},{"internalType":"uint256[]","name":"amounts","type":"uint256[]"}],"name":"checkInitBeneficiaries","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"erc20","outputs":[{"internalType":"contract IERC20","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address[]","name":"addresses","type":"address[]"},{"internalType":"uint256[]","name":"amounts","type":"uint256[]"}],"name":"initBeneficiaries","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"startBlocktime","type":"uint256"}],"name":"launch","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"holder","type":"address"}],"name":"locked","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"readyForLaunch","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"release","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"holder","type":"address"}],"name":"releaseFor","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"holder","type":"address"}],"name":"released","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"tokenCountOnLaunch","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"}]