¡El código fuente de este contrato está verificado!
Metadatos del Contrato
Compilador
0.8.23+commit.f704f362
Idioma
Solidity
Código Fuente del Contrato
Archivo 1 de 8: Address.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.9.0) (utils/Address.sol)pragmasolidity ^0.8.1;/**
* @dev Collection of functions related to the address type
*/libraryAddress{
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
*
* Furthermore, `isContract` will also return true if the target contract within
* the same transaction is already scheduled for destruction by `SELFDESTRUCT`,
* which only has an effect at the end of a transaction.
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/functionisContract(address account) internalviewreturns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0// for contracts in construction, since the code is only stored at the end// of the constructor execution.return account.code.length>0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.8.0/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/functionsendValue(addresspayable recipient, uint256 amount) internal{
require(address(this).balance>= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/functionfunctionCall(address target, bytesmemory data) internalreturns (bytesmemory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/functionfunctionCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalreturns (bytesmemory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/functionfunctionCallWithValue(address target, bytesmemory data, uint256 value) internalreturns (bytesmemory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/functionfunctionCallWithValue(address target,
bytesmemory data,
uint256 value,
stringmemory errorMessage
) internalreturns (bytesmemory) {
require(address(this).balance>= value, "Address: insufficient balance for call");
(bool success, bytesmemory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/functionfunctionStaticCall(address target, bytesmemory data) internalviewreturns (bytesmemory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/functionfunctionStaticCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalviewreturns (bytesmemory) {
(bool success, bytesmemory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/functionfunctionDelegateCall(address target, bytesmemory data) internalreturns (bytesmemory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/functionfunctionDelegateCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalreturns (bytesmemory) {
(bool success, bytesmemory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/functionverifyCallResultFromTarget(address target,
bool success,
bytesmemory returndata,
stringmemory errorMessage
) internalviewreturns (bytesmemory) {
if (success) {
if (returndata.length==0) {
// only check isContract if the call was successful and the return data is empty// otherwise we already know that it was a contractrequire(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/functionverifyCallResult(bool success,
bytesmemory returndata,
stringmemory errorMessage
) internalpurereturns (bytesmemory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function_revert(bytesmemory returndata, stringmemory errorMessage) privatepure{
// Look for revert reason and bubble it up if presentif (returndata.length>0) {
// The easiest way to bubble the revert reason is using memory via assembly/// @solidity memory-safe-assemblyassembly {
let returndata_size :=mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
Código Fuente del Contrato
Archivo 2 de 8: Context.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)pragmasolidity ^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.
*/abstractcontractContext{
function_msgSender() internalviewvirtualreturns (address) {
returnmsg.sender;
}
function_msgData() internalviewvirtualreturns (bytescalldata) {
returnmsg.data;
}
}
Código Fuente del Contrato
Archivo 3 de 8: IERC20.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/IERC20.sol)pragmasolidity ^0.8.0;/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/interfaceIERC20{
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/eventTransfer(addressindexedfrom, addressindexed 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.
*/eventApproval(addressindexed owner, addressindexed spender, uint256 value);
/**
* @dev Returns the amount of tokens in existence.
*/functiontotalSupply() externalviewreturns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/functionbalanceOf(address account) externalviewreturns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/functiontransfer(address to, uint256 amount) externalreturns (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.
*/functionallowance(address owner, address spender) externalviewreturns (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.
*/functionapprove(address spender, uint256 amount) externalreturns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` 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.
*/functiontransferFrom(addressfrom, address to, uint256 amount) externalreturns (bool);
}
Código Fuente del Contrato
Archivo 4 de 8: IERC20Permit.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/extensions/IERC20Permit.sol)pragmasolidity ^0.8.0;/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*/interfaceIERC20Permit{
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*/functionpermit(address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/functionnonces(address owner) externalviewreturns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/// solhint-disable-next-line func-name-mixedcasefunctionDOMAIN_SEPARATOR() externalviewreturns (bytes32);
}
Código Fuente del Contrato
Archivo 5 de 8: Ownable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.9.0) (access/Ownable.sol)pragmasolidity ^0.8.0;import"../utils/Context.sol";
/**
* @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.
*/abstractcontractOwnableisContext{
addressprivate _owner;
eventOwnershipTransferred(addressindexed previousOwner, addressindexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Throws if called by any account other than the owner.
*/modifieronlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/functionowner() publicviewvirtualreturns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/function_checkOwner() internalviewvirtual{
require(owner() == _msgSender(), "Ownable: caller is not the owner");
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/functionrenounceOwnership() publicvirtualonlyOwner{
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/functiontransferOwnership(address newOwner) publicvirtualonlyOwner{
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) internalvirtual{
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
Código Fuente del Contrato
Archivo 6 de 8: ReentrancyGuard.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.9.0) (security/ReentrancyGuard.sol)pragmasolidity ^0.8.0;/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/abstractcontractReentrancyGuard{
// Booleans are more expensive than uint256 or any type that takes up a full// word because each write operation emits an extra SLOAD to first read the// slot's contents, replace the bits taken up by the boolean, and then write// back. This is the compiler's defense against contract upgrades and// pointer aliasing, and it cannot be disabled.// The values being non-zero value makes deployment a bit more expensive,// but in exchange the refund on every call to nonReentrant will be lower in// amount. Since refunds are capped to a percentage of the total// transaction's gas, it is best to keep them low in cases like this one, to// increase the likelihood of the full refund coming into effect.uint256privateconstant _NOT_ENTERED =1;
uint256privateconstant _ENTERED =2;
uint256private _status;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/modifiernonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function_nonReentrantBefore() private{
// On the first call to nonReentrant, _status will be _NOT_ENTEREDrequire(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function_nonReentrantAfter() private{
// By storing the original value once again, a refund is triggered (see// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/function_reentrancyGuardEntered() internalviewreturns (bool) {
return _status == _ENTERED;
}
}
Código Fuente del Contrato
Archivo 7 de 8: SafeERC20.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.9.3) (token/ERC20/utils/SafeERC20.sol)pragmasolidity ^0.8.0;import"../IERC20.sol";
import"../extensions/IERC20Permit.sol";
import"../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/librarySafeERC20{
usingAddressforaddress;
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/functionsafeTransfer(IERC20 token, address to, uint256 value) internal{
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/functionsafeTransferFrom(IERC20 token, addressfrom, address to, uint256 value) internal{
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/functionsafeApprove(IERC20 token, address spender, uint256 value) internal{
// safeApprove should only be called when setting an initial allowance,// or when resetting it to zero. To increase and decrease it, use// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'require(
(value ==0) || (token.allowance(address(this), spender) ==0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/functionsafeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal{
uint256 oldAllowance = token.allowance(address(this), spender);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance + value));
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/functionsafeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal{
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance - value));
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*/functionforceApprove(IERC20 token, address spender, uint256 value) internal{
bytesmemory approvalCall =abi.encodeWithSelector(token.approve.selector, spender, value);
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, 0));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Use a ERC-2612 signature to set the `owner` approval toward `spender` on `token`.
* Revert on invalid signature.
*/functionsafePermit(
IERC20Permit token,
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal{
uint256 nonceBefore = token.nonces(owner);
token.permit(owner, spender, value, deadline, v, r, s);
uint256 nonceAfter = token.nonces(owner);
require(nonceAfter == nonceBefore +1, "SafeERC20: permit did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/function_callOptionalReturn(IERC20 token, bytesmemory data) private{
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that// the target address contains contract code and also asserts for success in the low-level call.bytesmemory returndata =address(token).functionCall(data, "SafeERC20: low-level call failed");
require(returndata.length==0||abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead.
*/function_callOptionalReturnBool(IERC20 token, bytesmemory data) privatereturns (bool) {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since// we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false// and not revert is the subcall reverts.
(bool success, bytesmemory returndata) =address(token).call(data);
return
success && (returndata.length==0||abi.decode(returndata, (bool))) && Address.isContract(address(token));
}
}
Código Fuente del Contrato
Archivo 8 de 8: Vesting.sol
// SPDX-License-Identifier: MITpragmasolidity 0.8.23;import {IERC20} from"@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {SafeERC20} from"@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {Ownable} from"@openzeppelin/contracts/access/Ownable.sol";
import"@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import"@openzeppelin/contracts/security/ReentrancyGuard.sol";
structCreateVestingInput {
address user;
uint128 amount;
}
/**
* @param rate percentage vested from total amount during the phase in BPS
* @param endAt Time when phase ends
* @param minimumClaimablePeriod for linear vesting it would be "1 seconds", for weekly westing it would be "1 weeks", if not set(set to zero) user will be able to claim only after phase ends
*/structPhase {
uint32 rate;
uint40 endAt;
uint32 minimumClaimablePeriod;
}
/**
* @title Vesting
* @dev no user can claim while contract is in locked state
* @dev Contract that is used for token vesting by some predefined schedule. It supports cases when part(percentage) of the token was already given
* to users and rest will be claimed here. It supports many phases and cliff at the start. Also it supports vesting by block, which means user can vest every block some tokens,
* by percentage defined in phase percetage.
* For time we are using uint40, which max number is 1099511627776, presented in seconds is more than suitable for our usage.
*/contractVestingisOwnable, ReentrancyGuard{
usingSafeERC20forIERC20;
/**
* @param amount Total amount allocated for user
* @param amountClaimed Total amount claimed by user so far
* @param lastClaimAt Timestamp from user last claim
*/structUserVesting {
uint40 lastClaimAt;
bool init;
// during refundGracePeriod (i.e. 1, 3 or 7 days after vesting starts, user can request refund if did not claim any tokens)// after refundGracePeriod expires, user will be then enabled refund on fundraise chain.bool requestedRefund;
uint256 amount;
uint256 amountClaimed;
}
uint128publicconstant BASIS_POINT_RATE_CONVERTER =10_000; // Basis Points(bps) 1% = 100bpsuint256publicconstant MAX_ALLOWED_PHASES =30;
stringpublic name;
boolpublic refundMode;
boolpublic requestedRefundWithdrawn;
boolpublic refundWithdrawn;
uint40public startDateAt;
uint40public vestingEndAt;
uint16public claimableAtStart; // in BPSuint32public refundGracePeriodDuration; // in seconds
IERC20 public vestedToken;
// when refund mode is on this means complete project will be refunded as terms has been nreached. // i.e. price is bellow IDO Price after 48 hours, etc. uint256public totalAmountAllocated; // Amount owner allocated for all usersuint256public totalAmountClaimed; // Amount claimed by all usersuint256public totalAmountRefundRequested; // Amount reserved for refund, requested by users
Phase[] public phases;
mapping(address=> UserVesting) public vestings;
// it is hard to add user and then remove it if cancle requestRefund. SO here wew ill store all users// that requestedRefund. Later we will check flag in UserVestingaddress[] public refundRequestedUsersAtLeastOnce;
eventNewVestingCreated(addressindexed user, uint256 amount);
eventNewClaim(addressindexed user, uint256 amountClaimed);
eventRefundRequested(addressindexed user);
eventRefundRequestedPulledBack(addressindexed user);
eventRefundRequestedWithdrawn(addressindexed user, uint256 amount);
eventRefundForAllWithdrawn(addressindexed user, uint256 amount);
constructor(
IERC20 _vestedToken,
stringmemory _name,
uint40 _startDateAt,
uint16 _claimableAtStart,
Phase[] memory _phases,
uint32 _refundGracePeriodDuration
) payableOwnable() {
_initialize(
_vestedToken,
_name,
_startDateAt,
_claimableAtStart,
_phases,
_refundGracePeriodDuration
);
}
/**
* @notice owner can reinitialize vesting schedule only if vesting did not started
*/functionreinitialize(
IERC20 _vestedToken,
stringmemory _name,
uint40 _startDateAt,
uint16 _claimableAtStart,
Phase[] memory _phases,
uint32 _refundGracePeriodDuration
) externalonlyOwner{
require(totalAmountClaimed ==0, "claim already started");
_initialize(
_vestedToken,
_name,
_startDateAt,
_claimableAtStart,
_phases,
_refundGracePeriodDuration
);
}
functiongetNumberOfRefundRequestedUsersAtLeastOnce() publicviewreturns (uint256) {
return refundRequestedUsersAtLeastOnce.length;
}
functiongetRefundRequestedUsersAtLeastOnceVesting(uint256 index) publicviewreturns (UserVesting memory userVesting) {
address user = refundRequestedUsersAtLeastOnce[index];
userVesting = vestings[user];
}
/**
* @notice this is to make vesting refundMode. This method is used if e.g we will refund launchpad but we need to return not vested tokens, we need to make it
* to stop vesting contract.
*/functionsetRefundMode(bool _refundMode) externalonlyOwner{
refundMode = _refundMode;
}
functiongetUserVesting(address _userAddress) publicviewreturns (UserVesting memory) {
return vestings[_userAddress];
}
/**
* @notice create vesting for user, only one vesting per user address
* @dev owner needs to first deploy enough tokens to vesting contract address
*/functioncreateVestings(CreateVestingInput[] calldata vestingsInput, bool depositCheck) externalonlyOwner{
require(vestingsInput.length>0, "vestingsInput empty");
require(block.timestamp< startDateAt, "vesting started");
uint256 totalDepositedAmount = getDepositedAmount();
uint256 amountAllocated;
for (uint64 i =0; i < vestingsInput.length; i++) {
amountAllocated += vestingsInput[i].amount;
}
if (depositCheck) {
uint256 totalTokenAvailable = totalDepositedAmount + totalAmountClaimed - totalAmountAllocated;
require(totalTokenAvailable >= amountAllocated, "not enough token deposited");
}
for (uint64 i =0; i < vestingsInput.length; i++) {
_createVesting(vestingsInput[i]);
}
}
/**
* @dev method which is used for claiming if any tokens are available for claim
*/functionclaim() externalnonReentrant{
require(!refundMode, "vesting is refunded");
address user = _msgSender();
UserVesting storage vesting = vestings[user];
require(!vesting.requestedRefund, "user req refund");
require(vesting.init, "user is not participating");
require(vesting.amount - vesting.amountClaimed >0, "all amount claimed");
uint256 claimableAmount = _claimable(vesting);
require(getDepositedAmount() >= claimableAmount, "not enough token deposited for claim");
require(claimableAmount >0, "nothing to claim currently");
totalAmountClaimed += claimableAmount;
vesting.amountClaimed += claimableAmount;
vesting.lastClaimAt =uint40(block.timestamp);
assert(vesting.amountClaimed <= vesting.amount);
assert(totalAmountClaimed <= totalAmountAllocated);
vestedToken.safeTransfer(user, claimableAmount);
emit NewClaim(user, claimableAmount);
}
/**
* @dev return amount user can claim from locked tokens at the moment
*/functionclaimable(address _user) externalviewreturns (uint256 amount) {
if (refundMode) {
return0;
}
amount = _claimable(vestings[_user]);
}
functiongetDepositedAmount() publicviewreturns (uint256 amount) {
amount = vestedToken.balanceOf(address(this));
}
/**
* @dev method which is used for user to request refund
*/functionrequestRefund() externalnonReentrant{
address user = _msgSender();
UserVesting storage vesting = vestings[user];
require(vesting.init, "user is not participating");
require(vesting.amountClaimed ==0, "user already claimed");
require(block.timestamp<= (startDateAt + refundGracePeriodDuration), "refund period passed");
vesting.requestedRefund =true;
totalAmountRefundRequested += vesting.amount;
totalAmountAllocated -= vesting.amount;
refundRequestedUsersAtLeastOnce.push(user);
emit RefundRequested(user);
}
/**
* @dev method which is used for user to request refund
*/functionpullBackRequestRefund() externalnonReentrant{
address user = _msgSender();
UserVesting storage vesting = vestings[user];
require(vesting.init, "user is not participating");
require(vesting.amountClaimed ==0, "user already claimed");
require(vesting.requestedRefund, "nothin to pull back");
require(block.timestamp<= (startDateAt + refundGracePeriodDuration), "refund period passed");
vesting.requestedRefund =false;
totalAmountRefundRequested -= vesting.amount;
totalAmountAllocated += vesting.amount;
emit RefundRequestedPulledBack(user);
}
/**
* @dev Returns time until next vesting batch will be unlocked for vesting contract provided in arguments
* in case of linear vesting (or next block vesting) it is returned 1, which for the caller indicates it will be next block
* for other use cases it is returned time when next phase will be available
*/functionnextBatchAt() externalviewreturns (uint256) {
if (block.timestamp>= vestingEndAt) {
return vestingEndAt;
}
// we assume all vesting contracts release at least some funds on start date/TGEif (block.timestamp< startDateAt) {
return startDateAt;
}
uint256 nextBatchIn;
uint256 prevEndDate = startDateAt;
// iterate over phases until we find current phase contract does not returns phases lengthfor (uint256 i =0; block.timestamp> prevEndDate; i++) {
Phase memory phase = phases[i];
if (block.timestamp<= phase.endAt) {
// vesting per sec/blockif (phase.minimumClaimablePeriod ==1) {
nextBatchIn =1;
} elseif (phase.minimumClaimablePeriod ==0) {
// vested at the end of the phase
nextBatchIn = phase.endAt;
} else {
// if the funds are released in batches in current phase every `minimumClaimablePeriod` time,
nextBatchIn =block.timestamp+ phase.minimumClaimablePeriod - ((block.timestamp- prevEndDate) % phase.minimumClaimablePeriod);
}
break;
}
prevEndDate = phase.endAt;
}
return nextBatchIn;
}
/**
* @notice rescue any token accidentally sent to this contract
*/functionemergencyWithdrawToken(IERC20 token) externalonlyOwner{
token.safeTransfer(_msgSender(), token.balanceOf(address(this)));
}
/**
* @notice Move vesting to another address in case user lose access to his original account
*/functionmoveVesting(addressfrom, address to) externalonlyOwner{
UserVesting memory vestingFrom = vestings[from];
require(vestingFrom.init, "`from` no active vesting");
require(vestingFrom.amount - vestingFrom.amountClaimed >0, "`from` all amount claimed");
UserVesting memory vestingTo = vestings[to];
require(!vestingTo.init, "`to` has registered listing");
require(to !=address(0), "`to` must not be 0 addr");
vestings[to] = vestingFrom;
delete vestings[from];
}
/**
* @dev withdraw toknes which requested refund. These tokens will be returned to the project and user will be enabled refund on fundraiseChain
*/functionwithdrawRequestRefundToken() externalonlyOwner{
require(!requestedRefundWithdrawn, "already withdrawn");
require(block.timestamp> startDateAt + refundGracePeriodDuration, "refund period active");
uint256 vestedbalance = vestedToken.balanceOf(address(this));
require(vestedbalance >= totalAmountRefundRequested, "not enough tokens");
requestedRefundWithdrawn =true;
vestedToken.safeTransfer(msg.sender, totalAmountRefundRequested);
emit RefundRequestedWithdrawn(msg.sender, totalAmountRefundRequested);
}
/**
* @dev withdraw refund tokens. These tokens will be returned to project and user will be enabled refund on fundraiseChain
*/functionwithdrawRefundForAll() externalonlyOwner{
require(!refundWithdrawn, "already withdrawn");
require(refundMode, "refund mode is off");
refundWithdrawn =true;
vestedToken.safeTransfer(msg.sender, vestedToken.balanceOf(address(this)));
emit RefundForAllWithdrawn(msg.sender, totalAmountRefundRequested);
}
function_initialize(
IERC20 _vestedToken,
stringmemory _name,
uint40 _startDateAt,
uint16 _claimableAtStart,
Phase[] memory _phases,
uint32 _refundGracePeriodDuration
) private{
require(_phases.length<= MAX_ALLOWED_PHASES, "phases size exceeds max allowed");
uint256 prevStartDate = _startDateAt;
uint256 total = _claimableAtStart;
for (uint256 i =0; i < _phases.length; i++) {
Phase memory phase = _phases[i];
require(phase.endAt > prevStartDate, "phases not ordered");
total += phase.rate;
prevStartDate = phase.endAt;
}
require(total == BASIS_POINT_RATE_CONVERTER, "total == 10000");
require(address(_vestedToken) !=address(0), "vesttedToken address is zero");
name = _name;
vestedToken = _vestedToken;
startDateAt = _startDateAt;
// set vesting end date to last phase end date, if there is not phases then set end date to start date(e.g. for 100% claim at TGE)
vestingEndAt = _phases.length>0
? _phases[_phases.length-1].endAt
: _startDateAt;
claimableAtStart = _claimableAtStart;
// clear the phases array in case of reinitializationdelete phases;
for (uint256 i =0; i < _phases.length; i++) {
phases.push(_phases[i]);
}
refundGracePeriodDuration = _refundGracePeriodDuration;
}
/**
* @dev create vesting for an user
*/function_createVesting(CreateVestingInput memory v) private{
require(v.user !=address(0), "user address is zero");
require(v.amount >0, "amount is zero");
require(vestings[v.user].amount ==0, "one vesting per addr");
totalAmountAllocated += v.amount;
vestings[v.user] = UserVesting({
init: true,
amount: v.amount,
amountClaimed: 0,
lastClaimAt: 0,
requestedRefund: false
});
emit NewVestingCreated(v.user, v.amount);
}
/**
* @dev claimable amount available at the time function is called
*/function_claimable(UserVesting memory v) privateviewreturns (uint256 amount) {
if (refundMode || v.requestedRefund) {
// refundMode is on or user requested refundreturn0;
} elseif (block.timestamp< startDateAt) {
// vesting has not startedreturn0;
}
uint256 amountLeft = v.amount - v.amountClaimed;
// user already claimed everythingif (amountLeft ==0) return0;
if (block.timestamp>= vestingEndAt) {
// if vesting ended return everything left
amount = amountLeft;
} else {
if (v.lastClaimAt ==0) {
// if this is first claim also calculate amount available at start
amount += (claimableAtStart * v.amount) / BASIS_POINT_RATE_CONVERTER;
}
uint256 prevEndDate = startDateAt;
for (uint256 i =0; i < phases.length; i++) {
Phase memory phase = phases[i];
uint40 phaseLength =uint40(phase.endAt - prevEndDate);
// if last claim time is larger than the end of phase then skip it, already calculated in previous claimif (v.lastClaimAt < phase.endAt) {
if (block.timestamp>= phase.endAt && phase.minimumClaimablePeriod ==0) {
// if phase completely passed then calculate amount with every second in phase
amount += (v.amount * phase.rate) / BASIS_POINT_RATE_CONVERTER;
} elseif (phase.minimumClaimablePeriod !=0) {
uint40 start =uint40(max(v.lastClaimAt, prevEndDate));
uint40 end =uint40(min(block.timestamp, phase.endAt));
// only take full increments of minimumClaimablePeriod in calculation of amount. // e.g. if end (current block.timestamp) is at 170, and start is at 100, and if minimumClaimable perios is 20s. // then we have following: end - start = 170 - 100 = 70, and of that 70 we can only take in calculation 60 seconds, only full amount of claimable period.// timePassed = 170 - 100 - ((170 - 100) % 20) = 70 - (70 % 20) = 70 - 10 = 60uint40 timePassed = end - start - ((end - start) % phase.minimumClaimablePeriod);
amount += (v.amount * phase.rate * timePassed) / (phaseLength * BASIS_POINT_RATE_CONVERTER);
}
if (block.timestamp< phase.endAt) {
// if current time is less than end of this phase then there is no need to calculate remaining phasesbreak;
}
}
prevEndDate = phase.endAt;
}
}
return min(amount, amountLeft);
}
/**
* @dev Returns the largest of two numbers.
*/functionmax(uint256 a, uint256 b) internalpurereturns (uint256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two numbers.
*/functionmin(uint256 a, uint256 b) internalpurereturns (uint256) {
return a < b ? a : b;
}
}