Contract Name:
PriceOracle
Contract Source Code:
// This is for running the tests
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
import { AccessControlUpgradeable } from "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
import { ReentrancyGuardUpgradeable } from "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
import { PausableUpgradeable } from "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";
import { AggregatorV3Interface } from "@chainlink/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol";
import { IPriceOracle } from "./interfaces/IPriceOracle.sol";
import { CustomRevert } from "./libs/CustomRevert.sol";
import { IRateProvider } from "./interfaces/IRateProvider.sol";
/**
* @title PriceOracle
* @notice A price oracle contract that manages and validates price feeds for various tokens
* @dev This contract integrates with Chainlink price feeds and provides additional validation
* mechanisms for Liquid Staking Tokens (LSTs) and stable tokens. It is upgradeable and
* implements access control, reentrancy protection, and pausability.
*/
contract PriceOracle is AccessControlUpgradeable, ReentrancyGuardUpgradeable, PausableUpgradeable, IPriceOracle {
using CustomRevert for bytes4;
/**
* @notice Role identifier for accounts that can pause the contract
* @dev Calculated as keccak256("PAUSER_ROLE")
*/
bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");
/**
* @notice Base points constant used for percentage calculations (100% = 10000)
* @dev Used in price validation calculations
*/
uint256 public constant BASE_POINTS = 10_000;
/**
* @notice Structure containing information about a price feed
* @param feed The Chainlink price feed interface
* @param decimals Number of decimals used by the price feed
* @param heartbeat Maximum time allowed between price feed updates
* @param initialized Boolean indicating if the feed has been initialized
*/
struct FeedInfo {
AggregatorV3Interface feed;
uint8 decimals;
uint256 heartbeat;
bool initialized;
}
/**
* @notice Structure containing information for price validation checks
* @param lstTokenFeed Price feed for the LST token
* @param lstFeedDecimals Number of decimals in the LST token feed
* @param lstHeartbeat Maximum time allowed between LST price feed updates
* @param lstRateProvider Address of the rate provider for LST exchange rates
* @param percentageThreshold Maximum allowed deviation threshold in base points
* @param expectedPriceWithCorrectPrecision Expected price with 18 decimals precision
*/
struct PriceValidityCheck {
AggregatorV3Interface lstTokenFeed;
uint8 lstFeedDecimals;
uint256 lstHeartbeat;
address lstRateProvider;
uint256 percentageThreshold;
uint256 expectedPriceWithCorrectPrecision;
}
/**
* @notice Mapping of token addresses to their price feed information
*/
mapping(address => FeedInfo) public priceFeeds;
/**
* @notice Mapping of token addresses to their price validation parameters
*/
mapping(address => PriceValidityCheck) public priceValidityChecks;
/**
* @notice Constant for decimal scaling (1e18)
* @dev Used for price calculations and normalization
*/
uint256 private constant DECIMAL_SCALE = 1e18;
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() initializer {}
/**
* @notice Initializes the contract
* @dev Sets up initial roles and initializes inherited contracts
* @param admin Address of the contract administrator
* @param pauser Address that will have the PAUSER_ROLE
*/
function initialize(address admin, address pauser) external initializer {
if (admin == address(0)) IPriceOracle.ZeroAddress.selector.revertWith();
__AccessControl_init();
__Pausable_init();
__ReentrancyGuard_init();
_grantRole(DEFAULT_ADMIN_ROLE, admin);
_grantRole(PAUSER_ROLE, pauser);
}
/**
* @notice Adds or updates a price feed for a token
* @dev Can be called only by admin role
* @param token Address of the token
* @param feed Address of the Chainlink price feed
* @param decimals Number of decimals in the price feed
* @param heartbeat Maximum time allowed between price updates
* @param lstTokenFeed Address of the LST token price feed (if applicable)
* @param lstFeedDecimals Number of decimals in the LST feed
* @param lstRateProvider Address of the LST rate provider
* @param lstHeartbeat Maximum time allowed between LST price updates
* @param percentageThreshold Maximum allowed price deviation in base points
* @param expectedPriceWithCorrectPrecision Expected price with 18 decimals (for stablecoins)
*/
function addPriceFeed(
address token,
address feed,
uint8 decimals,
uint256 heartbeat,
address lstTokenFeed,
uint8 lstFeedDecimals,
address lstRateProvider,
uint256 lstHeartbeat,
uint256 percentageThreshold,
uint256 expectedPriceWithCorrectPrecision
) external onlyRole(DEFAULT_ADMIN_ROLE) {
if (feed == address(0)) IPriceOracle.ZeroAddress.selector.revertWith();
if (decimals == 0 || heartbeat == 0) IPriceOracle.InvalidInput.selector.revertWith();
if (priceFeeds[token].initialized) IPriceOracle.DuplicateEntry.selector.revertWith();
priceFeeds[token] = FeedInfo({ feed: AggregatorV3Interface(feed), decimals: decimals, heartbeat: heartbeat, initialized: true });
if (percentageThreshold > 0) {
priceValidityChecks[token] = PriceValidityCheck({
lstTokenFeed: AggregatorV3Interface(lstTokenFeed),
lstFeedDecimals: lstFeedDecimals,
lstHeartbeat: lstHeartbeat,
lstRateProvider: lstRateProvider,
percentageThreshold: percentageThreshold,
expectedPriceWithCorrectPrecision: expectedPriceWithCorrectPrecision
});
}
emit FeedAdded(token, feed);
}
/**
* @notice Removes a price feed for a token
* @dev Can be called only by admin role
* @param token Address of the token whose feed should be removed
*/
function removePriceFeed(address token) external onlyRole(DEFAULT_ADMIN_ROLE) {
if (address(priceFeeds[token].feed) == address(0)) IPriceOracle.InvalidAddress.selector.revertWith();
delete priceFeeds[token];
delete priceValidityChecks[token];
emit FeedRemoved(token);
}
/**
* @notice Updates an existing price feed for a token
* @dev Can be called only by admin role, feed must already exist
* @param token Address of the token
* @param feed Address of the new Chainlink price feed
* @param decimals Number of decimals in the price feed
* @param heartbeat Maximum time allowed between price updates
* @param lstTokenFeed Address of the LST token price feed (if applicable)
* @param lstFeedDecimals Number of decimals in the LST feed
* @param lstRateProvider Address of the LST rate provider
* @param lstHeartbeat Maximum time allowed between LST price updates
* @param percentageThreshold Maximum allowed price deviation in base points
* @param expectedPriceWithCorrectPrecision Expected price with 18 decimals (for stablecoins)
*/
function updatePriceFeed(
address token,
address feed,
uint8 decimals,
uint256 heartbeat,
address lstTokenFeed,
uint8 lstFeedDecimals,
address lstRateProvider,
uint256 lstHeartbeat,
uint256 percentageThreshold,
uint256 expectedPriceWithCorrectPrecision
) external onlyRole(DEFAULT_ADMIN_ROLE) {
if (feed == address(0)) IPriceOracle.ZeroAddress.selector.revertWith();
if (decimals == 0 || heartbeat == 0) IPriceOracle.InvalidInput.selector.revertWith();
if (address(priceFeeds[token].feed) == address(0)) IPriceOracle.InvalidAddress.selector.revertWith();
address oldFeed = address(priceFeeds[token].feed);
priceFeeds[token] = FeedInfo({ feed: AggregatorV3Interface(feed), decimals: decimals, heartbeat: heartbeat, initialized: true });
if (percentageThreshold > 0) {
priceValidityChecks[token] = PriceValidityCheck({
lstTokenFeed: AggregatorV3Interface(lstTokenFeed),
lstFeedDecimals: lstFeedDecimals,
lstHeartbeat: lstHeartbeat,
lstRateProvider: lstRateProvider,
percentageThreshold: percentageThreshold,
expectedPriceWithCorrectPrecision: expectedPriceWithCorrectPrecision
});
} else {
delete priceValidityChecks[token];
}
emit FeedUpdated(token, oldFeed, feed);
}
/**
* @notice Gets the current price for a token
* @dev Returns both the price and its validity status
* @param token Address of the token to get the price for
* @return isValid Boolean indicating if the price is valid
* @return price Current price with 18 decimals precision
*/
function getPrice(address token) external view override whenNotPaused returns (bool isValid, uint256 price) {
FeedInfo storage feedInfo = priceFeeds[token];
if (address(feedInfo.feed) == address(0)) IPriceOracle.InvalidAddress.selector.revertWith();
uint256 _price = _fetchPrice(feedInfo);
return (true, _price);
// if (_price == 0) {
// return (false, 0);
// }
// PriceValidityCheck storage validityCheck = priceValidityChecks[token];
// bool _isValid = _isPriceValid(validityCheck, _price);
// return (_isValid, _price);
}
/**
* @notice Gets the token decimals from the feed
* @param token The token address
* @return decimals The number of decimals in the token feed
*/
function getFeedDecimals(address token) external view returns (uint8 decimals) {
return priceFeeds[token].decimals;
}
/**
* @notice Pauses the contract
* @dev Can be called only by accounts with PAUSER_ROLE
*/
function pause() external onlyRole(PAUSER_ROLE) {
_pause();
}
/**
* @notice Unpauses the contract
* @dev Can be called only by accounts with ADMIN_ROLE
*/
function unpause() external onlyRole(DEFAULT_ADMIN_ROLE) {
_unpause();
}
/**
* @notice Internal function to fetch and validate price from Chainlink feed
* @dev Includes various safety checks and normalizes to 18 decimals
* @param _info The feed information structure
* @return price The normalized price with 18 decimals, or 0 if invalid
*/
function _fetchPrice(FeedInfo memory _info) internal view returns (uint256) {
try _info.feed.latestRoundData() returns (uint80 roundID, int256 _answer, uint256, uint256 updatedAt, uint80 answeredInRound) {
uint256 price = uint256(_answer);
price = _scalePrice(price, _info.decimals, 18);
return price;
} catch {
return 0;
}
}
/**
* @notice Internal function to scale price to a target number of decimals
* @param _price The price to scale
* @param _priceDecimals The current number of decimals of the price
* @param _decimals The target number of decimals
* @return The scaled price
*/
function _scalePrice(uint256 _price, uint8 _priceDecimals, uint8 _decimals) internal pure returns (uint256) {
if (_priceDecimals < _decimals) {
return _price * (10 ** uint256(_decimals - _priceDecimals));
} else if (_priceDecimals > _decimals) {
return _price / (10 ** uint256(_priceDecimals - _decimals));
} else {
return _price;
}
}
/**
* @notice Validates price against configured thresholds and conditions
* @dev Handles both LST tokens and regular tokens differently
* @param _cached The price validity check parameters
* @param baseTokenPrice The current price of the base token
* @return bool True if the price is valid, false otherwise
*/
function _isPriceValid(
PriceValidityCheck memory _cached,
uint256 baseTokenPrice
) internal view returns (bool) {
return true;
}
/**
* @notice Checks if the contract supports a specific interface.
* @param interfaceId The interface identifier.
* @return True if the interface is supported, false otherwise.
*/
function supportsInterface(bytes4 interfaceId) public view override(AccessControlUpgradeable) returns (bool) {
return interfaceId == type(IPriceOracle).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @notice Prevents renouncing roles for security
* @dev Overrides the default renounceRole function to prevent accidental role removal
*/
function renounceRole(bytes32, address) public virtual override {
revert("Roles can't be renounced");
}
/**
* @dev Reserved storage space for future upgrades
*/
uint256[50] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (access/AccessControl.sol)
pragma solidity ^0.8.0;
import "./IAccessControlUpgradeable.sol";
import "../utils/ContextUpgradeable.sol";
import "../utils/StringsUpgradeable.sol";
import "../utils/introspection/ERC165Upgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module that allows children to implement role-based access
* control mechanisms. This is a lightweight version that doesn't allow enumerating role
* members except through off-chain means by accessing the contract event logs. Some
* applications may benefit from on-chain enumerability, for those cases see
* {AccessControlEnumerable}.
*
* Roles are referred to by their `bytes32` identifier. These should be exposed
* in the external API and be unique. The best way to achieve this is by
* using `public constant` hash digests:
*
* ```solidity
* bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
* ```
*
* Roles can be used to represent a set of permissions. To restrict access to a
* function call, use {hasRole}:
*
* ```solidity
* function foo() public {
* require(hasRole(MY_ROLE, msg.sender));
* ...
* }
* ```
*
* Roles can be granted and revoked dynamically via the {grantRole} and
* {revokeRole} functions. Each role has an associated admin role, and only
* accounts that have a role's admin role can call {grantRole} and {revokeRole}.
*
* By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
* that only accounts with this role will be able to grant or revoke other
* roles. More complex role relationships can be created by using
* {_setRoleAdmin}.
*
* WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
* grant and revoke this role. Extra precautions should be taken to secure
* accounts that have been granted it. We recommend using {AccessControlDefaultAdminRules}
* to enforce additional security measures for this role.
*/
abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable, IAccessControlUpgradeable, ERC165Upgradeable {
struct RoleData {
mapping(address => bool) members;
bytes32 adminRole;
}
mapping(bytes32 => RoleData) private _roles;
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
/**
* @dev Modifier that checks that an account has a specific role. Reverts
* with a standardized message including the required role.
*
* The format of the revert reason is given by the following regular expression:
*
* /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
*
* _Available since v4.1._
*/
modifier onlyRole(bytes32 role) {
_checkRole(role);
_;
}
function __AccessControl_init() internal onlyInitializing {
}
function __AccessControl_init_unchained() internal onlyInitializing {
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IAccessControlUpgradeable).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) public view virtual override returns (bool) {
return _roles[role].members[account];
}
/**
* @dev Revert with a standard message if `_msgSender()` is missing `role`.
* Overriding this function changes the behavior of the {onlyRole} modifier.
*
* Format of the revert message is described in {_checkRole}.
*
* _Available since v4.6._
*/
function _checkRole(bytes32 role) internal view virtual {
_checkRole(role, _msgSender());
}
/**
* @dev Revert with a standard message if `account` is missing `role`.
*
* The format of the revert reason is given by the following regular expression:
*
* /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
*/
function _checkRole(bytes32 role, address account) internal view virtual {
if (!hasRole(role, account)) {
revert(
string(
abi.encodePacked(
"AccessControl: account ",
StringsUpgradeable.toHexString(account),
" is missing role ",
StringsUpgradeable.toHexString(uint256(role), 32)
)
)
);
}
}
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) public view virtual override returns (bytes32) {
return _roles[role].adminRole;
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleGranted} event.
*/
function grantRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {
_grantRole(role, account);
}
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleRevoked} event.
*/
function revokeRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {
_revokeRole(role, account);
}
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been revoked `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `account`.
*
* May emit a {RoleRevoked} event.
*/
function renounceRole(bytes32 role, address account) public virtual override {
require(account == _msgSender(), "AccessControl: can only renounce roles for self");
_revokeRole(role, account);
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event. Note that unlike {grantRole}, this function doesn't perform any
* checks on the calling account.
*
* May emit a {RoleGranted} event.
*
* [WARNING]
* ====
* This function should only be called from the constructor when setting
* up the initial roles for the system.
*
* Using this function in any other way is effectively circumventing the admin
* system imposed by {AccessControl}.
* ====
*
* NOTE: This function is deprecated in favor of {_grantRole}.
*/
function _setupRole(bytes32 role, address account) internal virtual {
_grantRole(role, account);
}
/**
* @dev Sets `adminRole` as ``role``'s admin role.
*
* Emits a {RoleAdminChanged} event.
*/
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
bytes32 previousAdminRole = getRoleAdmin(role);
_roles[role].adminRole = adminRole;
emit RoleAdminChanged(role, previousAdminRole, adminRole);
}
/**
* @dev Grants `role` to `account`.
*
* Internal function without access restriction.
*
* May emit a {RoleGranted} event.
*/
function _grantRole(bytes32 role, address account) internal virtual {
if (!hasRole(role, account)) {
_roles[role].members[account] = true;
emit RoleGranted(role, account, _msgSender());
}
}
/**
* @dev Revokes `role` from `account`.
*
* Internal function without access restriction.
*
* May emit a {RoleRevoked} event.
*/
function _revokeRole(bytes32 role, address account) internal virtual {
if (hasRole(role, account)) {
_roles[role].members[account] = false;
emit RoleRevoked(role, account, _msgSender());
}
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @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 ReentrancyGuardUpgradeable is Initializable {
// 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;
function __ReentrancyGuard_init() internal onlyInitializing {
__ReentrancyGuard_init_unchained();
}
function __ReentrancyGuard_init_unchained() internal onlyInitializing {
_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;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _status == _ENTERED;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (security/Pausable.sol)
pragma solidity ^0.8.0;
import "../utils/ContextUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module which allows children to implement an emergency stop
* mechanism that can be triggered by an authorized account.
*
* This module is used through inheritance. It will make available the
* modifiers `whenNotPaused` and `whenPaused`, which can be applied to
* the functions of your contract. Note that they will not be pausable by
* simply including this module, only once the modifiers are put in place.
*/
abstract contract PausableUpgradeable is Initializable, ContextUpgradeable {
/**
* @dev Emitted when the pause is triggered by `account`.
*/
event Paused(address account);
/**
* @dev Emitted when the pause is lifted by `account`.
*/
event Unpaused(address account);
bool private _paused;
/**
* @dev Initializes the contract in unpaused state.
*/
function __Pausable_init() internal onlyInitializing {
__Pausable_init_unchained();
}
function __Pausable_init_unchained() internal onlyInitializing {
_paused = false;
}
/**
* @dev Modifier to make a function callable only when the contract is not paused.
*
* Requirements:
*
* - The contract must not be paused.
*/
modifier whenNotPaused() {
_requireNotPaused();
_;
}
/**
* @dev Modifier to make a function callable only when the contract is paused.
*
* Requirements:
*
* - The contract must be paused.
*/
modifier whenPaused() {
_requirePaused();
_;
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/
function paused() public view virtual returns (bool) {
return _paused;
}
/**
* @dev Throws if the contract is paused.
*/
function _requireNotPaused() internal view virtual {
require(!paused(), "Pausable: paused");
}
/**
* @dev Throws if the contract is not paused.
*/
function _requirePaused() internal view virtual {
require(paused(), "Pausable: not paused");
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/
function _pause() internal virtual whenNotPaused {
_paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
_paused = false;
emit Unpaused(_msgSender());
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
interface AggregatorV3Interface {
function decimals() external view returns (uint8);
function description() external view returns (string memory);
function version() external view returns (uint256);
function getRoundData(uint80 _roundId)
external
view
returns (
uint80 roundId,
int256 answer,
uint256 startedAt,
uint256 updatedAt,
uint80 answeredInRound
);
function latestRoundData()
external
view
returns (
uint80 roundId,
int256 answer,
uint256 startedAt,
uint256 updatedAt,
uint80 answeredInRound
);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
/**
* @title IPriceOracle
* @notice Interface for the PriceOracle contract, managing and updating token price feeds.
*/
interface IPriceOracle {
/**
* @dev Emitted when a price feed is added for a token.
* @param token The address of the token.
* @param feed The address of the Chainlink price feed.
*/
event FeedAdded(address indexed token, address indexed feed);
/**
* @dev Emitted when a price feed is removed for a token.
* @param token The address of the token.
*/
event FeedRemoved(address indexed token);
/**
* @dev Emitted when a price feed is updated for a token.
* @param token The address of the token.
* @param oldFeed The address of the old price feed.
* @param newFeed The address of the new price feed.
*/
event FeedUpdated(address indexed token, address indexed oldFeed, address indexed newFeed);
// Custom Errors
error ZeroAddress();
error InvalidAddress();
error InvalidOperation();
error InvalidAmount();
error StalePrice();
error InvalidInput();
error DuplicateEntry();
/**
* @notice Gets the latest price data for a specified token.
* @param token The address of the token.
* @return isValid Whether the price is valid.
* @return price The last updated price (18 decimals).
*/
function getPrice(address token) external view returns (bool isValid, uint256 price);
/**
* @notice gets the token decimals from the feed
*/
function getFeedDecimals(address token) external view returns (uint8 decimals);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
import { GroupId } from "../types/GroupId.sol";
// solhint-disable
/// @title Library for reverting with custom errors efficiently
/// @notice Contains functions for reverting with custom errors with different argument types efficiently
/// @dev To use this library, declare `using CustomRevert for bytes4;` and replace `revert CustomError()` with
/// `CustomError.selector.revertWith()`
/// @dev The functions may tamper with the free memory pointer but it is fine since the call context is exited immediately
library CustomRevert {
/// @dev Reverts with the selector of a custom error in the scratch space
function revertWith(bytes4 selector) internal pure {
assembly("memory-safe") {
mstore(0, selector)
revert(0, 0x04)
}
}
/// @dev Reverts with a custom error with an address argument in the scratch space
function revertWith(bytes4 selector, address addr) internal pure {
assembly("memory-safe") {
mstore(0, selector)
mstore(0x04, and(addr, 0xffffffffffffffffffffffffffffffffffffffff))
revert(0, 0x24)
}
}
/// @dev Reverts with a custom error with an int24 argument in the scratch space
function revertWith(bytes4 selector, int24 value) internal pure {
assembly("memory-safe") {
mstore(0, selector)
mstore(0x04, signextend(2, value))
revert(0, 0x24)
}
}
/// @dev Reverts with a custom error with a uint160 argument in the scratch space
function revertWith(bytes4 selector, uint160 value) internal pure {
assembly("memory-safe") {
mstore(0, selector)
mstore(0x04, and(value, 0xffffffffffffffffffffffffffffffffffffffff))
revert(0, 0x24)
}
}
/// @dev Reverts with a custom error with two int24 arguments
function revertWith(bytes4 selector, int24 value1, int24 value2) internal pure {
assembly("memory-safe") {
let fmp := mload(0x40)
mstore(fmp, selector)
mstore(add(fmp, 0x04), signextend(2, value1))
mstore(add(fmp, 0x24), signextend(2, value2))
revert(fmp, 0x44)
}
}
/// @dev Reverts with a custom error with two uint160 arguments
function revertWith(bytes4 selector, uint160 value1, uint160 value2) internal pure {
assembly("memory-safe") {
let fmp := mload(0x40)
mstore(fmp, selector)
mstore(add(fmp, 0x04), and(value1, 0xffffffffffffffffffffffffffffffffffffffff))
mstore(add(fmp, 0x24), and(value2, 0xffffffffffffffffffffffffffffffffffffffff))
revert(fmp, 0x44)
}
}
/// @dev Reverts with a custom error with two address arguments
function revertWith(bytes4 selector, address value1, address value2) internal pure {
assembly("memory-safe") {
mstore(0, selector)
mstore(0x04, and(value1, 0xffffffffffffffffffffffffffffffffffffffff))
mstore(0x24, and(value2, 0xffffffffffffffffffffffffffffffffffffffff))
revert(0, 0x44)
}
}
/// @dev Reverts with a custom error with a bytes32 argument in the scratch space
function revertWith(bytes4 selector, bytes32 value) internal pure {
assembly("memory-safe") {
mstore(0, selector)
mstore(0x04, value)
revert(0, 0x24)
}
}
/// @dev Reverts with a custom error with a bytes32 argument in the scratch space
function revertWith(bytes4 selector, GroupId value) internal pure {
bytes32 valueBytes = GroupId.unwrap(value);
assembly("memory-safe") {
mstore(0, selector)
mstore(0x04, valueBytes)
revert(0, 0x24)
}
}
/// @dev Reverts with a custom error with a bytes32 and an address argument
function revertWith(bytes4 selector, GroupId value, address addr) internal pure {
bytes32 valueBytes = GroupId.unwrap(value);
assembly("memory-safe") {
mstore(0x00, selector)
mstore(0x04, valueBytes)
mstore(0x24, and(addr, 0xffffffffffffffffffffffffffffffffffffffff))
revert(0x00, 0x44)
}
}
/// @dev Reverts with a custom error with a bytes32, address, and uint256 arguments
function revertWith(bytes4 selector, GroupId value, address addr, uint256 amount) internal pure {
bytes32 valueBytes = GroupId.unwrap(value);
assembly("memory-safe") {
mstore(0x00, selector)
mstore(0x04, valueBytes)
mstore(0x24, and(addr, 0xffffffffffffffffffffffffffffffffffffffff))
mstore(0x44, amount)
revert(0x00, 0x64)
}
}
/// @notice bubble up the revert message returned by a call and revert with the selector provided
/// @dev this function should only be used with custom errors of the type `CustomError(address target, bytes revertReason)`
function bubbleUpAndRevertWith(bytes4 selector, address addr) internal pure {
assembly("memory-safe") {
let size := returndatasize()
let fmp := mload(0x40)
// Encode selector, address, offset, size, data
mstore(fmp, selector)
mstore(add(fmp, 0x04), addr)
mstore(add(fmp, 0x24), 0x40)
mstore(add(fmp, 0x44), size)
returndatacopy(add(fmp, 0x64), 0, size)
// Ensure the size is a multiple of 32 bytes
let encodedSize := add(0x64, mul(div(add(size, 31), 32), 32))
revert(fmp, encodedSize)
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
interface IRateProvider {
function getRate() external view returns (uint256);
function rateDecimals() external view returns (uint256);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (access/IAccessControl.sol)
pragma solidity ^0.8.0;
/**
* @dev External interface of AccessControl declared to support ERC165 detection.
*/
interface IAccessControlUpgradeable {
/**
* @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
*
* `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
* {RoleAdminChanged} not being emitted signaling this.
*
* _Available since v3.1._
*/
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
/**
* @dev Emitted when `account` is granted `role`.
*
* `sender` is the account that originated the contract call, an admin role
* bearer except when using {AccessControl-_setupRole}.
*/
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Emitted when `account` is revoked `role`.
*
* `sender` is the account that originated the contract call:
* - if using `revokeRole`, it is the admin role bearer
* - if using `renounceRole`, it is the role bearer (i.e. `account`)
*/
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) external view returns (bool);
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {AccessControl-_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) external view returns (bytes32);
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function grantRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function revokeRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been granted `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `account`.
*/
function renounceRole(bytes32 role, address account) external;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.4) (utils/Context.sol)
pragma solidity ^0.8.0;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @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 ContextUpgradeable is Initializable {
function __Context_init() internal onlyInitializing {
}
function __Context_init_unchained() internal onlyInitializing {
}
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Strings.sol)
pragma solidity ^0.8.0;
import "./math/MathUpgradeable.sol";
import "./math/SignedMathUpgradeable.sol";
/**
* @dev String operations.
*/
library StringsUpgradeable {
bytes16 private constant _SYMBOLS = "0123456789abcdef";
uint8 private constant _ADDRESS_LENGTH = 20;
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
unchecked {
uint256 length = MathUpgradeable.log10(value) + 1;
string memory buffer = new string(length);
uint256 ptr;
/// @solidity memory-safe-assembly
assembly {
ptr := add(buffer, add(32, length))
}
while (true) {
ptr--;
/// @solidity memory-safe-assembly
assembly {
mstore8(ptr, byte(mod(value, 10), _SYMBOLS))
}
value /= 10;
if (value == 0) break;
}
return buffer;
}
}
/**
* @dev Converts a `int256` to its ASCII `string` decimal representation.
*/
function toString(int256 value) internal pure returns (string memory) {
return string(abi.encodePacked(value < 0 ? "-" : "", toString(SignedMathUpgradeable.abs(value))));
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
unchecked {
return toHexString(value, MathUpgradeable.log256(value) + 1);
}
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = _SYMBOLS[value & 0xf];
value >>= 4;
}
require(value == 0, "Strings: hex length insufficient");
return string(buffer);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation.
*/
function toHexString(address addr) internal pure returns (string memory) {
return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH);
}
/**
* @dev Returns true if the two strings are equal.
*/
function equal(string memory a, string memory b) internal pure returns (bool) {
return keccak256(bytes(a)) == keccak256(bytes(b));
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)
pragma solidity ^0.8.0;
import "./IERC165Upgradeable.sol";
import {Initializable} from "../../proxy/utils/Initializable.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*
* Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
*/
abstract contract ERC165Upgradeable is Initializable, IERC165Upgradeable {
function __ERC165_init() internal onlyInitializing {
}
function __ERC165_init_unchained() internal onlyInitializing {
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IERC165Upgradeable).interfaceId;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.2;
import "../../utils/AddressUpgradeable.sol";
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```solidity
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
*
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Indicates that the contract has been initialized.
* @custom:oz-retyped-from bool
*/
uint8 private _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private _initializing;
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint8 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts.
*
* Similar to `reinitializer(1)`, except that functions marked with `initializer` can be nested in the context of a
* constructor.
*
* Emits an {Initialized} event.
*/
modifier initializer() {
bool isTopLevelCall = !_initializing;
require(
(isTopLevelCall && _initialized < 1) || (!AddressUpgradeable.isContract(address(this)) && _initialized == 1),
"Initializable: contract is already initialized"
);
_initialized = 1;
if (isTopLevelCall) {
_initializing = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* A reinitializer may be used after the original initialization step. This is essential to configure modules that
* are added through upgrades and that require initialization.
*
* When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
* cannot be nested. If one is invoked in the context of another, execution will revert.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*
* WARNING: setting the version to 255 will prevent any future reinitialization.
*
* Emits an {Initialized} event.
*/
modifier reinitializer(uint8 version) {
require(!_initializing && _initialized < version, "Initializable: contract is already initialized");
_initialized = version;
_initializing = true;
_;
_initializing = false;
emit Initialized(version);
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
require(_initializing, "Initializable: contract is not initializing");
_;
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*
* Emits an {Initialized} event the first time it is successfully executed.
*/
function _disableInitializers() internal virtual {
require(!_initializing, "Initializable: contract is initializing");
if (_initialized != type(uint8).max) {
_initialized = type(uint8).max;
emit Initialized(type(uint8).max);
}
}
/**
* @dev Returns the highest version that has been initialized. See {reinitializer}.
*/
function _getInitializedVersion() internal view returns (uint8) {
return _initialized;
}
/**
* @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
*/
function _isInitializing() internal view returns (bool) {
return _initializing;
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
import { GroupKey } from "./GroupKey.sol";
type GroupId is bytes32;
// @notice library for computing the ID of a group
library GroupIdLibrary {
using GroupIdLibrary for GroupId;
function toId(GroupKey memory groupKey) internal pure returns (GroupId groupId) {
groupId = GroupId.wrap(keccak256(abi.encode(groupKey)));
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/math/Math.sol)
pragma solidity ^0.8.0;
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library MathUpgradeable {
enum Rounding {
Down, // Toward negative infinity
Up, // Toward infinity
Zero // Toward zero
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds up instead
* of rounding down.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b - 1) / b can overflow on addition, so we distribute.
return a == 0 ? 0 : (a - 1) / b + 1;
}
/**
* @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
* @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv)
* with further edits by Uniswap Labs also under MIT license.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
// 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
// use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = prod1 * 2^256 + prod0.
uint256 prod0; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(x, y, not(0))
prod0 := mul(x, y)
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Handle non-overflow cases, 256 by 256 division.
if (prod1 == 0) {
// Solidity will revert if denominator == 0, unlike the div opcode on its own.
// The surrounding unchecked block does not change this fact.
// See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
return prod0 / denominator;
}
// Make sure the result is less than 2^256. Also prevents denominator == 0.
require(denominator > prod1, "Math: mulDiv overflow");
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0].
uint256 remainder;
assembly {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1.
// See https://cs.stackexchange.com/q/138556/92363.
// Does not overflow because the denominator cannot be zero at this stage in the function.
uint256 twos = denominator & (~denominator + 1);
assembly {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [prod1 prod0] by twos.
prod0 := div(prod0, twos)
// Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from prod1 into prod0.
prod0 |= prod1 * twos;
// Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
// that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv = 1 mod 2^4.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works
// in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2^8
inverse *= 2 - denominator * inverse; // inverse mod 2^16
inverse *= 2 - denominator * inverse; // inverse mod 2^32
inverse *= 2 - denominator * inverse; // inverse mod 2^64
inverse *= 2 - denominator * inverse; // inverse mod 2^128
inverse *= 2 - denominator * inverse; // inverse mod 2^256
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
// less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
// is no longer required.
result = prod0 * inverse;
return result;
}
}
/**
* @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
uint256 result = mulDiv(x, y, denominator);
if (rounding == Rounding.Up && mulmod(x, y, denominator) > 0) {
result += 1;
}
return result;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded down.
*
* Inspired by Henry S. Warren, Jr.'s "Hacker's Delight" (Chapter 11).
*/
function sqrt(uint256 a) internal pure returns (uint256) {
if (a == 0) {
return 0;
}
// For our first guess, we get the biggest power of 2 which is smaller than the square root of the target.
//
// We know that the "msb" (most significant bit) of our target number `a` is a power of 2 such that we have
// `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`.
//
// This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)`
// → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))`
// → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)`
//
// Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit.
uint256 result = 1 << (log2(a) >> 1);
// At this point `result` is an estimation with one bit of precision. We know the true value is a uint128,
// since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at
// every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision
// into the expected uint128 result.
unchecked {
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
return min(result, a / result);
}
}
/**
* @notice Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + (rounding == Rounding.Up && result * result < a ? 1 : 0);
}
}
/**
* @dev Return the log in base 2, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 128;
}
if (value >> 64 > 0) {
value >>= 64;
result += 64;
}
if (value >> 32 > 0) {
value >>= 32;
result += 32;
}
if (value >> 16 > 0) {
value >>= 16;
result += 16;
}
if (value >> 8 > 0) {
value >>= 8;
result += 8;
}
if (value >> 4 > 0) {
value >>= 4;
result += 4;
}
if (value >> 2 > 0) {
value >>= 2;
result += 2;
}
if (value >> 1 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + (rounding == Rounding.Up && 1 << result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 10, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10 ** 64) {
value /= 10 ** 64;
result += 64;
}
if (value >= 10 ** 32) {
value /= 10 ** 32;
result += 32;
}
if (value >= 10 ** 16) {
value /= 10 ** 16;
result += 16;
}
if (value >= 10 ** 8) {
value /= 10 ** 8;
result += 8;
}
if (value >= 10 ** 4) {
value /= 10 ** 4;
result += 4;
}
if (value >= 10 ** 2) {
value /= 10 ** 2;
result += 2;
}
if (value >= 10 ** 1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + (rounding == Rounding.Up && 10 ** result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 256, rounded down, of a positive value.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 16;
}
if (value >> 64 > 0) {
value >>= 64;
result += 8;
}
if (value >> 32 > 0) {
value >>= 32;
result += 4;
}
if (value >> 16 > 0) {
value >>= 16;
result += 2;
}
if (value >> 8 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + (rounding == Rounding.Up && 1 << (result << 3) < value ? 1 : 0);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/math/SignedMath.sol)
pragma solidity ^0.8.0;
/**
* @dev Standard signed math utilities missing in the Solidity language.
*/
library SignedMathUpgradeable {
/**
* @dev Returns the largest of two signed numbers.
*/
function max(int256 a, int256 b) internal pure returns (int256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two signed numbers.
*/
function min(int256 a, int256 b) internal pure returns (int256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two signed numbers without overflow.
* The result is rounded towards zero.
*/
function average(int256 a, int256 b) internal pure returns (int256) {
// Formula from the book "Hacker's Delight"
int256 x = (a & b) + ((a ^ b) >> 1);
return x + (int256(uint256(x) >> 255) & (a ^ b));
}
/**
* @dev Returns the absolute unsigned value of a signed value.
*/
function abs(int256 n) internal pure returns (uint256) {
unchecked {
// must be unchecked in order to support `n = type(int256).min`
return uint256(n >= 0 ? n : -n);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165Upgradeable {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
// 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 AddressUpgradeable {
/**
* @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);
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
import { DTokenRegistry } from "../declarations/DTokenRegistry.sol";
/**
* @title GroupKey
* @dev Struct representing the core group key information.
*/
struct GroupKey {
/**
* @dev The core group information from the DTokenRegistry.
*/
DTokenRegistry.GroupCore core;
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
import { Currency } from "../types/Currency.sol";
import { Address } from "../types/Address.sol";
import { DefaultFeeParams, FeeParams, FeePermissions, CollateralInfo } from "../types/CommonTypes.sol";
library DTokenRegistry {
// Core tokens of the group (immutable)
struct GroupCore {
Currency aToken; // Yield-bearing token
Currency xToken; // Leverage token
Currency baseToken; // Base token for the group - wrapped Avax
Currency yieldBearingToken; // Example: staked AVAX (immutable)
Currency wethToken; // WETH token address for the router
}
// Decimals for each core token
struct GroupDecimals {
uint8 aTokenDecimals;
uint8 xTokenDecimals;
uint8 baseTokenDecimals;
uint8 yieldBearingTokenDecimals;
}
// Extended group settings (mutable)
struct GroupExtended {
Address priceOracle; // Price Oracle address
Address rateProvider; // Rate provider address
Address swapRouter; // Swap Router
Address treasury; // Treasury address
Address feeCollector; // Fee collector address
Address strategy; // Strategy contract address
Currency rebalancePool; // Rebalance pool address
}
// Metadata for the group (partially mutable)
struct GroupMeta {
uint96 stabilityRatio; // Mutable stability ratio (this is 2^96-1 and we have max 5e18)
uint96 stabilityConditionsTriggeringRate; // Mutable stability fee trigger (this is 2^96-1 and we have max 5e18)
uint8 feeModel; // Immutable fee model used for this group
bool isWrappingRequired; // Immutable wrapping requirement flag
}
// Struct representing full group setup during creation
struct GroupSetup {
GroupCore core;
GroupDecimals decimals;
GroupExtended extended;
GroupMeta meta;
FeeParams fees;
DefaultFeeParams defaultFees;
FeePermissions feePermissions;
CollateralInfo[] acceptableCollaterals;
}
// Data used for updating mutable parts of the group
struct GroupUpdate {
GroupExtended extended;
GroupMeta meta;
CollateralInfo[] acceptableCollaterals;
FeeParams feeParams;
DefaultFeeParams defaultFees;
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
/// @notice https://forum.openzeppelin.com/t/safeerc20-vs-safeerc20upgradeable/17326
import { SafeERC20Upgradeable, IERC20Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
import { CustomRevert } from "../libs/CustomRevert.sol";
// Custom type `Currency` to represent either an ERC20 token or the native currency (e.g., ETH)
type Currency is address;
/**
* @title CurrencyLibrary
* @dev A library for handling operations related to currencies, supporting both ERC20 tokens and native currency.
* Provides utility functions for balance checks, transfers, approvals, and comparisons.
*/
library CurrencyLibrary {
// Use SafeERC20Upgradeable for IERC20Upgradeable token operations to ensure safety
using SafeERC20Upgradeable for IERC20Upgradeable;
// Use CustomRevert for standardized error handling via selectors
using CustomRevert for bytes4;
// Define a constant representing the native currency (address(0))
Currency public constant NATIVE = Currency.wrap(address(0));
// Custom error definitions for various invalid operations involving native currency
error NativeCurrencyTransfersNotAllowed();
error NativeCurrencyTransferFromNotAllowed();
error NativeCurrencyApprovalNotAllowed();
error NativeCurrencyDoesNotHaveTotalSupply();
error NativeCurrencyIncreaseAllowanceNotAllowed();
error NativeCurrencyDecreaseAllowanceNotAllowed();
error ArbitraryTransfersNotAllowed();
/**
* @notice Checks if two currencies are equal.
* @param currency The first currency to compare.
* @param other The second currency to compare.
* @return True if both currencies are the same, false otherwise.
*/
function equals(Currency currency, Currency other) internal pure returns (bool) {
return Currency.unwrap(currency) == Currency.unwrap(other);
}
/**
* @notice Retrieves the balance of the specified owner for the given currency.
* @param currency The currency to check (ERC20 token or native).
* @param owner The address of the owner whose balance is queried.
* @return The balance of the owner in the specified currency.
*/
function balanceOf(Currency currency, address owner) internal view returns (uint256) {
if (isNative(currency)) {
return owner.balance; // For native currency, return the ETH balance
} else {
return IERC20Upgradeable(Currency.unwrap(currency)).balanceOf(owner); // For ERC20 tokens, use balanceOf
}
}
/**
* @notice Safely transfers a specified amount of the currency to a recipient.
* @param currency The currency to transfer (must be an ERC20 token).
* @param to The recipient address.
* @param amount The amount to transfer.
* @dev Native currency transfers are not allowed and will revert.
*/
function safeTransfer(Currency currency, address to, uint256 amount) internal {
if (isNative(currency)) {
// Revert if attempting to transfer native currency using ERC20 methods
NativeCurrencyTransfersNotAllowed.selector.revertWith();
} else {
IERC20Upgradeable(Currency.unwrap(currency)).safeTransfer(to, amount);
}
}
/**
* @notice Safely transfers a specified amount of the currency from one address to another.
* @param currency The currency to transfer (must be an ERC20 token).
* @param safeFrom The address to transfer from.
* @param to The recipient address.
* @param amount The amount to transfer.
* @dev Native currency transfers are not allowed and will revert.
* @dev Arbitrary transfers (i.e., not initiated by the sender) are also not allowed and will revert.
* @notice Slither false positive. The function is internal and only used within the library
*/
//slither-disable-next-line arbitrary-send-erc20
function safeTransferFrom(Currency currency, address safeFrom, address to, uint256 amount) internal {
if (isNative(currency)) {
// Revert if attempting to transfer ERC20 tokens from an address other than the sender
// This is to prevent arbitrary transfers, which are not allowed in the context of this library
// This logic has the priority, so overrides any other inhereted logic
NativeCurrencyTransferFromNotAllowed.selector.revertWith();
} else {
if (safeFrom != msg.sender) ArbitraryTransfersNotAllowed.selector.revertWith();
IERC20Upgradeable(Currency.unwrap(currency)).safeTransferFrom(safeFrom, to, amount);
}
}
/**
* @notice Retrieves the allowance of a spender for the given owner's currency.
* @param currency The currency to check (must be an ERC20 token).
* @param owner The address of the owner of the currency.
* @param spender The address of the spender.
* @return The allowance of the spender for the owner's currency.
*/
function allowance(Currency currency, address owner, address spender) internal view returns (uint256) {
if (isNative(currency)) {
return 0; // For native currency, return 0 as allowance is not applicable
} else {
return IERC20Upgradeable(Currency.unwrap(currency)).allowance(owner, spender); // For ERC20 tokens, use allowance
}
}
/**
* @notice Safely approves a spender to spend a specified amount of the currency.
* @param currency The currency to approve (must be an ERC20 token).
* @param spender The address authorized to spend the tokens.
* @param amount The amount to approve.
* @dev Approving native currency is not allowed and will revert.
*/
function safeApprove(Currency currency, address spender, uint256 amount) internal {
if (!isNative(currency)) {
IERC20Upgradeable(Currency.unwrap(currency)).safeApprove(spender, amount);
} else {
// Revert if attempting to approve native currency
NativeCurrencyApprovalNotAllowed.selector.revertWith();
}
}
/**
* @notice Safely increases the allowance of a spender for the currency.
* @param currency The currency to modify allowance for (must be an ERC20 token).
* @param spender The address authorized to spend the tokens.
* @param addedValue The amount to increase the allowance by.
* @dev Increasing allowance for native currency is not allowed and will revert.
*/
function safeIncreaseAllowance(Currency currency, address spender, uint256 addedValue) internal {
if (!isNative(currency)) {
IERC20Upgradeable(Currency.unwrap(currency)).safeIncreaseAllowance(spender, addedValue);
} else {
// Revert if attempting to increase allowance for native currency
NativeCurrencyIncreaseAllowanceNotAllowed.selector.revertWith();
}
}
/**
* @notice Checks if the given currency is the native currency.
* @param currency The currency to check.
* @return True if `currency` is the native currency, false otherwise.
*/
function isNative(Currency currency) internal pure returns (bool) {
return Currency.unwrap(currency) == Currency.unwrap(NATIVE);
}
/**
* @notice Checks if the given currency is the zero address.
* @param currency The currency to check.
* @return True if `currency` is the zero address, false otherwise.
*/
function isZero(Currency currency) internal pure returns (bool) {
return Currency.unwrap(currency) == address(0);
}
/**
* @notice Converts the currency address to a unique identifier.
* @param currency The currency to convert.
* @return The uint256 representation of the currency's address.
*/
function toId(Currency currency) internal pure returns (uint256) {
return uint160(Currency.unwrap(currency));
}
/**
* @notice Unwraps the `Currency` type to retrieve the underlying address.
* @param currency The currency to unwrap.
* @return The underlying address of the currency.
*/
function toAddress(Currency currency) internal pure returns (address) {
return Currency.unwrap(currency);
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
// Import the CustomRevert library for standardized error handling
import { CustomRevert } from "../libs/CustomRevert.sol";
/**
* @title Address
* @dev Defines a user-defined value type `Address` that wraps the built-in `address` type.
*/
type Address is address;
/**
* @title AddressLibrary
* @dev A library for performing various operations on the `Address` type.
*/
library AddressLibrary {
// Apply the library functions to the `Address` type
using AddressLibrary for Address;
// Use the CustomRevert library for standardized error handling via selectors
using CustomRevert for bytes4;
// Custom error definitions for more descriptive revert reasons
error ZeroAddress();
error FailedCall(string reason);
error NonContractAddress();
error UnableToSendValue();
/**
* @notice Checks if the given `Address` is the zero address.
* @param addr The `Address` to check.
* @return True if `addr` is the zero address, false otherwise.
*/
function isZero(Address addr) internal pure returns (bool) {
return Address.unwrap(addr) == address(0);
}
/**
* @notice Determines if the given `Address` is a contract.
* @param addr The `Address` to check.
* @return True if `addr` is a contract, false otherwise.
*
* @dev This method relies on the fact that contracts have non-zero code size.
* It returns false for contracts in construction, since the code is only stored at the end of the constructor execution.
*/
function isContract(Address addr) internal view returns (bool) {
return Address.unwrap(addr).code.length > 0;
}
/**
* @notice Compares two `Address` instances for equality.
* @param a The first `Address`.
* @param b The second `Address`.
* @return True if both addresses are equal, false otherwise.
*/
function equals(Address a, Address b) internal pure returns (bool) {
address addrA = Address.unwrap(a);
address addrB = Address.unwrap(b);
return addrA == addrB;
}
/**
* @notice Converts an `Address` to a `uint160`.
* @param addr The `Address` to convert.
* @return The `uint160` representation of the address.
*/
function toUint160(Address addr) internal pure returns (uint160) {
return uint160(Address.unwrap(addr));
}
/**
* @notice Creates an `Address` from a `uint160`.
* @param addr The `uint160` value to convert.
* @return A new `Address` instance.
*/
function fromUint160(uint160 addr) internal pure returns (Address) {
return Address.wrap(address(addr));
}
/**
* @notice Unwraps the `Address` type to retrieve the underlying address.
* @param addr The `Address` to unwrap.
* @return The underlying `address`.
*/
function toAddress(Address addr) internal pure returns (address) {
return Address.unwrap(addr);
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
import { Currency } from "./Currency.sol";
import { DTokenRegistry } from "../declarations/DTokenRegistry.sol";
import { Address } from "../types/Address.sol";
// Enums representing different fee models that can be applied.
enum OperationTypes {
OP_TYPE_MINT_VT,
OP_TYPE_MINT_YT,
OP_TYPE_REDEEM_VT,
OP_TYPE_REDEEM_YT
}
enum FeeModel {
NONE, // No fees.
MANAGEMENT_FEE, // Management fee model.
VARIABLE_FUNDING_FEE, // Fee that varies based on funding.
FIXED_FUNDING_FEE, // Fixed fee for funding.
CURATED_PAIRS_FEE, // Curated pairs fee model.
BLANK_FEE // Blank fee model.
}
// Information about acceptable collaterals
struct CollateralInfo {
Currency token; // Token address for collateral
uint8 decimals; // Decimals for the collateral token
uint256 minAmount; // Minimum amount for both usage minting and redeeming (as desired token)
uint256 maxAmount; // Maximum amount for both usage minting and redeeming (as desired token)
}
// DefaultFeeParams defines the basic fee structure with base, min, and max fees.
struct DefaultFeeParams {
uint24 baseFee; // The base fee applied when no flags are present.
uint24 minFee; // The minimum fee allowed for dynamic fee models.
uint24 maxFee; // The maximum fee allowed.
}
// FeeParams defines specific fees for different token types and operations.
struct FeeParams {
uint24 mintFeeVT; // Minting fee for volatile tokens (VT).
uint24 redeemFeeVT; // Redemption fee for volatile tokens (VT).
uint24 mintFeeYT; // Minting fee for yield tokens (YT).
uint24 redeemFeeYT; // Redemption fee for yield tokens (YT).
uint24 stabilityMintFeeVT; // Stability minting fee for volatile tokens (VT).
uint24 stabilityMintFeeYT; // Stability minting fee for yield tokens (YT).
uint24 stabilityRedeemFeeVT; // Stability redemption fee for volatile tokens (VT).
uint24 stabilityRedeemFeeYT; // Stability redemption fee for yield tokens (YT).
uint24 yieldFeeVT; // Yield fee for volatile tokens (VT).
uint24 yieldFeeYT; // Yield fee for yield tokens (YT).
uint24 protocolFee; // Protocol fee.
}
// FeePermissions define the flexibility of the fee model (dynamic fees, delegation).
struct FeePermissions {
bool isDynamic; // Whether the fee model is dynamic.
bool allowDelegation; // Whether fee delegation is allowed.
}
struct GroupState {
DTokenRegistry.GroupCore core;
DTokenRegistry.GroupExtended extended;
bytes32 feesPacked;
CollateralInfo[] acceptableCollaterals;
Address hookContract;
bytes32 groupSettings;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.3) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "../IERC20Upgradeable.sol";
import "../extensions/IERC20PermitUpgradeable.sol";
import "../../../utils/AddressUpgradeable.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 SafeERC20Upgradeable {
using AddressUpgradeable 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(IERC20Upgradeable 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(IERC20Upgradeable 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(IERC20Upgradeable 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(IERC20Upgradeable 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(IERC20Upgradeable 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(IERC20Upgradeable 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(
IERC20PermitUpgradeable 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(IERC20Upgradeable 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(IERC20Upgradeable 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))) && AddressUpgradeable.isContract(address(token));
}
}
// 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 IERC20Upgradeable {
/**
* @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.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 IERC20PermitUpgradeable {
/**
* @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);
}