// This contract is part of Zellic’s smart contract dataset, which is a collection of publicly available contract code gathered as of March 2023. | |
// SPDX-License-Identifier: Unlicensed | |
pragma solidity ^0.8.9; | |
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); | |
} | |
// MIT | |
// OpenZeppelin Contracts (last updated v4.7.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://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.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); | |
} | |
} | |
} | |
/** | |
* @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"); | |
} | |
} | |
} | |
// MIT | |
// OpenZeppelin Contracts (last updated v4.7.0) (utils/structs/EnumerableSet.sol) | |
// This file was procedurally generated from scripts/generate/templates/EnumerableSet.js. | |
pragma solidity ^0.8.0; | |
/** | |
* @dev Library for managing | |
* https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive | |
* types. | |
* | |
* Sets have the following properties: | |
* | |
* - Elements are added, removed, and checked for existence in constant time | |
* (O(1)). | |
* - Elements are enumerated in O(n). No guarantees are made on the ordering. | |
* | |
* ``` | |
* contract Example { | |
* // Add the library methods | |
* using EnumerableSet for EnumerableSet.AddressSet; | |
* | |
* // Declare a set state variable | |
* EnumerableSet.AddressSet private mySet; | |
* } | |
* ``` | |
* | |
* As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`) | |
* and `uint256` (`UintSet`) are supported. | |
* | |
* [WARNING] | |
* ==== | |
* Trying to delete such a structure from storage will likely result in data corruption, rendering the structure | |
* unusable. | |
* See https://github.com/ethereum/solidity/pull/11843[ethereum/solidity#11843] for more info. | |
* | |
* In order to clean an EnumerableSet, you can either remove all elements one by one or create a fresh instance using an | |
* array of EnumerableSet. | |
* ==== | |
*/ | |
library EnumerableSet { | |
// To implement this library for multiple types with as little code | |
// repetition as possible, we write it in terms of a generic Set type with | |
// bytes32 values. | |
// The Set implementation uses private functions, and user-facing | |
// implementations (such as AddressSet) are just wrappers around the | |
// underlying Set. | |
// This means that we can only create new EnumerableSets for types that fit | |
// in bytes32. | |
struct Set { | |
// Storage of set values | |
bytes32[] _values; | |
// Position of the value in the `values` array, plus 1 because index 0 | |
// means a value is not in the set. | |
mapping(bytes32 => uint256) _indexes; | |
} | |
/** | |
* @dev Add a value to a set. O(1). | |
* | |
* Returns true if the value was added to the set, that is if it was not | |
* already present. | |
*/ | |
function _add(Set storage set, bytes32 value) private returns (bool) { | |
if (!_contains(set, value)) { | |
set._values.push(value); | |
// The value is stored at length-1, but we add 1 to all indexes | |
// and use 0 as a sentinel value | |
set._indexes[value] = set._values.length; | |
return true; | |
} else { | |
return false; | |
} | |
} | |
/** | |
* @dev Removes a value from a set. O(1). | |
* | |
* Returns true if the value was removed from the set, that is if it was | |
* present. | |
*/ | |
function _remove(Set storage set, bytes32 value) private returns (bool) { | |
// We read and store the value's index to prevent multiple reads from the same storage slot | |
uint256 valueIndex = set._indexes[value]; | |
if (valueIndex != 0) { | |
// Equivalent to contains(set, value) | |
// To delete an element from the _values array in O(1), we swap the element to delete with the last one in | |
// the array, and then remove the last element (sometimes called as 'swap and pop'). | |
// This modifies the order of the array, as noted in {at}. | |
uint256 toDeleteIndex = valueIndex - 1; | |
uint256 lastIndex = set._values.length - 1; | |
if (lastIndex != toDeleteIndex) { | |
bytes32 lastValue = set._values[lastIndex]; | |
// Move the last value to the index where the value to delete is | |
set._values[toDeleteIndex] = lastValue; | |
// Update the index for the moved value | |
set._indexes[lastValue] = valueIndex; // Replace lastValue's index to valueIndex | |
} | |
// Delete the slot where the moved value was stored | |
set._values.pop(); | |
// Delete the index for the deleted slot | |
delete set._indexes[value]; | |
return true; | |
} else { | |
return false; | |
} | |
} | |
/** | |
* @dev Returns true if the value is in the set. O(1). | |
*/ | |
function _contains(Set storage set, bytes32 value) private view returns (bool) { | |
return set._indexes[value] != 0; | |
} | |
/** | |
* @dev Returns the number of values on the set. O(1). | |
*/ | |
function _length(Set storage set) private view returns (uint256) { | |
return set._values.length; | |
} | |
/** | |
* @dev Returns the value stored at position `index` in the set. O(1). | |
* | |
* Note that there are no guarantees on the ordering of values inside the | |
* array, and it may change when more values are added or removed. | |
* | |
* Requirements: | |
* | |
* - `index` must be strictly less than {length}. | |
*/ | |
function _at(Set storage set, uint256 index) private view returns (bytes32) { | |
return set._values[index]; | |
} | |
/** | |
* @dev Return the entire set in an array | |
* | |
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed | |
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that | |
* this function has an unbounded cost, and using it as part of a state-changing function may render the function | |
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. | |
*/ | |
function _values(Set storage set) private view returns (bytes32[] memory) { | |
return set._values; | |
} | |
// Bytes32Set | |
struct Bytes32Set { | |
Set _inner; | |
} | |
/** | |
* @dev Add a value to a set. O(1). | |
* | |
* Returns true if the value was added to the set, that is if it was not | |
* already present. | |
*/ | |
function add(Bytes32Set storage set, bytes32 value) internal returns (bool) { | |
return _add(set._inner, value); | |
} | |
/** | |
* @dev Removes a value from a set. O(1). | |
* | |
* Returns true if the value was removed from the set, that is if it was | |
* present. | |
*/ | |
function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) { | |
return _remove(set._inner, value); | |
} | |
/** | |
* @dev Returns true if the value is in the set. O(1). | |
*/ | |
function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) { | |
return _contains(set._inner, value); | |
} | |
/** | |
* @dev Returns the number of values in the set. O(1). | |
*/ | |
function length(Bytes32Set storage set) internal view returns (uint256) { | |
return _length(set._inner); | |
} | |
/** | |
* @dev Returns the value stored at position `index` in the set. O(1). | |
* | |
* Note that there are no guarantees on the ordering of values inside the | |
* array, and it may change when more values are added or removed. | |
* | |
* Requirements: | |
* | |
* - `index` must be strictly less than {length}. | |
*/ | |
function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) { | |
return _at(set._inner, index); | |
} | |
/** | |
* @dev Return the entire set in an array | |
* | |
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed | |
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that | |
* this function has an unbounded cost, and using it as part of a state-changing function may render the function | |
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. | |
*/ | |
function values(Bytes32Set storage set) internal view returns (bytes32[] memory) { | |
bytes32[] memory store = _values(set._inner); | |
bytes32[] memory result; | |
/// @solidity memory-safe-assembly | |
assembly { | |
result := store | |
} | |
return result; | |
} | |
// AddressSet | |
struct AddressSet { | |
Set _inner; | |
} | |
/** | |
* @dev Add a value to a set. O(1). | |
* | |
* Returns true if the value was added to the set, that is if it was not | |
* already present. | |
*/ | |
function add(AddressSet storage set, address value) internal returns (bool) { | |
return _add(set._inner, bytes32(uint256(uint160(value)))); | |
} | |
/** | |
* @dev Removes a value from a set. O(1). | |
* | |
* Returns true if the value was removed from the set, that is if it was | |
* present. | |
*/ | |
function remove(AddressSet storage set, address value) internal returns (bool) { | |
return _remove(set._inner, bytes32(uint256(uint160(value)))); | |
} | |
/** | |
* @dev Returns true if the value is in the set. O(1). | |
*/ | |
function contains(AddressSet storage set, address value) internal view returns (bool) { | |
return _contains(set._inner, bytes32(uint256(uint160(value)))); | |
} | |
/** | |
* @dev Returns the number of values in the set. O(1). | |
*/ | |
function length(AddressSet storage set) internal view returns (uint256) { | |
return _length(set._inner); | |
} | |
/** | |
* @dev Returns the value stored at position `index` in the set. O(1). | |
* | |
* Note that there are no guarantees on the ordering of values inside the | |
* array, and it may change when more values are added or removed. | |
* | |
* Requirements: | |
* | |
* - `index` must be strictly less than {length}. | |
*/ | |
function at(AddressSet storage set, uint256 index) internal view returns (address) { | |
return address(uint160(uint256(_at(set._inner, index)))); | |
} | |
/** | |
* @dev Return the entire set in an array | |
* | |
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed | |
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that | |
* this function has an unbounded cost, and using it as part of a state-changing function may render the function | |
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. | |
*/ | |
function values(AddressSet storage set) internal view returns (address[] memory) { | |
bytes32[] memory store = _values(set._inner); | |
address[] memory result; | |
/// @solidity memory-safe-assembly | |
assembly { | |
result := store | |
} | |
return result; | |
} | |
// UintSet | |
struct UintSet { | |
Set _inner; | |
} | |
/** | |
* @dev Add a value to a set. O(1). | |
* | |
* Returns true if the value was added to the set, that is if it was not | |
* already present. | |
*/ | |
function add(UintSet storage set, uint256 value) internal returns (bool) { | |
return _add(set._inner, bytes32(value)); | |
} | |
/** | |
* @dev Removes a value from a set. O(1). | |
* | |
* Returns true if the value was removed from the set, that is if it was | |
* present. | |
*/ | |
function remove(UintSet storage set, uint256 value) internal returns (bool) { | |
return _remove(set._inner, bytes32(value)); | |
} | |
/** | |
* @dev Returns true if the value is in the set. O(1). | |
*/ | |
function contains(UintSet storage set, uint256 value) internal view returns (bool) { | |
return _contains(set._inner, bytes32(value)); | |
} | |
/** | |
* @dev Returns the number of values in the set. O(1). | |
*/ | |
function length(UintSet storage set) internal view returns (uint256) { | |
return _length(set._inner); | |
} | |
/** | |
* @dev Returns the value stored at position `index` in the set. O(1). | |
* | |
* Note that there are no guarantees on the ordering of values inside the | |
* array, and it may change when more values are added or removed. | |
* | |
* Requirements: | |
* | |
* - `index` must be strictly less than {length}. | |
*/ | |
function at(UintSet storage set, uint256 index) internal view returns (uint256) { | |
return uint256(_at(set._inner, index)); | |
} | |
/** | |
* @dev Return the entire set in an array | |
* | |
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed | |
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that | |
* this function has an unbounded cost, and using it as part of a state-changing function may render the function | |
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. | |
*/ | |
function values(UintSet storage set) internal view returns (uint256[] memory) { | |
bytes32[] memory store = _values(set._inner); | |
uint256[] memory result; | |
/// @solidity memory-safe-assembly | |
assembly { | |
result := store | |
} | |
return result; | |
} | |
} | |
pragma solidity ^0.8.9; | |
// MIT | |
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol) | |
pragma solidity ^0.8.0; | |
/** | |
* @dev Provides information about the current execution context, including the | |
* sender of the transaction and its data. While these are generally available | |
* via msg.sender and msg.data, they should not be accessed in such a direct | |
* manner, since when dealing with meta-transactions the account sending and | |
* paying for execution may not be the actual sender (as far as an application | |
* is concerned). | |
* | |
* This contract is only required for intermediate, library-like contracts. | |
*/ | |
abstract contract Context { | |
function _msgSender() internal view virtual returns (address) { | |
return msg.sender; | |
} | |
function _msgData() internal view virtual returns (bytes calldata) { | |
return msg.data; | |
} | |
} | |
// 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); | |
} | |
// MIT | |
// OpenZeppelin Contracts (last updated v4.7.0) (utils/Address.sol) | |
pragma solidity ^0.8.1; | |
// MIT | |
// OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol) | |
pragma solidity ^0.8.0; | |
/** | |
* @dev Contract module which provides a basic access control mechanism, where | |
* there is an account (an owner) that can be granted exclusive access to | |
* specific functions. | |
* | |
* By default, the owner account will be the one that deploys the contract. This | |
* can later be changed with {transferOwnership}. | |
* | |
* This module is used through inheritance. It will make available the modifier | |
* `onlyOwner`, which can be applied to your functions to restrict their use to | |
* the owner. | |
*/ | |
abstract contract Ownable is Context { | |
address private _owner; | |
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); | |
/** | |
* @dev Initializes the contract setting the deployer as the initial owner. | |
*/ | |
constructor() { | |
_transferOwnership(_msgSender()); | |
} | |
/** | |
* @dev Throws if called by any account other than the owner. | |
*/ | |
modifier onlyOwner() { | |
_checkOwner(); | |
_; | |
} | |
/** | |
* @dev Returns the address of the current owner. | |
*/ | |
function owner() public view virtual returns (address) { | |
return _owner; | |
} | |
/** | |
* @dev Throws if the sender is not the owner. | |
*/ | |
function _checkOwner() internal view virtual { | |
require(owner() == _msgSender(), "Ownable: caller is not the owner"); | |
} | |
/** | |
* @dev Leaves the contract without owner. It will not be possible to call | |
* `onlyOwner` functions anymore. Can only be called by the current owner. | |
* | |
* NOTE: Renouncing ownership will leave the contract without an owner, | |
* thereby removing any functionality that is only available to the owner. | |
*/ | |
function renounceOwnership() public virtual onlyOwner { | |
_transferOwnership(address(0)); | |
} | |
/** | |
* @dev Transfers ownership of the contract to a new account (`newOwner`). | |
* Can only be called by the current owner. | |
*/ | |
function transferOwnership(address newOwner) public virtual onlyOwner { | |
require(newOwner != address(0), "Ownable: new owner is the zero address"); | |
_transferOwnership(newOwner); | |
} | |
/** | |
* @dev Transfers ownership of the contract to a new account (`newOwner`). | |
* Internal function without access restriction. | |
*/ | |
function _transferOwnership(address newOwner) internal virtual { | |
address oldOwner = _owner; | |
_owner = newOwner; | |
emit OwnershipTransferred(oldOwner, newOwner); | |
} | |
} | |
error InsufficientBalance(uint256 available, uint256 required); | |
error InvalidPool(); | |
error NothingToDo(); | |
contract BullRunStaking is Ownable { | |
using SafeERC20 for IERC20; | |
struct UserInfo { | |
uint256 amount; | |
uint256 rewardDebt; | |
uint256 startTime; | |
uint256 totalRewards; | |
} | |
struct PoolInfo { | |
IERC20 token; | |
uint256 lastRewardTimestamp; | |
uint256 accBRLPerShare; | |
uint256 balance; | |
uint256 rewardSupply; | |
uint256 brlPerSecond; | |
} | |
IERC20 public brl; | |
uint256 public brlPoolIndex; | |
address public bulldozer; | |
PoolInfo[] public poolInfo; | |
mapping(uint256 => mapping(address => UserInfo)) public userInfo; | |
uint256 public startTime; | |
event Deposit(address indexed user, uint256 indexed pid, uint256 amount); | |
event Compound(address indexed user, uint256 indexed pid, uint256 amount); | |
event Withdraw(address indexed user, uint256 indexed pid, uint256 amount); | |
event EmergencyWithdraw( | |
address indexed user, | |
uint256 indexed pid, | |
uint256 amount | |
); | |
constructor(IERC20 _brl, uint256 _startTime, address _bulldozer) { | |
brl = _brl; | |
startTime = _startTime; | |
bulldozer = _bulldozer; | |
} | |
function poolLength() external view returns (uint256) { | |
return poolInfo.length; | |
} | |
function add(IERC20 _token, uint256 _rewardSupply, uint256 _brlPerSecond) public onlyOwner { | |
uint256 lastRewardTimestamp = block.timestamp > startTime ? block.timestamp : startTime; | |
uint256 balBefore = brl.balanceOf(address(this)); | |
brl.transferFrom(msg.sender, address(this), _rewardSupply); | |
uint256 amountReceived = brl.balanceOf(address(this)) - balBefore; | |
poolInfo.push( | |
PoolInfo({ | |
token: _token, | |
lastRewardTimestamp: lastRewardTimestamp, | |
accBRLPerShare: 0, | |
balance: 0, | |
rewardSupply: amountReceived, | |
brlPerSecond: _brlPerSecond | |
}) | |
); | |
} | |
function setRewardRate(uint256 _pid, uint256 _brlPerSecond) public onlyOwner { | |
poolInfo[_pid].brlPerSecond = _brlPerSecond; | |
} | |
function supplyRewards(uint256 _pid, uint256 _amount) external { | |
uint256 balBefore = brl.balanceOf(address(this)); | |
brl.transferFrom(msg.sender, address(this), _amount); | |
uint256 amountReceived = brl.balanceOf(address(this)) - balBefore; | |
poolInfo[_pid].rewardSupply += amountReceived; | |
} | |
function pendingBRL(uint256 _pid, address _user) external view returns (uint256) | |
{ | |
PoolInfo storage pool = poolInfo[_pid]; | |
UserInfo storage user = userInfo[_pid][_user]; | |
uint256 accBRLPerShare = pool.accBRLPerShare; | |
uint256 balance = pool.balance; | |
uint256 lastRewardTimestamp = pool.lastRewardTimestamp; | |
if (block.timestamp > lastRewardTimestamp && balance != 0) { | |
uint256 brlReward = (block.timestamp - lastRewardTimestamp) * pool.brlPerSecond; | |
accBRLPerShare += (brlReward * 1e12 / balance); | |
} | |
return (user.amount * accBRLPerShare / 1e12) - user.rewardDebt; | |
} | |
function massUpdatePools() public { | |
uint256 length = poolInfo.length; | |
for (uint256 pid = 0; pid < length; ++pid) { | |
updatePool(pid); | |
} | |
} | |
function updatePool(uint256 _pid) public { | |
PoolInfo storage pool = poolInfo[_pid]; | |
uint256 timestamp = block.timestamp; | |
if (timestamp <= pool.lastRewardTimestamp) { | |
return; | |
} | |
uint256 balance = pool.balance; | |
if (balance == 0) { | |
pool.lastRewardTimestamp = timestamp; | |
return; | |
} | |
uint256 brlReward = (timestamp - pool.lastRewardTimestamp) * pool.brlPerSecond; | |
pool.accBRLPerShare += (brlReward * 1e12 / balance); | |
pool.lastRewardTimestamp = timestamp; | |
} | |
function deposit(uint256 _pid, uint256 _amount) external { | |
PoolInfo storage pool = poolInfo[_pid]; | |
UserInfo storage user = userInfo[_pid][msg.sender]; | |
updatePool(_pid); | |
if (user.amount > 0) { | |
uint256 pending = (user.amount * pool.accBRLPerShare / 1e12) - user.rewardDebt; | |
uint256 amountTransferred = safeBRLTransfer(msg.sender, pending, pool.rewardSupply); | |
pool.rewardSupply -= amountTransferred; | |
user.totalRewards += amountTransferred; | |
} | |
uint256 beforeBal = pool.token.balanceOf(address(this)); | |
pool.token.safeTransferFrom(address(msg.sender), address(this), _amount); | |
uint256 amountReceived = pool.token.balanceOf(address(this)) - beforeBal; | |
//take fees | |
uint256 fee = amountReceived / 50; | |
pool.token.safeTransfer(bulldozer, fee); | |
amountReceived -= fee; | |
//for apy calculations | |
if (user.amount == 0) { | |
user.startTime = block.timestamp; | |
user.totalRewards = 0; | |
} | |
//update balances | |
pool.balance += amountReceived; | |
user.amount += amountReceived; | |
user.rewardDebt = user.amount * pool.accBRLPerShare / 1e12; | |
emit Deposit(msg.sender, _pid, _amount); | |
} | |
function compound(uint256 _pid) external { | |
PoolInfo storage pool = poolInfo[_pid]; | |
UserInfo storage user = userInfo[_pid][msg.sender]; | |
updatePool(_pid); | |
uint256 pending = (user.amount * pool.accBRLPerShare / 1e12) - user.rewardDebt; | |
if (pending == 0) { | |
revert NothingToDo(); | |
} | |
uint256 rewardSupply = pool.rewardSupply; | |
uint256 paidRewards = pending > rewardSupply ? rewardSupply : pending; | |
pool.rewardSupply -= paidRewards; | |
user.totalRewards += paidRewards; | |
user.rewardDebt = user.amount * pool.accBRLPerShare / 1e12; | |
uint256 totalCompounded = _compound(paidRewards); | |
emit Compound(msg.sender, _pid, totalCompounded); | |
} | |
function _compound(uint256 _amount) internal returns (uint256) { | |
PoolInfo storage pool = poolInfo[brlPoolIndex]; | |
UserInfo storage user = userInfo[brlPoolIndex][msg.sender]; | |
updatePool(brlPoolIndex); | |
uint256 paidRewards; | |
if (user.amount > 0) { | |
uint256 pending = (user.amount * pool.accBRLPerShare / 1e12) - user.rewardDebt; | |
paidRewards = pending > pool.rewardSupply ? pool.rewardSupply : pending; | |
pool.rewardSupply -= paidRewards; | |
user.totalRewards += paidRewards; | |
} | |
uint256 sum = _amount + paidRewards; | |
pool.balance += sum; | |
user.amount += sum; | |
user.rewardDebt = user.amount * pool.accBRLPerShare / 1e12; | |
return sum; | |
} | |
function withdraw(uint256 _pid, uint256 _amount) external { | |
PoolInfo storage pool = poolInfo[_pid]; | |
UserInfo storage user = userInfo[_pid][msg.sender]; | |
if (_amount > user.amount) { | |
revert InsufficientBalance(user.amount, _amount); | |
} | |
updatePool(_pid); | |
uint256 pending = (user.amount * pool.accBRLPerShare / 1e12) - user.rewardDebt; | |
uint256 amountTransferred = safeBRLTransfer(msg.sender, pending, pool.rewardSupply); | |
pool.rewardSupply -= amountTransferred; | |
user.totalRewards += amountTransferred; | |
pool.balance -= _amount; | |
user.amount -= _amount; | |
user.rewardDebt = user.amount * pool.accBRLPerShare / 1e12; | |
//take fees | |
uint256 fee = _amount / 20; | |
_amount -= fee; | |
pool.token.safeTransfer(bulldozer, fee); | |
pool.token.safeTransfer(address(msg.sender), _amount); | |
emit Withdraw(msg.sender, _pid, _amount); | |
} | |
function emergencyWithdraw(uint256 _pid) external { | |
PoolInfo storage pool = poolInfo[_pid]; | |
UserInfo storage user = userInfo[_pid][msg.sender]; | |
uint256 amount = user.amount; | |
pool.balance -= amount; | |
user.amount = 0; | |
user.rewardDebt = 0; | |
pool.token.safeTransfer(address(msg.sender), amount); | |
emit EmergencyWithdraw(msg.sender, _pid, amount); | |
} | |
function safeBRLTransfer(address _to, uint256 _amount, uint256 _rewardSupply) internal returns (uint256) { | |
uint256 amountToSend = _amount > _rewardSupply ? _rewardSupply : _amount; | |
brl.transfer(_to, amountToSend); | |
return amountToSend; | |
} | |
function setBRLPoolIndex(uint256 _pid) external onlyOwner { | |
PoolInfo storage pool = poolInfo[_pid]; | |
if (pool.token != brl) { | |
revert InvalidPool(); | |
} | |
brlPoolIndex = _pid; | |
} | |
function setBulldozer(address wallet) external onlyOwner { | |
bulldozer = wallet; | |
} | |
} |