Overview
BERA Balance
0 BERABERA Value
$0.00More Info
Private Name Tags
ContractCreator
Loading...
Loading
This contract may be a proxy contract. Click on More Options and select Is this a proxy? to confirm and enable the "Read as Proxy" & "Write as Proxy" tabs.
Contract Source Code Verified (Exact Match)
Contract Name:
BeraPawForge
Compiler Version
v0.8.28+commit.7893614a
Optimization Enabled:
Yes with 69420 runs
Other Settings:
cancun EvmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
import { AccessControlUpgradeable } from "@openzeppelin-contracts-upgradeable-5.1.0/access/AccessControlUpgradeable.sol";
import { Initializable } from "@openzeppelin-contracts-upgradeable-5.1.0/proxy/utils/Initializable.sol";
import { UUPSUpgradeable } from "@openzeppelin-contracts-upgradeable-5.1.0/proxy/utils/UUPSUpgradeable.sol";
import { PausableUpgradeable } from "@openzeppelin-contracts-upgradeable-5.1.0/utils/PausableUpgradeable.sol";
import { ReentrancyGuardUpgradeable } from
"@openzeppelin-contracts-upgradeable-5.1.0/utils/ReentrancyGuardUpgradeable.sol";
import { SafeERC20 } from "@openzeppelin-contracts-5.1.0/token/ERC20/utils/SafeERC20.sol";
import { IERC20 } from "@openzeppelin-contracts-5.1.0/token/ERC20/IERC20.sol";
import { Math } from "@openzeppelin-contracts-5.1.0/utils/math/Math.sol";
import { SafeTransferLib } from "solady-0.0.298/src/utils/SafeTransferLib.sol";
import { SafeCast } from "@openzeppelin-contracts-5.1.0/utils/math/SafeCast.sol";
import { IBGT } from "berachain-contracts-latest/src/pol/interfaces/IBGT.sol";
import { IRewardVault } from "berachain-contracts-latest/src/pol/interfaces/IRewardVault.sol";
import { LBGT } from "./LBGT.sol";
import { IBeraPawForge } from "./interfaces/IBeraPawForge.sol";
import { IBGTStaker } from "berachain-contracts-latest/src/pol/interfaces/IBGTStaker.sol";
import { Constants } from "../Constants.sol";
/**
* @title BeraPawForge
* @author BeraPaw
* @notice Core contract for BeraPaw protocol that holds BGT and issues LBGT at 1:1 ratio.
* It is also has hooks for delegation operations and reward distribution.
* @dev This contract:
* - Holds BGT tokens and issues LBGT at 1:1 ratio
* - Manages redemption queue for LBGT->BGT conversions
* - Handles reward collection and distribution
* - Controls BGT boosting operations
* - Collects BGT rewards from staking contract
*/
contract BeraPawForge is
IBeraPawForge,
Initializable,
AccessControlUpgradeable,
PausableUpgradeable,
ReentrancyGuardUpgradeable,
UUPSUpgradeable
{
using SafeERC20 for IERC20;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* CONSTANTS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
IBGT private constant bgt = IBGT(Constants.BGT);
LBGT private constant lbgt = LBGT(Constants.LBGT);
IBGTStaker private constant bgtStaker = IBGTStaker(Constants.BGT_STAKER);
IERC20 private constant honey = IERC20(Constants.HONEY);
bytes32 private constant ROLE_GOD = Constants.ROLE_GOD;
bytes32 private constant ROLE_ADMIN = Constants.ROLE_ADMIN;
bytes32 private constant ROLE_CURATOR = Constants.ROLE_CURATOR;
bytes32 private constant ROLE_BOOSTER = Constants.ROLE_BOOSTER;
bytes32 private constant ROLE_REWARD_COLLECTOR = Constants.ROLE_REWARD_COLLECTOR;
bytes32 private constant ROLE_REDEMPTIONS_PROCESSOR = Constants.ROLE_REDEMPTIONS_PROCESSOR;
uint256 private constant ONE_HUNDRED_PERCENT = 1e18;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* STORAGE */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @inheritdoc IBeraPawForge
mapping(address account => mapping(address rewardVault => address manager)) public lbgtManager;
/// @inheritdoc IBeraPawForge
mapping(address account => RedeemPosition) public redeemPosition;
/// @inheritdoc IBeraPawForge
RedeemQueue[] public redeemQueue;
/// @inheritdoc IBeraPawForge
uint128 public redeemQueueIndex;
/// @inheritdoc IBeraPawForge
uint128 public totalRedeemQueue;
/// @inheritdoc IBeraPawForge
uint256 public processingFee;
/// @inheritdoc IBeraPawForge
uint96 public queueDelay;
/// @inheritdoc IBeraPawForge
uint128 public minimumRedeemAmount;
/// @inheritdoc IBeraPawForge
bool public isProcessRedemptionsOpen;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* MODIFIERS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
modifier onlyUserOrManager(address _user, address _rewardVault) {
address sender = _msgSender();
require(_user == sender || lbgtManager[_user][_rewardVault] == sender, NotUserOrManager(_user, _rewardVault));
_;
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* INITIALIZATION */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
function initialize(address _owner) public initializer {
__AccessControl_init();
__Pausable_init();
__ReentrancyGuard_init();
__UUPSUpgradeable_init();
_setRoleAdmin(ROLE_GOD, ROLE_GOD);
_setRoleAdmin(ROLE_ADMIN, ROLE_GOD);
_setRoleAdmin(ROLE_BOOSTER, ROLE_ADMIN);
_setRoleAdmin(ROLE_CURATOR, ROLE_ADMIN);
_setRoleAdmin(ROLE_REWARD_COLLECTOR, ROLE_GOD);
_setRoleAdmin(ROLE_REDEMPTIONS_PROCESSOR, ROLE_ADMIN);
_grantRole(ROLE_GOD, _owner);
queueDelay = 20_000;
minimumRedeemAmount = 1 ether;
processingFee = 1e18 / 200; // 0.5%;
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* ADMIN FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @inheritdoc IBeraPawForge
function pause() public onlyRole(ROLE_CURATOR) {
_pause();
}
/// @inheritdoc IBeraPawForge
function unpause() public onlyRole(ROLE_ADMIN) {
_unpause();
}
/// @inheritdoc IBeraPawForge
function delegate(address _delegate) public onlyRole(ROLE_ADMIN) {
bgt.delegate(_delegate);
emit Delegated(_delegate);
}
/// @inheritdoc IBeraPawForge
function setQueueDelay(uint96 _queueDelay) public onlyRole(ROLE_ADMIN) {
queueDelay = _queueDelay;
emit QueueDelaySet(queueDelay);
}
/// @inheritdoc IBeraPawForge
function setMinimumRedeemAmount(uint128 _minimumRedeemAmount) public onlyRole(ROLE_ADMIN) {
minimumRedeemAmount = _minimumRedeemAmount;
emit MinimumRedeemAmountSet(minimumRedeemAmount);
}
/// @inheritdoc IBeraPawForge
function setProcessingFee(uint256 _processingFee) public onlyRole(ROLE_ADMIN) {
processingFee = _processingFee;
emit ProcessingFeeSet(processingFee);
}
/// @inheritdoc IBeraPawForge
function setOpenProcessRedemptions(bool _open) public onlyRole(ROLE_GOD) {
isProcessRedemptionsOpen = _open;
emit OpenProcessRedemptionsSet(isProcessRedemptionsOpen);
}
/// @inheritdoc IBeraPawForge
function recover(address token, address to, uint256 amount) external onlyRole(ROLE_GOD) {
require(token != lbgtAddress(), InvalidInput());
IERC20(token).safeTransfer(to, amount);
emit Recovered(token, to, amount);
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* USER FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @inheritdoc IBeraPawForge
function setManager(address rewardVault, address manager) external {
address sender = _msgSender();
lbgtManager[sender][rewardVault] = manager;
emit ManagerSet(sender, rewardVault, manager);
}
/// @inheritdoc IBeraPawForge
function setManagerMulti(address[] calldata rewardVaults, address[] calldata managers) external {
require(rewardVaults.length == managers.length, InvalidInput());
require(rewardVaults.length > 0, InvalidInput());
address sender = _msgSender();
for (uint256 i = 0; i < rewardVaults.length; i++) {
address rewardVault = rewardVaults[i];
address manager = managers[i];
lbgtManager[sender][rewardVault] = manager;
emit ManagerSet(sender, rewardVault, manager);
}
}
/// @inheritdoc IBeraPawForge
function mint(
address user,
address rewardVault,
address recipient
)
external
nonReentrant
whenNotPaused
returns (uint256)
{
return _mintLbgtTo(rewardVault, user, recipient);
}
/// @inheritdoc IBeraPawForge
function mintReferred(
address user,
address rewardVault,
address recipient,
bytes32 data
)
external
nonReentrant
whenNotPaused
returns (uint256)
{
uint256 amount = _mintLbgtTo(rewardVault, user, recipient);
emit Referred(user, data, amount);
return amount;
}
/// @inheritdoc IBeraPawForge
function mintMulti(
address[] calldata users,
address[] calldata rewardVaults,
address[] calldata recipients
)
external
nonReentrant
whenNotPaused
returns (uint256)
{
require(rewardVaults.length == users.length && users.length == recipients.length, InvalidInput());
uint256 bgtBalanceBefore = bgt.balanceOf(address(this));
uint256 totalAmount = 0;
uint256 vaultLength = rewardVaults.length;
for (uint256 index = 0; index < vaultLength;) {
totalAmount += _mintLbgtTo(rewardVaults[index], users[index], recipients[index]);
unchecked {
++index;
}
}
assert(bgt.balanceOf(address(this)) - totalAmount == bgtBalanceBefore);
return totalAmount;
}
/// @inheritdoc IBeraPawForge
function queueRedeem(uint128 amount) external whenNotPaused {
require(amount >= minimumRedeemAmount, InvalidInput());
address sender = _msgSender();
RedeemPosition storage position = redeemPosition[sender];
// Prevent duplicate queue entries for the same user
require(position.queued == 0, AlreadyQueued());
unchecked {
position.queued += amount;
totalRedeemQueue += amount;
}
// Unsafely cast block number to uint96, should never overflow.
redeemQueue.push(RedeemQueue(sender, uint96(block.number)));
// Transfer LBGT to contract as a precondition
SafeERC20.safeTransferFrom(lbgt, sender, address(this), amount);
emit RedeemQueued(sender, amount);
}
/// @inheritdoc IBeraPawForge
function redeem(uint128 amount, address recipient) external whenNotPaused {
require(recipient != address(0), ZeroAddress());
require(amount > 0, ZeroAmount());
address sender = _msgSender();
RedeemPosition storage position = redeemPosition[sender];
require(amount <= position.available, RedeemNotAvailable(amount));
unchecked {
position.available -= amount;
}
payable(recipient).transfer(amount);
emit Redeemed(sender, recipient, amount);
}
/// @inheritdoc IBeraPawForge
function processRedemptions(uint128 maxBatchSize, address recipient) external payable whenNotPaused {
require(isProcessRedemptionsOpen || hasRole(ROLE_REDEMPTIONS_PROCESSOR, _msgSender()), NotAuthorized());
uint128 queuePosition = redeemQueueIndex;
uint128 maxQueuePosition =
uint128(Math.min(uint256(queuePosition + maxBatchSize), uint256(redeemQueue.length - 1)));
uint256 beraRemaining = msg.value;
uint96 blockDelay = queueDelay;
uint256 feePercentual = processingFee;
uint256 lbgtToTransfer;
uint256 lbgtToBurn;
uint128 lbgtUnqueued;
while (queuePosition <= maxQueuePosition) {
RedeemQueue memory queueRequest = redeemQueue[queuePosition];
RedeemPosition memory position = redeemPosition[queueRequest.account];
if (position.queued == 0) {
// Nothing to do here, skip to the next position in queue.
++queuePosition;
continue;
}
// The fee is discounted from the solver payment.
uint256 fee = Math.mulDiv(position.queued, feePercentual, ONE_HUNDRED_PERCENT);
uint256 amount = position.queued - fee;
if (beraRemaining >= amount) {
unchecked {
redeemPosition[queueRequest.account] =
RedeemPosition(0, position.available + SafeCast.toUint128(amount));
beraRemaining = beraRemaining - amount;
lbgtToTransfer += position.queued;
}
} else if (block.number >= queueRequest.blockNumber + blockDelay) {
unchecked {
redeemPosition[queueRequest.account] =
RedeemPosition(0, position.available + SafeCast.toUint128(amount));
lbgtToBurn += amount - beraRemaining; // amount > beraRemaining
lbgtToTransfer += fee + beraRemaining;
beraRemaining = 0;
}
} else {
// Nothing to do here, no bera to be paid for the lbgt and not enough time for redeem have passed.
break;
}
lbgtUnqueued += position.queued;
// Recover some gas
delete redeemQueue[queuePosition];
emit RedeemProcessed(queueRequest.account, recipient, amount);
// Move to next user in queue
unchecked {
++queuePosition;
}
}
redeemQueueIndex = queuePosition;
totalRedeemQueue -= lbgtUnqueued;
if (lbgtToBurn > 0) {
_burn(address(this), lbgtToBurn);
bgt.redeem(address(this), lbgtToBurn);
}
if (beraRemaining > 0) {
SafeTransferLib.safeTransferETH(_msgSender(), beraRemaining); // Give back bera not used + fee.
}
if (lbgtToTransfer > 0) {
SafeERC20.safeTransfer(lbgt, recipient, lbgtToTransfer);
}
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* REWARDS FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @inheritdoc IBeraPawForge
function collectStakerReward(address to) external onlyRole(ROLE_REWARD_COLLECTOR) returns (uint256) {
uint256 amount = bgtStaker.getReward();
honey.safeTransfer(to, amount);
emit StakerRewardCollected(msg.sender, to, amount);
return amount;
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* BOOSTER FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @inheritdoc IBeraPawForge
function queueBoost(bytes calldata pubkey, uint128 amount) external onlyRole(ROLE_BOOSTER) {
return bgt.queueBoost(pubkey, amount);
}
/// @inheritdoc IBeraPawForge
function cancelBoost(bytes calldata pubkey, uint128 amount) external onlyRole(ROLE_BOOSTER) {
return bgt.cancelBoost(pubkey, amount);
}
/// @inheritdoc IBeraPawForge
function activateBoost(bytes calldata pubkey) external onlyRole(ROLE_BOOSTER) returns (bool) {
return bgt.activateBoost(address(this), pubkey);
}
/// @inheritdoc IBeraPawForge
function queueDropBoost(bytes calldata pubkey, uint128 amount) external onlyRole(ROLE_BOOSTER) {
return bgt.queueDropBoost(pubkey, amount);
}
/// @inheritdoc IBeraPawForge
function cancelDropBoost(bytes calldata pubkey, uint128 amount) external onlyRole(ROLE_BOOSTER) {
return bgt.cancelDropBoost(pubkey, amount);
}
/// @inheritdoc IBeraPawForge
function dropBoost(bytes calldata pubkey) external onlyRole(ROLE_BOOSTER) returns (bool) {
return bgt.dropBoost(address(this), pubkey);
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* VIEW FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @inheritdoc IBeraPawForge
function lbgtAddress() public pure returns (address) {
return address(lbgt);
}
/// @inheritdoc IBeraPawForge
function getBGTOperator(address rewardVault, address account) public view returns (address) {
return IRewardVault(rewardVault).operator(account);
}
/// @inheritdoc IBeraPawForge
function boostableBGT() public view returns (uint256) {
return bgt.balanceOf(address(this)) - totalRedeemQueue;
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* INTERNAL FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
function _authorizeUpgrade(address newImplementation) internal override onlyRole(ROLE_GOD) { }
function _mintLbgtTo(
address _rewardVault,
address _user,
address _recipient
)
internal
onlyUserOrManager(_user, _rewardVault)
returns (uint256)
{
require(_rewardVault != address(0), ZeroAddress());
require(_recipient != address(0), ZeroAddress());
require(_user != address(0), ZeroAddress());
// We have to break checks effects interactions pattern because we can only know the reward
// after calling the vault, the vault cannot be assumed to be trustworthy so we need to check
// for reentrancy on all external functions that use this. Checks are done after the call to
// the vault in order to make sure we are not cheated on the reward amount.
uint256 bgtBalanceBefore = bgt.balanceOf(address(this));
IRewardVault(_rewardVault).getReward(_user, address(this)); // dont trust amount returned
uint256 bgtBalanceAfter = bgt.balanceOf(address(this));
require(bgtBalanceAfter > bgtBalanceBefore, IncorrectBGTReward());
uint256 amount;
unchecked {
amount = bgtBalanceAfter - bgtBalanceBefore;
}
_mint(_recipient, amount);
emit LBGTMinted(_user, _rewardVault, _recipient, amount);
return amount;
}
function _mint(address to, uint256 amount) internal {
lbgt.mint(to, amount);
}
function _burn(address from, uint256 amount) internal {
lbgt.burn(from, amount);
}
receive() external payable { }
fallback() external payable { }
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/AccessControl.sol)
pragma solidity ^0.8.20;
import {IAccessControl} from "@openzeppelin/contracts/access/IAccessControl.sol";
import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol";
import {ERC165Upgradeable} from "../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, IAccessControl, ERC165Upgradeable {
struct RoleData {
mapping(address account => bool) hasRole;
bytes32 adminRole;
}
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
/// @custom:storage-location erc7201:openzeppelin.storage.AccessControl
struct AccessControlStorage {
mapping(bytes32 role => RoleData) _roles;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.AccessControl")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant AccessControlStorageLocation = 0x02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b626800;
function _getAccessControlStorage() private pure returns (AccessControlStorage storage $) {
assembly {
$.slot := AccessControlStorageLocation
}
}
/**
* @dev Modifier that checks that an account has a specific role. Reverts
* with an {AccessControlUnauthorizedAccount} error including the required role.
*/
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(IAccessControl).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) public view virtual returns (bool) {
AccessControlStorage storage $ = _getAccessControlStorage();
return $._roles[role].hasRole[account];
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `_msgSender()`
* is missing `role`. Overriding this function changes the behavior of the {onlyRole} modifier.
*/
function _checkRole(bytes32 role) internal view virtual {
_checkRole(role, _msgSender());
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `account`
* is missing `role`.
*/
function _checkRole(bytes32 role, address account) internal view virtual {
if (!hasRole(role, account)) {
revert AccessControlUnauthorizedAccount(account, role);
}
}
/**
* @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 returns (bytes32) {
AccessControlStorage storage $ = _getAccessControlStorage();
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 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 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 `callerConfirmation`.
*
* May emit a {RoleRevoked} event.
*/
function renounceRole(bytes32 role, address callerConfirmation) public virtual {
if (callerConfirmation != _msgSender()) {
revert AccessControlBadConfirmation();
}
_revokeRole(role, callerConfirmation);
}
/**
* @dev Sets `adminRole` as ``role``'s admin role.
*
* Emits a {RoleAdminChanged} event.
*/
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
AccessControlStorage storage $ = _getAccessControlStorage();
bytes32 previousAdminRole = getRoleAdmin(role);
$._roles[role].adminRole = adminRole;
emit RoleAdminChanged(role, previousAdminRole, adminRole);
}
/**
* @dev Attempts to grant `role` to `account` and returns a boolean indicating if `role` was granted.
*
* Internal function without access restriction.
*
* May emit a {RoleGranted} event.
*/
function _grantRole(bytes32 role, address account) internal virtual returns (bool) {
AccessControlStorage storage $ = _getAccessControlStorage();
if (!hasRole(role, account)) {
$._roles[role].hasRole[account] = true;
emit RoleGranted(role, account, _msgSender());
return true;
} else {
return false;
}
}
/**
* @dev Attempts to revoke `role` to `account` and returns a boolean indicating if `role` was revoked.
*
* Internal function without access restriction.
*
* May emit a {RoleRevoked} event.
*/
function _revokeRole(bytes32 role, address account) internal virtual returns (bool) {
AccessControlStorage storage $ = _getAccessControlStorage();
if (hasRole(role, account)) {
$._roles[role].hasRole[account] = false;
emit RoleRevoked(role, account, _msgSender());
return true;
} else {
return false;
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.20;
/**
* @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 Storage of the initializable contract.
*
* It's implemented on a custom ERC-7201 namespace to reduce the risk of storage collisions
* when using with upgradeable contracts.
*
* @custom:storage-location erc7201:openzeppelin.storage.Initializable
*/
struct InitializableStorage {
/**
* @dev Indicates that the contract has been initialized.
*/
uint64 _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool _initializing;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Initializable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant INITIALIZABLE_STORAGE = 0xf0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00;
/**
* @dev The contract is already initialized.
*/
error InvalidInitialization();
/**
* @dev The contract is not initializing.
*/
error NotInitializing();
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint64 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 in the context of a constructor an `initializer` may be invoked any
* number of times. This behavior in the constructor can be useful during testing and is not expected to be used in
* production.
*
* Emits an {Initialized} event.
*/
modifier initializer() {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
// Cache values to avoid duplicated sloads
bool isTopLevelCall = !$._initializing;
uint64 initialized = $._initialized;
// Allowed calls:
// - initialSetup: the contract is not in the initializing state and no previous version was
// initialized
// - construction: the contract is initialized at version 1 (no reininitialization) and the
// current contract is just being deployed
bool initialSetup = initialized == 0 && isTopLevelCall;
bool construction = initialized == 1 && address(this).code.length == 0;
if (!initialSetup && !construction) {
revert InvalidInitialization();
}
$._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 2**64 - 1 will prevent any future reinitialization.
*
* Emits an {Initialized} event.
*/
modifier reinitializer(uint64 version) {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
if ($._initializing || $._initialized >= version) {
revert InvalidInitialization();
}
$._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() {
_checkInitializing();
_;
}
/**
* @dev Reverts if the contract is not in an initializing state. See {onlyInitializing}.
*/
function _checkInitializing() internal view virtual {
if (!_isInitializing()) {
revert NotInitializing();
}
}
/**
* @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 {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
if ($._initializing) {
revert InvalidInitialization();
}
if ($._initialized != type(uint64).max) {
$._initialized = type(uint64).max;
emit Initialized(type(uint64).max);
}
}
/**
* @dev Returns the highest version that has been initialized. See {reinitializer}.
*/
function _getInitializedVersion() internal view returns (uint64) {
return _getInitializableStorage()._initialized;
}
/**
* @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
*/
function _isInitializing() internal view returns (bool) {
return _getInitializableStorage()._initializing;
}
/**
* @dev Returns a pointer to the storage namespace.
*/
// solhint-disable-next-line var-name-mixedcase
function _getInitializableStorage() private pure returns (InitializableStorage storage $) {
assembly {
$.slot := INITIALIZABLE_STORAGE
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (proxy/utils/UUPSUpgradeable.sol)
pragma solidity ^0.8.20;
import {IERC1822Proxiable} from "@openzeppelin/contracts/interfaces/draft-IERC1822.sol";
import {ERC1967Utils} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Utils.sol";
import {Initializable} from "./Initializable.sol";
/**
* @dev An upgradeability mechanism designed for UUPS proxies. The functions included here can perform an upgrade of an
* {ERC1967Proxy}, when this contract is set as the implementation behind such a proxy.
*
* A security mechanism ensures that an upgrade does not turn off upgradeability accidentally, although this risk is
* reinstated if the upgrade retains upgradeability but removes the security mechanism, e.g. by replacing
* `UUPSUpgradeable` with a custom implementation of upgrades.
*
* The {_authorizeUpgrade} function must be overridden to include access restriction to the upgrade mechanism.
*/
abstract contract UUPSUpgradeable is Initializable, IERC1822Proxiable {
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable
address private immutable __self = address(this);
/**
* @dev The version of the upgrade interface of the contract. If this getter is missing, both `upgradeTo(address)`
* and `upgradeToAndCall(address,bytes)` are present, and `upgradeTo` must be used if no function should be called,
* while `upgradeToAndCall` will invoke the `receive` function if the second argument is the empty byte string.
* If the getter returns `"5.0.0"`, only `upgradeToAndCall(address,bytes)` is present, and the second argument must
* be the empty byte string if no function should be called, making it impossible to invoke the `receive` function
* during an upgrade.
*/
string public constant UPGRADE_INTERFACE_VERSION = "5.0.0";
/**
* @dev The call is from an unauthorized context.
*/
error UUPSUnauthorizedCallContext();
/**
* @dev The storage `slot` is unsupported as a UUID.
*/
error UUPSUnsupportedProxiableUUID(bytes32 slot);
/**
* @dev Check that the execution is being performed through a delegatecall call and that the execution context is
* a proxy contract with an implementation (as defined in ERC-1967) pointing to self. This should only be the case
* for UUPS and transparent proxies that are using the current contract as their implementation. Execution of a
* function through ERC-1167 minimal proxies (clones) would not normally pass this test, but is not guaranteed to
* fail.
*/
modifier onlyProxy() {
_checkProxy();
_;
}
/**
* @dev Check that the execution is not being performed through a delegate call. This allows a function to be
* callable on the implementing contract but not through proxies.
*/
modifier notDelegated() {
_checkNotDelegated();
_;
}
function __UUPSUpgradeable_init() internal onlyInitializing {
}
function __UUPSUpgradeable_init_unchained() internal onlyInitializing {
}
/**
* @dev Implementation of the ERC-1822 {proxiableUUID} function. This returns the storage slot used by the
* implementation. It is used to validate the implementation's compatibility when performing an upgrade.
*
* IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks
* bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this
* function revert if invoked through a proxy. This is guaranteed by the `notDelegated` modifier.
*/
function proxiableUUID() external view virtual notDelegated returns (bytes32) {
return ERC1967Utils.IMPLEMENTATION_SLOT;
}
/**
* @dev Upgrade the implementation of the proxy to `newImplementation`, and subsequently execute the function call
* encoded in `data`.
*
* Calls {_authorizeUpgrade}.
*
* Emits an {Upgraded} event.
*
* @custom:oz-upgrades-unsafe-allow-reachable delegatecall
*/
function upgradeToAndCall(address newImplementation, bytes memory data) public payable virtual onlyProxy {
_authorizeUpgrade(newImplementation);
_upgradeToAndCallUUPS(newImplementation, data);
}
/**
* @dev Reverts if the execution is not performed via delegatecall or the execution
* context is not of a proxy with an ERC-1967 compliant implementation pointing to self.
* See {_onlyProxy}.
*/
function _checkProxy() internal view virtual {
if (
address(this) == __self || // Must be called through delegatecall
ERC1967Utils.getImplementation() != __self // Must be called through an active proxy
) {
revert UUPSUnauthorizedCallContext();
}
}
/**
* @dev Reverts if the execution is performed via delegatecall.
* See {notDelegated}.
*/
function _checkNotDelegated() internal view virtual {
if (address(this) != __self) {
// Must not be called through delegatecall
revert UUPSUnauthorizedCallContext();
}
}
/**
* @dev Function that should revert when `msg.sender` is not authorized to upgrade the contract. Called by
* {upgradeToAndCall}.
*
* Normally, this function will use an xref:access.adoc[access control] modifier such as {Ownable-onlyOwner}.
*
* ```solidity
* function _authorizeUpgrade(address) internal onlyOwner {}
* ```
*/
function _authorizeUpgrade(address newImplementation) internal virtual;
/**
* @dev Performs an implementation upgrade with a security check for UUPS proxies, and additional setup call.
*
* As a security check, {proxiableUUID} is invoked in the new implementation, and the return value
* is expected to be the implementation slot in ERC-1967.
*
* Emits an {IERC1967-Upgraded} event.
*/
function _upgradeToAndCallUUPS(address newImplementation, bytes memory data) private {
try IERC1822Proxiable(newImplementation).proxiableUUID() returns (bytes32 slot) {
if (slot != ERC1967Utils.IMPLEMENTATION_SLOT) {
revert UUPSUnsupportedProxiableUUID(slot);
}
ERC1967Utils.upgradeToAndCall(newImplementation, data);
} catch {
// The implementation is not UUPS
revert ERC1967Utils.ERC1967InvalidImplementation(newImplementation);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Pausable.sol)
pragma solidity ^0.8.20;
import {ContextUpgradeable} from "../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 {
/// @custom:storage-location erc7201:openzeppelin.storage.Pausable
struct PausableStorage {
bool _paused;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Pausable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant PausableStorageLocation = 0xcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f03300;
function _getPausableStorage() private pure returns (PausableStorage storage $) {
assembly {
$.slot := PausableStorageLocation
}
}
/**
* @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);
/**
* @dev The operation failed because the contract is paused.
*/
error EnforcedPause();
/**
* @dev The operation failed because the contract is not paused.
*/
error ExpectedPause();
/**
* @dev Initializes the contract in unpaused state.
*/
function __Pausable_init() internal onlyInitializing {
__Pausable_init_unchained();
}
function __Pausable_init_unchained() internal onlyInitializing {
PausableStorage storage $ = _getPausableStorage();
$._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) {
PausableStorage storage $ = _getPausableStorage();
return $._paused;
}
/**
* @dev Throws if the contract is paused.
*/
function _requireNotPaused() internal view virtual {
if (paused()) {
revert EnforcedPause();
}
}
/**
* @dev Throws if the contract is not paused.
*/
function _requirePaused() internal view virtual {
if (!paused()) {
revert ExpectedPause();
}
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/
function _pause() internal virtual whenNotPaused {
PausableStorage storage $ = _getPausableStorage();
$._paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
PausableStorage storage $ = _getPausableStorage();
$._paused = false;
emit Unpaused(_msgSender());
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/ReentrancyGuard.sol)
pragma solidity ^0.8.20;
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 EIP-1153 (transient storage) is available on the chain you're deploying at,
* consider using {ReentrancyGuardTransient} instead.
*
* 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;
/// @custom:storage-location erc7201:openzeppelin.storage.ReentrancyGuard
struct ReentrancyGuardStorage {
uint256 _status;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ReentrancyGuard")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant ReentrancyGuardStorageLocation = 0x9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f00;
function _getReentrancyGuardStorage() private pure returns (ReentrancyGuardStorage storage $) {
assembly {
$.slot := ReentrancyGuardStorageLocation
}
}
/**
* @dev Unauthorized reentrant call.
*/
error ReentrancyGuardReentrantCall();
function __ReentrancyGuard_init() internal onlyInitializing {
__ReentrancyGuard_init_unchained();
}
function __ReentrancyGuard_init_unchained() internal onlyInitializing {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
$._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 {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
// On the first call to nonReentrant, _status will be NOT_ENTERED
if ($._status == ENTERED) {
revert ReentrancyGuardReentrantCall();
}
// Any calls to nonReentrant after this point will fail
$._status = ENTERED;
}
function _nonReentrantAfter() private {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
// 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) {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
return $._status == ENTERED;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC1363} from "../../../interfaces/IERC1363.sol";
import {Address} from "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC-20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
/**
* @dev An operation with an ERC-20 token failed.
*/
error SafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/
error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20 token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, 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.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
forceApprove(token, spender, oldAllowance + value);
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
* value, non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
unchecked {
uint256 currentAllowance = token.allowance(address(this), spender);
if (currentAllowance < requestedDecrease) {
revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
}
forceApprove(token, spender, currentAllowance - requestedDecrease);
}
}
/**
* @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.
*
* NOTE: If the token implements ERC-7674, this function will not modify any temporary allowance. This function
* only sets the "standard" allowance. Any temporary allowance will remain active, in addition to the value being
* set here.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Performs an {ERC1363} transferAndCall, with a fallback to the simple {ERC20} transfer if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
safeTransfer(token, to, value);
} else if (!token.transferAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} transferFromAndCall, with a fallback to the simple {ERC20} transferFrom if the target
* has no code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferFromAndCallRelaxed(
IERC1363 token,
address from,
address to,
uint256 value,
bytes memory data
) internal {
if (to.code.length == 0) {
safeTransferFrom(token, from, to, value);
} else if (!token.transferFromAndCall(from, to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} approveAndCall, with a fallback to the simple {ERC20} approve if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* NOTE: When the recipient address (`to`) has no code (i.e. is an EOA), this function behaves as {forceApprove}.
* Opposedly, when the recipient address (`to`) has code, this function only attempts to call {ERC1363-approveAndCall}
* once without retrying, and relies on the returned value to be true.
*
* Reverts if the returned value is other than `true`.
*/
function approveAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
forceApprove(token, to, value);
} else if (!token.approveAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @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 {_callOptionalReturnBool} that reverts if call fails to meet the requirements.
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
let success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
// bubble errors
if iszero(success) {
let ptr := mload(0x40)
returndatacopy(ptr, 0, returndatasize())
revert(ptr, returndatasize())
}
returnSize := returndatasize()
returnValue := mload(0)
}
if (returnSize == 0 ? address(token).code.length == 0 : returnValue != 1) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @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 silently catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
bool success;
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
returnSize := returndatasize()
returnValue := mload(0)
}
return success && (returnSize == 0 ? address(token).code.length > 0 : returnValue == 1);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-20 standard as defined in the ERC.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the value of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves a `value` amount of 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 value) 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 a `value` amount of tokens 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 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the
* allowance mechanism. `value` 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 value) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/math/Math.sol)
pragma solidity ^0.8.20;
import {Panic} from "../Panic.sol";
import {SafeCast} from "./SafeCast.sol";
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
enum Rounding {
Floor, // Toward negative infinity
Ceil, // Toward positive infinity
Trunc, // Toward zero
Expand // Away from zero
}
/**
* @dev Returns the addition of two unsigned integers, with an success flag (no overflow).
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a + b;
if (c < a) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the subtraction of two unsigned integers, with an success flag (no overflow).
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
if (b > a) return (false, 0);
return (true, a - b);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with an success flag (no overflow).
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
if (a == 0) return (true, 0);
uint256 c = a * b;
if (c / a != b) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the division of two unsigned integers, with a success flag (no division by zero).
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
if (b == 0) return (false, 0);
return (true, a / b);
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a success flag (no division by zero).
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
if (b == 0) return (false, 0);
return (true, a % b);
}
}
/**
* @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant.
*
* IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.
* However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute
* one branch when needed, making this function more expensive.
*/
function ternary(bool condition, uint256 a, uint256 b) internal pure returns (uint256) {
unchecked {
// branchless ternary works because:
// b ^ (a ^ b) == a
// b ^ 0 == b
return b ^ ((a ^ b) * SafeCast.toUint(condition));
}
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(a > b, a, b);
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(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 towards infinity instead
* of rounding towards zero.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
if (b == 0) {
// Guarantee the same behavior as in a regular Solidity division.
Panic.panic(Panic.DIVISION_BY_ZERO);
}
// The following calculation ensures accurate ceiling division without overflow.
// Since a is non-zero, (a - 1) / b will not overflow.
// The largest possible result occurs when (a - 1) / b is type(uint256).max,
// but the largest value we can obtain is type(uint256).max - 1, which happens
// when a = type(uint256).max and b = 1.
unchecked {
return SafeCast.toUint(a > 0) * ((a - 1) / b + 1);
}
}
/**
* @dev Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
* denominator == 0.
*
* 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²⁵⁶ and mod 2²⁵⁶ - 1, then use
// the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = prod1 * 2²⁵⁶ + prod0.
uint256 prod0 = x * y; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(x, y, not(0))
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²⁵⁶. Also prevents denominator == 0.
if (denominator <= prod1) {
Panic.panic(ternary(denominator == 0, Panic.DIVISION_BY_ZERO, Panic.UNDER_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.
uint256 twos = denominator & (0 - denominator);
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²⁵⁶ / 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²⁵⁶. Now that denominator is an odd number, it has an inverse modulo 2²⁵⁶ such
// that denominator * inv ≡ 1 mod 2²⁵⁶. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv ≡ 1 mod 2⁴.
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⁸
inverse *= 2 - denominator * inverse; // inverse mod 2¹⁶
inverse *= 2 - denominator * inverse; // inverse mod 2³²
inverse *= 2 - denominator * inverse; // inverse mod 2⁶⁴
inverse *= 2 - denominator * inverse; // inverse mod 2¹²⁸
inverse *= 2 - denominator * inverse; // inverse mod 2²⁵⁶
// 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²⁵⁶. Since the preconditions guarantee that the outcome is
// less than 2²⁵⁶, 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;
}
}
/**
* @dev 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) {
return mulDiv(x, y, denominator) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0);
}
/**
* @dev Calculate the modular multiplicative inverse of a number in Z/nZ.
*
* If n is a prime, then Z/nZ is a field. In that case all elements are inversible, except 0.
* If n is not a prime, then Z/nZ is not a field, and some elements might not be inversible.
*
* If the input value is not inversible, 0 is returned.
*
* NOTE: If you know for sure that n is (big) a prime, it may be cheaper to use Fermat's little theorem and get the
* inverse using `Math.modExp(a, n - 2, n)`. See {invModPrime}.
*/
function invMod(uint256 a, uint256 n) internal pure returns (uint256) {
unchecked {
if (n == 0) return 0;
// The inverse modulo is calculated using the Extended Euclidean Algorithm (iterative version)
// Used to compute integers x and y such that: ax + ny = gcd(a, n).
// When the gcd is 1, then the inverse of a modulo n exists and it's x.
// ax + ny = 1
// ax = 1 + (-y)n
// ax ≡ 1 (mod n) # x is the inverse of a modulo n
// If the remainder is 0 the gcd is n right away.
uint256 remainder = a % n;
uint256 gcd = n;
// Therefore the initial coefficients are:
// ax + ny = gcd(a, n) = n
// 0a + 1n = n
int256 x = 0;
int256 y = 1;
while (remainder != 0) {
uint256 quotient = gcd / remainder;
(gcd, remainder) = (
// The old remainder is the next gcd to try.
remainder,
// Compute the next remainder.
// Can't overflow given that (a % gcd) * (gcd // (a % gcd)) <= gcd
// where gcd is at most n (capped to type(uint256).max)
gcd - remainder * quotient
);
(x, y) = (
// Increment the coefficient of a.
y,
// Decrement the coefficient of n.
// Can overflow, but the result is casted to uint256 so that the
// next value of y is "wrapped around" to a value between 0 and n - 1.
x - y * int256(quotient)
);
}
if (gcd != 1) return 0; // No inverse exists.
return ternary(x < 0, n - uint256(-x), uint256(x)); // Wrap the result if it's negative.
}
}
/**
* @dev Variant of {invMod}. More efficient, but only works if `p` is known to be a prime greater than `2`.
*
* From https://en.wikipedia.org/wiki/Fermat%27s_little_theorem[Fermat's little theorem], we know that if p is
* prime, then `a**(p-1) ≡ 1 mod p`. As a consequence, we have `a * a**(p-2) ≡ 1 mod p`, which means that
* `a**(p-2)` is the modular multiplicative inverse of a in Fp.
*
* NOTE: this function does NOT check that `p` is a prime greater than `2`.
*/
function invModPrime(uint256 a, uint256 p) internal view returns (uint256) {
unchecked {
return Math.modExp(a, p - 2, p);
}
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m)
*
* Requirements:
* - modulus can't be zero
* - underlying staticcall to precompile must succeed
*
* IMPORTANT: The result is only valid if the underlying call succeeds. When using this function, make
* sure the chain you're using it on supports the precompiled contract for modular exponentiation
* at address 0x05 as specified in https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise,
* the underlying function will succeed given the lack of a revert, but the result may be incorrectly
* interpreted as 0.
*/
function modExp(uint256 b, uint256 e, uint256 m) internal view returns (uint256) {
(bool success, uint256 result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m).
* It includes a success flag indicating if the operation succeeded. Operation will be marked as failed if trying
* to operate modulo 0 or if the underlying precompile reverted.
*
* IMPORTANT: The result is only valid if the success flag is true. When using this function, make sure the chain
* you're using it on supports the precompiled contract for modular exponentiation at address 0x05 as specified in
* https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise, the underlying function will succeed given the lack
* of a revert, but the result may be incorrectly interpreted as 0.
*/
function tryModExp(uint256 b, uint256 e, uint256 m) internal view returns (bool success, uint256 result) {
if (m == 0) return (false, 0);
assembly ("memory-safe") {
let ptr := mload(0x40)
// | Offset | Content | Content (Hex) |
// |-----------|------------|--------------------------------------------------------------------|
// | 0x00:0x1f | size of b | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x20:0x3f | size of e | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x40:0x5f | size of m | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x60:0x7f | value of b | 0x<.............................................................b> |
// | 0x80:0x9f | value of e | 0x<.............................................................e> |
// | 0xa0:0xbf | value of m | 0x<.............................................................m> |
mstore(ptr, 0x20)
mstore(add(ptr, 0x20), 0x20)
mstore(add(ptr, 0x40), 0x20)
mstore(add(ptr, 0x60), b)
mstore(add(ptr, 0x80), e)
mstore(add(ptr, 0xa0), m)
// Given the result < m, it's guaranteed to fit in 32 bytes,
// so we can use the memory scratch space located at offset 0.
success := staticcall(gas(), 0x05, ptr, 0xc0, 0x00, 0x20)
result := mload(0x00)
}
}
/**
* @dev Variant of {modExp} that supports inputs of arbitrary length.
*/
function modExp(bytes memory b, bytes memory e, bytes memory m) internal view returns (bytes memory) {
(bool success, bytes memory result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Variant of {tryModExp} that supports inputs of arbitrary length.
*/
function tryModExp(
bytes memory b,
bytes memory e,
bytes memory m
) internal view returns (bool success, bytes memory result) {
if (_zeroBytes(m)) return (false, new bytes(0));
uint256 mLen = m.length;
// Encode call args in result and move the free memory pointer
result = abi.encodePacked(b.length, e.length, mLen, b, e, m);
assembly ("memory-safe") {
let dataPtr := add(result, 0x20)
// Write result on top of args to avoid allocating extra memory.
success := staticcall(gas(), 0x05, dataPtr, mload(result), dataPtr, mLen)
// Overwrite the length.
// result.length > returndatasize() is guaranteed because returndatasize() == m.length
mstore(result, mLen)
// Set the memory pointer after the returned data.
mstore(0x40, add(dataPtr, mLen))
}
}
/**
* @dev Returns whether the provided byte array is zero.
*/
function _zeroBytes(bytes memory byteArray) private pure returns (bool) {
for (uint256 i = 0; i < byteArray.length; ++i) {
if (byteArray[i] != 0) {
return false;
}
}
return true;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded
* towards zero.
*
* This method is based on Newton's method for computing square roots; the algorithm is restricted to only
* using integer operations.
*/
function sqrt(uint256 a) internal pure returns (uint256) {
unchecked {
// Take care of easy edge cases when a == 0 or a == 1
if (a <= 1) {
return a;
}
// In this function, we use Newton's method to get a root of `f(x) := x² - a`. It involves building a
// sequence x_n that converges toward sqrt(a). For each iteration x_n, we also define the error between
// the current value as `ε_n = | x_n - sqrt(a) |`.
//
// For our first estimation, we consider `e` the smallest power of 2 which is bigger than the square root
// of the target. (i.e. `2**(e-1) ≤ sqrt(a) < 2**e`). We know that `e ≤ 128` because `(2¹²⁸)² = 2²⁵⁶` is
// bigger than any uint256.
//
// By noticing that
// `2**(e-1) ≤ sqrt(a) < 2**e → (2**(e-1))² ≤ a < (2**e)² → 2**(2*e-2) ≤ a < 2**(2*e)`
// we can deduce that `e - 1` is `log2(a) / 2`. We can thus compute `x_n = 2**(e-1)` using a method similar
// to the msb function.
uint256 aa = a;
uint256 xn = 1;
if (aa >= (1 << 128)) {
aa >>= 128;
xn <<= 64;
}
if (aa >= (1 << 64)) {
aa >>= 64;
xn <<= 32;
}
if (aa >= (1 << 32)) {
aa >>= 32;
xn <<= 16;
}
if (aa >= (1 << 16)) {
aa >>= 16;
xn <<= 8;
}
if (aa >= (1 << 8)) {
aa >>= 8;
xn <<= 4;
}
if (aa >= (1 << 4)) {
aa >>= 4;
xn <<= 2;
}
if (aa >= (1 << 2)) {
xn <<= 1;
}
// We now have x_n such that `x_n = 2**(e-1) ≤ sqrt(a) < 2**e = 2 * x_n`. This implies ε_n ≤ 2**(e-1).
//
// We can refine our estimation by noticing that the middle of that interval minimizes the error.
// If we move x_n to equal 2**(e-1) + 2**(e-2), then we reduce the error to ε_n ≤ 2**(e-2).
// This is going to be our x_0 (and ε_0)
xn = (3 * xn) >> 1; // ε_0 := | x_0 - sqrt(a) | ≤ 2**(e-2)
// From here, Newton's method give us:
// x_{n+1} = (x_n + a / x_n) / 2
//
// One should note that:
// x_{n+1}² - a = ((x_n + a / x_n) / 2)² - a
// = ((x_n² + a) / (2 * x_n))² - a
// = (x_n⁴ + 2 * a * x_n² + a²) / (4 * x_n²) - a
// = (x_n⁴ + 2 * a * x_n² + a² - 4 * a * x_n²) / (4 * x_n²)
// = (x_n⁴ - 2 * a * x_n² + a²) / (4 * x_n²)
// = (x_n² - a)² / (2 * x_n)²
// = ((x_n² - a) / (2 * x_n))²
// ≥ 0
// Which proves that for all n ≥ 1, sqrt(a) ≤ x_n
//
// This gives us the proof of quadratic convergence of the sequence:
// ε_{n+1} = | x_{n+1} - sqrt(a) |
// = | (x_n + a / x_n) / 2 - sqrt(a) |
// = | (x_n² + a - 2*x_n*sqrt(a)) / (2 * x_n) |
// = | (x_n - sqrt(a))² / (2 * x_n) |
// = | ε_n² / (2 * x_n) |
// = ε_n² / | (2 * x_n) |
//
// For the first iteration, we have a special case where x_0 is known:
// ε_1 = ε_0² / | (2 * x_0) |
// ≤ (2**(e-2))² / (2 * (2**(e-1) + 2**(e-2)))
// ≤ 2**(2*e-4) / (3 * 2**(e-1))
// ≤ 2**(e-3) / 3
// ≤ 2**(e-3-log2(3))
// ≤ 2**(e-4.5)
//
// For the following iterations, we use the fact that, 2**(e-1) ≤ sqrt(a) ≤ x_n:
// ε_{n+1} = ε_n² / | (2 * x_n) |
// ≤ (2**(e-k))² / (2 * 2**(e-1))
// ≤ 2**(2*e-2*k) / 2**e
// ≤ 2**(e-2*k)
xn = (xn + a / xn) >> 1; // ε_1 := | x_1 - sqrt(a) | ≤ 2**(e-4.5) -- special case, see above
xn = (xn + a / xn) >> 1; // ε_2 := | x_2 - sqrt(a) | ≤ 2**(e-9) -- general case with k = 4.5
xn = (xn + a / xn) >> 1; // ε_3 := | x_3 - sqrt(a) | ≤ 2**(e-18) -- general case with k = 9
xn = (xn + a / xn) >> 1; // ε_4 := | x_4 - sqrt(a) | ≤ 2**(e-36) -- general case with k = 18
xn = (xn + a / xn) >> 1; // ε_5 := | x_5 - sqrt(a) | ≤ 2**(e-72) -- general case with k = 36
xn = (xn + a / xn) >> 1; // ε_6 := | x_6 - sqrt(a) | ≤ 2**(e-144) -- general case with k = 72
// Because e ≤ 128 (as discussed during the first estimation phase), we know have reached a precision
// ε_6 ≤ 2**(e-144) < 1. Given we're operating on integers, then we can ensure that xn is now either
// sqrt(a) or sqrt(a) + 1.
return xn - SafeCast.toUint(xn > a / xn);
}
}
/**
* @dev 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 + SafeCast.toUint(unsignedRoundsUp(rounding) && result * result < a);
}
}
/**
* @dev Return the log in base 2 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log2(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
uint256 exp;
unchecked {
exp = 128 * SafeCast.toUint(value > (1 << 128) - 1);
value >>= exp;
result += exp;
exp = 64 * SafeCast.toUint(value > (1 << 64) - 1);
value >>= exp;
result += exp;
exp = 32 * SafeCast.toUint(value > (1 << 32) - 1);
value >>= exp;
result += exp;
exp = 16 * SafeCast.toUint(value > (1 << 16) - 1);
value >>= exp;
result += exp;
exp = 8 * SafeCast.toUint(value > (1 << 8) - 1);
value >>= exp;
result += exp;
exp = 4 * SafeCast.toUint(value > (1 << 4) - 1);
value >>= exp;
result += exp;
exp = 2 * SafeCast.toUint(value > (1 << 2) - 1);
value >>= exp;
result += exp;
result += SafeCast.toUint(value > 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 + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << result < value);
}
}
/**
* @dev Return the log in base 10 of a positive value rounded towards zero.
* 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 + SafeCast.toUint(unsignedRoundsUp(rounding) && 10 ** result < value);
}
}
/**
* @dev Return the log in base 256 of a positive value rounded towards zero.
* 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;
uint256 isGt;
unchecked {
isGt = SafeCast.toUint(value > (1 << 128) - 1);
value >>= isGt * 128;
result += isGt * 16;
isGt = SafeCast.toUint(value > (1 << 64) - 1);
value >>= isGt * 64;
result += isGt * 8;
isGt = SafeCast.toUint(value > (1 << 32) - 1);
value >>= isGt * 32;
result += isGt * 4;
isGt = SafeCast.toUint(value > (1 << 16) - 1);
value >>= isGt * 16;
result += isGt * 2;
result += SafeCast.toUint(value > (1 << 8) - 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 + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << (result << 3) < value);
}
}
/**
* @dev Returns whether a provided rounding mode is considered rounding up for unsigned integers.
*/
function unsignedRoundsUp(Rounding rounding) internal pure returns (bool) {
return uint8(rounding) % 2 == 1;
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;
/// @notice Safe ETH and ERC20 transfer library that gracefully handles missing return values.
/// @author Solady (https://github.com/vectorized/solady/blob/main/src/utils/SafeTransferLib.sol)
/// @author Modified from Solmate (https://github.com/transmissions11/solmate/blob/main/src/utils/SafeTransferLib.sol)
/// @author Permit2 operations from (https://github.com/Uniswap/permit2/blob/main/src/libraries/Permit2Lib.sol)
///
/// @dev Note:
/// - For ETH transfers, please use `forceSafeTransferETH` for DoS protection.
library SafeTransferLib {
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* CUSTOM ERRORS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @dev The ETH transfer has failed.
error ETHTransferFailed();
/// @dev The ERC20 `transferFrom` has failed.
error TransferFromFailed();
/// @dev The ERC20 `transfer` has failed.
error TransferFailed();
/// @dev The ERC20 `approve` has failed.
error ApproveFailed();
/// @dev The ERC20 `totalSupply` query has failed.
error TotalSupplyQueryFailed();
/// @dev The Permit2 operation has failed.
error Permit2Failed();
/// @dev The Permit2 amount must be less than `2**160 - 1`.
error Permit2AmountOverflow();
/// @dev The Permit2 approve operation has failed.
error Permit2ApproveFailed();
/// @dev The Permit2 lockdown operation has failed.
error Permit2LockdownFailed();
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* CONSTANTS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @dev Suggested gas stipend for contract receiving ETH that disallows any storage writes.
uint256 internal constant GAS_STIPEND_NO_STORAGE_WRITES = 2300;
/// @dev Suggested gas stipend for contract receiving ETH to perform a few
/// storage reads and writes, but low enough to prevent griefing.
uint256 internal constant GAS_STIPEND_NO_GRIEF = 100000;
/// @dev The unique EIP-712 domain domain separator for the DAI token contract.
bytes32 internal constant DAI_DOMAIN_SEPARATOR =
0xdbb8cf42e1ecb028be3f3dbc922e1d878b963f411dc388ced501601c60f7c6f7;
/// @dev The address for the WETH9 contract on Ethereum mainnet.
address internal constant WETH9 = 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2;
/// @dev The canonical Permit2 address.
/// [Github](https://github.com/Uniswap/permit2)
/// [Etherscan](https://etherscan.io/address/0x000000000022D473030F116dDEE9F6B43aC78BA3)
address internal constant PERMIT2 = 0x000000000022D473030F116dDEE9F6B43aC78BA3;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* ETH OPERATIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
// If the ETH transfer MUST succeed with a reasonable gas budget, use the force variants.
//
// The regular variants:
// - Forwards all remaining gas to the target.
// - Reverts if the target reverts.
// - Reverts if the current contract has insufficient balance.
//
// The force variants:
// - Forwards with an optional gas stipend
// (defaults to `GAS_STIPEND_NO_GRIEF`, which is sufficient for most cases).
// - If the target reverts, or if the gas stipend is exhausted,
// creates a temporary contract to force send the ETH via `SELFDESTRUCT`.
// Future compatible with `SENDALL`: https://eips.ethereum.org/EIPS/eip-4758.
// - Reverts if the current contract has insufficient balance.
//
// The try variants:
// - Forwards with a mandatory gas stipend.
// - Instead of reverting, returns whether the transfer succeeded.
/// @dev Sends `amount` (in wei) ETH to `to`.
function safeTransferETH(address to, uint256 amount) internal {
/// @solidity memory-safe-assembly
assembly {
if iszero(call(gas(), to, amount, codesize(), 0x00, codesize(), 0x00)) {
mstore(0x00, 0xb12d13eb) // `ETHTransferFailed()`.
revert(0x1c, 0x04)
}
}
}
/// @dev Sends all the ETH in the current contract to `to`.
function safeTransferAllETH(address to) internal {
/// @solidity memory-safe-assembly
assembly {
// Transfer all the ETH and check if it succeeded or not.
if iszero(call(gas(), to, selfbalance(), codesize(), 0x00, codesize(), 0x00)) {
mstore(0x00, 0xb12d13eb) // `ETHTransferFailed()`.
revert(0x1c, 0x04)
}
}
}
/// @dev Force sends `amount` (in wei) ETH to `to`, with a `gasStipend`.
function forceSafeTransferETH(address to, uint256 amount, uint256 gasStipend) internal {
/// @solidity memory-safe-assembly
assembly {
if lt(selfbalance(), amount) {
mstore(0x00, 0xb12d13eb) // `ETHTransferFailed()`.
revert(0x1c, 0x04)
}
if iszero(call(gasStipend, to, amount, codesize(), 0x00, codesize(), 0x00)) {
mstore(0x00, to) // Store the address in scratch space.
mstore8(0x0b, 0x73) // Opcode `PUSH20`.
mstore8(0x20, 0xff) // Opcode `SELFDESTRUCT`.
if iszero(create(amount, 0x0b, 0x16)) { revert(codesize(), codesize()) } // For gas estimation.
}
}
}
/// @dev Force sends all the ETH in the current contract to `to`, with a `gasStipend`.
function forceSafeTransferAllETH(address to, uint256 gasStipend) internal {
/// @solidity memory-safe-assembly
assembly {
if iszero(call(gasStipend, to, selfbalance(), codesize(), 0x00, codesize(), 0x00)) {
mstore(0x00, to) // Store the address in scratch space.
mstore8(0x0b, 0x73) // Opcode `PUSH20`.
mstore8(0x20, 0xff) // Opcode `SELFDESTRUCT`.
if iszero(create(selfbalance(), 0x0b, 0x16)) { revert(codesize(), codesize()) } // For gas estimation.
}
}
}
/// @dev Force sends `amount` (in wei) ETH to `to`, with `GAS_STIPEND_NO_GRIEF`.
function forceSafeTransferETH(address to, uint256 amount) internal {
/// @solidity memory-safe-assembly
assembly {
if lt(selfbalance(), amount) {
mstore(0x00, 0xb12d13eb) // `ETHTransferFailed()`.
revert(0x1c, 0x04)
}
if iszero(call(GAS_STIPEND_NO_GRIEF, to, amount, codesize(), 0x00, codesize(), 0x00)) {
mstore(0x00, to) // Store the address in scratch space.
mstore8(0x0b, 0x73) // Opcode `PUSH20`.
mstore8(0x20, 0xff) // Opcode `SELFDESTRUCT`.
if iszero(create(amount, 0x0b, 0x16)) { revert(codesize(), codesize()) } // For gas estimation.
}
}
}
/// @dev Force sends all the ETH in the current contract to `to`, with `GAS_STIPEND_NO_GRIEF`.
function forceSafeTransferAllETH(address to) internal {
/// @solidity memory-safe-assembly
assembly {
// forgefmt: disable-next-item
if iszero(call(GAS_STIPEND_NO_GRIEF, to, selfbalance(), codesize(), 0x00, codesize(), 0x00)) {
mstore(0x00, to) // Store the address in scratch space.
mstore8(0x0b, 0x73) // Opcode `PUSH20`.
mstore8(0x20, 0xff) // Opcode `SELFDESTRUCT`.
if iszero(create(selfbalance(), 0x0b, 0x16)) { revert(codesize(), codesize()) } // For gas estimation.
}
}
}
/// @dev Sends `amount` (in wei) ETH to `to`, with a `gasStipend`.
function trySafeTransferETH(address to, uint256 amount, uint256 gasStipend)
internal
returns (bool success)
{
/// @solidity memory-safe-assembly
assembly {
success := call(gasStipend, to, amount, codesize(), 0x00, codesize(), 0x00)
}
}
/// @dev Sends all the ETH in the current contract to `to`, with a `gasStipend`.
function trySafeTransferAllETH(address to, uint256 gasStipend)
internal
returns (bool success)
{
/// @solidity memory-safe-assembly
assembly {
success := call(gasStipend, to, selfbalance(), codesize(), 0x00, codesize(), 0x00)
}
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* ERC20 OPERATIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @dev Sends `amount` of ERC20 `token` from `from` to `to`.
/// Reverts upon failure.
///
/// The `from` account must have at least `amount` approved for
/// the current contract to manage.
function safeTransferFrom(address token, address from, address to, uint256 amount) internal {
/// @solidity memory-safe-assembly
assembly {
let m := mload(0x40) // Cache the free memory pointer.
mstore(0x60, amount) // Store the `amount` argument.
mstore(0x40, to) // Store the `to` argument.
mstore(0x2c, shl(96, from)) // Store the `from` argument.
mstore(0x0c, 0x23b872dd000000000000000000000000) // `transferFrom(address,address,uint256)`.
let success := call(gas(), token, 0, 0x1c, 0x64, 0x00, 0x20)
if iszero(and(eq(mload(0x00), 1), success)) {
if iszero(lt(or(iszero(extcodesize(token)), returndatasize()), success)) {
mstore(0x00, 0x7939f424) // `TransferFromFailed()`.
revert(0x1c, 0x04)
}
}
mstore(0x60, 0) // Restore the zero slot to zero.
mstore(0x40, m) // Restore the free memory pointer.
}
}
/// @dev Sends `amount` of ERC20 `token` from `from` to `to`.
///
/// The `from` account must have at least `amount` approved for the current contract to manage.
function trySafeTransferFrom(address token, address from, address to, uint256 amount)
internal
returns (bool success)
{
/// @solidity memory-safe-assembly
assembly {
let m := mload(0x40) // Cache the free memory pointer.
mstore(0x60, amount) // Store the `amount` argument.
mstore(0x40, to) // Store the `to` argument.
mstore(0x2c, shl(96, from)) // Store the `from` argument.
mstore(0x0c, 0x23b872dd000000000000000000000000) // `transferFrom(address,address,uint256)`.
success := call(gas(), token, 0, 0x1c, 0x64, 0x00, 0x20)
if iszero(and(eq(mload(0x00), 1), success)) {
success := lt(or(iszero(extcodesize(token)), returndatasize()), success)
}
mstore(0x60, 0) // Restore the zero slot to zero.
mstore(0x40, m) // Restore the free memory pointer.
}
}
/// @dev Sends all of ERC20 `token` from `from` to `to`.
/// Reverts upon failure.
///
/// The `from` account must have their entire balance approved for the current contract to manage.
function safeTransferAllFrom(address token, address from, address to)
internal
returns (uint256 amount)
{
/// @solidity memory-safe-assembly
assembly {
let m := mload(0x40) // Cache the free memory pointer.
mstore(0x40, to) // Store the `to` argument.
mstore(0x2c, shl(96, from)) // Store the `from` argument.
mstore(0x0c, 0x70a08231000000000000000000000000) // `balanceOf(address)`.
// Read the balance, reverting upon failure.
if iszero(
and( // The arguments of `and` are evaluated from right to left.
gt(returndatasize(), 0x1f), // At least 32 bytes returned.
staticcall(gas(), token, 0x1c, 0x24, 0x60, 0x20)
)
) {
mstore(0x00, 0x7939f424) // `TransferFromFailed()`.
revert(0x1c, 0x04)
}
mstore(0x00, 0x23b872dd) // `transferFrom(address,address,uint256)`.
amount := mload(0x60) // The `amount` is already at 0x60. We'll need to return it.
// Perform the transfer, reverting upon failure.
let success := call(gas(), token, 0, 0x1c, 0x64, 0x00, 0x20)
if iszero(and(eq(mload(0x00), 1), success)) {
if iszero(lt(or(iszero(extcodesize(token)), returndatasize()), success)) {
mstore(0x00, 0x7939f424) // `TransferFromFailed()`.
revert(0x1c, 0x04)
}
}
mstore(0x60, 0) // Restore the zero slot to zero.
mstore(0x40, m) // Restore the free memory pointer.
}
}
/// @dev Sends `amount` of ERC20 `token` from the current contract to `to`.
/// Reverts upon failure.
function safeTransfer(address token, address to, uint256 amount) internal {
/// @solidity memory-safe-assembly
assembly {
mstore(0x14, to) // Store the `to` argument.
mstore(0x34, amount) // Store the `amount` argument.
mstore(0x00, 0xa9059cbb000000000000000000000000) // `transfer(address,uint256)`.
// Perform the transfer, reverting upon failure.
let success := call(gas(), token, 0, 0x10, 0x44, 0x00, 0x20)
if iszero(and(eq(mload(0x00), 1), success)) {
if iszero(lt(or(iszero(extcodesize(token)), returndatasize()), success)) {
mstore(0x00, 0x90b8ec18) // `TransferFailed()`.
revert(0x1c, 0x04)
}
}
mstore(0x34, 0) // Restore the part of the free memory pointer that was overwritten.
}
}
/// @dev Sends all of ERC20 `token` from the current contract to `to`.
/// Reverts upon failure.
function safeTransferAll(address token, address to) internal returns (uint256 amount) {
/// @solidity memory-safe-assembly
assembly {
mstore(0x00, 0x70a08231) // Store the function selector of `balanceOf(address)`.
mstore(0x20, address()) // Store the address of the current contract.
// Read the balance, reverting upon failure.
if iszero(
and( // The arguments of `and` are evaluated from right to left.
gt(returndatasize(), 0x1f), // At least 32 bytes returned.
staticcall(gas(), token, 0x1c, 0x24, 0x34, 0x20)
)
) {
mstore(0x00, 0x90b8ec18) // `TransferFailed()`.
revert(0x1c, 0x04)
}
mstore(0x14, to) // Store the `to` argument.
amount := mload(0x34) // The `amount` is already at 0x34. We'll need to return it.
mstore(0x00, 0xa9059cbb000000000000000000000000) // `transfer(address,uint256)`.
// Perform the transfer, reverting upon failure.
let success := call(gas(), token, 0, 0x10, 0x44, 0x00, 0x20)
if iszero(and(eq(mload(0x00), 1), success)) {
if iszero(lt(or(iszero(extcodesize(token)), returndatasize()), success)) {
mstore(0x00, 0x90b8ec18) // `TransferFailed()`.
revert(0x1c, 0x04)
}
}
mstore(0x34, 0) // Restore the part of the free memory pointer that was overwritten.
}
}
/// @dev Sets `amount` of ERC20 `token` for `to` to manage on behalf of the current contract.
/// Reverts upon failure.
function safeApprove(address token, address to, uint256 amount) internal {
/// @solidity memory-safe-assembly
assembly {
mstore(0x14, to) // Store the `to` argument.
mstore(0x34, amount) // Store the `amount` argument.
mstore(0x00, 0x095ea7b3000000000000000000000000) // `approve(address,uint256)`.
let success := call(gas(), token, 0, 0x10, 0x44, 0x00, 0x20)
if iszero(and(eq(mload(0x00), 1), success)) {
if iszero(lt(or(iszero(extcodesize(token)), returndatasize()), success)) {
mstore(0x00, 0x3e3f8f73) // `ApproveFailed()`.
revert(0x1c, 0x04)
}
}
mstore(0x34, 0) // Restore the part of the free memory pointer that was overwritten.
}
}
/// @dev Sets `amount` of ERC20 `token` for `to` to manage on behalf of the current contract.
/// If the initial attempt to approve fails, attempts to reset the approved amount to zero,
/// then retries the approval again (some tokens, e.g. USDT, requires this).
/// Reverts upon failure.
function safeApproveWithRetry(address token, address to, uint256 amount) internal {
/// @solidity memory-safe-assembly
assembly {
mstore(0x14, to) // Store the `to` argument.
mstore(0x34, amount) // Store the `amount` argument.
mstore(0x00, 0x095ea7b3000000000000000000000000) // `approve(address,uint256)`.
// Perform the approval, retrying upon failure.
let success := call(gas(), token, 0, 0x10, 0x44, 0x00, 0x20)
if iszero(and(eq(mload(0x00), 1), success)) {
if iszero(lt(or(iszero(extcodesize(token)), returndatasize()), success)) {
mstore(0x34, 0) // Store 0 for the `amount`.
mstore(0x00, 0x095ea7b3000000000000000000000000) // `approve(address,uint256)`.
pop(call(gas(), token, 0, 0x10, 0x44, codesize(), 0x00)) // Reset the approval.
mstore(0x34, amount) // Store back the original `amount`.
// Retry the approval, reverting upon failure.
success := call(gas(), token, 0, 0x10, 0x44, 0x00, 0x20)
if iszero(and(eq(mload(0x00), 1), success)) {
// Check the `extcodesize` again just in case the token selfdestructs lol.
if iszero(lt(or(iszero(extcodesize(token)), returndatasize()), success)) {
mstore(0x00, 0x3e3f8f73) // `ApproveFailed()`.
revert(0x1c, 0x04)
}
}
}
}
mstore(0x34, 0) // Restore the part of the free memory pointer that was overwritten.
}
}
/// @dev Returns the amount of ERC20 `token` owned by `account`.
/// Returns zero if the `token` does not exist.
function balanceOf(address token, address account) internal view returns (uint256 amount) {
/// @solidity memory-safe-assembly
assembly {
mstore(0x14, account) // Store the `account` argument.
mstore(0x00, 0x70a08231000000000000000000000000) // `balanceOf(address)`.
amount :=
mul( // The arguments of `mul` are evaluated from right to left.
mload(0x20),
and( // The arguments of `and` are evaluated from right to left.
gt(returndatasize(), 0x1f), // At least 32 bytes returned.
staticcall(gas(), token, 0x10, 0x24, 0x20, 0x20)
)
)
}
}
/// @dev Returns the total supply of the `token`.
/// Reverts if the token does not exist or does not implement `totalSupply()`.
function totalSupply(address token) internal view returns (uint256 result) {
/// @solidity memory-safe-assembly
assembly {
mstore(0x00, 0x18160ddd) // `totalSupply()`.
if iszero(
and(gt(returndatasize(), 0x1f), staticcall(gas(), token, 0x1c, 0x04, 0x00, 0x20))
) {
mstore(0x00, 0x54cd9435) // `TotalSupplyQueryFailed()`.
revert(0x1c, 0x04)
}
result := mload(0x00)
}
}
/// @dev Sends `amount` of ERC20 `token` from `from` to `to`.
/// If the initial attempt fails, try to use Permit2 to transfer the token.
/// Reverts upon failure.
///
/// The `from` account must have at least `amount` approved for the current contract to manage.
function safeTransferFrom2(address token, address from, address to, uint256 amount) internal {
if (!trySafeTransferFrom(token, from, to, amount)) {
permit2TransferFrom(token, from, to, amount);
}
}
/// @dev Sends `amount` of ERC20 `token` from `from` to `to` via Permit2.
/// Reverts upon failure.
function permit2TransferFrom(address token, address from, address to, uint256 amount)
internal
{
/// @solidity memory-safe-assembly
assembly {
let m := mload(0x40)
mstore(add(m, 0x74), shr(96, shl(96, token)))
mstore(add(m, 0x54), amount)
mstore(add(m, 0x34), to)
mstore(add(m, 0x20), shl(96, from))
// `transferFrom(address,address,uint160,address)`.
mstore(m, 0x36c78516000000000000000000000000)
let p := PERMIT2
let exists := eq(chainid(), 1)
if iszero(exists) { exists := iszero(iszero(extcodesize(p))) }
if iszero(
and(
call(gas(), p, 0, add(m, 0x10), 0x84, codesize(), 0x00),
lt(iszero(extcodesize(token)), exists) // Token has code and Permit2 exists.
)
) {
mstore(0x00, 0x7939f4248757f0fd) // `TransferFromFailed()` or `Permit2AmountOverflow()`.
revert(add(0x18, shl(2, iszero(iszero(shr(160, amount))))), 0x04)
}
}
}
/// @dev Permit a user to spend a given amount of
/// another user's tokens via native EIP-2612 permit if possible, falling
/// back to Permit2 if native permit fails or is not implemented on the token.
function permit2(
address token,
address owner,
address spender,
uint256 amount,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal {
bool success;
/// @solidity memory-safe-assembly
assembly {
for {} shl(96, xor(token, WETH9)) {} {
mstore(0x00, 0x3644e515) // `DOMAIN_SEPARATOR()`.
if iszero(
and( // The arguments of `and` are evaluated from right to left.
lt(iszero(mload(0x00)), eq(returndatasize(), 0x20)), // Returns 1 non-zero word.
// Gas stipend to limit gas burn for tokens that don't refund gas when
// an non-existing function is called. 5K should be enough for a SLOAD.
staticcall(5000, token, 0x1c, 0x04, 0x00, 0x20)
)
) { break }
// After here, we can be sure that token is a contract.
let m := mload(0x40)
mstore(add(m, 0x34), spender)
mstore(add(m, 0x20), shl(96, owner))
mstore(add(m, 0x74), deadline)
if eq(mload(0x00), DAI_DOMAIN_SEPARATOR) {
mstore(0x14, owner)
mstore(0x00, 0x7ecebe00000000000000000000000000) // `nonces(address)`.
mstore(
add(m, 0x94),
lt(iszero(amount), staticcall(gas(), token, 0x10, 0x24, add(m, 0x54), 0x20))
)
mstore(m, 0x8fcbaf0c000000000000000000000000) // `IDAIPermit.permit`.
// `nonces` is already at `add(m, 0x54)`.
// `amount != 0` is already stored at `add(m, 0x94)`.
mstore(add(m, 0xb4), and(0xff, v))
mstore(add(m, 0xd4), r)
mstore(add(m, 0xf4), s)
success := call(gas(), token, 0, add(m, 0x10), 0x104, codesize(), 0x00)
break
}
mstore(m, 0xd505accf000000000000000000000000) // `IERC20Permit.permit`.
mstore(add(m, 0x54), amount)
mstore(add(m, 0x94), and(0xff, v))
mstore(add(m, 0xb4), r)
mstore(add(m, 0xd4), s)
success := call(gas(), token, 0, add(m, 0x10), 0xe4, codesize(), 0x00)
break
}
}
if (!success) simplePermit2(token, owner, spender, amount, deadline, v, r, s);
}
/// @dev Simple permit on the Permit2 contract.
function simplePermit2(
address token,
address owner,
address spender,
uint256 amount,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal {
/// @solidity memory-safe-assembly
assembly {
let m := mload(0x40)
mstore(m, 0x927da105) // `allowance(address,address,address)`.
{
let addressMask := shr(96, not(0))
mstore(add(m, 0x20), and(addressMask, owner))
mstore(add(m, 0x40), and(addressMask, token))
mstore(add(m, 0x60), and(addressMask, spender))
mstore(add(m, 0xc0), and(addressMask, spender))
}
let p := mul(PERMIT2, iszero(shr(160, amount)))
if iszero(
and( // The arguments of `and` are evaluated from right to left.
gt(returndatasize(), 0x5f), // Returns 3 words: `amount`, `expiration`, `nonce`.
staticcall(gas(), p, add(m, 0x1c), 0x64, add(m, 0x60), 0x60)
)
) {
mstore(0x00, 0x6b836e6b8757f0fd) // `Permit2Failed()` or `Permit2AmountOverflow()`.
revert(add(0x18, shl(2, iszero(p))), 0x04)
}
mstore(m, 0x2b67b570) // `Permit2.permit` (PermitSingle variant).
// `owner` is already `add(m, 0x20)`.
// `token` is already at `add(m, 0x40)`.
mstore(add(m, 0x60), amount)
mstore(add(m, 0x80), 0xffffffffffff) // `expiration = type(uint48).max`.
// `nonce` is already at `add(m, 0xa0)`.
// `spender` is already at `add(m, 0xc0)`.
mstore(add(m, 0xe0), deadline)
mstore(add(m, 0x100), 0x100) // `signature` offset.
mstore(add(m, 0x120), 0x41) // `signature` length.
mstore(add(m, 0x140), r)
mstore(add(m, 0x160), s)
mstore(add(m, 0x180), shl(248, v))
if iszero( // Revert if token does not have code, or if the call fails.
mul(extcodesize(token), call(gas(), p, 0, add(m, 0x1c), 0x184, codesize(), 0x00))) {
mstore(0x00, 0x6b836e6b) // `Permit2Failed()`.
revert(0x1c, 0x04)
}
}
}
/// @dev Approves `spender` to spend `amount` of `token` for `address(this)`.
function permit2Approve(address token, address spender, uint160 amount, uint48 expiration)
internal
{
/// @solidity memory-safe-assembly
assembly {
let addressMask := shr(96, not(0))
let m := mload(0x40)
mstore(m, 0x87517c45) // `approve(address,address,uint160,uint48)`.
mstore(add(m, 0x20), and(addressMask, token))
mstore(add(m, 0x40), and(addressMask, spender))
mstore(add(m, 0x60), and(addressMask, amount))
mstore(add(m, 0x80), and(0xffffffffffff, expiration))
if iszero(call(gas(), PERMIT2, 0, add(m, 0x1c), 0xa0, codesize(), 0x00)) {
mstore(0x00, 0x324f14ae) // `Permit2ApproveFailed()`.
revert(0x1c, 0x04)
}
}
}
/// @dev Revokes an approval for `token` and `spender` for `address(this)`.
function permit2Lockdown(address token, address spender) internal {
/// @solidity memory-safe-assembly
assembly {
let m := mload(0x40)
mstore(m, 0xcc53287f) // `Permit2.lockdown`.
mstore(add(m, 0x20), 0x20) // Offset of the `approvals`.
mstore(add(m, 0x40), 1) // `approvals.length`.
mstore(add(m, 0x60), shr(96, shl(96, token)))
mstore(add(m, 0x80), shr(96, shl(96, spender)))
if iszero(call(gas(), PERMIT2, 0, add(m, 0x1c), 0xa0, codesize(), 0x00)) {
mstore(0x00, 0x96b3de23) // `Permit2LockdownFailed()`.
revert(0x1c, 0x04)
}
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/math/SafeCast.sol)
// This file was procedurally generated from scripts/generate/templates/SafeCast.js.
pragma solidity ^0.8.20;
/**
* @dev Wrappers over Solidity's uintXX/intXX/bool casting operators with added overflow
* checks.
*
* Downcasting from uint256/int256 in Solidity does not revert on overflow. This can
* easily result in undesired exploitation or bugs, since developers usually
* assume that overflows raise errors. `SafeCast` restores this intuition by
* reverting the transaction when such an operation overflows.
*
* Using this library instead of the unchecked operations eliminates an entire
* class of bugs, so it's recommended to use it always.
*/
library SafeCast {
/**
* @dev Value doesn't fit in an uint of `bits` size.
*/
error SafeCastOverflowedUintDowncast(uint8 bits, uint256 value);
/**
* @dev An int value doesn't fit in an uint of `bits` size.
*/
error SafeCastOverflowedIntToUint(int256 value);
/**
* @dev Value doesn't fit in an int of `bits` size.
*/
error SafeCastOverflowedIntDowncast(uint8 bits, int256 value);
/**
* @dev An uint value doesn't fit in an int of `bits` size.
*/
error SafeCastOverflowedUintToInt(uint256 value);
/**
* @dev Returns the downcasted uint248 from uint256, reverting on
* overflow (when the input is greater than largest uint248).
*
* Counterpart to Solidity's `uint248` operator.
*
* Requirements:
*
* - input must fit into 248 bits
*/
function toUint248(uint256 value) internal pure returns (uint248) {
if (value > type(uint248).max) {
revert SafeCastOverflowedUintDowncast(248, value);
}
return uint248(value);
}
/**
* @dev Returns the downcasted uint240 from uint256, reverting on
* overflow (when the input is greater than largest uint240).
*
* Counterpart to Solidity's `uint240` operator.
*
* Requirements:
*
* - input must fit into 240 bits
*/
function toUint240(uint256 value) internal pure returns (uint240) {
if (value > type(uint240).max) {
revert SafeCastOverflowedUintDowncast(240, value);
}
return uint240(value);
}
/**
* @dev Returns the downcasted uint232 from uint256, reverting on
* overflow (when the input is greater than largest uint232).
*
* Counterpart to Solidity's `uint232` operator.
*
* Requirements:
*
* - input must fit into 232 bits
*/
function toUint232(uint256 value) internal pure returns (uint232) {
if (value > type(uint232).max) {
revert SafeCastOverflowedUintDowncast(232, value);
}
return uint232(value);
}
/**
* @dev Returns the downcasted uint224 from uint256, reverting on
* overflow (when the input is greater than largest uint224).
*
* Counterpart to Solidity's `uint224` operator.
*
* Requirements:
*
* - input must fit into 224 bits
*/
function toUint224(uint256 value) internal pure returns (uint224) {
if (value > type(uint224).max) {
revert SafeCastOverflowedUintDowncast(224, value);
}
return uint224(value);
}
/**
* @dev Returns the downcasted uint216 from uint256, reverting on
* overflow (when the input is greater than largest uint216).
*
* Counterpart to Solidity's `uint216` operator.
*
* Requirements:
*
* - input must fit into 216 bits
*/
function toUint216(uint256 value) internal pure returns (uint216) {
if (value > type(uint216).max) {
revert SafeCastOverflowedUintDowncast(216, value);
}
return uint216(value);
}
/**
* @dev Returns the downcasted uint208 from uint256, reverting on
* overflow (when the input is greater than largest uint208).
*
* Counterpart to Solidity's `uint208` operator.
*
* Requirements:
*
* - input must fit into 208 bits
*/
function toUint208(uint256 value) internal pure returns (uint208) {
if (value > type(uint208).max) {
revert SafeCastOverflowedUintDowncast(208, value);
}
return uint208(value);
}
/**
* @dev Returns the downcasted uint200 from uint256, reverting on
* overflow (when the input is greater than largest uint200).
*
* Counterpart to Solidity's `uint200` operator.
*
* Requirements:
*
* - input must fit into 200 bits
*/
function toUint200(uint256 value) internal pure returns (uint200) {
if (value > type(uint200).max) {
revert SafeCastOverflowedUintDowncast(200, value);
}
return uint200(value);
}
/**
* @dev Returns the downcasted uint192 from uint256, reverting on
* overflow (when the input is greater than largest uint192).
*
* Counterpart to Solidity's `uint192` operator.
*
* Requirements:
*
* - input must fit into 192 bits
*/
function toUint192(uint256 value) internal pure returns (uint192) {
if (value > type(uint192).max) {
revert SafeCastOverflowedUintDowncast(192, value);
}
return uint192(value);
}
/**
* @dev Returns the downcasted uint184 from uint256, reverting on
* overflow (when the input is greater than largest uint184).
*
* Counterpart to Solidity's `uint184` operator.
*
* Requirements:
*
* - input must fit into 184 bits
*/
function toUint184(uint256 value) internal pure returns (uint184) {
if (value > type(uint184).max) {
revert SafeCastOverflowedUintDowncast(184, value);
}
return uint184(value);
}
/**
* @dev Returns the downcasted uint176 from uint256, reverting on
* overflow (when the input is greater than largest uint176).
*
* Counterpart to Solidity's `uint176` operator.
*
* Requirements:
*
* - input must fit into 176 bits
*/
function toUint176(uint256 value) internal pure returns (uint176) {
if (value > type(uint176).max) {
revert SafeCastOverflowedUintDowncast(176, value);
}
return uint176(value);
}
/**
* @dev Returns the downcasted uint168 from uint256, reverting on
* overflow (when the input is greater than largest uint168).
*
* Counterpart to Solidity's `uint168` operator.
*
* Requirements:
*
* - input must fit into 168 bits
*/
function toUint168(uint256 value) internal pure returns (uint168) {
if (value > type(uint168).max) {
revert SafeCastOverflowedUintDowncast(168, value);
}
return uint168(value);
}
/**
* @dev Returns the downcasted uint160 from uint256, reverting on
* overflow (when the input is greater than largest uint160).
*
* Counterpart to Solidity's `uint160` operator.
*
* Requirements:
*
* - input must fit into 160 bits
*/
function toUint160(uint256 value) internal pure returns (uint160) {
if (value > type(uint160).max) {
revert SafeCastOverflowedUintDowncast(160, value);
}
return uint160(value);
}
/**
* @dev Returns the downcasted uint152 from uint256, reverting on
* overflow (when the input is greater than largest uint152).
*
* Counterpart to Solidity's `uint152` operator.
*
* Requirements:
*
* - input must fit into 152 bits
*/
function toUint152(uint256 value) internal pure returns (uint152) {
if (value > type(uint152).max) {
revert SafeCastOverflowedUintDowncast(152, value);
}
return uint152(value);
}
/**
* @dev Returns the downcasted uint144 from uint256, reverting on
* overflow (when the input is greater than largest uint144).
*
* Counterpart to Solidity's `uint144` operator.
*
* Requirements:
*
* - input must fit into 144 bits
*/
function toUint144(uint256 value) internal pure returns (uint144) {
if (value > type(uint144).max) {
revert SafeCastOverflowedUintDowncast(144, value);
}
return uint144(value);
}
/**
* @dev Returns the downcasted uint136 from uint256, reverting on
* overflow (when the input is greater than largest uint136).
*
* Counterpart to Solidity's `uint136` operator.
*
* Requirements:
*
* - input must fit into 136 bits
*/
function toUint136(uint256 value) internal pure returns (uint136) {
if (value > type(uint136).max) {
revert SafeCastOverflowedUintDowncast(136, value);
}
return uint136(value);
}
/**
* @dev Returns the downcasted uint128 from uint256, reverting on
* overflow (when the input is greater than largest uint128).
*
* Counterpart to Solidity's `uint128` operator.
*
* Requirements:
*
* - input must fit into 128 bits
*/
function toUint128(uint256 value) internal pure returns (uint128) {
if (value > type(uint128).max) {
revert SafeCastOverflowedUintDowncast(128, value);
}
return uint128(value);
}
/**
* @dev Returns the downcasted uint120 from uint256, reverting on
* overflow (when the input is greater than largest uint120).
*
* Counterpart to Solidity's `uint120` operator.
*
* Requirements:
*
* - input must fit into 120 bits
*/
function toUint120(uint256 value) internal pure returns (uint120) {
if (value > type(uint120).max) {
revert SafeCastOverflowedUintDowncast(120, value);
}
return uint120(value);
}
/**
* @dev Returns the downcasted uint112 from uint256, reverting on
* overflow (when the input is greater than largest uint112).
*
* Counterpart to Solidity's `uint112` operator.
*
* Requirements:
*
* - input must fit into 112 bits
*/
function toUint112(uint256 value) internal pure returns (uint112) {
if (value > type(uint112).max) {
revert SafeCastOverflowedUintDowncast(112, value);
}
return uint112(value);
}
/**
* @dev Returns the downcasted uint104 from uint256, reverting on
* overflow (when the input is greater than largest uint104).
*
* Counterpart to Solidity's `uint104` operator.
*
* Requirements:
*
* - input must fit into 104 bits
*/
function toUint104(uint256 value) internal pure returns (uint104) {
if (value > type(uint104).max) {
revert SafeCastOverflowedUintDowncast(104, value);
}
return uint104(value);
}
/**
* @dev Returns the downcasted uint96 from uint256, reverting on
* overflow (when the input is greater than largest uint96).
*
* Counterpart to Solidity's `uint96` operator.
*
* Requirements:
*
* - input must fit into 96 bits
*/
function toUint96(uint256 value) internal pure returns (uint96) {
if (value > type(uint96).max) {
revert SafeCastOverflowedUintDowncast(96, value);
}
return uint96(value);
}
/**
* @dev Returns the downcasted uint88 from uint256, reverting on
* overflow (when the input is greater than largest uint88).
*
* Counterpart to Solidity's `uint88` operator.
*
* Requirements:
*
* - input must fit into 88 bits
*/
function toUint88(uint256 value) internal pure returns (uint88) {
if (value > type(uint88).max) {
revert SafeCastOverflowedUintDowncast(88, value);
}
return uint88(value);
}
/**
* @dev Returns the downcasted uint80 from uint256, reverting on
* overflow (when the input is greater than largest uint80).
*
* Counterpart to Solidity's `uint80` operator.
*
* Requirements:
*
* - input must fit into 80 bits
*/
function toUint80(uint256 value) internal pure returns (uint80) {
if (value > type(uint80).max) {
revert SafeCastOverflowedUintDowncast(80, value);
}
return uint80(value);
}
/**
* @dev Returns the downcasted uint72 from uint256, reverting on
* overflow (when the input is greater than largest uint72).
*
* Counterpart to Solidity's `uint72` operator.
*
* Requirements:
*
* - input must fit into 72 bits
*/
function toUint72(uint256 value) internal pure returns (uint72) {
if (value > type(uint72).max) {
revert SafeCastOverflowedUintDowncast(72, value);
}
return uint72(value);
}
/**
* @dev Returns the downcasted uint64 from uint256, reverting on
* overflow (when the input is greater than largest uint64).
*
* Counterpart to Solidity's `uint64` operator.
*
* Requirements:
*
* - input must fit into 64 bits
*/
function toUint64(uint256 value) internal pure returns (uint64) {
if (value > type(uint64).max) {
revert SafeCastOverflowedUintDowncast(64, value);
}
return uint64(value);
}
/**
* @dev Returns the downcasted uint56 from uint256, reverting on
* overflow (when the input is greater than largest uint56).
*
* Counterpart to Solidity's `uint56` operator.
*
* Requirements:
*
* - input must fit into 56 bits
*/
function toUint56(uint256 value) internal pure returns (uint56) {
if (value > type(uint56).max) {
revert SafeCastOverflowedUintDowncast(56, value);
}
return uint56(value);
}
/**
* @dev Returns the downcasted uint48 from uint256, reverting on
* overflow (when the input is greater than largest uint48).
*
* Counterpart to Solidity's `uint48` operator.
*
* Requirements:
*
* - input must fit into 48 bits
*/
function toUint48(uint256 value) internal pure returns (uint48) {
if (value > type(uint48).max) {
revert SafeCastOverflowedUintDowncast(48, value);
}
return uint48(value);
}
/**
* @dev Returns the downcasted uint40 from uint256, reverting on
* overflow (when the input is greater than largest uint40).
*
* Counterpart to Solidity's `uint40` operator.
*
* Requirements:
*
* - input must fit into 40 bits
*/
function toUint40(uint256 value) internal pure returns (uint40) {
if (value > type(uint40).max) {
revert SafeCastOverflowedUintDowncast(40, value);
}
return uint40(value);
}
/**
* @dev Returns the downcasted uint32 from uint256, reverting on
* overflow (when the input is greater than largest uint32).
*
* Counterpart to Solidity's `uint32` operator.
*
* Requirements:
*
* - input must fit into 32 bits
*/
function toUint32(uint256 value) internal pure returns (uint32) {
if (value > type(uint32).max) {
revert SafeCastOverflowedUintDowncast(32, value);
}
return uint32(value);
}
/**
* @dev Returns the downcasted uint24 from uint256, reverting on
* overflow (when the input is greater than largest uint24).
*
* Counterpart to Solidity's `uint24` operator.
*
* Requirements:
*
* - input must fit into 24 bits
*/
function toUint24(uint256 value) internal pure returns (uint24) {
if (value > type(uint24).max) {
revert SafeCastOverflowedUintDowncast(24, value);
}
return uint24(value);
}
/**
* @dev Returns the downcasted uint16 from uint256, reverting on
* overflow (when the input is greater than largest uint16).
*
* Counterpart to Solidity's `uint16` operator.
*
* Requirements:
*
* - input must fit into 16 bits
*/
function toUint16(uint256 value) internal pure returns (uint16) {
if (value > type(uint16).max) {
revert SafeCastOverflowedUintDowncast(16, value);
}
return uint16(value);
}
/**
* @dev Returns the downcasted uint8 from uint256, reverting on
* overflow (when the input is greater than largest uint8).
*
* Counterpart to Solidity's `uint8` operator.
*
* Requirements:
*
* - input must fit into 8 bits
*/
function toUint8(uint256 value) internal pure returns (uint8) {
if (value > type(uint8).max) {
revert SafeCastOverflowedUintDowncast(8, value);
}
return uint8(value);
}
/**
* @dev Converts a signed int256 into an unsigned uint256.
*
* Requirements:
*
* - input must be greater than or equal to 0.
*/
function toUint256(int256 value) internal pure returns (uint256) {
if (value < 0) {
revert SafeCastOverflowedIntToUint(value);
}
return uint256(value);
}
/**
* @dev Returns the downcasted int248 from int256, reverting on
* overflow (when the input is less than smallest int248 or
* greater than largest int248).
*
* Counterpart to Solidity's `int248` operator.
*
* Requirements:
*
* - input must fit into 248 bits
*/
function toInt248(int256 value) internal pure returns (int248 downcasted) {
downcasted = int248(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(248, value);
}
}
/**
* @dev Returns the downcasted int240 from int256, reverting on
* overflow (when the input is less than smallest int240 or
* greater than largest int240).
*
* Counterpart to Solidity's `int240` operator.
*
* Requirements:
*
* - input must fit into 240 bits
*/
function toInt240(int256 value) internal pure returns (int240 downcasted) {
downcasted = int240(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(240, value);
}
}
/**
* @dev Returns the downcasted int232 from int256, reverting on
* overflow (when the input is less than smallest int232 or
* greater than largest int232).
*
* Counterpart to Solidity's `int232` operator.
*
* Requirements:
*
* - input must fit into 232 bits
*/
function toInt232(int256 value) internal pure returns (int232 downcasted) {
downcasted = int232(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(232, value);
}
}
/**
* @dev Returns the downcasted int224 from int256, reverting on
* overflow (when the input is less than smallest int224 or
* greater than largest int224).
*
* Counterpart to Solidity's `int224` operator.
*
* Requirements:
*
* - input must fit into 224 bits
*/
function toInt224(int256 value) internal pure returns (int224 downcasted) {
downcasted = int224(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(224, value);
}
}
/**
* @dev Returns the downcasted int216 from int256, reverting on
* overflow (when the input is less than smallest int216 or
* greater than largest int216).
*
* Counterpart to Solidity's `int216` operator.
*
* Requirements:
*
* - input must fit into 216 bits
*/
function toInt216(int256 value) internal pure returns (int216 downcasted) {
downcasted = int216(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(216, value);
}
}
/**
* @dev Returns the downcasted int208 from int256, reverting on
* overflow (when the input is less than smallest int208 or
* greater than largest int208).
*
* Counterpart to Solidity's `int208` operator.
*
* Requirements:
*
* - input must fit into 208 bits
*/
function toInt208(int256 value) internal pure returns (int208 downcasted) {
downcasted = int208(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(208, value);
}
}
/**
* @dev Returns the downcasted int200 from int256, reverting on
* overflow (when the input is less than smallest int200 or
* greater than largest int200).
*
* Counterpart to Solidity's `int200` operator.
*
* Requirements:
*
* - input must fit into 200 bits
*/
function toInt200(int256 value) internal pure returns (int200 downcasted) {
downcasted = int200(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(200, value);
}
}
/**
* @dev Returns the downcasted int192 from int256, reverting on
* overflow (when the input is less than smallest int192 or
* greater than largest int192).
*
* Counterpart to Solidity's `int192` operator.
*
* Requirements:
*
* - input must fit into 192 bits
*/
function toInt192(int256 value) internal pure returns (int192 downcasted) {
downcasted = int192(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(192, value);
}
}
/**
* @dev Returns the downcasted int184 from int256, reverting on
* overflow (when the input is less than smallest int184 or
* greater than largest int184).
*
* Counterpart to Solidity's `int184` operator.
*
* Requirements:
*
* - input must fit into 184 bits
*/
function toInt184(int256 value) internal pure returns (int184 downcasted) {
downcasted = int184(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(184, value);
}
}
/**
* @dev Returns the downcasted int176 from int256, reverting on
* overflow (when the input is less than smallest int176 or
* greater than largest int176).
*
* Counterpart to Solidity's `int176` operator.
*
* Requirements:
*
* - input must fit into 176 bits
*/
function toInt176(int256 value) internal pure returns (int176 downcasted) {
downcasted = int176(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(176, value);
}
}
/**
* @dev Returns the downcasted int168 from int256, reverting on
* overflow (when the input is less than smallest int168 or
* greater than largest int168).
*
* Counterpart to Solidity's `int168` operator.
*
* Requirements:
*
* - input must fit into 168 bits
*/
function toInt168(int256 value) internal pure returns (int168 downcasted) {
downcasted = int168(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(168, value);
}
}
/**
* @dev Returns the downcasted int160 from int256, reverting on
* overflow (when the input is less than smallest int160 or
* greater than largest int160).
*
* Counterpart to Solidity's `int160` operator.
*
* Requirements:
*
* - input must fit into 160 bits
*/
function toInt160(int256 value) internal pure returns (int160 downcasted) {
downcasted = int160(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(160, value);
}
}
/**
* @dev Returns the downcasted int152 from int256, reverting on
* overflow (when the input is less than smallest int152 or
* greater than largest int152).
*
* Counterpart to Solidity's `int152` operator.
*
* Requirements:
*
* - input must fit into 152 bits
*/
function toInt152(int256 value) internal pure returns (int152 downcasted) {
downcasted = int152(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(152, value);
}
}
/**
* @dev Returns the downcasted int144 from int256, reverting on
* overflow (when the input is less than smallest int144 or
* greater than largest int144).
*
* Counterpart to Solidity's `int144` operator.
*
* Requirements:
*
* - input must fit into 144 bits
*/
function toInt144(int256 value) internal pure returns (int144 downcasted) {
downcasted = int144(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(144, value);
}
}
/**
* @dev Returns the downcasted int136 from int256, reverting on
* overflow (when the input is less than smallest int136 or
* greater than largest int136).
*
* Counterpart to Solidity's `int136` operator.
*
* Requirements:
*
* - input must fit into 136 bits
*/
function toInt136(int256 value) internal pure returns (int136 downcasted) {
downcasted = int136(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(136, value);
}
}
/**
* @dev Returns the downcasted int128 from int256, reverting on
* overflow (when the input is less than smallest int128 or
* greater than largest int128).
*
* Counterpart to Solidity's `int128` operator.
*
* Requirements:
*
* - input must fit into 128 bits
*/
function toInt128(int256 value) internal pure returns (int128 downcasted) {
downcasted = int128(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(128, value);
}
}
/**
* @dev Returns the downcasted int120 from int256, reverting on
* overflow (when the input is less than smallest int120 or
* greater than largest int120).
*
* Counterpart to Solidity's `int120` operator.
*
* Requirements:
*
* - input must fit into 120 bits
*/
function toInt120(int256 value) internal pure returns (int120 downcasted) {
downcasted = int120(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(120, value);
}
}
/**
* @dev Returns the downcasted int112 from int256, reverting on
* overflow (when the input is less than smallest int112 or
* greater than largest int112).
*
* Counterpart to Solidity's `int112` operator.
*
* Requirements:
*
* - input must fit into 112 bits
*/
function toInt112(int256 value) internal pure returns (int112 downcasted) {
downcasted = int112(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(112, value);
}
}
/**
* @dev Returns the downcasted int104 from int256, reverting on
* overflow (when the input is less than smallest int104 or
* greater than largest int104).
*
* Counterpart to Solidity's `int104` operator.
*
* Requirements:
*
* - input must fit into 104 bits
*/
function toInt104(int256 value) internal pure returns (int104 downcasted) {
downcasted = int104(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(104, value);
}
}
/**
* @dev Returns the downcasted int96 from int256, reverting on
* overflow (when the input is less than smallest int96 or
* greater than largest int96).
*
* Counterpart to Solidity's `int96` operator.
*
* Requirements:
*
* - input must fit into 96 bits
*/
function toInt96(int256 value) internal pure returns (int96 downcasted) {
downcasted = int96(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(96, value);
}
}
/**
* @dev Returns the downcasted int88 from int256, reverting on
* overflow (when the input is less than smallest int88 or
* greater than largest int88).
*
* Counterpart to Solidity's `int88` operator.
*
* Requirements:
*
* - input must fit into 88 bits
*/
function toInt88(int256 value) internal pure returns (int88 downcasted) {
downcasted = int88(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(88, value);
}
}
/**
* @dev Returns the downcasted int80 from int256, reverting on
* overflow (when the input is less than smallest int80 or
* greater than largest int80).
*
* Counterpart to Solidity's `int80` operator.
*
* Requirements:
*
* - input must fit into 80 bits
*/
function toInt80(int256 value) internal pure returns (int80 downcasted) {
downcasted = int80(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(80, value);
}
}
/**
* @dev Returns the downcasted int72 from int256, reverting on
* overflow (when the input is less than smallest int72 or
* greater than largest int72).
*
* Counterpart to Solidity's `int72` operator.
*
* Requirements:
*
* - input must fit into 72 bits
*/
function toInt72(int256 value) internal pure returns (int72 downcasted) {
downcasted = int72(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(72, value);
}
}
/**
* @dev Returns the downcasted int64 from int256, reverting on
* overflow (when the input is less than smallest int64 or
* greater than largest int64).
*
* Counterpart to Solidity's `int64` operator.
*
* Requirements:
*
* - input must fit into 64 bits
*/
function toInt64(int256 value) internal pure returns (int64 downcasted) {
downcasted = int64(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(64, value);
}
}
/**
* @dev Returns the downcasted int56 from int256, reverting on
* overflow (when the input is less than smallest int56 or
* greater than largest int56).
*
* Counterpart to Solidity's `int56` operator.
*
* Requirements:
*
* - input must fit into 56 bits
*/
function toInt56(int256 value) internal pure returns (int56 downcasted) {
downcasted = int56(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(56, value);
}
}
/**
* @dev Returns the downcasted int48 from int256, reverting on
* overflow (when the input is less than smallest int48 or
* greater than largest int48).
*
* Counterpart to Solidity's `int48` operator.
*
* Requirements:
*
* - input must fit into 48 bits
*/
function toInt48(int256 value) internal pure returns (int48 downcasted) {
downcasted = int48(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(48, value);
}
}
/**
* @dev Returns the downcasted int40 from int256, reverting on
* overflow (when the input is less than smallest int40 or
* greater than largest int40).
*
* Counterpart to Solidity's `int40` operator.
*
* Requirements:
*
* - input must fit into 40 bits
*/
function toInt40(int256 value) internal pure returns (int40 downcasted) {
downcasted = int40(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(40, value);
}
}
/**
* @dev Returns the downcasted int32 from int256, reverting on
* overflow (when the input is less than smallest int32 or
* greater than largest int32).
*
* Counterpart to Solidity's `int32` operator.
*
* Requirements:
*
* - input must fit into 32 bits
*/
function toInt32(int256 value) internal pure returns (int32 downcasted) {
downcasted = int32(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(32, value);
}
}
/**
* @dev Returns the downcasted int24 from int256, reverting on
* overflow (when the input is less than smallest int24 or
* greater than largest int24).
*
* Counterpart to Solidity's `int24` operator.
*
* Requirements:
*
* - input must fit into 24 bits
*/
function toInt24(int256 value) internal pure returns (int24 downcasted) {
downcasted = int24(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(24, value);
}
}
/**
* @dev Returns the downcasted int16 from int256, reverting on
* overflow (when the input is less than smallest int16 or
* greater than largest int16).
*
* Counterpart to Solidity's `int16` operator.
*
* Requirements:
*
* - input must fit into 16 bits
*/
function toInt16(int256 value) internal pure returns (int16 downcasted) {
downcasted = int16(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(16, value);
}
}
/**
* @dev Returns the downcasted int8 from int256, reverting on
* overflow (when the input is less than smallest int8 or
* greater than largest int8).
*
* Counterpart to Solidity's `int8` operator.
*
* Requirements:
*
* - input must fit into 8 bits
*/
function toInt8(int256 value) internal pure returns (int8 downcasted) {
downcasted = int8(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(8, value);
}
}
/**
* @dev Converts an unsigned uint256 into a signed int256.
*
* Requirements:
*
* - input must be less than or equal to maxInt256.
*/
function toInt256(uint256 value) internal pure returns (int256) {
// Note: Unsafe cast below is okay because `type(int256).max` is guaranteed to be positive
if (value > uint256(type(int256).max)) {
revert SafeCastOverflowedUintToInt(value);
}
return int256(value);
}
/**
* @dev Cast a boolean (false or true) to a uint256 (0 or 1) with no jump.
*/
function toUint(bool b) internal pure returns (uint256 u) {
assembly ("memory-safe") {
u := iszero(iszero(b))
}
}
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.26;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import { IVotes } from "@openzeppelin/contracts/governance/utils/IVotes.sol";
import { IPOLErrors } from "./IPOLErrors.sol";
interface IBGT is IPOLErrors, IERC20, IERC20Metadata, IVotes {
/**
* @notice Emitted when the minter address is changed.
* @param previous The address of the previous minter.
* @param current The address of the current minter.
*/
event MinterChanged(address indexed previous, address indexed current);
/**
* @notice Emitted when the Staker address is changed.
* @param previous The address of the previous Staker.
* @param current The address of the current Staker.
*/
event StakerChanged(address indexed previous, address indexed current);
/**
* @notice Emitted when an address is approved to send BGT.
* @param sender The address of the sender.
* @param approved Whether the sender is approved or not.
*/
event SenderWhitelisted(address indexed sender, bool approved);
/**
* @notice Emitted when sender queues a new boost for a validator with an amount of BGT
* @param user The address of the user.
* @param pubkey The pubkey of the validator to be queued for boost.
* @param amount The amount of BGT enqueued for boosting during function call.
*/
event QueueBoost(address indexed user, bytes indexed pubkey, uint128 amount);
/**
* @notice Emitted when sender cancels a queued boost for a validator with an amount of BGT
* @param user The address of the user.
* @param pubkey The pubkey of the validator to be canceled from queued boosts.
* @param amount The amount of BGT to cancel from queued boosts.
*/
event CancelBoost(address indexed user, bytes indexed pubkey, uint128 amount);
/**
* @notice Emitted when sender activates a new boost for a validator
* @param sender The address of the sender.
* @param user The address of the user boosting.
* @param pubkey The pubkey of the validator to be activated for the queued boosts.
* @param amount The amount of BGT to boost with.
*/
event ActivateBoost(address indexed sender, address indexed user, bytes indexed pubkey, uint128 amount);
/**
* @notice Emitted when an user queues a drop boost for a validator.
* @param user The address of the user.
* @param pubkey The pubkey of the validator to remove boost from.
* @param amount The amount of BGT boost enqueued for dropping boost during function call.
*/
event QueueDropBoost(address indexed user, bytes indexed pubkey, uint128 amount);
/**
* @notice Emitted when an user cancels a queued drop boost for a validator.
* @param user The address of the user.
* @param pubkey The pubkey of the validator to cancel drop boost for.
* @param amount The amount of BGT boost to cancel.
*/
event CancelDropBoost(address indexed user, bytes indexed pubkey, uint128 amount);
/**
* @notice Emitted when sender removes an amount of BGT boost from a validator
* @param sender The address of the sender.
* @param user The address of the user dropping boost.
* @param pubkey The pubkey of the validator to remove boost from.
* @param amount The amount of BGT boost to remove.
*/
event DropBoost(address indexed sender, address indexed user, bytes indexed pubkey, uint128 amount);
/**
* @notice Emitted when the BGT token is redeemed for the native token.
* @param from The address of the redeemer.
* @param receiver The address of the receiver.
* @param amount The amount of redeemed BGT (and thus, of received BERA).
*/
event Redeem(address indexed from, address indexed receiver, uint256 amount);
/**
* @notice Emitted when the activate boost delay is changed.
* @param newDelay The new delay for activating boosts.
*/
event ActivateBoostDelayChanged(uint32 newDelay);
/**
* @notice Emitted when the drop boost delay is changed.
* @param newDelay The new delay for dropping boosts.
*/
event DropBoostDelayChanged(uint32 newDelay);
/**
* @notice Emitted when the BGT terms and conditions are changed.
* @param newTermsAndConditions The new terms and conditions.
*/
event BgtTermsAndConditionsChanged(string newTermsAndConditions);
/**
* @notice Returns the BGT staker contract address.
* @return The address of the staker.
*/
function staker() external view returns (address);
/**
* @notice Returns the activate boost delay.
* @return The activate boost delay.
*/
function activateBoostDelay() external view returns (uint32);
/**
* @notice Returns the drop boost delay.
* @return The drop boost delay.
*/
function dropBoostDelay() external view returns (uint32);
/**
* @notice Emitted when the native token exceeding reserves are burnt.
* @param caller The address of the caller.
* @param amount The amount of BERA burnt.
*/
event ExceedingReservesBurnt(address caller, uint256 amount);
/**
* @notice Approve an address to send BGT or approve another address to transfer BGT from it.
* @dev This can only be called by the governance module.
* @dev BGT should be soul bound to EOAs and only transferable by approved senders.
* @param sender The address of the sender.
* @param approved Whether the sender is approved or not.
*/
function whitelistSender(address sender, bool approved) external;
/**
* @notice Mint BGT to the distributor.
* @dev This can only be called by the minter address, which is set by governance.
* @param distributor The address of the distributor.
* @param amount The amount of BGT to mint.
*/
function mint(address distributor, uint256 amount) external;
/**
* @notice Queues a new boost of the validator with an amount of BGT from `msg.sender`.
* @dev Reverts if `msg.sender` does not have enough unboosted balance to cover amount.
* @param pubkey The pubkey of the validator to be boosted.
* @param amount The amount of BGT to use for the queued boost.
*/
function queueBoost(bytes calldata pubkey, uint128 amount) external;
/**
* @notice Cancels a queued boost of the validator removing an amount of BGT for `msg.sender`.
* @dev Reverts if `msg.sender` does not have enough queued balance to cover amount.
* @param pubkey The pubkey of the validator to cancel boost for.
* @param amount The amount of BGT to remove from the queued boost.
*/
function cancelBoost(bytes calldata pubkey, uint128 amount) external;
/**
* @notice Boost the validator with an amount of BGT from `user`.
* @param user The address of the user boosting.
* @param pubkey The pubkey of the validator to be boosted.
* @return bool False if amount is zero or if enough time has not passed, otherwise true.
*/
function activateBoost(address user, bytes calldata pubkey) external returns (bool);
/**
* @notice Queues a drop boost of the validator removing an amount of BGT for sender.
* @dev Reverts if `user` does not have enough boosted balance to cover amount.
* @param pubkey The pubkey of the validator to remove boost from.
* @param amount The amount of BGT to remove from the boost.
*/
function queueDropBoost(bytes calldata pubkey, uint128 amount) external;
/**
* @notice Cancels a queued drop boost of the validator removing an amount of BGT for sender.
* @param pubkey The pubkey of the validator to cancel drop boost for.
* @param amount The amount of BGT to remove from the queued drop boost.
*/
function cancelDropBoost(bytes calldata pubkey, uint128 amount) external;
/**
* @notice Drops an amount of BGT from an existing boost of validator by user.
* @param user The address of the user to drop boost from.
* @param pubkey The pubkey of the validator to remove boost from.
* @return bool False if amount is zero or if enough time has not passed, otherwise true.
*/
function dropBoost(address user, bytes calldata pubkey) external returns (bool);
/**
* @notice Returns the amount of BGT queued up to be used by an account to boost a validator.
* @param account The address of the account boosting.
* @param pubkey The pubkey of the validator being boosted.
*/
function boostedQueue(
address account,
bytes calldata pubkey
)
external
view
returns (uint32 blockNumberLast, uint128 balance);
/**
* @notice Returns the amount of BGT queued up by an account to drop boost from a validator.
* @param account The address of the account dropping boost.
* @param pubkey The pubkey of the validator to drop boost for.
*/
function dropBoostQueue(
address account,
bytes calldata pubkey
)
external
view
returns (uint32 blockNumberLast, uint128 balance);
/**
* @notice Returns the amount of BGT queued up to be used by an account for boosts.
* @param account The address of the account boosting.
*/
function queuedBoost(address account) external view returns (uint128);
/**
* @notice Returns the amount of BGT used by an account to boost a validator.
* @param account The address of the account boosting.
* @param pubkey The pubkey of the validator being boosted.
*/
function boosted(address account, bytes calldata pubkey) external view returns (uint128);
/**
* @notice Returns the amount of BGT used by an account for boosts.
* @param account The address of the account boosting.
*/
function boosts(address account) external view returns (uint128);
/**
* @notice Returns the amount of BGT attributed to the validator for boosts.
* @param pubkey The pubkey of the validator being boosted.
*/
function boostees(bytes calldata pubkey) external view returns (uint128);
/**
* @notice Returns the total boosts for all validators.
*/
function totalBoosts() external view returns (uint128);
/**
* @notice Returns the normalized boost power for the validator given outstanding boosts.
* @dev Used by distributor get validator boost power.
* @param pubkey The pubkey of the boosted validator.
*/
function normalizedBoost(bytes calldata pubkey) external view returns (uint256);
/**
* @notice Public variable that represents the caller of the mint method.
* @dev This is going to be the BlockRewardController contract at first.
*/
function minter() external view returns (address);
/**
* @notice Set the minter address.
* @dev This can only be called by the governance module.
* @param _minter The address of the minter.
*/
function setMinter(address _minter) external;
/**
* @notice Set the BGT staker contract address.
* @param _staker The address of the staker.
*/
function setStaker(address _staker) external;
/**
* @notice Set the activate boost delay.
* @param _activateBoostDelay The new delay for activating boosts.
*/
function setActivateBoostDelay(uint32 _activateBoostDelay) external;
/**
* @notice Set the drop boost delay.
* @param _dropBoostDelay The new delay for dropping boosts.
*/
function setDropBoostDelay(uint32 _dropBoostDelay) external;
/**
* @notice Redeem the BGT token for the native token at a 1:1 rate.
* @param receiver The receiver's address who will receive the native token.
* @param amount The amount of BGT to redeem.
*/
function redeem(address receiver, uint256 amount) external;
/**
* @notice Returns the unboosted balance of an account.
* @param account The address of the account.
*/
function unboostedBalanceOf(address account) external view returns (uint256);
/**
* @notice Burns the excess BERA held by this contract to redeem BGTs.
* @dev Since CL at deployment is minting to this contract a quantity of native token sufficient to redeem
* the upper bound of BGT production range, this contract may hold excess BERA. Can burn BERA exceeding
* BGT.totalSupply() + outstanding rewards.
*/
function burnExceedingReserves() external;
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.26;
import { IPOLErrors } from "./IPOLErrors.sol";
import { IStakingRewards } from "../../base/IStakingRewards.sol";
interface IRewardVault is IPOLErrors, IStakingRewards {
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* EVENTS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @notice Emitted when a delegate has staked on behalf of an account.
/// @param account The account whose delegate has staked.
/// @param delegate The delegate that has staked.
/// @param amount The amount of staked tokens.
event DelegateStaked(address indexed account, address indexed delegate, uint256 amount);
/// @notice Emitted when a delegate has withdrawn on behalf of an account.
/// @param account The account whose delegate has withdrawn.
/// @param delegate The delegate that has withdrawn.
/// @param amount The amount of withdrawn tokens.
event DelegateWithdrawn(address indexed account, address indexed delegate, uint256 amount);
/// @notice Emitted when a token has been recovered.
/// @param token The token that has been recovered.
/// @param amount The amount of token recovered.
event Recovered(address token, uint256 amount);
/// @notice Emitted when the msg.sender has set an operator to handle its rewards.
/// @param account The account that has set the operator.
/// @param operator The operator that has been set.
event OperatorSet(address account, address operator);
/// @notice Emitted when the distributor is set.
/// @param distributor The address of the distributor.
event DistributorSet(address indexed distributor);
/// @notice Emitted when the manager of an incentive token is changed.
/// @param token The address of the incentive token.
/// @param newManager The new manager of the incentive token.
/// @param oldManager The old manager of the incentive token.
event IncentiveManagerChanged(address indexed token, address newManager, address oldManager);
/// @notice Emitted when an incentive token is whitelisted.
/// @param token The address of the token that has been whitelisted.
/// @param minIncentiveRate The minimum amount of the token to incentivize per BGT emission.
/// @param manager The address of the manager that can addIncentive for this incentive token.
event IncentiveTokenWhitelisted(address indexed token, uint256 minIncentiveRate, address manager);
/// @notice Emitted when an incentive token is removed.
/// @param token The address of the token that has been removed.
event IncentiveTokenRemoved(address indexed token);
/// @notice Emitted when maxIncentiveTokensCount is updated.
/// @param maxIncentiveTokensCount The max count of incentive tokens.
event MaxIncentiveTokensCountUpdated(uint8 maxIncentiveTokensCount);
/// @notice Emitted when incentives are processed for the operator of a validator.
event IncentivesProcessed(bytes indexed pubkey, address indexed token, uint256 bgtEmitted, uint256 amount);
/// @notice Emitted when incentives fail to be processed for the operator of a validator.
event IncentivesProcessFailed(bytes indexed pubkey, address indexed token, uint256 bgtEmitted, uint256 amount);
/// @notice Emitted when incentives are added to the vault.
/// @param token The incentive token.
/// @param sender The address that added the incentive.
/// @param amount The amount of the incentive.
/// @param incentiveRate The amount of the token to incentivize per BGT emission.
event IncentiveAdded(address indexed token, address sender, uint256 amount, uint256 incentiveRate);
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* GETTERS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @notice Get the address that is allowed to distribute rewards.
/// @return The address that is allowed to distribute rewards.
function distributor() external view returns (address);
/// @notice Get the operator for an account.
/// @param account The account to get the operator for.
/// @return The operator for the account.
function operator(address account) external view returns (address);
/// @notice Get the count of active incentive tokens.
/// @return The count of active incentive tokens.
function getWhitelistedTokensCount() external view returns (uint256);
/// @notice Get the list of whitelisted tokens.
/// @return The list of whitelisted tokens.
function getWhitelistedTokens() external view returns (address[] memory);
/// @notice Get the total amount staked by delegates.
/// @return The total amount staked by delegates.
function getTotalDelegateStaked(address account) external view returns (uint256);
/// @notice Get the amount staked by a delegate on behalf of an account.
/// @return The amount staked by a delegate.
function getDelegateStake(address account, address delegate) external view returns (uint256);
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* ADMIN */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/**
* @notice Initialize the vault, this is only callable once and by the factory since its the deployer.
* @param _berachef The address of the berachef.
* @param _bgt The address of the BGT token.
* @param _distributor The address of the distributor.
* @param _stakingToken The address of the staking token.
*/
function initialize(address _berachef, address _bgt, address _distributor, address _stakingToken) external;
/// @notice Allows the factory owner to set the contract that is allowed to distribute rewards.
/// @param _rewardDistribution The address that is allowed to distribute rewards.
function setDistributor(address _rewardDistribution) external;
/// @notice Allows the distributor to notify the reward amount.
/// @param pubkey The pubkey of the validator.
/// @param reward The amount of reward to notify.
function notifyRewardAmount(bytes calldata pubkey, uint256 reward) external;
/// @notice Allows the factory owner to recover any ERC20 token from the vault.
/// @param tokenAddress The address of the token to recover.
/// @param tokenAmount The amount of token to recover.
function recoverERC20(address tokenAddress, uint256 tokenAmount) external;
/// @notice Allows the factory owner to update the duration of the rewards.
/// @param _rewardsDuration The new duration of the rewards.
function setRewardsDuration(uint256 _rewardsDuration) external;
/// @notice Allows the factory owner to whitelist a token to incentivize with.
/// @param token The address of the token to whitelist.
/// @param minIncentiveRate The minimum amount of the token to incentivize per BGT emission.
/// @param manager The address of the manager that can addIncentive for this token.
function whitelistIncentiveToken(address token, uint256 minIncentiveRate, address manager) external;
/// @notice Allows the factory vault manager to remove a whitelisted incentive token.
/// @param token The address of the token to remove.
function removeIncentiveToken(address token) external;
/// @notice Allows the factory owner to update the maxIncentiveTokensCount.
/// @param _maxIncentiveTokensCount The new maxIncentiveTokens count.
function setMaxIncentiveTokensCount(uint8 _maxIncentiveTokensCount) external;
/// @notice Allows the factory vault pauser to pause the vault.
function pause() external;
/// @notice Allows the factory vault manager to unpause the vault.
function unpause() external;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* MUTATIVE */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @notice Exit the vault with the staked tokens and claim the reward.
/// @dev Only the account holder can call this function, not the operator.
/// @dev Clears out the user self-staked balance and rewards.
/// @param recipient The address to send the 'BGT' reward to.
function exit(address recipient) external;
/// @notice Claim the reward.
/// @dev The operator only handles BGT, not STAKING_TOKEN.
/// @dev Callable by the operator or the account holder.
/// @param account The account to get the reward for.
/// @param recipient The address to send the reward to.
/// @return The amount of the reward claimed.
function getReward(address account, address recipient) external returns (uint256);
/// @notice Stake tokens in the vault.
/// @param amount The amount of tokens to stake.
function stake(uint256 amount) external;
/// @notice Stake tokens on behalf of another account.
/// @param account The account to stake for.
/// @param amount The amount of tokens to stake.
function delegateStake(address account, uint256 amount) external;
/// @notice Withdraw the staked tokens from the vault.
/// @param amount The amount of tokens to withdraw.
function withdraw(uint256 amount) external;
/// @notice Withdraw tokens staked on behalf of another account by the delegate (msg.sender).
/// @param account The account to withdraw for.
/// @param amount The amount of tokens to withdraw.
function delegateWithdraw(address account, uint256 amount) external;
/// @notice Allows msg.sender to set another address to claim and manage their rewards.
/// @param _operator The address that will be allowed to claim and manage rewards.
function setOperator(address _operator) external;
/// @notice Update the manager of an incentive token.
/// @dev Permissioned function, only allow factory owner to update the manager.
/// @param token The address of the incentive token.
/// @param newManager The new manager of the incentive token.
function updateIncentiveManager(address token, address newManager) external;
/// @notice Add an incentive token to the vault.
/// @notice The incentive token's transfer should not exceed a gas usage of 500k units.
/// In case the transfer exceeds 500k gas units, your incentive will fail to be transferred to the validator and
/// its delegates.
/// @param token The address of the token to add as an incentive.
/// @param amount The amount of the token to add as an incentive.
/// @param incentiveRate The amount of the token to incentivize per BGT emission.
/// @dev Permissioned function, only callable by incentive token manager.
function addIncentive(address token, uint256 amount, uint256 incentiveRate) external;
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
import { Math } from "@openzeppelin-contracts-5.1.0/utils/math/Math.sol";
import { ERC20 } from "@openzeppelin-contracts-5.1.0/token/ERC20/ERC20.sol";
import { ERC20Permit } from "@openzeppelin-contracts-5.1.0/token/ERC20/extensions/ERC20Permit.sol";
import { ERC20FlashMint } from "@openzeppelin-contracts-5.1.0/token/ERC20/extensions/ERC20FlashMint.sol";
import { ERC20Wrapper } from "@openzeppelin-contracts-5.1.0/token/ERC20/extensions/ERC20Wrapper.sol";
import { AccessControl } from "@openzeppelin-contracts-5.1.0/access/AccessControl.sol";
import { IERC3156FlashLender } from "@openzeppelin-contracts-5.1.0/interfaces/IERC3156FlashLender.sol";
import { ILBGT } from "./interfaces/ILBGT.sol";
import { Constants } from "../Constants.sol";
/**
* @title LBGT (Liquid BGT)
* @author BeraPaw
* @notice ERC20 token representing liquid staked BGT in the BeraPaw protocol
* @dev Implementation of liquid staking token with:
* Core functions:
* - mint/burn: Controlled by BeraPawForge
* - flash loans: Configurable amounts and fees
* - permit: ERC20 gasless approvals
*/
contract LBGT is ILBGT, ERC20, ERC20Permit, ERC20FlashMint, AccessControl {
using Math for uint256;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* CONSTANTS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @inheritdoc ILBGT
address public immutable beraPawForge;
uint16 constant ONE_HUNDRED_PERCENT = 10_000;
/// @dev Can only give admin role.
bytes32 public constant ROLE_GOD = Constants.ROLE_GOD;
/// @dev Can only set flashMint parameters.
bytes32 public constant ROLE_ADMIN = Constants.ROLE_ADMIN;
/// @dev Can only flashMint without fees and limit, used to facilitate internal operations.
bytes32 public constant ROLE_FLASH_MINTER = Constants.ROLE_FLASH_MINTER;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* STORAGE */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @inheritdoc ILBGT
uint16 public flashMintPercentualFee;
/// @inheritdoc ILBGT
address public flashFeeCollector;
/// @inheritdoc ILBGT
uint256 public flashMaxMint;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* MODIFIERS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
modifier onlyBeraPawForge() {
require(_msgSender() == beraPawForge, OnlyBeraPawForge());
_;
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* INITIALIZATION */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
constructor(
address _berapawForge,
address _owner
)
ERC20("Liquid BGT", "LBGT")
ERC20Permit("Liquid BGT")
ERC20FlashMint()
{
beraPawForge = _berapawForge;
flashMintPercentualFee = 50; //0.5%
flashMaxMint = 0; // We start with no flash mint
_setRoleAdmin(ROLE_GOD, ROLE_GOD);
_setRoleAdmin(ROLE_ADMIN, ROLE_GOD);
_setRoleAdmin(ROLE_FLASH_MINTER, ROLE_GOD);
_grantRole(ROLE_GOD, _owner);
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* ADMIN FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @inheritdoc ILBGT
function setFlashMintFee(uint16 _flashMintPercentualFee) public onlyRole(ROLE_ADMIN) {
require(_flashMintPercentualFee <= ONE_HUNDRED_PERCENT, InvalidFee(_flashMintPercentualFee));
flashMintPercentualFee = _flashMintPercentualFee;
emit FlashFeeSet(_flashMintPercentualFee);
}
/// @inheritdoc ILBGT
function setFlashMaxMint(uint256 _maxFlashMint) public onlyRole(ROLE_ADMIN) {
flashMaxMint = _maxFlashMint;
emit FlashMaxMintSet(_maxFlashMint);
}
/// @inheritdoc ILBGT
function setFlashFeeCollector(address _feeCollector) public onlyRole(ROLE_ADMIN) {
require(_feeCollector != address(0), ZeroAddress());
flashFeeCollector = _feeCollector;
emit FlashFeeCollectorSet(_feeCollector);
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* BERAPAW FORGE FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @inheritdoc ILBGT
function mint(address to, uint256 amount) public onlyBeraPawForge {
_mint(to, amount);
}
/// @inheritdoc ILBGT
function burn(address from, uint256 amount) public onlyBeraPawForge {
_burn(from, amount);
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* OVERRIDES */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/**
* @notice Get the max flash loan amount of the given token.
* @dev Only LBGT can be flash loaned.
* The ROLE_FLASH_MINTER can flash mint regardless of the limit.
* @param token The token to get the max flash loan amount for.
* @return The max flash loan amount of the given token.
*/
function maxFlashLoan(address token) public view override returns (uint256) {
if (token != address(this)) {
return 0;
}
if (hasRole(ROLE_FLASH_MINTER, _msgSender())) {
return type(uint128).max - totalSupply();
}
return Math.min(type(uint128).max - totalSupply(), flashMaxMint);
}
/**
* @notice Get the flash fee for a given amount of tokens.
* @dev Only used for flash loans. The ROLE_FLASH_MINTER can flash mint with zero fee.
* @param value The amount of tokens to get the flash fee for.
* @return The flash fee for the given amount of tokens.
*/
function _flashFee(address, /*token*/ uint256 value) internal view override returns (uint256) {
if (hasRole(ROLE_FLASH_MINTER, _msgSender())) {
return 0;
}
return value.mulDiv(flashMintPercentualFee, ONE_HUNDRED_PERCENT);
}
/**
* @notice Get the address to send the flash fee to.
* @dev Only used for flash loans.
* @return The address to send the flash fee to.
*/
function _flashFeeReceiver() internal view override returns (address) {
return flashFeeCollector;
}
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
import { IErrors } from "./IErrors.sol";
interface IBeraPawForge is IErrors {
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* STRUCTS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
struct RedeemPosition {
uint128 queued;
uint128 available;
}
struct RedeemQueue {
address account;
uint96 blockNumber;
}
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* EVENTS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @notice Emitted when LBGT is minted.
/// @param account The user for whom rewards were claimed.
/// @param rewardVault The rewards vault from which rewards were claimed.
/// @param recipient The address receiving the minted LBGT.
/// @param amount The amount of LBGT minted.
event LBGTMinted(address indexed account, address indexed rewardVault, address indexed recipient, uint256 amount);
event Referred(address indexed account, bytes32 indexed referrer, uint256 amount);
/// @notice Emitted when an address is set to get voting rights on behalf of this contract.
/// @dev Triggered by {delegate}.
/// @param delegate The address that will receive the voting power.
event Delegated(address indexed delegate);
/// @notice Emitted when treasury address is updated
/// @dev Triggered when treasury address is set
/// @param treasury The new treasury address
event TreasurySet(address indexed treasury);
/// @notice Emitted when a user queues LBGT for redemption
/// @dev Triggered in `queueRedeem` function
/// @param account The address requesting redemption
/// @param amount The amount of LBGT being queued
event RedeemQueued(address indexed account, uint256 amount);
/// @notice Emitted when LBGT is redeemed for BGT
/// @dev Triggered in `redeem` function
/// @param account The address redeeming LBGT
/// @param recipient The address receiving BGT
/// @param amount The amount being redeemed
event Redeemed(address indexed account, address indexed recipient, uint256 amount);
/// @notice Emitted when a redemption request is processed by a solver
/// @dev Triggered in `processRedemptions` function
/// @param account The address whose redemption is being processed
/// @param recipient The solver's address receiving LBGT
/// @param amount The amount processed that the user will be able to claim
event RedeemProcessed(address indexed account, address indexed recipient, uint256 amount);
/// @notice Emitted when a manager is set for an account's rewards vault
/// @dev Triggered in `setManager` function
/// @param account The address setting the manager
/// @param rewardVault The rewards vault address
/// @param manager The new manager address
event ManagerSet(address indexed account, address indexed rewardVault, address indexed manager);
/// @notice Emitted when queue delay is updated
/// @dev Triggered in `setQueueDelay` function
/// @param queueDelay The new queue delay value
event QueueDelaySet(uint256 queueDelay);
/// @notice Emitted when minimum redeem amount is updated
/// @dev Triggered in `setMinimumRedeemAmount` function
/// @param minimumRedeemAmount The new minimum redeem amount
event MinimumRedeemAmountSet(uint256 minimumRedeemAmount);
/// @notice Emitted when processing fee is updated
/// @dev Triggered in `setProcessingFee` function
/// @param processingFee The new processing fee value
event ProcessingFeeSet(uint256 processingFee);
/// @notice Emitted when staker rewards are collected
/// @dev Triggered in `collectStakerReward` function
/// @param caller The address collecting the reward
/// @param to The address receiving the reward
/// @param amount The amount of rewards collected
event StakerRewardCollected(address indexed caller, address indexed to, uint256 amount);
/// @notice Emitted when tokens are recovered from the contract
/// @dev Triggered in `recover` function
/// @param token The address of the recovered token
/// @param to The address receiving the recovered tokens
/// @param amount The amount of tokens recovered
event Recovered(address indexed token, address indexed to, uint256 amount);
/// @notice Emitted when process redemptions toggle is updated
/// @dev Triggered in `setOpenProcessRedemptions` function
/// @param openProcessRedemptions The new state of process redemptions
event OpenProcessRedemptionsSet(bool openProcessRedemptions);
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* ADMIN FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @notice Pause all user functions.
/// @dev Only the curator can pause the forge.
function pause() external;
/// @notice Unpause the forge.
/// @dev Only the admin can unpause the forge.
function unpause() external;
/// @notice Delegates the underlying BGT token to another address for voting purposes.
/// this address can vote on behalf of this contract. Should be set to the governance
/// timelock contract.
/// @dev Only the admin can delegate the LBGT token.
/// @param _delegate The address to delegate the underlying BGT token to.
function delegate(address _delegate) external;
/// @notice Sets the queue delay for redemptions.
/// @dev Only the admin can set the queue delay.
/// @param _queueDelay The new queue delay in blocks.
function setQueueDelay(uint96 _queueDelay) external;
/// @notice Sets the minimum redeem amount.
/// @dev Only the admin can set the minimum redeem amount.
/// @param _minimumRedeemAmount The new minimum redeem amount.
function setMinimumRedeemAmount(uint128 _minimumRedeemAmount) external;
/// @notice Sets the processing fee for redemptions.
/// @dev Only the admin can set the processing fee.
/// @param _processingFee The new processing fee as a percentage (1e18 = 100%).
function setProcessingFee(uint256 _processingFee) external;
/// @notice Sets whether redemption processing is open to non-processors
/// @dev Only callable by GOD role
/// @param _open True to allow anyone to process redemptions, false to restrict to processors only
function setOpenProcessRedemptions(bool _open) external;
function recover(address token, address to, uint256 amount) external;
/// @notice Recovers ERC20 tokens accidentally sent to the contract
/// @dev Only callable by GOD role
/// @param token The address of the ERC20 token to recover
/// @param to The address to send the recovered tokens to
/// @param amount The amount of tokens to recover
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* PUBLIC FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @notice Sets the manager for a rewards vault.
/// @param rewardVault The rewards vault to set the manager for.
/// @param manager The address of the manager.
function setManager(address rewardVault, address manager) external;
/// @notice Sets the managers for a set of reward vaults.
/// @dev rewardVaults and managers must have the same length.
/// @param rewardVaults The reward vaults to set the manager for.
/// @param managers Addresses of the managers.
function setManagerMulti(address[] calldata rewardVaults, address[] calldata managers) external;
/// @notice Mints LBGT for a user.
/// @param user The user for whom rewards are claimed.
/// @param rewardVault The rewards vault from which rewards are claimed.
/// @param recipient The address receiving the minted LBGT.
/// @return The amount of LBGT minted.
function mint(address user, address rewardVault, address recipient) external returns (uint256);
/// @notice Mints LBGT for a user with a referrer.
/// @param user The user for whom rewards are claimed.
/// @param rewardVault The rewards vault from which rewards are claimed.
/// @param recipient The address receiving the minted LBGT.
/// @param referrer The referrer data.
/// @return The amount of LBGT minted.
function mintReferred(
address user,
address rewardVault,
address recipient,
bytes32 referrer
)
external
returns (uint256);
/// @notice Mints LBGT for multiple users.
/// @param users Array of user addresses.
/// @param rewardVaults Array of rewards vault addresses corresponding to users.
/// @param recipients Array of recipient addresses.
/// @return The total amount of LBGT minted.
function mintMulti(
address[] calldata users,
address[] calldata rewardVaults,
address[] calldata recipients
)
external
returns (uint256);
/// @notice Queues a redeem request for a user.
/// @param amount The amount of LBGT to redeem.
function queueRedeem(uint128 amount) external;
/// @notice Redeems LBGT for a user.
/// @param recipient The address receiving the redeemed amount.
/// @param amount The amount of LBGT to redeem.
function redeem(uint128 amount, address recipient) external;
/// @notice Processes redemption requests.
/// @param maxBatchSize The maximum number of redemption requests to process.
/// @param recipient The address receiving the redeemed amount.
function processRedemptions(uint128 maxBatchSize, address recipient) external payable;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* REWARDS FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
function collectStakerReward(address to) external returns (uint256);
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* BOOSTER FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/**
* @notice Queues a new boost of the validator with an amount of BGT from `msg.sender`.
* @dev Reverts if `msg.sender` does not have enough unboosted balance to cover amount.
* @param pubkey The pubkey of the validator to be boosted.
* @param amount The amount of BGT to use for the queued boost.
*/
function queueBoost(bytes calldata pubkey, uint128 amount) external;
/**
* @notice Cancels a queued boost of the validator removing an amount of BGT for `msg.sender`.
* @dev Reverts if `msg.sender` does not have enough queued balance to cover amount.
* @param pubkey The pubkey of the validator to cancel boost for.
* @param amount The amount of BGT to remove from the queued boost.
*/
function cancelBoost(bytes calldata pubkey, uint128 amount) external;
/**
* @notice Boost the validator with an amount of BGT.
* @param pubkey The pubkey of the validator to be boosted.
* @return bool False if amount is zero or if enough time has not passed, otherwise true.
*/
function activateBoost(bytes calldata pubkey) external returns (bool);
/**
* @notice Queues a drop boost of the validator removing an amount of BGT for sender.
* @dev Reverts if does not have enough boosted balance to cover amount.
* @param pubkey The pubkey of the validator to remove boost from.
* @param amount The amount of BGT to remove from the boost.
*/
function queueDropBoost(bytes calldata pubkey, uint128 amount) external;
/**
* @notice Cancels a queued drop boost of the validator removing an amount of BGT for sender.
* @param pubkey The pubkey of the validator to cancel drop boost for.
* @param amount The amount of BGT to remove from the queued drop boost.
*/
function cancelDropBoost(bytes calldata pubkey, uint128 amount) external;
/**
* @notice Drops an amount of BGT from an existing boost of validator.
* @param pubkey The pubkey of the validator to remove boost from.
* @return bool False if amount is zero or if enough time has not passed, otherwise true.
*/
function dropBoost(bytes calldata pubkey) external returns (bool);
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* VIEW FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/**
* @notice Returns the LBGT token address.
* @return The address of LBGT.
*/
function lbgtAddress() external view returns (address);
/**
* @notice Returns the BGT operator address for the given rewards vault and user.
* @param rewardVault The rewards vault to get the BGT operator from.
* @param account The user account to get the BGT operator from.
* @return The BGT operator address for the given rewards vault and user.
* @dev The BGT operator is the address that can claim BGT rewards for the given user and rewards vault.
*/
function getBGTOperator(address rewardVault, address account) external view returns (address);
/**
* @notice Returns the amount of BGT minus the amount queued for redeem.
* @return The amount of boostable BGT.
*/
function boostableBGT() external view returns (uint256);
/// @notice Returns the manager address for a given account and rewards vault
/// @dev Used to track who can manage LBGT rewards for an account
/// @param account The address of the account
/// @param rewardVault The address of the rewards vault
/// @return manager The address of the authorized manager
function lbgtManager(address account, address rewardVault) external view returns (address);
/// @notice Returns the redeem position for a given account
/// @dev Contains details about user's pending redemption
/// @param account The address of the account
/// @return queued Amount of LBGT queued for redemption
/// @return available Amount of LBGT available for redemption
function redeemPosition(address account) external view returns (uint128 queued, uint128 available);
/// @notice Returns redeem queue entry at specified index
/// @dev Used to track all redemption requests in order
/// @param index The position in the queue
/// @return account The account that entered the queue entry details
/// @return blockNumber The block where the queue entry started
function redeemQueue(uint256 index) external view returns (address account, uint96 blockNumber);
/// @notice Returns the current index in the redeem queue
/// @dev Represents the next position to be processed
/// @return Current queue index
function redeemQueueIndex() external view returns (uint128);
/// @notice Returns total number of entries in redeem queue
/// @dev Represents total redemption requests
/// @return Total queue size
function totalRedeemQueue() external view returns (uint128);
/// @notice Returns current processing fee
/// @dev Fee charged for processing redemptions
/// @return Current processing fee amount
function processingFee() external view returns (uint256);
/// @notice Returns delay period for queue processing
/// @dev Minimum time that must pass before processing redemptions
/// @return Delay period in seconds
function queueDelay() external view returns (uint96);
/// @notice Returns minimum amount required for redemption
/// @dev Prevents dust amounts from being redeemed
/// @return Minimum redemption amount
function minimumRedeemAmount() external view returns (uint128);
/// @notice Returns whether redemption processing is currently enabled
/// @dev Controls if redemptions can be processed
/// @return true if processing is open, false otherwise
function isProcessRedemptionsOpen() external view returns (bool);
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.26;
import { IPOLErrors } from "./IPOLErrors.sol";
import { IStakingRewards } from "../../base/IStakingRewards.sol";
interface IBGTStaker is IPOLErrors, IStakingRewards {
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* EVENTS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @notice Emitted when a token has been recovered.
/// @param token The token that has been recovered.
/// @param amount The amount of token recovered.
event Recovered(address token, uint256 amount);
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* ADMIN FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @notice Notify the staker of a new reward amount.
/// @dev Can only be called by the fee collector.
/// @param reward The amount of reward to notify.
function notifyRewardAmount(uint256 reward) external;
/// @notice Recover ERC20 tokens.
/// @dev Revert if the tokenAddress is the reward token.
/// @dev Can only be called by the owner.
/// @param tokenAddress The address of the token to recover.
/// @param tokenAmount The amount of token to recover.
function recoverERC20(address tokenAddress, uint256 tokenAmount) external;
/// @notice Set the rewards duration.
/// @dev Revert if the reward cycle has started.
/// @dev Can only be called by the owner.
/// @param _rewardsDuration The rewards duration.
function setRewardsDuration(uint256 _rewardsDuration) external;
/// @notice Stake BGT tokens.
/// @dev Can only be called by the BGT contract.
/// @param account The account to stake for.
/// @param amount The amount of BGT to stake.
function stake(address account, uint256 amount) external;
/// @notice Withdraw BGT tokens.
/// @dev Can only be called by the BGT contract.
/// @param account The account to withdraw for.
/// @param amount The amount of BGT to withdraw.
function withdraw(address account, uint256 amount) external;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* STATE MUTATING FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @notice Get the reward.
/// @dev Get the reward for the caller.
/// @return The reward amount.
function getReward() external returns (uint256);
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
library Constants {
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* CONTRACTS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// BeraPaw
address constant BERAPAW_FORGE = 0xFeedb9750d6ac77D2E52e0C9EB8fB79F9de5Cafe;
address constant LBGT = 0xBaadCC2962417C01Af99fb2B7C75706B9bd6Babe;
address constant STAKED_LBGT = 0xFaceb349C1a0b71cC5782C45281747979300F0ca;
address constant PAW = address(0); // TODO: generate addy
address constant STAKED_PAW = address(0); // TODO: generate addy
/// Berachain
address constant REWARD_VAULT_FACTORY = 0x94Ad6Ac84f6C6FbA8b8CCbD71d9f4f101def52a8;
address constant BGT = 0x656b95E550C07a9ffe548bd4085c72418Ceb1dba;
address constant BGT_STAKER = 0x44F07Ce5AfeCbCC406e6beFD40cc2998eEb8c7C6;
address constant BERACHAIN_GOVERNANCE = 0x4f4A5c2194B8e856b7a05B348F6ba3978FB6f6D5;
address constant BEACON_DEPOSIT = 0x4242424242424242424242424242424242424242;
address constant WBERA = 0x6969696969696969696969696969696969696969;
address constant HONEY = 0xFCBD14DC51f0A4d49d5E53C2E0950e0bC26d0Dce;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* ROLES */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
bytes32 constant ROLE_GOD = keccak256("ROLE_GOD");
bytes32 constant ROLE_ADMIN = keccak256("ROLE_ADMIN");
bytes32 constant ROLE_CURATOR = keccak256("ROLE_CURATOR");
// BeraPaw Forge
bytes32 constant ROLE_BOOSTER = keccak256("ROLE_BOOSTER");
bytes32 constant ROLE_REWARD_COLLECTOR = keccak256("ROLE_REWARD_COLLECTOR");
bytes32 constant ROLE_REDEMPTIONS_PROCESSOR = keccak256("ROLE_REDEMPTIONS_PROCESSOR");
// LBGT
bytes32 constant ROLE_MINTER = keccak256("ROLE_MINTER");
bytes32 constant ROLE_BURNER = keccak256("ROLE_BURNER");
bytes32 constant ROLE_FLASH_MINTER = keccak256("ROLE_FLASH_MINTER");
// stLBGT
bytes32 constant ROLE_COMPOUNDER = keccak256("ROLE_COMPOUNDER");
// POL Controller
bytes32 constant ROLE_REGISTER = keccak256("ROLE_REGISTER");
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* DEPLOYERS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
// Contract Deployers that have the desired contract address at zero nonce.
address constant INITIAL_GOD = 0x8362fAAb2711f757b8F52eCB746f6b6a69622B8F;
address constant BERAPAW_FORGE_DEPLOYER = 0xDb1ebdAc30988078c135d05a7ad206e0b2263CD3;
address constant LBGT_DEPLOYER = 0x5173ed2B85f72e27E9Df92FB78Ea016EB16E11f5;
address constant STAKED_LBGT_DEPLOYER = 0x4CaA8c73C86f1E2cec832aa2cf8377327E9f0909;
address constant GENERAL_DEPLOYER = 0x8362fAAb2711f757b8F52eCB746f6b6a69622B8F;
address constant TREASURY = 0xe105B981bC871c6591a666424FF2368097836469;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (access/IAccessControl.sol)
pragma solidity ^0.8.20;
/**
* @dev External interface of AccessControl declared to support ERC-165 detection.
*/
interface IAccessControl {
/**
* @dev The `account` is missing a role.
*/
error AccessControlUnauthorizedAccount(address account, bytes32 neededRole);
/**
* @dev The caller of a function is not the expected one.
*
* NOTE: Don't confuse with {AccessControlUnauthorizedAccount}.
*/
error AccessControlBadConfirmation();
/**
* @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.
*/
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. This account bears the admin role (for the granted role).
* Expected in cases where the role was granted using the internal {AccessControl-_grantRole}.
*/
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 `callerConfirmation`.
*/
function renounceRole(bytes32 role, address callerConfirmation) external;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
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;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/ERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import {Initializable} from "../../proxy/utils/Initializable.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC-165 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);
* }
* ```
*/
abstract contract ERC165Upgradeable is Initializable, IERC165 {
function __ERC165_init() internal onlyInitializing {
}
function __ERC165_init_unchained() internal onlyInitializing {
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/draft-IERC1822.sol)
pragma solidity ^0.8.20;
/**
* @dev ERC-1822: Universal Upgradeable Proxy Standard (UUPS) documents a method for upgradeability through a simplified
* proxy whose upgrades are fully controlled by the current implementation.
*/
interface IERC1822Proxiable {
/**
* @dev Returns the storage slot that the proxiable contract assumes is being used to store the implementation
* address.
*
* IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks
* bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this
* function revert if invoked through a proxy.
*/
function proxiableUUID() external view returns (bytes32);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (proxy/ERC1967/ERC1967Utils.sol)
pragma solidity ^0.8.21;
import {IBeacon} from "../beacon/IBeacon.sol";
import {IERC1967} from "../../interfaces/IERC1967.sol";
import {Address} from "../../utils/Address.sol";
import {StorageSlot} from "../../utils/StorageSlot.sol";
/**
* @dev This library provides getters and event emitting update functions for
* https://eips.ethereum.org/EIPS/eip-1967[ERC-1967] slots.
*/
library ERC1967Utils {
/**
* @dev Storage slot with the address of the current implementation.
* This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1.
*/
// solhint-disable-next-line private-vars-leading-underscore
bytes32 internal constant IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
/**
* @dev The `implementation` of the proxy is invalid.
*/
error ERC1967InvalidImplementation(address implementation);
/**
* @dev The `admin` of the proxy is invalid.
*/
error ERC1967InvalidAdmin(address admin);
/**
* @dev The `beacon` of the proxy is invalid.
*/
error ERC1967InvalidBeacon(address beacon);
/**
* @dev An upgrade function sees `msg.value > 0` that may be lost.
*/
error ERC1967NonPayable();
/**
* @dev Returns the current implementation address.
*/
function getImplementation() internal view returns (address) {
return StorageSlot.getAddressSlot(IMPLEMENTATION_SLOT).value;
}
/**
* @dev Stores a new address in the ERC-1967 implementation slot.
*/
function _setImplementation(address newImplementation) private {
if (newImplementation.code.length == 0) {
revert ERC1967InvalidImplementation(newImplementation);
}
StorageSlot.getAddressSlot(IMPLEMENTATION_SLOT).value = newImplementation;
}
/**
* @dev Performs implementation upgrade with additional setup call if data is nonempty.
* This function is payable only if the setup call is performed, otherwise `msg.value` is rejected
* to avoid stuck value in the contract.
*
* Emits an {IERC1967-Upgraded} event.
*/
function upgradeToAndCall(address newImplementation, bytes memory data) internal {
_setImplementation(newImplementation);
emit IERC1967.Upgraded(newImplementation);
if (data.length > 0) {
Address.functionDelegateCall(newImplementation, data);
} else {
_checkNonPayable();
}
}
/**
* @dev Storage slot with the admin of the contract.
* This is the keccak-256 hash of "eip1967.proxy.admin" subtracted by 1.
*/
// solhint-disable-next-line private-vars-leading-underscore
bytes32 internal constant ADMIN_SLOT = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103;
/**
* @dev Returns the current admin.
*
* TIP: To get this value clients can read directly from the storage slot shown below (specified by ERC-1967) using
* the https://eth.wiki/json-rpc/API#eth_getstorageat[`eth_getStorageAt`] RPC call.
* `0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103`
*/
function getAdmin() internal view returns (address) {
return StorageSlot.getAddressSlot(ADMIN_SLOT).value;
}
/**
* @dev Stores a new address in the ERC-1967 admin slot.
*/
function _setAdmin(address newAdmin) private {
if (newAdmin == address(0)) {
revert ERC1967InvalidAdmin(address(0));
}
StorageSlot.getAddressSlot(ADMIN_SLOT).value = newAdmin;
}
/**
* @dev Changes the admin of the proxy.
*
* Emits an {IERC1967-AdminChanged} event.
*/
function changeAdmin(address newAdmin) internal {
emit IERC1967.AdminChanged(getAdmin(), newAdmin);
_setAdmin(newAdmin);
}
/**
* @dev The storage slot of the UpgradeableBeacon contract which defines the implementation for this proxy.
* This is the keccak-256 hash of "eip1967.proxy.beacon" subtracted by 1.
*/
// solhint-disable-next-line private-vars-leading-underscore
bytes32 internal constant BEACON_SLOT = 0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50;
/**
* @dev Returns the current beacon.
*/
function getBeacon() internal view returns (address) {
return StorageSlot.getAddressSlot(BEACON_SLOT).value;
}
/**
* @dev Stores a new beacon in the ERC-1967 beacon slot.
*/
function _setBeacon(address newBeacon) private {
if (newBeacon.code.length == 0) {
revert ERC1967InvalidBeacon(newBeacon);
}
StorageSlot.getAddressSlot(BEACON_SLOT).value = newBeacon;
address beaconImplementation = IBeacon(newBeacon).implementation();
if (beaconImplementation.code.length == 0) {
revert ERC1967InvalidImplementation(beaconImplementation);
}
}
/**
* @dev Change the beacon and trigger a setup call if data is nonempty.
* This function is payable only if the setup call is performed, otherwise `msg.value` is rejected
* to avoid stuck value in the contract.
*
* Emits an {IERC1967-BeaconUpgraded} event.
*
* CAUTION: Invoking this function has no effect on an instance of {BeaconProxy} since v5, since
* it uses an immutable beacon without looking at the value of the ERC-1967 beacon slot for
* efficiency.
*/
function upgradeBeaconToAndCall(address newBeacon, bytes memory data) internal {
_setBeacon(newBeacon);
emit IERC1967.BeaconUpgraded(newBeacon);
if (data.length > 0) {
Address.functionDelegateCall(IBeacon(newBeacon).implementation(), data);
} else {
_checkNonPayable();
}
}
/**
* @dev Reverts if `msg.value` is not zero. It can be used to avoid `msg.value` stuck in the contract
* if an upgrade doesn't perform an initialization call.
*/
function _checkNonPayable() private {
if (msg.value > 0) {
revert ERC1967NonPayable();
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/IERC1363.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC165} from "./IERC165.sol";
/**
* @title IERC1363
* @dev Interface of the ERC-1363 standard as defined in the https://eips.ethereum.org/EIPS/eip-1363[ERC-1363].
*
* Defines an extension interface for ERC-20 tokens that supports executing code on a recipient contract
* after `transfer` or `transferFrom`, or code on a spender contract after `approve`, in a single transaction.
*/
interface IERC1363 is IERC20, IERC165 {
/*
* Note: the ERC-165 identifier for this interface is 0xb0202a11.
* 0xb0202a11 ===
* bytes4(keccak256('transferAndCall(address,uint256)')) ^
* bytes4(keccak256('transferAndCall(address,uint256,bytes)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256,bytes)')) ^
* bytes4(keccak256('approveAndCall(address,uint256)')) ^
* bytes4(keccak256('approveAndCall(address,uint256,bytes)'))
*/
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @param data Additional data with no specified format, sent in call to `spender`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value, bytes calldata data) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Address.sol)
pragma solidity ^0.8.20;
import {Errors} from "./Errors.sol";
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev There's no code at `target` (it is not a contract).
*/
error AddressEmptyCode(address target);
/**
* @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.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
if (address(this).balance < amount) {
revert Errors.InsufficientBalance(address(this).balance, amount);
}
(bool success, ) = recipient.call{value: amount}("");
if (!success) {
revert Errors.FailedCall();
}
}
/**
* @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 or custom error, it is bubbled
* up by this function (like regular Solidity function calls). However, if
* the call reverted with no returned reason, this function reverts with a
* {Errors.FailedCall} error.
*
* 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.
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0);
}
/**
* @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`.
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
if (address(this).balance < value) {
revert Errors.InsufficientBalance(address(this).balance, value);
}
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target
* was not a contract or bubbling up the revert reason (falling back to {Errors.FailedCall}) in case
* of an unsuccessful call.
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata
) internal view returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
// only check if target is a contract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
if (returndata.length == 0 && target.code.length == 0) {
revert AddressEmptyCode(target);
}
return returndata;
}
}
/**
* @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the
* revert reason or with a default {Errors.FailedCall} error.
*/
function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
return returndata;
}
}
/**
* @dev Reverts with returndata if present. Otherwise reverts with {Errors.FailedCall}.
*/
function _revert(bytes memory returndata) 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
assembly ("memory-safe") {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert Errors.FailedCall();
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Panic.sol)
pragma solidity ^0.8.20;
/**
* @dev Helper library for emitting standardized panic codes.
*
* ```solidity
* contract Example {
* using Panic for uint256;
*
* // Use any of the declared internal constants
* function foo() { Panic.GENERIC.panic(); }
*
* // Alternatively
* function foo() { Panic.panic(Panic.GENERIC); }
* }
* ```
*
* Follows the list from https://github.com/ethereum/solidity/blob/v0.8.24/libsolutil/ErrorCodes.h[libsolutil].
*
* _Available since v5.1._
*/
// slither-disable-next-line unused-state
library Panic {
/// @dev generic / unspecified error
uint256 internal constant GENERIC = 0x00;
/// @dev used by the assert() builtin
uint256 internal constant ASSERT = 0x01;
/// @dev arithmetic underflow or overflow
uint256 internal constant UNDER_OVERFLOW = 0x11;
/// @dev division or modulo by zero
uint256 internal constant DIVISION_BY_ZERO = 0x12;
/// @dev enum conversion error
uint256 internal constant ENUM_CONVERSION_ERROR = 0x21;
/// @dev invalid encoding in storage
uint256 internal constant STORAGE_ENCODING_ERROR = 0x22;
/// @dev empty array pop
uint256 internal constant EMPTY_ARRAY_POP = 0x31;
/// @dev array out of bounds access
uint256 internal constant ARRAY_OUT_OF_BOUNDS = 0x32;
/// @dev resource error (too large allocation or too large array)
uint256 internal constant RESOURCE_ERROR = 0x41;
/// @dev calling invalid internal function
uint256 internal constant INVALID_INTERNAL_FUNCTION = 0x51;
/// @dev Reverts with a panic code. Recommended to use with
/// the internal constants with predefined codes.
function panic(uint256 code) internal pure {
assembly ("memory-safe") {
mstore(0x00, 0x4e487b71)
mstore(0x20, code)
revert(0x1c, 0x24)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC-20 standard.
*/
interface IERC20Metadata is IERC20 {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (governance/utils/IVotes.sol)
pragma solidity ^0.8.20;
/**
* @dev Common interface for {ERC20Votes}, {ERC721Votes}, and other {Votes}-enabled contracts.
*/
interface IVotes {
/**
* @dev The signature used has expired.
*/
error VotesExpiredSignature(uint256 expiry);
/**
* @dev Emitted when an account changes their delegate.
*/
event DelegateChanged(address indexed delegator, address indexed fromDelegate, address indexed toDelegate);
/**
* @dev Emitted when a token transfer or delegate change results in changes to a delegate's number of voting units.
*/
event DelegateVotesChanged(address indexed delegate, uint256 previousVotes, uint256 newVotes);
/**
* @dev Returns the current amount of votes that `account` has.
*/
function getVotes(address account) external view returns (uint256);
/**
* @dev Returns the amount of votes that `account` had at a specific moment in the past. If the `clock()` is
* configured to use block numbers, this will return the value at the end of the corresponding block.
*/
function getPastVotes(address account, uint256 timepoint) external view returns (uint256);
/**
* @dev Returns the total supply of votes available at a specific moment in the past. If the `clock()` is
* configured to use block numbers, this will return the value at the end of the corresponding block.
*
* NOTE: This value is the sum of all available votes, which is not necessarily the sum of all delegated votes.
* Votes that have not been delegated are still part of total supply, even though they would not participate in a
* vote.
*/
function getPastTotalSupply(uint256 timepoint) external view returns (uint256);
/**
* @dev Returns the delegate that `account` has chosen.
*/
function delegates(address account) external view returns (address);
/**
* @dev Delegates votes from the sender to `delegatee`.
*/
function delegate(address delegatee) external;
/**
* @dev Delegates votes from signer to `delegatee`.
*/
function delegateBySig(address delegatee, uint256 nonce, uint256 expiry, uint8 v, bytes32 r, bytes32 s) external;
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.26;
import { IStakingRewardsErrors } from "../../base/IStakingRewardsErrors.sol";
/// @notice Interface of POL errors
interface IPOLErrors is IStakingRewardsErrors {
// Signature: 0xf2d81d95
error NotApprovedSender();
// Signature: 0x1db3b859
error NotDelegate();
// Signature: 0x53f0a596
error NotBGT();
// Signature: 0x1b0eb4ec
error NotBlockRewardController();
// Signature: 0x385296d5
error NotDistributor();
// Signature: 0x73fcd3fe
error NotFeeCollector();
// Signature: 0x36407850
error NotWhitelistedVault();
// Signature:0x7c214f04
error NotOperator();
// Signature: 0xad3a8b9e
error NotEnoughBalance();
// Signature: 0xadd377f6
error InvalidActivateBoostDelay();
// Signature: 0x2f14f4f9
error InvalidDropBoostDelay();
// Signature: 0x14969061
error NotEnoughBoostedBalance();
// Signature: 0xe8966d7a
error NotEnoughTime();
// Signature: 0xec2caa0d
error InvalidStartBlock();
// Signature: 0x3be31f8c
error RewardAllocationAlreadyQueued();
// Signature: 0x13134d24
error InvalidRewardAllocationWeights();
// Signature: 0xf6fae721
error TooManyWeights();
// Signature: 0x3e38573f
error InvalidateDefaultRewardAllocation();
// Signature: 0xd92e233d
error ZeroAddress();
// Signature: 0x462a2bb2
error RewardAllocationBlockDelayTooLarge();
// Signature: 0x08519afa
error NotFactoryVault();
// Signature: 0x978dc040
error ZeroPercentageWeight();
/* BLOCK REWARD CONTROLLLER */
// Signature: 0x2e2dab43
error InvalidBaseRate();
// Signature: 0x22be2284
error InvalidRewardRate();
// Signature: 0x15482337
error InvalidMinBoostedRewardRate();
// Signature: 0xb7b2319a
error InvalidBoostMultiplier();
// Signature: 0x347f95b2
error InvalidRewardConvexity();
/* STAKING */
// Signature: 0x09ee12d5
error NotAContract();
// Signature: 0xe4ea100b
error CannotRecoverRewardToken();
// Signature: 0x1b813803
error CannotRecoverStakingToken();
// Signature: 0x2899103f
error CannotRecoverIncentiveToken();
// Signature: 0x38432c89
error IncentiveRateTooHigh();
// Signature: 0x5ee4de0e
error NotIncentiveManager();
// Signature: 0xf84835a0
error TokenNotWhitelisted();
// Signature: 0x8d1473a6
error InsufficientDelegateStake();
// Signature: 0x08e88f46
error InsufficientSelfStake();
// Signature: 0xfbf97e07
error TokenAlreadyWhitelistedOrLimitReached();
// Signature: 0xad57d95d
error AmountLessThanMinIncentiveRate();
// Signature: 0xfbf1123c
error InvalidMaxIncentiveTokensCount();
// Signature: 0x546c7600
error PayoutAmountIsZero();
// Signature: 0x89c622a2
error DonateAmountLessThanPayoutAmount();
// Signature: 0xa4cc22ed
error MaxNumWeightsPerRewardAllocationIsZero();
// Signature: 0x0b5c3aff
error MinIncentiveRateIsZero();
// Signature: 0x8e7572da
error InvariantCheckFailed();
/* BEACON ROOTS */
// Signature: 0x1390f2a1
error IndexOutOfRange();
// Signature: 0x09bde339
error InvalidProof();
// Signature: 0x0a431b2a
error TimestampAlreadyProcessed();
/* BEACON DEPOSIT */
/// @dev Error thrown when the deposit amount is too small, to prevent dust deposits.
// Signature: 0x0e1eddda
error InsufficientDeposit();
/// @dev Error thrown when the deposit amount is not a multiple of Gwei.
// Signature: 0x40567b38
error DepositNotMultipleOfGwei();
/// @dev Error thrown when the deposit amount is too high, since it is a uint64.
// Signature: 0x2aa66734
error DepositValueTooHigh();
/// @dev Error thrown when the public key length is not 48 bytes.
// Signature: 0x9f106472
error InvalidPubKeyLength();
/// @dev Error thrown when the withdrawal credentials length is not 32 bytes.
// Signature: 0xb39bca16
error InvalidCredentialsLength();
/// @dev Error thrown when the signature length is not 96 bytes.
// Signature: 0x4be6321b
error InvalidSignatureLength();
/// @dev Error thrown when the input operator is zero address on the first deposit.
// Signature: 0x51969a7a
error ZeroOperatorOnFirstDeposit();
/// @dev Error thrown when the operator is already set and caller passed non-zero operator.
// Signature: 0xc4142b41
error OperatorAlreadySet();
/// @dev Error thrown when the caller is not the current operator.
// Signature: 0x819a0d0b
error NotNewOperator();
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.26;
import { IStakingRewardsErrors } from "./IStakingRewardsErrors.sol";
/// @notice Interface of staking rewards
interface IStakingRewards is IStakingRewardsErrors {
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* EVENTS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @notice Emitted when a reward has been added to the vault.
/// @param reward The amount of reward added, scaled by PRECISION.
event RewardAdded(uint256 reward);
/// @notice Emitted when the staking balance of an account has increased.
/// @param account The account that has staked.
/// @param amount The amount of staked tokens.
event Staked(address indexed account, uint256 amount);
/// @notice Emitted when the staking balance of an account has decreased.
/// @param account The account that has withdrawn.
/// @param amount The amount of withdrawn tokens.
event Withdrawn(address indexed account, uint256 amount);
/// @notice Emitted when a reward has been claimed.
/// @param account The account whose reward has been claimed.
/// @param to The address that the reward was sent to. (user or operator).
/// @param reward The amount of reward claimed.
event RewardPaid(address indexed account, address to, uint256 reward);
/// @notice Emitted when the reward duration has been updated.
/// @param newDuration The new duration of the reward.
event RewardsDurationUpdated(uint256 newDuration);
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* GETTERS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/// @notice Get the balance of the staked tokens for an account.
/// @param account The account to get the balance for.
/// @return The balance of the staked tokens.
function balanceOf(address account) external view returns (uint256);
/// @notice Get the reward balance for a specific account.
/// @param account The account to retrieve the reward balance for.
/// @return The current reward balance of the specified account.
function rewards(address account) external view returns (uint256);
/// @notice Get the user reward per token paid.
/// @param account The account to retrieve the reward for.
/// @return The current reward balance of the specified account.
function userRewardPerTokenPaid(address account) external view returns (uint256);
/// @notice Retrieves the amount of reward earned by a specific account.
/// @param account The account to calculate the reward for.
/// @return The amount of reward earned by the account.
function earned(address account) external view returns (uint256);
/// @notice Retrieves the total reward vested over the specified duration.
/// @return The total reward vested over the duration.
function getRewardForDuration() external view returns (uint256);
/// @notice Returns the timestamp of the last reward distribution. This is either the current timestamp (if rewards
/// are still being actively distributed) or the timestamp when the reward duration ended (if all rewards have
/// already been distributed).
/// @return The timestamp of the last reward distribution.
function lastTimeRewardApplicable() external view returns (uint256);
/// @notice Retrieves the current value of the global reward per token accumulator. This value is the sum of the
/// last checkpoint value and the accumulated value since the last checkpoint. It should increase monotonically
/// over time as more rewards are distributed.
/// @return The current value of the global reward per token accumulator scaled by 1e18.
function rewardPerToken() external view returns (uint256);
/// @notice Get the total supply of the staked tokens in the vault.
/// @return The total supply of the staked tokens in the vault.
function totalSupply() external view returns (uint256);
/// @notice Get the end of the current reward period.
/// @return The end of the current reward period.
function periodFinish() external view returns (uint256);
/// @notice Get the reward rate for the current reward period.
/// @return The reward rate.
function rewardRate() external view returns (uint256);
/// @notice Get the time over which the rewards will be distributed.
/// @return The duration of the rewards cycle.
function rewardsDuration() external view returns (uint256);
/// @notice Get the last time the rewards were updated.
/// @return The last time the rewards were updated.
function lastUpdateTime() external view returns (uint256);
/// @notice Get the amount of undistributed rewards.
/// @return The amount of undistributed rewards.
function undistributedRewards() external view returns (uint256);
/// @notice Get the last updated reward per token scaled.
/// @return The last updated reward per token.
function rewardPerTokenStored() external view returns (uint256);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC20Metadata} from "./extensions/IERC20Metadata.sol";
import {Context} from "../../utils/Context.sol";
import {IERC20Errors} from "../../interfaces/draft-IERC6093.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
*
* TIP: For a detailed writeup see our guide
* https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* The default value of {decimals} is 18. To change this, you should override
* this function so it returns a different value.
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC-20
* applications.
*/
abstract contract ERC20 is Context, IERC20, IERC20Metadata, IERC20Errors {
mapping(address account => uint256) private _balances;
mapping(address account => mapping(address spender => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* All two of these values are immutable: they can only be set once during
* construction.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual returns (string memory) {
return _symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5.05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the default value returned by this function, unless
* it's overridden.
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual returns (uint8) {
return 18;
}
/**
* @dev See {IERC20-totalSupply}.
*/
function totalSupply() public view virtual returns (uint256) {
return _totalSupply;
}
/**
* @dev See {IERC20-balanceOf}.
*/
function balanceOf(address account) public view virtual returns (uint256) {
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `value`.
*/
function transfer(address to, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_transfer(owner, to, value);
return true;
}
/**
* @dev See {IERC20-allowance}.
*/
function allowance(address owner, address spender) public view virtual returns (uint256) {
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `value` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_approve(owner, spender, value);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Skips emitting an {Approval} event indicating an allowance update. This is not
* required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve].
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `value`.
* - the caller must have allowance for ``from``'s tokens of at least
* `value`.
*/
function transferFrom(address from, address to, uint256 value) public virtual returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, value);
_transfer(from, to, value);
return true;
}
/**
* @dev Moves a `value` amount of tokens from `from` to `to`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _transfer(address from, address to, uint256 value) internal {
if (from == address(0)) {
revert ERC20InvalidSender(address(0));
}
if (to == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(from, to, value);
}
/**
* @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from`
* (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding
* this function.
*
* Emits a {Transfer} event.
*/
function _update(address from, address to, uint256 value) internal virtual {
if (from == address(0)) {
// Overflow check required: The rest of the code assumes that totalSupply never overflows
_totalSupply += value;
} else {
uint256 fromBalance = _balances[from];
if (fromBalance < value) {
revert ERC20InsufficientBalance(from, fromBalance, value);
}
unchecked {
// Overflow not possible: value <= fromBalance <= totalSupply.
_balances[from] = fromBalance - value;
}
}
if (to == address(0)) {
unchecked {
// Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply.
_totalSupply -= value;
}
} else {
unchecked {
// Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256.
_balances[to] += value;
}
}
emit Transfer(from, to, value);
}
/**
* @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0).
* Relies on the `_update` mechanism
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _mint(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(address(0), account, value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, lowering the total supply.
* Relies on the `_update` mechanism.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead
*/
function _burn(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidSender(address(0));
}
_update(account, address(0), value);
}
/**
* @dev Sets `value` as the allowance of `spender` over the `owner` s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*
* Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
*/
function _approve(address owner, address spender, uint256 value) internal {
_approve(owner, spender, value, true);
}
/**
* @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event.
*
* By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by
* `_spendAllowance` during the `transferFrom` operation set the flag to false. This saves gas by not emitting any
* `Approval` event during `transferFrom` operations.
*
* Anyone who wishes to continue emitting `Approval` events on the`transferFrom` operation can force the flag to
* true using the following override:
*
* ```solidity
* function _approve(address owner, address spender, uint256 value, bool) internal virtual override {
* super._approve(owner, spender, value, true);
* }
* ```
*
* Requirements are the same as {_approve}.
*/
function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual {
if (owner == address(0)) {
revert ERC20InvalidApprover(address(0));
}
if (spender == address(0)) {
revert ERC20InvalidSpender(address(0));
}
_allowances[owner][spender] = value;
if (emitEvent) {
emit Approval(owner, spender, value);
}
}
/**
* @dev Updates `owner` s allowance for `spender` based on spent `value`.
*
* Does not update the allowance value in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Does not emit an {Approval} event.
*/
function _spendAllowance(address owner, address spender, uint256 value) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance != type(uint256).max) {
if (currentAllowance < value) {
revert ERC20InsufficientAllowance(spender, currentAllowance, value);
}
unchecked {
_approve(owner, spender, currentAllowance - value, false);
}
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/extensions/ERC20Permit.sol)
pragma solidity ^0.8.20;
import {IERC20Permit} from "./IERC20Permit.sol";
import {ERC20} from "../ERC20.sol";
import {ECDSA} from "../../../utils/cryptography/ECDSA.sol";
import {EIP712} from "../../../utils/cryptography/EIP712.sol";
import {Nonces} from "../../../utils/Nonces.sol";
/**
* @dev Implementation of the ERC-20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[ERC-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC-20 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.
*/
abstract contract ERC20Permit is ERC20, IERC20Permit, EIP712, Nonces {
bytes32 private constant PERMIT_TYPEHASH =
keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)");
/**
* @dev Permit deadline has expired.
*/
error ERC2612ExpiredSignature(uint256 deadline);
/**
* @dev Mismatched signature.
*/
error ERC2612InvalidSigner(address signer, address owner);
/**
* @dev Initializes the {EIP712} domain separator using the `name` parameter, and setting `version` to `"1"`.
*
* It's a good idea to use the same `name` that is defined as the ERC-20 token name.
*/
constructor(string memory name) EIP712(name, "1") {}
/**
* @inheritdoc IERC20Permit
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) public virtual {
if (block.timestamp > deadline) {
revert ERC2612ExpiredSignature(deadline);
}
bytes32 structHash = keccak256(abi.encode(PERMIT_TYPEHASH, owner, spender, value, _useNonce(owner), deadline));
bytes32 hash = _hashTypedDataV4(structHash);
address signer = ECDSA.recover(hash, v, r, s);
if (signer != owner) {
revert ERC2612InvalidSigner(signer, owner);
}
_approve(owner, spender, value);
}
/**
* @inheritdoc IERC20Permit
*/
function nonces(address owner) public view virtual override(IERC20Permit, Nonces) returns (uint256) {
return super.nonces(owner);
}
/**
* @inheritdoc IERC20Permit
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view virtual returns (bytes32) {
return _domainSeparatorV4();
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/extensions/ERC20FlashMint.sol)
pragma solidity ^0.8.20;
import {IERC3156FlashBorrower} from "../../../interfaces/IERC3156FlashBorrower.sol";
import {IERC3156FlashLender} from "../../../interfaces/IERC3156FlashLender.sol";
import {ERC20} from "../ERC20.sol";
/**
* @dev Implementation of the ERC-3156 Flash loans extension, as defined in
* https://eips.ethereum.org/EIPS/eip-3156[ERC-3156].
*
* Adds the {flashLoan} method, which provides flash loan support at the token
* level. By default there is no fee, but this can be changed by overriding {flashFee}.
*
* NOTE: When this extension is used along with the {ERC20Capped} or {ERC20Votes} extensions,
* {maxFlashLoan} will not correctly reflect the maximum that can be flash minted. We recommend
* overriding {maxFlashLoan} so that it correctly reflects the supply cap.
*/
abstract contract ERC20FlashMint is ERC20, IERC3156FlashLender {
bytes32 private constant RETURN_VALUE = keccak256("ERC3156FlashBorrower.onFlashLoan");
/**
* @dev The loan token is not valid.
*/
error ERC3156UnsupportedToken(address token);
/**
* @dev The requested loan exceeds the max loan value for `token`.
*/
error ERC3156ExceededMaxLoan(uint256 maxLoan);
/**
* @dev The receiver of a flashloan is not a valid {IERC3156FlashBorrower-onFlashLoan} implementer.
*/
error ERC3156InvalidReceiver(address receiver);
/**
* @dev Returns the maximum amount of tokens available for loan.
* @param token The address of the token that is requested.
* @return The amount of token that can be loaned.
*
* NOTE: This function does not consider any form of supply cap, so in case
* it's used in a token with a cap like {ERC20Capped}, make sure to override this
* function to integrate the cap instead of `type(uint256).max`.
*/
function maxFlashLoan(address token) public view virtual returns (uint256) {
return token == address(this) ? type(uint256).max - totalSupply() : 0;
}
/**
* @dev Returns the fee applied when doing flash loans. This function calls
* the {_flashFee} function which returns the fee applied when doing flash
* loans.
* @param token The token to be flash loaned.
* @param value The amount of tokens to be loaned.
* @return The fees applied to the corresponding flash loan.
*/
function flashFee(address token, uint256 value) public view virtual returns (uint256) {
if (token != address(this)) {
revert ERC3156UnsupportedToken(token);
}
return _flashFee(token, value);
}
/**
* @dev Returns the fee applied when doing flash loans. By default this
* implementation has 0 fees. This function can be overloaded to make
* the flash loan mechanism deflationary.
* @param token The token to be flash loaned.
* @param value The amount of tokens to be loaned.
* @return The fees applied to the corresponding flash loan.
*/
function _flashFee(address token, uint256 value) internal view virtual returns (uint256) {
// silence warning about unused variable without the addition of bytecode.
token;
value;
return 0;
}
/**
* @dev Returns the receiver address of the flash fee. By default this
* implementation returns the address(0) which means the fee amount will be burnt.
* This function can be overloaded to change the fee receiver.
* @return The address for which the flash fee will be sent to.
*/
function _flashFeeReceiver() internal view virtual returns (address) {
return address(0);
}
/**
* @dev Performs a flash loan. New tokens are minted and sent to the
* `receiver`, who is required to implement the {IERC3156FlashBorrower}
* interface. By the end of the flash loan, the receiver is expected to own
* value + fee tokens and have them approved back to the token contract itself so
* they can be burned.
* @param receiver The receiver of the flash loan. Should implement the
* {IERC3156FlashBorrower-onFlashLoan} interface.
* @param token The token to be flash loaned. Only `address(this)` is
* supported.
* @param value The amount of tokens to be loaned.
* @param data An arbitrary datafield that is passed to the receiver.
* @return `true` if the flash loan was successful.
*/
// This function can reenter, but it doesn't pose a risk because it always preserves the property that the amount
// minted at the beginning is always recovered and burned at the end, or else the entire function will revert.
// slither-disable-next-line reentrancy-no-eth
function flashLoan(
IERC3156FlashBorrower receiver,
address token,
uint256 value,
bytes calldata data
) public virtual returns (bool) {
uint256 maxLoan = maxFlashLoan(token);
if (value > maxLoan) {
revert ERC3156ExceededMaxLoan(maxLoan);
}
uint256 fee = flashFee(token, value);
_mint(address(receiver), value);
if (receiver.onFlashLoan(_msgSender(), token, value, fee, data) != RETURN_VALUE) {
revert ERC3156InvalidReceiver(address(receiver));
}
address flashFeeReceiver = _flashFeeReceiver();
_spendAllowance(address(receiver), address(this), value + fee);
if (fee == 0 || flashFeeReceiver == address(0)) {
_burn(address(receiver), value + fee);
} else {
_burn(address(receiver), value);
_transfer(address(receiver), flashFeeReceiver, fee);
}
return true;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/extensions/ERC20Wrapper.sol)
pragma solidity ^0.8.20;
import {IERC20, IERC20Metadata, ERC20} from "../ERC20.sol";
import {SafeERC20} from "../utils/SafeERC20.sol";
/**
* @dev Extension of the ERC-20 token contract to support token wrapping.
*
* Users can deposit and withdraw "underlying tokens" and receive a matching number of "wrapped tokens". This is useful
* in conjunction with other modules. For example, combining this wrapping mechanism with {ERC20Votes} will allow the
* wrapping of an existing "basic" ERC-20 into a governance token.
*
* WARNING: Any mechanism in which the underlying token changes the {balanceOf} of an account without an explicit transfer
* may desynchronize this contract's supply and its underlying balance. Please exercise caution when wrapping tokens that
* may undercollateralize the wrapper (i.e. wrapper's total supply is higher than its underlying balance). See {_recover}
* for recovering value accrued to the wrapper.
*/
abstract contract ERC20Wrapper is ERC20 {
IERC20 private immutable _underlying;
/**
* @dev The underlying token couldn't be wrapped.
*/
error ERC20InvalidUnderlying(address token);
constructor(IERC20 underlyingToken) {
if (underlyingToken == this) {
revert ERC20InvalidUnderlying(address(this));
}
_underlying = underlyingToken;
}
/**
* @dev See {ERC20-decimals}.
*/
function decimals() public view virtual override returns (uint8) {
try IERC20Metadata(address(_underlying)).decimals() returns (uint8 value) {
return value;
} catch {
return super.decimals();
}
}
/**
* @dev Returns the address of the underlying ERC-20 token that is being wrapped.
*/
function underlying() public view returns (IERC20) {
return _underlying;
}
/**
* @dev Allow a user to deposit underlying tokens and mint the corresponding number of wrapped tokens.
*/
function depositFor(address account, uint256 value) public virtual returns (bool) {
address sender = _msgSender();
if (sender == address(this)) {
revert ERC20InvalidSender(address(this));
}
if (account == address(this)) {
revert ERC20InvalidReceiver(account);
}
SafeERC20.safeTransferFrom(_underlying, sender, address(this), value);
_mint(account, value);
return true;
}
/**
* @dev Allow a user to burn a number of wrapped tokens and withdraw the corresponding number of underlying tokens.
*/
function withdrawTo(address account, uint256 value) public virtual returns (bool) {
if (account == address(this)) {
revert ERC20InvalidReceiver(account);
}
_burn(_msgSender(), value);
SafeERC20.safeTransfer(_underlying, account, value);
return true;
}
/**
* @dev Mint wrapped token to cover any underlyingTokens that would have been transferred by mistake or acquired from
* rebasing mechanisms. Internal function that can be exposed with access control if desired.
*/
function _recover(address account) internal virtual returns (uint256) {
uint256 value = _underlying.balanceOf(address(this)) - totalSupply();
_mint(account, value);
return value;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/AccessControl.sol)
pragma solidity ^0.8.20;
import {IAccessControl} from "./IAccessControl.sol";
import {Context} from "../utils/Context.sol";
import {ERC165} from "../utils/introspection/ERC165.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 AccessControl is Context, IAccessControl, ERC165 {
struct RoleData {
mapping(address account => bool) hasRole;
bytes32 adminRole;
}
mapping(bytes32 role => RoleData) private _roles;
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
/**
* @dev Modifier that checks that an account has a specific role. Reverts
* with an {AccessControlUnauthorizedAccount} error including the required role.
*/
modifier onlyRole(bytes32 role) {
_checkRole(role);
_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IAccessControl).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) public view virtual returns (bool) {
return _roles[role].hasRole[account];
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `_msgSender()`
* is missing `role`. Overriding this function changes the behavior of the {onlyRole} modifier.
*/
function _checkRole(bytes32 role) internal view virtual {
_checkRole(role, _msgSender());
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `account`
* is missing `role`.
*/
function _checkRole(bytes32 role, address account) internal view virtual {
if (!hasRole(role, account)) {
revert AccessControlUnauthorizedAccount(account, role);
}
}
/**
* @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 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 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 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 `callerConfirmation`.
*
* May emit a {RoleRevoked} event.
*/
function renounceRole(bytes32 role, address callerConfirmation) public virtual {
if (callerConfirmation != _msgSender()) {
revert AccessControlBadConfirmation();
}
_revokeRole(role, callerConfirmation);
}
/**
* @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 Attempts to grant `role` to `account` and returns a boolean indicating if `role` was granted.
*
* Internal function without access restriction.
*
* May emit a {RoleGranted} event.
*/
function _grantRole(bytes32 role, address account) internal virtual returns (bool) {
if (!hasRole(role, account)) {
_roles[role].hasRole[account] = true;
emit RoleGranted(role, account, _msgSender());
return true;
} else {
return false;
}
}
/**
* @dev Attempts to revoke `role` to `account` and returns a boolean indicating if `role` was revoked.
*
* Internal function without access restriction.
*
* May emit a {RoleRevoked} event.
*/
function _revokeRole(bytes32 role, address account) internal virtual returns (bool) {
if (hasRole(role, account)) {
_roles[role].hasRole[account] = false;
emit RoleRevoked(role, account, _msgSender());
return true;
} else {
return false;
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/IERC3156FlashLender.sol)
pragma solidity ^0.8.20;
import {IERC3156FlashBorrower} from "./IERC3156FlashBorrower.sol";
/**
* @dev Interface of the ERC-3156 FlashLender, as defined in
* https://eips.ethereum.org/EIPS/eip-3156[ERC-3156].
*/
interface IERC3156FlashLender {
/**
* @dev The amount of currency available to be lended.
* @param token The loan currency.
* @return The amount of `token` that can be borrowed.
*/
function maxFlashLoan(address token) external view returns (uint256);
/**
* @dev The fee to be charged for a given loan.
* @param token The loan currency.
* @param amount The amount of tokens lent.
* @return The amount of `token` to be charged for the loan, on top of the returned principal.
*/
function flashFee(address token, uint256 amount) external view returns (uint256);
/**
* @dev Initiate a flash loan.
* @param receiver The receiver of the tokens in the loan, and the receiver of the callback.
* @param token The loan currency.
* @param amount The amount of tokens lent.
* @param data Arbitrary data structure, intended to contain user-defined parameters.
*/
function flashLoan(
IERC3156FlashBorrower receiver,
address token,
uint256 amount,
bytes calldata data
) external returns (bool);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import { IErrors } from "./IErrors.sol";
interface ILBGT is IErrors {
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* EVENTS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/**
* @dev Emitted when the flash mint fee is set.
* @param fee The new flash mint fee in basis points (bps).
*/
event FlashFeeSet(uint256 fee);
/**
* @dev Emitted when the flash mint max limit is set.
* @param amount The new flash mint max limit.
*/
event FlashMaxMintSet(uint256 amount);
/**
* @dev Emitted when the flash fee collector is set.
* @param feeCollector The new flash fee collector address.
*/
event FlashFeeCollectorSet(address feeCollector);
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* ADMIN FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/**
* @notice Set the flash mint fee in basis points (bps).
* @dev Only the admin can set the flash mint fee.
* @param _flashMintPercentualFee The flash mint fee in basis points (bps).
*/
function setFlashMintFee(uint16 _flashMintPercentualFee) external;
/**
* @notice Set the flash mint max limit.
* @dev Only the admin can set the flash mint max limit.
* @param _maxFlashMint The flash mint max limit.
*/
function setFlashMaxMint(uint256 _maxFlashMint) external;
/**
* @notice Set the flash fee collector address.
* @dev Only the admin can set the flash fee collector address.
* @param _feeCollector The address to set as the flash fee collector.
*/
function setFlashFeeCollector(address _feeCollector) external;
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* GETTERS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/**
* @notice Gets BeraPaw Forge contract address.
* @return Returns BeraPaw Forge contract address.
*/
function beraPawForge() external view returns (address);
/**
* @notice Get the current percentual fee for flash minting LBGT tokens
* @dev Fee is represented in basis points (1 = 0.01%), with a max of 10,000 (100%)
* @return The current flash mint fee percentage in basis points
*/
function flashMintPercentualFee() external view returns (uint16);
/**
* @notice Get the address that collects flash mint fees
* @dev Returns address(0) if no fee collector has been set
* @return The address where flash mint fees are sent
*/
function flashFeeCollector() external view returns (address);
/**
* @notice Get the maximum amount of LBGT that can be flash minted
* @dev Flash minters with ROLE_FLASH_MINTER bypass this limit
* @return The maximum amount of tokens that can be flash minted
*/
function flashMaxMint() external view returns (uint256);
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* BERAPAW FORGE FUNCTIONS */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/**
* @notice Mint new tokens to a given address.
* @dev Only the BeraPaw vault can mint tokens.
* @param to The address to mint tokens to.
* @param amount The amount of tokens to mint.
*/
function mint(address to, uint256 amount) external;
/**
* @notice Burn a given amount of tokens from a given address.
* @dev Only the BeraPaw vault can burn tokens.
* @param from The address to burn tokens from.
* @param amount The amount of tokens to burn.
*/
function burn(address from, uint256 amount) external;
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
/**
* @notice Standard errors for berapaw contracts
*/
interface IErrors {
error ZeroAddress();
error InvalidInput();
error ZeroAmount();
error PayoutAmountIsZero();
error InvalidFee(uint16 _fee);
error InsufficientBalance();
/**
* @dev Revert when the function is not called by the BeraPaw vault.
*/
error OnlyBeraPawForge();
error InsufficientRedeem();
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* BeraPaw Forge */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
error NotUser(address user);
error NotUserOrManager(address user, address rewardsVault);
error IncorrectBGTReward();
error RedeemNotAvailable(uint128 amount);
error AlreadyQueued();
error NotEnoughTimeHasPassed();
error NotPositionOwner();
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* StakedPaw */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
error BelowMinBoost();
error NotAuthorized();
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* Fee Distributor */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
/**
* @notice Thrown if the total of the fee recipients doesn't equal 100%.
* @dev This error is thrown when the total of the fee recipients doesn't equal 100%.
*/
error InvalidFeeRecipients();
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* Treasury */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
error InvalidRate();
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* PolController */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
error ValidatorAlreadyRegistered();
error ValidatorNotRegistered();
error WeightsDoNotAddToOneHundredPercent();
error AlreadyCalledThisEpoch();
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* StakedPaw */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
error ContractExpired();
error LockNotExpired();
error ZeroBias();
error NotDistributor();
error RewardPeriodNotFinished();
error LockExists();
error OnlyIncreaseLockLength();
error OnlyFutureLockEnd();
error ExceededMaxTime();
error LockExpired();
error NoLock();
error DelegateeHasNoLock();
error DelegateeLockExpired();
error SelfTransferNotAllowed();
error ReceiverHasSmallerLockEnd();
error LockDelegated();
error AlreadyDelegated();
error OnlyDelegateToLongerLock();
error AlreadyUndelegated();
error FutureLookUp();
error Disabled();
/*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
/* StakedPawRewards */
/*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
error NotStaker();
error NotFeeCollector();
error CannotRecoverRewardToken();
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/IERC165.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[ERC].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @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[ERC 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 v5.0.0) (proxy/beacon/IBeacon.sol)
pragma solidity ^0.8.20;
/**
* @dev This is the interface that {BeaconProxy} expects of its beacon.
*/
interface IBeacon {
/**
* @dev Must return an address that can be used as a delegate call target.
*
* {UpgradeableBeacon} will check that this address is a contract.
*/
function implementation() external view returns (address);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC1967.sol)
pragma solidity ^0.8.20;
/**
* @dev ERC-1967: Proxy Storage Slots. This interface contains the events defined in the ERC.
*/
interface IERC1967 {
/**
* @dev Emitted when the implementation is upgraded.
*/
event Upgraded(address indexed implementation);
/**
* @dev Emitted when the admin account has changed.
*/
event AdminChanged(address previousAdmin, address newAdmin);
/**
* @dev Emitted when the beacon is changed.
*/
event BeaconUpgraded(address indexed beacon);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.
pragma solidity ^0.8.20;
/**
* @dev Library for reading and writing primitive types to specific storage slots.
*
* Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.
* This library helps with reading and writing to such slots without the need for inline assembly.
*
* The functions in this library return Slot structs that contain a `value` member that can be used to read or write.
*
* Example usage to set ERC-1967 implementation slot:
* ```solidity
* contract ERC1967 {
* // Define the slot. Alternatively, use the SlotDerivation library to derive the slot.
* bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
*
* function _getImplementation() internal view returns (address) {
* return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
* }
*
* function _setImplementation(address newImplementation) internal {
* require(newImplementation.code.length > 0);
* StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
* }
* }
* ```
*
* TIP: Consider using this library along with {SlotDerivation}.
*/
library StorageSlot {
struct AddressSlot {
address value;
}
struct BooleanSlot {
bool value;
}
struct Bytes32Slot {
bytes32 value;
}
struct Uint256Slot {
uint256 value;
}
struct Int256Slot {
int256 value;
}
struct StringSlot {
string value;
}
struct BytesSlot {
bytes value;
}
/**
* @dev Returns an `AddressSlot` with member `value` located at `slot`.
*/
function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `BooleanSlot` with member `value` located at `slot`.
*/
function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Bytes32Slot` with member `value` located at `slot`.
*/
function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Uint256Slot` with member `value` located at `slot`.
*/
function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Int256Slot` with member `value` located at `slot`.
*/
function getInt256Slot(bytes32 slot) internal pure returns (Int256Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `StringSlot` with member `value` located at `slot`.
*/
function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` representation of the string storage pointer `store`.
*/
function getStringSlot(string storage store) internal pure returns (StringSlot storage r) {
assembly ("memory-safe") {
r.slot := store.slot
}
}
/**
* @dev Returns a `BytesSlot` with member `value` located at `slot`.
*/
function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns an `BytesSlot` representation of the bytes storage pointer `store`.
*/
function getBytesSlot(bytes storage store) internal pure returns (BytesSlot storage r) {
assembly ("memory-safe") {
r.slot := store.slot
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../token/ERC20/IERC20.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../utils/introspection/IERC165.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Errors.sol)
pragma solidity ^0.8.20;
/**
* @dev Collection of common custom errors used in multiple contracts
*
* IMPORTANT: Backwards compatibility is not guaranteed in future versions of the library.
* It is recommended to avoid relying on the error API for critical functionality.
*
* _Available since v5.1._
*/
library Errors {
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/
error InsufficientBalance(uint256 balance, uint256 needed);
/**
* @dev A call to an address target failed. The target may have reverted.
*/
error FailedCall();
/**
* @dev The deployment failed.
*/
error FailedDeployment();
/**
* @dev A necessary precompile is missing.
*/
error MissingPrecompile(address);
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.26;
/// @notice Interface of staking rewards errors
interface IStakingRewardsErrors {
// Signature: 0xf4ba521f
error InsolventReward();
// Signature: 0xf1bc94d2
error InsufficientStake();
// Signature: 0x49835af0
error RewardCycleNotEnded();
// Signature: 0x5ce91fd0
error StakeAmountIsZero();
// Signature: 0xe5cfe957
error TotalSupplyOverflow();
// Signature: 0xa393d14b
error WithdrawAmountIsZero();
// Signature: 0x359f174d
error RewardsDurationIsZero();
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/draft-IERC6093.sol)
pragma solidity ^0.8.20;
/**
* @dev Standard ERC-20 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-20 tokens.
*/
interface IERC20Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC20InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC20InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
* @param spender Address that may be allowed to operate on tokens without being their owner.
* @param allowance Amount of tokens a `spender` is allowed to operate with.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC20InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `spender` to be approved. Used in approvals.
* @param spender Address that may be allowed to operate on tokens without being their owner.
*/
error ERC20InvalidSpender(address spender);
}
/**
* @dev Standard ERC-721 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-721 tokens.
*/
interface IERC721Errors {
/**
* @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in ERC-20.
* Used in balance queries.
* @param owner Address of the current owner of a token.
*/
error ERC721InvalidOwner(address owner);
/**
* @dev Indicates a `tokenId` whose `owner` is the zero address.
* @param tokenId Identifier number of a token.
*/
error ERC721NonexistentToken(uint256 tokenId);
/**
* @dev Indicates an error related to the ownership over a particular token. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param tokenId Identifier number of a token.
* @param owner Address of the current owner of a token.
*/
error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC721InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC721InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param tokenId Identifier number of a token.
*/
error ERC721InsufficientApproval(address operator, uint256 tokenId);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC721InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC721InvalidOperator(address operator);
}
/**
* @dev Standard ERC-1155 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-1155 tokens.
*/
interface IERC1155Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
* @param tokenId Identifier number of a token.
*/
error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC1155InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC1155InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param owner Address of the current owner of a token.
*/
error ERC1155MissingApprovalForAll(address operator, address owner);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC1155InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC1155InvalidOperator(address operator);
/**
* @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation.
* Used in batch transfers.
* @param idsLength Length of the array of token identifiers
* @param valuesLength Length of the array of token amounts
*/
error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[ERC-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC-20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*
* ==== Security Considerations
*
* There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
* expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
* considered as an intention to spend the allowance in any specific way. The second is that because permits have
* built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
* take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
* generally recommended is:
*
* ```solidity
* function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
* try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
* doThing(..., value);
* }
*
* function doThing(..., uint256 value) public {
* token.safeTransferFrom(msg.sender, address(this), value);
* ...
* }
* ```
*
* Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
* `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
* {SafeERC20-safeTransferFrom}).
*
* Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
* contracts should have entry points that don't rely on permit.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*
* CAUTION: See Security Considerations above.
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/cryptography/ECDSA.sol)
pragma solidity ^0.8.20;
/**
* @dev Elliptic Curve Digital Signature Algorithm (ECDSA) operations.
*
* These functions can be used to verify that a message was signed by the holder
* of the private keys of a given address.
*/
library ECDSA {
enum RecoverError {
NoError,
InvalidSignature,
InvalidSignatureLength,
InvalidSignatureS
}
/**
* @dev The signature derives the `address(0)`.
*/
error ECDSAInvalidSignature();
/**
* @dev The signature has an invalid length.
*/
error ECDSAInvalidSignatureLength(uint256 length);
/**
* @dev The signature has an S value that is in the upper half order.
*/
error ECDSAInvalidSignatureS(bytes32 s);
/**
* @dev Returns the address that signed a hashed message (`hash`) with `signature` or an error. This will not
* return address(0) without also returning an error description. Errors are documented using an enum (error type)
* and a bytes32 providing additional information about the error.
*
* If no error is returned, then the address can be used for verification purposes.
*
* The `ecrecover` EVM precompile allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {MessageHashUtils-toEthSignedMessageHash} on it.
*
* Documentation for signature generation:
* - with https://web3js.readthedocs.io/en/v1.3.4/web3-eth-accounts.html#sign[Web3.js]
* - with https://docs.ethers.io/v5/api/signer/#Signer-signMessage[ethers]
*/
function tryRecover(
bytes32 hash,
bytes memory signature
) internal pure returns (address recovered, RecoverError err, bytes32 errArg) {
if (signature.length == 65) {
bytes32 r;
bytes32 s;
uint8 v;
// ecrecover takes the signature parameters, and the only way to get them
// currently is to use assembly.
assembly ("memory-safe") {
r := mload(add(signature, 0x20))
s := mload(add(signature, 0x40))
v := byte(0, mload(add(signature, 0x60)))
}
return tryRecover(hash, v, r, s);
} else {
return (address(0), RecoverError.InvalidSignatureLength, bytes32(signature.length));
}
}
/**
* @dev Returns the address that signed a hashed message (`hash`) with
* `signature`. This address can then be used for verification purposes.
*
* The `ecrecover` EVM precompile allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {MessageHashUtils-toEthSignedMessageHash} on it.
*/
function recover(bytes32 hash, bytes memory signature) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, signature);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately.
*
* See https://eips.ethereum.org/EIPS/eip-2098[ERC-2098 short signatures]
*/
function tryRecover(
bytes32 hash,
bytes32 r,
bytes32 vs
) internal pure returns (address recovered, RecoverError err, bytes32 errArg) {
unchecked {
bytes32 s = vs & bytes32(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff);
// We do not check for an overflow here since the shift operation results in 0 or 1.
uint8 v = uint8((uint256(vs) >> 255) + 27);
return tryRecover(hash, v, r, s);
}
}
/**
* @dev Overload of {ECDSA-recover} that receives the `r and `vs` short-signature fields separately.
*/
function recover(bytes32 hash, bytes32 r, bytes32 vs) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, r, vs);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `v`,
* `r` and `s` signature fields separately.
*/
function tryRecover(
bytes32 hash,
uint8 v,
bytes32 r,
bytes32 s
) internal pure returns (address recovered, RecoverError err, bytes32 errArg) {
// EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature
// unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines
// the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. Most
// signatures from current libraries generate a unique signature with an s-value in the lower half order.
//
// If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value
// with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or
// vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept
// these malleable signatures as well.
if (uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) {
return (address(0), RecoverError.InvalidSignatureS, s);
}
// If the signature is valid (and not malleable), return the signer address
address signer = ecrecover(hash, v, r, s);
if (signer == address(0)) {
return (address(0), RecoverError.InvalidSignature, bytes32(0));
}
return (signer, RecoverError.NoError, bytes32(0));
}
/**
* @dev Overload of {ECDSA-recover} that receives the `v`,
* `r` and `s` signature fields separately.
*/
function recover(bytes32 hash, uint8 v, bytes32 r, bytes32 s) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, v, r, s);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Optionally reverts with the corresponding custom error according to the `error` argument provided.
*/
function _throwError(RecoverError error, bytes32 errorArg) private pure {
if (error == RecoverError.NoError) {
return; // no error: do nothing
} else if (error == RecoverError.InvalidSignature) {
revert ECDSAInvalidSignature();
} else if (error == RecoverError.InvalidSignatureLength) {
revert ECDSAInvalidSignatureLength(uint256(errorArg));
} else if (error == RecoverError.InvalidSignatureS) {
revert ECDSAInvalidSignatureS(errorArg);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/cryptography/EIP712.sol)
pragma solidity ^0.8.20;
import {MessageHashUtils} from "./MessageHashUtils.sol";
import {ShortStrings, ShortString} from "../ShortStrings.sol";
import {IERC5267} from "../../interfaces/IERC5267.sol";
/**
* @dev https://eips.ethereum.org/EIPS/eip-712[EIP-712] is a standard for hashing and signing of typed structured data.
*
* The encoding scheme specified in the EIP requires a domain separator and a hash of the typed structured data, whose
* encoding is very generic and therefore its implementation in Solidity is not feasible, thus this contract
* does not implement the encoding itself. Protocols need to implement the type-specific encoding they need in order to
* produce the hash of their typed data using a combination of `abi.encode` and `keccak256`.
*
* This contract implements the EIP-712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding
* scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA
* ({_hashTypedDataV4}).
*
* The implementation of the domain separator was designed to be as efficient as possible while still properly updating
* the chain id to protect against replay attacks on an eventual fork of the chain.
*
* NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method
* https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask].
*
* NOTE: In the upgradeable version of this contract, the cached values will correspond to the address, and the domain
* separator of the implementation contract. This will cause the {_domainSeparatorV4} function to always rebuild the
* separator from the immutable values, which is cheaper than accessing a cached version in cold storage.
*
* @custom:oz-upgrades-unsafe-allow state-variable-immutable
*/
abstract contract EIP712 is IERC5267 {
using ShortStrings for *;
bytes32 private constant TYPE_HASH =
keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");
// Cache the domain separator as an immutable value, but also store the chain id that it corresponds to, in order to
// invalidate the cached domain separator if the chain id changes.
bytes32 private immutable _cachedDomainSeparator;
uint256 private immutable _cachedChainId;
address private immutable _cachedThis;
bytes32 private immutable _hashedName;
bytes32 private immutable _hashedVersion;
ShortString private immutable _name;
ShortString private immutable _version;
string private _nameFallback;
string private _versionFallback;
/**
* @dev Initializes the domain separator and parameter caches.
*
* The meaning of `name` and `version` is specified in
* https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator[EIP-712]:
*
* - `name`: the user readable name of the signing domain, i.e. the name of the DApp or the protocol.
* - `version`: the current major version of the signing domain.
*
* NOTE: These parameters cannot be changed except through a xref:learn::upgrading-smart-contracts.adoc[smart
* contract upgrade].
*/
constructor(string memory name, string memory version) {
_name = name.toShortStringWithFallback(_nameFallback);
_version = version.toShortStringWithFallback(_versionFallback);
_hashedName = keccak256(bytes(name));
_hashedVersion = keccak256(bytes(version));
_cachedChainId = block.chainid;
_cachedDomainSeparator = _buildDomainSeparator();
_cachedThis = address(this);
}
/**
* @dev Returns the domain separator for the current chain.
*/
function _domainSeparatorV4() internal view returns (bytes32) {
if (address(this) == _cachedThis && block.chainid == _cachedChainId) {
return _cachedDomainSeparator;
} else {
return _buildDomainSeparator();
}
}
function _buildDomainSeparator() private view returns (bytes32) {
return keccak256(abi.encode(TYPE_HASH, _hashedName, _hashedVersion, block.chainid, address(this)));
}
/**
* @dev Given an already https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct[hashed struct], this
* function returns the hash of the fully encoded EIP712 message for this domain.
*
* This hash can be used together with {ECDSA-recover} to obtain the signer of a message. For example:
*
* ```solidity
* bytes32 digest = _hashTypedDataV4(keccak256(abi.encode(
* keccak256("Mail(address to,string contents)"),
* mailTo,
* keccak256(bytes(mailContents))
* )));
* address signer = ECDSA.recover(digest, signature);
* ```
*/
function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) {
return MessageHashUtils.toTypedDataHash(_domainSeparatorV4(), structHash);
}
/**
* @dev See {IERC-5267}.
*/
function eip712Domain()
public
view
virtual
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
)
{
return (
hex"0f", // 01111
_EIP712Name(),
_EIP712Version(),
block.chainid,
address(this),
bytes32(0),
new uint256[](0)
);
}
/**
* @dev The name parameter for the EIP712 domain.
*
* NOTE: By default this function reads _name which is an immutable value.
* It only reads from storage if necessary (in case the value is too large to fit in a ShortString).
*/
// solhint-disable-next-line func-name-mixedcase
function _EIP712Name() internal view returns (string memory) {
return _name.toStringWithFallback(_nameFallback);
}
/**
* @dev The version parameter for the EIP712 domain.
*
* NOTE: By default this function reads _version which is an immutable value.
* It only reads from storage if necessary (in case the value is too large to fit in a ShortString).
*/
// solhint-disable-next-line func-name-mixedcase
function _EIP712Version() internal view returns (string memory) {
return _version.toStringWithFallback(_versionFallback);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Nonces.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides tracking nonces for addresses. Nonces will only increment.
*/
abstract contract Nonces {
/**
* @dev The nonce used for an `account` is not the expected current nonce.
*/
error InvalidAccountNonce(address account, uint256 currentNonce);
mapping(address account => uint256) private _nonces;
/**
* @dev Returns the next unused nonce for an address.
*/
function nonces(address owner) public view virtual returns (uint256) {
return _nonces[owner];
}
/**
* @dev Consumes a nonce.
*
* Returns the current value and increments nonce.
*/
function _useNonce(address owner) internal virtual returns (uint256) {
// For each account, the nonce has an initial value of 0, can only be incremented by one, and cannot be
// decremented or reset. This guarantees that the nonce never overflows.
unchecked {
// It is important to do x++ and not ++x here.
return _nonces[owner]++;
}
}
/**
* @dev Same as {_useNonce} but checking that `nonce` is the next valid for `owner`.
*/
function _useCheckedNonce(address owner, uint256 nonce) internal virtual {
uint256 current = _useNonce(owner);
if (nonce != current) {
revert InvalidAccountNonce(owner, current);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/IERC3156FlashBorrower.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-3156 FlashBorrower, as defined in
* https://eips.ethereum.org/EIPS/eip-3156[ERC-3156].
*/
interface IERC3156FlashBorrower {
/**
* @dev Receive a flash loan.
* @param initiator The initiator of the loan.
* @param token The loan currency.
* @param amount The amount of tokens lent.
* @param fee The additional amount of tokens to repay.
* @param data Arbitrary data structure, intended to contain user-defined parameters.
* @return The keccak256 hash of "ERC3156FlashBorrower.onFlashLoan"
*/
function onFlashLoan(
address initiator,
address token,
uint256 amount,
uint256 fee,
bytes calldata data
) external returns (bytes32);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/ERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "./IERC165.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC-165 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);
* }
* ```
*/
abstract contract ERC165 is IERC165 {
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/cryptography/MessageHashUtils.sol)
pragma solidity ^0.8.20;
import {Strings} from "../Strings.sol";
/**
* @dev Signature message hash utilities for producing digests to be consumed by {ECDSA} recovery or signing.
*
* The library provides methods for generating a hash of a message that conforms to the
* https://eips.ethereum.org/EIPS/eip-191[ERC-191] and https://eips.ethereum.org/EIPS/eip-712[EIP 712]
* specifications.
*/
library MessageHashUtils {
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x45` (`personal_sign` messages).
*
* The digest is calculated by prefixing a bytes32 `messageHash` with
* `"\x19Ethereum Signed Message:\n32"` and hashing the result. It corresponds with the
* hash signed when using the https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`] JSON-RPC method.
*
* NOTE: The `messageHash` parameter is intended to be the result of hashing a raw message with
* keccak256, although any bytes32 value can be safely used because the final digest will
* be re-hashed.
*
* See {ECDSA-recover}.
*/
function toEthSignedMessageHash(bytes32 messageHash) internal pure returns (bytes32 digest) {
assembly ("memory-safe") {
mstore(0x00, "\x19Ethereum Signed Message:\n32") // 32 is the bytes-length of messageHash
mstore(0x1c, messageHash) // 0x1c (28) is the length of the prefix
digest := keccak256(0x00, 0x3c) // 0x3c is the length of the prefix (0x1c) + messageHash (0x20)
}
}
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x45` (`personal_sign` messages).
*
* The digest is calculated by prefixing an arbitrary `message` with
* `"\x19Ethereum Signed Message:\n" + len(message)` and hashing the result. It corresponds with the
* hash signed when using the https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`] JSON-RPC method.
*
* See {ECDSA-recover}.
*/
function toEthSignedMessageHash(bytes memory message) internal pure returns (bytes32) {
return
keccak256(bytes.concat("\x19Ethereum Signed Message:\n", bytes(Strings.toString(message.length)), message));
}
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x00` (data with intended validator).
*
* The digest is calculated by prefixing an arbitrary `data` with `"\x19\x00"` and the intended
* `validator` address. Then hashing the result.
*
* See {ECDSA-recover}.
*/
function toDataWithIntendedValidatorHash(address validator, bytes memory data) internal pure returns (bytes32) {
return keccak256(abi.encodePacked(hex"19_00", validator, data));
}
/**
* @dev Returns the keccak256 digest of an EIP-712 typed data (ERC-191 version `0x01`).
*
* The digest is calculated from a `domainSeparator` and a `structHash`, by prefixing them with
* `\x19\x01` and hashing the result. It corresponds to the hash signed by the
* https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`] JSON-RPC method as part of EIP-712.
*
* See {ECDSA-recover}.
*/
function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32 digest) {
assembly ("memory-safe") {
let ptr := mload(0x40)
mstore(ptr, hex"19_01")
mstore(add(ptr, 0x02), domainSeparator)
mstore(add(ptr, 0x22), structHash)
digest := keccak256(ptr, 0x42)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/ShortStrings.sol)
pragma solidity ^0.8.20;
import {StorageSlot} from "./StorageSlot.sol";
// | string | 0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA |
// | length | 0x BB |
type ShortString is bytes32;
/**
* @dev This library provides functions to convert short memory strings
* into a `ShortString` type that can be used as an immutable variable.
*
* Strings of arbitrary length can be optimized using this library if
* they are short enough (up to 31 bytes) by packing them with their
* length (1 byte) in a single EVM word (32 bytes). Additionally, a
* fallback mechanism can be used for every other case.
*
* Usage example:
*
* ```solidity
* contract Named {
* using ShortStrings for *;
*
* ShortString private immutable _name;
* string private _nameFallback;
*
* constructor(string memory contractName) {
* _name = contractName.toShortStringWithFallback(_nameFallback);
* }
*
* function name() external view returns (string memory) {
* return _name.toStringWithFallback(_nameFallback);
* }
* }
* ```
*/
library ShortStrings {
// Used as an identifier for strings longer than 31 bytes.
bytes32 private constant FALLBACK_SENTINEL = 0x00000000000000000000000000000000000000000000000000000000000000FF;
error StringTooLong(string str);
error InvalidShortString();
/**
* @dev Encode a string of at most 31 chars into a `ShortString`.
*
* This will trigger a `StringTooLong` error is the input string is too long.
*/
function toShortString(string memory str) internal pure returns (ShortString) {
bytes memory bstr = bytes(str);
if (bstr.length > 31) {
revert StringTooLong(str);
}
return ShortString.wrap(bytes32(uint256(bytes32(bstr)) | bstr.length));
}
/**
* @dev Decode a `ShortString` back to a "normal" string.
*/
function toString(ShortString sstr) internal pure returns (string memory) {
uint256 len = byteLength(sstr);
// using `new string(len)` would work locally but is not memory safe.
string memory str = new string(32);
assembly ("memory-safe") {
mstore(str, len)
mstore(add(str, 0x20), sstr)
}
return str;
}
/**
* @dev Return the length of a `ShortString`.
*/
function byteLength(ShortString sstr) internal pure returns (uint256) {
uint256 result = uint256(ShortString.unwrap(sstr)) & 0xFF;
if (result > 31) {
revert InvalidShortString();
}
return result;
}
/**
* @dev Encode a string into a `ShortString`, or write it to storage if it is too long.
*/
function toShortStringWithFallback(string memory value, string storage store) internal returns (ShortString) {
if (bytes(value).length < 32) {
return toShortString(value);
} else {
StorageSlot.getStringSlot(store).value = value;
return ShortString.wrap(FALLBACK_SENTINEL);
}
}
/**
* @dev Decode a string that was encoded to `ShortString` or written to storage using {setWithFallback}.
*/
function toStringWithFallback(ShortString value, string storage store) internal pure returns (string memory) {
if (ShortString.unwrap(value) != FALLBACK_SENTINEL) {
return toString(value);
} else {
return store;
}
}
/**
* @dev Return the length of a string that was encoded to `ShortString` or written to storage using
* {setWithFallback}.
*
* WARNING: This will return the "byte length" of the string. This may not reflect the actual length in terms of
* actual characters as the UTF-8 encoding of a single character can span over multiple bytes.
*/
function byteLengthWithFallback(ShortString value, string storage store) internal view returns (uint256) {
if (ShortString.unwrap(value) != FALLBACK_SENTINEL) {
return byteLength(value);
} else {
return bytes(store).length;
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC5267.sol)
pragma solidity ^0.8.20;
interface IERC5267 {
/**
* @dev MAY be emitted to signal that the domain could have changed.
*/
event EIP712DomainChanged();
/**
* @dev returns the fields and values that describe the domain separator used by this contract for EIP-712
* signature.
*/
function eip712Domain()
external
view
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Strings.sol)
pragma solidity ^0.8.20;
import {Math} from "./math/Math.sol";
import {SignedMath} from "./math/SignedMath.sol";
/**
* @dev String operations.
*/
library Strings {
bytes16 private constant HEX_DIGITS = "0123456789abcdef";
uint8 private constant ADDRESS_LENGTH = 20;
/**
* @dev The `value` string doesn't fit in the specified `length`.
*/
error StringsInsufficientHexLength(uint256 value, uint256 length);
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
unchecked {
uint256 length = Math.log10(value) + 1;
string memory buffer = new string(length);
uint256 ptr;
assembly ("memory-safe") {
ptr := add(buffer, add(32, length))
}
while (true) {
ptr--;
assembly ("memory-safe") {
mstore8(ptr, byte(mod(value, 10), HEX_DIGITS))
}
value /= 10;
if (value == 0) break;
}
return buffer;
}
}
/**
* @dev Converts a `int256` to its ASCII `string` decimal representation.
*/
function toStringSigned(int256 value) internal pure returns (string memory) {
return string.concat(value < 0 ? "-" : "", toString(SignedMath.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, Math.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) {
uint256 localValue = value;
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] = HEX_DIGITS[localValue & 0xf];
localValue >>= 4;
}
if (localValue != 0) {
revert StringsInsufficientHexLength(value, length);
}
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 Converts an `address` with fixed length of 20 bytes to its checksummed ASCII `string` hexadecimal
* representation, according to EIP-55.
*/
function toChecksumHexString(address addr) internal pure returns (string memory) {
bytes memory buffer = bytes(toHexString(addr));
// hash the hex part of buffer (skip length + 2 bytes, length 40)
uint256 hashValue;
assembly ("memory-safe") {
hashValue := shr(96, keccak256(add(buffer, 0x22), 40))
}
for (uint256 i = 41; i > 1; --i) {
// possible values for buffer[i] are 48 (0) to 57 (9) and 97 (a) to 102 (f)
if (hashValue & 0xf > 7 && uint8(buffer[i]) > 96) {
// case shift by xoring with 0x20
buffer[i] ^= 0x20;
}
hashValue >>= 4;
}
return string(buffer);
}
/**
* @dev Returns true if the two strings are equal.
*/
function equal(string memory a, string memory b) internal pure returns (bool) {
return bytes(a).length == bytes(b).length && keccak256(bytes(a)) == keccak256(bytes(b));
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/math/SignedMath.sol)
pragma solidity ^0.8.20;
import {SafeCast} from "./SafeCast.sol";
/**
* @dev Standard signed math utilities missing in the Solidity language.
*/
library SignedMath {
/**
* @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant.
*
* IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.
* However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute
* one branch when needed, making this function more expensive.
*/
function ternary(bool condition, int256 a, int256 b) internal pure returns (int256) {
unchecked {
// branchless ternary works because:
// b ^ (a ^ b) == a
// b ^ 0 == b
return b ^ ((a ^ b) * int256(SafeCast.toUint(condition)));
}
}
/**
* @dev Returns the largest of two signed numbers.
*/
function max(int256 a, int256 b) internal pure returns (int256) {
return ternary(a > b, a, b);
}
/**
* @dev Returns the smallest of two signed numbers.
*/
function min(int256 a, int256 b) internal pure returns (int256) {
return ternary(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 {
// Formula from the "Bit Twiddling Hacks" by Sean Eron Anderson.
// Since `n` is a signed integer, the generated bytecode will use the SAR opcode to perform the right shift,
// taking advantage of the most significant (or "sign" bit) in two's complement representation.
// This opcode adds new most significant bits set to the value of the previous most significant bit. As a result,
// the mask will either be `bytes32(0)` (if n is positive) or `~bytes32(0)` (if n is negative).
int256 mask = n >> 255;
// A `bytes32(0)` mask leaves the input unchanged, while a `~bytes32(0)` mask complements it.
return uint256((n + mask) ^ mask);
}
}
}{
"remappings": [
"@openzeppelin-contracts-5.1.0/=dependencies/@openzeppelin-contracts-5.1.0/",
"@openzeppelin-contracts-upgradeable-5.1.0/=dependencies/@openzeppelin-contracts-upgradeable-5.1.0/",
"@openzeppelin/contracts-upgradeable/=dependencies/@openzeppelin-contracts-upgradeable-5.1.0/",
"@openzeppelin/contracts/=dependencies/@openzeppelin-contracts-5.1.0/",
"@uniswap-v2-core-1.0.1/=dependencies/@uniswap-v2-core-1.0.1/",
"balancer-v2-latest/=dependencies/balancer-v2-latest/",
"berachain-contracts-latest/=dependencies/berachain-contracts-latest/",
"forge-std-1.9.4/=dependencies/forge-std-1.9.4/",
"forge-std/=dependencies/forge-std-1.9.4/src/",
"foundry-devops-0.2.2/=dependencies/foundry-devops-0.2.2/",
"openzeppelin-foundry-upgrades-0.3.6/=dependencies/openzeppelin-foundry-upgrades-0.3.6/",
"solady-0.0.298/=dependencies/solady-0.0.298/",
"solady/src/=dependencies/solady-0.0.298/src/",
"solady/test/=dependencies/solady-0.0.298/test/",
"@balancer-labs/=dependencies/balancer-v2-latest/../../node_modules/@balancer-labs/",
"@mock/=dependencies/berachain-contracts-latest/test/mock/",
"@openzeppelin-gov-ext/=dependencies/berachain-contracts-latest/node_modules/@openzeppelin/contracts-upgradeable/governance/extensions/",
"@openzeppelin-gov/=dependencies/berachain-contracts-latest/node_modules/@openzeppelin/contracts-upgradeable/governance/",
"@prb/math/=dependencies/berachain-contracts-latest/node_modules/@prb/math/",
"@pythnetwork/=dependencies/berachain-contracts-latest/node_modules/@pythnetwork/pyth-sdk-solidity/",
"ds-test/=dependencies/openzeppelin-foundry-upgrades-0.3.6/lib/solidity-stringutils/lib/ds-test/src/",
"openzeppelin-foundry-upgrades/=dependencies/openzeppelin-foundry-upgrades-0.3.6/src/",
"solidity-stringutils/=dependencies/openzeppelin-foundry-upgrades-0.3.6/lib/solidity-stringutils/",
"transient-goodies/=dependencies/berachain-contracts-latest/lib/transient-goodies/src/"
],
"optimizer": {
"enabled": true,
"runs": 69420
},
"metadata": {
"useLiteralContent": false,
"bytecodeHash": "ipfs",
"appendCBOR": true
},
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
},
"evmVersion": "cancun",
"viaIR": false,
"libraries": {}
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"AccessControlBadConfirmation","type":"error"},{"inputs":[{"internalType":"address","name":"account","type":"address"},{"internalType":"bytes32","name":"neededRole","type":"bytes32"}],"name":"AccessControlUnauthorizedAccount","type":"error"},{"inputs":[{"internalType":"address","name":"target","type":"address"}],"name":"AddressEmptyCode","type":"error"},{"inputs":[],"name":"AlreadyCalledThisEpoch","type":"error"},{"inputs":[],"name":"AlreadyDelegated","type":"error"},{"inputs":[],"name":"AlreadyQueued","type":"error"},{"inputs":[],"name":"AlreadyUndelegated","type":"error"},{"inputs":[],"name":"BelowMinBoost","type":"error"},{"inputs":[],"name":"CannotRecoverRewardToken","type":"error"},{"inputs":[],"name":"ContractExpired","type":"error"},{"inputs":[],"name":"DelegateeHasNoLock","type":"error"},{"inputs":[],"name":"DelegateeLockExpired","type":"error"},{"inputs":[],"name":"Disabled","type":"error"},{"inputs":[{"internalType":"address","name":"implementation","type":"address"}],"name":"ERC1967InvalidImplementation","type":"error"},{"inputs":[],"name":"ERC1967NonPayable","type":"error"},{"inputs":[],"name":"EnforcedPause","type":"error"},{"inputs":[],"name":"ExceededMaxTime","type":"error"},{"inputs":[],"name":"ExpectedPause","type":"error"},{"inputs":[],"name":"FailedCall","type":"error"},{"inputs":[],"name":"FutureLookUp","type":"error"},{"inputs":[],"name":"IncorrectBGTReward","type":"error"},{"inputs":[],"name":"InsufficientBalance","type":"error"},{"inputs":[],"name":"InsufficientRedeem","type":"error"},{"inputs":[{"internalType":"uint16","name":"_fee","type":"uint16"}],"name":"InvalidFee","type":"error"},{"inputs":[],"name":"InvalidFeeRecipients","type":"error"},{"inputs":[],"name":"InvalidInitialization","type":"error"},{"inputs":[],"name":"InvalidInput","type":"error"},{"inputs":[],"name":"InvalidRate","type":"error"},{"inputs":[],"name":"LockDelegated","type":"error"},{"inputs":[],"name":"LockExists","type":"error"},{"inputs":[],"name":"LockExpired","type":"error"},{"inputs":[],"name":"LockNotExpired","type":"error"},{"inputs":[],"name":"NoLock","type":"error"},{"inputs":[],"name":"NotAuthorized","type":"error"},{"inputs":[],"name":"NotDistributor","type":"error"},{"inputs":[],"name":"NotEnoughTimeHasPassed","type":"error"},{"inputs":[],"name":"NotFeeCollector","type":"error"},{"inputs":[],"name":"NotInitializing","type":"error"},{"inputs":[],"name":"NotPositionOwner","type":"error"},{"inputs":[],"name":"NotStaker","type":"error"},{"inputs":[{"internalType":"address","name":"user","type":"address"}],"name":"NotUser","type":"error"},{"inputs":[{"internalType":"address","name":"user","type":"address"},{"internalType":"address","name":"rewardsVault","type":"address"}],"name":"NotUserOrManager","type":"error"},{"inputs":[],"name":"OnlyBeraPawForge","type":"error"},{"inputs":[],"name":"OnlyDelegateToLongerLock","type":"error"},{"inputs":[],"name":"OnlyFutureLockEnd","type":"error"},{"inputs":[],"name":"OnlyIncreaseLockLength","type":"error"},{"inputs":[],"name":"PayoutAmountIsZero","type":"error"},{"inputs":[],"name":"ReceiverHasSmallerLockEnd","type":"error"},{"inputs":[{"internalType":"uint128","name":"amount","type":"uint128"}],"name":"RedeemNotAvailable","type":"error"},{"inputs":[],"name":"ReentrancyGuardReentrantCall","type":"error"},{"inputs":[],"name":"RewardPeriodNotFinished","type":"error"},{"inputs":[{"internalType":"uint8","name":"bits","type":"uint8"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"SafeCastOverflowedUintDowncast","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"SafeERC20FailedOperation","type":"error"},{"inputs":[],"name":"SelfTransferNotAllowed","type":"error"},{"inputs":[],"name":"UUPSUnauthorizedCallContext","type":"error"},{"inputs":[{"internalType":"bytes32","name":"slot","type":"bytes32"}],"name":"UUPSUnsupportedProxiableUUID","type":"error"},{"inputs":[],"name":"ValidatorAlreadyRegistered","type":"error"},{"inputs":[],"name":"ValidatorNotRegistered","type":"error"},{"inputs":[],"name":"WeightsDoNotAddToOneHundredPercent","type":"error"},{"inputs":[],"name":"ZeroAddress","type":"error"},{"inputs":[],"name":"ZeroAmount","type":"error"},{"inputs":[],"name":"ZeroBias","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"delegate","type":"address"}],"name":"Delegated","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint64","name":"version","type":"uint64"}],"name":"Initialized","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":true,"internalType":"address","name":"rewardVault","type":"address"},{"indexed":true,"internalType":"address","name":"recipient","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"LBGTMinted","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":true,"internalType":"address","name":"rewardVault","type":"address"},{"indexed":true,"internalType":"address","name":"manager","type":"address"}],"name":"ManagerSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"minimumRedeemAmount","type":"uint256"}],"name":"MinimumRedeemAmountSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"bool","name":"openProcessRedemptions","type":"bool"}],"name":"OpenProcessRedemptionsSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"account","type":"address"}],"name":"Paused","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"processingFee","type":"uint256"}],"name":"ProcessingFeeSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"queueDelay","type":"uint256"}],"name":"QueueDelaySet","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"token","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"Recovered","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":true,"internalType":"address","name":"recipient","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"RedeemProcessed","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"RedeemQueued","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":true,"internalType":"address","name":"recipient","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"Redeemed","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":true,"internalType":"bytes32","name":"referrer","type":"bytes32"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"Referred","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"role","type":"bytes32"},{"indexed":true,"internalType":"bytes32","name":"previousAdminRole","type":"bytes32"},{"indexed":true,"internalType":"bytes32","name":"newAdminRole","type":"bytes32"}],"name":"RoleAdminChanged","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"role","type":"bytes32"},{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":true,"internalType":"address","name":"sender","type":"address"}],"name":"RoleGranted","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"role","type":"bytes32"},{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":true,"internalType":"address","name":"sender","type":"address"}],"name":"RoleRevoked","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"caller","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"StakerRewardCollected","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"treasury","type":"address"}],"name":"TreasurySet","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"account","type":"address"}],"name":"Unpaused","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"implementation","type":"address"}],"name":"Upgraded","type":"event"},{"stateMutability":"payable","type":"fallback"},{"inputs":[],"name":"DEFAULT_ADMIN_ROLE","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"UPGRADE_INTERFACE_VERSION","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes","name":"pubkey","type":"bytes"}],"name":"activateBoost","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"boostableBGT","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes","name":"pubkey","type":"bytes"},{"internalType":"uint128","name":"amount","type":"uint128"}],"name":"cancelBoost","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes","name":"pubkey","type":"bytes"},{"internalType":"uint128","name":"amount","type":"uint128"}],"name":"cancelDropBoost","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"}],"name":"collectStakerReward","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_delegate","type":"address"}],"name":"delegate","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes","name":"pubkey","type":"bytes"}],"name":"dropBoost","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"rewardVault","type":"address"},{"internalType":"address","name":"account","type":"address"}],"name":"getBGTOperator","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"}],"name":"getRoleAdmin","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"account","type":"address"}],"name":"grantRole","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"account","type":"address"}],"name":"hasRole","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_owner","type":"address"}],"name":"initialize","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"isProcessRedemptionsOpen","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"lbgtAddress","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"pure","type":"function"},{"inputs":[{"internalType":"address","name":"account","type":"address"},{"internalType":"address","name":"rewardVault","type":"address"}],"name":"lbgtManager","outputs":[{"internalType":"address","name":"manager","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"minimumRedeemAmount","outputs":[{"internalType":"uint128","name":"","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"},{"internalType":"address","name":"rewardVault","type":"address"},{"internalType":"address","name":"recipient","type":"address"}],"name":"mint","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address[]","name":"users","type":"address[]"},{"internalType":"address[]","name":"rewardVaults","type":"address[]"},{"internalType":"address[]","name":"recipients","type":"address[]"}],"name":"mintMulti","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"},{"internalType":"address","name":"rewardVault","type":"address"},{"internalType":"address","name":"recipient","type":"address"},{"internalType":"bytes32","name":"data","type":"bytes32"}],"name":"mintReferred","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"pause","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"paused","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint128","name":"maxBatchSize","type":"uint128"},{"internalType":"address","name":"recipient","type":"address"}],"name":"processRedemptions","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[],"name":"processingFee","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"proxiableUUID","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes","name":"pubkey","type":"bytes"},{"internalType":"uint128","name":"amount","type":"uint128"}],"name":"queueBoost","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"queueDelay","outputs":[{"internalType":"uint96","name":"","type":"uint96"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes","name":"pubkey","type":"bytes"},{"internalType":"uint128","name":"amount","type":"uint128"}],"name":"queueDropBoost","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint128","name":"amount","type":"uint128"}],"name":"queueRedeem","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"recover","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"address","name":"recipient","type":"address"}],"name":"redeem","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"redeemPosition","outputs":[{"internalType":"uint128","name":"queued","type":"uint128"},{"internalType":"uint128","name":"available","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"redeemQueue","outputs":[{"internalType":"address","name":"account","type":"address"},{"internalType":"uint96","name":"blockNumber","type":"uint96"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"redeemQueueIndex","outputs":[{"internalType":"uint128","name":"","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"callerConfirmation","type":"address"}],"name":"renounceRole","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"account","type":"address"}],"name":"revokeRole","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"rewardVault","type":"address"},{"internalType":"address","name":"manager","type":"address"}],"name":"setManager","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address[]","name":"rewardVaults","type":"address[]"},{"internalType":"address[]","name":"managers","type":"address[]"}],"name":"setManagerMulti","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint128","name":"_minimumRedeemAmount","type":"uint128"}],"name":"setMinimumRedeemAmount","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bool","name":"_open","type":"bool"}],"name":"setOpenProcessRedemptions","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_processingFee","type":"uint256"}],"name":"setProcessingFee","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint96","name":"_queueDelay","type":"uint96"}],"name":"setQueueDelay","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes4","name":"interfaceId","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalRedeemQueue","outputs":[{"internalType":"uint128","name":"","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"unpause","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newImplementation","type":"address"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"upgradeToAndCall","outputs":[],"stateMutability":"payable","type":"function"},{"stateMutability":"payable","type":"receive"}]Contract Creation Code
60a060405230608052348015610013575f5ffd5b5061001c610021565b6100d3565b7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00805468010000000000000000900460ff16156100715760405163f92ee8a960e01b815260040160405180910390fd5b80546001600160401b03908116146100d05780546001600160401b0319166001600160401b0390811782556040519081527fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d29060200160405180910390a15b50565b6080516147bf6100f95f395f8181612e9c01528181612ec5015261310301526147bf5ff3fe6080604052600436106102da575f3560e01c806364eb1a2b116101815780639891bcd6116100d4578063c9e831d311610083578063d8d66f4711610060578063d8d66f4714610a55578063de1881a814610a74578063f59f3cbf14610a8957005b8063c9e831d3146109a4578063d33d049f14610a22578063d547741f14610a3657005b8063a2ff02dd116100b1578063a2ff02dd1461091d578063ad3cb1cc14610930578063c4d66de81461098557005b80639891bcd6146108935780639c8b0547146108eb578063a217fddf1461090a57005b80638456cb591161013057806391d148541161010d57806391d14854146107e55780639461446d1461085557806395195fd91461087457005b80638456cb5914610793578063898dc10d146107a75780638ca6ee00146107c657005b80637644bc021161015e5780637644bc021461070357806378d0ea351461074c57806383003d0a1461076b57005b806364eb1a2b1461063f57806368bdb2111461068057806373279cdf146106c757005b806336568abe1161023957806352d1902d116101e85780635df8122f116101c55780635df8122f146105e25780636299b0151461060157806363185c421461062057005b806352d1902d146105795780635c19a95c1461058d5780635c975abb146105ac57005b8063475869d111610216578063475869d114610528578063489fa30a146105475780634f1ef2861461056657005b806336568abe146104bc5780633f4ba83a146104db578063459ecab8146104ef57005b80631a31268b11610295578063273b4ffa11610272578063273b4ffa1461045f5780632b153ce11461047e5780632f2ff15d1461049d57005b80631a31268b146103d45780631ec82cb8146103f3578063248a9ca31461041257005b80630bc5206a116102c35780630bc5206a146103695780630d7da3281461038857806312c0f7ae146103b557005b806301ffc9a7146102dc5780630bb4299a14610310575b005b3480156102e7575f5ffd5b506102fb6102f6366004613ee4565b610aa8565b60405190151581526020015b60405180910390f35b34801561031b575f5ffd5b50600554610348906c0100000000000000000000000090046fffffffffffffffffffffffffffffffff1681565b6040516fffffffffffffffffffffffffffffffff9091168152602001610307565b348015610374575f5ffd5b506102da610383366004613f47565b610b40565b348015610393575f5ffd5b506103a76103a2366004613f81565b610bf6565b604051908152602001610307565b3480156103c0575f5ffd5b506102da6103cf366004613fa9565b610d19565b3480156103df575f5ffd5b506102da6103ee366004613fc4565b610dcc565b3480156103fe575f5ffd5b506102da61040d366004613fef565b610e61565b34801561041d575f5ffd5b506103a761042c36600461402d565b5f9081527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b626800602052604090206001015490565b34801561046a575f5ffd5b506102da610479366004613f47565b610f88565b348015610489575f5ffd5b506102da610498366004614089565b6111cc565b3480156104a8575f5ffd5b506102da6104b73660046140d9565b61127e565b3480156104c7575f5ffd5b506102da6104d63660046140d9565b6112c1565b3480156104e6575f5ffd5b506102da61131f565b3480156104fa575f5ffd5b506005546102fb907c0100000000000000000000000000000000000000000000000000000000900460ff1681565b348015610533575f5ffd5b506102da610542366004614107565b611354565b348015610552575f5ffd5b506102da610561366004614089565b61155d565b6102da61057436600461415e565b6115db565b348015610584575f5ffd5b506103a76115fa565b348015610598575f5ffd5b506102da6105a7366004613f81565b611628565b3480156105b7575f5ffd5b507fcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f033005460ff166102fb565b3480156105ed575f5ffd5b506102da6105fc366004614261565b611724565b34801561060c575f5ffd5b506103a761061b36600461427d565b6117b2565b34801561062b575f5ffd5b506103a761063a3660046142cb565b611855565b34801561064a575f5ffd5b50600554610663906bffffffffffffffffffffffff1681565b6040516bffffffffffffffffffffffff9091168152602001610307565b34801561068b575f5ffd5b5073baadcc2962417c01af99fb2b7c75706b9bd6babe5b60405173ffffffffffffffffffffffffffffffffffffffff9091168152602001610307565b3480156106d2575f5ffd5b506003546103489070010000000000000000000000000000000090046fffffffffffffffffffffffffffffffff1681565b34801561070e575f5ffd5b506106a261071d366004614261565b5f60208181529281526040808220909352908152205473ffffffffffffffffffffffffffffffffffffffff1681565b348015610757575f5ffd5b506106a2610766366004614261565b6118a3565b348015610776575f5ffd5b50600354610348906fffffffffffffffffffffffffffffffff1681565b34801561079e575f5ffd5b506102da611934565b3480156107b2575f5ffd5b506103a76107c1366004614354565b611966565b3480156107d1575f5ffd5b506102fb6107e03660046143f3565b611bc3565b3480156107f0575f5ffd5b506102fb6107ff3660046140d9565b5f9182527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b6268006020908152604080842073ffffffffffffffffffffffffffffffffffffffff93909316845291905290205460ff1690565b348015610860575f5ffd5b506102da61086f36600461402d565b611c82565b34801561087f575f5ffd5b506102fb61088e3660046143f3565b611ce1565b34801561089e575f5ffd5b506108b26108ad36600461402d565b611d60565b6040805173ffffffffffffffffffffffffffffffffffffffff90931683526bffffffffffffffffffffffff909116602083015201610307565b3480156108f6575f5ffd5b506102da610905366004614089565b611dbc565b348015610915575f5ffd5b506103a75f81565b6102da61092b366004614107565b611e3a565b34801561093b575f5ffd5b506109786040518060400160405280600581526020017f352e302e3000000000000000000000000000000000000000000000000000000081525081565b6040516103079190614432565b348015610990575f5ffd5b506102da61099f366004613f81565b612435565b3480156109af575f5ffd5b506109f96109be366004613f81565b60016020525f90815260409020546fffffffffffffffffffffffffffffffff8082169170010000000000000000000000000000000090041682565b604080516fffffffffffffffffffffffffffffffff938416815292909116602083015201610307565b348015610a2d575f5ffd5b506103a76127da565b348015610a41575f5ffd5b506102da610a503660046140d9565b61289f565b348015610a60575f5ffd5b506102da610a6f366004614485565b6128e2565b348015610a7f575f5ffd5b506103a760045481565b348015610a94575f5ffd5b506102da610aa3366004614089565b612a40565b5f7fffffffff0000000000000000000000000000000000000000000000000000000082167f7965db0b000000000000000000000000000000000000000000000000000000001480610b3a57507f01ffc9a7000000000000000000000000000000000000000000000000000000007fffffffff000000000000000000000000000000000000000000000000000000008316145b92915050565b7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca025096610b6a81612abe565b600580547fffffffff00000000000000000000000000000000ffffffffffffffffffffffff166c010000000000000000000000006fffffffffffffffffffffffffffffffff8581168202929092179283905560405192041681527f7c6ad4fbdf3c2a8f2e791eca2642f1525b0d06793477fca9c25366640c22913b906020015b60405180910390a15050565b5f7fed006b25ab3bfcbcb95545f8ef3d963f3d51bf0bd8e919efec855b98354bb8f4610c2181612abe565b5f7344f07ce5afecbcc406e6befd40cc2998eeb8c7c673ffffffffffffffffffffffffffffffffffffffff16633d18b9126040518163ffffffff1660e01b81526004016020604051808303815f875af1158015610c80573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190610ca491906144f1565b9050610cc573fcbd14dc51f0a4d49d5e53c2e0950e0bc26d0dce8583612ac8565b60405181815273ffffffffffffffffffffffffffffffffffffffff85169033907fa19cd46390cd8cf2df4eaa8d4f40b83bf502706d6a585c2f8e406be584c0bdfe9060200160405180910390a39392505050565b7f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde43610d4381612abe565b600580547fffffff00ffffffffffffffffffffffffffffffffffffffffffffffffffffffff167c01000000000000000000000000000000000000000000000000000000008415158102919091179182905560405160ff9190920416151581527f0f23521b34e9e3aacc5e2ed99c92b79107705583bd8429c0367bf01e6ff61c8590602001610bea565b7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca025096610df681612abe565b600580547fffffffffffffffffffffffffffffffffffffffff000000000000000000000000166bffffffffffffffffffffffff84169081179091556040519081527f200adf9cb78cab506787e59986fc90c32209d365f612039d3ae110b16e445f1b90602001610bea565b7f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde43610e8b81612abe565b7fffffffffffffffffffffffff455233d69dbe83fe506604d4838a8f946429454273ffffffffffffffffffffffffffffffffffffffff851601610efa576040517fb4fa3fb300000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b610f1b73ffffffffffffffffffffffffffffffffffffffff85168484612ac8565b8273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff167ffff3b3844276f57024e0b42afec1a37f75db36511e43819a4f2a63ab7862b64884604051610f7a91815260200190565b60405180910390a350505050565b610f90612b49565b6005546fffffffffffffffffffffffffffffffff6c0100000000000000000000000090910481169082161015610ff2576040517fb4fa3fb300000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b335f81815260016020526040902080546fffffffffffffffffffffffffffffffff161561104b576040517f5f8547c200000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b80546fffffffffffffffffffffffffffffffff808216850181167fffffffffffffffffffffffffffffffff0000000000000000000000000000000090921691909117825560038054700100000000000000000000000000000000808204841687018416029083161790556040805180820190915273ffffffffffffffffffffffffffffffffffffffff80851682526bffffffffffffffffffffffff43811660208401908152600280546001810182555f919091529351905190911674010000000000000000000000000000000000000000029116177f405787fa12a823e0f2b7631cc41b3ba8828b3321ca811111fa75cd3aa3bb5ace9091015561116a9073baadcc2962417c01af99fb2b7c75706b9bd6babe90849030908716612ba7565b6040516fffffffffffffffffffffffffffffffff8416815273ffffffffffffffffffffffffffffffffffffffff8316907f2d63629c76f6eb6e13f82b6b4c2d85ff01c2cdd17b6dbd5557ce4487071c42709060200160405180910390a2505050565b7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f6111f681612abe565b6040517f2b153ce100000000000000000000000000000000000000000000000000000000815273656b95e550c07a9ffe548bd4085c72418ceb1dba90632b153ce19061124a9087908790879060040161454f565b5f604051808303815f87803b158015611261575f5ffd5b505af1158015611273573d5f5f3e3d5ffd5b505050505b50505050565b5f8281527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b62680060205260409020600101546112b781612abe565b6112788383612bed565b73ffffffffffffffffffffffffffffffffffffffff81163314611310576040517f6697b23200000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b61131a8282612d0b565b505050565b7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca02509661134981612abe565b611351612de7565b50565b61135c612b49565b73ffffffffffffffffffffffffffffffffffffffff81166113a9576040517fd92e233d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b5f826fffffffffffffffffffffffffffffffff16116113f4576040517f1f2a200500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b335f8181526001602052604090208054849070010000000000000000000000000000000090046fffffffffffffffffffffffffffffffff9081169082161115611483576040517f2a2525470000000000000000000000000000000000000000000000000000000081526fffffffffffffffffffffffffffffffff90911660048201526024015b60405180910390fd5b5080546fffffffffffffffffffffffffffffffff700100000000000000000000000000000000808304821687900382160291811691909117825560405173ffffffffffffffffffffffffffffffffffffffff851691861680156108fc02915f818181858888f193505050501580156114fd573d5f5f3e3d5ffd5b506040516fffffffffffffffffffffffffffffffff8516815273ffffffffffffffffffffffffffffffffffffffff80851691908416907f27d4634c833b7622a0acddbf7f746183625f105945e95c723ad1d5a9f2a0b6fc90602001610f7a565b7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f61158781612abe565b6040517f489fa30a00000000000000000000000000000000000000000000000000000000815273656b95e550c07a9ffe548bd4085c72418ceb1dba9063489fa30a9061124a9087908790879060040161454f565b6115e3612e84565b6115ec82612f88565b6115f68282612fb2565b5050565b5f6116036130eb565b507f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc90565b7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca02509661165281612abe565b6040517f5c19a95c00000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff8316600482015273656b95e550c07a9ffe548bd4085c72418ceb1dba90635c19a95c906024015f604051808303815f87803b1580156116ca575f5ffd5b505af11580156116dc573d5f5f3e3d5ffd5b505060405173ffffffffffffffffffffffffffffffffffffffff851692507f8032572cea061551dfd3bca9ad398b6b62d05ead9c2647d284bdf1c9b3c09c7c91505f90a25050565b5f3373ffffffffffffffffffffffffffffffffffffffff8181165f81815260208181526040808320898616808552925280832080547fffffffffffffffffffffffff00000000000000000000000000000000000000001695891695861790555194955092937f5dae668abd992231c1c15f4276f098f39a13c928004c77e411ec0a5592f67d039190a4505050565b5f6117bb61315a565b6117c3612b49565b5f6117cf8587866131db565b9050828673ffffffffffffffffffffffffffffffffffffffff167ffa659c803725cf0cb6ac5831fed3c24debfe1165ab50c15e1ebddd62074149158360405161181a91815260200190565b60405180910390a3905061184d60017f9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f0055565b949350505050565b5f61185e61315a565b611866612b49565b6118718385846131db565b905061189c60017f9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f0055565b9392505050565b6040517f9a30739100000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff82811660048301525f9190841690639a30739190602401602060405180830381865afa158015611910573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061189c9190614584565b7f7d68abe375688fa6524a1e9fa536eba0f1436a99b6f68e00057ca09082957cb161195e81612abe565b611351613624565b5f61196f61315a565b611977612b49565b838614801561198557508582145b6119bb576040517fb4fa3fb300000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6040517f70a082310000000000000000000000000000000000000000000000000000000081523060048201525f9073656b95e550c07a9ffe548bd4085c72418ceb1dba906370a0823190602401602060405180830381865afa158015611a23573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190611a4791906144f1565b90505f85815b81811015611ae657611ad2898983818110611a6a57611a6a61459f565b9050602002016020810190611a7f9190613f81565b8c8c84818110611a9157611a9161459f565b9050602002016020810190611aa69190613f81565b898985818110611ab857611ab861459f565b9050602002016020810190611acd9190613f81565b6131db565b611adc90846145f9565b9250600101611a4d565b506040517f70a082310000000000000000000000000000000000000000000000000000000081523060048201528390839073656b95e550c07a9ffe548bd4085c72418ceb1dba906370a0823190602401602060405180830381865afa158015611b51573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190611b7591906144f1565b611b7f919061460c565b14611b8c57611b8c61461f565b50915050611bb960017f9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f0055565b9695505050505050565b5f7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f611bee81612abe565b6040517f814d261400000000000000000000000000000000000000000000000000000000815273656b95e550c07a9ffe548bd4085c72418ceb1dba9063814d261490611c429030908890889060040161464c565b6020604051808303815f875af1158015611c5e573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061184d919061467b565b7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca025096611cac81612abe565b60048290556040518281527f081823ccb60015b731da23650649389eb10ff7229b3e43ccb9a2ef49be72b53590602001610bea565b5f7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f611d0c81612abe565b6040517f9b05e78100000000000000000000000000000000000000000000000000000000815273656b95e550c07a9ffe548bd4085c72418ceb1dba90639b05e78190611c429030908890889060040161464c565b60028181548110611d6f575f80fd5b5f9182526020909120015473ffffffffffffffffffffffffffffffffffffffff811691507401000000000000000000000000000000000000000090046bffffffffffffffffffffffff1682565b7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f611de681612abe565b6040517f9c8b054700000000000000000000000000000000000000000000000000000000815273656b95e550c07a9ffe548bd4085c72418ceb1dba90639c8b05479061124a9087908790879060040161454f565b611e42612b49565b6005547c0100000000000000000000000000000000000000000000000000000000900460ff1680611ea05750335f9081527f67d8f4228a491565bfa315c4f41398da0e2a03ae36964f1821259636ab407773602052604090205460ff165b611ed6576040517fea8e4eb500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6003546fffffffffffffffffffffffffffffffff165f611f22611ef98584614696565b6fffffffffffffffffffffffffffffffff166001600280549050611f1d919061460c565b61369d565b60055460045491925034916bffffffffffffffffffffffff909116905f80805b866fffffffffffffffffffffffffffffffff16886fffffffffffffffffffffffffffffffff16116122c5575f6002896fffffffffffffffffffffffffffffffff1681548110611f9357611f9361459f565b5f9182526020808320604080518082018252939091015473ffffffffffffffffffffffffffffffffffffffff8116808552740100000000000000000000000000000000000000009091046bffffffffffffffffffffffff16848401528452600182528084208151808301909252546fffffffffffffffffffffffffffffffff8082168084527001000000000000000000000000000000009092041692820192909252919350909103612051576120488a6146be565b99505050611f42565b5f61207a825f01516fffffffffffffffffffffffffffffffff1688670de0b6b3a76400006136ac565b90505f81835f01516fffffffffffffffffffffffffffffffff1661209e919061460c565b9050808a1061214c5760405180604001604052805f6fffffffffffffffffffffffffffffffff1681526020016120d383613781565b6020808701516fffffffffffffffffffffffffffffffff92018216909252865173ffffffffffffffffffffffffffffffffffffffff165f90815260018352604090208351939092015181167001000000000000000000000000000000000292811692909217905583519a8290039a169690960195612222565b88846020015161215c91906146fa565b6bffffffffffffffffffffffff1643106122195760405180604001604052805f6fffffffffffffffffffffffffffffffff16815260200161219c83613781565b6020808701516fffffffffffffffffffffffffffffffff92018216909252865173ffffffffffffffffffffffffffffffffffffffff165f9081526001835260408120845194909301518216700100000000000000000000000000000000029390911692909217905599828101979097019681039590950194612222565b505050506122c5565b825161222e9086614696565b945060028c6fffffffffffffffffffffffffffffffff16815481106122555761225561459f565b5f918252602082200155835160405173ffffffffffffffffffffffffffffffffffffffff8f81169216907f2fdc87fbfb7f9a7b687e842c6f26a8ae9d842a9370f1f2f4cdfba1c176601768906122ae9085815260200190565b60405180910390a38b6001019b5050505050611f42565b600380547fffffffffffffffffffffffffffffffff00000000000000000000000000000000166fffffffffffffffffffffffffffffffff8a81169190911780835583929160109161232c91859170010000000000000000000000000000000090041661471e565b92506101000a8154816fffffffffffffffffffffffffffffffff02191690836fffffffffffffffffffffffffffffffff1602179055505f8211156123f45761237430836137da565b6040517f1e9a69500000000000000000000000000000000000000000000000000000000081523060048201526024810183905273656b95e550c07a9ffe548bd4085c72418ceb1dba90631e9a6950906044015f604051808303815f87803b1580156123dd575f5ffd5b505af11580156123ef573d5f5f3e3d5ffd5b505050505b851561240457612404338761386c565b82156124295761242973baadcc2962417c01af99fb2b7c75706b9bd6babe8a85612ac8565b50505050505050505050565b7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00805468010000000000000000810460ff16159067ffffffffffffffff165f8115801561247f5750825b90505f8267ffffffffffffffff16600114801561249b5750303b155b9050811580156124a9575080155b156124e0576040517ff92ee8a900000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b84547fffffffffffffffffffffffffffffffffffffffffffffffff000000000000000016600117855583156125415784547fffffffffffffffffffffffffffffffffffffffffffffff00ffffffffffffffff16680100000000000000001785555b612549613885565b61255161388d565b61255961389d565b612561613885565b61258b7f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde43806138ad565b6125d57f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca0250967f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde436138ad565b61261f7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca0250966138ad565b6126697f7d68abe375688fa6524a1e9fa536eba0f1436a99b6f68e00057ca09082957cb17f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca0250966138ad565b6126b37fed006b25ab3bfcbcb95545f8ef3d963f3d51bf0bd8e919efec855b98354bb8f47f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde436138ad565b6126fd7f9c293e7bdd073aa80b23cccfdc58a27fdae37a3d8eafa8182d2246295f86180a7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca0250966138ad565b6127277f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde4387612bed565b50600580547fffffffff0000000000000000000000000000000000000000000000000000000016730de0b6b3a7640000000000000000000000004e201790556611c37937e0800060045583156127d25784547fffffffffffffffffffffffffffffffffffffffffffffff00ffffffffffffffff168555604051600181527fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d29060200160405180910390a15b505050505050565b6003546040517f70a082310000000000000000000000000000000000000000000000000000000081523060048201525f9170010000000000000000000000000000000090046fffffffffffffffffffffffffffffffff169073656b95e550c07a9ffe548bd4085c72418ceb1dba906370a0823190602401602060405180830381865afa15801561286c573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061289091906144f1565b61289a919061460c565b905090565b5f8281527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b62680060205260409020600101546128d881612abe565b6112788383612d0b565b82811461291b576040517fb4fa3fb300000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b82612952576040517fb4fa3fb300000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b335f5b848110156127d2575f8686838181106129705761297061459f565b90506020020160208101906129859190613f81565b90505f85858481811061299a5761299a61459f565b90506020020160208101906129af9190613f81565b73ffffffffffffffffffffffffffffffffffffffff8581165f81815260208181526040808320888616808552925280832080547fffffffffffffffffffffffff00000000000000000000000000000000000000001695871695861790555194955092937f5dae668abd992231c1c15f4276f098f39a13c928004c77e411ec0a5592f67d039190a45050600101612955565b7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f612a6a81612abe565b6040517ff59f3cbf00000000000000000000000000000000000000000000000000000000815273656b95e550c07a9ffe548bd4085c72418ceb1dba9063f59f3cbf9061124a9087908790879060040161454f565b611351813361394e565b60405173ffffffffffffffffffffffffffffffffffffffff83811660248301526044820183905261131a91859182169063a9059cbb906064015b604051602081830303815290604052915060e01b6020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff83818316178352505050506139f4565b7fcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f033005460ff1615612ba5576040517fd93c066500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b565b60405173ffffffffffffffffffffffffffffffffffffffff84811660248301528381166044830152606482018390526112789186918216906323b872dd90608401612b02565b5f8281527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b6268006020818152604080842073ffffffffffffffffffffffffffffffffffffffff8616855290915282205460ff16612d02575f8481526020828152604080832073ffffffffffffffffffffffffffffffffffffffff87168452909152902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00166001179055612c9e3390565b73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16857f2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d60405160405180910390a46001915050610b3a565b5f915050610b3a565b5f8281527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b6268006020818152604080842073ffffffffffffffffffffffffffffffffffffffff8616855290915282205460ff1615612d02575f8481526020828152604080832073ffffffffffffffffffffffffffffffffffffffff8716808552925280832080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0016905551339287917ff6391f5c32d9c69d2a47ea670b442974b53935d1edc7fd64eb21e047a839171b9190a46001915050610b3a565b612def613a93565b7fcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f0330080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff001681557f5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa335b60405173ffffffffffffffffffffffffffffffffffffffff909116815260200160405180910390a150565b3073ffffffffffffffffffffffffffffffffffffffff7f0000000000000000000000000000000000000000000000000000000000000000161480612f5157507f000000000000000000000000000000000000000000000000000000000000000073ffffffffffffffffffffffffffffffffffffffff16612f387f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc5473ffffffffffffffffffffffffffffffffffffffff1690565b73ffffffffffffffffffffffffffffffffffffffff1614155b15612ba5576040517fe07c8dba00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b7f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde436115f681612abe565b8173ffffffffffffffffffffffffffffffffffffffff166352d1902d6040518163ffffffff1660e01b8152600401602060405180830381865afa925050508015613037575060408051601f3d9081017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0168201909252613034918101906144f1565b60015b613085576040517f4c9c8ce300000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff8316600482015260240161147a565b7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc81146130e1576040517faa1d49a40000000000000000000000000000000000000000000000000000000081526004810182905260240161147a565b61131a8383613aee565b3073ffffffffffffffffffffffffffffffffffffffff7f00000000000000000000000000000000000000000000000000000000000000001614612ba5576040517fe07c8dba00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b7f9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f0080547ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe016131d5576040517f3ee5aeb500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b60029055565b5f82843373ffffffffffffffffffffffffffffffffffffffff8316811480613236575073ffffffffffffffffffffffffffffffffffffffff8381165f9081526020818152604080832086851684529091529020548116908216145b83839091613290576040517f2740b14000000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff92831660048201529116602482015260440161147a565b505073ffffffffffffffffffffffffffffffffffffffff87166132df576040517fd92e233d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b73ffffffffffffffffffffffffffffffffffffffff851661332c576040517fd92e233d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b73ffffffffffffffffffffffffffffffffffffffff8616613379576040517fd92e233d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6040517f70a082310000000000000000000000000000000000000000000000000000000081523060048201525f9073656b95e550c07a9ffe548bd4085c72418ceb1dba906370a0823190602401602060405180830381865afa1580156133e1573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061340591906144f1565b6040517f6b09169500000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff898116600483015230602483015291925090891690636b091695906044016020604051808303815f875af115801561347a573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061349e91906144f1565b506040517f70a082310000000000000000000000000000000000000000000000000000000081523060048201525f9073656b95e550c07a9ffe548bd4085c72418ceb1dba906370a0823190602401602060405180830381865afa158015613507573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061352b91906144f1565b9050818111613566576040517faf8d8a9500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b8181036135738882613b50565b8773ffffffffffffffffffffffffffffffffffffffff168a73ffffffffffffffffffffffffffffffffffffffff168a73ffffffffffffffffffffffffffffffffffffffff167fc3a082aa63632e8a89ade2a12c0685c160196b8e5fdfe991c737409412c2f4f6846040516135e991815260200190565b60405180910390a49998505050505050505050565b60017f9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f0055565b61362c612b49565b7fcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f0330080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff001660011781557f62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a25833612e59565b5f82821882841002821861189c565b5f838302817fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff85870982811083820303915050805f036136ff578382816136f5576136f5614746565b049250505061189c565b808411613716576137166003851502601118613bbd565b5f848688095f868103871696879004966002600389028118808a02820302808a02820302808a02820302808a02820302808a02820302808a02909103029181900381900460010186841190950394909402919094039290920491909117919091029150509392505050565b5f6fffffffffffffffffffffffffffffffff8211156137d6576040517f6dfcc650000000000000000000000000000000000000000000000000000000008152608060048201526024810183905260440161147a565b5090565b6040517f9dc29fac00000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff831660048201526024810182905273baadcc2962417c01af99fb2b7c75706b9bd6babe90639dc29fac906044015b5f604051808303815f87803b15801561385a575f5ffd5b505af11580156127d2573d5f5f3e3d5ffd5b5f385f3884865af16115f65763b12d13eb5f526004601cfd5b612ba5613bce565b613895613bce565b612ba5613c35565b6138a5613bce565b612ba5613c86565b7f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b6268005f613906845f9081527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b626800602052604090206001015490565b5f85815260208490526040808220600101869055519192508491839187917fbd79b86ffe0ab8e8776151514217cd7cacd52c909f66475c3af44e129f0b00ff9190a450505050565b5f8281527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b6268006020908152604080832073ffffffffffffffffffffffffffffffffffffffff8516845290915290205460ff166115f6576040517fe2517d3f00000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff821660048201526024810183905260440161147a565b5f5f60205f8451602086015f885af180613a13576040513d5f823e3d81fd5b50505f513d91508115613a2a578060011415613a44565b73ffffffffffffffffffffffffffffffffffffffff84163b155b15611278576040517f5274afe700000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff8516600482015260240161147a565b7fcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f033005460ff16612ba5576040517f8dfc202b00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b613af782613c8e565b60405173ffffffffffffffffffffffffffffffffffffffff8316907fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b905f90a2805115613b485761131a8282613d5c565b6115f6613ddb565b6040517f40c10f1900000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff831660048201526024810182905273baadcc2962417c01af99fb2b7c75706b9bd6babe906340c10f1990604401613843565b634e487b715f52806020526024601cfd5b7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a005468010000000000000000900460ff16612ba5576040517fd7e6bcf800000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b613c3d613bce565b7fcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f0330080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00169055565b6135fe613bce565b8073ffffffffffffffffffffffffffffffffffffffff163b5f03613cf6576040517f4c9c8ce300000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff8216600482015260240161147a565b7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc80547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff92909216919091179055565b60605f5f8473ffffffffffffffffffffffffffffffffffffffff1684604051613d859190614773565b5f60405180830381855af49150503d805f8114613dbd576040519150601f19603f3d011682016040523d82523d5f602084013e613dc2565b606091505b5091509150613dd2858383613e13565b95945050505050565b3415612ba5576040517fb398979f00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b606082613e2857613e2382613ea2565b61189c565b8151158015613e4c575073ffffffffffffffffffffffffffffffffffffffff84163b155b15613e9b576040517f9996b31500000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff8516600482015260240161147a565b508061189c565b805115613eb25780518082602001fd5b6040517fd6bda27500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b5f60208284031215613ef4575f5ffd5b81357fffffffff000000000000000000000000000000000000000000000000000000008116811461189c575f5ffd5b80356fffffffffffffffffffffffffffffffff81168114613f42575f5ffd5b919050565b5f60208284031215613f57575f5ffd5b61189c82613f23565b73ffffffffffffffffffffffffffffffffffffffff81168114611351575f5ffd5b5f60208284031215613f91575f5ffd5b813561189c81613f60565b8015158114611351575f5ffd5b5f60208284031215613fb9575f5ffd5b813561189c81613f9c565b5f60208284031215613fd4575f5ffd5b81356bffffffffffffffffffffffff8116811461189c575f5ffd5b5f5f5f60608486031215614001575f5ffd5b833561400c81613f60565b9250602084013561401c81613f60565b929592945050506040919091013590565b5f6020828403121561403d575f5ffd5b5035919050565b5f5f83601f840112614054575f5ffd5b50813567ffffffffffffffff81111561406b575f5ffd5b602083019150836020828501011115614082575f5ffd5b9250929050565b5f5f5f6040848603121561409b575f5ffd5b833567ffffffffffffffff8111156140b1575f5ffd5b6140bd86828701614044565b90945092506140d0905060208501613f23565b90509250925092565b5f5f604083850312156140ea575f5ffd5b8235915060208301356140fc81613f60565b809150509250929050565b5f5f60408385031215614118575f5ffd5b61412183613f23565b915060208301356140fc81613f60565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b5f5f6040838503121561416f575f5ffd5b823561417a81613f60565b9150602083013567ffffffffffffffff811115614195575f5ffd5b8301601f810185136141a5575f5ffd5b803567ffffffffffffffff8111156141bf576141bf614131565b6040517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0603f7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0601f8501160116810181811067ffffffffffffffff8211171561422b5761422b614131565b604052818152828201602001871015614242575f5ffd5b816020840160208301375f602083830101528093505050509250929050565b5f5f60408385031215614272575f5ffd5b823561412181613f60565b5f5f5f5f60808587031215614290575f5ffd5b843561429b81613f60565b935060208501356142ab81613f60565b925060408501356142bb81613f60565b9396929550929360600135925050565b5f5f5f606084860312156142dd575f5ffd5b83356142e881613f60565b925060208401356142f881613f60565b9150604084013561430881613f60565b809150509250925092565b5f5f83601f840112614323575f5ffd5b50813567ffffffffffffffff81111561433a575f5ffd5b6020830191508360208260051b8501011115614082575f5ffd5b5f5f5f5f5f5f60608789031215614369575f5ffd5b863567ffffffffffffffff81111561437f575f5ffd5b61438b89828a01614313565b909750955050602087013567ffffffffffffffff8111156143aa575f5ffd5b6143b689828a01614313565b909550935050604087013567ffffffffffffffff8111156143d5575f5ffd5b6143e189828a01614313565b979a9699509497509295939492505050565b5f5f60208385031215614404575f5ffd5b823567ffffffffffffffff81111561441a575f5ffd5b61442685828601614044565b90969095509350505050565b602081525f82518060208401528060208501604085015e5f6040828501015260407fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0601f83011684010191505092915050565b5f5f5f5f60408587031215614498575f5ffd5b843567ffffffffffffffff8111156144ae575f5ffd5b6144ba87828801614313565b909550935050602085013567ffffffffffffffff8111156144d9575f5ffd5b6144e587828801614313565b95989497509550505050565b5f60208284031215614501575f5ffd5b5051919050565b81835281816020850137505f602082840101525f60207fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0601f840116840101905092915050565b604081525f614562604083018587614508565b90506fffffffffffffffffffffffffffffffff83166020830152949350505050565b5f60208284031215614594575f5ffd5b815161189c81613f60565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52603260045260245ffd5b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601160045260245ffd5b80820180821115610b3a57610b3a6145cc565b81810381811115610b3a57610b3a6145cc565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52600160045260245ffd5b73ffffffffffffffffffffffffffffffffffffffff84168152604060208201525f613dd2604083018486614508565b5f6020828403121561468b575f5ffd5b815161189c81613f9c565b6fffffffffffffffffffffffffffffffff8181168382160190811115610b3a57610b3a6145cc565b5f6fffffffffffffffffffffffffffffffff82166fffffffffffffffffffffffffffffffff81036146f1576146f16145cc565b60010192915050565b6bffffffffffffffffffffffff8181168382160190811115610b3a57610b3a6145cc565b6fffffffffffffffffffffffffffffffff8281168282160390811115610b3a57610b3a6145cc565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601260045260245ffd5b5f82518060208501845e5f92019182525091905056fea2646970667358221220a36f40e8f056d9f3a6a4a8a25a67a8cf4b74637f876e17248f38e64bc5b09fab64736f6c634300081c0033
Deployed Bytecode
0x6080604052600436106102da575f3560e01c806364eb1a2b116101815780639891bcd6116100d4578063c9e831d311610083578063d8d66f4711610060578063d8d66f4714610a55578063de1881a814610a74578063f59f3cbf14610a8957005b8063c9e831d3146109a4578063d33d049f14610a22578063d547741f14610a3657005b8063a2ff02dd116100b1578063a2ff02dd1461091d578063ad3cb1cc14610930578063c4d66de81461098557005b80639891bcd6146108935780639c8b0547146108eb578063a217fddf1461090a57005b80638456cb591161013057806391d148541161010d57806391d14854146107e55780639461446d1461085557806395195fd91461087457005b80638456cb5914610793578063898dc10d146107a75780638ca6ee00146107c657005b80637644bc021161015e5780637644bc021461070357806378d0ea351461074c57806383003d0a1461076b57005b806364eb1a2b1461063f57806368bdb2111461068057806373279cdf146106c757005b806336568abe1161023957806352d1902d116101e85780635df8122f116101c55780635df8122f146105e25780636299b0151461060157806363185c421461062057005b806352d1902d146105795780635c19a95c1461058d5780635c975abb146105ac57005b8063475869d111610216578063475869d114610528578063489fa30a146105475780634f1ef2861461056657005b806336568abe146104bc5780633f4ba83a146104db578063459ecab8146104ef57005b80631a31268b11610295578063273b4ffa11610272578063273b4ffa1461045f5780632b153ce11461047e5780632f2ff15d1461049d57005b80631a31268b146103d45780631ec82cb8146103f3578063248a9ca31461041257005b80630bc5206a116102c35780630bc5206a146103695780630d7da3281461038857806312c0f7ae146103b557005b806301ffc9a7146102dc5780630bb4299a14610310575b005b3480156102e7575f5ffd5b506102fb6102f6366004613ee4565b610aa8565b60405190151581526020015b60405180910390f35b34801561031b575f5ffd5b50600554610348906c0100000000000000000000000090046fffffffffffffffffffffffffffffffff1681565b6040516fffffffffffffffffffffffffffffffff9091168152602001610307565b348015610374575f5ffd5b506102da610383366004613f47565b610b40565b348015610393575f5ffd5b506103a76103a2366004613f81565b610bf6565b604051908152602001610307565b3480156103c0575f5ffd5b506102da6103cf366004613fa9565b610d19565b3480156103df575f5ffd5b506102da6103ee366004613fc4565b610dcc565b3480156103fe575f5ffd5b506102da61040d366004613fef565b610e61565b34801561041d575f5ffd5b506103a761042c36600461402d565b5f9081527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b626800602052604090206001015490565b34801561046a575f5ffd5b506102da610479366004613f47565b610f88565b348015610489575f5ffd5b506102da610498366004614089565b6111cc565b3480156104a8575f5ffd5b506102da6104b73660046140d9565b61127e565b3480156104c7575f5ffd5b506102da6104d63660046140d9565b6112c1565b3480156104e6575f5ffd5b506102da61131f565b3480156104fa575f5ffd5b506005546102fb907c0100000000000000000000000000000000000000000000000000000000900460ff1681565b348015610533575f5ffd5b506102da610542366004614107565b611354565b348015610552575f5ffd5b506102da610561366004614089565b61155d565b6102da61057436600461415e565b6115db565b348015610584575f5ffd5b506103a76115fa565b348015610598575f5ffd5b506102da6105a7366004613f81565b611628565b3480156105b7575f5ffd5b507fcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f033005460ff166102fb565b3480156105ed575f5ffd5b506102da6105fc366004614261565b611724565b34801561060c575f5ffd5b506103a761061b36600461427d565b6117b2565b34801561062b575f5ffd5b506103a761063a3660046142cb565b611855565b34801561064a575f5ffd5b50600554610663906bffffffffffffffffffffffff1681565b6040516bffffffffffffffffffffffff9091168152602001610307565b34801561068b575f5ffd5b5073baadcc2962417c01af99fb2b7c75706b9bd6babe5b60405173ffffffffffffffffffffffffffffffffffffffff9091168152602001610307565b3480156106d2575f5ffd5b506003546103489070010000000000000000000000000000000090046fffffffffffffffffffffffffffffffff1681565b34801561070e575f5ffd5b506106a261071d366004614261565b5f60208181529281526040808220909352908152205473ffffffffffffffffffffffffffffffffffffffff1681565b348015610757575f5ffd5b506106a2610766366004614261565b6118a3565b348015610776575f5ffd5b50600354610348906fffffffffffffffffffffffffffffffff1681565b34801561079e575f5ffd5b506102da611934565b3480156107b2575f5ffd5b506103a76107c1366004614354565b611966565b3480156107d1575f5ffd5b506102fb6107e03660046143f3565b611bc3565b3480156107f0575f5ffd5b506102fb6107ff3660046140d9565b5f9182527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b6268006020908152604080842073ffffffffffffffffffffffffffffffffffffffff93909316845291905290205460ff1690565b348015610860575f5ffd5b506102da61086f36600461402d565b611c82565b34801561087f575f5ffd5b506102fb61088e3660046143f3565b611ce1565b34801561089e575f5ffd5b506108b26108ad36600461402d565b611d60565b6040805173ffffffffffffffffffffffffffffffffffffffff90931683526bffffffffffffffffffffffff909116602083015201610307565b3480156108f6575f5ffd5b506102da610905366004614089565b611dbc565b348015610915575f5ffd5b506103a75f81565b6102da61092b366004614107565b611e3a565b34801561093b575f5ffd5b506109786040518060400160405280600581526020017f352e302e3000000000000000000000000000000000000000000000000000000081525081565b6040516103079190614432565b348015610990575f5ffd5b506102da61099f366004613f81565b612435565b3480156109af575f5ffd5b506109f96109be366004613f81565b60016020525f90815260409020546fffffffffffffffffffffffffffffffff8082169170010000000000000000000000000000000090041682565b604080516fffffffffffffffffffffffffffffffff938416815292909116602083015201610307565b348015610a2d575f5ffd5b506103a76127da565b348015610a41575f5ffd5b506102da610a503660046140d9565b61289f565b348015610a60575f5ffd5b506102da610a6f366004614485565b6128e2565b348015610a7f575f5ffd5b506103a760045481565b348015610a94575f5ffd5b506102da610aa3366004614089565b612a40565b5f7fffffffff0000000000000000000000000000000000000000000000000000000082167f7965db0b000000000000000000000000000000000000000000000000000000001480610b3a57507f01ffc9a7000000000000000000000000000000000000000000000000000000007fffffffff000000000000000000000000000000000000000000000000000000008316145b92915050565b7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca025096610b6a81612abe565b600580547fffffffff00000000000000000000000000000000ffffffffffffffffffffffff166c010000000000000000000000006fffffffffffffffffffffffffffffffff8581168202929092179283905560405192041681527f7c6ad4fbdf3c2a8f2e791eca2642f1525b0d06793477fca9c25366640c22913b906020015b60405180910390a15050565b5f7fed006b25ab3bfcbcb95545f8ef3d963f3d51bf0bd8e919efec855b98354bb8f4610c2181612abe565b5f7344f07ce5afecbcc406e6befd40cc2998eeb8c7c673ffffffffffffffffffffffffffffffffffffffff16633d18b9126040518163ffffffff1660e01b81526004016020604051808303815f875af1158015610c80573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190610ca491906144f1565b9050610cc573fcbd14dc51f0a4d49d5e53c2e0950e0bc26d0dce8583612ac8565b60405181815273ffffffffffffffffffffffffffffffffffffffff85169033907fa19cd46390cd8cf2df4eaa8d4f40b83bf502706d6a585c2f8e406be584c0bdfe9060200160405180910390a39392505050565b7f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde43610d4381612abe565b600580547fffffff00ffffffffffffffffffffffffffffffffffffffffffffffffffffffff167c01000000000000000000000000000000000000000000000000000000008415158102919091179182905560405160ff9190920416151581527f0f23521b34e9e3aacc5e2ed99c92b79107705583bd8429c0367bf01e6ff61c8590602001610bea565b7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca025096610df681612abe565b600580547fffffffffffffffffffffffffffffffffffffffff000000000000000000000000166bffffffffffffffffffffffff84169081179091556040519081527f200adf9cb78cab506787e59986fc90c32209d365f612039d3ae110b16e445f1b90602001610bea565b7f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde43610e8b81612abe565b7fffffffffffffffffffffffff455233d69dbe83fe506604d4838a8f946429454273ffffffffffffffffffffffffffffffffffffffff851601610efa576040517fb4fa3fb300000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b610f1b73ffffffffffffffffffffffffffffffffffffffff85168484612ac8565b8273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff167ffff3b3844276f57024e0b42afec1a37f75db36511e43819a4f2a63ab7862b64884604051610f7a91815260200190565b60405180910390a350505050565b610f90612b49565b6005546fffffffffffffffffffffffffffffffff6c0100000000000000000000000090910481169082161015610ff2576040517fb4fa3fb300000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b335f81815260016020526040902080546fffffffffffffffffffffffffffffffff161561104b576040517f5f8547c200000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b80546fffffffffffffffffffffffffffffffff808216850181167fffffffffffffffffffffffffffffffff0000000000000000000000000000000090921691909117825560038054700100000000000000000000000000000000808204841687018416029083161790556040805180820190915273ffffffffffffffffffffffffffffffffffffffff80851682526bffffffffffffffffffffffff43811660208401908152600280546001810182555f919091529351905190911674010000000000000000000000000000000000000000029116177f405787fa12a823e0f2b7631cc41b3ba8828b3321ca811111fa75cd3aa3bb5ace9091015561116a9073baadcc2962417c01af99fb2b7c75706b9bd6babe90849030908716612ba7565b6040516fffffffffffffffffffffffffffffffff8416815273ffffffffffffffffffffffffffffffffffffffff8316907f2d63629c76f6eb6e13f82b6b4c2d85ff01c2cdd17b6dbd5557ce4487071c42709060200160405180910390a2505050565b7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f6111f681612abe565b6040517f2b153ce100000000000000000000000000000000000000000000000000000000815273656b95e550c07a9ffe548bd4085c72418ceb1dba90632b153ce19061124a9087908790879060040161454f565b5f604051808303815f87803b158015611261575f5ffd5b505af1158015611273573d5f5f3e3d5ffd5b505050505b50505050565b5f8281527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b62680060205260409020600101546112b781612abe565b6112788383612bed565b73ffffffffffffffffffffffffffffffffffffffff81163314611310576040517f6697b23200000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b61131a8282612d0b565b505050565b7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca02509661134981612abe565b611351612de7565b50565b61135c612b49565b73ffffffffffffffffffffffffffffffffffffffff81166113a9576040517fd92e233d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b5f826fffffffffffffffffffffffffffffffff16116113f4576040517f1f2a200500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b335f8181526001602052604090208054849070010000000000000000000000000000000090046fffffffffffffffffffffffffffffffff9081169082161115611483576040517f2a2525470000000000000000000000000000000000000000000000000000000081526fffffffffffffffffffffffffffffffff90911660048201526024015b60405180910390fd5b5080546fffffffffffffffffffffffffffffffff700100000000000000000000000000000000808304821687900382160291811691909117825560405173ffffffffffffffffffffffffffffffffffffffff851691861680156108fc02915f818181858888f193505050501580156114fd573d5f5f3e3d5ffd5b506040516fffffffffffffffffffffffffffffffff8516815273ffffffffffffffffffffffffffffffffffffffff80851691908416907f27d4634c833b7622a0acddbf7f746183625f105945e95c723ad1d5a9f2a0b6fc90602001610f7a565b7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f61158781612abe565b6040517f489fa30a00000000000000000000000000000000000000000000000000000000815273656b95e550c07a9ffe548bd4085c72418ceb1dba9063489fa30a9061124a9087908790879060040161454f565b6115e3612e84565b6115ec82612f88565b6115f68282612fb2565b5050565b5f6116036130eb565b507f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc90565b7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca02509661165281612abe565b6040517f5c19a95c00000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff8316600482015273656b95e550c07a9ffe548bd4085c72418ceb1dba90635c19a95c906024015f604051808303815f87803b1580156116ca575f5ffd5b505af11580156116dc573d5f5f3e3d5ffd5b505060405173ffffffffffffffffffffffffffffffffffffffff851692507f8032572cea061551dfd3bca9ad398b6b62d05ead9c2647d284bdf1c9b3c09c7c91505f90a25050565b5f3373ffffffffffffffffffffffffffffffffffffffff8181165f81815260208181526040808320898616808552925280832080547fffffffffffffffffffffffff00000000000000000000000000000000000000001695891695861790555194955092937f5dae668abd992231c1c15f4276f098f39a13c928004c77e411ec0a5592f67d039190a4505050565b5f6117bb61315a565b6117c3612b49565b5f6117cf8587866131db565b9050828673ffffffffffffffffffffffffffffffffffffffff167ffa659c803725cf0cb6ac5831fed3c24debfe1165ab50c15e1ebddd62074149158360405161181a91815260200190565b60405180910390a3905061184d60017f9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f0055565b949350505050565b5f61185e61315a565b611866612b49565b6118718385846131db565b905061189c60017f9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f0055565b9392505050565b6040517f9a30739100000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff82811660048301525f9190841690639a30739190602401602060405180830381865afa158015611910573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061189c9190614584565b7f7d68abe375688fa6524a1e9fa536eba0f1436a99b6f68e00057ca09082957cb161195e81612abe565b611351613624565b5f61196f61315a565b611977612b49565b838614801561198557508582145b6119bb576040517fb4fa3fb300000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6040517f70a082310000000000000000000000000000000000000000000000000000000081523060048201525f9073656b95e550c07a9ffe548bd4085c72418ceb1dba906370a0823190602401602060405180830381865afa158015611a23573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190611a4791906144f1565b90505f85815b81811015611ae657611ad2898983818110611a6a57611a6a61459f565b9050602002016020810190611a7f9190613f81565b8c8c84818110611a9157611a9161459f565b9050602002016020810190611aa69190613f81565b898985818110611ab857611ab861459f565b9050602002016020810190611acd9190613f81565b6131db565b611adc90846145f9565b9250600101611a4d565b506040517f70a082310000000000000000000000000000000000000000000000000000000081523060048201528390839073656b95e550c07a9ffe548bd4085c72418ceb1dba906370a0823190602401602060405180830381865afa158015611b51573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190611b7591906144f1565b611b7f919061460c565b14611b8c57611b8c61461f565b50915050611bb960017f9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f0055565b9695505050505050565b5f7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f611bee81612abe565b6040517f814d261400000000000000000000000000000000000000000000000000000000815273656b95e550c07a9ffe548bd4085c72418ceb1dba9063814d261490611c429030908890889060040161464c565b6020604051808303815f875af1158015611c5e573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061184d919061467b565b7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca025096611cac81612abe565b60048290556040518281527f081823ccb60015b731da23650649389eb10ff7229b3e43ccb9a2ef49be72b53590602001610bea565b5f7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f611d0c81612abe565b6040517f9b05e78100000000000000000000000000000000000000000000000000000000815273656b95e550c07a9ffe548bd4085c72418ceb1dba90639b05e78190611c429030908890889060040161464c565b60028181548110611d6f575f80fd5b5f9182526020909120015473ffffffffffffffffffffffffffffffffffffffff811691507401000000000000000000000000000000000000000090046bffffffffffffffffffffffff1682565b7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f611de681612abe565b6040517f9c8b054700000000000000000000000000000000000000000000000000000000815273656b95e550c07a9ffe548bd4085c72418ceb1dba90639c8b05479061124a9087908790879060040161454f565b611e42612b49565b6005547c0100000000000000000000000000000000000000000000000000000000900460ff1680611ea05750335f9081527f67d8f4228a491565bfa315c4f41398da0e2a03ae36964f1821259636ab407773602052604090205460ff165b611ed6576040517fea8e4eb500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6003546fffffffffffffffffffffffffffffffff165f611f22611ef98584614696565b6fffffffffffffffffffffffffffffffff166001600280549050611f1d919061460c565b61369d565b60055460045491925034916bffffffffffffffffffffffff909116905f80805b866fffffffffffffffffffffffffffffffff16886fffffffffffffffffffffffffffffffff16116122c5575f6002896fffffffffffffffffffffffffffffffff1681548110611f9357611f9361459f565b5f9182526020808320604080518082018252939091015473ffffffffffffffffffffffffffffffffffffffff8116808552740100000000000000000000000000000000000000009091046bffffffffffffffffffffffff16848401528452600182528084208151808301909252546fffffffffffffffffffffffffffffffff8082168084527001000000000000000000000000000000009092041692820192909252919350909103612051576120488a6146be565b99505050611f42565b5f61207a825f01516fffffffffffffffffffffffffffffffff1688670de0b6b3a76400006136ac565b90505f81835f01516fffffffffffffffffffffffffffffffff1661209e919061460c565b9050808a1061214c5760405180604001604052805f6fffffffffffffffffffffffffffffffff1681526020016120d383613781565b6020808701516fffffffffffffffffffffffffffffffff92018216909252865173ffffffffffffffffffffffffffffffffffffffff165f90815260018352604090208351939092015181167001000000000000000000000000000000000292811692909217905583519a8290039a169690960195612222565b88846020015161215c91906146fa565b6bffffffffffffffffffffffff1643106122195760405180604001604052805f6fffffffffffffffffffffffffffffffff16815260200161219c83613781565b6020808701516fffffffffffffffffffffffffffffffff92018216909252865173ffffffffffffffffffffffffffffffffffffffff165f9081526001835260408120845194909301518216700100000000000000000000000000000000029390911692909217905599828101979097019681039590950194612222565b505050506122c5565b825161222e9086614696565b945060028c6fffffffffffffffffffffffffffffffff16815481106122555761225561459f565b5f918252602082200155835160405173ffffffffffffffffffffffffffffffffffffffff8f81169216907f2fdc87fbfb7f9a7b687e842c6f26a8ae9d842a9370f1f2f4cdfba1c176601768906122ae9085815260200190565b60405180910390a38b6001019b5050505050611f42565b600380547fffffffffffffffffffffffffffffffff00000000000000000000000000000000166fffffffffffffffffffffffffffffffff8a81169190911780835583929160109161232c91859170010000000000000000000000000000000090041661471e565b92506101000a8154816fffffffffffffffffffffffffffffffff02191690836fffffffffffffffffffffffffffffffff1602179055505f8211156123f45761237430836137da565b6040517f1e9a69500000000000000000000000000000000000000000000000000000000081523060048201526024810183905273656b95e550c07a9ffe548bd4085c72418ceb1dba90631e9a6950906044015f604051808303815f87803b1580156123dd575f5ffd5b505af11580156123ef573d5f5f3e3d5ffd5b505050505b851561240457612404338761386c565b82156124295761242973baadcc2962417c01af99fb2b7c75706b9bd6babe8a85612ac8565b50505050505050505050565b7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00805468010000000000000000810460ff16159067ffffffffffffffff165f8115801561247f5750825b90505f8267ffffffffffffffff16600114801561249b5750303b155b9050811580156124a9575080155b156124e0576040517ff92ee8a900000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b84547fffffffffffffffffffffffffffffffffffffffffffffffff000000000000000016600117855583156125415784547fffffffffffffffffffffffffffffffffffffffffffffff00ffffffffffffffff16680100000000000000001785555b612549613885565b61255161388d565b61255961389d565b612561613885565b61258b7f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde43806138ad565b6125d57f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca0250967f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde436138ad565b61261f7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca0250966138ad565b6126697f7d68abe375688fa6524a1e9fa536eba0f1436a99b6f68e00057ca09082957cb17f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca0250966138ad565b6126b37fed006b25ab3bfcbcb95545f8ef3d963f3d51bf0bd8e919efec855b98354bb8f47f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde436138ad565b6126fd7f9c293e7bdd073aa80b23cccfdc58a27fdae37a3d8eafa8182d2246295f86180a7f2172861495e7b85edac73e3cd5fbb42dd675baadf627720e687bcfdaca0250966138ad565b6127277f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde4387612bed565b50600580547fffffffff0000000000000000000000000000000000000000000000000000000016730de0b6b3a7640000000000000000000000004e201790556611c37937e0800060045583156127d25784547fffffffffffffffffffffffffffffffffffffffffffffff00ffffffffffffffff168555604051600181527fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d29060200160405180910390a15b505050505050565b6003546040517f70a082310000000000000000000000000000000000000000000000000000000081523060048201525f9170010000000000000000000000000000000090046fffffffffffffffffffffffffffffffff169073656b95e550c07a9ffe548bd4085c72418ceb1dba906370a0823190602401602060405180830381865afa15801561286c573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061289091906144f1565b61289a919061460c565b905090565b5f8281527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b62680060205260409020600101546128d881612abe565b6112788383612d0b565b82811461291b576040517fb4fa3fb300000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b82612952576040517fb4fa3fb300000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b335f5b848110156127d2575f8686838181106129705761297061459f565b90506020020160208101906129859190613f81565b90505f85858481811061299a5761299a61459f565b90506020020160208101906129af9190613f81565b73ffffffffffffffffffffffffffffffffffffffff8581165f81815260208181526040808320888616808552925280832080547fffffffffffffffffffffffff00000000000000000000000000000000000000001695871695861790555194955092937f5dae668abd992231c1c15f4276f098f39a13c928004c77e411ec0a5592f67d039190a45050600101612955565b7f2bdb8f633b2b5cc0da9376172a20964ddefe1a9d7604e72e094c7f7e57a1fc2f612a6a81612abe565b6040517ff59f3cbf00000000000000000000000000000000000000000000000000000000815273656b95e550c07a9ffe548bd4085c72418ceb1dba9063f59f3cbf9061124a9087908790879060040161454f565b611351813361394e565b60405173ffffffffffffffffffffffffffffffffffffffff83811660248301526044820183905261131a91859182169063a9059cbb906064015b604051602081830303815290604052915060e01b6020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff83818316178352505050506139f4565b7fcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f033005460ff1615612ba5576040517fd93c066500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b565b60405173ffffffffffffffffffffffffffffffffffffffff84811660248301528381166044830152606482018390526112789186918216906323b872dd90608401612b02565b5f8281527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b6268006020818152604080842073ffffffffffffffffffffffffffffffffffffffff8616855290915282205460ff16612d02575f8481526020828152604080832073ffffffffffffffffffffffffffffffffffffffff87168452909152902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00166001179055612c9e3390565b73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16857f2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d60405160405180910390a46001915050610b3a565b5f915050610b3a565b5f8281527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b6268006020818152604080842073ffffffffffffffffffffffffffffffffffffffff8616855290915282205460ff1615612d02575f8481526020828152604080832073ffffffffffffffffffffffffffffffffffffffff8716808552925280832080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0016905551339287917ff6391f5c32d9c69d2a47ea670b442974b53935d1edc7fd64eb21e047a839171b9190a46001915050610b3a565b612def613a93565b7fcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f0330080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff001681557f5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa335b60405173ffffffffffffffffffffffffffffffffffffffff909116815260200160405180910390a150565b3073ffffffffffffffffffffffffffffffffffffffff7f000000000000000000000000a1c400f1ec0dd6a4dc5a08ff2fe9aa0fbfd76d5f161480612f5157507f000000000000000000000000a1c400f1ec0dd6a4dc5a08ff2fe9aa0fbfd76d5f73ffffffffffffffffffffffffffffffffffffffff16612f387f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc5473ffffffffffffffffffffffffffffffffffffffff1690565b73ffffffffffffffffffffffffffffffffffffffff1614155b15612ba5576040517fe07c8dba00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b7f3dd5781c5eb2381e177c02b5f4bf2015939f2f99355dca561e8feb76fa6bde436115f681612abe565b8173ffffffffffffffffffffffffffffffffffffffff166352d1902d6040518163ffffffff1660e01b8152600401602060405180830381865afa925050508015613037575060408051601f3d9081017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0168201909252613034918101906144f1565b60015b613085576040517f4c9c8ce300000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff8316600482015260240161147a565b7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc81146130e1576040517faa1d49a40000000000000000000000000000000000000000000000000000000081526004810182905260240161147a565b61131a8383613aee565b3073ffffffffffffffffffffffffffffffffffffffff7f000000000000000000000000a1c400f1ec0dd6a4dc5a08ff2fe9aa0fbfd76d5f1614612ba5576040517fe07c8dba00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b7f9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f0080547ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe016131d5576040517f3ee5aeb500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b60029055565b5f82843373ffffffffffffffffffffffffffffffffffffffff8316811480613236575073ffffffffffffffffffffffffffffffffffffffff8381165f9081526020818152604080832086851684529091529020548116908216145b83839091613290576040517f2740b14000000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff92831660048201529116602482015260440161147a565b505073ffffffffffffffffffffffffffffffffffffffff87166132df576040517fd92e233d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b73ffffffffffffffffffffffffffffffffffffffff851661332c576040517fd92e233d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b73ffffffffffffffffffffffffffffffffffffffff8616613379576040517fd92e233d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6040517f70a082310000000000000000000000000000000000000000000000000000000081523060048201525f9073656b95e550c07a9ffe548bd4085c72418ceb1dba906370a0823190602401602060405180830381865afa1580156133e1573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061340591906144f1565b6040517f6b09169500000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff898116600483015230602483015291925090891690636b091695906044016020604051808303815f875af115801561347a573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061349e91906144f1565b506040517f70a082310000000000000000000000000000000000000000000000000000000081523060048201525f9073656b95e550c07a9ffe548bd4085c72418ceb1dba906370a0823190602401602060405180830381865afa158015613507573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061352b91906144f1565b9050818111613566576040517faf8d8a9500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b8181036135738882613b50565b8773ffffffffffffffffffffffffffffffffffffffff168a73ffffffffffffffffffffffffffffffffffffffff168a73ffffffffffffffffffffffffffffffffffffffff167fc3a082aa63632e8a89ade2a12c0685c160196b8e5fdfe991c737409412c2f4f6846040516135e991815260200190565b60405180910390a49998505050505050505050565b60017f9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f0055565b61362c612b49565b7fcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f0330080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff001660011781557f62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a25833612e59565b5f82821882841002821861189c565b5f838302817fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff85870982811083820303915050805f036136ff578382816136f5576136f5614746565b049250505061189c565b808411613716576137166003851502601118613bbd565b5f848688095f868103871696879004966002600389028118808a02820302808a02820302808a02820302808a02820302808a02820302808a02909103029181900381900460010186841190950394909402919094039290920491909117919091029150509392505050565b5f6fffffffffffffffffffffffffffffffff8211156137d6576040517f6dfcc650000000000000000000000000000000000000000000000000000000008152608060048201526024810183905260440161147a565b5090565b6040517f9dc29fac00000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff831660048201526024810182905273baadcc2962417c01af99fb2b7c75706b9bd6babe90639dc29fac906044015b5f604051808303815f87803b15801561385a575f5ffd5b505af11580156127d2573d5f5f3e3d5ffd5b5f385f3884865af16115f65763b12d13eb5f526004601cfd5b612ba5613bce565b613895613bce565b612ba5613c35565b6138a5613bce565b612ba5613c86565b7f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b6268005f613906845f9081527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b626800602052604090206001015490565b5f85815260208490526040808220600101869055519192508491839187917fbd79b86ffe0ab8e8776151514217cd7cacd52c909f66475c3af44e129f0b00ff9190a450505050565b5f8281527f02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b6268006020908152604080832073ffffffffffffffffffffffffffffffffffffffff8516845290915290205460ff166115f6576040517fe2517d3f00000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff821660048201526024810183905260440161147a565b5f5f60205f8451602086015f885af180613a13576040513d5f823e3d81fd5b50505f513d91508115613a2a578060011415613a44565b73ffffffffffffffffffffffffffffffffffffffff84163b155b15611278576040517f5274afe700000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff8516600482015260240161147a565b7fcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f033005460ff16612ba5576040517f8dfc202b00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b613af782613c8e565b60405173ffffffffffffffffffffffffffffffffffffffff8316907fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b905f90a2805115613b485761131a8282613d5c565b6115f6613ddb565b6040517f40c10f1900000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff831660048201526024810182905273baadcc2962417c01af99fb2b7c75706b9bd6babe906340c10f1990604401613843565b634e487b715f52806020526024601cfd5b7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a005468010000000000000000900460ff16612ba5576040517fd7e6bcf800000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b613c3d613bce565b7fcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f0330080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00169055565b6135fe613bce565b8073ffffffffffffffffffffffffffffffffffffffff163b5f03613cf6576040517f4c9c8ce300000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff8216600482015260240161147a565b7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc80547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff92909216919091179055565b60605f5f8473ffffffffffffffffffffffffffffffffffffffff1684604051613d859190614773565b5f60405180830381855af49150503d805f8114613dbd576040519150601f19603f3d011682016040523d82523d5f602084013e613dc2565b606091505b5091509150613dd2858383613e13565b95945050505050565b3415612ba5576040517fb398979f00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b606082613e2857613e2382613ea2565b61189c565b8151158015613e4c575073ffffffffffffffffffffffffffffffffffffffff84163b155b15613e9b576040517f9996b31500000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff8516600482015260240161147a565b508061189c565b805115613eb25780518082602001fd5b6040517fd6bda27500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b5f60208284031215613ef4575f5ffd5b81357fffffffff000000000000000000000000000000000000000000000000000000008116811461189c575f5ffd5b80356fffffffffffffffffffffffffffffffff81168114613f42575f5ffd5b919050565b5f60208284031215613f57575f5ffd5b61189c82613f23565b73ffffffffffffffffffffffffffffffffffffffff81168114611351575f5ffd5b5f60208284031215613f91575f5ffd5b813561189c81613f60565b8015158114611351575f5ffd5b5f60208284031215613fb9575f5ffd5b813561189c81613f9c565b5f60208284031215613fd4575f5ffd5b81356bffffffffffffffffffffffff8116811461189c575f5ffd5b5f5f5f60608486031215614001575f5ffd5b833561400c81613f60565b9250602084013561401c81613f60565b929592945050506040919091013590565b5f6020828403121561403d575f5ffd5b5035919050565b5f5f83601f840112614054575f5ffd5b50813567ffffffffffffffff81111561406b575f5ffd5b602083019150836020828501011115614082575f5ffd5b9250929050565b5f5f5f6040848603121561409b575f5ffd5b833567ffffffffffffffff8111156140b1575f5ffd5b6140bd86828701614044565b90945092506140d0905060208501613f23565b90509250925092565b5f5f604083850312156140ea575f5ffd5b8235915060208301356140fc81613f60565b809150509250929050565b5f5f60408385031215614118575f5ffd5b61412183613f23565b915060208301356140fc81613f60565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b5f5f6040838503121561416f575f5ffd5b823561417a81613f60565b9150602083013567ffffffffffffffff811115614195575f5ffd5b8301601f810185136141a5575f5ffd5b803567ffffffffffffffff8111156141bf576141bf614131565b6040517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0603f7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0601f8501160116810181811067ffffffffffffffff8211171561422b5761422b614131565b604052818152828201602001871015614242575f5ffd5b816020840160208301375f602083830101528093505050509250929050565b5f5f60408385031215614272575f5ffd5b823561412181613f60565b5f5f5f5f60808587031215614290575f5ffd5b843561429b81613f60565b935060208501356142ab81613f60565b925060408501356142bb81613f60565b9396929550929360600135925050565b5f5f5f606084860312156142dd575f5ffd5b83356142e881613f60565b925060208401356142f881613f60565b9150604084013561430881613f60565b809150509250925092565b5f5f83601f840112614323575f5ffd5b50813567ffffffffffffffff81111561433a575f5ffd5b6020830191508360208260051b8501011115614082575f5ffd5b5f5f5f5f5f5f60608789031215614369575f5ffd5b863567ffffffffffffffff81111561437f575f5ffd5b61438b89828a01614313565b909750955050602087013567ffffffffffffffff8111156143aa575f5ffd5b6143b689828a01614313565b909550935050604087013567ffffffffffffffff8111156143d5575f5ffd5b6143e189828a01614313565b979a9699509497509295939492505050565b5f5f60208385031215614404575f5ffd5b823567ffffffffffffffff81111561441a575f5ffd5b61442685828601614044565b90969095509350505050565b602081525f82518060208401528060208501604085015e5f6040828501015260407fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0601f83011684010191505092915050565b5f5f5f5f60408587031215614498575f5ffd5b843567ffffffffffffffff8111156144ae575f5ffd5b6144ba87828801614313565b909550935050602085013567ffffffffffffffff8111156144d9575f5ffd5b6144e587828801614313565b95989497509550505050565b5f60208284031215614501575f5ffd5b5051919050565b81835281816020850137505f602082840101525f60207fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0601f840116840101905092915050565b604081525f614562604083018587614508565b90506fffffffffffffffffffffffffffffffff83166020830152949350505050565b5f60208284031215614594575f5ffd5b815161189c81613f60565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52603260045260245ffd5b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601160045260245ffd5b80820180821115610b3a57610b3a6145cc565b81810381811115610b3a57610b3a6145cc565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52600160045260245ffd5b73ffffffffffffffffffffffffffffffffffffffff84168152604060208201525f613dd2604083018486614508565b5f6020828403121561468b575f5ffd5b815161189c81613f9c565b6fffffffffffffffffffffffffffffffff8181168382160190811115610b3a57610b3a6145cc565b5f6fffffffffffffffffffffffffffffffff82166fffffffffffffffffffffffffffffffff81036146f1576146f16145cc565b60010192915050565b6bffffffffffffffffffffffff8181168382160190811115610b3a57610b3a6145cc565b6fffffffffffffffffffffffffffffffff8281168282160390811115610b3a57610b3a6145cc565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601260045260245ffd5b5f82518060208501845e5f92019182525091905056fea2646970667358221220a36f40e8f056d9f3a6a4a8a25a67a8cf4b74637f876e17248f38e64bc5b09fab64736f6c634300081c0033
Loading...
Loading
Loading...
Loading
Multichain Portfolio | 34 Chains
| Chain | Token | Portfolio % | Price | Amount | Value |
|---|
Loading...
Loading
Loading...
Loading
A contract address hosts a smart contract, which is a set of code stored on the blockchain that runs when predetermined conditions are met. Learn more about addresses in our Knowledge Base.