// 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);
}
}
}
Contract Source Code
File 2 of 9: 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;
}
}
Contract Source Code
File 3 of 9: 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);
}
Contract Source Code
File 4 of 9: 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);
}
Contract Source Code
File 5 of 9: IVotingEscrow.sol
// SPDX-License-Identifier: UNLICENSEDpragmasolidity 0.8.25;interfaceIVotingEscrow{
/// @dev Lockup structstructLockup {
uint128 amount; // Locked amountuint128 duration; // Lock duration in secondsuint128 end; // Lock end timestamp in secondsuint256 points; // veTRUF pointsbool isVesting; // True if locked from vesting
}
functionstakeVesting(uint256 amount, uint256 duration, address to, uint256 startTime) externalreturns (uint256 lockupId);
functionunstakeVesting(address user, uint256 lockupId, bool force) externalreturns (uint256 amount);
functionmigrateVestingLock(address oldUser, address newUser, uint256 lockupId)
externalreturns (uint256 newLockupId);
functionextendVestingLock(address user, uint256 lockupId, uint256 amount, uint256 duration) external;
// Events/// Emitted when user staked TRUF or vestingeventStake(addressindexed user, boolindexed isVesting, uint256 lockupId, uint256 amount, uint256 start, uint256 end, uint256 points
);
/// Emitted when user unstakedeventUnstake(addressindexed user, boolindexed isVesting, uint256 lockupId, uint256 amount, uint256 end, uint256 points
);
/// Emitted when lockup migrated to another user (for vesting only)eventMigrated(addressindexed oldUser, addressindexed newUser, uint256 oldLockupId, uint256 newLockupId);
/// Emitted when lockup cancelled (for vesting only)eventCancelled(addressindexed user, uint256 lockupId, uint256 amount, uint256 points);
}
Contract Source Code
File 6 of 9: 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);
}
}
Contract Source Code
File 7 of 9: Ownable2Step.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.9.0) (access/Ownable2Step.sol)pragmasolidity ^0.8.0;import"./Ownable.sol";
/**
* @dev Contract module which provides 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} and {acceptOwnership}.
*
* This module is used through inheritance. It will make available all functions
* from parent (Ownable).
*/abstractcontractOwnable2StepisOwnable{
addressprivate _pendingOwner;
eventOwnershipTransferStarted(addressindexed previousOwner, addressindexed newOwner);
/**
* @dev Returns the address of the pending owner.
*/functionpendingOwner() publicviewvirtualreturns (address) {
return _pendingOwner;
}
/**
* @dev Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one.
* Can only be called by the current owner.
*/functiontransferOwnership(address newOwner) publicvirtualoverrideonlyOwner{
_pendingOwner = newOwner;
emit OwnershipTransferStarted(owner(), newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`) and deletes any pending owner.
* Internal function without access restriction.
*/function_transferOwnership(address newOwner) internalvirtualoverride{
delete _pendingOwner;
super._transferOwnership(newOwner);
}
/**
* @dev The new owner accepts the ownership transfer.
*/functionacceptOwnership() publicvirtual{
address sender = _msgSender();
require(pendingOwner() == sender, "Ownable2Step: caller is not the new owner");
_transferOwnership(sender);
}
}
Contract Source Code
File 8 of 9: 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));
}
}
Contract Source Code
File 9 of 9: TrufVesting.sol
// SPDX-License-Identifier: UNLICENSEDpragmasolidity 0.8.25;import {Ownable2Step} from"@openzeppelin/contracts/access/Ownable2Step.sol";
import {IERC20} from"@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {SafeERC20} from"@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {IVotingEscrow} from"../interfaces/IVotingEscrow.sol";
/**
* @title TRUF vesting contract
* @author Ryuhei Matsuda
* @notice Admin registers vesting information for users,
* and users could claim or lock vesting to veTRUF to get voting power and TRUF staking rewards
*/contractTrufVestingisOwnable2Step{
usingSafeERC20forIERC20;
errorZeroAddress();
errorZeroAmount();
errorForbidden(address sender);
errorInvalidTimestamp();
errorInvalidAmount();
errorInvalidVestingCategory(uint256 id);
errorInvalidEmissions();
errorInvalidVestingInfo(uint256 categoryIdx, uint256 id);
errorInvalidUserVesting();
errorClaimAmountExceed();
errorUserVestingAlreadySet(uint256 categoryIdx, uint256 vestingId, address user);
errorUserVestingDoesNotExists(uint256 categoryIdx, uint256 vestingId, address user);
errorMaxAllocationExceed();
errorAlreadyVested(uint256 categoryIdx, uint256 vestingId, address user);
errorLockExist();
errorLockDoesNotExist();
errorInvalidInitialReleasePct();
errorInvalidInitialReleasePeriod();
errorInvalidCliff();
errorInvalidPeriod();
errorInvalidUnit();
errorInitialized();
/// @dev Emitted when vesting category is seteventVestingCategorySet(uint256indexed id, string category, uint256 maxAllocation, bool adminClaimable);
/// @dev Emitted when emission schedule is seteventEmissionScheduleSet(uint256indexed categoryId, uint256[] emissions);
/// @dev Emitted when vesting info is seteventVestingInfoSet(uint256indexed categoryId, uint256indexed id, VestingInfo info);
/// @dev Emitted when user vesting info is seteventUserVestingSet(uint256indexed categoryId, uint256indexed vestingId, addressindexed user, uint256 amount, uint64 startTime
);
/// @dev Emitted when user vesting is migrated using the migrator contract.eventUserVestingMigrated(uint256indexed categoryId,
uint256indexed vestingId,
addressindexed user,
uint256 amount,
uint256 claimed,
uint256 locked,
uint64 startTime
);
/// @dev Emitted when admin migrates user's vesting to another addresseventMigrateUser(uint256indexed categoryId, uint256indexed vestingId, address prevUser, address newUser, uint256 newLockupId
);
/// @dev Emitted when admin cancel user's vestingeventCancelVesting(uint256indexed categoryId, uint256indexed vestingId, addressindexed user, bool giveUnclaimed
);
/// @dev Emitted when admin has been seteventAdminSet(addressindexed admin, boolindexed flag);
/// @dev Emitted when user claimed vested TRUF tokenseventClaimed(uint256indexed categoryId, uint256indexed vestingId, addressindexed user, uint256 amount);
/// @dev Emitted when veTRUF token has been seteventVeTrufSet(addressindexed veTRUF);
/// @dev Emitted when user stakes vesting to veTRUFeventStaked(uint256indexed categoryId,
uint256indexed vestingId,
addressindexed user,
uint256 amount,
uint256 start,
uint256 duration,
uint256 lockupId
);
/// @dev Emitted when user extended veTRUF staking period or increased amounteventExtendedStaking(uint256indexed categoryId, uint256indexed vestingId, addressindexed user, uint256 amount, uint256 duration
);
/// @dev Emitted when user unstakes from veTRUFeventUnstaked(uint256indexed categoryId, uint256indexed vestingId, addressindexed user, uint256 amount);
/// @dev Vesting Category structstructVestingCategory {
string category; // Category nameuint256 maxAllocation; // Maximum allocation for this categoryuint256 allocated; // Current allocated amountbool adminClaimable; // Allow admin to claim if value is trueuint256 totalClaimed; // Total claimed amount
}
/// @dev Vesting info structstructVestingInfo {
uint64 initialReleasePct; // Initial Release percentageuint64 initialReleasePeriod; // Initial release period after TGEuint64 cliff; // Cliff perioduint64 period; // Total perioduint64 unit; // The period to claim. ex. monthly or 6 monthly
}
/// @dev User vesting info structstructUserVesting {
uint256 amount; // Total vesting amountuint256 claimed; // Total claimed amountuint256 locked; // Locked amount at VotingEscrowuint64 startTime; // Vesting start time
}
uint256publicconstant DENOMINATOR =1e18;
uint64publicconstant ONE_MONTH =30days;
/// @dev Is category initializedmapping(uint256=>bool) public isInitialized;
/// @dev TRUF token address
IERC20 publicimmutable trufToken;
/// @dev TRUF Migration contract addressaddresspublicimmutable trufMigrator;
/// @dev veTRUF token address
IVotingEscrow public veTRUF;
/// @dev TGE timestampuint64publicimmutable tgeTime;
/// @dev Vesting categories
VestingCategory[] public categories;
// @dev Emission schedule per category. x index item of array indicates emission limit on x+1 months after TGE time.mapping(uint256=>uint256[]) public emissionSchedule;
/// @dev Vesting info per categorymapping(uint256=> VestingInfo[]) public vestingInfos;
/// @dev User vesting information (category => info => user address => user vesting)mapping(uint256=>mapping(uint256=>mapping(address=> UserVesting))) public userVestings;
/// @dev Vesting lockup ids (category => info => user address => lockup id)mapping(uint256=>mapping(uint256=>mapping(address=>uint256))) public lockupIds;
/// @dev True if account has admin permissionmapping(address=>bool) public isAdmin;
modifieronlyAdmin() {
if (!isAdmin[msg.sender] &&msg.sender!= owner()) {
revert Forbidden(msg.sender);
}
_;
}
/**
* @notice TRUF Vesting constructor
* @param _trufToken TRUF token address
*/constructor(IERC20 _trufToken, address _trufMigrator, uint64 _tgeTime) {
if (address(_trufToken) ==address(0)) revert ZeroAddress();
trufToken = _trufToken;
trufMigrator = _trufMigrator;
tgeTime = _tgeTime;
}
/**
* @notice Calculate claimable amount (total vested amount - previously claimed amount - locked amount)
* @param categoryId Vesting category id
* @param vestingId Vesting id
* @param user user address
* @return claimableAmount Claimable amount
*/functionclaimable(uint256 categoryId, uint256 vestingId, address user)
publicviewreturns (uint256 claimableAmount)
{
if (isInitialized[categoryId] ==false) revert Initialized();
UserVesting memory userVesting = userVestings[categoryId][vestingId][user];
VestingInfo memory info = vestingInfos[categoryId][vestingId];
uint64 startTime = userVesting.startTime + info.initialReleasePeriod;
if (startTime >block.timestamp) {
return0;
}
uint256 totalAmount = userVesting.amount;
uint256 initialRelease = (totalAmount * info.initialReleasePct) / DENOMINATOR;
startTime += info.cliff;
uint256 vestedAmount;
if (startTime >block.timestamp) {
vestedAmount = initialRelease;
} else {
uint64 timeElapsed = ((uint64(block.timestamp) - startTime) / info.unit) * info.unit;
vestedAmount = ((totalAmount - initialRelease) * timeElapsed) / info.period + initialRelease;
}
uint256 maxClaimable = userVesting.amount - userVesting.locked;
if (vestedAmount > maxClaimable) {
vestedAmount = maxClaimable;
}
if (vestedAmount <= userVesting.claimed) {
return0;
}
claimableAmount = vestedAmount - userVesting.claimed;
uint256 emissionLeft = getEmission(categoryId) - categories[categoryId].totalClaimed;
if (claimableAmount > emissionLeft) {
claimableAmount = emissionLeft;
}
}
/**
* @notice Claim available amount
* @dev Owner is able to claim for admin claimable categories.
* @param user user account(For non-admin claimable categories, it must be msg.sender)
* @param categoryId category id
* @param vestingId vesting id
* @param claimAmount token amount to claim
*/functionclaim(address user, uint256 categoryId, uint256 vestingId, uint256 claimAmount) public{
if (isInitialized[categoryId] ==false) revert Initialized();
if (user !=msg.sender&& (!categories[categoryId].adminClaimable ||!isAdmin[msg.sender])) {
revert Forbidden(msg.sender);
}
uint256 claimableAmount = claimable(categoryId, vestingId, user);
if (claimAmount ==type(uint256).max) {
claimAmount = claimableAmount;
} elseif (claimAmount > claimableAmount) {
revert ClaimAmountExceed();
}
if (claimAmount ==0) {
revert ZeroAmount();
}
categories[categoryId].totalClaimed += claimAmount;
userVestings[categoryId][vestingId][user].claimed += claimAmount;
trufToken.safeTransfer(user, claimAmount);
emit Claimed(categoryId, vestingId, user, claimAmount);
}
/**
* @notice Stake vesting to veTRUF to get voting power and get staking TRUF rewards
* @param categoryId category id
* @param vestingId vesting id
* @param amount amount to stake
* @param duration lock period in seconds
*/functionstake(uint256 categoryId, uint256 vestingId, uint256 amount, uint256 duration) external{
_stake(msg.sender, categoryId, vestingId, amount, block.timestamp, duration);
}
/**
* @notice Extend veTRUF staking period and increase amount
* @param categoryId category id
* @param vestingId vesting id
* @param amount token amount to increase
* @param duration lock period from now
*/functionextendStaking(uint256 categoryId, uint256 vestingId, uint256 amount, uint256 duration) external{
if (isInitialized[categoryId] ==false) revert Initialized();
uint256 lockupId = lockupIds[categoryId][vestingId][msg.sender];
if (lockupId ==0) {
revert LockDoesNotExist();
}
if (amount !=0) {
UserVesting storage userVesting = userVestings[categoryId][vestingId][msg.sender];
if (amount > userVesting.amount - userVesting.claimed - userVesting.locked) {
revert InvalidAmount();
}
userVesting.locked += amount;
trufToken.safeIncreaseAllowance(address(veTRUF), amount);
}
veTRUF.extendVestingLock(msg.sender, lockupId -1, amount, duration);
emit ExtendedStaking(categoryId, vestingId, msg.sender, amount, duration);
}
/**
* @notice Unstake vesting from veTRUF
* @param categoryId category id
* @param vestingId vesting id
*/functionunstake(uint256 categoryId, uint256 vestingId) external{
if (isInitialized[categoryId] ==false) revert Initialized();
uint256 lockupId = lockupIds[categoryId][vestingId][msg.sender];
if (lockupId ==0) {
revert LockDoesNotExist();
}
uint256 amount = veTRUF.unstakeVesting(msg.sender, lockupId -1, false);
UserVesting storage userVesting = userVestings[categoryId][vestingId][msg.sender];
userVesting.locked -= amount;
delete lockupIds[categoryId][vestingId][msg.sender];
emit Unstaked(categoryId, vestingId, msg.sender, amount);
}
/**
* @notice Migrate owner of vesting. Used when user lost his private key
* @dev Only admin can migrate users vesting
* @param categoryId Category id
* @param vestingId Vesting id
* @param prevUser previous user address
* @param newUser new user address
*/functionmigrateUser(uint256 categoryId, uint256 vestingId, address prevUser, address newUser) externalonlyAdmin{
if (newUser ==address(0)) {
revert ZeroAddress();
}
UserVesting storage prevVesting = userVestings[categoryId][vestingId][prevUser];
UserVesting storage newVesting = userVestings[categoryId][vestingId][newUser];
if (newVesting.amount !=0) {
revert UserVestingAlreadySet(categoryId, vestingId, newUser);
}
if (prevVesting.amount ==0) {
revert UserVestingDoesNotExists(categoryId, vestingId, prevUser);
}
newVesting.amount = prevVesting.amount;
newVesting.claimed = prevVesting.claimed;
newVesting.startTime = prevVesting.startTime;
uint256 lockupId = lockupIds[categoryId][vestingId][prevUser];
uint256 newLockupId;
if (lockupId !=0) {
newLockupId = veTRUF.migrateVestingLock(prevUser, newUser, lockupId -1) +1;
lockupIds[categoryId][vestingId][newUser] = newLockupId;
delete lockupIds[categoryId][vestingId][prevUser];
newVesting.locked = prevVesting.locked;
}
delete userVestings[categoryId][vestingId][prevUser];
emit MigrateUser(categoryId, vestingId, prevUser, newUser, newLockupId);
}
/**
* @notice Cancel vesting and force cancel from voting escrow
* @dev Only admin can cancel users vesting
* @param categoryId Category id
* @param vestingId Vesting id
* @param user user address
* @param giveUnclaimed Send currently vested, but unclaimed amount to use or not
*/functioncancelVesting(uint256 categoryId, uint256 vestingId, address user, bool giveUnclaimed)
externalonlyAdmin{
UserVesting storage userVesting = userVestings[categoryId][vestingId][user];
if (userVesting.amount ==0) {
revert UserVestingDoesNotExists(categoryId, vestingId, user);
}
VestingInfo memory vestingInfo = vestingInfos[categoryId][vestingId];
if (
userVesting.startTime + vestingInfo.initialReleasePeriod + vestingInfo.cliff + vestingInfo.period
<=block.timestamp
) {
revert AlreadyVested(categoryId, vestingId, user);
}
uint256 lockupId = lockupIds[categoryId][vestingId][user];
if (lockupId !=0) {
veTRUF.unstakeVesting(user, lockupId -1, true);
delete lockupIds[categoryId][vestingId][user];
userVesting.locked =0;
}
VestingCategory storage category = categories[categoryId];
uint256 claimableAmount = claimable(categoryId, vestingId, user);
uint256 unvested = userVesting.amount - (userVesting.claimed + (giveUnclaimed ? claimableAmount : 0));
delete userVestings[categoryId][vestingId][user];
category.allocated -= unvested;
if (giveUnclaimed && claimableAmount !=0) {
trufToken.safeTransfer(user, claimableAmount);
category.totalClaimed += claimableAmount;
emit Claimed(categoryId, vestingId, user, claimableAmount);
}
emit CancelVesting(categoryId, vestingId, user, giveUnclaimed);
}
/**
* @notice Add a new vesting category
* @dev Only admin can add a vesting category
* @param category new vesting category
* @param maxAllocation Max allocation amount for this category
* @param adminClaimable Admin claimable flag
*/functionsetVestingCategory(stringcalldata category, uint256 maxAllocation, bool adminClaimable)
publiconlyOwner{
if (maxAllocation ==0) {
revert ZeroAmount();
}
uint256 id = categories.length;
categories.push(VestingCategory(category, maxAllocation, 0, adminClaimable, 0));
emit VestingCategorySet(id, category, maxAllocation, adminClaimable);
}
/**
* @notice Set emission schedule
* @dev Only admin can set emission schedule
* @param categoryId category id
* @param emissions Emission schedule
*/functionsetEmissionSchedule(uint256 categoryId, uint256[] memory emissions) publiconlyOwner{
if (isInitialized[categoryId]) {
revert Initialized();
}
uint256 maxAllocation = categories[categoryId].maxAllocation;
if (emissions.length==0|| emissions[emissions.length-1] != maxAllocation) {
revert InvalidEmissions();
}
delete emissionSchedule[categoryId];
emissionSchedule[categoryId] = emissions;
emit EmissionScheduleSet(categoryId, emissions);
}
/**
* @notice Add or modify vesting information
* @dev Only admin can set vesting info
* @param categoryIdx category id
* @param id id to modify or uint256.max to add new info
* @param info new vesting info
*/functionsetVestingInfo(uint256 categoryIdx, uint256 id, VestingInfo calldata info) publiconlyAdmin{
if (info.initialReleasePct > DENOMINATOR) {
revert InvalidInitialReleasePct();
} elseif (info.initialReleasePeriod > info.period) {
revert InvalidInitialReleasePeriod();
} elseif (info.cliff >365days) {
revert InvalidCliff();
} elseif (info.period >8*365days) {
revert InvalidPeriod();
} elseif (info.period % info.unit !=0) {
revert InvalidUnit();
}
if (id ==type(uint256).max) {
id = vestingInfos[categoryIdx].length;
vestingInfos[categoryIdx].push(info);
} else {
vestingInfos[categoryIdx][id] = info;
}
emit VestingInfoSet(categoryIdx, id, info);
}
/**
* @notice Migrate vesting from old contracts.
* @param categoryId category id
* @param vestingId vesting id
* @param user user address
* @param amount vesting amount
* @param claimed vesting claimed amount
* @param locked vesting locked amount, 0 if no staking
* @param vestingStartTime zero to start from TGE or non-zero to set up custom start time
* @param stakingStartTime timestamp where the staking began, 0 if no staking
* @param stakingDuration duration of the staking, 0 if no staking
*/functionmigrate(uint256 categoryId,
uint256 vestingId,
address user,
uint256 amount,
uint256 claimed,
uint256 locked,
uint64 vestingStartTime,
uint256 stakingStartTime,
uint256 stakingDuration
) public{
if (msg.sender!= trufMigrator) {
revert();
}
if (user ==address(0)) {
revert ZeroAddress();
}
if (amount ==0) {
revert ZeroAmount();
}
if (categoryId >= categories.length) {
revert InvalidVestingCategory(categoryId);
}
if (vestingId >= vestingInfos[categoryId].length) {
revert InvalidVestingInfo(categoryId, vestingId);
}
if (isInitialized[categoryId]) {
trufToken.safeTransferFrom(msg.sender, address(this), amount - claimed);
} elseif (locked >0) {
revert Initialized();
}
VestingCategory storage category = categories[categoryId];
UserVesting storage userVesting = userVestings[categoryId][vestingId][user];
if (amount < claimed + locked) {
revert InvalidUserVesting();
}
category.allocated += amount;
category.totalClaimed += claimed;
if (category.allocated > category.maxAllocation) {
revert MaxAllocationExceed();
}
if (vestingStartTime !=0&& vestingStartTime < tgeTime) revert InvalidTimestamp();
userVesting.amount += amount;
userVesting.claimed += claimed;
userVesting.startTime = vestingStartTime ==0 ? tgeTime : vestingStartTime;
emit UserVestingMigrated(categoryId, vestingId, user, amount, claimed, locked, userVesting.startTime);
if (locked >0) {
_stake(user, categoryId, vestingId, locked, stakingStartTime, stakingDuration);
}
}
/**
* @notice Set user vesting amount
* @dev Only admin can set user vesting
* @dev It will be failed if it exceeds max allocation
* @param categoryId category id
* @param vestingId vesting id
* @param user user address
* @param startTime zero to start from TGE or non-zero to set up custom start time
* @param amount vesting amount
*/functionsetUserVesting(uint256 categoryId, uint256 vestingId, address user, uint64 startTime, uint256 amount)
publiconlyAdmin{
if (user ==address(0)) {
revert ZeroAddress();
}
if (amount ==0) {
revert ZeroAmount();
}
if (categoryId >= categories.length) {
revert InvalidVestingCategory(categoryId);
}
if (vestingId >= vestingInfos[categoryId].length) {
revert InvalidVestingInfo(categoryId, vestingId);
}
VestingCategory storage category = categories[categoryId];
UserVesting storage userVesting = userVestings[categoryId][vestingId][user];
category.allocated += amount;
category.allocated -= userVesting.amount;
if (category.allocated > category.maxAllocation) {
revert MaxAllocationExceed();
}
if (amount < userVesting.claimed + userVesting.locked) {
revert InvalidUserVesting();
}
if (startTime !=0&& startTime < tgeTime) revert InvalidTimestamp();
userVesting.amount = amount;
userVesting.startTime = startTime ==0 ? tgeTime : startTime;
emit UserVestingSet(categoryId, vestingId, user, amount, userVesting.startTime);
}
/**
* @notice Set veTRUF token
* @dev Only admin can set veTRUF
* @param _veTRUF veTRUF token address
*/functionsetVeTruf(address _veTRUF) externalonlyOwner{
if (_veTRUF ==address(0)) {
revert ZeroAddress();
}
veTRUF = IVotingEscrow(_veTRUF);
emit VeTrufSet(_veTRUF);
}
/**
* @notice Set admin
* @dev Only owner can set
* @param _admin admin address
* @param _flag true to set, false to remove
*/functionsetAdmin(address _admin, bool _flag) externalonlyOwner{
isAdmin[_admin] = _flag;
emit AdminSet(_admin, _flag);
}
/**
* @notice Initialize category by transferring TRUF tokens
* @param _categoryId category to initialize
*/functioninitialize(uint256 _categoryId) external{
if (isInitialized[_categoryId]) {
revert Initialized();
}
isInitialized[_categoryId] =true;
// Categories ID 0 and 7 have already been initialized previously and will be handled in `migrate` function.if (_categoryId !=0&& _categoryId !=7) {
trufToken.safeTransferFrom(msg.sender, address(this), categories[_categoryId].maxAllocation);
}
}
/**
* @notice Multicall several functions in single transaction
* @dev Could be for setting vesting categories, vesting info, and user vesting in single transaction at once
* @param payloads list of payloads
*/functionmulticall(bytes[] calldata payloads) external{
uint256 len = payloads.length;
for (uint256 i; i < len;) {
(bool success, bytesmemory result) =address(this).delegatecall(payloads[i]);
if (!success) {
if (result.length<68) revert();
assembly {
result :=add(result, 0x04)
}
revert(abi.decode(result, (string)));
}
unchecked {
i +=1;
}
}
}
/**
* @return emissions returns emission schedule of category
*/functiongetEmissionSchedule(uint256 categoryId) externalviewreturns (uint256[] memory emissions) {
emissions = emissionSchedule[categoryId];
}
/**
* @return emissionLimit returns current emission limit of category
*/functiongetEmission(uint256 categoryId) publicviewreturns (uint256 emissionLimit) {
uint64 _tgeTime = tgeTime;
if (block.timestamp>= _tgeTime) {
uint256 maxAllocation = categories[categoryId].maxAllocation;
if (emissionSchedule[categoryId].length==0) {
return maxAllocation;
}
uint64 elapsedTime =uint64(block.timestamp) - _tgeTime + ONE_MONTH;
uint64 elapsedMonth = elapsedTime / ONE_MONTH;
if (elapsedMonth >= emissionSchedule[categoryId].length) {
return maxAllocation;
}
uint256 lastMonthEmission = elapsedMonth ==0 ? 0 : emissionSchedule[categoryId][elapsedMonth -1];
uint256 thisMonthEmission = emissionSchedule[categoryId][elapsedMonth];
uint64 elapsedTimeOfLastMonth = elapsedTime % ONE_MONTH;
emissionLimit =
(thisMonthEmission - lastMonthEmission) * elapsedTimeOfLastMonth / ONE_MONTH + lastMonthEmission;
if (emissionLimit > maxAllocation) {
emissionLimit = maxAllocation;
}
}
}
/**
* @notice Stake vesting to veTRUF to get voting power and get staking TRUF rewards
* @param user user address
* @param categoryId category id
* @param vestingId vesting id
* @param amount amount to stake
* @param start lock start timestamp
* @param duration lock period in seconds
*/function_stake(address user,
uint256 categoryId,
uint256 vestingId,
uint256 amount,
uint256 start,
uint256 duration
) internal{
if (isInitialized[categoryId] ==false) revert Initialized();
if (amount ==0) {
revert ZeroAmount();
}
if (lockupIds[categoryId][vestingId][user] !=0) {
revert LockExist();
}
UserVesting storage userVesting = userVestings[categoryId][vestingId][user];
if (amount > userVesting.amount - userVesting.claimed - userVesting.locked) {
revert InvalidAmount();
}
userVesting.locked += amount;
trufToken.safeIncreaseAllowance(address(veTRUF), amount);
uint256 lockupId = veTRUF.stakeVesting(amount, duration, user, start) +1;
lockupIds[categoryId][vestingId][user] = lockupId;
emit Staked(categoryId, vestingId, user, amount, start, duration, lockupId);
}
}