Source Code
Overview
ETH Balance
0 ETH
Eth Value
$0.00View more zero value Internal Transactions in Advanced View mode
Advanced mode:
Loading...
Loading
Loading...
Loading
Cross-Chain Transactions
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 Name:
FuelERC20GatewayV4
Compiler Version
v0.8.9+commit.e5eed63a
Optimization Enabled:
Yes with 10000 runs
Other Settings:
default evmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: Apache-2.0
pragma solidity 0.8.9;
import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import {AccessControlUpgradeable} from "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
import {PausableUpgradeable} from "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";
import {IERC20MetadataUpgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/IERC20MetadataUpgradeable.sol";
import {SafeERC20Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
import {CommonPredicates} from "../../../lib/CommonPredicates.sol";
import {FuelMessagePortal} from "../../../fuelchain/FuelMessagePortal.sol";
import {FuelBridgeBase} from "../FuelBridgeBase/FuelBridgeBase.sol";
import {FuelMessagesEnabledUpgradeable} from "../../FuelMessagesEnabledUpgradeable.sol";
/// @title FuelERC20GatewayV4
/// @notice The L1 side of the general ERC20 gateway with Fuel.
/// @notice Not backwards compatible with previous implementations
/// @notice Hexens Fuel1-12: Not compatible with fee-on-transfer erc20 tokens
/// @notice Hexens Fuel1-18: Payable modifiers are intentionally used
contract FuelERC20GatewayV4 is
Initializable,
FuelBridgeBase,
FuelMessagesEnabledUpgradeable,
PausableUpgradeable,
AccessControlUpgradeable,
UUPSUpgradeable
{
using SafeERC20Upgradeable for IERC20MetadataUpgradeable;
////////////
// Types //
////////////
error BridgeFull();
error GlobalDepositLimit();
error CannotDepositZero();
error CannotWithdrawZero();
error InvalidAssetIssuerID();
error InvalidSender();
error InvalidAmount();
error RateLimitExceeded();
/// @dev Emitted when tokens are deposited from Ethereum to Fuel
event Deposit(bytes32 indexed sender, address indexed tokenAddress, uint256 amount);
/// @dev Emitted when tokens are withdrawn from Fuel to Ethereum
event Withdrawal(bytes32 indexed recipient, address indexed tokenAddress, uint256 amount);
/// @dev Emitted when rate limit is reset
event RateLimitUpdated(address indexed tokenAddress, uint256 amount);
/// @dev Emitted when rate limit is enabled/disabled
event RateLimitStatusUpdated(address indexed tokenAddress, bool status);
enum MessageType {
DEPOSIT_TO_ADDRESS,
DEPOSIT_TO_CONTRACT,
DEPOSIT_WITH_DATA,
METADATA
}
///////////////
// Constants //
///////////////
/// @dev The admin related contract roles
bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");
/// @dev The rate limit setter role
bytes32 public constant SET_RATE_LIMITER_ROLE = keccak256("SET_RATE_LIMITER_ROLE");
uint256 public constant FUEL_ASSET_DECIMALS = 9;
uint256 constant NO_DECIMALS = type(uint256).max;
/////////////
// Storage //
/////////////
bool public whitelistRequired;
bytes32 public assetIssuerId;
mapping(address => uint256) internal _deposits;
mapping(address => uint256) internal _depositLimits;
mapping(address => uint256) internal _decimalsCache;
/// @notice Tracks rate limit duration for each token.
mapping(address => uint256) public rateLimitDuration;
/// @notice Amounts already withdrawn this period for each token.
mapping(address => uint256) public currentPeriodAmount;
/// @notice The time at which the current period ends at for each token.
mapping(address => uint256) public currentPeriodEnd;
/// @notice The eth withdrawal limit amount for each token.
mapping(address => uint256) public limitAmount;
/// @notice Flag to indicate rate limit status for each token, whether disabled or enabled.
// if `true` it is enabled
// if `false` it is disabled
mapping(address => bool) public rateLimitStatus;
/// @notice disabling initialization
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
/// @notice Contract initializer to setup starting values
/// @param fuelMessagePortal The FuelMessagePortal contract
function initialize(FuelMessagePortal fuelMessagePortal) public initializer {
__FuelMessagesEnabled_init(fuelMessagePortal);
__Pausable_init();
__AccessControl_init();
__UUPSUpgradeable_init();
//grant initial roles
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(PAUSER_ROLE, msg.sender);
// set rate limiter role
_grantRole(SET_RATE_LIMITER_ROLE, msg.sender);
}
/////////////////////
// Admin Functions //
/////////////////////
/// @notice Pause ERC20 transfers
function pause() external onlyRole(PAUSER_ROLE) {
_pause();
}
/// @notice Unpause ERC20 transfers
function unpause() external onlyRole(DEFAULT_ADMIN_ROLE) {
_unpause();
}
/// @notice sets the entity on L2 that will mint the tokens
function setAssetIssuerId(bytes32 id) external payable virtual onlyRole(DEFAULT_ADMIN_ROLE) {
assetIssuerId = id;
}
/// @notice if enabled, only deposits for tokens allowed through `setGlobalDepositLimit` will be allowed
function requireWhitelist(bool value) external onlyRole(DEFAULT_ADMIN_ROLE) {
whitelistRequired = value;
}
/// @notice see `requireWhitelist`
/// @dev param `limit` must be down/up scaled according to _adjustDepositDecimals
function setGlobalDepositLimit(address token, uint256 limit) external payable virtual onlyRole(DEFAULT_ADMIN_ROLE) {
_depositLimits[token] = limit;
}
/// @notice Allows the admin to rescue ETH sent to this contract by accident
/// @dev Made payable to reduce gas costs
function rescueETH() external payable virtual onlyRole(DEFAULT_ADMIN_ROLE) {
(bool success, ) = address(msg.sender).call{value: address(this).balance}("");
require(success);
}
/**
* @notice Resets the rate limit amount.
* @param _token The token address to set rate limit for.
* @param _amount The amount to reset the limit to.
* @param _rateLimitDuration The new rate limit duration.
* Fuel's implementation is inspired by the Linea Bridge dessign (https://github.com/Consensys/linea-contracts/blob/main/contracts/messageService/lib/RateLimiter.sol)
* Only point of difference from the linea implementation is that when currentPeriodEnd >= block.timestamp then if the new rate limit amount is less than the currentPeriodAmount, then currentPeriodAmount is not updated this makes sure that if rate limit is first reduced & then increased within the rate limit duration then any extra amount can't be withdrawn
*/
function resetRateLimitAmount(
address _token,
uint256 _amount,
uint256 _rateLimitDuration
) external onlyRole(SET_RATE_LIMITER_ROLE) {
// avoid multiple SLOADS
uint256 rateLimitDurationEndTimestamp = currentPeriodEnd[_token];
// set new rate limit duration
rateLimitDuration[_token] = _rateLimitDuration;
// if period has expired then currentPeriodAmount is zero
if (rateLimitDurationEndTimestamp < block.timestamp) {
unchecked {
currentPeriodEnd[_token] = block.timestamp + _rateLimitDuration;
}
currentPeriodAmount[_token] = 0;
}
limitAmount[_token] = _amount;
emit RateLimitUpdated(_token, _amount);
}
/**
* @notice updates rate limit status by disabling/re-enabling rate limit.
* @param _token The token address to update rate limit status for.
* @param _rateLimitStatus bool flag to disable or re-enable rate limit.
*/
function updateRateLimitStatus(address _token, bool _rateLimitStatus) external onlyRole(SET_RATE_LIMITER_ROLE) {
rateLimitStatus[_token] = _rateLimitStatus;
emit RateLimitStatusUpdated(_token, _rateLimitStatus);
}
//////////////////////
// Public Functions //
//////////////////////
/// @notice Gets the amount of tokens deposited to a corresponding token on Fuel
/// @param tokenAddress ERC-20 token address
/// @return amount of tokens deposited
function tokensDeposited(address tokenAddress) public view virtual returns (uint256) {
return _deposits[tokenAddress];
}
/// @notice Gets the amount of tokens deposited to a corresponding token on Fuel
/// @param tokenAddress ERC-20 token address
/// @return amount of tokens deposited
function depositLimits(address tokenAddress) public view virtual returns (uint256) {
return _depositLimits[tokenAddress];
}
/// @notice Deposits the given tokens to an account on Fuel
/// @param to Fuel address to deposit tokens to
/// @param tokenAddress Address of the token being transferred to Fuel
/// @param amount Amount of tokens to deposit
/// @dev Made payable to reduce gas costs
function deposit(bytes32 to, address tokenAddress, uint256 amount) external payable virtual whenNotPaused {
if (assetIssuerId == bytes32(0)) revert InvalidAssetIssuerID();
uint8 decimals = _getTokenDecimals(tokenAddress);
uint256 l2MintedAmount = _adjustDepositDecimals(decimals, amount);
bytes memory depositMessage = abi.encodePacked(
assetIssuerId,
uint256(MessageType.DEPOSIT_TO_ADDRESS),
bytes32(uint256(uint160(tokenAddress))),
uint256(0), // token_id = 0 for all erc20 deposits
bytes32(uint256(uint160(msg.sender))),
to,
l2MintedAmount,
uint256(decimals)
);
_deposit(tokenAddress, amount, l2MintedAmount, depositMessage);
}
/// @notice Deposits the given tokens to a contract on Fuel with optional data
/// @param to Fuel account or contract to deposit tokens to
/// @param tokenAddress Address of the token being transferred to Fuel
/// @param amount Amount of tokens to deposit
/// @param data Optional data to send with the deposit
/// @dev Made payable to reduce gas costs
function depositWithData(
bytes32 to,
address tokenAddress,
uint256 amount,
bytes calldata data
) external payable virtual whenNotPaused {
if (assetIssuerId == bytes32(0)) revert InvalidAssetIssuerID();
uint8 decimals = _getTokenDecimals(tokenAddress);
uint256 l2MintedAmount = _adjustDepositDecimals(decimals, amount);
bytes memory depositMessage = abi.encodePacked(
assetIssuerId,
uint256(data.length == 0 ? MessageType.DEPOSIT_TO_CONTRACT : MessageType.DEPOSIT_WITH_DATA),
bytes32(uint256(uint160(tokenAddress))),
uint256(0), // token_id = 0 for all erc20 deposits
bytes32(uint256(uint160(msg.sender))),
to,
l2MintedAmount,
uint256(decimals),
data
);
_deposit(tokenAddress, amount, l2MintedAmount, depositMessage);
}
function sendMetadata(address tokenAddress) external payable virtual whenNotPaused {
if (assetIssuerId == bytes32(0)) revert InvalidAssetIssuerID();
bytes memory metadataMessage = abi.encodePacked(
assetIssuerId,
uint256(MessageType.METADATA),
abi.encode(
tokenAddress,
uint256(0), // token_id = 0 for all erc20 deposits
IERC20MetadataUpgradeable(tokenAddress).name(),
IERC20MetadataUpgradeable(tokenAddress).symbol()
)
);
sendMessage(CommonPredicates.CONTRACT_MESSAGE_PREDICATE, metadataMessage);
}
/// @notice Finalizes the withdrawal process from the Fuel side gateway contract
/// @param to Account to send withdrawn tokens to
/// @param tokenAddress Address of the token being withdrawn from Fuel
/// @param l2BurntAmount Amount of tokens to withdraw
/// @dev Made payable to reduce gas costs
function finalizeWithdrawal(
address to,
address tokenAddress,
uint256 l2BurntAmount,
uint256 /*tokenId*/
) external payable virtual override whenNotPaused onlyFromPortal {
if (l2BurntAmount == 0) {
revert CannotWithdrawZero();
}
if (messageSender() != assetIssuerId) {
revert InvalidSender();
}
uint8 decimals = _getTokenDecimals(tokenAddress);
uint256 amount = _adjustWithdrawalDecimals(decimals, l2BurntAmount);
// rate limit check is only performed when it is enabled
// if the rate limit has not been initialised then the tx will revert with `RateLimitExceeded()`
if (rateLimitStatus[tokenAddress]) _addWithdrawnAmount(tokenAddress, amount);
//reduce deposit balance and transfer tokens (math will underflow if amount is larger than allowed)
_deposits[tokenAddress] = _deposits[tokenAddress] - l2BurntAmount;
IERC20MetadataUpgradeable(tokenAddress).safeTransfer(to, amount);
//emit event for successful token withdraw
emit Withdrawal(bytes32(uint256(uint160(to))), tokenAddress, amount);
}
/// @notice Deposits the given tokens to an account or contract on Fuel
/// @param tokenAddress Address of the token being transferred to Fuel
/// @param amount tokens that have been deposited
/// @param l2MintedAmount tokens that will be minted on L2
/// @param messageData The data of the message to send for deposit
/// @dev Hexens 1-12: Not compatible with fee-on-transfer tokens
function _deposit(
address tokenAddress,
uint256 amount,
uint256 l2MintedAmount,
bytes memory messageData
) internal virtual {
////////////
// Checks //
////////////
if (l2MintedAmount == 0) revert CannotDepositZero();
if (l2MintedAmount > uint256(type(uint64).max)) revert InvalidAmount();
/////////////
// Effects //
/////////////
uint256 updatedDeposits = _deposits[tokenAddress] + l2MintedAmount;
if (updatedDeposits > type(uint64).max) revert BridgeFull();
if (whitelistRequired && updatedDeposits > _depositLimits[tokenAddress]) {
revert GlobalDepositLimit();
}
_deposits[tokenAddress] = updatedDeposits;
/////////////
// Actions //
/////////////
//send message to gateway on Fuel to finalize the deposit
sendMessage(CommonPredicates.CONTRACT_MESSAGE_PREDICATE, messageData);
//transfer tokens to this contract and update deposit balance
IERC20MetadataUpgradeable(tokenAddress).safeTransferFrom(msg.sender, address(this), amount);
//emit event for successful token deposit
emit Deposit(bytes32(uint256(uint160(msg.sender))), tokenAddress, amount);
}
function _getTokenDecimals(address tokenAddress) internal virtual returns (uint8) {
uint256 decimals = _decimalsCache[tokenAddress];
if (decimals == 0) {
try IERC20MetadataUpgradeable(tokenAddress).decimals() returns (uint8 returnedDecimals) {
_decimalsCache[tokenAddress] = returnedDecimals == 0 ? NO_DECIMALS : returnedDecimals;
return returnedDecimals;
} catch {
_decimalsCache[tokenAddress] = NO_DECIMALS;
return 0;
}
}
if (decimals == NO_DECIMALS) return 0;
return uint8(decimals);
}
function _adjustDepositDecimals(uint8 tokenDecimals, uint256 amount) internal pure virtual returns (uint256) {
if (tokenDecimals > FUEL_ASSET_DECIMALS) {
unchecked {
uint256 precision = 10 ** (tokenDecimals - FUEL_ASSET_DECIMALS);
if (amount % precision != 0) {
revert InvalidAmount();
}
return _divByNonZero(amount, precision);
}
}
return amount;
}
function _adjustWithdrawalDecimals(uint8 tokenDecimals, uint256 amount) internal pure virtual returns (uint256) {
if (tokenDecimals > FUEL_ASSET_DECIMALS) {
uint256 precision = 10 ** (tokenDecimals - FUEL_ASSET_DECIMALS);
return amount * precision;
}
return amount;
}
/// @dev gas efficient division. Must be used with care, `_div` must be non zero
function _divByNonZero(uint256 _num, uint256 _div) internal pure returns (uint256 result) {
assembly {
result := div(_num, _div)
}
}
/// @notice Executes a message in the given header
// solhint-disable-next-line no-empty-blocks
function _authorizeUpgrade(address newImplementation) internal override onlyRole(DEFAULT_ADMIN_ROLE) {
//should revert if msg.sender is not authorized to upgrade the contract (currently only owner)
}
/**
* @notice Increments the amount withdrawn in the period.
* @dev Reverts if the withdrawn limit is breached.
* @param _token Token address to update withdrawn amount for.
* @param _withdrawnAmount The amount withdrawn to be added.
*/
function _addWithdrawnAmount(address _token, uint256 _withdrawnAmount) internal {
uint256 currentPeriodAmountTemp;
if (currentPeriodEnd[_token] < block.timestamp) {
unchecked {
currentPeriodEnd[_token] = block.timestamp + rateLimitDuration[_token];
}
currentPeriodAmountTemp = _withdrawnAmount;
} else {
unchecked {
currentPeriodAmountTemp = currentPeriodAmount[_token] + _withdrawnAmount;
}
}
if (currentPeriodAmountTemp > limitAmount[_token]) {
revert RateLimitExceeded();
}
currentPeriodAmount[_token] = currentPeriodAmountTemp;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[48] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (access/AccessControl.sol)
pragma solidity ^0.8.0;
import "./IAccessControlUpgradeable.sol";
import "../utils/ContextUpgradeable.sol";
import "../utils/StringsUpgradeable.sol";
import "../utils/introspection/ERC165Upgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module that allows children to implement role-based access
* control mechanisms. This is a lightweight version that doesn't allow enumerating role
* members except through off-chain means by accessing the contract event logs. Some
* applications may benefit from on-chain enumerability, for those cases see
* {AccessControlEnumerable}.
*
* Roles are referred to by their `bytes32` identifier. These should be exposed
* in the external API and be unique. The best way to achieve this is by
* using `public constant` hash digests:
*
* ```solidity
* bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
* ```
*
* Roles can be used to represent a set of permissions. To restrict access to a
* function call, use {hasRole}:
*
* ```solidity
* function foo() public {
* require(hasRole(MY_ROLE, msg.sender));
* ...
* }
* ```
*
* Roles can be granted and revoked dynamically via the {grantRole} and
* {revokeRole} functions. Each role has an associated admin role, and only
* accounts that have a role's admin role can call {grantRole} and {revokeRole}.
*
* By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
* that only accounts with this role will be able to grant or revoke other
* roles. More complex role relationships can be created by using
* {_setRoleAdmin}.
*
* WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
* grant and revoke this role. Extra precautions should be taken to secure
* accounts that have been granted it. We recommend using {AccessControlDefaultAdminRules}
* to enforce additional security measures for this role.
*/
abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable, IAccessControlUpgradeable, ERC165Upgradeable {
struct RoleData {
mapping(address => bool) members;
bytes32 adminRole;
}
mapping(bytes32 => RoleData) private _roles;
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
/**
* @dev Modifier that checks that an account has a specific role. Reverts
* with a standardized message including the required role.
*
* The format of the revert reason is given by the following regular expression:
*
* /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
*
* _Available since v4.1._
*/
modifier onlyRole(bytes32 role) {
_checkRole(role);
_;
}
function __AccessControl_init() internal onlyInitializing {
}
function __AccessControl_init_unchained() internal onlyInitializing {
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IAccessControlUpgradeable).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) public view virtual override returns (bool) {
return _roles[role].members[account];
}
/**
* @dev Revert with a standard message if `_msgSender()` is missing `role`.
* Overriding this function changes the behavior of the {onlyRole} modifier.
*
* Format of the revert message is described in {_checkRole}.
*
* _Available since v4.6._
*/
function _checkRole(bytes32 role) internal view virtual {
_checkRole(role, _msgSender());
}
/**
* @dev Revert with a standard message if `account` is missing `role`.
*
* The format of the revert reason is given by the following regular expression:
*
* /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
*/
function _checkRole(bytes32 role, address account) internal view virtual {
if (!hasRole(role, account)) {
revert(
string(
abi.encodePacked(
"AccessControl: account ",
StringsUpgradeable.toHexString(account),
" is missing role ",
StringsUpgradeable.toHexString(uint256(role), 32)
)
)
);
}
}
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) public view virtual override returns (bytes32) {
return _roles[role].adminRole;
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleGranted} event.
*/
function grantRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {
_grantRole(role, account);
}
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleRevoked} event.
*/
function revokeRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {
_revokeRole(role, account);
}
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been revoked `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `account`.
*
* May emit a {RoleRevoked} event.
*/
function renounceRole(bytes32 role, address account) public virtual override {
require(account == _msgSender(), "AccessControl: can only renounce roles for self");
_revokeRole(role, account);
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event. Note that unlike {grantRole}, this function doesn't perform any
* checks on the calling account.
*
* May emit a {RoleGranted} event.
*
* [WARNING]
* ====
* This function should only be called from the constructor when setting
* up the initial roles for the system.
*
* Using this function in any other way is effectively circumventing the admin
* system imposed by {AccessControl}.
* ====
*
* NOTE: This function is deprecated in favor of {_grantRole}.
*/
function _setupRole(bytes32 role, address account) internal virtual {
_grantRole(role, account);
}
/**
* @dev Sets `adminRole` as ``role``'s admin role.
*
* Emits a {RoleAdminChanged} event.
*/
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
bytes32 previousAdminRole = getRoleAdmin(role);
_roles[role].adminRole = adminRole;
emit RoleAdminChanged(role, previousAdminRole, adminRole);
}
/**
* @dev Grants `role` to `account`.
*
* Internal function without access restriction.
*
* May emit a {RoleGranted} event.
*/
function _grantRole(bytes32 role, address account) internal virtual {
if (!hasRole(role, account)) {
_roles[role].members[account] = true;
emit RoleGranted(role, account, _msgSender());
}
}
/**
* @dev Revokes `role` from `account`.
*
* Internal function without access restriction.
*
* May emit a {RoleRevoked} event.
*/
function _revokeRole(bytes32 role, address account) internal virtual {
if (hasRole(role, account)) {
_roles[role].members[account] = false;
emit RoleRevoked(role, account, _msgSender());
}
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (access/IAccessControl.sol)
pragma solidity ^0.8.0;
/**
* @dev External interface of AccessControl declared to support ERC165 detection.
*/
interface IAccessControlUpgradeable {
/**
* @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
*
* `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
* {RoleAdminChanged} not being emitted signaling this.
*
* _Available since v3.1._
*/
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
/**
* @dev Emitted when `account` is granted `role`.
*
* `sender` is the account that originated the contract call, an admin role
* bearer except when using {AccessControl-_setupRole}.
*/
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Emitted when `account` is revoked `role`.
*
* `sender` is the account that originated the contract call:
* - if using `revokeRole`, it is the admin role bearer
* - if using `renounceRole`, it is the role bearer (i.e. `account`)
*/
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) external view returns (bool);
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {AccessControl-_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) external view returns (bytes32);
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function grantRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function revokeRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been granted `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `account`.
*/
function renounceRole(bytes32 role, address account) external;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (interfaces/draft-IERC1822.sol)
pragma solidity ^0.8.0;
/**
* @dev ERC1822: Universal Upgradeable Proxy Standard (UUPS) documents a method for upgradeability through a simplified
* proxy whose upgrades are fully controlled by the current implementation.
*/
interface IERC1822ProxiableUpgradeable {
/**
* @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 v4.9.0) (interfaces/IERC1967.sol)
pragma solidity ^0.8.0;
/**
* @dev ERC-1967: Proxy Storage Slots. This interface contains the events defined in the ERC.
*
* _Available since v4.8.3._
*/
interface IERC1967Upgradeable {
/**
* @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 v4.4.1 (proxy/beacon/IBeacon.sol)
pragma solidity ^0.8.0;
/**
* @dev This is the interface that {BeaconProxy} expects of its beacon.
*/
interface IBeaconUpgradeable {
/**
* @dev Must return an address that can be used as a delegate call target.
*
* {BeaconProxy} will check that this address is a contract.
*/
function implementation() external view returns (address);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (proxy/ERC1967/ERC1967Upgrade.sol)
pragma solidity ^0.8.2;
import "../beacon/IBeaconUpgradeable.sol";
import "../../interfaces/IERC1967Upgradeable.sol";
import "../../interfaces/draft-IERC1822Upgradeable.sol";
import "../../utils/AddressUpgradeable.sol";
import "../../utils/StorageSlotUpgradeable.sol";
import {Initializable} from "../utils/Initializable.sol";
/**
* @dev This abstract contract provides getters and event emitting update functions for
* https://eips.ethereum.org/EIPS/eip-1967[EIP1967] slots.
*
* _Available since v4.1._
*/
abstract contract ERC1967UpgradeUpgradeable is Initializable, IERC1967Upgradeable {
// This is the keccak-256 hash of "eip1967.proxy.rollback" subtracted by 1
bytes32 private constant _ROLLBACK_SLOT = 0x4910fdfa16fed3260ed0e7147f7cc6da11a60208b5b9406d12a635614ffd9143;
/**
* @dev Storage slot with the address of the current implementation.
* This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1, and is
* validated in the constructor.
*/
bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
function __ERC1967Upgrade_init() internal onlyInitializing {
}
function __ERC1967Upgrade_init_unchained() internal onlyInitializing {
}
/**
* @dev Returns the current implementation address.
*/
function _getImplementation() internal view returns (address) {
return StorageSlotUpgradeable.getAddressSlot(_IMPLEMENTATION_SLOT).value;
}
/**
* @dev Stores a new address in the EIP1967 implementation slot.
*/
function _setImplementation(address newImplementation) private {
require(AddressUpgradeable.isContract(newImplementation), "ERC1967: new implementation is not a contract");
StorageSlotUpgradeable.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
}
/**
* @dev Perform implementation upgrade
*
* Emits an {Upgraded} event.
*/
function _upgradeTo(address newImplementation) internal {
_setImplementation(newImplementation);
emit Upgraded(newImplementation);
}
/**
* @dev Perform implementation upgrade with additional setup call.
*
* Emits an {Upgraded} event.
*/
function _upgradeToAndCall(address newImplementation, bytes memory data, bool forceCall) internal {
_upgradeTo(newImplementation);
if (data.length > 0 || forceCall) {
AddressUpgradeable.functionDelegateCall(newImplementation, data);
}
}
/**
* @dev Perform implementation upgrade with security checks for UUPS proxies, and additional setup call.
*
* Emits an {Upgraded} event.
*/
function _upgradeToAndCallUUPS(address newImplementation, bytes memory data, bool forceCall) internal {
// Upgrades from old implementations will perform a rollback test. This test requires the new
// implementation to upgrade back to the old, non-ERC1822 compliant, implementation. Removing
// this special case will break upgrade paths from old UUPS implementation to new ones.
if (StorageSlotUpgradeable.getBooleanSlot(_ROLLBACK_SLOT).value) {
_setImplementation(newImplementation);
} else {
try IERC1822ProxiableUpgradeable(newImplementation).proxiableUUID() returns (bytes32 slot) {
require(slot == _IMPLEMENTATION_SLOT, "ERC1967Upgrade: unsupported proxiableUUID");
} catch {
revert("ERC1967Upgrade: new implementation is not UUPS");
}
_upgradeToAndCall(newImplementation, data, forceCall);
}
}
/**
* @dev Storage slot with the admin of the contract.
* This is the keccak-256 hash of "eip1967.proxy.admin" subtracted by 1, and is
* validated in the constructor.
*/
bytes32 internal constant _ADMIN_SLOT = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103;
/**
* @dev Returns the current admin.
*/
function _getAdmin() internal view returns (address) {
return StorageSlotUpgradeable.getAddressSlot(_ADMIN_SLOT).value;
}
/**
* @dev Stores a new address in the EIP1967 admin slot.
*/
function _setAdmin(address newAdmin) private {
require(newAdmin != address(0), "ERC1967: new admin is the zero address");
StorageSlotUpgradeable.getAddressSlot(_ADMIN_SLOT).value = newAdmin;
}
/**
* @dev Changes the admin of the proxy.
*
* Emits an {AdminChanged} event.
*/
function _changeAdmin(address newAdmin) internal {
emit AdminChanged(_getAdmin(), newAdmin);
_setAdmin(newAdmin);
}
/**
* @dev The storage slot of the UpgradeableBeacon contract which defines the implementation for this proxy.
* This is bytes32(uint256(keccak256('eip1967.proxy.beacon')) - 1)) and is validated in the constructor.
*/
bytes32 internal constant _BEACON_SLOT = 0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50;
/**
* @dev Returns the current beacon.
*/
function _getBeacon() internal view returns (address) {
return StorageSlotUpgradeable.getAddressSlot(_BEACON_SLOT).value;
}
/**
* @dev Stores a new beacon in the EIP1967 beacon slot.
*/
function _setBeacon(address newBeacon) private {
require(AddressUpgradeable.isContract(newBeacon), "ERC1967: new beacon is not a contract");
require(
AddressUpgradeable.isContract(IBeaconUpgradeable(newBeacon).implementation()),
"ERC1967: beacon implementation is not a contract"
);
StorageSlotUpgradeable.getAddressSlot(_BEACON_SLOT).value = newBeacon;
}
/**
* @dev Perform beacon upgrade with additional setup call. Note: This upgrades the address of the beacon, it does
* not upgrade the implementation contained in the beacon (see {UpgradeableBeacon-_setImplementation} for that).
*
* Emits a {BeaconUpgraded} event.
*/
function _upgradeBeaconToAndCall(address newBeacon, bytes memory data, bool forceCall) internal {
_setBeacon(newBeacon);
emit BeaconUpgraded(newBeacon);
if (data.length > 0 || forceCall) {
AddressUpgradeable.functionDelegateCall(IBeaconUpgradeable(newBeacon).implementation(), data);
}
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.2;
import "../../utils/AddressUpgradeable.sol";
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```solidity
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
*
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Indicates that the contract has been initialized.
* @custom:oz-retyped-from bool
*/
uint8 private _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private _initializing;
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint8 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts.
*
* Similar to `reinitializer(1)`, except that functions marked with `initializer` can be nested in the context of a
* constructor.
*
* Emits an {Initialized} event.
*/
modifier initializer() {
bool isTopLevelCall = !_initializing;
require(
(isTopLevelCall && _initialized < 1) || (!AddressUpgradeable.isContract(address(this)) && _initialized == 1),
"Initializable: contract is already initialized"
);
_initialized = 1;
if (isTopLevelCall) {
_initializing = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* A reinitializer may be used after the original initialization step. This is essential to configure modules that
* are added through upgrades and that require initialization.
*
* When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
* cannot be nested. If one is invoked in the context of another, execution will revert.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*
* WARNING: setting the version to 255 will prevent any future reinitialization.
*
* Emits an {Initialized} event.
*/
modifier reinitializer(uint8 version) {
require(!_initializing && _initialized < version, "Initializable: contract is already initialized");
_initialized = version;
_initializing = true;
_;
_initializing = false;
emit Initialized(version);
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
require(_initializing, "Initializable: contract is not initializing");
_;
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*
* Emits an {Initialized} event the first time it is successfully executed.
*/
function _disableInitializers() internal virtual {
require(!_initializing, "Initializable: contract is initializing");
if (_initialized != type(uint8).max) {
_initialized = type(uint8).max;
emit Initialized(type(uint8).max);
}
}
/**
* @dev Returns the highest version that has been initialized. See {reinitializer}.
*/
function _getInitializedVersion() internal view returns (uint8) {
return _initialized;
}
/**
* @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
*/
function _isInitializing() internal view returns (bool) {
return _initializing;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (proxy/utils/UUPSUpgradeable.sol)
pragma solidity ^0.8.0;
import "../../interfaces/draft-IERC1822Upgradeable.sol";
import "../ERC1967/ERC1967UpgradeUpgradeable.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.
*
* _Available since v4.1._
*/
abstract contract UUPSUpgradeable is Initializable, IERC1822ProxiableUpgradeable, ERC1967UpgradeUpgradeable {
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment
address private immutable __self = address(this);
/**
* @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 ERC1967) 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 ERC1167 minimal proxies (clones) would not normally pass this test, but is not guaranteed to
* fail.
*/
modifier onlyProxy() {
require(address(this) != __self, "Function must be called through delegatecall");
require(_getImplementation() == __self, "Function must be called through active proxy");
_;
}
/**
* @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() {
require(address(this) == __self, "UUPSUpgradeable: must not be called through delegatecall");
_;
}
function __UUPSUpgradeable_init() internal onlyInitializing {
}
function __UUPSUpgradeable_init_unchained() internal onlyInitializing {
}
/**
* @dev Implementation of the ERC1822 {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 override notDelegated returns (bytes32) {
return _IMPLEMENTATION_SLOT;
}
/**
* @dev Upgrade the implementation of the proxy to `newImplementation`.
*
* Calls {_authorizeUpgrade}.
*
* Emits an {Upgraded} event.
*
* @custom:oz-upgrades-unsafe-allow-reachable delegatecall
*/
function upgradeTo(address newImplementation) public virtual onlyProxy {
_authorizeUpgrade(newImplementation);
_upgradeToAndCallUUPS(newImplementation, new bytes(0), false);
}
/**
* @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, true);
}
/**
* @dev Function that should revert when `msg.sender` is not authorized to upgrade the contract. Called by
* {upgradeTo} and {upgradeToAndCall}.
*
* Normally, this function will use an xref:access.adoc[access control] modifier such as {Ownable-onlyOwner}.
*
* ```solidity
* function _authorizeUpgrade(address) internal override onlyOwner {}
* ```
*/
function _authorizeUpgrade(address newImplementation) internal virtual;
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (security/Pausable.sol)
pragma solidity ^0.8.0;
import "../utils/ContextUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module which allows children to implement an emergency stop
* mechanism that can be triggered by an authorized account.
*
* This module is used through inheritance. It will make available the
* modifiers `whenNotPaused` and `whenPaused`, which can be applied to
* the functions of your contract. Note that they will not be pausable by
* simply including this module, only once the modifiers are put in place.
*/
abstract contract PausableUpgradeable is Initializable, ContextUpgradeable {
/**
* @dev Emitted when the pause is triggered by `account`.
*/
event Paused(address account);
/**
* @dev Emitted when the pause is lifted by `account`.
*/
event Unpaused(address account);
bool private _paused;
/**
* @dev Initializes the contract in unpaused state.
*/
function __Pausable_init() internal onlyInitializing {
__Pausable_init_unchained();
}
function __Pausable_init_unchained() internal onlyInitializing {
_paused = false;
}
/**
* @dev Modifier to make a function callable only when the contract is not paused.
*
* Requirements:
*
* - The contract must not be paused.
*/
modifier whenNotPaused() {
_requireNotPaused();
_;
}
/**
* @dev Modifier to make a function callable only when the contract is paused.
*
* Requirements:
*
* - The contract must be paused.
*/
modifier whenPaused() {
_requirePaused();
_;
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/
function paused() public view virtual returns (bool) {
return _paused;
}
/**
* @dev Throws if the contract is paused.
*/
function _requireNotPaused() internal view virtual {
require(!paused(), "Pausable: paused");
}
/**
* @dev Throws if the contract is not paused.
*/
function _requirePaused() internal view virtual {
require(paused(), "Pausable: not paused");
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/
function _pause() internal virtual whenNotPaused {
_paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
_paused = false;
emit Unpaused(_msgSender());
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuardUpgradeable is Initializable {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant _NOT_ENTERED = 1;
uint256 private constant _ENTERED = 2;
uint256 private _status;
function __ReentrancyGuard_init() internal onlyInitializing {
__ReentrancyGuard_init_unchained();
}
function __ReentrancyGuard_init_unchained() internal onlyInitializing {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _status == _ENTERED;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.0;
import "../IERC20Upgradeable.sol";
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*
* _Available since v4.1._
*/
interface IERC20MetadataUpgradeable is IERC20Upgradeable {
/**
* @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 v4.9.4) (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*
* ==== Security Considerations
*
* There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
* expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
* considered as an intention to spend the allowance in any specific way. The second is that because permits have
* built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
* take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
* generally recommended is:
*
* ```solidity
* function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
* try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
* doThing(..., value);
* }
*
* function doThing(..., uint256 value) public {
* token.safeTransferFrom(msg.sender, address(this), value);
* ...
* }
* ```
*
* Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
* `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
* {SafeERC20-safeTransferFrom}).
*
* Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
* contracts should have entry points that don't rely on permit.
*/
interface IERC20PermitUpgradeable {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*
* CAUTION: See Security Considerations above.
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20Upgradeable {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 amount) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.3) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "../IERC20Upgradeable.sol";
import "../extensions/IERC20PermitUpgradeable.sol";
import "../../../utils/AddressUpgradeable.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20Upgradeable {
using AddressUpgradeable for address;
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20Upgradeable token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20Upgradeable token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/
function safeApprove(IERC20Upgradeable token, address spender, uint256 value) internal {
// safeApprove should only be called when setting an initial allowance,
// or when resetting it to zero. To increase and decrease it, use
// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
require(
(value == 0) || (token.allowance(address(this), spender) == 0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeIncreaseAllowance(IERC20Upgradeable token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance + value));
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeDecreaseAllowance(IERC20Upgradeable token, address spender, uint256 value) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance - value));
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*/
function forceApprove(IERC20Upgradeable token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeWithSelector(token.approve.selector, spender, value);
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, 0));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Use a ERC-2612 signature to set the `owner` approval toward `spender` on `token`.
* Revert on invalid signature.
*/
function safePermit(
IERC20PermitUpgradeable token,
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal {
uint256 nonceBefore = token.nonces(owner);
token.permit(owner, spender, value, deadline, v, r, s);
uint256 nonceAfter = token.nonces(owner);
require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20Upgradeable token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
require(returndata.length == 0 || abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20Upgradeable token, bytes memory data) private returns (bool) {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false
// and not revert is the subcall reverts.
(bool success, bytes memory returndata) = address(token).call(data);
return
success && (returndata.length == 0 || abi.decode(returndata, (bool))) && AddressUpgradeable.isContract(address(token));
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library AddressUpgradeable {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
*
* Furthermore, `isContract` will also return true if the target contract within
* the same transaction is already scheduled for destruction by `SELFDESTRUCT`,
* which only has an effect at the end of a transaction.
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.8.0/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.4) (utils/Context.sol)
pragma solidity ^0.8.0;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract ContextUpgradeable is Initializable {
function __Context_init() internal onlyInitializing {
}
function __Context_init_unchained() internal onlyInitializing {
}
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)
pragma solidity ^0.8.0;
import "./IERC165Upgradeable.sol";
import {Initializable} from "../../proxy/utils/Initializable.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*
* Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
*/
abstract contract ERC165Upgradeable is Initializable, IERC165Upgradeable {
function __ERC165_init() internal onlyInitializing {
}
function __ERC165_init_unchained() internal onlyInitializing {
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IERC165Upgradeable).interfaceId;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165Upgradeable {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/math/Math.sol)
pragma solidity ^0.8.0;
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library MathUpgradeable {
enum Rounding {
Down, // Toward negative infinity
Up, // Toward infinity
Zero // Toward zero
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds up instead
* of rounding down.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b - 1) / b can overflow on addition, so we distribute.
return a == 0 ? 0 : (a - 1) / b + 1;
}
/**
* @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
* @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv)
* with further edits by Uniswap Labs also under MIT license.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
// 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
// use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = prod1 * 2^256 + prod0.
uint256 prod0; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(x, y, not(0))
prod0 := mul(x, y)
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Handle non-overflow cases, 256 by 256 division.
if (prod1 == 0) {
// Solidity will revert if denominator == 0, unlike the div opcode on its own.
// The surrounding unchecked block does not change this fact.
// See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
return prod0 / denominator;
}
// Make sure the result is less than 2^256. Also prevents denominator == 0.
require(denominator > prod1, "Math: mulDiv overflow");
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0].
uint256 remainder;
assembly {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1.
// See https://cs.stackexchange.com/q/138556/92363.
// Does not overflow because the denominator cannot be zero at this stage in the function.
uint256 twos = denominator & (~denominator + 1);
assembly {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [prod1 prod0] by twos.
prod0 := div(prod0, twos)
// Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from prod1 into prod0.
prod0 |= prod1 * twos;
// Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
// that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv = 1 mod 2^4.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works
// in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2^8
inverse *= 2 - denominator * inverse; // inverse mod 2^16
inverse *= 2 - denominator * inverse; // inverse mod 2^32
inverse *= 2 - denominator * inverse; // inverse mod 2^64
inverse *= 2 - denominator * inverse; // inverse mod 2^128
inverse *= 2 - denominator * inverse; // inverse mod 2^256
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
// less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
// is no longer required.
result = prod0 * inverse;
return result;
}
}
/**
* @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
uint256 result = mulDiv(x, y, denominator);
if (rounding == Rounding.Up && mulmod(x, y, denominator) > 0) {
result += 1;
}
return result;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded down.
*
* Inspired by Henry S. Warren, Jr.'s "Hacker's Delight" (Chapter 11).
*/
function sqrt(uint256 a) internal pure returns (uint256) {
if (a == 0) {
return 0;
}
// For our first guess, we get the biggest power of 2 which is smaller than the square root of the target.
//
// We know that the "msb" (most significant bit) of our target number `a` is a power of 2 such that we have
// `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`.
//
// This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)`
// → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))`
// → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)`
//
// Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit.
uint256 result = 1 << (log2(a) >> 1);
// At this point `result` is an estimation with one bit of precision. We know the true value is a uint128,
// since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at
// every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision
// into the expected uint128 result.
unchecked {
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
return min(result, a / result);
}
}
/**
* @notice Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + (rounding == Rounding.Up && result * result < a ? 1 : 0);
}
}
/**
* @dev Return the log in base 2, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 128;
}
if (value >> 64 > 0) {
value >>= 64;
result += 64;
}
if (value >> 32 > 0) {
value >>= 32;
result += 32;
}
if (value >> 16 > 0) {
value >>= 16;
result += 16;
}
if (value >> 8 > 0) {
value >>= 8;
result += 8;
}
if (value >> 4 > 0) {
value >>= 4;
result += 4;
}
if (value >> 2 > 0) {
value >>= 2;
result += 2;
}
if (value >> 1 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + (rounding == Rounding.Up && 1 << result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 10, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10 ** 64) {
value /= 10 ** 64;
result += 64;
}
if (value >= 10 ** 32) {
value /= 10 ** 32;
result += 32;
}
if (value >= 10 ** 16) {
value /= 10 ** 16;
result += 16;
}
if (value >= 10 ** 8) {
value /= 10 ** 8;
result += 8;
}
if (value >= 10 ** 4) {
value /= 10 ** 4;
result += 4;
}
if (value >= 10 ** 2) {
value /= 10 ** 2;
result += 2;
}
if (value >= 10 ** 1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + (rounding == Rounding.Up && 10 ** result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 256, rounded down, of a positive value.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 16;
}
if (value >> 64 > 0) {
value >>= 64;
result += 8;
}
if (value >> 32 > 0) {
value >>= 32;
result += 4;
}
if (value >> 16 > 0) {
value >>= 16;
result += 2;
}
if (value >> 8 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + (rounding == Rounding.Up && 1 << (result << 3) < value ? 1 : 0);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/math/SignedMath.sol)
pragma solidity ^0.8.0;
/**
* @dev Standard signed math utilities missing in the Solidity language.
*/
library SignedMathUpgradeable {
/**
* @dev Returns the largest of two signed numbers.
*/
function max(int256 a, int256 b) internal pure returns (int256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two signed numbers.
*/
function min(int256 a, int256 b) internal pure returns (int256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two signed numbers without overflow.
* The result is rounded towards zero.
*/
function average(int256 a, int256 b) internal pure returns (int256) {
// Formula from the book "Hacker's Delight"
int256 x = (a & b) + ((a ^ b) >> 1);
return x + (int256(uint256(x) >> 255) & (a ^ b));
}
/**
* @dev Returns the absolute unsigned value of a signed value.
*/
function abs(int256 n) internal pure returns (uint256) {
unchecked {
// must be unchecked in order to support `n = type(int256).min`
return uint256(n >= 0 ? n : -n);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.
pragma solidity ^0.8.0;
/**
* @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 ERC1967 implementation slot:
* ```solidity
* contract ERC1967 {
* bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
*
* function _getImplementation() internal view returns (address) {
* return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
* }
*
* function _setImplementation(address newImplementation) internal {
* require(Address.isContract(newImplementation), "ERC1967: new implementation is not a contract");
* StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
* }
* }
* ```
*
* _Available since v4.1 for `address`, `bool`, `bytes32`, `uint256`._
* _Available since v4.9 for `string`, `bytes`._
*/
library StorageSlotUpgradeable {
struct AddressSlot {
address value;
}
struct BooleanSlot {
bool value;
}
struct Bytes32Slot {
bytes32 value;
}
struct Uint256Slot {
uint256 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) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `BooleanSlot` with member `value` located at `slot`.
*/
function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `Bytes32Slot` with member `value` located at `slot`.
*/
function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `Uint256Slot` with member `value` located at `slot`.
*/
function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` with member `value` located at `slot`.
*/
function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
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) {
/// @solidity memory-safe-assembly
assembly {
r.slot := store.slot
}
}
/**
* @dev Returns an `BytesSlot` with member `value` located at `slot`.
*/
function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
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) {
/// @solidity memory-safe-assembly
assembly {
r.slot := store.slot
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Strings.sol)
pragma solidity ^0.8.0;
import "./math/MathUpgradeable.sol";
import "./math/SignedMathUpgradeable.sol";
/**
* @dev String operations.
*/
library StringsUpgradeable {
bytes16 private constant _SYMBOLS = "0123456789abcdef";
uint8 private constant _ADDRESS_LENGTH = 20;
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
unchecked {
uint256 length = MathUpgradeable.log10(value) + 1;
string memory buffer = new string(length);
uint256 ptr;
/// @solidity memory-safe-assembly
assembly {
ptr := add(buffer, add(32, length))
}
while (true) {
ptr--;
/// @solidity memory-safe-assembly
assembly {
mstore8(ptr, byte(mod(value, 10), _SYMBOLS))
}
value /= 10;
if (value == 0) break;
}
return buffer;
}
}
/**
* @dev Converts a `int256` to its ASCII `string` decimal representation.
*/
function toString(int256 value) internal pure returns (string memory) {
return string(abi.encodePacked(value < 0 ? "-" : "", toString(SignedMathUpgradeable.abs(value))));
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
unchecked {
return toHexString(value, MathUpgradeable.log256(value) + 1);
}
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = _SYMBOLS[value & 0xf];
value >>= 4;
}
require(value == 0, "Strings: hex length insufficient");
return string(buffer);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation.
*/
function toHexString(address addr) internal pure returns (string memory) {
return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH);
}
/**
* @dev Returns true if the two strings are equal.
*/
function equal(string memory a, string memory b) internal pure returns (bool) {
return keccak256(bytes(a)) == keccak256(bytes(b));
}
}// SPDX-License-Identifier: UNLICENSED
// solhint-disable not-rely-on-time
pragma solidity 0.8.9;
import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import {AccessControlUpgradeable} from "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
import {PausableUpgradeable} from "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";
import {CryptographyLib} from "../lib/Cryptography.sol";
/// @notice Structure for commits
struct Commit {
bytes32 blockHash;
uint32 timestamp;
address reserved1;
uint16 reserved2;
}
/// @notice The Fuel v2 chain state
contract FuelChainState is Initializable, PausableUpgradeable, AccessControlUpgradeable, UUPSUpgradeable {
///////////////
// Constants //
///////////////
/// @dev The commit proccess parameters
// NUM_COMMIT_SLOTS an arbitrary number of commits to store before starting to overwrite
uint256 public constant NUM_COMMIT_SLOTS = 240;
// Number of blocks per commit interval
// BLOCKS_PER_COMMIT_INTERVAL = (num of blocks per minute (=60) * target interval in minutes)
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable
uint256 public immutable BLOCKS_PER_COMMIT_INTERVAL;
// Time after which a commit becomes finalized
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable
uint256 public immutable TIME_TO_FINALIZE;
/// Time before a slot can be overwritten
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable
uint32 public immutable COMMIT_COOLDOWN;
/// @dev The admin related contract roles
bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");
bytes32 public constant COMMITTER_ROLE = keccak256("COMMITTER_ROLE");
////////////
// Events //
////////////
/// @dev Emitted when a commit is first submitted
event CommitSubmitted(uint256 indexed commitHeight, bytes32 blockHash);
////////////
// Errors //
////////////
error CannotRecommit();
error CommitCooldownTooLarge();
error FinalizationIsGtCooldown();
error InvalidTimeToFinalize();
error TimeToFinalizeTooLarge();
error UnknownBlock();
/////////////
// Storage //
/////////////
/// @dev The commits buffer
Commit[NUM_COMMIT_SLOTS] private _commitSlots;
/////////////////////////////
// Constructor/Initializer //
/////////////////////////////
/// @notice Constructor disables initialization for the implementation contract
/// @dev assumes 1 block per second in the L2 chain
/// @custom:oz-upgrades-unsafe-allow constructor
constructor(uint256 timeToFinalize, uint256 blocksPerCommitInterval, uint32 commitCooldown) {
if (timeToFinalize == 0) {
revert InvalidTimeToFinalize();
}
if (timeToFinalize > commitCooldown) {
revert FinalizationIsGtCooldown();
}
uint256 circularBufferSizeInSeconds = NUM_COMMIT_SLOTS * blocksPerCommitInterval;
if (timeToFinalize > circularBufferSizeInSeconds) {
revert TimeToFinalizeTooLarge();
}
if (commitCooldown > circularBufferSizeInSeconds) {
revert CommitCooldownTooLarge();
}
TIME_TO_FINALIZE = timeToFinalize;
COMMIT_COOLDOWN = commitCooldown;
BLOCKS_PER_COMMIT_INTERVAL = blocksPerCommitInterval;
_disableInitializers();
}
/// @notice Contract initializer to setup starting values
function initialize() public initializer {
__Pausable_init();
__AccessControl_init();
__UUPSUpgradeable_init();
//grant initial roles
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(PAUSER_ROLE, msg.sender);
_grantRole(COMMITTER_ROLE, msg.sender);
}
/////////////////////
// Admin Functions //
/////////////////////
/// @notice Pause block commitments
function pause() external onlyRole(PAUSER_ROLE) {
_pause();
}
/// @notice Unpause block commitments
function unpause() external onlyRole(DEFAULT_ADMIN_ROLE) {
_unpause();
}
/// @notice Commits a block header.
/// @param blockHash The hash of a block
/// @param commitHeight The height of the commit
function commit(bytes32 blockHash, uint256 commitHeight) external whenNotPaused onlyRole(COMMITTER_ROLE) {
uint256 slot = commitHeight % NUM_COMMIT_SLOTS;
Commit storage commitSlot = _commitSlots[slot];
unchecked {
if (commitSlot.timestamp + COMMIT_COOLDOWN > uint32(block.timestamp)) {
revert CannotRecommit();
}
}
commitSlot.blockHash = blockHash;
commitSlot.timestamp = uint32(block.timestamp);
emit CommitSubmitted(commitHeight, blockHash);
}
//////////////////////
// Public Functions //
//////////////////////
/// @notice Checks if a given block is finalized
/// @param blockHash The hash of the block to check
/// @param blockHeight The height of the block to check
/// @return true if the block is finalized
function finalized(bytes32 blockHash, uint256 blockHeight) external view whenNotPaused returns (bool) {
// TODO This division could be done offchain, or at least also could be assembly'ed to avoid non-zero division check
uint256 commitHeight = blockHeight / BLOCKS_PER_COMMIT_INTERVAL;
Commit storage commitSlot = _commitSlots[commitHeight % NUM_COMMIT_SLOTS];
if (commitSlot.blockHash != blockHash) revert UnknownBlock();
return block.timestamp >= uint256(commitSlot.timestamp) + TIME_TO_FINALIZE;
}
/// @notice Gets the block hash at the given commit height
/// @param commitHeight The height of the commit
/// @return hash of the block at the given commit height
function blockHashAtCommit(uint256 commitHeight) external view returns (bytes32) {
Commit storage commitSlot = _commitSlots[commitHeight % NUM_COMMIT_SLOTS];
return commitSlot.blockHash;
}
////////////////////////
// Internal Functions //
////////////////////////
/// @notice Executes a message in the given header
// solhint-disable-next-line no-empty-blocks
function _authorizeUpgrade(address newImplementation) internal override onlyRole(DEFAULT_ADMIN_ROLE) {
//should revert if msg.sender is not authorized to upgrade the contract (currently only owner)
}
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.9;
import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import {AccessControlUpgradeable} from "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
import {PausableUpgradeable} from "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";
import {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
import {verifyBinaryTree} from "../lib/VerifyBinaryTree/VerifyBinaryTree.sol";
import {FuelChainState} from "./FuelChainState.sol";
import {FuelBlockHeader, FuelBlockHeaderLib} from "./types/FuelBlockHeader.sol";
import {FuelBlockHeaderLite, FuelBlockHeaderLiteLib} from "./types/FuelBlockHeaderLite.sol";
import {CryptographyLib} from "../lib/Cryptography.sol";
import {CommonPredicates} from "../lib/CommonPredicates.sol";
/// @notice Structure for proving an element in a merkle tree
struct MerkleProof {
uint256 key;
bytes32[] proof;
}
/// @notice Structure containing all message details
struct Message {
bytes32 sender;
bytes32 recipient;
bytes32 nonce;
uint64 amount;
bytes data;
}
/// @title FuelMessagePortal
/// @notice The Fuel Message Portal contract sends messages to and from Fuel
/// @custom:deprecation THIS CONTRACT IS DEPRECATED. CHECK FuelMessagePortalV3
contract FuelMessagePortal is
Initializable,
PausableUpgradeable,
AccessControlUpgradeable,
ReentrancyGuardUpgradeable,
UUPSUpgradeable
{
using FuelBlockHeaderLib for FuelBlockHeader;
using FuelBlockHeaderLiteLib for FuelBlockHeaderLite;
////////////
// Events //
////////////
/// @dev Emitted when a message is sent from Ethereum to Fuel
event MessageSent(
bytes32 indexed sender,
bytes32 indexed recipient,
uint256 indexed nonce,
uint64 amount,
bytes data
);
/// @dev Emitted when a message is successfully relayed to Ethereum from Fuel
event MessageRelayed(bytes32 indexed messageId, bytes32 indexed sender, bytes32 indexed recipient, uint64 amount);
////////////
// Errors //
////////////
error UnfinalizedBlock();
error InvalidBlockInHistoryProof();
error InvalidMessageInBlockProof();
error CurrentMessageSenderNotSet();
error MessageDataTooLarge();
error AmountPrecisionIncompatibility();
error AmountTooBig();
error AlreadyRelayed();
///////////////
// Constants //
///////////////
/// @dev The admin related contract roles
bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");
/// @dev The number of decimals that the base Fuel asset uses
uint256 public constant FUEL_BASE_ASSET_DECIMALS = 9;
uint256 public constant ETH_DECIMALS = 18;
uint256 public constant PRECISION = 10 ** (ETH_DECIMALS - FUEL_BASE_ASSET_DECIMALS);
/// @dev The max message data size in bytes
uint256 public constant MAX_MESSAGE_DATA_SIZE = 2 ** 16;
/// @dev Non-zero null value to optimize gas costs
bytes32 internal constant NULL_MESSAGE_SENDER = 0x000000000000000000000000000000000000000000000000000000000000dead;
/////////////
// Storage //
/////////////
/// @notice Current message sender for other contracts to reference
bytes32 internal _incomingMessageSender;
/// @notice The Fuel chain state contract
FuelChainState internal _fuelChainState;
/// @notice Nonce for the next message to be sent
uint256 internal _outgoingMessageNonce;
/// @notice Mapping of message hash to boolean success value
mapping(bytes32 => bool) internal _incomingMessageSuccessful;
/////////////////////////////
// Constructor/Initializer //
/////////////////////////////
/// @notice Constructor disables initialization for the implementation contract
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
/// @notice Contract initializer to setup starting values
/// @param fuelChainState Chain state contract
function initialize(FuelChainState fuelChainState) public virtual initializer {
initializerV1(fuelChainState);
}
function initializerV1(FuelChainState fuelChainState) internal virtual onlyInitializing {
__Pausable_init();
__AccessControl_init();
__ReentrancyGuard_init();
__UUPSUpgradeable_init();
//grant initial roles
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(PAUSER_ROLE, msg.sender);
//chain state contract
_fuelChainState = fuelChainState;
//outgoing message data
_outgoingMessageNonce = 0;
//incoming message data
_incomingMessageSender = NULL_MESSAGE_SENDER;
}
/////////////////////
// Admin Functions //
/////////////////////
/// @notice Pause outbound messages
function pause() external virtual onlyRole(PAUSER_ROLE) {
_pause();
}
/// @notice Unpause outbound messages
function unpause() external virtual onlyRole(DEFAULT_ADMIN_ROLE) {
_unpause();
}
//////////////////////
// Public Functions //
//////////////////////
/// @notice Gets the number of decimals used in the Fuel base asset
/// @return decimals of the Fuel base asset
function fuelBaseAssetDecimals() public pure virtual returns (uint8) {
return uint8(FUEL_BASE_ASSET_DECIMALS);
}
/// @notice Gets the set Fuel chain state contract
/// @return fuel chain state contract
function fuelChainStateContract() public view virtual returns (address) {
return address(_fuelChainState);
}
function getNextOutgoingMessageNonce() public view virtual returns (uint256) {
return _outgoingMessageNonce;
}
///////////////////////////////////////
// Incoming Message Public Functions //
///////////////////////////////////////
/// @notice Relays a message published on Fuel from a given block
/// @param message The message to relay
/// @param rootBlockHeader The root block for proving chain history
/// @param blockHeader The block containing the message
/// @param blockInHistoryProof Proof that the message block exists in the history of the root block
/// @param messageInBlockProof Proof that message exists in block
/// @dev Made payable to reduce gas costs
function relayMessage(
Message calldata message,
FuelBlockHeaderLite calldata rootBlockHeader,
FuelBlockHeader calldata blockHeader,
MerkleProof calldata blockInHistoryProof,
MerkleProof calldata messageInBlockProof
) external payable virtual whenNotPaused {
//verify root block header
if (!_fuelChainState.finalized(rootBlockHeader.computeConsensusHeaderHash(), rootBlockHeader.height)) {
revert UnfinalizedBlock();
}
//verify block in history
if (
!verifyBinaryTree(
rootBlockHeader.prevRoot,
abi.encodePacked(blockHeader.computeConsensusHeaderHash()),
blockInHistoryProof.proof,
blockInHistoryProof.key,
rootBlockHeader.height
)
) revert InvalidBlockInHistoryProof();
//verify message in block
bytes32 messageId = CryptographyLib.hash(
abi.encodePacked(message.sender, message.recipient, message.nonce, message.amount, message.data)
);
if (
!verifyBinaryTree(
blockHeader.outputMessagesRoot,
abi.encodePacked(messageId),
messageInBlockProof.proof,
messageInBlockProof.key,
blockHeader.outputMessagesCount
)
) revert InvalidMessageInBlockProof();
//execute message
_executeMessage(messageId, message);
}
/// @notice Gets if the given message ID has been relayed successfully
/// @param messageId Message ID
/// @return true if message has been relayed successfully
function incomingMessageSuccessful(bytes32 messageId) public view virtual returns (bool) {
return _incomingMessageSuccessful[messageId];
}
/// @notice Used by message receiving contracts to get the address on Fuel that sent the message
/// @return sender the address of the sender on Fuel
function messageSender() external view virtual returns (bytes32) {
if (_incomingMessageSender == NULL_MESSAGE_SENDER) revert CurrentMessageSenderNotSet();
return _incomingMessageSender;
}
///////////////////////////////////////
// Outgoing Message Public Functions //
///////////////////////////////////////
/// @notice Send a message to a recipient on Fuel
/// @param recipient The target message receiver address or predicate root
/// @param data The message data to be sent to the receiver
function sendMessage(bytes32 recipient, bytes calldata data) external payable virtual whenNotPaused {
_sendOutgoingMessage(recipient, data);
}
/// @notice Send only ETH to the given recipient
/// @param recipient The target message receiver
function depositETH(bytes32 recipient) external payable virtual whenNotPaused {
_sendOutgoingMessage(recipient, new bytes(0));
}
////////////////////////
// Internal Functions //
////////////////////////
/// @notice Performs all necessary logic to send a message to a target on Fuel
/// @param recipient The message receiver address or predicate root
/// @param data The message data to be sent to the receiver
function _sendOutgoingMessage(bytes32 recipient, bytes memory data) internal virtual {
bytes32 sender = bytes32(uint256(uint160(msg.sender)));
unchecked {
//make sure data size is not too large
if (data.length >= MAX_MESSAGE_DATA_SIZE) revert MessageDataTooLarge();
//make sure amount fits into the Fuel base asset decimal level
uint256 precision = 10 ** (ETH_DECIMALS - FUEL_BASE_ASSET_DECIMALS);
uint256 amount = msg.value / precision;
if (msg.value > 0) {
if (amount * PRECISION != msg.value) revert AmountPrecisionIncompatibility();
if (amount > type(uint64).max) revert AmountTooBig();
}
//emit message for Fuel clients to pickup (messageID calculated offchain)
uint256 nonce = _outgoingMessageNonce;
emit MessageSent(sender, recipient, nonce, uint64(amount), data);
// increment nonce for next message
_outgoingMessageNonce = nonce + 1;
}
}
/// @notice Executes a message in the given header
/// @param messageId The id of message to execute
/// @param message The message to execute
function _executeMessage(bytes32 messageId, Message calldata message) internal virtual nonReentrant {
if (_incomingMessageSuccessful[messageId]) revert AlreadyRelayed();
//set message sender for receiving contract to reference
_incomingMessageSender = message.sender;
(bool success, bytes memory result) = address(uint160(uint256(message.recipient))).call{
value: message.amount * (10 ** (ETH_DECIMALS - FUEL_BASE_ASSET_DECIMALS))
}(message.data);
if (!success) {
// Look for revert reason and bubble it up if present
if (result.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(result)
revert(add(32, result), returndata_size)
}
}
revert("Message relay failed");
}
//unset message sender reference
_incomingMessageSender = NULL_MESSAGE_SENDER;
//keep track of successfully relayed messages
_incomingMessageSuccessful[messageId] = true;
//emit event for successful message relay
emit MessageRelayed(messageId, message.sender, message.recipient, message.amount);
}
/// @notice Executes a message in the given header
// solhint-disable-next-line no-empty-blocks
function _authorizeUpgrade(address newImplementation) internal override onlyRole(DEFAULT_ADMIN_ROLE) {
//should revert if msg.sender is not authorized to upgrade the contract (currently only admin)
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.9;
import {CryptographyLib} from "../../lib/Cryptography.sol";
/// @title Fuel Chain Block Header
/// @dev The Fuel chain block header structure
struct FuelBlockHeader {
///////////////
// Consensus //
///////////////
// Merkle root of all previous consensus header hashes (not including this block)
bytes32 prevRoot;
// Time this block was created, in TAI64 format
uint64 timestamp;
/////////////////
// Application //
/////////////////
//Height of the data availability layer up to which (inclusive) input messages are processed
uint64 daHeight;
// Number of output messages in this block
uint32 outputMessagesCount;
// Version of consensus parameters
uint32 consensusParametersVersion;
// Version of state transition bytecode
uint32 stateTransitionBytecodeVersion;
// Height of this block
uint32 height;
// Merkle root of transactions in this block
bytes32 txRoot;
// Merkle root of output messages in this block
bytes32 outputMessagesRoot;
// Merkle root of incoming messages in this block
bytes32 eventInboxRoot;
// Number of transactions in this block
uint16 txCount;
}
/// @title Block Header Library
/// @dev Provides useful functions for dealing with Fuel blocks
library FuelBlockHeaderLib {
/////////////
// Methods //
/////////////
/// @notice Serialize a block application header.
/// @param header The block header structure.
/// @return The serialized block application header.
function serializeApplicationHeader(FuelBlockHeader memory header) internal pure returns (bytes memory) {
return
abi.encodePacked(
header.daHeight,
header.consensusParametersVersion,
header.stateTransitionBytecodeVersion,
header.txCount,
header.outputMessagesCount,
header.txRoot,
header.outputMessagesRoot,
header.eventInboxRoot
);
}
/// @notice Produce the block application header hash.
/// @param header The block header structure.
/// @return The block application header hash.
function computeApplicationHeaderHash(FuelBlockHeader memory header) internal pure returns (bytes32) {
return CryptographyLib.hash(serializeApplicationHeader(header));
}
/// @notice Serialize a block consensus header.
/// @param header The block header structure.
/// @return The serialized block consensus header.
function serializeConsensusHeader(FuelBlockHeader memory header) internal pure returns (bytes memory) {
return abi.encodePacked(header.prevRoot, header.height, header.timestamp, computeApplicationHeaderHash(header));
}
/// @notice Produce the block consensus header hash.
/// @param header The block header structure.
/// @return The block consensus header hash.
function computeConsensusHeaderHash(FuelBlockHeader memory header) internal pure returns (bytes32) {
return CryptographyLib.hash(serializeConsensusHeader(header));
}
}// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.9;
import {CryptographyLib} from "../../lib/Cryptography.sol";
/// @title Lightweight Fuel Chain Block Header
/// @dev The Fuel chain block header structure with just a hash of the application header
struct FuelBlockHeaderLite {
// Merkle root of all previous consensus header hashes (not including this block)
bytes32 prevRoot;
// Height of this block
uint32 height;
// Time this block was created, in TAI64 format
uint64 timestamp;
// Hash of serialized application header for this block
bytes32 applicationHash;
}
/// @title Block Header Library
/// @dev Provides useful functions for dealing with Fuel blocks
library FuelBlockHeaderLiteLib {
/////////////
// Methods //
/////////////
/// @notice Serialize a block consensus header.
/// @param header The block header structure.
/// @return The serialized block consensus header.
function serializeConsensusHeader(FuelBlockHeaderLite memory header) internal pure returns (bytes memory) {
return abi.encodePacked(header.prevRoot, (uint32)(header.height), header.timestamp, header.applicationHash);
}
/// @notice Produce the block consensus header hash.
/// @param header The block header structure.
/// @return The block consensus header hash.
function computeConsensusHeaderHash(FuelBlockHeaderLite memory header) internal pure returns (bytes32) {
return CryptographyLib.hash(serializeConsensusHeader(header));
}
}// SPDX-License-Identifier: Apache 2.0
pragma solidity 0.8.9;
/// @notice Common predicates for Fuel inputs
library CommonPredicates {
bytes32 public constant CONTRACT_MESSAGE_PREDICATE =
0xe821b978bcce9abbf40c3e50ea30143e68c65fa95b9da8907fef59c02d954cec;
}// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.9;
/// @notice This is the Fuel protocol cryptography library.
library CryptographyLib {
/////////////
// Methods //
/////////////
// secp256k1n / 2
uint256 private constant MAX_SIGNATURE_S_VALUE = 0x7fffffffffffffffffffffffffffffff5d576e7357a4501ddfe92f46681b20a0;
/// @notice The primary hash method for Fuel.
/// @param data The bytes input data.
/// @return The returned hash result.
function hash(bytes memory data) internal pure returns (bytes32) {
return sha256(data);
}
}// SPDX-License-Identifier: Apache-2.0
pragma solidity ^0.8.4;
library Constants {
///////////////
// Constants //
///////////////
/// @dev Maximum tree height
uint256 internal constant MAX_HEIGHT = 256;
/// @dev Empty node hash
bytes32 internal constant EMPTY = sha256("");
/// @dev Default value for sparse Merkle tree node
bytes32 internal constant ZERO = bytes32(0);
/// @dev The null pointer
bytes32 internal constant NULL = bytes32(0);
/// @dev The prefixes of leaves and nodes
bytes1 internal constant LEAF_PREFIX = 0x00;
bytes1 internal constant NODE_PREFIX = 0x01;
}// SPDX-License-Identifier: Apache-2.0
pragma solidity ^0.8.4;
/// @notice Merkle Tree Node structure.
struct Node {
bytes32 digest;
// Left child.
bytes32 leftChildPtr;
// Right child.
bytes32 rightChildPtr;
}// SPDX-License-Identifier: Apache-2.0
pragma solidity ^0.8.4;
import {CryptographyLib} from "../Cryptography.sol";
import {Constants} from "./Constants.sol";
import {Node} from "./Node.sol";
/// @notice hash some data
/// @param data: The data to be hashed
// solhint-disable-next-line func-visibility
function hash(bytes memory data) pure returns (bytes32) {
return CryptographyLib.hash(data);
}
/// @notice Calculate the digest of a node
/// @param left : The left child
/// @param right: The right child
/// @return digest : The node digest
// solhint-disable-next-line func-visibility
function nodeDigest(bytes32 left, bytes32 right) pure returns (bytes32 digest) {
digest = hash(abi.encodePacked(Constants.NODE_PREFIX, left, right));
}
/// @notice Calculate the digest of a leaf
/// @param data : The data of the leaf
/// @return digest : The leaf digest
// solhint-disable-next-line func-visibility
function leafDigest(bytes memory data) pure returns (bytes32 digest) {
digest = hash(abi.encodePacked(Constants.LEAF_PREFIX, data));
}// SPDX-License-Identifier: Apache-2.0
pragma solidity ^0.8.4;
import {Constants} from "./Constants.sol";
/// @notice Calculate the starting bit of the path to a leaf
/// @param numLeaves : The total number of leaves in the tree
/// @return startingBit : The starting bit of the path
// solhint-disable-next-line func-visibility
function getStartingBit(uint256 numLeaves) pure returns (uint256 startingBit) {
// Determine height of the left subtree. This is the maximum path length, so all paths start at this offset from the right-most bit
startingBit = 0;
while ((1 << startingBit) < numLeaves) {
startingBit += 1;
}
return Constants.MAX_HEIGHT - startingBit;
}
/// @notice Calculate the length of the path to a leaf
/// @param key: The key of the leaf
/// @param numLeaves: The total number of leaves in the tree
/// @return pathLength : The length of the path to the leaf
/// @dev A precondition to this function is that `numLeaves > 1`, so that `(pathLength - 1)` does not cause an underflow when pathLength = 0.
// solhint-disable-next-line func-visibility
function pathLengthFromKey(uint256 key, uint256 numLeaves) pure returns (uint256 pathLength) {
// Get the height of the left subtree. This is equal to the offset of the starting bit of the path
pathLength = 256 - getStartingBit(numLeaves);
// Determine the number of leaves in the left subtree
uint256 numLeavesLeftSubTree = (1 << (pathLength - 1));
// If leaf is in left subtree, path length is full height of left subtree
if (key <= numLeavesLeftSubTree - 1) {
return pathLength;
}
// Otherwise, if left sub tree has only one leaf, path has one additional step
else if (numLeavesLeftSubTree == 1) {
return 1;
}
// Otherwise, if right sub tree has only one leaf, path has one additional step
else if (numLeaves - numLeavesLeftSubTree <= 1) {
return 1;
}
// Otherwise, add 1 to height and recurse into right subtree
else {
return 1 + pathLengthFromKey(key - numLeavesLeftSubTree, numLeaves - numLeavesLeftSubTree);
}
}// SPDX-License-Identifier: Apache-2.0
/// @title VerifyBinaryTree
/// @author Fuel Labs
/// @dev This implements verification for the binary trees used by the FuelVM
/// @dev For more details, check:
/// @dev https://github.com/FuelLabs/fuel-specs/blob/master/src/protocol/cryptographic-primitives.md
pragma solidity ^0.8.4;
import {Node} from "./Node.sol";
import {nodeDigest, leafDigest} from "./TreeHasher.sol";
import {pathLengthFromKey, getStartingBit} from "./Utils.sol";
/// @notice Verify if element (key, data) exists in Merkle tree, given data, proof, and root.
/// @param root: The root of the tree in which verify the given leaf
/// @param data: The data of the leaf to verify
/// @param key: The key of the leaf to verify.
/// @param proof: Binary Merkle Proof for the leaf.
/// @param numLeaves: The number of leaves in the tree
/// @return : Whether the proof is valid
/// @dev numLeaves is necessary to determine height of sub-tree containing the data to prove
// solhint-disable-next-line func-visibility
function verifyBinaryTree(
bytes32 root,
bytes memory data,
bytes32[] memory proof,
uint256 key,
uint256 numLeaves
) pure returns (bool) {
// A sibling at height 1 is created by getting the hash of the data to prove.
return verifyBinaryTreeDigest(root, leafDigest(data), proof, key, numLeaves);
}
/// @notice Verify if element (key, digest) exists in Merkle tree, given digest, proof, and root.
/// @param root: The root of the tree in which verify the given leaf
/// @param digest: The digest of the data of the leaf to verify
/// @param key: The key of the leaf to verify.
/// @param proof: Binary Merkle Proof for the leaf.
/// @param numLeaves: The number of leaves in the tree
/// @return : Whether the proof is valid
/// @dev numLeaves is necessary to determine height of sub-tree containing the data to prove
// solhint-disable-next-line func-visibility
function verifyBinaryTreeDigest(
bytes32 root,
bytes32 digest,
bytes32[] memory proof,
uint256 key,
uint256 numLeaves
) pure returns (bool) {
// Check proof is correct length for the key it is proving
if (numLeaves <= 1) {
if (proof.length != 0) {
return false;
}
} else if (proof.length != pathLengthFromKey(key, numLeaves)) {
return false;
}
// Check key is in tree
if (key >= numLeaves) {
return false;
}
// Null proof is only valid if numLeaves = 1
// If so, just verify digest is root
if (proof.length == 0) {
if (numLeaves == 1) {
return (root == digest);
} else {
return false;
}
}
uint256 height = 1;
uint256 stableEnd = key;
// While the current subtree (of height 'height') is complete, determine
// the position of the next sibling using the complete subtree algorithm.
// 'stableEnd' tells us the ending index of the last full subtree. It gets
// initialized to 'key' because the first full subtree was the
// subtree of height 1, created above (and had an ending index of
// 'key').
while (true) {
// Determine if the subtree is complete. This is accomplished by
// rounding down the key to the nearest 1 << 'height', adding 1
// << 'height', and comparing the result to the number of leaves in the
// Merkle tree.
uint256 subTreeStartIndex = (key / (1 << height)) * (1 << height);
uint256 subTreeEndIndex = subTreeStartIndex + (1 << height) - 1;
// If the Merkle tree does not have a leaf at index
// 'subTreeEndIndex', then the subtree of the current height is not
// a complete subtree.
if (subTreeEndIndex >= numLeaves) {
break;
}
stableEnd = subTreeEndIndex;
// Determine if the key is in the first or the second half of
// the subtree.
if (proof.length <= height - 1) {
return false;
}
if (key - subTreeStartIndex < (1 << (height - 1))) {
digest = nodeDigest(digest, proof[height - 1]);
} else {
digest = nodeDigest(proof[height - 1], digest);
}
height += 1;
}
// Determine if the next hash belongs to an orphan that was elevated. This
// is the case IFF 'stableEnd' (the last index of the largest full subtree)
// is equal to the number of leaves in the Merkle tree.
if (stableEnd != numLeaves - 1) {
if (proof.length <= height - 1) {
return false;
}
digest = nodeDigest(digest, proof[height - 1]);
height += 1;
}
// All remaining elements in the proof set will belong to a left sibling\
// i.e proof sideNodes are hashed in "from the left"
while (height - 1 < proof.length) {
digest = nodeDigest(proof[height - 1], digest);
height += 1;
}
return (digest == root);
}// SPDX-License-Identifier: Apache-2.0
pragma solidity 0.8.9;
import {FuelMessagePortal} from "../fuelchain/FuelMessagePortal.sol";
/// @title FuelMessagesEnabled
/// @notice Helper contract for contracts sending and receiving messages from Fuel
abstract contract FuelMessagesEnabled {
////////////
// Errors //
////////////
error CallerIsNotPortal();
error InvalidMessageSender();
/////////////
// Storage //
/////////////
/// @notice FuelMessagePortal contract used to send and receive messages from Fuel
FuelMessagePortal internal _fuelMessagePortal;
////////////////////////
// Function Modifiers //
////////////////////////
/// @notice Enforces that the modified function is only callable by the Fuel message portal
modifier onlyFromPortal() {
if (msg.sender != address(_fuelMessagePortal)) revert CallerIsNotPortal();
_;
}
/// @notice Enforces that the modified function is only callable by the portal and a specific Fuel account
/// @param fuelSender The only sender on Fuel which is authenticated to call this function
modifier onlyFromFuelSender(bytes32 fuelSender) {
if (msg.sender != address(_fuelMessagePortal)) revert CallerIsNotPortal();
if (_fuelMessagePortal.messageSender() != fuelSender) revert InvalidMessageSender();
_;
}
//////////////////////
// Public Functions //
//////////////////////
/// @notice Gets the currently set message portal address
/// @return fuelMessagePortal Fuel message portal address
function fuelMessagePortal() public view returns (address) {
return address(_fuelMessagePortal);
}
////////////////////////
// Internal Functions //
////////////////////////
/// @notice Send a message to a recipient on Fuel
/// @param recipient The message receiver address or predicate root
/// @param data The message data to be sent to the receiver
function sendMessage(bytes32 recipient, bytes memory data) internal {
_fuelMessagePortal.sendMessage(recipient, data);
}
/// @notice Send a message to a recipient on Fuel
/// @param recipient The message receiver address or predicate root
/// @param amount The amount of ETH to send with message
/// @param data The message data to be sent to the receiver
function sendMessage(bytes32 recipient, uint256 amount, bytes memory data) internal {
_fuelMessagePortal.sendMessage{value: amount}(recipient, data);
}
/// @notice Used by message receiving contracts to get the address on Fuel that sent the message
function messageSender() internal view returns (bytes32) {
return _fuelMessagePortal.messageSender();
}
}// SPDX-License-Identifier: Apache-2.0
pragma solidity 0.8.9;
import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import {FuelMessagePortal} from "../fuelchain/FuelMessagePortal.sol";
import {FuelMessagesEnabled} from "./FuelMessagesEnabled.sol";
/// @title FuelMessagesEnabledUpgradeable
/// @notice Helper contract for contracts sending and receiving messages from Fuel
abstract contract FuelMessagesEnabledUpgradeable is Initializable, FuelMessagesEnabled {
/////////////////
// Initializer //
/////////////////
/// @dev Initializes the contract
// solhint-disable-next-line func-name-mixedcase
function __FuelMessagesEnabled_init(FuelMessagePortal fuelMessagePortal) internal onlyInitializing {
__FuelMessagesEnabled_init_unchained(fuelMessagePortal);
}
// solhint-disable-next-line func-name-mixedcase
function __FuelMessagesEnabled_init_unchained(FuelMessagePortal fuelMessagePortal) internal onlyInitializing {
_fuelMessagePortal = fuelMessagePortal;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}// SPDX-License-Identifier: Apache-2.0
pragma solidity 0.8.9;
abstract contract FuelBridgeBase {
/// @notice Finalizes the withdrawal process from the Fuel side gateway contract
/// @param to Account to send withdrawn tokens to
/// @param tokenAddress Address of the token being withdrawn from Fuel
/// @param amount Amount of tokens to withdraw
/// @param tokenId Discriminator for ERC721 / ERC1155 tokens. For ERC20, it must be 0
/// @dev Made payable to reduce gas costs
function finalizeWithdrawal(
address to,
address tokenAddress,
uint256 amount,
uint256 tokenId
) external payable virtual;
}{
"optimizer": {
"enabled": true,
"runs": 10000
},
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
},
"metadata": {
"useLiteralContent": true
},
"libraries": {}
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"BridgeFull","type":"error"},{"inputs":[],"name":"CallerIsNotPortal","type":"error"},{"inputs":[],"name":"CannotDepositZero","type":"error"},{"inputs":[],"name":"CannotWithdrawZero","type":"error"},{"inputs":[],"name":"GlobalDepositLimit","type":"error"},{"inputs":[],"name":"InvalidAmount","type":"error"},{"inputs":[],"name":"InvalidAssetIssuerID","type":"error"},{"inputs":[],"name":"InvalidMessageSender","type":"error"},{"inputs":[],"name":"InvalidSender","type":"error"},{"inputs":[],"name":"RateLimitExceeded","type":"error"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"previousAdmin","type":"address"},{"indexed":false,"internalType":"address","name":"newAdmin","type":"address"}],"name":"AdminChanged","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"beacon","type":"address"}],"name":"BeaconUpgraded","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"sender","type":"bytes32"},{"indexed":true,"internalType":"address","name":"tokenAddress","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"Deposit","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint8","name":"version","type":"uint8"}],"name":"Initialized","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"account","type":"address"}],"name":"Paused","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"tokenAddress","type":"address"},{"indexed":false,"internalType":"bool","name":"status","type":"bool"}],"name":"RateLimitStatusUpdated","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"tokenAddress","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"RateLimitUpdated","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":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"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"recipient","type":"bytes32"},{"indexed":true,"internalType":"address","name":"tokenAddress","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"Withdrawal","type":"event"},{"inputs":[],"name":"DEFAULT_ADMIN_ROLE","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"FUEL_ASSET_DECIMALS","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"PAUSER_ROLE","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"SET_RATE_LIMITER_ROLE","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"assetIssuerId","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"currentPeriodAmount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"currentPeriodEnd","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"to","type":"bytes32"},{"internalType":"address","name":"tokenAddress","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"deposit","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"tokenAddress","type":"address"}],"name":"depositLimits","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"to","type":"bytes32"},{"internalType":"address","name":"tokenAddress","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"depositWithData","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"address","name":"tokenAddress","type":"address"},{"internalType":"uint256","name":"l2BurntAmount","type":"uint256"},{"internalType":"uint256","name":"","type":"uint256"}],"name":"finalizeWithdrawal","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[],"name":"fuelMessagePortal","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":"contract FuelMessagePortal","name":"fuelMessagePortal","type":"address"}],"name":"initialize","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"limitAmount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"pause","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"paused","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"proxiableUUID","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"rateLimitDuration","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"rateLimitStatus","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"account","type":"address"}],"name":"renounceRole","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bool","name":"value","type":"bool"}],"name":"requireWhitelist","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"rescueETH","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"_token","type":"address"},{"internalType":"uint256","name":"_amount","type":"uint256"},{"internalType":"uint256","name":"_rateLimitDuration","type":"uint256"}],"name":"resetRateLimitAmount","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":"tokenAddress","type":"address"}],"name":"sendMetadata","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"id","type":"bytes32"}],"name":"setAssetIssuerId","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"},{"internalType":"uint256","name":"limit","type":"uint256"}],"name":"setGlobalDepositLimit","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"bytes4","name":"interfaceId","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"tokenAddress","type":"address"}],"name":"tokensDeposited","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"unpause","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_token","type":"address"},{"internalType":"bool","name":"_rateLimitStatus","type":"bool"}],"name":"updateRateLimitStatus","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newImplementation","type":"address"}],"name":"upgradeTo","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"},{"inputs":[],"name":"whitelistRequired","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"}]Contract Creation Code
60a0604052306080523480156200001557600080fd5b506200002062000026565b620000e7565b600054610100900460ff1615620000935760405162461bcd60e51b815260206004820152602760248201527f496e697469616c697a61626c653a20636f6e747261637420697320696e697469604482015266616c697a696e6760c81b606482015260840160405180910390fd5b60005460ff90811614620000e5576000805460ff191660ff9081179091556040519081527f7f26b83ff96e1f2b6a682f133852f6798a09c465da95921460cefb38474024989060200160405180910390a15b565b6080516133706200011f6000396000818161091f015281816109b501528181610ad001528181610b660152610e0301526133706000f3fe60806040526004361061026a5760003560e01c8063819a045c11610153578063c4d66de8116100cb578063d810e6f81161007f578063e63ab1e911610064578063e63ab1e9146106f1578063fb08f3a114610725578063fdec40a51461074057600080fd5b8063d810e6f8146106a7578063d954863c146106de57600080fd5b8063caa9147c116100b0578063caa9147c14610646578063cb68448b14610659578063d547741f1461068757600080fd5b8063c4d66de8146105f8578063c97df9ca1461061857600080fd5b8063a161c20511610122578063a5d7496111610107578063a5d74961146105a5578063b37b363b146105c5578063b46f77e4146105d857600080fd5b8063a161c20514610559578063a217fddf1461059057600080fd5b8063819a045c146104b85780638456cb59146104e957806391d14854146104fe57806394d4578e1461054457600080fd5b80634f1ef286116101e657806352d1902d116101b55780635c975abb1161019a5780635c975abb146104765780635ce36f2c1461048e57806364a7fad9146104a557600080fd5b806352d1902d1461044e5780635714b5a91461046357600080fd5b80634f1ef286146103c35780635049c17f146103d65780635176a43d1461040457806352148c231461043b57600080fd5b80632acc021a1161023d57806336568abe1161022257806336568abe1461036e5780633659cfe61461038e5780633f4ba83a146103ae57600080fd5b80632acc021a146103205780632f2ff15d1461034e57600080fd5b806301ffc9a71461026f5780631a2a45fc146102a457806320800a00146102e6578063248a9ca3146102f0575b600080fd5b34801561027b57600080fd5b5061028f61028a366004612ab2565b610760565b60405190151581526020015b60405180910390f35b3480156102b057600080fd5b506102d87f7e5b1c957d4df4bad29cdaceffe50f28f282a0d5096601b958917550d4b2e01681565b60405190815260200161029b565b6102ee6107f9565b005b3480156102fc57600080fd5b506102d861030b366004612af4565b600090815260c8602052604090206001015490565b34801561032c57600080fd5b506102d861033b366004612b22565b6101636020526000908152604090205481565b34801561035a57600080fd5b506102ee610369366004612b3f565b61085d565b34801561037a57600080fd5b506102ee610389366004612b3f565b610887565b34801561039a57600080fd5b506102ee6103a9366004612b22565b610914565b3480156103ba57600080fd5b506102ee610ab2565b6102ee6103d1366004612bf7565b610ac5565b3480156103e257600080fd5b506102d86103f1366004612b22565b6101656020526000908152604090205481565b34801561041057600080fd5b506000546201000090046001600160a01b03166040516001600160a01b03909116815260200161029b565b6102ee610449366004612b22565b610c50565b34801561045a57600080fd5b506102d8610df6565b6102ee610471366004612c8a565b610ebb565b34801561048257600080fd5b5060645460ff1661028f565b34801561049a57600080fd5b506102d861015f5481565b6102ee6104b3366004612d20565b610f96565b3480156104c457600080fd5b5061028f6104d3366004612b22565b6101676020526000908152604090205460ff1681565b3480156104f557600080fd5b506102ee61114f565b34801561050a57600080fd5b5061028f610519366004612b3f565b600091825260c8602090815260408084206001600160a01b0393909316845291905290205460ff1690565b34801561055057600080fd5b506102d8600981565b34801561056557600080fd5b506102d8610574366004612b22565b6001600160a01b03166000908152610160602052604090205490565b34801561059c57600080fd5b506102d8600081565b3480156105b157600080fd5b506102ee6105c0366004612d74565b611181565b6102ee6105d3366004612da2565b61120c565b3480156105e457600080fd5b506102ee6105f3366004612dce565b611235565b34801561060457600080fd5b506102ee610613366004612b22565b611255565b34801561062457600080fd5b506102d8610633366004612b22565b6101646020526000908152604090205481565b6102ee610654366004612af4565b611427565b34801561066557600080fd5b506102d8610674366004612b22565b6101666020526000908152604090205481565b34801561069357600080fd5b506102ee6106a2366004612b3f565b611439565b3480156106b357600080fd5b506102d86106c2366004612b22565b6001600160a01b03166000908152610161602052604090205490565b6102ee6106ec366004612deb565b61145e565b3480156106fd57600080fd5b506102d87f65d7a28e3265b37a6474929f336521b332c1681b933f6cb9f3376673440d862a81565b34801561073157600080fd5b5061015e5461028f9060ff1681565b34801561074c57600080fd5b506102ee61075b366004612e23565b611530565b60007fffffffff0000000000000000000000000000000000000000000000000000000082167f7965db0b0000000000000000000000000000000000000000000000000000000014806107f357507f01ffc9a7000000000000000000000000000000000000000000000000000000007fffffffff000000000000000000000000000000000000000000000000000000008316145b92915050565b600061080481611613565b604051600090339047908381818185875af1925050503d8060008114610846576040519150601f19603f3d011682016040523d82523d6000602084013e61084b565b606091505b505090508061085957600080fd5b5050565b600082815260c8602052604090206001015461087881611613565b610882838361161d565b505050565b6001600160a01b038116331461090a5760405162461bcd60e51b815260206004820152602f60248201527f416363657373436f6e74726f6c3a2063616e206f6e6c792072656e6f756e636560448201527f20726f6c657320666f722073656c66000000000000000000000000000000000060648201526084015b60405180910390fd5b61085982826116bf565b306001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001614156109b35760405162461bcd60e51b815260206004820152602c60248201527f46756e6374696f6e206d7573742062652063616c6c6564207468726f7567682060448201527f64656c656761746563616c6c00000000000000000000000000000000000000006064820152608401610901565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316610a0e7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc546001600160a01b031690565b6001600160a01b031614610a8a5760405162461bcd60e51b815260206004820152602c60248201527f46756e6374696f6e206d7573742062652063616c6c6564207468726f7567682060448201527f6163746976652070726f787900000000000000000000000000000000000000006064820152608401610901565b610a9381611742565b60408051600080825260208201909252610aaf9183919061174d565b50565b6000610abd81611613565b610aaf6118fc565b306001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000161415610b645760405162461bcd60e51b815260206004820152602c60248201527f46756e6374696f6e206d7573742062652063616c6c6564207468726f7567682060448201527f64656c656761746563616c6c00000000000000000000000000000000000000006064820152608401610901565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316610bbf7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc546001600160a01b031690565b6001600160a01b031614610c3b5760405162461bcd60e51b815260206004820152602c60248201527f46756e6374696f6e206d7573742062652063616c6c6564207468726f7567682060448201527f6163746976652070726f787900000000000000000000000000000000000000006064820152608401610901565b610c4482611742565b6108598282600161174d565b610c5861194e565b61015f54610c92576040517fbb2f9c9d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b61015f546000906003836000856001600160a01b03166306fdde036040518163ffffffff1660e01b815260040160006040518083038186803b158015610cd757600080fd5b505afa158015610ceb573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052610d139190810190612eb3565b866001600160a01b03166395d89b416040518163ffffffff1660e01b815260040160006040518083038186803b158015610d4c57600080fd5b505afa158015610d60573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052610d889190810190612eb3565b604051602001610d9b9493929190612f56565b60408051601f1981840301815290829052610dba939291602001612f90565b60408051601f1981840301815291905290506108597fe821b978bcce9abbf40c3e50ea30143e68c65fa95b9da8907fef59c02d954cec826119a3565b6000306001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001614610e965760405162461bcd60e51b815260206004820152603860248201527f555550535570677261646561626c653a206d757374206e6f742062652063616c60448201527f6c6564207468726f7567682064656c656761746563616c6c00000000000000006064820152608401610901565b507f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc90565b610ec361194e565b61015f54610efd576040517fbb2f9c9d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6000610f0885611a21565b90506000610f168286611b1d565b61015f549091506000908415610f2d576002610f30565b60015b6003811115610f4157610f41612e58565b604051610f6f9291906001600160a01b038b169060009033908e90899060ff8c16908e908e90602001612fbd565b6040516020818303038152906040529050610f8c87878484611bad565b5050505050505050565b610f9e61194e565b6000546201000090046001600160a01b03163314610fe8576040517f5c5536bd00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b8161101f576040517fc377136000000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b61015f5461102b611d93565b14611062576040517fddb5de5e00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b600061106d84611a21565b9050600061107b8285611e1f565b6001600160a01b0386166000908152610167602052604090205490915060ff16156110aa576110aa8582611e54565b6001600160a01b038516600090815261016060205260409020546110cf90859061303e565b6001600160a01b038616600081815261016060205260409020919091556110f7908783611f3a565b846001600160a01b0316866001600160a01b031660001b7f028ab133c73f6c00ad0c5896ef40eff18378acd3d7f2ecf573c2706582bf73bf8360405161113f91815260200190565b60405180910390a3505050505050565b7f65d7a28e3265b37a6474929f336521b332c1681b933f6cb9f3376673440d862a61117981611613565b610aaf611fe3565b7f7e5b1c957d4df4bad29cdaceffe50f28f282a0d5096601b958917550d4b2e0166111ab81611613565b6001600160a01b03831660008181526101676020908152604091829020805460ff191686151590811790915591519182527f8ac921afb63648e691280b72420b87f54bbdfebd4ba46618e07dc0231542e837910160405180910390a2505050565b600061121781611613565b506001600160a01b0390911660009081526101616020526040902055565b600061124081611613565b5061015e805460ff1916911515919091179055565b600054610100900460ff16158080156112755750600054600160ff909116105b8061128f5750303b15801561128f575060005460ff166001145b6113015760405162461bcd60e51b815260206004820152602e60248201527f496e697469616c697a61626c653a20636f6e747261637420697320616c72656160448201527f647920696e697469616c697a65640000000000000000000000000000000000006064820152608401610901565b6000805460ff19166001179055801561134157600080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00ff166101001790555b61134a82612020565b6113526120a6565b61135a61212b565b61136261212b565b61136d60003361161d565b6113977f65d7a28e3265b37a6474929f336521b332c1681b933f6cb9f3376673440d862a3361161d565b6113c17f7e5b1c957d4df4bad29cdaceffe50f28f282a0d5096601b958917550d4b2e0163361161d565b801561085957600080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00ff169055604051600181527f7f26b83ff96e1f2b6a682f133852f6798a09c465da95921460cefb38474024989060200160405180910390a15050565b600061143281611613565b5061015f55565b600082815260c8602052604090206001015461145481611613565b61088283836116bf565b61146661194e565b61015f546114a0576040517fbb2f9c9d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b60006114ab83611a21565b905060006114b98284611b1d565b61015f54909150600090816040805160208101939093528201526001600160a01b0386166060820152600060808201523360a082015260c0810187905260e0810183905260ff841661010082015261012001604051602081830303815290604052905061152885858484611bad565b505050505050565b7f7e5b1c957d4df4bad29cdaceffe50f28f282a0d5096601b958917550d4b2e01661155a81611613565b6001600160a01b03841660009081526101656020908152604080832054610163909252909120839055428110156115b6576001600160a01b03851660009081526101656020908152604080832042870190556101649091528120555b6001600160a01b0385166000818152610166602052604090819020869055517fc5f291321b52c0a880f53a520482ae7920b1e570181bea4971307e9ba13026de906116049087815260200190565b60405180910390a25050505050565b610aaf81336121a8565b600082815260c8602090815260408083206001600160a01b038516845290915290205460ff1661085957600082815260c8602090815260408083206001600160a01b03851684529091529020805460ff1916600117905561167b3390565b6001600160a01b0316816001600160a01b0316837f2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d60405160405180910390a45050565b600082815260c8602090815260408083206001600160a01b038516845290915290205460ff161561085957600082815260c8602090815260408083206001600160a01b0385168085529252808320805460ff1916905551339285917ff6391f5c32d9c69d2a47ea670b442974b53935d1edc7fd64eb21e047a839171b9190a45050565b600061085981611613565b7f4910fdfa16fed3260ed0e7147f7cc6da11a60208b5b9406d12a635614ffd91435460ff1615611780576108828361221d565b826001600160a01b03166352d1902d6040518163ffffffff1660e01b815260040160206040518083038186803b1580156117b957600080fd5b505afa9250505080156117e9575060408051601f3d908101601f191682019092526117e691810190613055565b60015b61185b5760405162461bcd60e51b815260206004820152602e60248201527f45524331393637557067726164653a206e657720696d706c656d656e7461746960448201527f6f6e206973206e6f7420555550530000000000000000000000000000000000006064820152608401610901565b7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc81146118f05760405162461bcd60e51b815260206004820152602960248201527f45524331393637557067726164653a20756e737570706f727465642070726f7860448201527f6961626c655555494400000000000000000000000000000000000000000000006064820152608401610901565b506108828383836122f3565b61190461231e565b6064805460ff191690557f5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa335b6040516001600160a01b03909116815260200160405180910390a1565b60645460ff16156119a15760405162461bcd60e51b815260206004820152601060248201527f5061757361626c653a20706175736564000000000000000000000000000000006044820152606401610901565b565b6000546040517f23c640e7000000000000000000000000000000000000000000000000000000008152620100009091046001600160a01b0316906323c640e7906119f3908590859060040161306e565b600060405180830381600087803b158015611a0d57600080fd5b505af1158015611528573d6000803e3d6000fd5b6001600160a01b0381166000908152610162602052604081205480611b0a57826001600160a01b031663313ce5676040518163ffffffff1660e01b815260040160206040518083038186803b158015611a7957600080fd5b505afa925050508015611aa9575060408051601f3d908101601f19168201909252611aa691810190613087565b60015b611acf5750506001600160a01b0316600090815261016260205260408120600019905590565b60ff811615611ae1578060ff16611ae5565b6000195b6001600160a01b03909416600090815261016260205260409020939093555090919050565b6000198114156107f35750600092915050565b600060098360ff161115611ba7577ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff760ff841601600a0a808381611b6357611b636130aa565b0615611b9b576040517f2c5211c600000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b8083045b9150506107f3565b50919050565b81611be4576040517f61ac6eba00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b67ffffffffffffffff821115611c26576040517f2c5211c600000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6001600160a01b03841660009081526101606020526040812054611c4b9084906130d9565b905067ffffffffffffffff811115611c8f576040517fa9112a1e00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b61015e5460ff168015611cba57506001600160a01b0385166000908152610161602052604090205481115b15611cf1576040517f22eef62800000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6001600160a01b038516600090815261016060205260409020819055611d377fe821b978bcce9abbf40c3e50ea30143e68c65fa95b9da8907fef59c02d954cec836119a3565b611d4c6001600160a01b038616333087612370565b6040518481526001600160a01b0386169033907f182fa52899142d44ff5c45a6354d3b3e868d5b07db6a65580b39bd321bdaf8ac9060200160405180910390a35050505050565b60008060029054906101000a90046001600160a01b03166001600160a01b031663d67bdd256040518163ffffffff1660e01b815260040160206040518083038186803b158015611de257600080fd5b505afa158015611df6573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611e1a9190613055565b905090565b600060098360ff161115611ba7576000611e3d600960ff861661303e565b611e4890600a6131d5565b9050611b9f81846131e1565b6001600160a01b03821660009081526101656020526040812054421115611ea857506001600160a01b0382166000908152610163602090815260408083205461016590925290912042909101905580611ec6565b506001600160a01b0382166000908152610164602052604090205481015b6001600160a01b03831660009081526101666020526040902054811115611f19576040517fa74c1c5f00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6001600160a01b039092166000908152610164602052604090209190915550565b6040516001600160a01b0383166024820152604481018290526108829084907fa9059cbb00000000000000000000000000000000000000000000000000000000906064015b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff00000000000000000000000000000000000000000000000000000000909316929092179091526123c1565b611feb61194e565b6064805460ff191660011790557f62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a2586119313390565b600054610100900460ff1661209d5760405162461bcd60e51b815260206004820152602b60248201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960448201527f6e697469616c697a696e670000000000000000000000000000000000000000006064820152608401610901565b610aaf816124a9565b600054610100900460ff166121235760405162461bcd60e51b815260206004820152602b60248201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960448201527f6e697469616c697a696e670000000000000000000000000000000000000000006064820152608401610901565b6119a1612566565b600054610100900460ff166119a15760405162461bcd60e51b815260206004820152602b60248201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960448201527f6e697469616c697a696e670000000000000000000000000000000000000000006064820152608401610901565b600082815260c8602090815260408083206001600160a01b038516845290915290205460ff16610859576121db816125ef565b6121e6836020612601565b6040516020016121f7929190613200565b60408051601f198184030181529082905262461bcd60e51b825261090191600401613281565b6001600160a01b0381163b61229a5760405162461bcd60e51b815260206004820152602d60248201527f455243313936373a206e657720696d706c656d656e746174696f6e206973206e60448201527f6f74206120636f6e7472616374000000000000000000000000000000000000006064820152608401610901565b7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc80547fffffffffffffffffffffffff0000000000000000000000000000000000000000166001600160a01b0392909216919091179055565b6122fc83612831565b6000825111806123095750805b15610882576123188383612871565b50505050565b60645460ff166119a15760405162461bcd60e51b815260206004820152601460248201527f5061757361626c653a206e6f74207061757365640000000000000000000000006044820152606401610901565b6040516001600160a01b03808516602483015283166044820152606481018290526123189085907f23b872dd0000000000000000000000000000000000000000000000000000000090608401611f7f565b6000612416826040518060400160405280602081526020017f5361666545524332303a206c6f772d6c6576656c2063616c6c206661696c6564815250856001600160a01b03166128969092919063ffffffff16565b90508051600014806124375750808060200190518101906124379190613294565b6108825760405162461bcd60e51b815260206004820152602a60248201527f5361666545524332303a204552433230206f7065726174696f6e20646964206e60448201527f6f742073756363656564000000000000000000000000000000000000000000006064820152608401610901565b600054610100900460ff166125265760405162461bcd60e51b815260206004820152602b60248201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960448201527f6e697469616c697a696e670000000000000000000000000000000000000000006064820152608401610901565b600080546001600160a01b0390921662010000027fffffffffffffffffffff0000000000000000000000000000000000000000ffff909216919091179055565b600054610100900460ff166125e35760405162461bcd60e51b815260206004820152602b60248201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960448201527f6e697469616c697a696e670000000000000000000000000000000000000000006064820152608401610901565b6064805460ff19169055565b60606107f36001600160a01b03831660145b606060006126108360026131e1565b61261b9060026130d9565b67ffffffffffffffff81111561263357612633612b6f565b6040519080825280601f01601f19166020018201604052801561265d576020820181803683370190505b5090507f300000000000000000000000000000000000000000000000000000000000000081600081518110612694576126946132b1565b60200101907effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916908160001a9053507f7800000000000000000000000000000000000000000000000000000000000000816001815181106126f7576126f76132b1565b60200101907effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916908160001a90535060006127338460026131e1565b61273e9060016130d9565b90505b60018111156127db577f303132333435363738396162636465660000000000000000000000000000000085600f166010811061277f5761277f6132b1565b1a60f81b828281518110612795576127956132b1565b60200101907effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916908160001a90535060049490941c936127d4816132e0565b9050612741565b50831561282a5760405162461bcd60e51b815260206004820181905260248201527f537472696e67733a20686578206c656e67746820696e73756666696369656e746044820152606401610901565b9392505050565b61283a8161221d565b6040516001600160a01b038216907fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b90600090a250565b606061282a8383604051806060016040528060278152602001613314602791396128ad565b60606128a58484600085612925565b949350505050565b6060600080856001600160a01b0316856040516128ca91906132f7565b600060405180830381855af49150503d8060008114612905576040519150601f19603f3d011682016040523d82523d6000602084013e61290a565b606091505b509150915061291b86838387612a17565b9695505050505050565b60608247101561299d5760405162461bcd60e51b815260206004820152602660248201527f416464726573733a20696e73756666696369656e742062616c616e636520666f60448201527f722063616c6c00000000000000000000000000000000000000000000000000006064820152608401610901565b600080866001600160a01b031685876040516129b991906132f7565b60006040518083038185875af1925050503d80600081146129f6576040519150601f19603f3d011682016040523d82523d6000602084013e6129fb565b606091505b5091509150612a0c87838387612a17565b979650505050505050565b60608315612a83578251612a7c576001600160a01b0385163b612a7c5760405162461bcd60e51b815260206004820152601d60248201527f416464726573733a2063616c6c20746f206e6f6e2d636f6e74726163740000006044820152606401610901565b50816128a5565b6128a58383815115612a985781518083602001fd5b8060405162461bcd60e51b81526004016109019190613281565b600060208284031215612ac457600080fd5b81357fffffffff000000000000000000000000000000000000000000000000000000008116811461282a57600080fd5b600060208284031215612b0657600080fd5b5035919050565b6001600160a01b0381168114610aaf57600080fd5b600060208284031215612b3457600080fd5b813561282a81612b0d565b60008060408385031215612b5257600080fd5b823591506020830135612b6481612b0d565b809150509250929050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b604051601f8201601f1916810167ffffffffffffffff81118282101715612bc757612bc7612b6f565b604052919050565b600067ffffffffffffffff821115612be957612be9612b6f565b50601f01601f191660200190565b60008060408385031215612c0a57600080fd5b8235612c1581612b0d565b9150602083013567ffffffffffffffff811115612c3157600080fd5b8301601f81018513612c4257600080fd5b8035612c55612c5082612bcf565b612b9e565b818152866020838501011115612c6a57600080fd5b816020840160208301376000602083830101528093505050509250929050565b600080600080600060808688031215612ca257600080fd5b853594506020860135612cb481612b0d565b935060408601359250606086013567ffffffffffffffff80821115612cd857600080fd5b818801915088601f830112612cec57600080fd5b813581811115612cfb57600080fd5b896020828501011115612d0d57600080fd5b9699959850939650602001949392505050565b60008060008060808587031215612d3657600080fd5b8435612d4181612b0d565b93506020850135612d5181612b0d565b93969395505050506040820135916060013590565b8015158114610aaf57600080fd5b60008060408385031215612d8757600080fd5b8235612d9281612b0d565b91506020830135612b6481612d66565b60008060408385031215612db557600080fd5b8235612dc081612b0d565b946020939093013593505050565b600060208284031215612de057600080fd5b813561282a81612d66565b600080600060608486031215612e0057600080fd5b833592506020840135612e1281612b0d565b929592945050506040919091013590565b600080600060608486031215612e3857600080fd5b8335612e4381612b0d565b95602085013595506040909401359392505050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052602160045260246000fd5b60005b83811015612ea2578181015183820152602001612e8a565b838111156123185750506000910152565b600060208284031215612ec557600080fd5b815167ffffffffffffffff811115612edc57600080fd5b8201601f81018413612eed57600080fd5b8051612efb612c5082612bcf565b818152856020838501011115612f1057600080fd5b612f21826020830160208601612e87565b95945050505050565b60008151808452612f42816020860160208601612e87565b601f01601f19169290920160200192915050565b6001600160a01b0385168152836020820152608060408201526000612f7e6080830185612f2a565b8281036060840152612a0c8185612f2a565b83815282602082015260008251612fae816040850160208701612e87565b91909101604001949350505050565b8a81528960208201528860408201528760608201528660808201528560a08201528460c08201528360e082015260006101008385828501376000929093019092019081529a9950505050505050505050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b6000828210156130505761305061300f565b500390565b60006020828403121561306757600080fd5b5051919050565b8281526040602082015260006128a56040830184612f2a565b60006020828403121561309957600080fd5b815160ff8116811461282a57600080fd5b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601260045260246000fd5b600082198211156130ec576130ec61300f565b500190565b600181815b8085111561312c5781600019048211156131125761311261300f565b8085161561311f57918102915b93841c93908002906130f6565b509250929050565b600082613143575060016107f3565b81613150575060006107f3565b816001811461316657600281146131705761318c565b60019150506107f3565b60ff8411156131815761318161300f565b50506001821b6107f3565b5060208310610133831016604e8410600b84101617156131af575081810a6107f3565b6131b983836130f1565b80600019048211156131cd576131cd61300f565b029392505050565b600061282a8383613134565b60008160001904831182151516156131fb576131fb61300f565b500290565b7f416363657373436f6e74726f6c3a206163636f756e7420000000000000000000815260008351613238816017850160208801612e87565b7f206973206d697373696e6720726f6c65200000000000000000000000000000006017918401918201528351613275816028840160208801612e87565b01602801949350505050565b60208152600061282a6020830184612f2a565b6000602082840312156132a657600080fd5b815161282a81612d66565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052603260045260246000fd5b6000816132ef576132ef61300f565b506000190190565b60008251613309818460208701612e87565b919091019291505056fe416464726573733a206c6f772d6c6576656c2064656c65676174652063616c6c206661696c6564a264697066735822122075da34347346a25e491add0c998e2940a4762964efc077eab836513325f9019564736f6c63430008090033
Deployed Bytecode
0x60806040526004361061026a5760003560e01c8063819a045c11610153578063c4d66de8116100cb578063d810e6f81161007f578063e63ab1e911610064578063e63ab1e9146106f1578063fb08f3a114610725578063fdec40a51461074057600080fd5b8063d810e6f8146106a7578063d954863c146106de57600080fd5b8063caa9147c116100b0578063caa9147c14610646578063cb68448b14610659578063d547741f1461068757600080fd5b8063c4d66de8146105f8578063c97df9ca1461061857600080fd5b8063a161c20511610122578063a5d7496111610107578063a5d74961146105a5578063b37b363b146105c5578063b46f77e4146105d857600080fd5b8063a161c20514610559578063a217fddf1461059057600080fd5b8063819a045c146104b85780638456cb59146104e957806391d14854146104fe57806394d4578e1461054457600080fd5b80634f1ef286116101e657806352d1902d116101b55780635c975abb1161019a5780635c975abb146104765780635ce36f2c1461048e57806364a7fad9146104a557600080fd5b806352d1902d1461044e5780635714b5a91461046357600080fd5b80634f1ef286146103c35780635049c17f146103d65780635176a43d1461040457806352148c231461043b57600080fd5b80632acc021a1161023d57806336568abe1161022257806336568abe1461036e5780633659cfe61461038e5780633f4ba83a146103ae57600080fd5b80632acc021a146103205780632f2ff15d1461034e57600080fd5b806301ffc9a71461026f5780631a2a45fc146102a457806320800a00146102e6578063248a9ca3146102f0575b600080fd5b34801561027b57600080fd5b5061028f61028a366004612ab2565b610760565b60405190151581526020015b60405180910390f35b3480156102b057600080fd5b506102d87f7e5b1c957d4df4bad29cdaceffe50f28f282a0d5096601b958917550d4b2e01681565b60405190815260200161029b565b6102ee6107f9565b005b3480156102fc57600080fd5b506102d861030b366004612af4565b600090815260c8602052604090206001015490565b34801561032c57600080fd5b506102d861033b366004612b22565b6101636020526000908152604090205481565b34801561035a57600080fd5b506102ee610369366004612b3f565b61085d565b34801561037a57600080fd5b506102ee610389366004612b3f565b610887565b34801561039a57600080fd5b506102ee6103a9366004612b22565b610914565b3480156103ba57600080fd5b506102ee610ab2565b6102ee6103d1366004612bf7565b610ac5565b3480156103e257600080fd5b506102d86103f1366004612b22565b6101656020526000908152604090205481565b34801561041057600080fd5b506000546201000090046001600160a01b03166040516001600160a01b03909116815260200161029b565b6102ee610449366004612b22565b610c50565b34801561045a57600080fd5b506102d8610df6565b6102ee610471366004612c8a565b610ebb565b34801561048257600080fd5b5060645460ff1661028f565b34801561049a57600080fd5b506102d861015f5481565b6102ee6104b3366004612d20565b610f96565b3480156104c457600080fd5b5061028f6104d3366004612b22565b6101676020526000908152604090205460ff1681565b3480156104f557600080fd5b506102ee61114f565b34801561050a57600080fd5b5061028f610519366004612b3f565b600091825260c8602090815260408084206001600160a01b0393909316845291905290205460ff1690565b34801561055057600080fd5b506102d8600981565b34801561056557600080fd5b506102d8610574366004612b22565b6001600160a01b03166000908152610160602052604090205490565b34801561059c57600080fd5b506102d8600081565b3480156105b157600080fd5b506102ee6105c0366004612d74565b611181565b6102ee6105d3366004612da2565b61120c565b3480156105e457600080fd5b506102ee6105f3366004612dce565b611235565b34801561060457600080fd5b506102ee610613366004612b22565b611255565b34801561062457600080fd5b506102d8610633366004612b22565b6101646020526000908152604090205481565b6102ee610654366004612af4565b611427565b34801561066557600080fd5b506102d8610674366004612b22565b6101666020526000908152604090205481565b34801561069357600080fd5b506102ee6106a2366004612b3f565b611439565b3480156106b357600080fd5b506102d86106c2366004612b22565b6001600160a01b03166000908152610161602052604090205490565b6102ee6106ec366004612deb565b61145e565b3480156106fd57600080fd5b506102d87f65d7a28e3265b37a6474929f336521b332c1681b933f6cb9f3376673440d862a81565b34801561073157600080fd5b5061015e5461028f9060ff1681565b34801561074c57600080fd5b506102ee61075b366004612e23565b611530565b60007fffffffff0000000000000000000000000000000000000000000000000000000082167f7965db0b0000000000000000000000000000000000000000000000000000000014806107f357507f01ffc9a7000000000000000000000000000000000000000000000000000000007fffffffff000000000000000000000000000000000000000000000000000000008316145b92915050565b600061080481611613565b604051600090339047908381818185875af1925050503d8060008114610846576040519150601f19603f3d011682016040523d82523d6000602084013e61084b565b606091505b505090508061085957600080fd5b5050565b600082815260c8602052604090206001015461087881611613565b610882838361161d565b505050565b6001600160a01b038116331461090a5760405162461bcd60e51b815260206004820152602f60248201527f416363657373436f6e74726f6c3a2063616e206f6e6c792072656e6f756e636560448201527f20726f6c657320666f722073656c66000000000000000000000000000000000060648201526084015b60405180910390fd5b61085982826116bf565b306001600160a01b037f000000000000000000000000de2d792ca3c4d02de3ce1cd1456d8d0990cc3fab1614156109b35760405162461bcd60e51b815260206004820152602c60248201527f46756e6374696f6e206d7573742062652063616c6c6564207468726f7567682060448201527f64656c656761746563616c6c00000000000000000000000000000000000000006064820152608401610901565b7f000000000000000000000000de2d792ca3c4d02de3ce1cd1456d8d0990cc3fab6001600160a01b0316610a0e7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc546001600160a01b031690565b6001600160a01b031614610a8a5760405162461bcd60e51b815260206004820152602c60248201527f46756e6374696f6e206d7573742062652063616c6c6564207468726f7567682060448201527f6163746976652070726f787900000000000000000000000000000000000000006064820152608401610901565b610a9381611742565b60408051600080825260208201909252610aaf9183919061174d565b50565b6000610abd81611613565b610aaf6118fc565b306001600160a01b037f000000000000000000000000de2d792ca3c4d02de3ce1cd1456d8d0990cc3fab161415610b645760405162461bcd60e51b815260206004820152602c60248201527f46756e6374696f6e206d7573742062652063616c6c6564207468726f7567682060448201527f64656c656761746563616c6c00000000000000000000000000000000000000006064820152608401610901565b7f000000000000000000000000de2d792ca3c4d02de3ce1cd1456d8d0990cc3fab6001600160a01b0316610bbf7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc546001600160a01b031690565b6001600160a01b031614610c3b5760405162461bcd60e51b815260206004820152602c60248201527f46756e6374696f6e206d7573742062652063616c6c6564207468726f7567682060448201527f6163746976652070726f787900000000000000000000000000000000000000006064820152608401610901565b610c4482611742565b6108598282600161174d565b610c5861194e565b61015f54610c92576040517fbb2f9c9d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b61015f546000906003836000856001600160a01b03166306fdde036040518163ffffffff1660e01b815260040160006040518083038186803b158015610cd757600080fd5b505afa158015610ceb573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052610d139190810190612eb3565b866001600160a01b03166395d89b416040518163ffffffff1660e01b815260040160006040518083038186803b158015610d4c57600080fd5b505afa158015610d60573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052610d889190810190612eb3565b604051602001610d9b9493929190612f56565b60408051601f1981840301815290829052610dba939291602001612f90565b60408051601f1981840301815291905290506108597fe821b978bcce9abbf40c3e50ea30143e68c65fa95b9da8907fef59c02d954cec826119a3565b6000306001600160a01b037f000000000000000000000000de2d792ca3c4d02de3ce1cd1456d8d0990cc3fab1614610e965760405162461bcd60e51b815260206004820152603860248201527f555550535570677261646561626c653a206d757374206e6f742062652063616c60448201527f6c6564207468726f7567682064656c656761746563616c6c00000000000000006064820152608401610901565b507f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc90565b610ec361194e565b61015f54610efd576040517fbb2f9c9d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6000610f0885611a21565b90506000610f168286611b1d565b61015f549091506000908415610f2d576002610f30565b60015b6003811115610f4157610f41612e58565b604051610f6f9291906001600160a01b038b169060009033908e90899060ff8c16908e908e90602001612fbd565b6040516020818303038152906040529050610f8c87878484611bad565b5050505050505050565b610f9e61194e565b6000546201000090046001600160a01b03163314610fe8576040517f5c5536bd00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b8161101f576040517fc377136000000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b61015f5461102b611d93565b14611062576040517fddb5de5e00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b600061106d84611a21565b9050600061107b8285611e1f565b6001600160a01b0386166000908152610167602052604090205490915060ff16156110aa576110aa8582611e54565b6001600160a01b038516600090815261016060205260409020546110cf90859061303e565b6001600160a01b038616600081815261016060205260409020919091556110f7908783611f3a565b846001600160a01b0316866001600160a01b031660001b7f028ab133c73f6c00ad0c5896ef40eff18378acd3d7f2ecf573c2706582bf73bf8360405161113f91815260200190565b60405180910390a3505050505050565b7f65d7a28e3265b37a6474929f336521b332c1681b933f6cb9f3376673440d862a61117981611613565b610aaf611fe3565b7f7e5b1c957d4df4bad29cdaceffe50f28f282a0d5096601b958917550d4b2e0166111ab81611613565b6001600160a01b03831660008181526101676020908152604091829020805460ff191686151590811790915591519182527f8ac921afb63648e691280b72420b87f54bbdfebd4ba46618e07dc0231542e837910160405180910390a2505050565b600061121781611613565b506001600160a01b0390911660009081526101616020526040902055565b600061124081611613565b5061015e805460ff1916911515919091179055565b600054610100900460ff16158080156112755750600054600160ff909116105b8061128f5750303b15801561128f575060005460ff166001145b6113015760405162461bcd60e51b815260206004820152602e60248201527f496e697469616c697a61626c653a20636f6e747261637420697320616c72656160448201527f647920696e697469616c697a65640000000000000000000000000000000000006064820152608401610901565b6000805460ff19166001179055801561134157600080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00ff166101001790555b61134a82612020565b6113526120a6565b61135a61212b565b61136261212b565b61136d60003361161d565b6113977f65d7a28e3265b37a6474929f336521b332c1681b933f6cb9f3376673440d862a3361161d565b6113c17f7e5b1c957d4df4bad29cdaceffe50f28f282a0d5096601b958917550d4b2e0163361161d565b801561085957600080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00ff169055604051600181527f7f26b83ff96e1f2b6a682f133852f6798a09c465da95921460cefb38474024989060200160405180910390a15050565b600061143281611613565b5061015f55565b600082815260c8602052604090206001015461145481611613565b61088283836116bf565b61146661194e565b61015f546114a0576040517fbb2f9c9d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b60006114ab83611a21565b905060006114b98284611b1d565b61015f54909150600090816040805160208101939093528201526001600160a01b0386166060820152600060808201523360a082015260c0810187905260e0810183905260ff841661010082015261012001604051602081830303815290604052905061152885858484611bad565b505050505050565b7f7e5b1c957d4df4bad29cdaceffe50f28f282a0d5096601b958917550d4b2e01661155a81611613565b6001600160a01b03841660009081526101656020908152604080832054610163909252909120839055428110156115b6576001600160a01b03851660009081526101656020908152604080832042870190556101649091528120555b6001600160a01b0385166000818152610166602052604090819020869055517fc5f291321b52c0a880f53a520482ae7920b1e570181bea4971307e9ba13026de906116049087815260200190565b60405180910390a25050505050565b610aaf81336121a8565b600082815260c8602090815260408083206001600160a01b038516845290915290205460ff1661085957600082815260c8602090815260408083206001600160a01b03851684529091529020805460ff1916600117905561167b3390565b6001600160a01b0316816001600160a01b0316837f2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d60405160405180910390a45050565b600082815260c8602090815260408083206001600160a01b038516845290915290205460ff161561085957600082815260c8602090815260408083206001600160a01b0385168085529252808320805460ff1916905551339285917ff6391f5c32d9c69d2a47ea670b442974b53935d1edc7fd64eb21e047a839171b9190a45050565b600061085981611613565b7f4910fdfa16fed3260ed0e7147f7cc6da11a60208b5b9406d12a635614ffd91435460ff1615611780576108828361221d565b826001600160a01b03166352d1902d6040518163ffffffff1660e01b815260040160206040518083038186803b1580156117b957600080fd5b505afa9250505080156117e9575060408051601f3d908101601f191682019092526117e691810190613055565b60015b61185b5760405162461bcd60e51b815260206004820152602e60248201527f45524331393637557067726164653a206e657720696d706c656d656e7461746960448201527f6f6e206973206e6f7420555550530000000000000000000000000000000000006064820152608401610901565b7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc81146118f05760405162461bcd60e51b815260206004820152602960248201527f45524331393637557067726164653a20756e737570706f727465642070726f7860448201527f6961626c655555494400000000000000000000000000000000000000000000006064820152608401610901565b506108828383836122f3565b61190461231e565b6064805460ff191690557f5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa335b6040516001600160a01b03909116815260200160405180910390a1565b60645460ff16156119a15760405162461bcd60e51b815260206004820152601060248201527f5061757361626c653a20706175736564000000000000000000000000000000006044820152606401610901565b565b6000546040517f23c640e7000000000000000000000000000000000000000000000000000000008152620100009091046001600160a01b0316906323c640e7906119f3908590859060040161306e565b600060405180830381600087803b158015611a0d57600080fd5b505af1158015611528573d6000803e3d6000fd5b6001600160a01b0381166000908152610162602052604081205480611b0a57826001600160a01b031663313ce5676040518163ffffffff1660e01b815260040160206040518083038186803b158015611a7957600080fd5b505afa925050508015611aa9575060408051601f3d908101601f19168201909252611aa691810190613087565b60015b611acf5750506001600160a01b0316600090815261016260205260408120600019905590565b60ff811615611ae1578060ff16611ae5565b6000195b6001600160a01b03909416600090815261016260205260409020939093555090919050565b6000198114156107f35750600092915050565b600060098360ff161115611ba7577ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff760ff841601600a0a808381611b6357611b636130aa565b0615611b9b576040517f2c5211c600000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b8083045b9150506107f3565b50919050565b81611be4576040517f61ac6eba00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b67ffffffffffffffff821115611c26576040517f2c5211c600000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6001600160a01b03841660009081526101606020526040812054611c4b9084906130d9565b905067ffffffffffffffff811115611c8f576040517fa9112a1e00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b61015e5460ff168015611cba57506001600160a01b0385166000908152610161602052604090205481115b15611cf1576040517f22eef62800000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6001600160a01b038516600090815261016060205260409020819055611d377fe821b978bcce9abbf40c3e50ea30143e68c65fa95b9da8907fef59c02d954cec836119a3565b611d4c6001600160a01b038616333087612370565b6040518481526001600160a01b0386169033907f182fa52899142d44ff5c45a6354d3b3e868d5b07db6a65580b39bd321bdaf8ac9060200160405180910390a35050505050565b60008060029054906101000a90046001600160a01b03166001600160a01b031663d67bdd256040518163ffffffff1660e01b815260040160206040518083038186803b158015611de257600080fd5b505afa158015611df6573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611e1a9190613055565b905090565b600060098360ff161115611ba7576000611e3d600960ff861661303e565b611e4890600a6131d5565b9050611b9f81846131e1565b6001600160a01b03821660009081526101656020526040812054421115611ea857506001600160a01b0382166000908152610163602090815260408083205461016590925290912042909101905580611ec6565b506001600160a01b0382166000908152610164602052604090205481015b6001600160a01b03831660009081526101666020526040902054811115611f19576040517fa74c1c5f00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6001600160a01b039092166000908152610164602052604090209190915550565b6040516001600160a01b0383166024820152604481018290526108829084907fa9059cbb00000000000000000000000000000000000000000000000000000000906064015b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff00000000000000000000000000000000000000000000000000000000909316929092179091526123c1565b611feb61194e565b6064805460ff191660011790557f62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a2586119313390565b600054610100900460ff1661209d5760405162461bcd60e51b815260206004820152602b60248201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960448201527f6e697469616c697a696e670000000000000000000000000000000000000000006064820152608401610901565b610aaf816124a9565b600054610100900460ff166121235760405162461bcd60e51b815260206004820152602b60248201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960448201527f6e697469616c697a696e670000000000000000000000000000000000000000006064820152608401610901565b6119a1612566565b600054610100900460ff166119a15760405162461bcd60e51b815260206004820152602b60248201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960448201527f6e697469616c697a696e670000000000000000000000000000000000000000006064820152608401610901565b600082815260c8602090815260408083206001600160a01b038516845290915290205460ff16610859576121db816125ef565b6121e6836020612601565b6040516020016121f7929190613200565b60408051601f198184030181529082905262461bcd60e51b825261090191600401613281565b6001600160a01b0381163b61229a5760405162461bcd60e51b815260206004820152602d60248201527f455243313936373a206e657720696d706c656d656e746174696f6e206973206e60448201527f6f74206120636f6e7472616374000000000000000000000000000000000000006064820152608401610901565b7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc80547fffffffffffffffffffffffff0000000000000000000000000000000000000000166001600160a01b0392909216919091179055565b6122fc83612831565b6000825111806123095750805b15610882576123188383612871565b50505050565b60645460ff166119a15760405162461bcd60e51b815260206004820152601460248201527f5061757361626c653a206e6f74207061757365640000000000000000000000006044820152606401610901565b6040516001600160a01b03808516602483015283166044820152606481018290526123189085907f23b872dd0000000000000000000000000000000000000000000000000000000090608401611f7f565b6000612416826040518060400160405280602081526020017f5361666545524332303a206c6f772d6c6576656c2063616c6c206661696c6564815250856001600160a01b03166128969092919063ffffffff16565b90508051600014806124375750808060200190518101906124379190613294565b6108825760405162461bcd60e51b815260206004820152602a60248201527f5361666545524332303a204552433230206f7065726174696f6e20646964206e60448201527f6f742073756363656564000000000000000000000000000000000000000000006064820152608401610901565b600054610100900460ff166125265760405162461bcd60e51b815260206004820152602b60248201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960448201527f6e697469616c697a696e670000000000000000000000000000000000000000006064820152608401610901565b600080546001600160a01b0390921662010000027fffffffffffffffffffff0000000000000000000000000000000000000000ffff909216919091179055565b600054610100900460ff166125e35760405162461bcd60e51b815260206004820152602b60248201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960448201527f6e697469616c697a696e670000000000000000000000000000000000000000006064820152608401610901565b6064805460ff19169055565b60606107f36001600160a01b03831660145b606060006126108360026131e1565b61261b9060026130d9565b67ffffffffffffffff81111561263357612633612b6f565b6040519080825280601f01601f19166020018201604052801561265d576020820181803683370190505b5090507f300000000000000000000000000000000000000000000000000000000000000081600081518110612694576126946132b1565b60200101907effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916908160001a9053507f7800000000000000000000000000000000000000000000000000000000000000816001815181106126f7576126f76132b1565b60200101907effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916908160001a90535060006127338460026131e1565b61273e9060016130d9565b90505b60018111156127db577f303132333435363738396162636465660000000000000000000000000000000085600f166010811061277f5761277f6132b1565b1a60f81b828281518110612795576127956132b1565b60200101907effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916908160001a90535060049490941c936127d4816132e0565b9050612741565b50831561282a5760405162461bcd60e51b815260206004820181905260248201527f537472696e67733a20686578206c656e67746820696e73756666696369656e746044820152606401610901565b9392505050565b61283a8161221d565b6040516001600160a01b038216907fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b90600090a250565b606061282a8383604051806060016040528060278152602001613314602791396128ad565b60606128a58484600085612925565b949350505050565b6060600080856001600160a01b0316856040516128ca91906132f7565b600060405180830381855af49150503d8060008114612905576040519150601f19603f3d011682016040523d82523d6000602084013e61290a565b606091505b509150915061291b86838387612a17565b9695505050505050565b60608247101561299d5760405162461bcd60e51b815260206004820152602660248201527f416464726573733a20696e73756666696369656e742062616c616e636520666f60448201527f722063616c6c00000000000000000000000000000000000000000000000000006064820152608401610901565b600080866001600160a01b031685876040516129b991906132f7565b60006040518083038185875af1925050503d80600081146129f6576040519150601f19603f3d011682016040523d82523d6000602084013e6129fb565b606091505b5091509150612a0c87838387612a17565b979650505050505050565b60608315612a83578251612a7c576001600160a01b0385163b612a7c5760405162461bcd60e51b815260206004820152601d60248201527f416464726573733a2063616c6c20746f206e6f6e2d636f6e74726163740000006044820152606401610901565b50816128a5565b6128a58383815115612a985781518083602001fd5b8060405162461bcd60e51b81526004016109019190613281565b600060208284031215612ac457600080fd5b81357fffffffff000000000000000000000000000000000000000000000000000000008116811461282a57600080fd5b600060208284031215612b0657600080fd5b5035919050565b6001600160a01b0381168114610aaf57600080fd5b600060208284031215612b3457600080fd5b813561282a81612b0d565b60008060408385031215612b5257600080fd5b823591506020830135612b6481612b0d565b809150509250929050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b604051601f8201601f1916810167ffffffffffffffff81118282101715612bc757612bc7612b6f565b604052919050565b600067ffffffffffffffff821115612be957612be9612b6f565b50601f01601f191660200190565b60008060408385031215612c0a57600080fd5b8235612c1581612b0d565b9150602083013567ffffffffffffffff811115612c3157600080fd5b8301601f81018513612c4257600080fd5b8035612c55612c5082612bcf565b612b9e565b818152866020838501011115612c6a57600080fd5b816020840160208301376000602083830101528093505050509250929050565b600080600080600060808688031215612ca257600080fd5b853594506020860135612cb481612b0d565b935060408601359250606086013567ffffffffffffffff80821115612cd857600080fd5b818801915088601f830112612cec57600080fd5b813581811115612cfb57600080fd5b896020828501011115612d0d57600080fd5b9699959850939650602001949392505050565b60008060008060808587031215612d3657600080fd5b8435612d4181612b0d565b93506020850135612d5181612b0d565b93969395505050506040820135916060013590565b8015158114610aaf57600080fd5b60008060408385031215612d8757600080fd5b8235612d9281612b0d565b91506020830135612b6481612d66565b60008060408385031215612db557600080fd5b8235612dc081612b0d565b946020939093013593505050565b600060208284031215612de057600080fd5b813561282a81612d66565b600080600060608486031215612e0057600080fd5b833592506020840135612e1281612b0d565b929592945050506040919091013590565b600080600060608486031215612e3857600080fd5b8335612e4381612b0d565b95602085013595506040909401359392505050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052602160045260246000fd5b60005b83811015612ea2578181015183820152602001612e8a565b838111156123185750506000910152565b600060208284031215612ec557600080fd5b815167ffffffffffffffff811115612edc57600080fd5b8201601f81018413612eed57600080fd5b8051612efb612c5082612bcf565b818152856020838501011115612f1057600080fd5b612f21826020830160208601612e87565b95945050505050565b60008151808452612f42816020860160208601612e87565b601f01601f19169290920160200192915050565b6001600160a01b0385168152836020820152608060408201526000612f7e6080830185612f2a565b8281036060840152612a0c8185612f2a565b83815282602082015260008251612fae816040850160208701612e87565b91909101604001949350505050565b8a81528960208201528860408201528760608201528660808201528560a08201528460c08201528360e082015260006101008385828501376000929093019092019081529a9950505050505050505050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b6000828210156130505761305061300f565b500390565b60006020828403121561306757600080fd5b5051919050565b8281526040602082015260006128a56040830184612f2a565b60006020828403121561309957600080fd5b815160ff8116811461282a57600080fd5b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601260045260246000fd5b600082198211156130ec576130ec61300f565b500190565b600181815b8085111561312c5781600019048211156131125761311261300f565b8085161561311f57918102915b93841c93908002906130f6565b509250929050565b600082613143575060016107f3565b81613150575060006107f3565b816001811461316657600281146131705761318c565b60019150506107f3565b60ff8411156131815761318161300f565b50506001821b6107f3565b5060208310610133831016604e8410600b84101617156131af575081810a6107f3565b6131b983836130f1565b80600019048211156131cd576131cd61300f565b029392505050565b600061282a8383613134565b60008160001904831182151516156131fb576131fb61300f565b500290565b7f416363657373436f6e74726f6c3a206163636f756e7420000000000000000000815260008351613238816017850160208801612e87565b7f206973206d697373696e6720726f6c65200000000000000000000000000000006017918401918201528351613275816028840160208801612e87565b01602801949350505050565b60208152600061282a6020830184612f2a565b6000602082840312156132a657600080fd5b815161282a81612d66565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052603260045260246000fd5b6000816132ef576132ef61300f565b506000190190565b60008251613309818460208701612e87565b919091019291505056fe416464726573733a206c6f772d6c6576656c2064656c65676174652063616c6c206661696c6564a264697066735822122075da34347346a25e491add0c998e2940a4762964efc077eab836513325f9019564736f6c63430008090033
Loading...
Loading
Loading...
Loading
Net Worth in USD
$0.00
Net Worth in ETH
0
Multichain Portfolio | 33 Chains
| Chain | Token | Portfolio % | Price | Amount | Value |
|---|
Loading...
Loading
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.