Contract Source Code:
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (security/ReentrancyGuard.sol)
pragma solidity ^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].
*/
abstract contract ReentrancyGuard {
// 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.
uint256 private constant _NOT_ENTERED = 1;
uint256 private constant _ENTERED = 2;
uint256 private _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.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_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;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/draft-IERC20Permit.sol)
pragma solidity ^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.
*/
interface IERC20Permit {
/**
* @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].
*/
function permit(
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.
*/
function nonces(address owner) external view returns (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-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @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);
/**
* @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 `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, 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 `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.
*/
function transferFrom(
address from,
address to,
uint256 amount
) external returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "../IERC20.sol";
import "../extensions/draft-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.
*/
library SafeERC20 {
using Address for address;
function safeTransfer(
IERC20 token,
address to,
uint256 value
) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
function safeTransferFrom(
IERC20 token,
address from,
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.
*/
function safeApprove(
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));
}
function safeIncreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
uint256 newAllowance = token.allowance(address(this), spender) + value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
function safeDecreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
uint256 newAllowance = oldAllowance - value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
}
function safePermit(
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, bytes memory 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.
bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
if (returndata.length > 0) {
// Return data is optional
require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @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
* ====
*
* [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.
* ====
*/
function isContract(address account) internal view returns (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://diligence.consensys.net/posts/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.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable 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._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
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._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
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._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value
) internal returns (bytes memory) {
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._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
(bool success, bytes memory 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._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
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._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory 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._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
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._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory 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._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
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 contract
require(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._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.13;
import "./interfaces/IMinter.sol";
import "./interfaces/IVoter.sol";
import "./interfaces/IVotingEscrow.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
contract Bribe is ReentrancyGuard {
using SafeERC20 for IERC20;
uint256 public constant WEEK = 7 days; // rewards are released over 7 days
uint256 public firstBribeTimestamp;
/* ========== STATE VARIABLES ========== */
struct Reward {
uint256 periodFinish;
uint256 rewardsPerEpoch;
uint256 lastUpdateTime;
}
mapping(address => mapping(uint256 => Reward)) public rewardData; // token -> startTimestamp -> Reward
mapping(address => bool) public isRewardToken;
address[] public rewardTokens;
address public voter;
address public immutable bribeFactory;
address public minter;
address public immutable ve;
address public owner;
string public TYPE;
// owner -> reward token -> lastTime
mapping(address => mapping(address => uint256)) public userRewardPerTokenPaid;
mapping(address => mapping(address => uint256)) public userTimestamp;
mapping(uint256 => uint256) public safetyMargin; // transition to n+1. this mapping is for unexpected consequences regarding removal of "+ WEEK" in multiple functions
//uint256 private _totalSupply;
mapping(uint256 => uint256) private _totalSupply;
mapping(address => mapping(uint256 => uint256)) private _balances; //owner -> timestamp -> amount
/* ========== CONSTRUCTOR ========== */
constructor(address _owner,address _voter,address _bribeFactory, string memory _type) {
require(_bribeFactory != address(0) && _voter != address(0) && _owner != address(0));
voter = _voter;
bribeFactory = _bribeFactory;
firstBribeTimestamp = 0;
ve = IVoter(_voter)._ve();
minter = IVoter(_voter).minter();
require(minter != address(0));
owner = _owner;
TYPE = _type;
}
/// @notice get the current epoch
function getEpochStart() public view returns(uint256){
return IMinter(minter).active_period();
}
/// @notice get next epoch (where bribes are saved)
function getNextEpochStart() public view returns(uint256){
return getEpochStart() + WEEK;
}
/* ========== VIEWS ========== */
/// @notice get the length of the reward tokens
function rewardsListLength() external view returns(uint256) {
return rewardTokens.length;
}
/// @notice get the last totalSupply (total votes for a pool)
function totalSupply() external view returns (uint256) {
uint256 _currentEpochStart = IMinter(minter).active_period() + safetyMargin[0]; // claim until current epoch + safetyMargin
return _totalSupply[_currentEpochStart];
}
/// @notice get a totalSupply given a timestamp
function totalSupplyAt(uint256 _timestamp) external view returns (uint256) {
return _totalSupply[_timestamp];
}
/// @notice read the balanceOf the tokenId at a given timestamp
function balanceOfAt(uint256 tokenId, uint256 _timestamp) public view returns (uint256) {
address _owner = IVotingEscrow(ve).ownerOf(tokenId);
return _balances[_owner][_timestamp];
}
/// @notice get last deposit available given a tokenID
function balanceOf(uint256 tokenId) public view returns (uint256) {
uint256 _timestamp = getNextEpochStart();
address _owner = IVotingEscrow(ve).ownerOf(tokenId);
return _balances[_owner][_timestamp];
}
/// @notice get the balance of an owner in the current epoch
function balanceOfOwner(address _owner) public view returns (uint256) {
uint256 _timestamp = getNextEpochStart();
return _balances[_owner][_timestamp];
}
/// @notice get the balance of an owner given a timestamp
function balanceOfOwnerAt(address _owner, uint256 _timestamp) public view returns (uint256) {
return _balances[_owner][_timestamp];
}
/// @notice Read earned amount given a tokenID and _rewardToken
function earned(uint256 tokenId, address _rewardToken) public view returns(uint256){
uint256 k = 0;
uint256 reward = 0;
uint256 _endTimestamp = IMinter(minter).active_period() + safetyMargin[1]; // claim until current epoch + safetyMargin
address _owner = IVotingEscrow(ve).ownerOf(tokenId);
uint256 _userLastTime = userTimestamp[_owner][_rewardToken];
if(_endTimestamp == _userLastTime){
return 0;
}
// if user first time then set it to first bribe - week to avoid any timestamp problem
if(_userLastTime < firstBribeTimestamp){
_userLastTime = firstBribeTimestamp - WEEK;
}
for(k; k < 50; k++){
if(_userLastTime == _endTimestamp){
// if we reach the current epoch, exit
break;
}
reward += _earned(_owner, _rewardToken, _userLastTime);
_userLastTime += WEEK;
}
return reward;
}
/// @notice read earned amounts given an address and the reward token
function earned(address _owner, address _rewardToken) public view returns(uint256){
uint256 k = 0;
uint256 reward = 0;
uint256 _endTimestamp = IMinter(minter).active_period() + safetyMargin[2]; // claim until current epoch + safetyMargin
uint256 _userLastTime = userTimestamp[_owner][_rewardToken];
if(_endTimestamp == _userLastTime){
return 0;
}
// if user first time then set it to first bribe - week to avoid any timestamp problem
if(_userLastTime < firstBribeTimestamp){
_userLastTime = firstBribeTimestamp - WEEK;
}
for(k; k < 50; k++){
if(_userLastTime == _endTimestamp){
// if we reach the current epoch, exit
break;
}
reward += _earned(_owner, _rewardToken, _userLastTime);
_userLastTime += WEEK;
}
return reward;
}
/// @notice Read earned amount given address and reward token, returns the rewards and the last user timestamp (used in case user do not claim since 50+epochs)
function earnedWithTimestamp(address _owner, address _rewardToken) private view returns(uint256,uint256){
uint256 k = 0;
uint256 reward = 0;
uint256 _endTimestamp = IMinter(minter).active_period() + safetyMargin[3]; // claim until current epoch + safetyMargin
uint256 _userLastTime = userTimestamp[_owner][_rewardToken];
// if user first time then set it to first bribe - week to avoid any timestamp problem
if(_userLastTime < firstBribeTimestamp){
_userLastTime = firstBribeTimestamp - WEEK;
}
for(k; k < 50; k++){
if(_userLastTime == _endTimestamp){
// if we reach the current epoch, exit
break;
}
reward += _earned(_owner, _rewardToken, _userLastTime);
_userLastTime += WEEK;
}
return (reward, _userLastTime);
}
/// @notice get the earned rewards
function _earned(address _owner, address _rewardToken, uint256 _timestamp) internal view returns (uint256) {
uint256 _balance = balanceOfOwnerAt(_owner, _timestamp);
if(_balance == 0){
return 0;
} else {
uint256 _rewardPerToken = rewardPerToken(_rewardToken, _timestamp);
uint256 _rewards = _rewardPerToken * _balance / 1e36;
return _rewards;
}
}
/// @notice get the rewards for token
function rewardPerToken(address _rewardsToken, uint256 _timestamp) public view returns (uint256) {
if (_totalSupply[_timestamp] == 0) {
return rewardData[_rewardsToken][_timestamp].rewardsPerEpoch;
}
return rewardData[_rewardsToken][_timestamp].rewardsPerEpoch * 1e36 / _totalSupply[_timestamp];
}
/* ========== MUTATIVE FUNCTIONS ========== */
/// @notice User votes deposit
/// @dev called on voter.vote() or voter.poke()
/// we save into owner "address" and not "tokenID".
/// Owner must reset before transferring token
function deposit(uint256 amount, uint256 tokenId) external nonReentrant {
require(amount > 0, "Cannot stake 0");
require(msg.sender == voter);
uint256 _startTimestamp = IMinter(minter).active_period() + safetyMargin[4];
uint256 _oldSupply = _totalSupply[_startTimestamp];
address _owner = IVotingEscrow(ve).ownerOf(tokenId);
uint256 _lastBalance = _balances[_owner][_startTimestamp];
_totalSupply[_startTimestamp] = _oldSupply + amount;
_balances[_owner][_startTimestamp] = _lastBalance + amount;
emit Staked(tokenId, amount);
}
/// @notice User votes withdrawal
/// @dev called on voter.reset()
function withdraw(uint256 amount, uint256 tokenId) external nonReentrant {
require(amount > 0, "Cannot withdraw 0");
require(msg.sender == voter);
uint256 _startTimestamp = IMinter(minter).active_period() + safetyMargin[5];
address _owner = IVotingEscrow(ve).ownerOf(tokenId);
// incase of bribe contract reset in gauge proxy
if (amount <= _balances[_owner][_startTimestamp]) {
uint256 _oldSupply = _totalSupply[_startTimestamp];
uint256 _oldBalance = _balances[_owner][_startTimestamp];
_totalSupply[_startTimestamp] = _oldSupply - amount;
_balances[_owner][_startTimestamp] = _oldBalance - amount;
emit Withdrawn(tokenId, amount);
}
}
/// @notice Claim the TOKENID rewards
function getReward(uint256 tokenId, address[] memory tokens) external nonReentrant {
require(IVotingEscrow(ve).isApprovedOrOwner(msg.sender, tokenId));
uint256 _userLastTime;
uint256 reward = 0;
address _owner = IVotingEscrow(ve).ownerOf(tokenId);
for (uint256 i = 0; i < tokens.length; i++) {
address _rewardToken = tokens[i];
(reward, _userLastTime) = earnedWithTimestamp(_owner, _rewardToken);
if (reward > 0) {
IERC20(_rewardToken).safeTransfer(_owner, reward);
emit RewardPaid(_owner, _rewardToken, reward);
}
userTimestamp[_owner][_rewardToken] = _userLastTime;
}
}
/// @notice Claim the rewards given msg.sender
function getReward(address[] memory tokens) external nonReentrant {
uint256 _userLastTime;
uint256 reward = 0;
address _owner = msg.sender;
for (uint256 i = 0; i < tokens.length; i++) {
address _rewardToken = tokens[i];
(reward, _userLastTime) = earnedWithTimestamp(_owner, _rewardToken);
if (reward > 0) {
IERC20(_rewardToken).safeTransfer(_owner, reward);
emit RewardPaid(_owner, _rewardToken, reward);
}
userTimestamp[_owner][_rewardToken] = _userLastTime;
}
}
/// @notice Claim rewards from voter
function getRewardForOwner(uint256 tokenId, address[] memory tokens) public nonReentrant {
require(msg.sender == voter);
uint256 _userLastTime;
uint256 reward = 0;
address _owner = IVotingEscrow(ve).ownerOf(tokenId);
for (uint256 i = 0; i < tokens.length; i++) {
address _rewardToken = tokens[i];
(reward, _userLastTime) = earnedWithTimestamp(_owner, _rewardToken);
if (reward > 0) {
IERC20(_rewardToken).safeTransfer(_owner, reward);
emit RewardPaid(_owner, _rewardToken, reward);
}
userTimestamp[_owner][_rewardToken] = _userLastTime;
}
}
/// @notice Claim rewards from voter
function getRewardForAddress(address _owner, address[] memory tokens) public nonReentrant {
require(msg.sender == voter);
uint256 _userLastTime;
uint256 reward = 0;
for (uint256 i = 0; i < tokens.length; i++) {
address _rewardToken = tokens[i];
(reward, _userLastTime) = earnedWithTimestamp(_owner, _rewardToken);
if (reward > 0) {
IERC20(_rewardToken).safeTransfer(_owner, reward);
emit RewardPaid(_owner, _rewardToken, reward);
}
userTimestamp[_owner][_rewardToken] = _userLastTime;
}
}
/// @notice Notify a bribe amount
function notifyRewardAmount(address _rewardsToken, uint256 reward) external nonReentrant {
require(isRewardToken[_rewardsToken], "reward token not verified");
IERC20(_rewardsToken).safeTransferFrom(msg.sender,address(this),reward);
uint256 _startTimestamp = IMinter(minter).active_period() + safetyMargin[6]; //period points to the current thursday. Bribes are distributed from next epoch (thursday) + safetyMargin
if(firstBribeTimestamp == 0){
firstBribeTimestamp = _startTimestamp;
}
uint256 _lastReward = rewardData[_rewardsToken][_startTimestamp].rewardsPerEpoch;
rewardData[_rewardsToken][_startTimestamp].rewardsPerEpoch = _lastReward + reward;
rewardData[_rewardsToken][_startTimestamp].lastUpdateTime = block.timestamp;
rewardData[_rewardsToken][_startTimestamp].periodFinish = _startTimestamp + WEEK;
emit RewardAdded(_rewardsToken, reward, _startTimestamp);
}
/* ========== RESTRICTED FUNCTIONS ========== */
/// @notice add rewards tokens
function addRewardTokens(address[] memory _rewardsToken) public onlyAllowed {
uint256 i = 0;
for(i; i < _rewardsToken.length; i++){
_addRewardToken(_rewardsToken[i]);
}
}
/// @notice add a single reward token
function addRewardToken(address _rewardsToken) public onlyAllowed {
_addRewardToken(_rewardsToken);
}
function _addRewardToken(address _rewardsToken) internal {
if(!isRewardToken[_rewardsToken]){
isRewardToken[_rewardsToken] = true;
rewardTokens.push(_rewardsToken);
}
}
/// @notice Recover some ERC20 from the contract and updated given bribe
function recoverERC20AndUpdateData(address tokenAddress, uint256 tokenAmount) external onlyAllowed {
require(tokenAmount <= IERC20(tokenAddress).balanceOf(address(this)));
uint256 _startTimestamp = IMinter(minter).active_period() + safetyMargin[7];
uint256 _lastReward = rewardData[tokenAddress][_startTimestamp].rewardsPerEpoch;
rewardData[tokenAddress][_startTimestamp].rewardsPerEpoch = _lastReward - tokenAmount;
rewardData[tokenAddress][_startTimestamp].lastUpdateTime = block.timestamp;
IERC20(tokenAddress).safeTransfer(owner, tokenAmount);
emit Recovered(tokenAddress, tokenAmount);
}
/// @notice Recover some ERC20 from the contract.
/// @dev Be careful --> if called then getReward() at last epoch will fail because some reward are missing!
/// Think about calling recoverERC20AndUpdateData()
function emergencyRecoverERC20(address tokenAddress, uint256 tokenAmount) external onlyAllowed {
require(tokenAmount <= IERC20(tokenAddress).balanceOf(address(this)));
IERC20(tokenAddress).safeTransfer(owner, tokenAmount);
emit Recovered(tokenAddress, tokenAmount);
}
/// @notice Set a new voter
function setVoter(address _Voter) external onlyAllowed {
require(_Voter != address(0));
voter = _Voter;
}
/// @notice Set a new minter
function setMinter(address _minter) external onlyAllowed {
require(_minter != address(0));
minter = _minter;
}
/// @notice Set a new Owner
event SetOwner(address indexed _owner);
function setOwner(address _owner) external onlyAllowed {
require(_owner != address(0));
owner = _owner;
emit SetOwner(_owner);
}
/// @notice Set safety margin for future flexibility & fix in case of any errors
function setSafetyMargin(uint256 index, uint256 amount) external onlyAllowed {
safetyMargin[index] = amount;
}
/* ========== MODIFIERS ========== */
modifier onlyAllowed() {
require( (msg.sender == owner || msg.sender == bribeFactory), "permission is denied!" );
_;
}
/* ========== EVENTS ========== */
event RewardAdded(address indexed rewardToken, uint256 reward, uint256 startTimestamp);
event Staked(uint256 indexed tokenId, uint256 amount);
event Withdrawn(uint256 indexed tokenId, uint256 amount);
event RewardPaid(address indexed user,address indexed rewardsToken,uint256 reward);
event Recovered(address indexed token, uint256 amount);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.13;
interface IMinter {
function update_period() external returns (uint);
function check() external view returns(bool);
function period() external view returns(uint);
function active_period() external view returns(uint);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.13;
interface IVoter {
function claimBribes(address[] memory _bribes, address[][] memory _tokens, uint256 _tokenId) external;
function claimFees(address[] memory _fees, address[][] memory _tokens, uint256 _tokenId) external;
function reset(uint256 _tokenId) external;
function vote(uint256 _tokenId, address[] calldata _poolVote, uint256[] calldata _weights) external;
function poke(uint256 _tokenId) external;
function _epochTimestamp() external view returns(uint256);
function _ve() external view returns (address);
function gauges(address _pair) external view returns (address);
function isGauge(address _gauge) external view returns (bool);
function poolForGauge(address _gauge) external view returns (address);
function factory() external view returns (address);
function minter() external view returns(address);
function isWhitelisted(address token) external view returns (bool);
function notifyRewardAmount(uint amount) external;
function distributeAll() external;
function distributeFees(address[] memory _gauges) external;
function internal_bribes(address _gauge) external view returns (address);
function external_bribes(address _gauge) external view returns (address);
function usedWeights(uint id) external view returns(uint);
function lastVoted(uint id) external view returns(uint);
function poolVote(uint id, uint _index) external view returns(address _pair);
function votes(uint id, address _pool) external view returns(uint votes);
function poolVoteLength(uint tokenId) external view returns(uint);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.13;
interface IVotingEscrow {
struct Point {
int128 bias;
int128 slope; // # -dweight / dt
uint256 ts;
uint256 blk; // block
}
struct LockedBalance {
int128 amount;
uint end;
}
function create_lock(uint _value, uint _lock_duration) external returns (uint);
function create_lock_for(uint _value, uint _lock_duration, address _to) external returns (uint);
function merge(uint _from, uint _to) external;
function increase_amount(uint _tokenId, uint _value) external;
function increase_unlock_time(uint _tokenId, uint _lock_duration) external;
function split(uint[] memory amounts, uint _tokenId) external;
function withdraw(uint _tokenId) external;
function setApprovalForAll(address _operator, bool _approved) external;
function locked(uint id) external view returns(LockedBalance memory);
function tokenOfOwnerByIndex(address _owner, uint _tokenIndex) external view returns (uint);
function token() external view returns (address);
function team() external returns (address);
function epoch() external view returns (uint);
function point_history(uint loc) external view returns (Point memory);
function user_point_history(uint tokenId, uint loc) external view returns (Point memory);
function user_point_epoch(uint tokenId) external view returns (uint);
function optionToken() external view returns (address);
function ownerOf(uint) external view returns (address);
function isApprovedOrOwner(address, uint) external view returns (bool);
function transferFrom(address, address, uint) external;
function safeTransferFrom(
address _from,
address _to,
uint _tokenId
) external;
function voted(uint) external view returns (bool);
function attachments(uint) external view returns (uint);
function voting(uint tokenId) external;
function abstain(uint tokenId) external;
function attach(uint tokenId) external;
function detach(uint tokenId) external;
function checkpoint() external;
function deposit_for(uint tokenId, uint value) external;
function balanceOfNFT(uint _id) external view returns (uint);
function balanceOf(address _owner) external view returns (uint);
function totalSupply() external view returns (uint);
function supply() external view returns (uint);
function balanceOfNFTAt(uint _tokenId, uint _t) external view returns (uint);
function balanceOfAtNFT(uint _tokenId, uint _t) external view returns (uint);
function decimals() external view returns(uint8);
}