Description:
Proxy contract enabling upgradeable smart contract patterns. Delegates calls to an implementation contract.
Blockchain: Ethereum
Source Code: View Code On The Blockchain
Solidity Source Code:
{{
"language": "Solidity",
"sources": {
"@openzeppelin/contracts/token/ERC20/extensions/IERC20Permit.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.4) (token/ERC20/extensions/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.
*
* ==== Security Considerations
*
* There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
* expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
* considered as an intention to spend the allowance in any specific way. The second is that because permits have
* built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
* take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
* generally recommended is:
*
* ```solidity
* function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
* try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
* doThing(..., value);
* }
*
* function doThing(..., uint256 value) public {
* token.safeTransferFrom(msg.sender, address(this), value);
* ...
* }
* ```
*
* Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
* `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
* {SafeERC20-safeTransferFrom}).
*
* Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
* contracts should have entry points that don't rely on permit.
*/
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].
*
* CAUTION: See Security Considerations above.
*/
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);
}
"
},
"@openzeppelin/contracts/token/ERC20/IERC20.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.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);
}
"
},
"@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.3) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^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.
*/
library SafeERC20 {
using Address for address;
/**
* @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.
*/
function safeTransfer(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.
*/
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));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeIncreaseAllowance(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.
*/
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");
_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.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
bytes memory 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.
*/
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");
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, bytes memory data) private returns (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, bytes memory returndata) = address(token).call(data);
return
success && (returndata.length == 0 || abi.decode(returndata, (bool))) && Address.isContract(address(token));
}
}
"
},
"@openzeppelin/contracts/utils/Address.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.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
*
* 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.
* ====
*/
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.8.0/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);
}
}
}
"
},
"@openzeppelin/contracts/utils/math/SafeMath.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/math/SafeMath.sol)
pragma solidity ^0.8.0;
// CAUTION
// This version of SafeMath should only be used with Solidity 0.8 or later,
// because it relies on the compiler's built in overflow checks.
/**
* @dev Wrappers over Solidity's arithmetic operations.
*
* NOTE: `SafeMath` is generally not needed starting with Solidity 0.8, since the compiler
* now has built in overflow checking.
*/
library SafeMath {
/**
* @dev Returns the addition of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
uint256 c = a + b;
if (c < a) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the subtraction of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b > a) return (false, 0);
return (true, a - b);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
if (a == 0) return (true, 0);
uint256 c = a * b;
if (c / a != b) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the division of two unsigned integers, with a division by zero flag.
*
* _Available since v3.4._
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b == 0) return (false, 0);
return (true, a / b);
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
*
* _Available since v3.4._
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b == 0) return (false, 0);
return (true, a % b);
}
}
/**
* @dev Returns the addition of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `+` operator.
*
* Requirements:
*
* - Addition cannot overflow.
*/
function add(uint256 a, uint256 b) internal pure returns (uint256) {
return a + b;
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting on
* overflow (when the result is negative).
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/
function sub(uint256 a, uint256 b) internal pure returns (uint256) {
return a - b;
}
/**
* @dev Returns the multiplication of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `*` operator.
*
* Requirements:
*
* - Multiplication cannot overflow.
*/
function mul(uint256 a, uint256 b) internal pure returns (uint256) {
return a * b;
}
/**
* @dev Returns the integer division of two unsigned integers, reverting on
* division by zero. The result is rounded towards zero.
*
* Counterpart to Solidity's `/` operator.
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function div(uint256 a, uint256 b) internal pure returns (uint256) {
return a / b;
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* reverting when dividing by zero.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function mod(uint256 a, uint256 b) internal pure returns (uint256) {
return a % b;
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on
* overflow (when the result is negative).
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {trySub}.
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/
function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
unchecked {
require(b <= a, errorMessage);
return a - b;
}
}
/**
* @dev Returns the integer division of two unsigned integers, reverting with custom message on
* division by zero. The result is rounded towards zero.
*
* Counterpart to Solidity's `/` operator. Note: this function uses a
* `revert` opcode (which leaves remaining gas untouched) while Solidity
* uses an invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
unchecked {
require(b > 0, errorMessage);
return a / b;
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* reverting with custom message when dividing by zero.
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {tryMod}.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
unchecked {
require(b > 0, errorMessage);
return a % b;
}
}
}
"
},
"contracts/base/IncentivesGeneral.sol": {
"content": "// SPDX-License-Identifier: Unlicense
pragma solidity 0.8.26;
import "@openzeppelin/contracts/utils/math/SafeMath.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "./inheritance/Controllable.sol";
import "./interface/IERC4626.sol";
import "./interface/IVault.sol";
contract IncentivesGeneral is Controllable {
using SafeERC20 for IERC20;
using SafeMath for uint256;
event IncentiveAdded(address indexed vault, address indexed token, uint256 amount, uint256 duration);
event IncentiveRemoved(address indexed strategy, address indexed token, uint256 claimed, uint256 returned, address receiver);
event IncentiveClaimed(address indexed strategy, address indexed token, uint256 amount);
struct IncentiveInfo {
address vault;
address strategy;
address token;
uint256 perSecond;
uint256 lastTime;
uint256 endTime;
}
mapping(address => IncentiveInfo[]) public strategyIncentives;
constructor(address _storage) Controllable(_storage) {}
function addIncentive(address _vault, address _token, uint256 _amount, uint256 _duration) public onlyGovernance {
require(_amount > 0, "Amount must be greater than zero");
require(_duration > 0, "Duration must be greater than zero");
IERC20(_token).safeTransferFrom(msg.sender, address(this), _amount);
uint256 perSecond = _amount.div(_duration);
address strategy = IVault(_vault).strategy();
strategyIncentives[strategy].push(IncentiveInfo({
vault: _vault,
strategy: strategy,
token: _token,
perSecond: perSecond,
lastTime: block.timestamp,
endTime: block.timestamp.add(_duration)
}));
emit IncentiveAdded(_vault, _token, _amount, _duration);
}
function removeIncentive(address _strategy, uint256 _index, address _receiver) public onlyGovernance {
require(_index < strategyIncentives[_strategy].length, "Invalid index");
require(_receiver != address(0), "Receiver cannot be zero address");
IncentiveInfo storage incentive = strategyIncentives[_strategy][_index];
uint256 timeElapsed = block.timestamp.sub(incentive.lastTime);
uint256 amountToClaim = incentive.perSecond.mul(timeElapsed);
uint256 amountToReturn;
if (block.timestamp < incentive.endTime) {
amountToReturn = incentive.perSecond.mul(incentive.endTime.sub(block.timestamp));
} else {
amountToReturn = 0;
}
// Remove the incentive from the list
strategyIncentives[_strategy][_index] = strategyIncentives[_strategy][strategyIncentives[_strategy].length - 1];
strategyIncentives[_strategy].pop();
IERC20(incentive.token).safeTransfer(incentive.strategy, amountToClaim);
IERC20(incentive.token).safeTransfer(_receiver, amountToReturn);
emit IncentiveRemoved(_strategy, incentive.token, amountToClaim, amountToReturn, _receiver);
}
function claim() public {
IncentiveInfo[] storage incentives = strategyIncentives[msg.sender];
uint256 i = 0;
while ( i < incentives.length) {
IncentiveInfo storage incentive = incentives[i];
if (block.timestamp > incentive.lastTime && block.timestamp < incentive.endTime) {
uint256 timeElapsed = block.timestamp.sub(incentive.lastTime);
uint256 amountToClaim = incentive.perSecond.mul(timeElapsed);
incentive.lastTime = block.timestamp;
IERC20(incentive.token).safeTransfer(msg.sender, amountToClaim);
emit IncentiveClaimed(msg.sender, incentive.token, amountToClaim);
i++;
} else if (block.timestamp >= incentive.endTime) {
uint256 timeElapsed = incentive.endTime.sub(incentive.lastTime);
uint256 amountToClaim = incentive.perSecond.mul(timeElapsed);
incentives[i] = incentives[incentives.length - 1];
incentives.pop();
IERC20(incentive.token).safeTransfer(msg.sender, amountToClaim);
emit IncentiveClaimed(msg.sender, incentive.token, amountToClaim);
} else {
i++;
}
}
}
function salvage(address _token, uint256 _amount) public onlyGovernance {
IERC20(_token).safeTransfer(governance(), _amount);
}
function pendingFor(address strategy, uint256 idx) external view returns (uint256) {
IncentiveInfo storage inf = strategyIncentives[strategy][idx];
uint256 until = block.timestamp < inf.endTime ? block.timestamp : inf.endTime;
return inf.perSecond * (until - inf.lastTime);
}
function activeIncentives(address strategy) external view returns (uint256) {
return strategyIncentives[strategy].length;
}
}
"
},
"contracts/base/inheritance/Controllable.sol": {
"content": "//SPDX-License-Identifier: Unlicense
pragma solidity 0.8.26;
import "./Governable.sol";
contract Controllable is Governable {
constructor(address _storage) Governable(_storage) {
}
modifier onlyController() {
require(store.isController(msg.sender), "Not a controller");
_;
}
modifier onlyControllerOrGovernance(){
require((store.isController(msg.sender) || store.isGovernance(msg.sender)),
"The caller must be controller or governance");
_;
}
function controller() public view returns (address) {
return store.controller();
}
}
"
},
"contracts/base/inheritance/Governable.sol": {
"content": "//SPDX-License-Identifier: Unlicense
pragma solidity 0.8.26;
import "./Storage.sol";
contract Governable {
Storage public store;
constructor(address _store) {
require(_store != address(0), "new storage shouldn't be empty");
store = Storage(_store);
}
modifier onlyGovernance() {
require(store.isGovernance(msg.sender), "Not governance");
_;
}
function setStorage(address _store) public onlyGovernance {
require(_store != address(0), "new storage shouldn't be empty");
store = Storage(_store);
}
function governance() public view returns (address) {
return store.governance();
}
}
"
},
"contracts/base/inheritance/Storage.sol": {
"content": "//SPDX-License-Identifier: Unlicense
pragma solidity 0.8.26;
contract Storage {
address public governance;
address public controller;
constructor() {
governance = msg.sender;
}
modifier onlyGovernance() {
require(isGovernance(msg.sender), "Not governance");
_;
}
function setGovernance(address _governance) public onlyGovernance {
require(_governance != address(0), "new governance shouldn't be empty");
governance = _governance;
}
function setController(address _controller) public onlyGovernance {
require(_controller != address(0), "new controller shouldn't be empty");
controller = _controller;
}
function isGovernance(address account) public view returns (bool) {
return account == governance;
}
function isController(address account) public view returns (bool) {
return account == controller;
}
}
"
},
"contracts/base/interface/IERC4626.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity 0.8.26;
interface IERC4626 {
// ========================= Events =========================
/**
* Caller has exchanged assets for shares, and transferred those shares to owner.
*
* MUST be emitted when tokens are deposited into the Vault via the mint and deposit methods.
*/
event Deposit(
address indexed sender,
address indexed receiver,
uint256 assets,
uint256 shares
);
/**
* Caller has exchanged shares, owned by owner, for assets, and transferred those assets to receiver.
*
* MUST be emitted when shares are withdrawn from the Vault in ERC4626.redeem or ERC4626.withdraw methods.
*/
event Withdraw(
address indexed sender,
address indexed receiver,
address indexed owner,
uint256 assets,
uint256 shares
);
// ========================= Functions =========================
/**
* @return assetTokenAddress The address of the underlying token used for the Vault for accounting, depositing, and withdrawing.
*/
function asset() external view returns (address assetTokenAddress);
/**
* @return totalManagedAssets Total amount of the underlying asset that is “managed” by Vault. SHOULD include any compounding that
* occurs from yield. MUST be inclusive of any fees that are charged against assets in the Vault.
*/
function totalAssets() external view returns (uint256 totalManagedAssets);
/**
* @return assetsPerUnitShare The amount of underlying the Vault would exchange for 1 unit of shares, in an ideal scenario where all
* the conditions are met. MUST NOT be inclusive of any fees that are charged against assets in the Vault.
* MUST NOT show any variations depending on the caller. MUST NOT reflect slippage or other on-chain
* conditions, when performing the actual exchange. MUST NOT revert unless due to integer overflow caused
* by an unreasonably large input. MUST round down towards 0. This calculation MAY NOT reflect the
* “per-user” price-per-share, and instead should reflect the “average-user’s” price-per-share, meaning
* what the average user should expect to see when exchanging to and from. This function should normally
* return more than `10 ** underlying().decimals`.
*/
function assetsPerShare() external view returns (uint256 assetsPerUnitShare);
/**
* @return assets Total amount of the underlying asset that is “managed” by Vault for the `depositor`. SHOULD include any
* compounding that occurs from yield. MUST be inclusive of any fees that are charged against assets in the
* Vault.
*/
function assetsOf(address depositor) external view returns (uint256 assets);
/**
* Maximum amount of the underlying asset that can be deposited into the Vault for the receiver, through a deposit
* call. MUST return the maximum amount of assets deposit would allow to be deposited for receiver and not cause a
* revert, which MUST NOT be higher than the actual maximum that would be accepted (it should underestimate if
* necessary). This assumes that the user has infinite assets, i.e. MUST NOT rely on balanceOf of asset. MUST factor
* in both global and user-specific limits, like if deposits are entirely disabled (even temporarily) it MUST return
* 0. MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of assets that may be deposited.
*/
function maxDeposit(address caller) external view returns (uint256 maxAssets);
/**
* Allows an on-chain or off-chain user to simulate the effects of their deposit at the current block, given current
* on-chain conditions.
*
* MUST return as close to and no more than the exact amount of Vault shares that would be
* minted in a deposit call in the same transaction. I.e. deposit should return the same or more shares as
* previewDeposit if called in the same transaction. MUST NOT account for deposit limits like those returned from
* maxDeposit and should always act as though the deposit would be accepted, regardless if the user has enough
* tokens approved, etc.
*
* MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
*
* MUST NOT revert due to vault specific user/global limits. MAY revert due to other conditions that would also
* cause deposit to revert.
*
* Note that any unfavorable discrepancy between convertToShares and previewDeposit SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by depositing.
*/
function previewDeposit(uint256 assets) external view returns (uint256 shares);
/**
* Mints shares Vault shares to receiver by depositing exactly amount of underlying tokens.
*
* MUST emit the Deposit event.
*
* MUST support ERC-20 approve / transferFrom on asset as a deposit flow. MAY support an additional flow in which
* the underlying tokens are owned by the Vault contract before the deposit execution, and are accounted for during
* deposit.
*
* MUST revert if all of assets cannot be deposited (due to deposit limit being reached, slippage, the user not
* approving enough underlying tokens to the Vault contract, etc).
*
* Note that most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
*/
function deposit(uint256 assets, address receiver) external returns (uint256 shares);
/**
* Maximum amount of shares that can be minted from the Vault for the receiver, through a mint call.
*
* MUST return the maximum amount of shares mint would allow to be deposited to receiver and not cause a revert,
* which MUST NOT be higher than the actual maximum that would be accepted (it should underestimate if necessary).
* This assumes that the user has infinite assets, i.e. MUST NOT rely on balanceOf of asset.
*
* MUST factor in both global and user-specific limits, like if mints are entirely disabled (even temporarily) it
* MUST return 0.
*
* MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of shares that may be minted.
*/
function maxMint(address caller) external view returns (uint256 maxShares);
/**
* Allows an on-chain or off-chain user to simulate the effects of their mint at the current block, given current
* on-chain conditions.
*
* MUST return as close to and no fewer than the exact amount of assets that would be deposited in a mint call in
* the same transaction. I.e. mint should return the same or fewer assets as previewMint if called in the same
* transaction.
*
* MUST NOT account for mint limits like those returned from maxMint and should always act as though the mint would
* be accepted, regardless if the user has enough tokens approved, etc.
*
* MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
*
* MUST NOT revert due to vault specific user/global limits. MAY revert due to other conditions that would also
* cause mint to revert.
*
* Note that any unfavorable discrepancy between convertToAssets and previewMint SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by minting.
*/
function previewMint(uint256 shares) external view returns (uint256 assets);
/**
* Mints exactly shares Vault shares to receiver by depositing amount of underlying tokens.
*
* MUST emit the Deposit event.
*
* MUST support ERC-20 approve / transferFrom on asset as a mint flow. MAY support an additional flow in which the
* underlying tokens are owned by the Vault contract before the mint execution, and are accounted for during mint.
*
* MUST revert if all of shares cannot be minted (due to deposit limit being reached, slippage, the user not
* approving enough underlying tokens to the Vault contract, etc).
*
* Note that most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
*/
function mint(uint256 shares, address receiver) external returns (uint256 assets);
/**
* Maximum amount of the underlying asset that can be withdrawn from the owner balance in the Vault, through a
* withdraw call.
*
* MUST return the maximum amount of assets that could be transferred from owner through withdraw and not cause a
* revert, which MUST NOT be higher than the actual maximum that would be accepted (it should underestimate if
* necessary).
*
* MUST factor in both global and user-specific limits, like if withdrawals are entirely disabled (even temporarily)
* it MUST return 0.
*/
function maxWithdraw(address caller) external view returns (uint256 maxAssets);
/**
* Allows an on-chain or off-chain user to simulate the effects of their withdrawal at the current block, given
* current on-chain conditions.
*
* MUST return as close to and no fewer than the exact amount of Vault shares that would be burned in a withdraw
* call in the same transaction. I.e. withdraw should return the same or fewer shares as previewWithdraw if called
* in the same transaction.
*
* MUST NOT account for withdrawal limits like those returned from maxWithdraw and should always act as though the
* withdrawal would be accepted, regardless if the user has enough shares, etc.
*
* MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
*
* MUST NOT revert due to vault specific user/global limits. MAY revert due to other conditions that would also
* cause withdraw to revert.
*
* Note that any unfavorable discrepancy between convertToShares and previewWithdraw SHOULD be considered slippage
* in share price or some other type of condition, meaning the depositor will lose assets by depositing.
*/
function previewWithdraw(uint256 assets) external view returns (uint256 shares);
/**
* Burns shares from owner and sends exactly assets of underlying tokens to receiver.
*
* MUST emit the Withdraw event.
*
* MUST support a withdraw flow where the shares are burned from owner directly where owner is msg.sender or
* msg.sender has ERC-20 approval over the shares of owner. MAY support an additional flow in which the shares are
* transferred to the Vault contract before the withdraw execution, and are accounted for during withdraw.
*
* MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner not
* having enough shares, etc).
*
* Note that some implementations will require pre-requesting to the Vault before a withdrawal may be performed.
* Those methods should be performed separately.
*/
function withdraw(uint256 assets, address receiver, address owner) external returns (uint256 shares);
/**
* Maximum amount of Vault shares that can be redeemed from the owner balance in the Vault, through a redeem call.
*
* MUST return the maximum amount of shares that could be transferred from owner through redeem and not cause a
* revert, which MUST NOT be higher than the actual maximum that would be accepted (it should underestimate if
* necessary).
*
* MUST factor in both global and user-specific limits, like if redemption is entirely disabled (even temporarily)
* it MUST return 0.
*/
function maxRedeem(address caller) external view returns (uint256 maxShares);
/**
* Allows an on-chain or off-chain user to simulate the effects of their redemption at the current block, given
* current on-chain conditions.
*
* MUST return as close to and no more than the exact amount of assets that would be withdrawn in a redeem call in
* the same transaction. I.e. redeem should return the same or more assets as previewRedeem if called in the same
* transaction.
*
* MUST NOT account for redemption limits like those returned from maxRedeem and should always act as though the
* redemption would be accepted, regardless if the user has enough shares, etc.
*
* MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
*
* MUST NOT revert due to vault specific user/global limits. MAY revert due to other conditions that would also
* cause redeem to revert.
*
* Note that any unfavorable discrepancy between convertToAssets and previewRedeem SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by redeeming.
*/
function previewRedeem(uint256 shares) external view returns (uint256 assets);
/**
* Burns exactly shares from owner and sends assets of underlying tokens to receiver.
*
* MUST emit the Withdraw event.
*
* MUST support a redeem flow where the shares are burned from owner directly where owner is msg.sender or
* msg.sender has ERC-20 approval over the shares of owner. MAY support an additional flow in which the shares are
* transferred to the Vault contract before the redeem execution, and are accounted for during redeem.
*
* MUST revert if all of shares cannot be redeemed (due to withdrawal limit being reached, slippage, the owner not
* having enough shares, etc).
*
* Note that some implementations will require pre-requesting to the Vault before a withdrawal may be performed.
* Those methods should be performed separately.
*/
function redeem(uint256 shares, address receiver, address owner) external returns (uint256 assets);
function convertToAssets(uint256 shares) external view returns (uint256 assets);
function convertToShares(uint256 assets) external view returns (uint256 shares);
}
"
},
"contracts/base/interface/IVault.sol": {
"content": "// SPDX-License-Identifier: Unlicense
pragma solidity 0.8.26;
interface IVault {
function initializeVault(
address _storage,
address _underlying,
uint256 _toInvestNumerator,
uint256 _toInvestDenominator
) external;
function balanceOf(address _holder) external view returns (uint256);
function underlyingBalanceInVault() external view returns (uint256);
function underlyingBalanceWithInvestment() external view returns (uint256);
function governance() external view returns (address);
function controller() external view returns (address);
function underlying() external view returns (address);
function underlyingUnit() external view returns (uint);
function strategy() external view returns (address);
function setStrategy(address _strategy) external;
function announceStrategyUpdate(address _strategy) external;
function setVaultFractionToInvest(uint256 _numerator, uint256 _denominator) external;
function deposit(uint256 _amount) external;
function deposit(uint256 _amount, address _receiver) external;
function depositFor(uint256 _amount, address _holder) external;
function withdrawAll() external;
function withdraw(uint256 _numberOfShares) external;
function getPricePerFullShare() external view returns (uint256);
function underlyingBalanceWithInvestmentForHolder(address _holder) view external returns (uint256);
/**
* The total amount available to be deposited from this vault into the strategy, while adhering to the
* `vaultFractionToInvestNumerator` and `vaultFractionToInvestDenominator` rules
*/
function availableToInvestOut() external view returns (uint256);
/**
* This should be callable only by the controller (by the hard worker) or by governance
*/
function doHardWork() external;
function decimals() external view returns (uint8);
}
"
}
},
"settings": {
"optimizer": {
"enabled": true,
"runs": 200
},
"evmVersion": "paris",
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
}
}
}}
Submitted on: 2025-09-17 16:13:29
Comments
Log in to comment.
No comments yet.