Overview
APE Balance
APE Value
$0.00Multichain Info
Latest 1 from a total of 1 transactions
| Transaction Hash |
|
Block
|
From
|
To
|
|||||
|---|---|---|---|---|---|---|---|---|---|
| Initialize | 20216554 | 178 days ago | IN | 0 APE | 0.00730275 |
Latest 1 internal transaction
| Parent Transaction Hash | Block | From | To | |||
|---|---|---|---|---|---|---|
| 20216529 | 178 days ago | Contract Creation | 0 APE |
Cross-Chain Transactions
Similar Match Source Code This contract matches the deployed Bytecode of the Source Code for Contract 0xa6D02337...c503424Ee The constructor portion of the code might be different and could alter the actual behaviour of the contract
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (proxy/transparent/TransparentUpgradeableProxy.sol)
pragma solidity ^0.8.22;
import {ERC1967Utils} from "../ERC1967/ERC1967Utils.sol";
import {ERC1967Proxy} from "../ERC1967/ERC1967Proxy.sol";
import {IERC1967} from "../../interfaces/IERC1967.sol";
import {ProxyAdmin} from "./ProxyAdmin.sol";
/**
* @dev Interface for {TransparentUpgradeableProxy}. In order to implement transparency, {TransparentUpgradeableProxy}
* does not implement this interface directly, and its upgradeability mechanism is implemented by an internal dispatch
* mechanism. The compiler is unaware that these functions are implemented by {TransparentUpgradeableProxy} and will not
* include them in the ABI so this interface must be used to interact with it.
*/
interface ITransparentUpgradeableProxy is IERC1967 {
/// @dev See {UUPSUpgradeable-upgradeToAndCall}
function upgradeToAndCall(address newImplementation, bytes calldata data) external payable;
}
/**
* @dev This contract implements a proxy that is upgradeable through an associated {ProxyAdmin} instance.
*
* To avoid https://medium.com/nomic-labs-blog/malicious-backdoors-in-ethereum-proxies-62629adf3357[proxy selector
* clashing], which can potentially be used in an attack, this contract uses the
* https://blog.openzeppelin.com/the-transparent-proxy-pattern/[transparent proxy pattern]. This pattern implies two
* things that go hand in hand:
*
* 1. If any account other than the admin calls the proxy, the call will be forwarded to the implementation, even if
* that call matches the {ITransparentUpgradeableProxy-upgradeToAndCall} function exposed by the proxy itself.
* 2. If the admin calls the proxy, it can call the `upgradeToAndCall` function but any other call won't be forwarded to
* the implementation. If the admin tries to call a function on the implementation it will fail with an error indicating
* the proxy admin cannot fallback to the target implementation.
*
* These properties mean that the admin account can only be used for upgrading the proxy, so it's best if it's a
* dedicated account that is not used for anything else. This will avoid headaches due to sudden errors when trying to
* call a function from the proxy implementation. For this reason, the proxy deploys an instance of {ProxyAdmin} and
* allows upgrades only if they come through it. You should think of the `ProxyAdmin` instance as the administrative
* interface of the proxy, including the ability to change who can trigger upgrades by transferring ownership.
*
* NOTE: The real interface of this proxy is that defined in `ITransparentUpgradeableProxy`. This contract does not
* inherit from that interface, and instead `upgradeToAndCall` is implicitly implemented using a custom dispatch
* mechanism in `_fallback`. Consequently, the compiler will not produce an ABI for this contract. This is necessary to
* fully implement transparency without decoding reverts caused by selector clashes between the proxy and the
* implementation.
*
* NOTE: This proxy does not inherit from {Context} deliberately. The {ProxyAdmin} of this contract won't send a
* meta-transaction in any way, and any other meta-transaction setup should be made in the implementation contract.
*
* IMPORTANT: This contract avoids unnecessary storage reads by setting the admin only during construction as an
* immutable variable, preventing any changes thereafter. However, the admin slot defined in ERC-1967 can still be
* overwritten by the implementation logic pointed to by this proxy. In such cases, the contract may end up in an
* undesirable state where the admin slot is different from the actual admin. Relying on the value of the admin slot
* is generally fine if the implementation is trusted.
*
* WARNING: It is not recommended to extend this contract to add additional external functions. If you do so, the
* compiler will not check that there are no selector conflicts, due to the note above. A selector clash between any new
* function and the functions declared in {ITransparentUpgradeableProxy} will be resolved in favor of the new one. This
* could render the `upgradeToAndCall` function inaccessible, preventing upgradeability and compromising transparency.
*/
contract TransparentUpgradeableProxy is ERC1967Proxy {
// An immutable address for the admin to avoid unnecessary SLOADs before each call
// at the expense of removing the ability to change the admin once it's set.
// This is acceptable if the admin is always a ProxyAdmin instance or similar contract
// with its own ability to transfer the permissions to another account.
address private immutable _admin;
/**
* @dev The proxy caller is the current admin, and can't fallback to the proxy target.
*/
error ProxyDeniedAdminAccess();
/**
* @dev Initializes an upgradeable proxy managed by an instance of a {ProxyAdmin} with an `initialOwner`,
* backed by the implementation at `_logic`, and optionally initialized with `_data` as explained in
* {ERC1967Proxy-constructor}.
*/
constructor(address _logic, address initialOwner, bytes memory _data) payable ERC1967Proxy(_logic, _data) {
_admin = address(new ProxyAdmin(initialOwner));
// Set the storage value and emit an event for ERC-1967 compatibility
ERC1967Utils.changeAdmin(_proxyAdmin());
}
/**
* @dev Returns the admin of this proxy.
*/
function _proxyAdmin() internal view virtual returns (address) {
return _admin;
}
/**
* @dev If caller is the admin process the call internally, otherwise transparently fallback to the proxy behavior.
*/
function _fallback() internal virtual override {
if (msg.sender == _proxyAdmin()) {
if (msg.sig != ITransparentUpgradeableProxy.upgradeToAndCall.selector) {
revert ProxyDeniedAdminAccess();
} else {
_dispatchUpgradeToAndCall();
}
} else {
super._fallback();
}
}
/**
* @dev Upgrade the implementation of the proxy. See {ERC1967Utils-upgradeToAndCall}.
*
* Requirements:
*
* - If `data` is empty, `msg.value` must be zero.
*/
function _dispatchUpgradeToAndCall() private {
(address newImplementation, bytes memory data) = abi.decode(msg.data[4:], (address, bytes));
ERC1967Utils.upgradeToAndCall(newImplementation, data);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (access/AccessControl.sol)
pragma solidity ^0.8.20;
import {IAccessControl} from "@openzeppelin/contracts/access/IAccessControl.sol";
import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol";
import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import {ERC165Upgradeable} from "../utils/introspection/ERC165Upgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module that allows children to implement role-based access
* control mechanisms. This is a lightweight version that doesn't allow enumerating role
* members except through off-chain means by accessing the contract event logs. Some
* applications may benefit from on-chain enumerability, for those cases see
* {AccessControlEnumerable}.
*
* Roles are referred to by their `bytes32` identifier. These should be exposed
* in the external API and be unique. The best way to achieve this is by
* using `public constant` hash digests:
*
* ```solidity
* bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
* ```
*
* Roles can be used to represent a set of permissions. To restrict access to a
* function call, use {hasRole}:
*
* ```solidity
* function foo() public {
* require(hasRole(MY_ROLE, msg.sender));
* ...
* }
* ```
*
* Roles can be granted and revoked dynamically via the {grantRole} and
* {revokeRole} functions. Each role has an associated admin role, and only
* accounts that have a role's admin role can call {grantRole} and {revokeRole}.
*
* By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
* that only accounts with this role will be able to grant or revoke other
* roles. More complex role relationships can be created by using
* {_setRoleAdmin}.
*
* WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
* grant and revoke this role. Extra precautions should be taken to secure
* accounts that have been granted it. We recommend using {AccessControlDefaultAdminRules}
* to enforce additional security measures for this role.
*/
abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable, IAccessControl, ERC165Upgradeable {
struct RoleData {
mapping(address account => bool) hasRole;
bytes32 adminRole;
}
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
/// @custom:storage-location erc7201:openzeppelin.storage.AccessControl
struct AccessControlStorage {
mapping(bytes32 role => RoleData) _roles;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.AccessControl")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant AccessControlStorageLocation = 0x02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b626800;
function _getAccessControlStorage() private pure returns (AccessControlStorage storage $) {
assembly {
$.slot := AccessControlStorageLocation
}
}
/**
* @dev Modifier that checks that an account has a specific role. Reverts
* with an {AccessControlUnauthorizedAccount} error including the required role.
*/
modifier onlyRole(bytes32 role) {
_checkRole(role);
_;
}
function __AccessControl_init() internal onlyInitializing {
}
function __AccessControl_init_unchained() internal onlyInitializing {
}
/// @inheritdoc IERC165
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IAccessControl).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) public view virtual returns (bool) {
AccessControlStorage storage $ = _getAccessControlStorage();
return $._roles[role].hasRole[account];
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `_msgSender()`
* is missing `role`. Overriding this function changes the behavior of the {onlyRole} modifier.
*/
function _checkRole(bytes32 role) internal view virtual {
_checkRole(role, _msgSender());
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `account`
* is missing `role`.
*/
function _checkRole(bytes32 role, address account) internal view virtual {
if (!hasRole(role, account)) {
revert AccessControlUnauthorizedAccount(account, role);
}
}
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) public view virtual returns (bytes32) {
AccessControlStorage storage $ = _getAccessControlStorage();
return $._roles[role].adminRole;
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleGranted} event.
*/
function grantRole(bytes32 role, address account) public virtual onlyRole(getRoleAdmin(role)) {
_grantRole(role, account);
}
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleRevoked} event.
*/
function revokeRole(bytes32 role, address account) public virtual onlyRole(getRoleAdmin(role)) {
_revokeRole(role, account);
}
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been revoked `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `callerConfirmation`.
*
* May emit a {RoleRevoked} event.
*/
function renounceRole(bytes32 role, address callerConfirmation) public virtual {
if (callerConfirmation != _msgSender()) {
revert AccessControlBadConfirmation();
}
_revokeRole(role, callerConfirmation);
}
/**
* @dev Sets `adminRole` as ``role``'s admin role.
*
* Emits a {RoleAdminChanged} event.
*/
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
AccessControlStorage storage $ = _getAccessControlStorage();
bytes32 previousAdminRole = getRoleAdmin(role);
$._roles[role].adminRole = adminRole;
emit RoleAdminChanged(role, previousAdminRole, adminRole);
}
/**
* @dev Attempts to grant `role` to `account` and returns a boolean indicating if `role` was granted.
*
* Internal function without access restriction.
*
* May emit a {RoleGranted} event.
*/
function _grantRole(bytes32 role, address account) internal virtual returns (bool) {
AccessControlStorage storage $ = _getAccessControlStorage();
if (!hasRole(role, account)) {
$._roles[role].hasRole[account] = true;
emit RoleGranted(role, account, _msgSender());
return true;
} else {
return false;
}
}
/**
* @dev Attempts to revoke `role` from `account` and returns a boolean indicating if `role` was revoked.
*
* Internal function without access restriction.
*
* May emit a {RoleRevoked} event.
*/
function _revokeRole(bytes32 role, address account) internal virtual returns (bool) {
AccessControlStorage storage $ = _getAccessControlStorage();
if (hasRole(role, account)) {
$._roles[role].hasRole[account] = false;
emit RoleRevoked(role, account, _msgSender());
return true;
} else {
return false;
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.20;
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```solidity
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
*
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Storage of the initializable contract.
*
* It's implemented on a custom ERC-7201 namespace to reduce the risk of storage collisions
* when using with upgradeable contracts.
*
* @custom:storage-location erc7201:openzeppelin.storage.Initializable
*/
struct InitializableStorage {
/**
* @dev Indicates that the contract has been initialized.
*/
uint64 _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool _initializing;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Initializable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant INITIALIZABLE_STORAGE = 0xf0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00;
/**
* @dev The contract is already initialized.
*/
error InvalidInitialization();
/**
* @dev The contract is not initializing.
*/
error NotInitializing();
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint64 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts.
*
* Similar to `reinitializer(1)`, except that in the context of a constructor an `initializer` may be invoked any
* number of times. This behavior in the constructor can be useful during testing and is not expected to be used in
* production.
*
* Emits an {Initialized} event.
*/
modifier initializer() {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
// Cache values to avoid duplicated sloads
bool isTopLevelCall = !$._initializing;
uint64 initialized = $._initialized;
// Allowed calls:
// - initialSetup: the contract is not in the initializing state and no previous version was
// initialized
// - construction: the contract is initialized at version 1 (no reinitialization) and the
// current contract is just being deployed
bool initialSetup = initialized == 0 && isTopLevelCall;
bool construction = initialized == 1 && address(this).code.length == 0;
if (!initialSetup && !construction) {
revert InvalidInitialization();
}
$._initialized = 1;
if (isTopLevelCall) {
$._initializing = true;
}
_;
if (isTopLevelCall) {
$._initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* A reinitializer may be used after the original initialization step. This is essential to configure modules that
* are added through upgrades and that require initialization.
*
* When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
* cannot be nested. If one is invoked in the context of another, execution will revert.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*
* WARNING: Setting the version to 2**64 - 1 will prevent any future reinitialization.
*
* Emits an {Initialized} event.
*/
modifier reinitializer(uint64 version) {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
if ($._initializing || $._initialized >= version) {
revert InvalidInitialization();
}
$._initialized = version;
$._initializing = true;
_;
$._initializing = false;
emit Initialized(version);
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
_checkInitializing();
_;
}
/**
* @dev Reverts if the contract is not in an initializing state. See {onlyInitializing}.
*/
function _checkInitializing() internal view virtual {
if (!_isInitializing()) {
revert NotInitializing();
}
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*
* Emits an {Initialized} event the first time it is successfully executed.
*/
function _disableInitializers() internal virtual {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
if ($._initializing) {
revert InvalidInitialization();
}
if ($._initialized != type(uint64).max) {
$._initialized = type(uint64).max;
emit Initialized(type(uint64).max);
}
}
/**
* @dev Returns the highest version that has been initialized. See {reinitializer}.
*/
function _getInitializedVersion() internal view returns (uint64) {
return _getInitializableStorage()._initialized;
}
/**
* @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
*/
function _isInitializing() internal view returns (bool) {
return _getInitializableStorage()._initializing;
}
/**
* @dev Pointer to storage slot. Allows integrators to override it with a custom storage location.
*
* NOTE: Consider following the ERC-7201 formula to derive storage locations.
*/
function _initializableStorageSlot() internal pure virtual returns (bytes32) {
return INITIALIZABLE_STORAGE;
}
/**
* @dev Returns a pointer to the storage namespace.
*/
// solhint-disable-next-line var-name-mixedcase
function _getInitializableStorage() private pure returns (InitializableStorage storage $) {
bytes32 slot = _initializableStorageSlot();
assembly {
$.slot := slot
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract ContextUpgradeable is Initializable {
function __Context_init() internal onlyInitializing {
}
function __Context_init_unchained() internal onlyInitializing {
}
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/introspection/ERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import {Initializable} from "../../proxy/utils/Initializable.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC-165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*/
abstract contract ERC165Upgradeable is Initializable, IERC165 {
function __ERC165_init() internal onlyInitializing {
}
function __ERC165_init_unchained() internal onlyInitializing {
}
/// @inheritdoc IERC165
function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/Pausable.sol)
pragma solidity ^0.8.20;
import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module which allows children to implement an emergency stop
* mechanism that can be triggered by an authorized account.
*
* This module is used through inheritance. It will make available the
* modifiers `whenNotPaused` and `whenPaused`, which can be applied to
* the functions of your contract. Note that they will not be pausable by
* simply including this module, only once the modifiers are put in place.
*/
abstract contract PausableUpgradeable is Initializable, ContextUpgradeable {
/// @custom:storage-location erc7201:openzeppelin.storage.Pausable
struct PausableStorage {
bool _paused;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Pausable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant PausableStorageLocation = 0xcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f03300;
function _getPausableStorage() private pure returns (PausableStorage storage $) {
assembly {
$.slot := PausableStorageLocation
}
}
/**
* @dev Emitted when the pause is triggered by `account`.
*/
event Paused(address account);
/**
* @dev Emitted when the pause is lifted by `account`.
*/
event Unpaused(address account);
/**
* @dev The operation failed because the contract is paused.
*/
error EnforcedPause();
/**
* @dev The operation failed because the contract is not paused.
*/
error ExpectedPause();
/**
* @dev 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();
_;
}
function __Pausable_init() internal onlyInitializing {
}
function __Pausable_init_unchained() internal onlyInitializing {
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/
function paused() public view virtual returns (bool) {
PausableStorage storage $ = _getPausableStorage();
return $._paused;
}
/**
* @dev Throws if the contract is paused.
*/
function _requireNotPaused() internal view virtual {
if (paused()) {
revert EnforcedPause();
}
}
/**
* @dev Throws if the contract is not paused.
*/
function _requirePaused() internal view virtual {
if (!paused()) {
revert ExpectedPause();
}
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/
function _pause() internal virtual whenNotPaused {
PausableStorage storage $ = _getPausableStorage();
$._paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
PausableStorage storage $ = _getPausableStorage();
$._paused = false;
emit Unpaused(_msgSender());
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/ReentrancyGuard.sol)
pragma solidity ^0.8.20;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If EIP-1153 (transient storage) is available on the chain you're deploying at,
* consider using {ReentrancyGuardTransient} instead.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuardUpgradeable is Initializable {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant NOT_ENTERED = 1;
uint256 private constant ENTERED = 2;
/// @custom:storage-location erc7201:openzeppelin.storage.ReentrancyGuard
struct ReentrancyGuardStorage {
uint256 _status;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ReentrancyGuard")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant ReentrancyGuardStorageLocation = 0x9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f00;
function _getReentrancyGuardStorage() private pure returns (ReentrancyGuardStorage storage $) {
assembly {
$.slot := ReentrancyGuardStorageLocation
}
}
/**
* @dev Unauthorized reentrant call.
*/
error ReentrancyGuardReentrantCall();
function __ReentrancyGuard_init() internal onlyInitializing {
__ReentrancyGuard_init_unchained();
}
function __ReentrancyGuard_init_unchained() internal onlyInitializing {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
$._status = NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
// On the first call to nonReentrant, _status will be NOT_ENTERED
if ($._status == ENTERED) {
revert ReentrancyGuardReentrantCall();
}
// Any calls to nonReentrant after this point will fail
$._status = ENTERED;
}
function _nonReentrantAfter() private {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
$._status = NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
return $._status == ENTERED;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (access/IAccessControl.sol)
pragma solidity >=0.8.4;
/**
* @dev External interface of AccessControl declared to support ERC-165 detection.
*/
interface IAccessControl {
/**
* @dev The `account` is missing a role.
*/
error AccessControlUnauthorizedAccount(address account, bytes32 neededRole);
/**
* @dev The caller of a function is not the expected one.
*
* NOTE: Don't confuse with {AccessControlUnauthorizedAccount}.
*/
error AccessControlBadConfirmation();
/**
* @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
*
* `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
* {RoleAdminChanged} not being emitted to signal this.
*/
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
/**
* @dev Emitted when `account` is granted `role`.
*
* `sender` is the account that originated the contract call. This account bears the admin role (for the granted role).
* Expected in cases where the role was granted using the internal {AccessControl-_grantRole}.
*/
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Emitted when `account` is revoked `role`.
*
* `sender` is the account that originated the contract call:
* - if using `revokeRole`, it is the admin role bearer
* - if using `renounceRole`, it is the role bearer (i.e. `account`)
*/
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) external view returns (bool);
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {AccessControl-_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) external view returns (bytes32);
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function grantRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function revokeRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been granted `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `callerConfirmation`.
*/
function renounceRole(bytes32 role, address callerConfirmation) external;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)
pragma solidity ^0.8.20;
import {Context} from "../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* The initial owner is set to the address provided by the deployer. This can
* later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
/**
* @dev The caller account is not authorized to perform an operation.
*/
error OwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/
error OwnableInvalidOwner(address owner);
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/
constructor(address initialOwner) {
if (initialOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
if (newOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/draft-IERC6093.sol)
pragma solidity >=0.8.4;
/**
* @dev Standard ERC-20 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-20 tokens.
*/
interface IERC20Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC20InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC20InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
* @param spender Address that may be allowed to operate on tokens without being their owner.
* @param allowance Amount of tokens a `spender` is allowed to operate with.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC20InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `spender` to be approved. Used in approvals.
* @param spender Address that may be allowed to operate on tokens without being their owner.
*/
error ERC20InvalidSpender(address spender);
}
/**
* @dev Standard ERC-721 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-721 tokens.
*/
interface IERC721Errors {
/**
* @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in ERC-20.
* Used in balance queries.
* @param owner Address of the current owner of a token.
*/
error ERC721InvalidOwner(address owner);
/**
* @dev Indicates a `tokenId` whose `owner` is the zero address.
* @param tokenId Identifier number of a token.
*/
error ERC721NonexistentToken(uint256 tokenId);
/**
* @dev Indicates an error related to the ownership over a particular token. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param tokenId Identifier number of a token.
* @param owner Address of the current owner of a token.
*/
error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC721InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC721InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param tokenId Identifier number of a token.
*/
error ERC721InsufficientApproval(address operator, uint256 tokenId);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC721InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC721InvalidOperator(address operator);
}
/**
* @dev Standard ERC-1155 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-1155 tokens.
*/
interface IERC1155Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
* @param tokenId Identifier number of a token.
*/
error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC1155InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC1155InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param owner Address of the current owner of a token.
*/
error ERC1155MissingApprovalForAll(address operator, address owner);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC1155InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC1155InvalidOperator(address operator);
/**
* @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation.
* Used in batch transfers.
* @param idsLength Length of the array of token identifiers
* @param valuesLength Length of the array of token amounts
*/
error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC1363.sol)
pragma solidity >=0.6.2;
import {IERC20} from "./IERC20.sol";
import {IERC165} from "./IERC165.sol";
/**
* @title IERC1363
* @dev Interface of the ERC-1363 standard as defined in the https://eips.ethereum.org/EIPS/eip-1363[ERC-1363].
*
* Defines an extension interface for ERC-20 tokens that supports executing code on a recipient contract
* after `transfer` or `transferFrom`, or code on a spender contract after `approve`, in a single transaction.
*/
interface IERC1363 is IERC20, IERC165 {
/*
* Note: the ERC-165 identifier for this interface is 0xb0202a11.
* 0xb0202a11 ===
* bytes4(keccak256('transferAndCall(address,uint256)')) ^
* bytes4(keccak256('transferAndCall(address,uint256,bytes)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256,bytes)')) ^
* bytes4(keccak256('approveAndCall(address,uint256)')) ^
* bytes4(keccak256('approveAndCall(address,uint256,bytes)'))
*/
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @param data Additional data with no specified format, sent in call to `spender`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value, bytes calldata data) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC165.sol)
pragma solidity >=0.4.16;
import {IERC165} from "../utils/introspection/IERC165.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC1967.sol)
pragma solidity >=0.4.11;
/**
* @dev ERC-1967: Proxy Storage Slots. This interface contains the events defined in the ERC.
*/
interface IERC1967 {
/**
* @dev Emitted when the implementation is upgraded.
*/
event Upgraded(address indexed implementation);
/**
* @dev Emitted when the admin account has changed.
*/
event AdminChanged(address previousAdmin, address newAdmin);
/**
* @dev Emitted when the beacon is changed.
*/
event BeaconUpgraded(address indexed beacon);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC20.sol)
pragma solidity >=0.4.16;
import {IERC20} from "../token/ERC20/IERC20.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC5267.sol)
pragma solidity >=0.4.16;
interface IERC5267 {
/**
* @dev MAY be emitted to signal that the domain could have changed.
*/
event EIP712DomainChanged();
/**
* @dev returns the fields and values that describe the domain separator used by this contract for EIP-712
* signature.
*/
function eip712Domain()
external
view
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (proxy/beacon/IBeacon.sol)
pragma solidity >=0.4.16;
/**
* @dev This is the interface that {BeaconProxy} expects of its beacon.
*/
interface IBeacon {
/**
* @dev Must return an address that can be used as a delegate call target.
*
* {UpgradeableBeacon} will check that this address is a contract.
*/
function implementation() external view returns (address);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (proxy/ERC1967/ERC1967Proxy.sol)
pragma solidity ^0.8.22;
import {Proxy} from "../Proxy.sol";
import {ERC1967Utils} from "./ERC1967Utils.sol";
/**
* @dev This contract implements an upgradeable proxy. It is upgradeable because calls are delegated to an
* implementation address that can be changed. This address is stored in storage in the location specified by
* https://eips.ethereum.org/EIPS/eip-1967[ERC-1967], so that it doesn't conflict with the storage layout of the
* implementation behind the proxy.
*/
contract ERC1967Proxy is Proxy {
/**
* @dev Initializes the upgradeable proxy with an initial implementation specified by `implementation`.
*
* If `_data` is nonempty, it's used as data in a delegate call to `implementation`. This will typically be an
* encoded function call, and allows initializing the storage of the proxy like a Solidity constructor.
*
* Requirements:
*
* - If `data` is empty, `msg.value` must be zero.
*/
constructor(address implementation, bytes memory _data) payable {
ERC1967Utils.upgradeToAndCall(implementation, _data);
}
/**
* @dev Returns the current implementation address.
*
* TIP: To get this value clients can read directly from the storage slot shown below (specified by ERC-1967) using
* the https://eth.wiki/json-rpc/API#eth_getstorageat[`eth_getStorageAt`] RPC call.
* `0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc`
*/
function _implementation() internal view virtual override returns (address) {
return ERC1967Utils.getImplementation();
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (proxy/ERC1967/ERC1967Utils.sol)
pragma solidity ^0.8.21;
import {IBeacon} from "../beacon/IBeacon.sol";
import {IERC1967} from "../../interfaces/IERC1967.sol";
import {Address} from "../../utils/Address.sol";
import {StorageSlot} from "../../utils/StorageSlot.sol";
/**
* @dev This library provides getters and event emitting update functions for
* https://eips.ethereum.org/EIPS/eip-1967[ERC-1967] slots.
*/
library ERC1967Utils {
/**
* @dev Storage slot with the address of the current implementation.
* This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1.
*/
// solhint-disable-next-line private-vars-leading-underscore
bytes32 internal constant IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
/**
* @dev The `implementation` of the proxy is invalid.
*/
error ERC1967InvalidImplementation(address implementation);
/**
* @dev The `admin` of the proxy is invalid.
*/
error ERC1967InvalidAdmin(address admin);
/**
* @dev The `beacon` of the proxy is invalid.
*/
error ERC1967InvalidBeacon(address beacon);
/**
* @dev An upgrade function sees `msg.value > 0` that may be lost.
*/
error ERC1967NonPayable();
/**
* @dev Returns the current implementation address.
*/
function getImplementation() internal view returns (address) {
return StorageSlot.getAddressSlot(IMPLEMENTATION_SLOT).value;
}
/**
* @dev Stores a new address in the ERC-1967 implementation slot.
*/
function _setImplementation(address newImplementation) private {
if (newImplementation.code.length == 0) {
revert ERC1967InvalidImplementation(newImplementation);
}
StorageSlot.getAddressSlot(IMPLEMENTATION_SLOT).value = newImplementation;
}
/**
* @dev Performs implementation upgrade with additional setup call if data is nonempty.
* This function is payable only if the setup call is performed, otherwise `msg.value` is rejected
* to avoid stuck value in the contract.
*
* Emits an {IERC1967-Upgraded} event.
*/
function upgradeToAndCall(address newImplementation, bytes memory data) internal {
_setImplementation(newImplementation);
emit IERC1967.Upgraded(newImplementation);
if (data.length > 0) {
Address.functionDelegateCall(newImplementation, data);
} else {
_checkNonPayable();
}
}
/**
* @dev Storage slot with the admin of the contract.
* This is the keccak-256 hash of "eip1967.proxy.admin" subtracted by 1.
*/
// solhint-disable-next-line private-vars-leading-underscore
bytes32 internal constant ADMIN_SLOT = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103;
/**
* @dev Returns the current admin.
*
* TIP: To get this value clients can read directly from the storage slot shown below (specified by ERC-1967) using
* the https://eth.wiki/json-rpc/API#eth_getstorageat[`eth_getStorageAt`] RPC call.
* `0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103`
*/
function getAdmin() internal view returns (address) {
return StorageSlot.getAddressSlot(ADMIN_SLOT).value;
}
/**
* @dev Stores a new address in the ERC-1967 admin slot.
*/
function _setAdmin(address newAdmin) private {
if (newAdmin == address(0)) {
revert ERC1967InvalidAdmin(address(0));
}
StorageSlot.getAddressSlot(ADMIN_SLOT).value = newAdmin;
}
/**
* @dev Changes the admin of the proxy.
*
* Emits an {IERC1967-AdminChanged} event.
*/
function changeAdmin(address newAdmin) internal {
emit IERC1967.AdminChanged(getAdmin(), newAdmin);
_setAdmin(newAdmin);
}
/**
* @dev The storage slot of the UpgradeableBeacon contract which defines the implementation for this proxy.
* This is the keccak-256 hash of "eip1967.proxy.beacon" subtracted by 1.
*/
// solhint-disable-next-line private-vars-leading-underscore
bytes32 internal constant BEACON_SLOT = 0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50;
/**
* @dev Returns the current beacon.
*/
function getBeacon() internal view returns (address) {
return StorageSlot.getAddressSlot(BEACON_SLOT).value;
}
/**
* @dev Stores a new beacon in the ERC-1967 beacon slot.
*/
function _setBeacon(address newBeacon) private {
if (newBeacon.code.length == 0) {
revert ERC1967InvalidBeacon(newBeacon);
}
StorageSlot.getAddressSlot(BEACON_SLOT).value = newBeacon;
address beaconImplementation = IBeacon(newBeacon).implementation();
if (beaconImplementation.code.length == 0) {
revert ERC1967InvalidImplementation(beaconImplementation);
}
}
/**
* @dev Change the beacon and trigger a setup call if data is nonempty.
* This function is payable only if the setup call is performed, otherwise `msg.value` is rejected
* to avoid stuck value in the contract.
*
* Emits an {IERC1967-BeaconUpgraded} event.
*
* CAUTION: Invoking this function has no effect on an instance of {BeaconProxy} since v5, since
* it uses an immutable beacon without looking at the value of the ERC-1967 beacon slot for
* efficiency.
*/
function upgradeBeaconToAndCall(address newBeacon, bytes memory data) internal {
_setBeacon(newBeacon);
emit IERC1967.BeaconUpgraded(newBeacon);
if (data.length > 0) {
Address.functionDelegateCall(IBeacon(newBeacon).implementation(), data);
} else {
_checkNonPayable();
}
}
/**
* @dev Reverts if `msg.value` is not zero. It can be used to avoid `msg.value` stuck in the contract
* if an upgrade doesn't perform an initialization call.
*/
function _checkNonPayable() private {
if (msg.value > 0) {
revert ERC1967NonPayable();
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (proxy/Proxy.sol)
pragma solidity ^0.8.20;
/**
* @dev This abstract contract provides a fallback function that delegates all calls to another contract using the EVM
* instruction `delegatecall`. We refer to the second contract as the _implementation_ behind the proxy, and it has to
* be specified by overriding the virtual {_implementation} function.
*
* Additionally, delegation to the implementation can be triggered manually through the {_fallback} function, or to a
* different contract through the {_delegate} function.
*
* The success and return data of the delegated call will be returned back to the caller of the proxy.
*/
abstract contract Proxy {
/**
* @dev Delegates the current call to `implementation`.
*
* This function does not return to its internal call site, it will return directly to the external caller.
*/
function _delegate(address implementation) internal virtual {
assembly {
// Copy msg.data. We take full control of memory in this inline assembly
// block because it will not return to Solidity code. We overwrite the
// Solidity scratch pad at memory position 0.
calldatacopy(0, 0, calldatasize())
// Call the implementation.
// out and outsize are 0 because we don't know the size yet.
let result := delegatecall(gas(), implementation, 0, calldatasize(), 0, 0)
// Copy the returned data.
returndatacopy(0, 0, returndatasize())
switch result
// delegatecall returns 0 on error.
case 0 {
revert(0, returndatasize())
}
default {
return(0, returndatasize())
}
}
}
/**
* @dev This is a virtual function that should be overridden so it returns the address to which the fallback
* function and {_fallback} should delegate.
*/
function _implementation() internal view virtual returns (address);
/**
* @dev Delegates the current call to the address returned by `_implementation()`.
*
* This function does not return to its internal call site, it will return directly to the external caller.
*/
function _fallback() internal virtual {
_delegate(_implementation());
}
/**
* @dev Fallback function that delegates calls to the address returned by `_implementation()`. Will run if no other
* function in the contract matches the call data.
*/
fallback() external payable virtual {
_fallback();
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (proxy/transparent/ProxyAdmin.sol)
pragma solidity ^0.8.22;
import {ITransparentUpgradeableProxy} from "./TransparentUpgradeableProxy.sol";
import {Ownable} from "../../access/Ownable.sol";
/**
* @dev This is an auxiliary contract meant to be assigned as the admin of a {TransparentUpgradeableProxy}. For an
* explanation of why you would want to use this see the documentation for {TransparentUpgradeableProxy}.
*/
contract ProxyAdmin is Ownable {
/**
* @dev The version of the upgrade interface of the contract. If this getter is missing, both `upgrade(address,address)`
* and `upgradeAndCall(address,address,bytes)` are present, and `upgrade` must be used if no function should be called,
* while `upgradeAndCall` will invoke the `receive` function if the third argument is the empty byte string.
* If the getter returns `"5.0.0"`, only `upgradeAndCall(address,address,bytes)` is present, and the third argument must
* be the empty byte string if no function should be called, making it impossible to invoke the `receive` function
* during an upgrade.
*/
string public constant UPGRADE_INTERFACE_VERSION = "5.0.0";
/**
* @dev Sets the initial owner who can perform upgrades.
*/
constructor(address initialOwner) Ownable(initialOwner) {}
/**
* @dev Upgrades `proxy` to `implementation` and calls a function on the new implementation.
* See {TransparentUpgradeableProxy-_dispatchUpgradeToAndCall}.
*
* Requirements:
*
* - This contract must be the admin of `proxy`.
* - If `data` is empty, `msg.value` must be zero.
*/
function upgradeAndCall(
ITransparentUpgradeableProxy proxy,
address implementation,
bytes memory data
) public payable virtual onlyOwner {
proxy.upgradeToAndCall{value: msg.value}(implementation, data);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC1155/IERC1155.sol)
pragma solidity >=0.6.2;
import {IERC165} from "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC-1155 compliant contract, as defined in the
* https://eips.ethereum.org/EIPS/eip-1155[ERC].
*/
interface IERC1155 is IERC165 {
/**
* @dev Emitted when `value` amount of tokens of type `id` are transferred from `from` to `to` by `operator`.
*/
event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value);
/**
* @dev Equivalent to multiple {TransferSingle} events, where `operator`, `from` and `to` are the same for all
* transfers.
*/
event TransferBatch(
address indexed operator,
address indexed from,
address indexed to,
uint256[] ids,
uint256[] values
);
/**
* @dev Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to
* `approved`.
*/
event ApprovalForAll(address indexed account, address indexed operator, bool approved);
/**
* @dev Emitted when the URI for token type `id` changes to `value`, if it is a non-programmatic URI.
*
* If an {URI} event was emitted for `id`, the standard
* https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[guarantees] that `value` will equal the value
* returned by {IERC1155MetadataURI-uri}.
*/
event URI(string value, uint256 indexed id);
/**
* @dev Returns the value of tokens of token type `id` owned by `account`.
*/
function balanceOf(address account, uint256 id) external view returns (uint256);
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {balanceOf}.
*
* Requirements:
*
* - `accounts` and `ids` must have the same length.
*/
function balanceOfBatch(
address[] calldata accounts,
uint256[] calldata ids
) external view returns (uint256[] memory);
/**
* @dev Grants or revokes permission to `operator` to transfer the caller's tokens, according to `approved`,
*
* Emits an {ApprovalForAll} event.
*
* Requirements:
*
* - `operator` cannot be the zero address.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns true if `operator` is approved to transfer ``account``'s tokens.
*
* See {setApprovalForAll}.
*/
function isApprovedForAll(address account, address operator) external view returns (bool);
/**
* @dev Transfers a `value` amount of tokens of type `id` from `from` to `to`.
*
* WARNING: This function can potentially allow a reentrancy attack when transferring tokens
* to an untrusted contract, when invoking {IERC1155Receiver-onERC1155Received} on the receiver.
* Ensure to follow the checks-effects-interactions pattern and consider employing
* reentrancy guards when interacting with untrusted contracts.
*
* Emits a {TransferSingle} event.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - If the caller is not `from`, it must have been approved to spend ``from``'s tokens via {setApprovalForAll}.
* - `from` must have a balance of tokens of type `id` of at least `value` amount.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
* acceptance magic value.
*/
function safeTransferFrom(address from, address to, uint256 id, uint256 value, bytes calldata data) external;
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {safeTransferFrom}.
*
* WARNING: This function can potentially allow a reentrancy attack when transferring tokens
* to an untrusted contract, when invoking {IERC1155Receiver-onERC1155BatchReceived} on the receiver.
* Ensure to follow the checks-effects-interactions pattern and consider employing
* reentrancy guards when interacting with untrusted contracts.
*
* Emits either a {TransferSingle} or a {TransferBatch} event, depending on the length of the array arguments.
*
* Requirements:
*
* - `ids` and `values` must have the same length.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
* acceptance magic value.
*/
function safeBatchTransferFrom(
address from,
address to,
uint256[] calldata ids,
uint256[] calldata values,
bytes calldata data
) external;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC1155/IERC1155Receiver.sol)
pragma solidity >=0.6.2;
import {IERC165} from "../../utils/introspection/IERC165.sol";
/**
* @dev Interface that must be implemented by smart contracts in order to receive
* ERC-1155 token transfers.
*/
interface IERC1155Receiver is IERC165 {
/**
* @dev Handles the receipt of a single ERC-1155 token type. This function is
* called at the end of a `safeTransferFrom` after the balance has been updated.
*
* NOTE: To accept the transfer, this must return
* `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))`
* (i.e. 0xf23a6e61, or its own function selector).
*
* @param operator The address which initiated the transfer (i.e. msg.sender)
* @param from The address which previously owned the token
* @param id The ID of the token being transferred
* @param value The amount of tokens being transferred
* @param data Additional data with no specified format
* @return `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` if transfer is allowed
*/
function onERC1155Received(
address operator,
address from,
uint256 id,
uint256 value,
bytes calldata data
) external returns (bytes4);
/**
* @dev Handles the receipt of a multiple ERC-1155 token types. This function
* is called at the end of a `safeBatchTransferFrom` after the balances have
* been updated.
*
* NOTE: To accept the transfer(s), this must return
* `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))`
* (i.e. 0xbc197c81, or its own function selector).
*
* @param operator The address which initiated the batch transfer (i.e. msg.sender)
* @param from The address which previously owned the token
* @param ids An array containing ids of each token being transferred (order and length must match values array)
* @param values An array containing amounts of each token being transferred (order and length must match ids array)
* @param data Additional data with no specified format
* @return `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` if transfer is allowed
*/
function onERC1155BatchReceived(
address operator,
address from,
uint256[] calldata ids,
uint256[] calldata values,
bytes calldata data
) external returns (bytes4);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC20Metadata} from "./extensions/IERC20Metadata.sol";
import {Context} from "../../utils/Context.sol";
import {IERC20Errors} from "../../interfaces/draft-IERC6093.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
*
* TIP: For a detailed writeup see our guide
* https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* The default value of {decimals} is 18. To change this, you should override
* this function so it returns a different value.
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC-20
* applications.
*/
abstract contract ERC20 is Context, IERC20, IERC20Metadata, IERC20Errors {
mapping(address account => uint256) private _balances;
mapping(address account => mapping(address spender => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* Both values are immutable: they can only be set once during construction.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual returns (string memory) {
return _symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5.05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the default value returned by this function, unless
* it's overridden.
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual returns (uint8) {
return 18;
}
/// @inheritdoc IERC20
function totalSupply() public view virtual returns (uint256) {
return _totalSupply;
}
/// @inheritdoc IERC20
function balanceOf(address account) public view virtual returns (uint256) {
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `value`.
*/
function transfer(address to, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_transfer(owner, to, value);
return true;
}
/// @inheritdoc IERC20
function allowance(address owner, address spender) public view virtual returns (uint256) {
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `value` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_approve(owner, spender, value);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Skips emitting an {Approval} event indicating an allowance update. This is not
* required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve].
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `value`.
* - the caller must have allowance for ``from``'s tokens of at least
* `value`.
*/
function transferFrom(address from, address to, uint256 value) public virtual returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, value);
_transfer(from, to, value);
return true;
}
/**
* @dev Moves a `value` amount of tokens from `from` to `to`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _transfer(address from, address to, uint256 value) internal {
if (from == address(0)) {
revert ERC20InvalidSender(address(0));
}
if (to == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(from, to, value);
}
/**
* @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from`
* (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding
* this function.
*
* Emits a {Transfer} event.
*/
function _update(address from, address to, uint256 value) internal virtual {
if (from == address(0)) {
// Overflow check required: The rest of the code assumes that totalSupply never overflows
_totalSupply += value;
} else {
uint256 fromBalance = _balances[from];
if (fromBalance < value) {
revert ERC20InsufficientBalance(from, fromBalance, value);
}
unchecked {
// Overflow not possible: value <= fromBalance <= totalSupply.
_balances[from] = fromBalance - value;
}
}
if (to == address(0)) {
unchecked {
// Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply.
_totalSupply -= value;
}
} else {
unchecked {
// Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256.
_balances[to] += value;
}
}
emit Transfer(from, to, value);
}
/**
* @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0).
* Relies on the `_update` mechanism
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _mint(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(address(0), account, value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, lowering the total supply.
* Relies on the `_update` mechanism.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead
*/
function _burn(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidSender(address(0));
}
_update(account, address(0), value);
}
/**
* @dev Sets `value` as the allowance of `spender` over the `owner`'s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*
* Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
*/
function _approve(address owner, address spender, uint256 value) internal {
_approve(owner, spender, value, true);
}
/**
* @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event.
*
* By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by
* `_spendAllowance` during the `transferFrom` operation set the flag to false. This saves gas by not emitting any
* `Approval` event during `transferFrom` operations.
*
* Anyone who wishes to continue emitting `Approval` events on the`transferFrom` operation can force the flag to
* true using the following override:
*
* ```solidity
* function _approve(address owner, address spender, uint256 value, bool) internal virtual override {
* super._approve(owner, spender, value, true);
* }
* ```
*
* Requirements are the same as {_approve}.
*/
function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual {
if (owner == address(0)) {
revert ERC20InvalidApprover(address(0));
}
if (spender == address(0)) {
revert ERC20InvalidSpender(address(0));
}
_allowances[owner][spender] = value;
if (emitEvent) {
emit Approval(owner, spender, value);
}
}
/**
* @dev Updates `owner`'s allowance for `spender` based on spent `value`.
*
* Does not update the allowance value in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Does not emit an {Approval} event.
*/
function _spendAllowance(address owner, address spender, uint256 value) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance < type(uint256).max) {
if (currentAllowance < value) {
revert ERC20InsufficientAllowance(spender, currentAllowance, value);
}
unchecked {
_approve(owner, spender, currentAllowance - value, false);
}
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity >=0.6.2;
import {IERC20} from "../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC-20 standard.
*/
interface IERC20Metadata is IERC20 {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/IERC20.sol)
pragma solidity >=0.4.16;
/**
* @dev Interface of the ERC-20 standard as defined in the ERC.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the value of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 value) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the
* allowance mechanism. `value` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 value) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC1363} from "../../../interfaces/IERC1363.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC-20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
/**
* @dev An operation with an ERC-20 token failed.
*/
error SafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/
error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20 token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value)));
}
/**
* @dev Variant of {safeTransfer} that returns a bool instead of reverting if the operation is not successful.
*/
function trySafeTransfer(IERC20 token, address to, uint256 value) internal returns (bool) {
return _callOptionalReturnBool(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Variant of {safeTransferFrom} that returns a bool instead of reverting if the operation is not successful.
*/
function trySafeTransferFrom(IERC20 token, address from, address to, uint256 value) internal returns (bool) {
return _callOptionalReturnBool(token, abi.encodeCall(token.transferFrom, (from, to, value)));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
forceApprove(token, spender, oldAllowance + value);
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
* value, non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
unchecked {
uint256 currentAllowance = token.allowance(address(this), spender);
if (currentAllowance < requestedDecrease) {
revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
}
forceApprove(token, spender, currentAllowance - requestedDecrease);
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*
* NOTE: If the token implements ERC-7674, this function will not modify any temporary allowance. This function
* only sets the "standard" allowance. Any temporary allowance will remain active, in addition to the value being
* set here.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Performs an {ERC1363} transferAndCall, with a fallback to the simple {ERC20} transfer if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
safeTransfer(token, to, value);
} else if (!token.transferAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} transferFromAndCall, with a fallback to the simple {ERC20} transferFrom if the target
* has no code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferFromAndCallRelaxed(
IERC1363 token,
address from,
address to,
uint256 value,
bytes memory data
) internal {
if (to.code.length == 0) {
safeTransferFrom(token, from, to, value);
} else if (!token.transferFromAndCall(from, to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} approveAndCall, with a fallback to the simple {ERC20} approve if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* NOTE: When the recipient address (`to`) has no code (i.e. is an EOA), this function behaves as {forceApprove}.
* Opposedly, when the recipient address (`to`) has code, this function only attempts to call {ERC1363-approveAndCall}
* once without retrying, and relies on the returned value to be true.
*
* Reverts if the returned value is other than `true`.
*/
function approveAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
forceApprove(token, to, value);
} else if (!token.approveAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturnBool} that reverts if call fails to meet the requirements.
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
let success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
// bubble errors
if iszero(success) {
let ptr := mload(0x40)
returndatacopy(ptr, 0, returndatasize())
revert(ptr, returndatasize())
}
returnSize := returndatasize()
returnValue := mload(0)
}
if (returnSize == 0 ? address(token).code.length == 0 : returnValue != 1) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturn} that silently catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
bool success;
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
returnSize := returndatasize()
returnValue := mload(0)
}
return success && (returnSize == 0 ? address(token).code.length > 0 : returnValue == 1);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/ERC721.sol)
pragma solidity ^0.8.20;
import {IERC721} from "./IERC721.sol";
import {IERC721Metadata} from "./extensions/IERC721Metadata.sol";
import {ERC721Utils} from "./utils/ERC721Utils.sol";
import {Context} from "../../utils/Context.sol";
import {Strings} from "../../utils/Strings.sol";
import {IERC165, ERC165} from "../../utils/introspection/ERC165.sol";
import {IERC721Errors} from "../../interfaces/draft-IERC6093.sol";
/**
* @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC-721] Non-Fungible Token Standard, including
* the Metadata extension, but not including the Enumerable extension, which is available separately as
* {ERC721Enumerable}.
*/
abstract contract ERC721 is Context, ERC165, IERC721, IERC721Metadata, IERC721Errors {
using Strings for uint256;
// Token name
string private _name;
// Token symbol
string private _symbol;
mapping(uint256 tokenId => address) private _owners;
mapping(address owner => uint256) private _balances;
mapping(uint256 tokenId => address) private _tokenApprovals;
mapping(address owner => mapping(address operator => bool)) private _operatorApprovals;
/**
* @dev Initializes the contract by setting a `name` and a `symbol` to the token collection.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/// @inheritdoc IERC165
function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) {
return
interfaceId == type(IERC721).interfaceId ||
interfaceId == type(IERC721Metadata).interfaceId ||
super.supportsInterface(interfaceId);
}
/// @inheritdoc IERC721
function balanceOf(address owner) public view virtual returns (uint256) {
if (owner == address(0)) {
revert ERC721InvalidOwner(address(0));
}
return _balances[owner];
}
/// @inheritdoc IERC721
function ownerOf(uint256 tokenId) public view virtual returns (address) {
return _requireOwned(tokenId);
}
/// @inheritdoc IERC721Metadata
function name() public view virtual returns (string memory) {
return _name;
}
/// @inheritdoc IERC721Metadata
function symbol() public view virtual returns (string memory) {
return _symbol;
}
/// @inheritdoc IERC721Metadata
function tokenURI(uint256 tokenId) public view virtual returns (string memory) {
_requireOwned(tokenId);
string memory baseURI = _baseURI();
return bytes(baseURI).length > 0 ? string.concat(baseURI, tokenId.toString()) : "";
}
/**
* @dev Base URI for computing {tokenURI}. If set, the resulting URI for each
* token will be the concatenation of the `baseURI` and the `tokenId`. Empty
* by default, can be overridden in child contracts.
*/
function _baseURI() internal view virtual returns (string memory) {
return "";
}
/// @inheritdoc IERC721
function approve(address to, uint256 tokenId) public virtual {
_approve(to, tokenId, _msgSender());
}
/// @inheritdoc IERC721
function getApproved(uint256 tokenId) public view virtual returns (address) {
_requireOwned(tokenId);
return _getApproved(tokenId);
}
/// @inheritdoc IERC721
function setApprovalForAll(address operator, bool approved) public virtual {
_setApprovalForAll(_msgSender(), operator, approved);
}
/// @inheritdoc IERC721
function isApprovedForAll(address owner, address operator) public view virtual returns (bool) {
return _operatorApprovals[owner][operator];
}
/// @inheritdoc IERC721
function transferFrom(address from, address to, uint256 tokenId) public virtual {
if (to == address(0)) {
revert ERC721InvalidReceiver(address(0));
}
// Setting an "auth" arguments enables the `_isAuthorized` check which verifies that the token exists
// (from != 0). Therefore, it is not needed to verify that the return value is not 0 here.
address previousOwner = _update(to, tokenId, _msgSender());
if (previousOwner != from) {
revert ERC721IncorrectOwner(from, tokenId, previousOwner);
}
}
/// @inheritdoc IERC721
function safeTransferFrom(address from, address to, uint256 tokenId) public {
safeTransferFrom(from, to, tokenId, "");
}
/// @inheritdoc IERC721
function safeTransferFrom(address from, address to, uint256 tokenId, bytes memory data) public virtual {
transferFrom(from, to, tokenId);
ERC721Utils.checkOnERC721Received(_msgSender(), from, to, tokenId, data);
}
/**
* @dev Returns the owner of the `tokenId`. Does NOT revert if token doesn't exist
*
* IMPORTANT: Any overrides to this function that add ownership of tokens not tracked by the
* core ERC-721 logic MUST be matched with the use of {_increaseBalance} to keep balances
* consistent with ownership. The invariant to preserve is that for any address `a` the value returned by
* `balanceOf(a)` must be equal to the number of tokens such that `_ownerOf(tokenId)` is `a`.
*/
function _ownerOf(uint256 tokenId) internal view virtual returns (address) {
return _owners[tokenId];
}
/**
* @dev Returns the approved address for `tokenId`. Returns 0 if `tokenId` is not minted.
*/
function _getApproved(uint256 tokenId) internal view virtual returns (address) {
return _tokenApprovals[tokenId];
}
/**
* @dev Returns whether `spender` is allowed to manage `owner`'s tokens, or `tokenId` in
* particular (ignoring whether it is owned by `owner`).
*
* WARNING: This function assumes that `owner` is the actual owner of `tokenId` and does not verify this
* assumption.
*/
function _isAuthorized(address owner, address spender, uint256 tokenId) internal view virtual returns (bool) {
return
spender != address(0) &&
(owner == spender || isApprovedForAll(owner, spender) || _getApproved(tokenId) == spender);
}
/**
* @dev Checks if `spender` can operate on `tokenId`, assuming the provided `owner` is the actual owner.
* Reverts if:
* - `spender` does not have approval from `owner` for `tokenId`.
* - `spender` does not have approval to manage all of `owner`'s assets.
*
* WARNING: This function assumes that `owner` is the actual owner of `tokenId` and does not verify this
* assumption.
*/
function _checkAuthorized(address owner, address spender, uint256 tokenId) internal view virtual {
if (!_isAuthorized(owner, spender, tokenId)) {
if (owner == address(0)) {
revert ERC721NonexistentToken(tokenId);
} else {
revert ERC721InsufficientApproval(spender, tokenId);
}
}
}
/**
* @dev Unsafe write access to the balances, used by extensions that "mint" tokens using an {ownerOf} override.
*
* NOTE: the value is limited to type(uint128).max. This protect against _balance overflow. It is unrealistic that
* a uint256 would ever overflow from increments when these increments are bounded to uint128 values.
*
* WARNING: Increasing an account's balance using this function tends to be paired with an override of the
* {_ownerOf} function to resolve the ownership of the corresponding tokens so that balances and ownership
* remain consistent with one another.
*/
function _increaseBalance(address account, uint128 value) internal virtual {
unchecked {
_balances[account] += value;
}
}
/**
* @dev Transfers `tokenId` from its current owner to `to`, or alternatively mints (or burns) if the current owner
* (or `to`) is the zero address. Returns the owner of the `tokenId` before the update.
*
* The `auth` argument is optional. If the value passed is non 0, then this function will check that
* `auth` is either the owner of the token, or approved to operate on the token (by the owner).
*
* Emits a {Transfer} event.
*
* NOTE: If overriding this function in a way that tracks balances, see also {_increaseBalance}.
*/
function _update(address to, uint256 tokenId, address auth) internal virtual returns (address) {
address from = _ownerOf(tokenId);
// Perform (optional) operator check
if (auth != address(0)) {
_checkAuthorized(from, auth, tokenId);
}
// Execute the update
if (from != address(0)) {
// Clear approval. No need to re-authorize or emit the Approval event
_approve(address(0), tokenId, address(0), false);
unchecked {
_balances[from] -= 1;
}
}
if (to != address(0)) {
unchecked {
_balances[to] += 1;
}
}
_owners[tokenId] = to;
emit Transfer(from, to, tokenId);
return from;
}
/**
* @dev Mints `tokenId` and transfers it to `to`.
*
* WARNING: Usage of this method is discouraged, use {_safeMint} whenever possible
*
* Requirements:
*
* - `tokenId` must not exist.
* - `to` cannot be the zero address.
*
* Emits a {Transfer} event.
*/
function _mint(address to, uint256 tokenId) internal {
if (to == address(0)) {
revert ERC721InvalidReceiver(address(0));
}
address previousOwner = _update(to, tokenId, address(0));
if (previousOwner != address(0)) {
revert ERC721InvalidSender(address(0));
}
}
/**
* @dev Mints `tokenId`, transfers it to `to` and checks for `to` acceptance.
*
* Requirements:
*
* - `tokenId` must not exist.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function _safeMint(address to, uint256 tokenId) internal {
_safeMint(to, tokenId, "");
}
/**
* @dev Same as {xref-ERC721-_safeMint-address-uint256-}[`_safeMint`], with an additional `data` parameter which is
* forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
*/
function _safeMint(address to, uint256 tokenId, bytes memory data) internal virtual {
_mint(to, tokenId);
ERC721Utils.checkOnERC721Received(_msgSender(), address(0), to, tokenId, data);
}
/**
* @dev Destroys `tokenId`.
* The approval is cleared when the token is burned.
* This is an internal function that does not check if the sender is authorized to operate on the token.
*
* Requirements:
*
* - `tokenId` must exist.
*
* Emits a {Transfer} event.
*/
function _burn(uint256 tokenId) internal {
address previousOwner = _update(address(0), tokenId, address(0));
if (previousOwner == address(0)) {
revert ERC721NonexistentToken(tokenId);
}
}
/**
* @dev Transfers `tokenId` from `from` to `to`.
* As opposed to {transferFrom}, this imposes no restrictions on msg.sender.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
*
* Emits a {Transfer} event.
*/
function _transfer(address from, address to, uint256 tokenId) internal {
if (to == address(0)) {
revert ERC721InvalidReceiver(address(0));
}
address previousOwner = _update(to, tokenId, address(0));
if (previousOwner == address(0)) {
revert ERC721NonexistentToken(tokenId);
} else if (previousOwner != from) {
revert ERC721IncorrectOwner(from, tokenId, previousOwner);
}
}
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking that contract recipients
* are aware of the ERC-721 standard to prevent tokens from being forever locked.
*
* `data` is additional data, it has no specified format and it is sent in call to `to`.
*
* This internal function is like {safeTransferFrom} in the sense that it invokes
* {IERC721Receiver-onERC721Received} on the receiver, and can be used to e.g.
* implement alternative mechanisms to perform token transfer, such as signature-based.
*
* Requirements:
*
* - `tokenId` token must exist and be owned by `from`.
* - `to` cannot be the zero address.
* - `from` cannot be the zero address.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function _safeTransfer(address from, address to, uint256 tokenId) internal {
_safeTransfer(from, to, tokenId, "");
}
/**
* @dev Same as {xref-ERC721-_safeTransfer-address-address-uint256-}[`_safeTransfer`], with an additional `data` parameter which is
* forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
*/
function _safeTransfer(address from, address to, uint256 tokenId, bytes memory data) internal virtual {
_transfer(from, to, tokenId);
ERC721Utils.checkOnERC721Received(_msgSender(), from, to, tokenId, data);
}
/**
* @dev Approve `to` to operate on `tokenId`
*
* The `auth` argument is optional. If the value passed is non 0, then this function will check that `auth` is
* either the owner of the token, or approved to operate on all tokens held by this owner.
*
* Emits an {Approval} event.
*
* Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
*/
function _approve(address to, uint256 tokenId, address auth) internal {
_approve(to, tokenId, auth, true);
}
/**
* @dev Variant of `_approve` with an optional flag to enable or disable the {Approval} event. The event is not
* emitted in the context of transfers.
*/
function _approve(address to, uint256 tokenId, address auth, bool emitEvent) internal virtual {
// Avoid reading the owner unless necessary
if (emitEvent || auth != address(0)) {
address owner = _requireOwned(tokenId);
// We do not use _isAuthorized because single-token approvals should not be able to call approve
if (auth != address(0) && owner != auth && !isApprovedForAll(owner, auth)) {
revert ERC721InvalidApprover(auth);
}
if (emitEvent) {
emit Approval(owner, to, tokenId);
}
}
_tokenApprovals[tokenId] = to;
}
/**
* @dev Approve `operator` to operate on all of `owner` tokens
*
* Requirements:
* - operator can't be the address zero.
*
* Emits an {ApprovalForAll} event.
*/
function _setApprovalForAll(address owner, address operator, bool approved) internal virtual {
if (operator == address(0)) {
revert ERC721InvalidOperator(operator);
}
_operatorApprovals[owner][operator] = approved;
emit ApprovalForAll(owner, operator, approved);
}
/**
* @dev Reverts if the `tokenId` doesn't have a current owner (it hasn't been minted, or it has been burned).
* Returns the owner.
*
* Overrides to ownership logic should be done to {_ownerOf}.
*/
function _requireOwned(uint256 tokenId) internal view returns (address) {
address owner = _ownerOf(tokenId);
if (owner == address(0)) {
revert ERC721NonexistentToken(tokenId);
}
return owner;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/extensions/IERC721Metadata.sol)
pragma solidity >=0.6.2;
import {IERC721} from "../IERC721.sol";
/**
* @title ERC-721 Non-Fungible Token Standard, optional metadata extension
* @dev See https://eips.ethereum.org/EIPS/eip-721
*/
interface IERC721Metadata is IERC721 {
/**
* @dev Returns the token collection name.
*/
function name() external view returns (string memory);
/**
* @dev Returns the token collection symbol.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
*/
function tokenURI(uint256 tokenId) external view returns (string memory);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/IERC721.sol)
pragma solidity >=0.6.2;
import {IERC165} from "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC-721 compliant contract.
*/
interface IERC721 is IERC165 {
/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/
event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/
function balanceOf(address owner) external view returns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function ownerOf(uint256 tokenId) external view returns (address owner);
/**
* @dev Safely transfers `tokenId` token from `from` to `to`.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
* a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId, bytes calldata data) external;
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC-721 protocol to prevent tokens from being forever locked.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must have been allowed to move this token by either {approve} or
* {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
* a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Transfers `tokenId` token from `from` to `to`.
*
* WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC-721
* or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
* understand this adds an external call which potentially creates a reentrancy vulnerability.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Gives permission to `to` to transfer `tokenId` token to another account.
* The approval is cleared when the token is transferred.
*
* Only a single account can be approved at a time, so approving the zero address clears previous approvals.
*
* Requirements:
*
* - The caller must own the token or be an approved operator.
* - `tokenId` must exist.
*
* Emits an {Approval} event.
*/
function approve(address to, uint256 tokenId) external;
/**
* @dev Approve or remove `operator` as an operator for the caller.
* Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
*
* Requirements:
*
* - The `operator` cannot be the address zero.
*
* Emits an {ApprovalForAll} event.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function getApproved(uint256 tokenId) external view returns (address operator);
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/
function isApprovedForAll(address owner, address operator) external view returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/IERC721Receiver.sol)
pragma solidity >=0.5.0;
/**
* @title ERC-721 token receiver interface
* @dev Interface for any contract that wants to support safeTransfers
* from ERC-721 asset contracts.
*/
interface IERC721Receiver {
/**
* @dev Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom}
* by `operator` from `from`, this function is called.
*
* It must return its Solidity selector to confirm the token transfer.
* If any other value is returned or the interface is not implemented by the recipient, the transfer will be
* reverted.
*
* The selector can be obtained in Solidity with `IERC721Receiver.onERC721Received.selector`.
*/
function onERC721Received(
address operator,
address from,
uint256 tokenId,
bytes calldata data
) external returns (bytes4);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC721/utils/ERC721Utils.sol)
pragma solidity ^0.8.20;
import {IERC721Receiver} from "../IERC721Receiver.sol";
import {IERC721Errors} from "../../../interfaces/draft-IERC6093.sol";
/**
* @dev Library that provide common ERC-721 utility functions.
*
* See https://eips.ethereum.org/EIPS/eip-721[ERC-721].
*
* _Available since v5.1._
*/
library ERC721Utils {
/**
* @dev Performs an acceptance check for the provided `operator` by calling {IERC721Receiver-onERC721Received}
* on the `to` address. The `operator` is generally the address that initiated the token transfer (i.e. `msg.sender`).
*
* The acceptance call is not executed and treated as a no-op if the target address doesn't contain code (i.e. an EOA).
* Otherwise, the recipient must implement {IERC721Receiver-onERC721Received} and return the acceptance magic value to accept
* the transfer.
*/
function checkOnERC721Received(
address operator,
address from,
address to,
uint256 tokenId,
bytes memory data
) internal {
if (to.code.length > 0) {
try IERC721Receiver(to).onERC721Received(operator, from, tokenId, data) returns (bytes4 retval) {
if (retval != IERC721Receiver.onERC721Received.selector) {
// Token rejected
revert IERC721Errors.ERC721InvalidReceiver(to);
}
} catch (bytes memory reason) {
if (reason.length == 0) {
// non-IERC721Receiver implementer
revert IERC721Errors.ERC721InvalidReceiver(to);
} else {
assembly ("memory-safe") {
revert(add(reason, 0x20), mload(reason))
}
}
}
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/Address.sol)
pragma solidity ^0.8.20;
import {Errors} from "./Errors.sol";
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev There's no code at `target` (it is not a contract).
*/
error AddressEmptyCode(address target);
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.8.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
if (address(this).balance < amount) {
revert Errors.InsufficientBalance(address(this).balance, amount);
}
(bool success, bytes memory returndata) = recipient.call{value: amount}("");
if (!success) {
_revert(returndata);
}
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason or custom error, it is bubbled
* up by this function (like regular Solidity function calls). However, if
* the call reverted with no returned reason, this function reverts with a
* {Errors.FailedCall} error.
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
if (address(this).balance < value) {
revert Errors.InsufficientBalance(address(this).balance, value);
}
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target
* was not a contract or bubbling up the revert reason (falling back to {Errors.FailedCall}) in case
* of an unsuccessful call.
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata
) internal view returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
// only check if target is a contract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
if (returndata.length == 0 && target.code.length == 0) {
revert AddressEmptyCode(target);
}
return returndata;
}
}
/**
* @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the
* revert reason or with a default {Errors.FailedCall} error.
*/
function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
return returndata;
}
}
/**
* @dev Reverts with returndata if present. Otherwise reverts with {Errors.FailedCall}.
*/
function _revert(bytes memory returndata) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
assembly ("memory-safe") {
revert(add(returndata, 0x20), mload(returndata))
}
} else {
revert Errors.FailedCall();
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/cryptography/ECDSA.sol)
pragma solidity ^0.8.20;
/**
* @dev Elliptic Curve Digital Signature Algorithm (ECDSA) operations.
*
* These functions can be used to verify that a message was signed by the holder
* of the private keys of a given address.
*/
library ECDSA {
enum RecoverError {
NoError,
InvalidSignature,
InvalidSignatureLength,
InvalidSignatureS
}
/**
* @dev The signature derives the `address(0)`.
*/
error ECDSAInvalidSignature();
/**
* @dev The signature has an invalid length.
*/
error ECDSAInvalidSignatureLength(uint256 length);
/**
* @dev The signature has an S value that is in the upper half order.
*/
error ECDSAInvalidSignatureS(bytes32 s);
/**
* @dev Returns the address that signed a hashed message (`hash`) with `signature` or an error. This will not
* return address(0) without also returning an error description. Errors are documented using an enum (error type)
* and a bytes32 providing additional information about the error.
*
* If no error is returned, then the address can be used for verification purposes.
*
* The `ecrecover` EVM precompile allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {MessageHashUtils-toEthSignedMessageHash} on it.
*
* Documentation for signature generation:
* - with https://web3js.readthedocs.io/en/v1.3.4/web3-eth-accounts.html#sign[Web3.js]
* - with https://docs.ethers.io/v5/api/signer/#Signer-signMessage[ethers]
*/
function tryRecover(
bytes32 hash,
bytes memory signature
) internal pure returns (address recovered, RecoverError err, bytes32 errArg) {
if (signature.length == 65) {
bytes32 r;
bytes32 s;
uint8 v;
// ecrecover takes the signature parameters, and the only way to get them
// currently is to use assembly.
assembly ("memory-safe") {
r := mload(add(signature, 0x20))
s := mload(add(signature, 0x40))
v := byte(0, mload(add(signature, 0x60)))
}
return tryRecover(hash, v, r, s);
} else {
return (address(0), RecoverError.InvalidSignatureLength, bytes32(signature.length));
}
}
/**
* @dev Returns the address that signed a hashed message (`hash`) with
* `signature`. This address can then be used for verification purposes.
*
* The `ecrecover` EVM precompile allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {MessageHashUtils-toEthSignedMessageHash} on it.
*/
function recover(bytes32 hash, bytes memory signature) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, signature);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately.
*
* See https://eips.ethereum.org/EIPS/eip-2098[ERC-2098 short signatures]
*/
function tryRecover(
bytes32 hash,
bytes32 r,
bytes32 vs
) internal pure returns (address recovered, RecoverError err, bytes32 errArg) {
unchecked {
bytes32 s = vs & bytes32(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff);
// We do not check for an overflow here since the shift operation results in 0 or 1.
uint8 v = uint8((uint256(vs) >> 255) + 27);
return tryRecover(hash, v, r, s);
}
}
/**
* @dev Overload of {ECDSA-recover} that receives the `r and `vs` short-signature fields separately.
*/
function recover(bytes32 hash, bytes32 r, bytes32 vs) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, r, vs);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `v`,
* `r` and `s` signature fields separately.
*/
function tryRecover(
bytes32 hash,
uint8 v,
bytes32 r,
bytes32 s
) internal pure returns (address recovered, RecoverError err, bytes32 errArg) {
// EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature
// unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines
// the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. Most
// signatures from current libraries generate a unique signature with an s-value in the lower half order.
//
// If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value
// with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or
// vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept
// these malleable signatures as well.
if (uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) {
return (address(0), RecoverError.InvalidSignatureS, s);
}
// If the signature is valid (and not malleable), return the signer address
address signer = ecrecover(hash, v, r, s);
if (signer == address(0)) {
return (address(0), RecoverError.InvalidSignature, bytes32(0));
}
return (signer, RecoverError.NoError, bytes32(0));
}
/**
* @dev Overload of {ECDSA-recover} that receives the `v`,
* `r` and `s` signature fields separately.
*/
function recover(bytes32 hash, uint8 v, bytes32 r, bytes32 s) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, v, r, s);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Optionally reverts with the corresponding custom error according to the `error` argument provided.
*/
function _throwError(RecoverError error, bytes32 errorArg) private pure {
if (error == RecoverError.NoError) {
return; // no error: do nothing
} else if (error == RecoverError.InvalidSignature) {
revert ECDSAInvalidSignature();
} else if (error == RecoverError.InvalidSignatureLength) {
revert ECDSAInvalidSignatureLength(uint256(errorArg));
} else if (error == RecoverError.InvalidSignatureS) {
revert ECDSAInvalidSignatureS(errorArg);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/cryptography/EIP712.sol)
pragma solidity ^0.8.20;
import {MessageHashUtils} from "./MessageHashUtils.sol";
import {ShortStrings, ShortString} from "../ShortStrings.sol";
import {IERC5267} from "../../interfaces/IERC5267.sol";
/**
* @dev https://eips.ethereum.org/EIPS/eip-712[EIP-712] is a standard for hashing and signing of typed structured data.
*
* The encoding scheme specified in the EIP requires a domain separator and a hash of the typed structured data, whose
* encoding is very generic and therefore its implementation in Solidity is not feasible, thus this contract
* does not implement the encoding itself. Protocols need to implement the type-specific encoding they need in order to
* produce the hash of their typed data using a combination of `abi.encode` and `keccak256`.
*
* This contract implements the EIP-712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding
* scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA
* ({_hashTypedDataV4}).
*
* The implementation of the domain separator was designed to be as efficient as possible while still properly updating
* the chain id to protect against replay attacks on an eventual fork of the chain.
*
* NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method
* https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask].
*
* NOTE: In the upgradeable version of this contract, the cached values will correspond to the address, and the domain
* separator of the implementation contract. This will cause the {_domainSeparatorV4} function to always rebuild the
* separator from the immutable values, which is cheaper than accessing a cached version in cold storage.
*
* @custom:oz-upgrades-unsafe-allow state-variable-immutable
*/
abstract contract EIP712 is IERC5267 {
using ShortStrings for *;
bytes32 private constant TYPE_HASH =
keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");
// Cache the domain separator as an immutable value, but also store the chain id that it corresponds to, in order to
// invalidate the cached domain separator if the chain id changes.
bytes32 private immutable _cachedDomainSeparator;
uint256 private immutable _cachedChainId;
address private immutable _cachedThis;
bytes32 private immutable _hashedName;
bytes32 private immutable _hashedVersion;
ShortString private immutable _name;
ShortString private immutable _version;
// slither-disable-next-line constable-states
string private _nameFallback;
// slither-disable-next-line constable-states
string private _versionFallback;
/**
* @dev Initializes the domain separator and parameter caches.
*
* The meaning of `name` and `version` is specified in
* https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator[EIP-712]:
*
* - `name`: the user readable name of the signing domain, i.e. the name of the DApp or the protocol.
* - `version`: the current major version of the signing domain.
*
* NOTE: These parameters cannot be changed except through a xref:learn::upgrading-smart-contracts.adoc[smart
* contract upgrade].
*/
constructor(string memory name, string memory version) {
_name = name.toShortStringWithFallback(_nameFallback);
_version = version.toShortStringWithFallback(_versionFallback);
_hashedName = keccak256(bytes(name));
_hashedVersion = keccak256(bytes(version));
_cachedChainId = block.chainid;
_cachedDomainSeparator = _buildDomainSeparator();
_cachedThis = address(this);
}
/**
* @dev Returns the domain separator for the current chain.
*/
function _domainSeparatorV4() internal view returns (bytes32) {
if (address(this) == _cachedThis && block.chainid == _cachedChainId) {
return _cachedDomainSeparator;
} else {
return _buildDomainSeparator();
}
}
function _buildDomainSeparator() private view returns (bytes32) {
return keccak256(abi.encode(TYPE_HASH, _hashedName, _hashedVersion, block.chainid, address(this)));
}
/**
* @dev Given an already https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct[hashed struct], this
* function returns the hash of the fully encoded EIP712 message for this domain.
*
* This hash can be used together with {ECDSA-recover} to obtain the signer of a message. For example:
*
* ```solidity
* bytes32 digest = _hashTypedDataV4(keccak256(abi.encode(
* keccak256("Mail(address to,string contents)"),
* mailTo,
* keccak256(bytes(mailContents))
* )));
* address signer = ECDSA.recover(digest, signature);
* ```
*/
function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) {
return MessageHashUtils.toTypedDataHash(_domainSeparatorV4(), structHash);
}
/// @inheritdoc IERC5267
function eip712Domain()
public
view
virtual
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
)
{
return (
hex"0f", // 01111
_EIP712Name(),
_EIP712Version(),
block.chainid,
address(this),
bytes32(0),
new uint256[](0)
);
}
/**
* @dev The name parameter for the EIP712 domain.
*
* NOTE: By default this function reads _name which is an immutable value.
* It only reads from storage if necessary (in case the value is too large to fit in a ShortString).
*/
// solhint-disable-next-line func-name-mixedcase
function _EIP712Name() internal view returns (string memory) {
return _name.toStringWithFallback(_nameFallback);
}
/**
* @dev The version parameter for the EIP712 domain.
*
* NOTE: By default this function reads _version which is an immutable value.
* It only reads from storage if necessary (in case the value is too large to fit in a ShortString).
*/
// solhint-disable-next-line func-name-mixedcase
function _EIP712Version() internal view returns (string memory) {
return _version.toStringWithFallback(_versionFallback);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/cryptography/MessageHashUtils.sol)
pragma solidity ^0.8.20;
import {Strings} from "../Strings.sol";
/**
* @dev Signature message hash utilities for producing digests to be consumed by {ECDSA} recovery or signing.
*
* The library provides methods for generating a hash of a message that conforms to the
* https://eips.ethereum.org/EIPS/eip-191[ERC-191] and https://eips.ethereum.org/EIPS/eip-712[EIP 712]
* specifications.
*/
library MessageHashUtils {
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x45` (`personal_sign` messages).
*
* The digest is calculated by prefixing a bytes32 `messageHash` with
* `"\x19Ethereum Signed Message:\n32"` and hashing the result. It corresponds with the
* hash signed when using the https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sign[`eth_sign`] JSON-RPC method.
*
* NOTE: The `messageHash` parameter is intended to be the result of hashing a raw message with
* keccak256, although any bytes32 value can be safely used because the final digest will
* be re-hashed.
*
* See {ECDSA-recover}.
*/
function toEthSignedMessageHash(bytes32 messageHash) internal pure returns (bytes32 digest) {
assembly ("memory-safe") {
mstore(0x00, "\x19Ethereum Signed Message:\n32") // 32 is the bytes-length of messageHash
mstore(0x1c, messageHash) // 0x1c (28) is the length of the prefix
digest := keccak256(0x00, 0x3c) // 0x3c is the length of the prefix (0x1c) + messageHash (0x20)
}
}
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x45` (`personal_sign` messages).
*
* The digest is calculated by prefixing an arbitrary `message` with
* `"\x19Ethereum Signed Message:\n" + len(message)` and hashing the result. It corresponds with the
* hash signed when using the https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sign[`eth_sign`] JSON-RPC method.
*
* See {ECDSA-recover}.
*/
function toEthSignedMessageHash(bytes memory message) internal pure returns (bytes32) {
return
keccak256(bytes.concat("\x19Ethereum Signed Message:\n", bytes(Strings.toString(message.length)), message));
}
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x00` (data with intended validator).
*
* The digest is calculated by prefixing an arbitrary `data` with `"\x19\x00"` and the intended
* `validator` address. Then hashing the result.
*
* See {ECDSA-recover}.
*/
function toDataWithIntendedValidatorHash(address validator, bytes memory data) internal pure returns (bytes32) {
return keccak256(abi.encodePacked(hex"19_00", validator, data));
}
/**
* @dev Variant of {toDataWithIntendedValidatorHash-address-bytes} optimized for cases where `data` is a bytes32.
*/
function toDataWithIntendedValidatorHash(
address validator,
bytes32 messageHash
) internal pure returns (bytes32 digest) {
assembly ("memory-safe") {
mstore(0x00, hex"19_00")
mstore(0x02, shl(96, validator))
mstore(0x16, messageHash)
digest := keccak256(0x00, 0x36)
}
}
/**
* @dev Returns the keccak256 digest of an EIP-712 typed data (ERC-191 version `0x01`).
*
* The digest is calculated from a `domainSeparator` and a `structHash`, by prefixing them with
* `\x19\x01` and hashing the result. It corresponds to the hash signed by the
* https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`] JSON-RPC method as part of EIP-712.
*
* See {ECDSA-recover}.
*/
function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32 digest) {
assembly ("memory-safe") {
let ptr := mload(0x40)
mstore(ptr, hex"19_01")
mstore(add(ptr, 0x02), domainSeparator)
mstore(add(ptr, 0x22), structHash)
digest := keccak256(ptr, 0x42)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Errors.sol)
pragma solidity ^0.8.20;
/**
* @dev Collection of common custom errors used in multiple contracts
*
* IMPORTANT: Backwards compatibility is not guaranteed in future versions of the library.
* It is recommended to avoid relying on the error API for critical functionality.
*
* _Available since v5.1._
*/
library Errors {
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/
error InsufficientBalance(uint256 balance, uint256 needed);
/**
* @dev A call to an address target failed. The target may have reverted.
*/
error FailedCall();
/**
* @dev The deployment failed.
*/
error FailedDeployment();
/**
* @dev A necessary precompile is missing.
*/
error MissingPrecompile(address);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/introspection/ERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "./IERC165.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC-165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*/
abstract contract ERC165 is IERC165 {
/// @inheritdoc IERC165
function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/introspection/IERC165.sol)
pragma solidity >=0.4.16;
/**
* @dev Interface of the ERC-165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[ERC].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[ERC section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/math/Math.sol)
pragma solidity ^0.8.20;
import {Panic} from "../Panic.sol";
import {SafeCast} from "./SafeCast.sol";
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
enum Rounding {
Floor, // Toward negative infinity
Ceil, // Toward positive infinity
Trunc, // Toward zero
Expand // Away from zero
}
/**
* @dev Return the 512-bit addition of two uint256.
*
* The result is stored in two 256 variables such that sum = high * 2²⁵⁶ + low.
*/
function add512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
assembly ("memory-safe") {
low := add(a, b)
high := lt(low, a)
}
}
/**
* @dev Return the 512-bit multiplication of two uint256.
*
* The result is stored in two 256 variables such that product = high * 2²⁵⁶ + low.
*/
function mul512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
// 512-bit multiply [high low] = x * y. Compute the product mod 2²⁵⁶ and mod 2²⁵⁶ - 1, then use
// the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = high * 2²⁵⁶ + low.
assembly ("memory-safe") {
let mm := mulmod(a, b, not(0))
low := mul(a, b)
high := sub(sub(mm, low), lt(mm, low))
}
}
/**
* @dev Returns the addition of two unsigned integers, with a success flag (no overflow).
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a + b;
success = c >= a;
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the subtraction of two unsigned integers, with a success flag (no overflow).
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a - b;
success = c <= a;
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with a success flag (no overflow).
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a * b;
assembly ("memory-safe") {
// Only true when the multiplication doesn't overflow
// (c / a == b) || (a == 0)
success := or(eq(div(c, a), b), iszero(a))
}
// equivalent to: success ? c : 0
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the division of two unsigned integers, with a success flag (no division by zero).
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
success = b > 0;
assembly ("memory-safe") {
// The `DIV` opcode returns zero when the denominator is 0.
result := div(a, b)
}
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a success flag (no division by zero).
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
success = b > 0;
assembly ("memory-safe") {
// The `MOD` opcode returns zero when the denominator is 0.
result := mod(a, b)
}
}
}
/**
* @dev Unsigned saturating addition, bounds to `2²⁵⁶ - 1` instead of overflowing.
*/
function saturatingAdd(uint256 a, uint256 b) internal pure returns (uint256) {
(bool success, uint256 result) = tryAdd(a, b);
return ternary(success, result, type(uint256).max);
}
/**
* @dev Unsigned saturating subtraction, bounds to zero instead of overflowing.
*/
function saturatingSub(uint256 a, uint256 b) internal pure returns (uint256) {
(, uint256 result) = trySub(a, b);
return result;
}
/**
* @dev Unsigned saturating multiplication, bounds to `2²⁵⁶ - 1` instead of overflowing.
*/
function saturatingMul(uint256 a, uint256 b) internal pure returns (uint256) {
(bool success, uint256 result) = tryMul(a, b);
return ternary(success, result, type(uint256).max);
}
/**
* @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant.
*
* IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.
* However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute
* one branch when needed, making this function more expensive.
*/
function ternary(bool condition, uint256 a, uint256 b) internal pure returns (uint256) {
unchecked {
// branchless ternary works because:
// b ^ (a ^ b) == a
// b ^ 0 == b
return b ^ ((a ^ b) * SafeCast.toUint(condition));
}
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(a > b, a, b);
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(a < b, a, b);
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds towards infinity instead
* of rounding towards zero.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
if (b == 0) {
// Guarantee the same behavior as in a regular Solidity division.
Panic.panic(Panic.DIVISION_BY_ZERO);
}
// The following calculation ensures accurate ceiling division without overflow.
// Since a is non-zero, (a - 1) / b will not overflow.
// The largest possible result occurs when (a - 1) / b is type(uint256).max,
// but the largest value we can obtain is type(uint256).max - 1, which happens
// when a = type(uint256).max and b = 1.
unchecked {
return SafeCast.toUint(a > 0) * ((a - 1) / b + 1);
}
}
/**
* @dev Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
* denominator == 0.
*
* Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv) with further edits by
* Uniswap Labs also under MIT license.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
(uint256 high, uint256 low) = mul512(x, y);
// Handle non-overflow cases, 256 by 256 division.
if (high == 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 low / denominator;
}
// Make sure the result is less than 2²⁵⁶. Also prevents denominator == 0.
if (denominator <= high) {
Panic.panic(ternary(denominator == 0, Panic.DIVISION_BY_ZERO, Panic.UNDER_OVERFLOW));
}
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [high low].
uint256 remainder;
assembly ("memory-safe") {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
high := sub(high, gt(remainder, low))
low := sub(low, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator.
// Always >= 1. See https://cs.stackexchange.com/q/138556/92363.
uint256 twos = denominator & (0 - denominator);
assembly ("memory-safe") {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [high low] by twos.
low := div(low, twos)
// Flip twos such that it is 2²⁵⁶ / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from high into low.
low |= high * twos;
// Invert denominator mod 2²⁵⁶. Now that denominator is an odd number, it has an inverse modulo 2²⁵⁶ such
// that denominator * inv ≡ 1 mod 2²⁵⁶. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv ≡ 1 mod 2⁴.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also
// works in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2⁸
inverse *= 2 - denominator * inverse; // inverse mod 2¹⁶
inverse *= 2 - denominator * inverse; // inverse mod 2³²
inverse *= 2 - denominator * inverse; // inverse mod 2⁶⁴
inverse *= 2 - denominator * inverse; // inverse mod 2¹²⁸
inverse *= 2 - denominator * inverse; // inverse mod 2²⁵⁶
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2²⁵⁶. Since the preconditions guarantee that the outcome is
// less than 2²⁵⁶, this is the final result. We don't need to compute the high bits of the result and high
// is no longer required.
result = low * inverse;
return result;
}
}
/**
* @dev Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
return mulDiv(x, y, denominator) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0);
}
/**
* @dev Calculates floor(x * y >> n) with full precision. Throws if result overflows a uint256.
*/
function mulShr(uint256 x, uint256 y, uint8 n) internal pure returns (uint256 result) {
unchecked {
(uint256 high, uint256 low) = mul512(x, y);
if (high >= 1 << n) {
Panic.panic(Panic.UNDER_OVERFLOW);
}
return (high << (256 - n)) | (low >> n);
}
}
/**
* @dev Calculates x * y >> n with full precision, following the selected rounding direction.
*/
function mulShr(uint256 x, uint256 y, uint8 n, Rounding rounding) internal pure returns (uint256) {
return mulShr(x, y, n) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, 1 << n) > 0);
}
/**
* @dev Calculate the modular multiplicative inverse of a number in Z/nZ.
*
* If n is a prime, then Z/nZ is a field. In that case all elements are inversible, except 0.
* If n is not a prime, then Z/nZ is not a field, and some elements might not be inversible.
*
* If the input value is not inversible, 0 is returned.
*
* NOTE: If you know for sure that n is (big) a prime, it may be cheaper to use Fermat's little theorem and get the
* inverse using `Math.modExp(a, n - 2, n)`. See {invModPrime}.
*/
function invMod(uint256 a, uint256 n) internal pure returns (uint256) {
unchecked {
if (n == 0) return 0;
// The inverse modulo is calculated using the Extended Euclidean Algorithm (iterative version)
// Used to compute integers x and y such that: ax + ny = gcd(a, n).
// When the gcd is 1, then the inverse of a modulo n exists and it's x.
// ax + ny = 1
// ax = 1 + (-y)n
// ax ≡ 1 (mod n) # x is the inverse of a modulo n
// If the remainder is 0 the gcd is n right away.
uint256 remainder = a % n;
uint256 gcd = n;
// Therefore the initial coefficients are:
// ax + ny = gcd(a, n) = n
// 0a + 1n = n
int256 x = 0;
int256 y = 1;
while (remainder != 0) {
uint256 quotient = gcd / remainder;
(gcd, remainder) = (
// The old remainder is the next gcd to try.
remainder,
// Compute the next remainder.
// Can't overflow given that (a % gcd) * (gcd // (a % gcd)) <= gcd
// where gcd is at most n (capped to type(uint256).max)
gcd - remainder * quotient
);
(x, y) = (
// Increment the coefficient of a.
y,
// Decrement the coefficient of n.
// Can overflow, but the result is casted to uint256 so that the
// next value of y is "wrapped around" to a value between 0 and n - 1.
x - y * int256(quotient)
);
}
if (gcd != 1) return 0; // No inverse exists.
return ternary(x < 0, n - uint256(-x), uint256(x)); // Wrap the result if it's negative.
}
}
/**
* @dev Variant of {invMod}. More efficient, but only works if `p` is known to be a prime greater than `2`.
*
* From https://en.wikipedia.org/wiki/Fermat%27s_little_theorem[Fermat's little theorem], we know that if p is
* prime, then `a**(p-1) ≡ 1 mod p`. As a consequence, we have `a * a**(p-2) ≡ 1 mod p`, which means that
* `a**(p-2)` is the modular multiplicative inverse of a in Fp.
*
* NOTE: this function does NOT check that `p` is a prime greater than `2`.
*/
function invModPrime(uint256 a, uint256 p) internal view returns (uint256) {
unchecked {
return Math.modExp(a, p - 2, p);
}
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m)
*
* Requirements:
* - modulus can't be zero
* - underlying staticcall to precompile must succeed
*
* IMPORTANT: The result is only valid if the underlying call succeeds. When using this function, make
* sure the chain you're using it on supports the precompiled contract for modular exponentiation
* at address 0x05 as specified in https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise,
* the underlying function will succeed given the lack of a revert, but the result may be incorrectly
* interpreted as 0.
*/
function modExp(uint256 b, uint256 e, uint256 m) internal view returns (uint256) {
(bool success, uint256 result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m).
* It includes a success flag indicating if the operation succeeded. Operation will be marked as failed if trying
* to operate modulo 0 or if the underlying precompile reverted.
*
* IMPORTANT: The result is only valid if the success flag is true. When using this function, make sure the chain
* you're using it on supports the precompiled contract for modular exponentiation at address 0x05 as specified in
* https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise, the underlying function will succeed given the lack
* of a revert, but the result may be incorrectly interpreted as 0.
*/
function tryModExp(uint256 b, uint256 e, uint256 m) internal view returns (bool success, uint256 result) {
if (m == 0) return (false, 0);
assembly ("memory-safe") {
let ptr := mload(0x40)
// | Offset | Content | Content (Hex) |
// |-----------|------------|--------------------------------------------------------------------|
// | 0x00:0x1f | size of b | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x20:0x3f | size of e | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x40:0x5f | size of m | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x60:0x7f | value of b | 0x<.............................................................b> |
// | 0x80:0x9f | value of e | 0x<.............................................................e> |
// | 0xa0:0xbf | value of m | 0x<.............................................................m> |
mstore(ptr, 0x20)
mstore(add(ptr, 0x20), 0x20)
mstore(add(ptr, 0x40), 0x20)
mstore(add(ptr, 0x60), b)
mstore(add(ptr, 0x80), e)
mstore(add(ptr, 0xa0), m)
// Given the result < m, it's guaranteed to fit in 32 bytes,
// so we can use the memory scratch space located at offset 0.
success := staticcall(gas(), 0x05, ptr, 0xc0, 0x00, 0x20)
result := mload(0x00)
}
}
/**
* @dev Variant of {modExp} that supports inputs of arbitrary length.
*/
function modExp(bytes memory b, bytes memory e, bytes memory m) internal view returns (bytes memory) {
(bool success, bytes memory result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Variant of {tryModExp} that supports inputs of arbitrary length.
*/
function tryModExp(
bytes memory b,
bytes memory e,
bytes memory m
) internal view returns (bool success, bytes memory result) {
if (_zeroBytes(m)) return (false, new bytes(0));
uint256 mLen = m.length;
// Encode call args in result and move the free memory pointer
result = abi.encodePacked(b.length, e.length, mLen, b, e, m);
assembly ("memory-safe") {
let dataPtr := add(result, 0x20)
// Write result on top of args to avoid allocating extra memory.
success := staticcall(gas(), 0x05, dataPtr, mload(result), dataPtr, mLen)
// Overwrite the length.
// result.length > returndatasize() is guaranteed because returndatasize() == m.length
mstore(result, mLen)
// Set the memory pointer after the returned data.
mstore(0x40, add(dataPtr, mLen))
}
}
/**
* @dev Returns whether the provided byte array is zero.
*/
function _zeroBytes(bytes memory byteArray) private pure returns (bool) {
for (uint256 i = 0; i < byteArray.length; ++i) {
if (byteArray[i] != 0) {
return false;
}
}
return true;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded
* towards zero.
*
* This method is based on Newton's method for computing square roots; the algorithm is restricted to only
* using integer operations.
*/
function sqrt(uint256 a) internal pure returns (uint256) {
unchecked {
// Take care of easy edge cases when a == 0 or a == 1
if (a <= 1) {
return a;
}
// In this function, we use Newton's method to get a root of `f(x) := x² - a`. It involves building a
// sequence x_n that converges toward sqrt(a). For each iteration x_n, we also define the error between
// the current value as `ε_n = | x_n - sqrt(a) |`.
//
// For our first estimation, we consider `e` the smallest power of 2 which is bigger than the square root
// of the target. (i.e. `2**(e-1) ≤ sqrt(a) < 2**e`). We know that `e ≤ 128` because `(2¹²⁸)² = 2²⁵⁶` is
// bigger than any uint256.
//
// By noticing that
// `2**(e-1) ≤ sqrt(a) < 2**e → (2**(e-1))² ≤ a < (2**e)² → 2**(2*e-2) ≤ a < 2**(2*e)`
// we can deduce that `e - 1` is `log2(a) / 2`. We can thus compute `x_n = 2**(e-1)` using a method similar
// to the msb function.
uint256 aa = a;
uint256 xn = 1;
if (aa >= (1 << 128)) {
aa >>= 128;
xn <<= 64;
}
if (aa >= (1 << 64)) {
aa >>= 64;
xn <<= 32;
}
if (aa >= (1 << 32)) {
aa >>= 32;
xn <<= 16;
}
if (aa >= (1 << 16)) {
aa >>= 16;
xn <<= 8;
}
if (aa >= (1 << 8)) {
aa >>= 8;
xn <<= 4;
}
if (aa >= (1 << 4)) {
aa >>= 4;
xn <<= 2;
}
if (aa >= (1 << 2)) {
xn <<= 1;
}
// We now have x_n such that `x_n = 2**(e-1) ≤ sqrt(a) < 2**e = 2 * x_n`. This implies ε_n ≤ 2**(e-1).
//
// We can refine our estimation by noticing that the middle of that interval minimizes the error.
// If we move x_n to equal 2**(e-1) + 2**(e-2), then we reduce the error to ε_n ≤ 2**(e-2).
// This is going to be our x_0 (and ε_0)
xn = (3 * xn) >> 1; // ε_0 := | x_0 - sqrt(a) | ≤ 2**(e-2)
// From here, Newton's method give us:
// x_{n+1} = (x_n + a / x_n) / 2
//
// One should note that:
// x_{n+1}² - a = ((x_n + a / x_n) / 2)² - a
// = ((x_n² + a) / (2 * x_n))² - a
// = (x_n⁴ + 2 * a * x_n² + a²) / (4 * x_n²) - a
// = (x_n⁴ + 2 * a * x_n² + a² - 4 * a * x_n²) / (4 * x_n²)
// = (x_n⁴ - 2 * a * x_n² + a²) / (4 * x_n²)
// = (x_n² - a)² / (2 * x_n)²
// = ((x_n² - a) / (2 * x_n))²
// ≥ 0
// Which proves that for all n ≥ 1, sqrt(a) ≤ x_n
//
// This gives us the proof of quadratic convergence of the sequence:
// ε_{n+1} = | x_{n+1} - sqrt(a) |
// = | (x_n + a / x_n) / 2 - sqrt(a) |
// = | (x_n² + a - 2*x_n*sqrt(a)) / (2 * x_n) |
// = | (x_n - sqrt(a))² / (2 * x_n) |
// = | ε_n² / (2 * x_n) |
// = ε_n² / | (2 * x_n) |
//
// For the first iteration, we have a special case where x_0 is known:
// ε_1 = ε_0² / | (2 * x_0) |
// ≤ (2**(e-2))² / (2 * (2**(e-1) + 2**(e-2)))
// ≤ 2**(2*e-4) / (3 * 2**(e-1))
// ≤ 2**(e-3) / 3
// ≤ 2**(e-3-log2(3))
// ≤ 2**(e-4.5)
//
// For the following iterations, we use the fact that, 2**(e-1) ≤ sqrt(a) ≤ x_n:
// ε_{n+1} = ε_n² / | (2 * x_n) |
// ≤ (2**(e-k))² / (2 * 2**(e-1))
// ≤ 2**(2*e-2*k) / 2**e
// ≤ 2**(e-2*k)
xn = (xn + a / xn) >> 1; // ε_1 := | x_1 - sqrt(a) | ≤ 2**(e-4.5) -- special case, see above
xn = (xn + a / xn) >> 1; // ε_2 := | x_2 - sqrt(a) | ≤ 2**(e-9) -- general case with k = 4.5
xn = (xn + a / xn) >> 1; // ε_3 := | x_3 - sqrt(a) | ≤ 2**(e-18) -- general case with k = 9
xn = (xn + a / xn) >> 1; // ε_4 := | x_4 - sqrt(a) | ≤ 2**(e-36) -- general case with k = 18
xn = (xn + a / xn) >> 1; // ε_5 := | x_5 - sqrt(a) | ≤ 2**(e-72) -- general case with k = 36
xn = (xn + a / xn) >> 1; // ε_6 := | x_6 - sqrt(a) | ≤ 2**(e-144) -- general case with k = 72
// Because e ≤ 128 (as discussed during the first estimation phase), we know have reached a precision
// ε_6 ≤ 2**(e-144) < 1. Given we're operating on integers, then we can ensure that xn is now either
// sqrt(a) or sqrt(a) + 1.
return xn - SafeCast.toUint(xn > a / xn);
}
}
/**
* @dev Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && result * result < a);
}
}
/**
* @dev Return the log in base 2 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log2(uint256 x) internal pure returns (uint256 r) {
// If value has upper 128 bits set, log2 result is at least 128
r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
// If upper 64 bits of 128-bit half set, add 64 to result
r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
// If upper 32 bits of 64-bit half set, add 32 to result
r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
// If upper 16 bits of 32-bit half set, add 16 to result
r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
// If upper 8 bits of 16-bit half set, add 8 to result
r |= SafeCast.toUint((x >> r) > 0xff) << 3;
// If upper 4 bits of 8-bit half set, add 4 to result
r |= SafeCast.toUint((x >> r) > 0xf) << 2;
// Shifts value right by the current result and use it as an index into this lookup table:
//
// | x (4 bits) | index | table[index] = MSB position |
// |------------|---------|-----------------------------|
// | 0000 | 0 | table[0] = 0 |
// | 0001 | 1 | table[1] = 0 |
// | 0010 | 2 | table[2] = 1 |
// | 0011 | 3 | table[3] = 1 |
// | 0100 | 4 | table[4] = 2 |
// | 0101 | 5 | table[5] = 2 |
// | 0110 | 6 | table[6] = 2 |
// | 0111 | 7 | table[7] = 2 |
// | 1000 | 8 | table[8] = 3 |
// | 1001 | 9 | table[9] = 3 |
// | 1010 | 10 | table[10] = 3 |
// | 1011 | 11 | table[11] = 3 |
// | 1100 | 12 | table[12] = 3 |
// | 1101 | 13 | table[13] = 3 |
// | 1110 | 14 | table[14] = 3 |
// | 1111 | 15 | table[15] = 3 |
//
// The lookup table is represented as a 32-byte value with the MSB positions for 0-15 in the last 16 bytes.
assembly ("memory-safe") {
r := or(r, byte(shr(r, x), 0x0000010102020202030303030303030300000000000000000000000000000000))
}
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << result < value);
}
}
/**
* @dev Return the log in base 10 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10 ** 64) {
value /= 10 ** 64;
result += 64;
}
if (value >= 10 ** 32) {
value /= 10 ** 32;
result += 32;
}
if (value >= 10 ** 16) {
value /= 10 ** 16;
result += 16;
}
if (value >= 10 ** 8) {
value /= 10 ** 8;
result += 8;
}
if (value >= 10 ** 4) {
value /= 10 ** 4;
result += 4;
}
if (value >= 10 ** 2) {
value /= 10 ** 2;
result += 2;
}
if (value >= 10 ** 1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 10 ** result < value);
}
}
/**
* @dev Return the log in base 256 of a positive value rounded towards zero.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 x) internal pure returns (uint256 r) {
// If value has upper 128 bits set, log2 result is at least 128
r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
// If upper 64 bits of 128-bit half set, add 64 to result
r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
// If upper 32 bits of 64-bit half set, add 32 to result
r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
// If upper 16 bits of 32-bit half set, add 16 to result
r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
// Add 1 if upper 8 bits of 16-bit half set, and divide accumulated result by 8
return (r >> 3) | SafeCast.toUint((x >> r) > 0xff);
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << (result << 3) < value);
}
}
/**
* @dev Returns whether a provided rounding mode is considered rounding up for unsigned integers.
*/
function unsignedRoundsUp(Rounding rounding) internal pure returns (bool) {
return uint8(rounding) % 2 == 1;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/math/SafeCast.sol)
// This file was procedurally generated from scripts/generate/templates/SafeCast.js.
pragma solidity ^0.8.20;
/**
* @dev Wrappers over Solidity's uintXX/intXX/bool casting operators with added overflow
* checks.
*
* Downcasting from uint256/int256 in Solidity does not revert on overflow. This can
* easily result in undesired exploitation or bugs, since developers usually
* assume that overflows raise errors. `SafeCast` restores this intuition by
* reverting the transaction when such an operation overflows.
*
* Using this library instead of the unchecked operations eliminates an entire
* class of bugs, so it's recommended to use it always.
*/
library SafeCast {
/**
* @dev Value doesn't fit in an uint of `bits` size.
*/
error SafeCastOverflowedUintDowncast(uint8 bits, uint256 value);
/**
* @dev An int value doesn't fit in an uint of `bits` size.
*/
error SafeCastOverflowedIntToUint(int256 value);
/**
* @dev Value doesn't fit in an int of `bits` size.
*/
error SafeCastOverflowedIntDowncast(uint8 bits, int256 value);
/**
* @dev An uint value doesn't fit in an int of `bits` size.
*/
error SafeCastOverflowedUintToInt(uint256 value);
/**
* @dev Returns the downcasted uint248 from uint256, reverting on
* overflow (when the input is greater than largest uint248).
*
* Counterpart to Solidity's `uint248` operator.
*
* Requirements:
*
* - input must fit into 248 bits
*/
function toUint248(uint256 value) internal pure returns (uint248) {
if (value > type(uint248).max) {
revert SafeCastOverflowedUintDowncast(248, value);
}
return uint248(value);
}
/**
* @dev Returns the downcasted uint240 from uint256, reverting on
* overflow (when the input is greater than largest uint240).
*
* Counterpart to Solidity's `uint240` operator.
*
* Requirements:
*
* - input must fit into 240 bits
*/
function toUint240(uint256 value) internal pure returns (uint240) {
if (value > type(uint240).max) {
revert SafeCastOverflowedUintDowncast(240, value);
}
return uint240(value);
}
/**
* @dev Returns the downcasted uint232 from uint256, reverting on
* overflow (when the input is greater than largest uint232).
*
* Counterpart to Solidity's `uint232` operator.
*
* Requirements:
*
* - input must fit into 232 bits
*/
function toUint232(uint256 value) internal pure returns (uint232) {
if (value > type(uint232).max) {
revert SafeCastOverflowedUintDowncast(232, value);
}
return uint232(value);
}
/**
* @dev Returns the downcasted uint224 from uint256, reverting on
* overflow (when the input is greater than largest uint224).
*
* Counterpart to Solidity's `uint224` operator.
*
* Requirements:
*
* - input must fit into 224 bits
*/
function toUint224(uint256 value) internal pure returns (uint224) {
if (value > type(uint224).max) {
revert SafeCastOverflowedUintDowncast(224, value);
}
return uint224(value);
}
/**
* @dev Returns the downcasted uint216 from uint256, reverting on
* overflow (when the input is greater than largest uint216).
*
* Counterpart to Solidity's `uint216` operator.
*
* Requirements:
*
* - input must fit into 216 bits
*/
function toUint216(uint256 value) internal pure returns (uint216) {
if (value > type(uint216).max) {
revert SafeCastOverflowedUintDowncast(216, value);
}
return uint216(value);
}
/**
* @dev Returns the downcasted uint208 from uint256, reverting on
* overflow (when the input is greater than largest uint208).
*
* Counterpart to Solidity's `uint208` operator.
*
* Requirements:
*
* - input must fit into 208 bits
*/
function toUint208(uint256 value) internal pure returns (uint208) {
if (value > type(uint208).max) {
revert SafeCastOverflowedUintDowncast(208, value);
}
return uint208(value);
}
/**
* @dev Returns the downcasted uint200 from uint256, reverting on
* overflow (when the input is greater than largest uint200).
*
* Counterpart to Solidity's `uint200` operator.
*
* Requirements:
*
* - input must fit into 200 bits
*/
function toUint200(uint256 value) internal pure returns (uint200) {
if (value > type(uint200).max) {
revert SafeCastOverflowedUintDowncast(200, value);
}
return uint200(value);
}
/**
* @dev Returns the downcasted uint192 from uint256, reverting on
* overflow (when the input is greater than largest uint192).
*
* Counterpart to Solidity's `uint192` operator.
*
* Requirements:
*
* - input must fit into 192 bits
*/
function toUint192(uint256 value) internal pure returns (uint192) {
if (value > type(uint192).max) {
revert SafeCastOverflowedUintDowncast(192, value);
}
return uint192(value);
}
/**
* @dev Returns the downcasted uint184 from uint256, reverting on
* overflow (when the input is greater than largest uint184).
*
* Counterpart to Solidity's `uint184` operator.
*
* Requirements:
*
* - input must fit into 184 bits
*/
function toUint184(uint256 value) internal pure returns (uint184) {
if (value > type(uint184).max) {
revert SafeCastOverflowedUintDowncast(184, value);
}
return uint184(value);
}
/**
* @dev Returns the downcasted uint176 from uint256, reverting on
* overflow (when the input is greater than largest uint176).
*
* Counterpart to Solidity's `uint176` operator.
*
* Requirements:
*
* - input must fit into 176 bits
*/
function toUint176(uint256 value) internal pure returns (uint176) {
if (value > type(uint176).max) {
revert SafeCastOverflowedUintDowncast(176, value);
}
return uint176(value);
}
/**
* @dev Returns the downcasted uint168 from uint256, reverting on
* overflow (when the input is greater than largest uint168).
*
* Counterpart to Solidity's `uint168` operator.
*
* Requirements:
*
* - input must fit into 168 bits
*/
function toUint168(uint256 value) internal pure returns (uint168) {
if (value > type(uint168).max) {
revert SafeCastOverflowedUintDowncast(168, value);
}
return uint168(value);
}
/**
* @dev Returns the downcasted uint160 from uint256, reverting on
* overflow (when the input is greater than largest uint160).
*
* Counterpart to Solidity's `uint160` operator.
*
* Requirements:
*
* - input must fit into 160 bits
*/
function toUint160(uint256 value) internal pure returns (uint160) {
if (value > type(uint160).max) {
revert SafeCastOverflowedUintDowncast(160, value);
}
return uint160(value);
}
/**
* @dev Returns the downcasted uint152 from uint256, reverting on
* overflow (when the input is greater than largest uint152).
*
* Counterpart to Solidity's `uint152` operator.
*
* Requirements:
*
* - input must fit into 152 bits
*/
function toUint152(uint256 value) internal pure returns (uint152) {
if (value > type(uint152).max) {
revert SafeCastOverflowedUintDowncast(152, value);
}
return uint152(value);
}
/**
* @dev Returns the downcasted uint144 from uint256, reverting on
* overflow (when the input is greater than largest uint144).
*
* Counterpart to Solidity's `uint144` operator.
*
* Requirements:
*
* - input must fit into 144 bits
*/
function toUint144(uint256 value) internal pure returns (uint144) {
if (value > type(uint144).max) {
revert SafeCastOverflowedUintDowncast(144, value);
}
return uint144(value);
}
/**
* @dev Returns the downcasted uint136 from uint256, reverting on
* overflow (when the input is greater than largest uint136).
*
* Counterpart to Solidity's `uint136` operator.
*
* Requirements:
*
* - input must fit into 136 bits
*/
function toUint136(uint256 value) internal pure returns (uint136) {
if (value > type(uint136).max) {
revert SafeCastOverflowedUintDowncast(136, value);
}
return uint136(value);
}
/**
* @dev Returns the downcasted uint128 from uint256, reverting on
* overflow (when the input is greater than largest uint128).
*
* Counterpart to Solidity's `uint128` operator.
*
* Requirements:
*
* - input must fit into 128 bits
*/
function toUint128(uint256 value) internal pure returns (uint128) {
if (value > type(uint128).max) {
revert SafeCastOverflowedUintDowncast(128, value);
}
return uint128(value);
}
/**
* @dev Returns the downcasted uint120 from uint256, reverting on
* overflow (when the input is greater than largest uint120).
*
* Counterpart to Solidity's `uint120` operator.
*
* Requirements:
*
* - input must fit into 120 bits
*/
function toUint120(uint256 value) internal pure returns (uint120) {
if (value > type(uint120).max) {
revert SafeCastOverflowedUintDowncast(120, value);
}
return uint120(value);
}
/**
* @dev Returns the downcasted uint112 from uint256, reverting on
* overflow (when the input is greater than largest uint112).
*
* Counterpart to Solidity's `uint112` operator.
*
* Requirements:
*
* - input must fit into 112 bits
*/
function toUint112(uint256 value) internal pure returns (uint112) {
if (value > type(uint112).max) {
revert SafeCastOverflowedUintDowncast(112, value);
}
return uint112(value);
}
/**
* @dev Returns the downcasted uint104 from uint256, reverting on
* overflow (when the input is greater than largest uint104).
*
* Counterpart to Solidity's `uint104` operator.
*
* Requirements:
*
* - input must fit into 104 bits
*/
function toUint104(uint256 value) internal pure returns (uint104) {
if (value > type(uint104).max) {
revert SafeCastOverflowedUintDowncast(104, value);
}
return uint104(value);
}
/**
* @dev Returns the downcasted uint96 from uint256, reverting on
* overflow (when the input is greater than largest uint96).
*
* Counterpart to Solidity's `uint96` operator.
*
* Requirements:
*
* - input must fit into 96 bits
*/
function toUint96(uint256 value) internal pure returns (uint96) {
if (value > type(uint96).max) {
revert SafeCastOverflowedUintDowncast(96, value);
}
return uint96(value);
}
/**
* @dev Returns the downcasted uint88 from uint256, reverting on
* overflow (when the input is greater than largest uint88).
*
* Counterpart to Solidity's `uint88` operator.
*
* Requirements:
*
* - input must fit into 88 bits
*/
function toUint88(uint256 value) internal pure returns (uint88) {
if (value > type(uint88).max) {
revert SafeCastOverflowedUintDowncast(88, value);
}
return uint88(value);
}
/**
* @dev Returns the downcasted uint80 from uint256, reverting on
* overflow (when the input is greater than largest uint80).
*
* Counterpart to Solidity's `uint80` operator.
*
* Requirements:
*
* - input must fit into 80 bits
*/
function toUint80(uint256 value) internal pure returns (uint80) {
if (value > type(uint80).max) {
revert SafeCastOverflowedUintDowncast(80, value);
}
return uint80(value);
}
/**
* @dev Returns the downcasted uint72 from uint256, reverting on
* overflow (when the input is greater than largest uint72).
*
* Counterpart to Solidity's `uint72` operator.
*
* Requirements:
*
* - input must fit into 72 bits
*/
function toUint72(uint256 value) internal pure returns (uint72) {
if (value > type(uint72).max) {
revert SafeCastOverflowedUintDowncast(72, value);
}
return uint72(value);
}
/**
* @dev Returns the downcasted uint64 from uint256, reverting on
* overflow (when the input is greater than largest uint64).
*
* Counterpart to Solidity's `uint64` operator.
*
* Requirements:
*
* - input must fit into 64 bits
*/
function toUint64(uint256 value) internal pure returns (uint64) {
if (value > type(uint64).max) {
revert SafeCastOverflowedUintDowncast(64, value);
}
return uint64(value);
}
/**
* @dev Returns the downcasted uint56 from uint256, reverting on
* overflow (when the input is greater than largest uint56).
*
* Counterpart to Solidity's `uint56` operator.
*
* Requirements:
*
* - input must fit into 56 bits
*/
function toUint56(uint256 value) internal pure returns (uint56) {
if (value > type(uint56).max) {
revert SafeCastOverflowedUintDowncast(56, value);
}
return uint56(value);
}
/**
* @dev Returns the downcasted uint48 from uint256, reverting on
* overflow (when the input is greater than largest uint48).
*
* Counterpart to Solidity's `uint48` operator.
*
* Requirements:
*
* - input must fit into 48 bits
*/
function toUint48(uint256 value) internal pure returns (uint48) {
if (value > type(uint48).max) {
revert SafeCastOverflowedUintDowncast(48, value);
}
return uint48(value);
}
/**
* @dev Returns the downcasted uint40 from uint256, reverting on
* overflow (when the input is greater than largest uint40).
*
* Counterpart to Solidity's `uint40` operator.
*
* Requirements:
*
* - input must fit into 40 bits
*/
function toUint40(uint256 value) internal pure returns (uint40) {
if (value > type(uint40).max) {
revert SafeCastOverflowedUintDowncast(40, value);
}
return uint40(value);
}
/**
* @dev Returns the downcasted uint32 from uint256, reverting on
* overflow (when the input is greater than largest uint32).
*
* Counterpart to Solidity's `uint32` operator.
*
* Requirements:
*
* - input must fit into 32 bits
*/
function toUint32(uint256 value) internal pure returns (uint32) {
if (value > type(uint32).max) {
revert SafeCastOverflowedUintDowncast(32, value);
}
return uint32(value);
}
/**
* @dev Returns the downcasted uint24 from uint256, reverting on
* overflow (when the input is greater than largest uint24).
*
* Counterpart to Solidity's `uint24` operator.
*
* Requirements:
*
* - input must fit into 24 bits
*/
function toUint24(uint256 value) internal pure returns (uint24) {
if (value > type(uint24).max) {
revert SafeCastOverflowedUintDowncast(24, value);
}
return uint24(value);
}
/**
* @dev Returns the downcasted uint16 from uint256, reverting on
* overflow (when the input is greater than largest uint16).
*
* Counterpart to Solidity's `uint16` operator.
*
* Requirements:
*
* - input must fit into 16 bits
*/
function toUint16(uint256 value) internal pure returns (uint16) {
if (value > type(uint16).max) {
revert SafeCastOverflowedUintDowncast(16, value);
}
return uint16(value);
}
/**
* @dev Returns the downcasted uint8 from uint256, reverting on
* overflow (when the input is greater than largest uint8).
*
* Counterpart to Solidity's `uint8` operator.
*
* Requirements:
*
* - input must fit into 8 bits
*/
function toUint8(uint256 value) internal pure returns (uint8) {
if (value > type(uint8).max) {
revert SafeCastOverflowedUintDowncast(8, value);
}
return uint8(value);
}
/**
* @dev Converts a signed int256 into an unsigned uint256.
*
* Requirements:
*
* - input must be greater than or equal to 0.
*/
function toUint256(int256 value) internal pure returns (uint256) {
if (value < 0) {
revert SafeCastOverflowedIntToUint(value);
}
return uint256(value);
}
/**
* @dev Returns the downcasted int248 from int256, reverting on
* overflow (when the input is less than smallest int248 or
* greater than largest int248).
*
* Counterpart to Solidity's `int248` operator.
*
* Requirements:
*
* - input must fit into 248 bits
*/
function toInt248(int256 value) internal pure returns (int248 downcasted) {
downcasted = int248(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(248, value);
}
}
/**
* @dev Returns the downcasted int240 from int256, reverting on
* overflow (when the input is less than smallest int240 or
* greater than largest int240).
*
* Counterpart to Solidity's `int240` operator.
*
* Requirements:
*
* - input must fit into 240 bits
*/
function toInt240(int256 value) internal pure returns (int240 downcasted) {
downcasted = int240(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(240, value);
}
}
/**
* @dev Returns the downcasted int232 from int256, reverting on
* overflow (when the input is less than smallest int232 or
* greater than largest int232).
*
* Counterpart to Solidity's `int232` operator.
*
* Requirements:
*
* - input must fit into 232 bits
*/
function toInt232(int256 value) internal pure returns (int232 downcasted) {
downcasted = int232(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(232, value);
}
}
/**
* @dev Returns the downcasted int224 from int256, reverting on
* overflow (when the input is less than smallest int224 or
* greater than largest int224).
*
* Counterpart to Solidity's `int224` operator.
*
* Requirements:
*
* - input must fit into 224 bits
*/
function toInt224(int256 value) internal pure returns (int224 downcasted) {
downcasted = int224(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(224, value);
}
}
/**
* @dev Returns the downcasted int216 from int256, reverting on
* overflow (when the input is less than smallest int216 or
* greater than largest int216).
*
* Counterpart to Solidity's `int216` operator.
*
* Requirements:
*
* - input must fit into 216 bits
*/
function toInt216(int256 value) internal pure returns (int216 downcasted) {
downcasted = int216(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(216, value);
}
}
/**
* @dev Returns the downcasted int208 from int256, reverting on
* overflow (when the input is less than smallest int208 or
* greater than largest int208).
*
* Counterpart to Solidity's `int208` operator.
*
* Requirements:
*
* - input must fit into 208 bits
*/
function toInt208(int256 value) internal pure returns (int208 downcasted) {
downcasted = int208(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(208, value);
}
}
/**
* @dev Returns the downcasted int200 from int256, reverting on
* overflow (when the input is less than smallest int200 or
* greater than largest int200).
*
* Counterpart to Solidity's `int200` operator.
*
* Requirements:
*
* - input must fit into 200 bits
*/
function toInt200(int256 value) internal pure returns (int200 downcasted) {
downcasted = int200(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(200, value);
}
}
/**
* @dev Returns the downcasted int192 from int256, reverting on
* overflow (when the input is less than smallest int192 or
* greater than largest int192).
*
* Counterpart to Solidity's `int192` operator.
*
* Requirements:
*
* - input must fit into 192 bits
*/
function toInt192(int256 value) internal pure returns (int192 downcasted) {
downcasted = int192(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(192, value);
}
}
/**
* @dev Returns the downcasted int184 from int256, reverting on
* overflow (when the input is less than smallest int184 or
* greater than largest int184).
*
* Counterpart to Solidity's `int184` operator.
*
* Requirements:
*
* - input must fit into 184 bits
*/
function toInt184(int256 value) internal pure returns (int184 downcasted) {
downcasted = int184(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(184, value);
}
}
/**
* @dev Returns the downcasted int176 from int256, reverting on
* overflow (when the input is less than smallest int176 or
* greater than largest int176).
*
* Counterpart to Solidity's `int176` operator.
*
* Requirements:
*
* - input must fit into 176 bits
*/
function toInt176(int256 value) internal pure returns (int176 downcasted) {
downcasted = int176(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(176, value);
}
}
/**
* @dev Returns the downcasted int168 from int256, reverting on
* overflow (when the input is less than smallest int168 or
* greater than largest int168).
*
* Counterpart to Solidity's `int168` operator.
*
* Requirements:
*
* - input must fit into 168 bits
*/
function toInt168(int256 value) internal pure returns (int168 downcasted) {
downcasted = int168(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(168, value);
}
}
/**
* @dev Returns the downcasted int160 from int256, reverting on
* overflow (when the input is less than smallest int160 or
* greater than largest int160).
*
* Counterpart to Solidity's `int160` operator.
*
* Requirements:
*
* - input must fit into 160 bits
*/
function toInt160(int256 value) internal pure returns (int160 downcasted) {
downcasted = int160(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(160, value);
}
}
/**
* @dev Returns the downcasted int152 from int256, reverting on
* overflow (when the input is less than smallest int152 or
* greater than largest int152).
*
* Counterpart to Solidity's `int152` operator.
*
* Requirements:
*
* - input must fit into 152 bits
*/
function toInt152(int256 value) internal pure returns (int152 downcasted) {
downcasted = int152(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(152, value);
}
}
/**
* @dev Returns the downcasted int144 from int256, reverting on
* overflow (when the input is less than smallest int144 or
* greater than largest int144).
*
* Counterpart to Solidity's `int144` operator.
*
* Requirements:
*
* - input must fit into 144 bits
*/
function toInt144(int256 value) internal pure returns (int144 downcasted) {
downcasted = int144(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(144, value);
}
}
/**
* @dev Returns the downcasted int136 from int256, reverting on
* overflow (when the input is less than smallest int136 or
* greater than largest int136).
*
* Counterpart to Solidity's `int136` operator.
*
* Requirements:
*
* - input must fit into 136 bits
*/
function toInt136(int256 value) internal pure returns (int136 downcasted) {
downcasted = int136(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(136, value);
}
}
/**
* @dev Returns the downcasted int128 from int256, reverting on
* overflow (when the input is less than smallest int128 or
* greater than largest int128).
*
* Counterpart to Solidity's `int128` operator.
*
* Requirements:
*
* - input must fit into 128 bits
*/
function toInt128(int256 value) internal pure returns (int128 downcasted) {
downcasted = int128(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(128, value);
}
}
/**
* @dev Returns the downcasted int120 from int256, reverting on
* overflow (when the input is less than smallest int120 or
* greater than largest int120).
*
* Counterpart to Solidity's `int120` operator.
*
* Requirements:
*
* - input must fit into 120 bits
*/
function toInt120(int256 value) internal pure returns (int120 downcasted) {
downcasted = int120(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(120, value);
}
}
/**
* @dev Returns the downcasted int112 from int256, reverting on
* overflow (when the input is less than smallest int112 or
* greater than largest int112).
*
* Counterpart to Solidity's `int112` operator.
*
* Requirements:
*
* - input must fit into 112 bits
*/
function toInt112(int256 value) internal pure returns (int112 downcasted) {
downcasted = int112(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(112, value);
}
}
/**
* @dev Returns the downcasted int104 from int256, reverting on
* overflow (when the input is less than smallest int104 or
* greater than largest int104).
*
* Counterpart to Solidity's `int104` operator.
*
* Requirements:
*
* - input must fit into 104 bits
*/
function toInt104(int256 value) internal pure returns (int104 downcasted) {
downcasted = int104(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(104, value);
}
}
/**
* @dev Returns the downcasted int96 from int256, reverting on
* overflow (when the input is less than smallest int96 or
* greater than largest int96).
*
* Counterpart to Solidity's `int96` operator.
*
* Requirements:
*
* - input must fit into 96 bits
*/
function toInt96(int256 value) internal pure returns (int96 downcasted) {
downcasted = int96(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(96, value);
}
}
/**
* @dev Returns the downcasted int88 from int256, reverting on
* overflow (when the input is less than smallest int88 or
* greater than largest int88).
*
* Counterpart to Solidity's `int88` operator.
*
* Requirements:
*
* - input must fit into 88 bits
*/
function toInt88(int256 value) internal pure returns (int88 downcasted) {
downcasted = int88(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(88, value);
}
}
/**
* @dev Returns the downcasted int80 from int256, reverting on
* overflow (when the input is less than smallest int80 or
* greater than largest int80).
*
* Counterpart to Solidity's `int80` operator.
*
* Requirements:
*
* - input must fit into 80 bits
*/
function toInt80(int256 value) internal pure returns (int80 downcasted) {
downcasted = int80(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(80, value);
}
}
/**
* @dev Returns the downcasted int72 from int256, reverting on
* overflow (when the input is less than smallest int72 or
* greater than largest int72).
*
* Counterpart to Solidity's `int72` operator.
*
* Requirements:
*
* - input must fit into 72 bits
*/
function toInt72(int256 value) internal pure returns (int72 downcasted) {
downcasted = int72(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(72, value);
}
}
/**
* @dev Returns the downcasted int64 from int256, reverting on
* overflow (when the input is less than smallest int64 or
* greater than largest int64).
*
* Counterpart to Solidity's `int64` operator.
*
* Requirements:
*
* - input must fit into 64 bits
*/
function toInt64(int256 value) internal pure returns (int64 downcasted) {
downcasted = int64(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(64, value);
}
}
/**
* @dev Returns the downcasted int56 from int256, reverting on
* overflow (when the input is less than smallest int56 or
* greater than largest int56).
*
* Counterpart to Solidity's `int56` operator.
*
* Requirements:
*
* - input must fit into 56 bits
*/
function toInt56(int256 value) internal pure returns (int56 downcasted) {
downcasted = int56(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(56, value);
}
}
/**
* @dev Returns the downcasted int48 from int256, reverting on
* overflow (when the input is less than smallest int48 or
* greater than largest int48).
*
* Counterpart to Solidity's `int48` operator.
*
* Requirements:
*
* - input must fit into 48 bits
*/
function toInt48(int256 value) internal pure returns (int48 downcasted) {
downcasted = int48(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(48, value);
}
}
/**
* @dev Returns the downcasted int40 from int256, reverting on
* overflow (when the input is less than smallest int40 or
* greater than largest int40).
*
* Counterpart to Solidity's `int40` operator.
*
* Requirements:
*
* - input must fit into 40 bits
*/
function toInt40(int256 value) internal pure returns (int40 downcasted) {
downcasted = int40(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(40, value);
}
}
/**
* @dev Returns the downcasted int32 from int256, reverting on
* overflow (when the input is less than smallest int32 or
* greater than largest int32).
*
* Counterpart to Solidity's `int32` operator.
*
* Requirements:
*
* - input must fit into 32 bits
*/
function toInt32(int256 value) internal pure returns (int32 downcasted) {
downcasted = int32(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(32, value);
}
}
/**
* @dev Returns the downcasted int24 from int256, reverting on
* overflow (when the input is less than smallest int24 or
* greater than largest int24).
*
* Counterpart to Solidity's `int24` operator.
*
* Requirements:
*
* - input must fit into 24 bits
*/
function toInt24(int256 value) internal pure returns (int24 downcasted) {
downcasted = int24(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(24, value);
}
}
/**
* @dev Returns the downcasted int16 from int256, reverting on
* overflow (when the input is less than smallest int16 or
* greater than largest int16).
*
* Counterpart to Solidity's `int16` operator.
*
* Requirements:
*
* - input must fit into 16 bits
*/
function toInt16(int256 value) internal pure returns (int16 downcasted) {
downcasted = int16(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(16, value);
}
}
/**
* @dev Returns the downcasted int8 from int256, reverting on
* overflow (when the input is less than smallest int8 or
* greater than largest int8).
*
* Counterpart to Solidity's `int8` operator.
*
* Requirements:
*
* - input must fit into 8 bits
*/
function toInt8(int256 value) internal pure returns (int8 downcasted) {
downcasted = int8(value);
if (downcasted != value) {
revert SafeCastOverflowedIntDowncast(8, value);
}
}
/**
* @dev Converts an unsigned uint256 into a signed int256.
*
* Requirements:
*
* - input must be less than or equal to maxInt256.
*/
function toInt256(uint256 value) internal pure returns (int256) {
// Note: Unsafe cast below is okay because `type(int256).max` is guaranteed to be positive
if (value > uint256(type(int256).max)) {
revert SafeCastOverflowedUintToInt(value);
}
return int256(value);
}
/**
* @dev Cast a boolean (false or true) to a uint256 (0 or 1) with no jump.
*/
function toUint(bool b) internal pure returns (uint256 u) {
assembly ("memory-safe") {
u := iszero(iszero(b))
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/math/SignedMath.sol)
pragma solidity ^0.8.20;
import {SafeCast} from "./SafeCast.sol";
/**
* @dev Standard signed math utilities missing in the Solidity language.
*/
library SignedMath {
/**
* @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant.
*
* IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.
* However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute
* one branch when needed, making this function more expensive.
*/
function ternary(bool condition, int256 a, int256 b) internal pure returns (int256) {
unchecked {
// branchless ternary works because:
// b ^ (a ^ b) == a
// b ^ 0 == b
return b ^ ((a ^ b) * int256(SafeCast.toUint(condition)));
}
}
/**
* @dev Returns the largest of two signed numbers.
*/
function max(int256 a, int256 b) internal pure returns (int256) {
return ternary(a > b, a, b);
}
/**
* @dev Returns the smallest of two signed numbers.
*/
function min(int256 a, int256 b) internal pure returns (int256) {
return ternary(a < b, a, b);
}
/**
* @dev Returns the average of two signed numbers without overflow.
* The result is rounded towards zero.
*/
function average(int256 a, int256 b) internal pure returns (int256) {
// Formula from the book "Hacker's Delight"
int256 x = (a & b) + ((a ^ b) >> 1);
return x + (int256(uint256(x) >> 255) & (a ^ b));
}
/**
* @dev Returns the absolute unsigned value of a signed value.
*/
function abs(int256 n) internal pure returns (uint256) {
unchecked {
// Formula from the "Bit Twiddling Hacks" by Sean Eron Anderson.
// Since `n` is a signed integer, the generated bytecode will use the SAR opcode to perform the right shift,
// taking advantage of the most significant (or "sign" bit) in two's complement representation.
// This opcode adds new most significant bits set to the value of the previous most significant bit. As a result,
// the mask will either be `bytes32(0)` (if n is positive) or `~bytes32(0)` (if n is negative).
int256 mask = n >> 255;
// A `bytes32(0)` mask leaves the input unchanged, while a `~bytes32(0)` mask complements it.
return uint256((n + mask) ^ mask);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Panic.sol)
pragma solidity ^0.8.20;
/**
* @dev Helper library for emitting standardized panic codes.
*
* ```solidity
* contract Example {
* using Panic for uint256;
*
* // Use any of the declared internal constants
* function foo() { Panic.GENERIC.panic(); }
*
* // Alternatively
* function foo() { Panic.panic(Panic.GENERIC); }
* }
* ```
*
* Follows the list from https://github.com/ethereum/solidity/blob/v0.8.24/libsolutil/ErrorCodes.h[libsolutil].
*
* _Available since v5.1._
*/
// slither-disable-next-line unused-state
library Panic {
/// @dev generic / unspecified error
uint256 internal constant GENERIC = 0x00;
/// @dev used by the assert() builtin
uint256 internal constant ASSERT = 0x01;
/// @dev arithmetic underflow or overflow
uint256 internal constant UNDER_OVERFLOW = 0x11;
/// @dev division or modulo by zero
uint256 internal constant DIVISION_BY_ZERO = 0x12;
/// @dev enum conversion error
uint256 internal constant ENUM_CONVERSION_ERROR = 0x21;
/// @dev invalid encoding in storage
uint256 internal constant STORAGE_ENCODING_ERROR = 0x22;
/// @dev empty array pop
uint256 internal constant EMPTY_ARRAY_POP = 0x31;
/// @dev array out of bounds access
uint256 internal constant ARRAY_OUT_OF_BOUNDS = 0x32;
/// @dev resource error (too large allocation or too large array)
uint256 internal constant RESOURCE_ERROR = 0x41;
/// @dev calling invalid internal function
uint256 internal constant INVALID_INTERNAL_FUNCTION = 0x51;
/// @dev Reverts with a panic code. Recommended to use with
/// the internal constants with predefined codes.
function panic(uint256 code) internal pure {
assembly ("memory-safe") {
mstore(0x00, 0x4e487b71)
mstore(0x20, code)
revert(0x1c, 0x24)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/ShortStrings.sol)
pragma solidity ^0.8.20;
import {StorageSlot} from "./StorageSlot.sol";
// | string | 0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA |
// | length | 0x BB |
type ShortString is bytes32;
/**
* @dev This library provides functions to convert short memory strings
* into a `ShortString` type that can be used as an immutable variable.
*
* Strings of arbitrary length can be optimized using this library if
* they are short enough (up to 31 bytes) by packing them with their
* length (1 byte) in a single EVM word (32 bytes). Additionally, a
* fallback mechanism can be used for every other case.
*
* Usage example:
*
* ```solidity
* contract Named {
* using ShortStrings for *;
*
* ShortString private immutable _name;
* string private _nameFallback;
*
* constructor(string memory contractName) {
* _name = contractName.toShortStringWithFallback(_nameFallback);
* }
*
* function name() external view returns (string memory) {
* return _name.toStringWithFallback(_nameFallback);
* }
* }
* ```
*/
library ShortStrings {
// Used as an identifier for strings longer than 31 bytes.
bytes32 private constant FALLBACK_SENTINEL = 0x00000000000000000000000000000000000000000000000000000000000000FF;
error StringTooLong(string str);
error InvalidShortString();
/**
* @dev Encode a string of at most 31 chars into a `ShortString`.
*
* This will trigger a `StringTooLong` error is the input string is too long.
*/
function toShortString(string memory str) internal pure returns (ShortString) {
bytes memory bstr = bytes(str);
if (bstr.length > 31) {
revert StringTooLong(str);
}
return ShortString.wrap(bytes32(uint256(bytes32(bstr)) | bstr.length));
}
/**
* @dev Decode a `ShortString` back to a "normal" string.
*/
function toString(ShortString sstr) internal pure returns (string memory) {
uint256 len = byteLength(sstr);
// using `new string(len)` would work locally but is not memory safe.
string memory str = new string(32);
assembly ("memory-safe") {
mstore(str, len)
mstore(add(str, 0x20), sstr)
}
return str;
}
/**
* @dev Return the length of a `ShortString`.
*/
function byteLength(ShortString sstr) internal pure returns (uint256) {
uint256 result = uint256(ShortString.unwrap(sstr)) & 0xFF;
if (result > 31) {
revert InvalidShortString();
}
return result;
}
/**
* @dev Encode a string into a `ShortString`, or write it to storage if it is too long.
*/
function toShortStringWithFallback(string memory value, string storage store) internal returns (ShortString) {
if (bytes(value).length < 32) {
return toShortString(value);
} else {
StorageSlot.getStringSlot(store).value = value;
return ShortString.wrap(FALLBACK_SENTINEL);
}
}
/**
* @dev Decode a string that was encoded to `ShortString` or written to storage using {toShortStringWithFallback}.
*/
function toStringWithFallback(ShortString value, string storage store) internal pure returns (string memory) {
if (ShortString.unwrap(value) != FALLBACK_SENTINEL) {
return toString(value);
} else {
return store;
}
}
/**
* @dev Return the length of a string that was encoded to `ShortString` or written to storage using
* {toShortStringWithFallback}.
*
* WARNING: This will return the "byte length" of the string. This may not reflect the actual length in terms of
* actual characters as the UTF-8 encoding of a single character can span over multiple bytes.
*/
function byteLengthWithFallback(ShortString value, string storage store) internal view returns (uint256) {
if (ShortString.unwrap(value) != FALLBACK_SENTINEL) {
return byteLength(value);
} else {
return bytes(store).length;
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.
pragma solidity ^0.8.20;
/**
* @dev Library for reading and writing primitive types to specific storage slots.
*
* Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.
* This library helps with reading and writing to such slots without the need for inline assembly.
*
* The functions in this library return Slot structs that contain a `value` member that can be used to read or write.
*
* Example usage to set ERC-1967 implementation slot:
* ```solidity
* contract ERC1967 {
* // Define the slot. Alternatively, use the SlotDerivation library to derive the slot.
* bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
*
* function _getImplementation() internal view returns (address) {
* return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
* }
*
* function _setImplementation(address newImplementation) internal {
* require(newImplementation.code.length > 0);
* StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
* }
* }
* ```
*
* TIP: Consider using this library along with {SlotDerivation}.
*/
library StorageSlot {
struct AddressSlot {
address value;
}
struct BooleanSlot {
bool value;
}
struct Bytes32Slot {
bytes32 value;
}
struct Uint256Slot {
uint256 value;
}
struct Int256Slot {
int256 value;
}
struct StringSlot {
string value;
}
struct BytesSlot {
bytes value;
}
/**
* @dev Returns an `AddressSlot` with member `value` located at `slot`.
*/
function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `BooleanSlot` with member `value` located at `slot`.
*/
function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Bytes32Slot` with member `value` located at `slot`.
*/
function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Uint256Slot` with member `value` located at `slot`.
*/
function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Int256Slot` with member `value` located at `slot`.
*/
function getInt256Slot(bytes32 slot) internal pure returns (Int256Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `StringSlot` with member `value` located at `slot`.
*/
function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` representation of the string storage pointer `store`.
*/
function getStringSlot(string storage store) internal pure returns (StringSlot storage r) {
assembly ("memory-safe") {
r.slot := store.slot
}
}
/**
* @dev Returns a `BytesSlot` with member `value` located at `slot`.
*/
function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns an `BytesSlot` representation of the bytes storage pointer `store`.
*/
function getBytesSlot(bytes storage store) internal pure returns (BytesSlot storage r) {
assembly ("memory-safe") {
r.slot := store.slot
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/Strings.sol)
pragma solidity ^0.8.20;
import {Math} from "./math/Math.sol";
import {SafeCast} from "./math/SafeCast.sol";
import {SignedMath} from "./math/SignedMath.sol";
/**
* @dev String operations.
*/
library Strings {
using SafeCast for *;
bytes16 private constant HEX_DIGITS = "0123456789abcdef";
uint8 private constant ADDRESS_LENGTH = 20;
uint256 private constant SPECIAL_CHARS_LOOKUP =
(1 << 0x08) | // backspace
(1 << 0x09) | // tab
(1 << 0x0a) | // newline
(1 << 0x0c) | // form feed
(1 << 0x0d) | // carriage return
(1 << 0x22) | // double quote
(1 << 0x5c); // backslash
/**
* @dev The `value` string doesn't fit in the specified `length`.
*/
error StringsInsufficientHexLength(uint256 value, uint256 length);
/**
* @dev The string being parsed contains characters that are not in scope of the given base.
*/
error StringsInvalidChar();
/**
* @dev The string being parsed is not a properly formatted address.
*/
error StringsInvalidAddressFormat();
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
unchecked {
uint256 length = Math.log10(value) + 1;
string memory buffer = new string(length);
uint256 ptr;
assembly ("memory-safe") {
ptr := add(add(buffer, 0x20), length)
}
while (true) {
ptr--;
assembly ("memory-safe") {
mstore8(ptr, byte(mod(value, 10), HEX_DIGITS))
}
value /= 10;
if (value == 0) break;
}
return buffer;
}
}
/**
* @dev Converts a `int256` to its ASCII `string` decimal representation.
*/
function toStringSigned(int256 value) internal pure returns (string memory) {
return string.concat(value < 0 ? "-" : "", toString(SignedMath.abs(value)));
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
unchecked {
return toHexString(value, Math.log256(value) + 1);
}
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
uint256 localValue = value;
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = HEX_DIGITS[localValue & 0xf];
localValue >>= 4;
}
if (localValue != 0) {
revert StringsInsufficientHexLength(value, length);
}
return string(buffer);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal
* representation.
*/
function toHexString(address addr) internal pure returns (string memory) {
return toHexString(uint256(uint160(addr)), ADDRESS_LENGTH);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its checksummed ASCII `string` hexadecimal
* representation, according to EIP-55.
*/
function toChecksumHexString(address addr) internal pure returns (string memory) {
bytes memory buffer = bytes(toHexString(addr));
// hash the hex part of buffer (skip length + 2 bytes, length 40)
uint256 hashValue;
assembly ("memory-safe") {
hashValue := shr(96, keccak256(add(buffer, 0x22), 40))
}
for (uint256 i = 41; i > 1; --i) {
// possible values for buffer[i] are 48 (0) to 57 (9) and 97 (a) to 102 (f)
if (hashValue & 0xf > 7 && uint8(buffer[i]) > 96) {
// case shift by xoring with 0x20
buffer[i] ^= 0x20;
}
hashValue >>= 4;
}
return string(buffer);
}
/**
* @dev Returns true if the two strings are equal.
*/
function equal(string memory a, string memory b) internal pure returns (bool) {
return bytes(a).length == bytes(b).length && keccak256(bytes(a)) == keccak256(bytes(b));
}
/**
* @dev Parse a decimal string and returns the value as a `uint256`.
*
* Requirements:
* - The string must be formatted as `[0-9]*`
* - The result must fit into an `uint256` type
*/
function parseUint(string memory input) internal pure returns (uint256) {
return parseUint(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseUint-string} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `[0-9]*`
* - The result must fit into an `uint256` type
*/
function parseUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) {
(bool success, uint256 value) = tryParseUint(input, begin, end);
if (!success) revert StringsInvalidChar();
return value;
}
/**
* @dev Variant of {parseUint-string} that returns false if the parsing fails because of an invalid character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseUint(string memory input) internal pure returns (bool success, uint256 value) {
return _tryParseUintUncheckedBounds(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseUint-string-uint256-uint256} that returns false if the parsing fails because of an invalid
* character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseUint(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, uint256 value) {
if (end > bytes(input).length || begin > end) return (false, 0);
return _tryParseUintUncheckedBounds(input, begin, end);
}
/**
* @dev Implementation of {tryParseUint-string-uint256-uint256} that does not check bounds. Caller should make sure that
* `begin <= end <= input.length`. Other inputs would result in undefined behavior.
*/
function _tryParseUintUncheckedBounds(
string memory input,
uint256 begin,
uint256 end
) private pure returns (bool success, uint256 value) {
bytes memory buffer = bytes(input);
uint256 result = 0;
for (uint256 i = begin; i < end; ++i) {
uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i)));
if (chr > 9) return (false, 0);
result *= 10;
result += chr;
}
return (true, result);
}
/**
* @dev Parse a decimal string and returns the value as a `int256`.
*
* Requirements:
* - The string must be formatted as `[-+]?[0-9]*`
* - The result must fit in an `int256` type.
*/
function parseInt(string memory input) internal pure returns (int256) {
return parseInt(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseInt-string} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `[-+]?[0-9]*`
* - The result must fit in an `int256` type.
*/
function parseInt(string memory input, uint256 begin, uint256 end) internal pure returns (int256) {
(bool success, int256 value) = tryParseInt(input, begin, end);
if (!success) revert StringsInvalidChar();
return value;
}
/**
* @dev Variant of {parseInt-string} that returns false if the parsing fails because of an invalid character or if
* the result does not fit in a `int256`.
*
* NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`.
*/
function tryParseInt(string memory input) internal pure returns (bool success, int256 value) {
return _tryParseIntUncheckedBounds(input, 0, bytes(input).length);
}
uint256 private constant ABS_MIN_INT256 = 2 ** 255;
/**
* @dev Variant of {parseInt-string-uint256-uint256} that returns false if the parsing fails because of an invalid
* character or if the result does not fit in a `int256`.
*
* NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`.
*/
function tryParseInt(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, int256 value) {
if (end > bytes(input).length || begin > end) return (false, 0);
return _tryParseIntUncheckedBounds(input, begin, end);
}
/**
* @dev Implementation of {tryParseInt-string-uint256-uint256} that does not check bounds. Caller should make sure that
* `begin <= end <= input.length`. Other inputs would result in undefined behavior.
*/
function _tryParseIntUncheckedBounds(
string memory input,
uint256 begin,
uint256 end
) private pure returns (bool success, int256 value) {
bytes memory buffer = bytes(input);
// Check presence of a negative sign.
bytes1 sign = begin == end ? bytes1(0) : bytes1(_unsafeReadBytesOffset(buffer, begin)); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
bool positiveSign = sign == bytes1("+");
bool negativeSign = sign == bytes1("-");
uint256 offset = (positiveSign || negativeSign).toUint();
(bool absSuccess, uint256 absValue) = tryParseUint(input, begin + offset, end);
if (absSuccess && absValue < ABS_MIN_INT256) {
return (true, negativeSign ? -int256(absValue) : int256(absValue));
} else if (absSuccess && negativeSign && absValue == ABS_MIN_INT256) {
return (true, type(int256).min);
} else return (false, 0);
}
/**
* @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as a `uint256`.
*
* Requirements:
* - The string must be formatted as `(0x)?[0-9a-fA-F]*`
* - The result must fit in an `uint256` type.
*/
function parseHexUint(string memory input) internal pure returns (uint256) {
return parseHexUint(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseHexUint-string} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `(0x)?[0-9a-fA-F]*`
* - The result must fit in an `uint256` type.
*/
function parseHexUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) {
(bool success, uint256 value) = tryParseHexUint(input, begin, end);
if (!success) revert StringsInvalidChar();
return value;
}
/**
* @dev Variant of {parseHexUint-string} that returns false if the parsing fails because of an invalid character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseHexUint(string memory input) internal pure returns (bool success, uint256 value) {
return _tryParseHexUintUncheckedBounds(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseHexUint-string-uint256-uint256} that returns false if the parsing fails because of an
* invalid character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseHexUint(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, uint256 value) {
if (end > bytes(input).length || begin > end) return (false, 0);
return _tryParseHexUintUncheckedBounds(input, begin, end);
}
/**
* @dev Implementation of {tryParseHexUint-string-uint256-uint256} that does not check bounds. Caller should make sure that
* `begin <= end <= input.length`. Other inputs would result in undefined behavior.
*/
function _tryParseHexUintUncheckedBounds(
string memory input,
uint256 begin,
uint256 end
) private pure returns (bool success, uint256 value) {
bytes memory buffer = bytes(input);
// skip 0x prefix if present
bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(buffer, begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
uint256 offset = hasPrefix.toUint() * 2;
uint256 result = 0;
for (uint256 i = begin + offset; i < end; ++i) {
uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i)));
if (chr > 15) return (false, 0);
result *= 16;
unchecked {
// Multiplying by 16 is equivalent to a shift of 4 bits (with additional overflow check).
// This guarantees that adding a value < 16 will not cause an overflow, hence the unchecked.
result += chr;
}
}
return (true, result);
}
/**
* @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as an `address`.
*
* Requirements:
* - The string must be formatted as `(0x)?[0-9a-fA-F]{40}`
*/
function parseAddress(string memory input) internal pure returns (address) {
return parseAddress(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseAddress-string} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `(0x)?[0-9a-fA-F]{40}`
*/
function parseAddress(string memory input, uint256 begin, uint256 end) internal pure returns (address) {
(bool success, address value) = tryParseAddress(input, begin, end);
if (!success) revert StringsInvalidAddressFormat();
return value;
}
/**
* @dev Variant of {parseAddress-string} that returns false if the parsing fails because the input is not a properly
* formatted address. See {parseAddress-string} requirements.
*/
function tryParseAddress(string memory input) internal pure returns (bool success, address value) {
return tryParseAddress(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseAddress-string-uint256-uint256} that returns false if the parsing fails because input is not a properly
* formatted address. See {parseAddress-string-uint256-uint256} requirements.
*/
function tryParseAddress(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, address value) {
if (end > bytes(input).length || begin > end) return (false, address(0));
bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(bytes(input), begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
uint256 expectedLength = 40 + hasPrefix.toUint() * 2;
// check that input is the correct length
if (end - begin == expectedLength) {
// length guarantees that this does not overflow, and value is at most type(uint160).max
(bool s, uint256 v) = _tryParseHexUintUncheckedBounds(input, begin, end);
return (s, address(uint160(v)));
} else {
return (false, address(0));
}
}
function _tryParseChr(bytes1 chr) private pure returns (uint8) {
uint8 value = uint8(chr);
// Try to parse `chr`:
// - Case 1: [0-9]
// - Case 2: [a-f]
// - Case 3: [A-F]
// - otherwise not supported
unchecked {
if (value > 47 && value < 58) value -= 48;
else if (value > 96 && value < 103) value -= 87;
else if (value > 64 && value < 71) value -= 55;
else return type(uint8).max;
}
return value;
}
/**
* @dev Escape special characters in JSON strings. This can be useful to prevent JSON injection in NFT metadata.
*
* WARNING: This function should only be used in double quoted JSON strings. Single quotes are not escaped.
*
* NOTE: This function escapes all unicode characters, and not just the ones in ranges defined in section 2.5 of
* RFC-4627 (U+0000 to U+001F, U+0022 and U+005C). ECMAScript's `JSON.parse` does recover escaped unicode
* characters that are not in this range, but other tooling may provide different results.
*/
function escapeJSON(string memory input) internal pure returns (string memory) {
bytes memory buffer = bytes(input);
bytes memory output = new bytes(2 * buffer.length); // worst case scenario
uint256 outputLength = 0;
for (uint256 i; i < buffer.length; ++i) {
bytes1 char = bytes1(_unsafeReadBytesOffset(buffer, i));
if (((SPECIAL_CHARS_LOOKUP & (1 << uint8(char))) != 0)) {
output[outputLength++] = "\\";
if (char == 0x08) output[outputLength++] = "b";
else if (char == 0x09) output[outputLength++] = "t";
else if (char == 0x0a) output[outputLength++] = "n";
else if (char == 0x0c) output[outputLength++] = "f";
else if (char == 0x0d) output[outputLength++] = "r";
else if (char == 0x5c) output[outputLength++] = "\\";
else if (char == 0x22) {
// solhint-disable-next-line quotes
output[outputLength++] = '"';
}
} else {
output[outputLength++] = char;
}
}
// write the actual length and deallocate unused memory
assembly ("memory-safe") {
mstore(output, outputLength)
mstore(0x40, add(output, shl(5, shr(5, add(outputLength, 63)))))
}
return string(output);
}
/**
* @dev Reads a bytes32 from a bytes array without bounds checking.
*
* NOTE: making this function internal would mean it could be used with memory unsafe offset, and marking the
* assembly block as such would prevent some optimizations.
*/
function _unsafeReadBytesOffset(bytes memory buffer, uint256 offset) private pure returns (bytes32 value) {
// This is not memory safe in the general case, but all calls to this private function are within bounds.
assembly ("memory-safe") {
value := mload(add(add(buffer, 0x20), offset))
}
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/utils/PausableUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "../libraries/Constants.sol";
import "../libraries/Errors.sol" ;
/**
* @title AccessControl
* @dev Role-based access control system for the Cross-Chain NFT Trading Platform
* @author Blocklabs Studio
*/
contract AccessControl is
Initializable,
AccessControlUpgradeable,
PausableUpgradeable,
ReentrancyGuardUpgradeable
{
// ============ EVENTS ============
/**
* @dev Emitted when emergency pause is activated
* @param admin The admin who activated the pause
* @param timestamp The timestamp of activation
*/
event EmergencyPauseActivated(address indexed admin, uint256 timestamp);
/**
* @dev Emitted when emergency pause is deactivated
* @param admin The admin who deactivated the pause
* @param timestamp The timestamp of deactivation
*/
event EmergencyPauseDeactivated(address indexed admin, uint256 timestamp);
/**
* @dev Emitted when a role is granted with additional context
* @param role The role that was granted
* @param account The account that received the role
* @param sender The account that granted the role
* @param timestamp The timestamp of the grant
*/
event RoleGrantedWithContext(
bytes32 indexed role,
address indexed account,
address indexed sender,
uint256 timestamp
);
/**
* @dev Emitted when a role is revoked with additional context
* @param role The role that was revoked
* @param account The account that lost the role
* @param sender The account that revoked the role
* @param timestamp The timestamp of the revocation
*/
event RoleRevokedWithContext(
bytes32 indexed role,
address indexed account,
address indexed sender,
uint256 timestamp
);
// ============ STATE VARIABLES ============
/// @dev Mapping to track role assignment timestamps
mapping(bytes32 => mapping(address => uint256)) public roleAssignmentTimestamps;
/// @dev Mapping to track emergency pause history
mapping(uint256 => bool) public emergencyPauseHistory;
/// @dev Counter for emergency pause events
uint256 public emergencyPauseCount;
/// @dev Timestamp of contract deployment
uint256 public deploymentTimestamp;
/// @dev Mapping to track role member counts
mapping(bytes32 => uint256) private _roleMemberCounts;
/// @dev Mapping to track if an account has a specific role (for counting)
mapping(bytes32 => mapping(address => bool)) private _roleMembers;
// ============ MODIFIERS ============
/**
* @dev Modifier to check if caller has admin role
*/
modifier onlyAdmin() {
if (!hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.ADMIN_ROLE);
}
_;
}
/**
* @dev Modifier to check if caller has project admin role
*/
modifier onlyProjectAdmin() {
if (!hasRole(Constants.PROJECT_ADMIN_ROLE, msg.sender) &&
!hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.PROJECT_ADMIN_ROLE);
}
_;
}
/**
* @dev Modifier to check if caller has fee manager role
*/
modifier onlyFeeManager() {
if (!hasRole(Constants.FEE_MANAGER_ROLE, msg.sender) &&
!hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.FEE_MANAGER_ROLE);
}
_;
}
/**
* @dev Modifier to check if caller has emergency role
*/
modifier onlyEmergency() {
if (!hasRole(Constants.EMERGENCY_ROLE, msg.sender) &&
!hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.EMERGENCY_ROLE);
}
_;
}
/**
* @dev Modifier to check if caller has upgrader role
*/
modifier onlyUpgrader() {
if (!hasRole(Constants.UPGRADER_ROLE, msg.sender) &&
!hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.UPGRADER_ROLE);
}
_;
}
/**
* @dev Modifier to ensure contract is not paused
*/
modifier whenNotPausedCustom() {
if (paused()) {
revert CustomErrors.ContractPaused();
}
_;
}
// ============ INITIALIZATION ============
/**
* @dev Initializes the AccessControl contract
* @param initialAdmin The initial admin address
*/
function initialize(address initialAdmin) public initializer {
if (initialAdmin == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
__AccessControl_init();
__Pausable_init();
__ReentrancyGuard_init();
// Set up role hierarchy
_setRoleAdmin(Constants.ADMIN_ROLE, Constants.ADMIN_ROLE);
_setRoleAdmin(Constants.PROJECT_ADMIN_ROLE, Constants.ADMIN_ROLE);
_setRoleAdmin(Constants.FEE_MANAGER_ROLE, Constants.ADMIN_ROLE);
_setRoleAdmin(Constants.EMERGENCY_ROLE, Constants.ADMIN_ROLE);
_setRoleAdmin(Constants.UPGRADER_ROLE, Constants.ADMIN_ROLE);
// Grant initial admin role
_grantRoleWithTracking(Constants.ADMIN_ROLE, initialAdmin);
// Set deployment timestamp
deploymentTimestamp = block.timestamp;
}
// ============ ROLE MANAGEMENT FUNCTIONS ============
/**
* @dev Grants a role to an account with additional validation
* @param role The role to grant
* @param account The account to grant the role to
*/
function grantRoleWithValidation(bytes32 role, address account)
external
onlyAdmin
nonReentrant
{
if (account == address(0)) {
revert CustomErrors.InvalidRoleRecipient(account);
}
// Additional validation for sensitive roles
if (role == Constants.ADMIN_ROLE && account == msg.sender) {
revert CustomErrors.RoleOperationFailed(role, account);
}
_grantRoleWithTracking(role, account);
roleAssignmentTimestamps[role][account] = block.timestamp;
emit RoleGrantedWithContext(role, account, msg.sender, block.timestamp);
}
/**
* @dev Revokes a role from an account with additional validation
* @param role The role to revoke
* @param account The account to revoke the role from
*/
function revokeRoleWithValidation(bytes32 role, address account)
external
onlyAdmin
nonReentrant
{
// Prevent revoking admin role from the last admin
if (role == Constants.ADMIN_ROLE) {
uint256 adminCount = _roleMemberCounts[Constants.ADMIN_ROLE];
if (adminCount <= 1) {
revert CustomErrors.RoleOperationFailed(role, account);
}
}
_revokeRoleWithTracking(role, account);
roleAssignmentTimestamps[role][account] = 0;
emit RoleRevokedWithContext(role, account, msg.sender, block.timestamp);
}
/**
* @dev Batch grants multiple roles to multiple accounts
* @param roles Array of roles to grant
* @param accounts Array of accounts to grant roles to
*/
function batchGrantRoles(bytes32[] calldata roles, address[] calldata accounts)
external
onlyAdmin
nonReentrant
{
if (roles.length != accounts.length) {
revert CustomErrors.ArrayLengthMismatch(roles.length, accounts.length);
}
if (roles.length == 0) {
revert CustomErrors.EmptyArray();
}
for (uint256 i = 0; i < roles.length; i++) {
if (accounts[i] == address(0)) {
revert CustomErrors.InvalidRoleRecipient(accounts[i]);
}
_grantRoleWithTracking(roles[i], accounts[i]);
roleAssignmentTimestamps[roles[i]][accounts[i]] = block.timestamp;
emit RoleGrantedWithContext(roles[i], accounts[i], msg.sender, block.timestamp);
}
}
/**
* @dev Batch revokes multiple roles from multiple accounts
* @param roles Array of roles to revoke
* @param accounts Array of accounts to revoke roles from
*/
function batchRevokeRoles(bytes32[] calldata roles, address[] calldata accounts)
external
onlyAdmin
nonReentrant
{
if (roles.length != accounts.length) {
revert CustomErrors.ArrayLengthMismatch(roles.length, accounts.length);
}
if (roles.length == 0) {
revert CustomErrors.EmptyArray();
}
for (uint256 i = 0; i < roles.length; i++) {
// Check admin role constraint
if (roles[i] == Constants.ADMIN_ROLE) {
uint256 adminCount = _roleMemberCounts[Constants.ADMIN_ROLE];
if (adminCount <= 1) {
revert CustomErrors.RoleOperationFailed(roles[i], accounts[i]);
}
}
_revokeRoleWithTracking(roles[i], accounts[i]);
roleAssignmentTimestamps[roles[i]][accounts[i]] = 0;
emit RoleRevokedWithContext(roles[i], accounts[i], msg.sender, block.timestamp);
}
}
// ============ EMERGENCY FUNCTIONS ============
/**
* @dev Activates emergency pause
*/
function emergencyPause() external onlyEmergency {
_pause();
emergencyPauseCount++;
emergencyPauseHistory[emergencyPauseCount] = true;
emit EmergencyPauseActivated(msg.sender, block.timestamp);
}
/**
* @dev Deactivates emergency pause
*/
function emergencyUnpause() external onlyAdmin {
_unpause();
emit EmergencyPauseDeactivated(msg.sender, block.timestamp);
}
// ============ VIEW FUNCTIONS ============
/**
* @dev Gets the timestamp when a role was assigned to an account
* @param role The role to check
* @param account The account to check
* @return timestamp The assignment timestamp (0 if not assigned)
*/
function getRoleAssignmentTimestamp(bytes32 role, address account)
external
view
returns (uint256 timestamp)
{
return roleAssignmentTimestamps[role][account];
}
/**
* @dev Checks if an account has any admin privileges
* @param account The account to check
* @return hasAdminPrivileges Whether the account has admin privileges
*/
function hasAdminPrivileges(address account) external view returns (bool) {
return hasRole(Constants.ADMIN_ROLE, account) ||
hasRole(Constants.PROJECT_ADMIN_ROLE, account) ||
hasRole(Constants.FEE_MANAGER_ROLE, account) ||
hasRole(Constants.EMERGENCY_ROLE, account) ||
hasRole(Constants.UPGRADER_ROLE, account);
}
/**
* @dev Gets all roles assigned to an account
* @param account The account to check
* @return roles Array of roles assigned to the account
*/
function getAccountRoles(address account) external view returns (bytes32[] memory roles) {
bytes32[] memory allRoles = new bytes32[](5);
allRoles[0] = Constants.ADMIN_ROLE;
allRoles[1] = Constants.PROJECT_ADMIN_ROLE;
allRoles[2] = Constants.FEE_MANAGER_ROLE;
allRoles[3] = Constants.EMERGENCY_ROLE;
allRoles[4] = Constants.UPGRADER_ROLE;
uint256 roleCount = 0;
for (uint256 i = 0; i < allRoles.length; i++) {
if (hasRole(allRoles[i], account)) {
roleCount++;
}
}
bytes32[] memory accountRoles = new bytes32[](roleCount);
uint256 index = 0;
for (uint256 i = 0; i < allRoles.length; i++) {
if (hasRole(allRoles[i], account)) {
accountRoles[index] = allRoles[i];
index++;
}
}
return accountRoles;
}
/**
* @dev Gets contract statistics
* @return totalRoleAssignments Total number of role assignments
* @return totalEmergencyPauses Total number of emergency pauses
* @return contractAge Age of the contract in seconds
*/
function getContractStats()
external
view
returns (
uint256 totalRoleAssignments,
uint256 totalEmergencyPauses,
uint256 contractAge
)
{
// Calculate total role assignments
totalRoleAssignments = _roleMemberCounts[Constants.ADMIN_ROLE] +
_roleMemberCounts[Constants.PROJECT_ADMIN_ROLE] +
_roleMemberCounts[Constants.FEE_MANAGER_ROLE] +
_roleMemberCounts[Constants.EMERGENCY_ROLE] +
_roleMemberCounts[Constants.UPGRADER_ROLE];
totalEmergencyPauses = emergencyPauseCount;
contractAge = block.timestamp - deploymentTimestamp;
}
/**
* @dev Checks if the contract is in a healthy state
* @return isHealthy Whether the contract is healthy
* @return issues Array of health issues (empty if healthy)
*/
function checkContractHealth()
external
view
returns (bool isHealthy, string[] memory issues)
{
string[] memory healthIssues = new string[](10);
uint256 issueCount = 0;
// Check if there's at least one admin
if (_roleMemberCounts[Constants.ADMIN_ROLE] == 0) {
healthIssues[issueCount] = "No admin accounts";
issueCount++;
}
// Check if contract is paused for too long
if (paused() && emergencyPauseCount > 5) {
healthIssues[issueCount] = "Too many emergency pauses";
issueCount++;
}
// Create result array with actual issues
string[] memory actualIssues = new string[](issueCount);
for (uint256 i = 0; i < issueCount; i++) {
actualIssues[i] = healthIssues[i];
}
return (issueCount == 0, actualIssues);
}
// ============ INTERNAL FUNCTIONS ============
/**
* @dev Internal function to grant role with tracking
*/
function _grantRoleWithTracking(bytes32 role, address account) internal {
bool hadRole = hasRole(role, account);
_grantRole(role, account);
// Update role member tracking
if (!hadRole) {
_roleMembers[role][account] = true;
_roleMemberCounts[role]++;
}
}
/**
* @dev Internal function to revoke role with tracking
*/
function _revokeRoleWithTracking(bytes32 role, address account) internal {
bool hadRole = hasRole(role, account);
_revokeRole(role, account);
// Update role member tracking
if (hadRole) {
_roleMembers[role][account] = false;
if (_roleMemberCounts[role] > 0) {
_roleMemberCounts[role]--;
}
}
}
/**
* @dev Gets the number of accounts that have a specific role
* @param role The role to count
* @return count The number of accounts with the role
*/
function getRoleMemberCount(bytes32 role) public view returns (uint256 count) {
return _roleMemberCounts[role];
}
// ============ UPGRADE FUNCTIONS ============
/**
* @dev Authorizes contract upgrades (only upgraders can authorize)
* @param newImplementation The new implementation address
*/
function _authorizeUpgrade(address newImplementation) internal view onlyUpgrader {
// Additional upgrade validation can be added here
if (newImplementation == address(0)) {
revert CustomErrors.InvalidUpgradeImplementation(newImplementation);
}
}
/**
* @dev Returns the version of the contract
* @return version The contract version
*/
function version() external pure returns (string memory) {
return "1.0.0";
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
import "../interfaces/ICrossChainBridge.sol";
import "../libraries/DataStructures.sol";
import "../libraries/Constants.sol";
import "../libraries/Errors.sol";
import "../libraries/CrossChainLibrary.sol";
import "../core/AccessControl.sol";
/**
* @title CrossChainBridge
* @dev LayerZero V2 integration for cross-chain messaging
* @author Blocklabs Studio
*/
contract CrossChainBridge is
Initializable,
ReentrancyGuardUpgradeable,
ICrossChainBridge
{
// ============ STATE VARIABLES ============
/// @dev Reference to the AccessControl contract
AccessControl public accessControl;
/// @dev LayerZero endpoints per chain
mapping(uint256 => address) private _layerZeroEndpoints;
/// @dev Trusted remote contracts per chain
mapping(uint256 => address) private _trustedRemotes;
/// @dev Default gas limits per chain
mapping(uint256 => uint256) private _defaultGasLimits;
/// @dev Chain enabled status
mapping(uint256 => bool) private _chainEnabled;
/// @dev Message status tracking
mapping(bytes32 => MessageStatus) private _messageStatus;
/// @dev Message retry tracking
mapping(bytes32 => uint256) private _messageRetryCount;
/// @dev Message last attempt timestamp
mapping(bytes32 => uint256) private _messageLastAttempt;
/// @dev Processed message hashes
mapping(bytes32 => bool) private _processedMessages;
/// @dev Supported chain IDs
uint256[] private _supportedChains;
/// @dev Bridge statistics
uint256 public totalMessagesSent;
uint256 public totalMessagesReceived;
uint256 public totalGasUsed;
/// @dev Emergency pause status
bool private _emergencyPaused;
// ============ STRUCTS ============
struct MessageStatus {
uint8 status; // 0=pending, 1=delivered, 2=failed
uint256 retryCount; // Number of retry attempts
uint256 lastAttempt; // Timestamp of last attempt
}
// ============ ADDITIONAL EVENTS ============
/**
* @dev Emitted when emergency pause status changes
* @param paused Whether the bridge is paused
* @param pausedBy The address that changed the pause status
*/
event EmergencyPauseStatusChanged(
bool paused,
address indexed pausedBy
);
// ============ MODIFIERS ============
/**
* @dev Modifier to ensure contract is not paused
*/
modifier whenNotPaused() {
if (accessControl.paused() || _emergencyPaused) {
revert CustomErrors.ContractPaused();
}
_;
}
/**
* @dev Modifier to check if caller has admin role
*/
modifier onlyAdmin() {
if (!accessControl.hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.ADMIN_ROLE);
}
_;
}
/**
* @dev Modifier to validate chain is supported
*/
modifier validChain(uint256 chainId) {
if (!_chainEnabled[chainId]) {
revert CustomErrors.UnsupportedChainId(chainId);
}
_;
}
// ============ INITIALIZATION ============
/**
* @dev Initializes the CrossChainBridge contract
* @param _accessControl Address of the AccessControl contract
*/
function initialize(address _accessControl) public initializer {
if (_accessControl == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
__ReentrancyGuard_init();
accessControl = AccessControl(_accessControl);
// Initialize supported chains
_initializeSupportedChains();
}
// ============ CORE FUNCTIONS ============
/**
* @dev Sends a cross-chain message via LayerZero
* @param destinationChain Target chain ID
* @param payload Message payload to send
* @param gasLimit Gas limit for execution on destination
* @return messageHash Hash of the sent message
*/
function sendMessage(
uint256 destinationChain,
bytes calldata payload,
uint256 gasLimit
) external payable override nonReentrant whenNotPaused validChain(destinationChain) returns (bytes32 messageHash) {
if (payload.length == 0) {
revert CustomErrors.EmptyArray();
}
if (payload.length > Constants.MAX_LZ_PAYLOAD_SIZE) {
revert CustomErrors.ValueOutOfRange(payload.length, 1, Constants.MAX_LZ_PAYLOAD_SIZE);
}
if (gasLimit < Constants.MIN_GAS_LIMIT || gasLimit > Constants.MAX_GAS_LIMIT) {
revert CustomErrors.InsufficientGasLimit(gasLimit, Constants.MIN_GAS_LIMIT);
}
// Generate message hash
messageHash = keccak256(abi.encodePacked(
block.chainid,
destinationChain,
payload,
block.timestamp,
msg.sender
));
// Estimate gas cost
uint256 estimatedGas = estimateGas(destinationChain, payload);
if (msg.value < estimatedGas) {
revert CustomErrors.InsufficientCrossChainFee(msg.value, estimatedGas);
}
// Initialize message status
_messageStatus[messageHash] = MessageStatus({
status: 0, // pending
retryCount: 0,
lastAttempt: block.timestamp
});
// Send message through LayerZero (simplified implementation)
uint256 gasUsed = _sendLayerZeroMessage(destinationChain, payload, gasLimit);
totalMessagesSent++;
totalGasUsed += gasUsed;
emit MessageSent(destinationChain, messageHash, gasLimit, gasUsed);
return messageHash;
}
/**
* @dev Receives and processes a cross-chain message
* @param sourceChain Source chain ID
* @param payload Message payload received
* @return success Whether message processing was successful
*/
function receiveMessage(
uint256 sourceChain,
bytes calldata payload
) external override nonReentrant whenNotPaused returns (bool success) {
// Validate source chain
if (!_chainEnabled[sourceChain]) {
revert CustomErrors.UnsupportedChainId(sourceChain);
}
// Generate message hash
bytes32 messageHash = keccak256(abi.encodePacked(sourceChain, payload, block.timestamp));
// Check if message already processed
if (_processedMessages[messageHash]) {
revert CustomErrors.DuplicateEntry(messageHash);
}
// Mark as processed
_processedMessages[messageHash] = true;
// Process the message
success = _processReceivedMessage(sourceChain, payload);
// Update statistics
totalMessagesReceived++;
emit MessageReceived(sourceChain, messageHash, success);
return success;
}
/**
* @dev Estimates gas cost for cross-chain message
* @param destinationChain Target chain ID
* @param payload Message payload
* @return gasEstimate Estimated gas cost in native token
*/
function estimateGas(
uint256 destinationChain,
bytes calldata payload
) public view override validChain(destinationChain) returns (uint256 gasEstimate) {
// Base gas cost
uint256 baseGas = _defaultGasLimits[destinationChain];
if (baseGas == 0) {
baseGas = Constants.DEFAULT_GAS_LIMIT;
}
// Add payload processing cost
uint256 payloadGas = payload.length * 100; // 100 gas per byte
// Add LayerZero overhead
uint256 layerZeroGas = Constants.LZ_GAS_BUFFER;
// Calculate total with buffer
gasEstimate = baseGas + payloadGas + layerZeroGas;
gasEstimate += (gasEstimate * Constants.GAS_BUFFER_PERCENT) / Constants.BASIS_POINTS;
return gasEstimate;
}
/**
* @dev Retries a failed cross-chain message
* @param messageHash Hash of the message to retry
* @param newGasLimit New gas limit for retry
*/
function retryMessage(
bytes32 messageHash,
uint256 newGasLimit
) external payable override nonReentrant whenNotPaused {
MessageStatus storage status = _messageStatus[messageHash];
if (status.status != 2) { // Not failed
revert CustomErrors.InvalidOfferStatus(0, status.status, 2);
}
if (status.retryCount >= Constants.LZ_RETRY_LIMIT) {
revert CustomErrors.ValueOutOfRange(status.retryCount, 0, Constants.LZ_RETRY_LIMIT);
}
// Calculate retry delay
uint256 retryDelay = CrossChainLibrary.calculateRetryDelay(status.retryCount + 1);
if (block.timestamp < status.lastAttempt + retryDelay) {
revert CustomErrors.OperationTimeout(status.lastAttempt + retryDelay, block.timestamp);
}
// Update retry tracking
status.retryCount++;
status.lastAttempt = block.timestamp;
status.status = 0; // Reset to pending
emit MessageRetry(messageHash, status.retryCount);
}
// ============ CONFIGURATION FUNCTIONS ============
/**
* @dev Sets LayerZero endpoint for a specific chain
* @param chainId Chain ID
* @param endpoint LayerZero endpoint address
*/
function setLayerZeroEndpoint(uint256 chainId, address endpoint)
external
override
onlyAdmin
nonReentrant
{
if (endpoint == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
address oldEndpoint = _layerZeroEndpoints[chainId];
_layerZeroEndpoints[chainId] = endpoint;
emit EndpointUpdated(chainId, oldEndpoint, endpoint);
}
/**
* @dev Sets trusted remote for cross-chain communication
* @param chainId Remote chain ID
* @param remoteAddress Trusted remote contract address
*/
function setTrustedRemote(uint256 chainId, address remoteAddress)
external
override
onlyAdmin
nonReentrant
{
if (remoteAddress == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_trustedRemotes[chainId] = remoteAddress;
}
/**
* @dev Sets default gas limit for a destination chain
* @param chainId Destination chain ID
* @param gasLimit Default gas limit
*/
function setDefaultGasLimit(uint256 chainId, uint256 gasLimit)
external
override
onlyAdmin
nonReentrant
{
if (gasLimit < Constants.MIN_GAS_LIMIT || gasLimit > Constants.MAX_GAS_LIMIT) {
revert CustomErrors.InsufficientGasLimit(gasLimit, Constants.MIN_GAS_LIMIT);
}
_defaultGasLimits[chainId] = gasLimit;
}
/**
* @dev Enables or disables cross-chain communication for a chain
* @param chainId Chain ID
* @param enabled Whether to enable communication
*/
function setChainEnabled(uint256 chainId, bool enabled)
external
override
onlyAdmin
nonReentrant
{
bool wasEnabled = _chainEnabled[chainId];
_chainEnabled[chainId] = enabled;
// Add to supported chains if newly enabled
if (enabled && !wasEnabled) {
_supportedChains.push(chainId);
}
// Remove from supported chains if disabled
if (!enabled && wasEnabled) {
_removeSupportedChain(chainId);
}
}
// ============ BATCH OPERATIONS ============
/**
* @dev Sends multiple cross-chain messages in batch
* @param destinations Array of destination chain IDs
* @param payloads Array of message payloads
* @param gasLimits Array of gas limits
* @return messageHashes Array of message hashes
*/
function sendBatchMessages(
uint256[] calldata destinations,
bytes[] calldata payloads,
uint256[] calldata gasLimits
) external payable override nonReentrant whenNotPaused returns (bytes32[] memory messageHashes) {
if (destinations.length != payloads.length || destinations.length != gasLimits.length) {
revert CustomErrors.ArrayLengthMismatch(destinations.length, payloads.length);
}
if (destinations.length == 0) {
revert CustomErrors.EmptyArray();
}
if (destinations.length > Constants.MAX_BATCH_SIZE) {
revert CustomErrors.TooManyAssets(destinations.length, Constants.MAX_BATCH_SIZE);
}
messageHashes = new bytes32[](destinations.length);
for (uint256 i = 0; i < destinations.length; i++) {
messageHashes[i] = this.sendMessage{value: msg.value / destinations.length}(destinations[i], payloads[i], gasLimits[i]);
}
return messageHashes;
}
/**
* @dev Retries multiple failed messages in batch
* @param messageHashes Array of message hashes to retry
* @param gasLimits Array of new gas limits
*/
function retryBatchMessages(
bytes32[] calldata messageHashes,
uint256[] calldata gasLimits
) external payable override nonReentrant whenNotPaused {
if (messageHashes.length != gasLimits.length) {
revert CustomErrors.ArrayLengthMismatch(messageHashes.length, gasLimits.length);
}
if (messageHashes.length == 0) {
revert CustomErrors.EmptyArray();
}
for (uint256 i = 0; i < messageHashes.length; i++) {
this.retryMessage{value: msg.value / messageHashes.length}(messageHashes[i], gasLimits[i]);
}
}
// ============ VIEW FUNCTIONS ============
/**
* @dev Gets LayerZero endpoint for a specific chain
* @param chainId Chain ID
* @return endpoint LayerZero endpoint address
*/
function getLayerZeroEndpoint(uint256 chainId)
external
view
override
returns (address endpoint)
{
return _layerZeroEndpoints[chainId];
}
/**
* @dev Gets trusted remote address for a chain
* @param chainId Remote chain ID
* @return remoteAddress Trusted remote contract address
*/
function getTrustedRemote(uint256 chainId)
external
view
override
returns (address remoteAddress)
{
return _trustedRemotes[chainId];
}
/**
* @dev Gets default gas limit for a destination chain
* @param chainId Destination chain ID
* @return gasLimit Default gas limit
*/
function getDefaultGasLimit(uint256 chainId)
external
view
override
returns (uint256 gasLimit)
{
return _defaultGasLimits[chainId];
}
/**
* @dev Checks if cross-chain communication is enabled for a chain
* @param chainId Chain ID
* @return enabled Whether communication is enabled
*/
function isChainEnabled(uint256 chainId)
external
view
override
returns (bool enabled)
{
return _chainEnabled[chainId];
}
/**
* @dev Gets message status and details
* @param messageHash Hash of the message
* @return status Message status (0=pending, 1=delivered, 2=failed)
* @return retryCount Number of retry attempts
* @return lastAttempt Timestamp of last attempt
*/
function getMessageStatus(bytes32 messageHash)
external
view
override
returns (uint8 status, uint256 retryCount, uint256 lastAttempt)
{
MessageStatus memory msgStatus = _messageStatus[messageHash];
return (msgStatus.status, msgStatus.retryCount, msgStatus.lastAttempt);
}
/**
* @dev Gets all supported chain IDs
* @return chainIds Array of supported chain IDs
*/
function getSupportedChains()
external
view
override
returns (uint256[] memory chainIds)
{
return _supportedChains;
}
/**
* @dev Checks if a message hash has been processed
* @param messageHash Hash of the message
* @return processed Whether the message has been processed
*/
function isMessageProcessed(bytes32 messageHash)
external
view
override
returns (bool processed)
{
return _processedMessages[messageHash];
}
/**
* @dev Gets cross-chain bridge statistics
* @return totalMessagesSentCount Total messages sent
* @return totalMessagesReceivedCount Total messages received
* @return totalGasUsedAmount Total gas used for cross-chain operations
*/
function getBridgeStats()
external
view
override
returns (uint256 totalMessagesSentCount, uint256 totalMessagesReceivedCount, uint256 totalGasUsedAmount)
{
return (totalMessagesSent, totalMessagesReceived, totalGasUsed);
}
// ============ EMERGENCY FUNCTIONS ============
/**
* @dev Emergency pause of cross-chain operations
*/
function emergencyPause() external override onlyAdmin {
_emergencyPaused = true;
emit EmergencyPauseStatusChanged(true, msg.sender);
}
/**
* @dev Resume cross-chain operations after emergency pause
*/
function emergencyUnpause() external override onlyAdmin {
_emergencyPaused = false;
emit EmergencyPauseStatusChanged(false, msg.sender);
}
/**
* @dev Emergency withdrawal of stuck native tokens
* @param recipient Address to receive the tokens
* @param amount Amount to withdraw
*/
function emergencyWithdraw(address recipient, uint256 amount)
external
override
onlyAdmin
nonReentrant
{
if (recipient == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
if (amount > address(this).balance) {
revert CustomErrors.InsufficientEscrowBalance(address(0), 0, amount, address(this).balance);
}
(bool success, ) = payable(recipient).call{value: amount}("");
if (!success) {
revert CustomErrors.FeePaymentFailed(recipient, amount);
}
}
// ============ INTERNAL FUNCTIONS ============
/**
* @dev Initializes supported chains with default configurations
*/
function _initializeSupportedChains() internal {
// Initialize supported chains including ApeChain
uint256[] memory chains = new uint256[](6);
chains[0] = Constants.ETHEREUM_CHAIN_ID;
chains[1] = Constants.ARBITRUM_CHAIN_ID;
chains[2] = Constants.POLYGON_CHAIN_ID;
chains[3] = Constants.OPTIMISM_CHAIN_ID;
chains[4] = Constants.BASE_CHAIN_ID;
chains[5] = block.chainid; // Current chain (including ApeChain)
for (uint256 i = 0; i < chains.length; i++) {
_chainEnabled[chains[i]] = true;
_defaultGasLimits[chains[i]] = Constants.DEFAULT_GAS_LIMIT;
_supportedChains.push(chains[i]);
}
}
/**
* @dev Sends message through LayerZero (simplified implementation)
* @param destinationChain Target chain ID
* @param payload Message payload
* @param gasLimit Gas limit for execution
* @return gasUsed Gas used for sending
*/
function _sendLayerZeroMessage(
uint256 destinationChain,
bytes calldata payload,
uint256 gasLimit
) internal returns (uint256 gasUsed) {
// This is a simplified implementation
// In production, this would integrate with actual LayerZero V2 endpoints
address endpoint = _layerZeroEndpoints[destinationChain];
if (endpoint == address(0)) {
revert CustomErrors.LayerZeroEndpointNotSet(destinationChain);
}
// Simulate gas usage
gasUsed = gasLimit + Constants.LZ_GAS_BUFFER;
// In production, this would call the LayerZero endpoint
// ILayerZeroEndpoint(endpoint).send{value: msg.value}(...)
return gasUsed;
}
/**
* @dev Processes received cross-chain message
* @param sourceChain Source chain ID
* @param payload Message payload
* @return success Whether processing was successful
*/
function _processReceivedMessage(
uint256 sourceChain,
bytes calldata payload
) internal returns (bool success) {
// Decode and process the message
try this._decodeAndExecuteMessage(sourceChain, payload) {
return true;
} catch {
return false;
}
}
/**
* @dev Decodes and executes cross-chain message
* @param sourceChain Source chain ID
* @param payload Message payload
*/
function _decodeAndExecuteMessage(
uint256 sourceChain,
bytes calldata payload
) external {
// This function would decode the message and execute the appropriate action
// For now, it's a placeholder
require(msg.sender == address(this), "Internal function");
// Decode message
DataStructures.CrossChainMessage memory message = CrossChainLibrary.decodeMessage(payload);
// Validate message
(bool valid, ) = CrossChainLibrary.validateMessage(message, 1 hours);
require(valid, "Invalid message");
// Process based on message type
// This would integrate with the main trading contract
}
/**
* @dev Removes a chain from supported chains array
* @param chainId Chain ID to remove
*/
function _removeSupportedChain(uint256 chainId) internal {
for (uint256 i = 0; i < _supportedChains.length; i++) {
if (_supportedChains[i] == chainId) {
_supportedChains[i] = _supportedChains[_supportedChains.length - 1];
_supportedChains.pop();
break;
}
}
}
/**
* @dev Returns the version of the contract
* @return version The contract version
*/
function version() external pure returns (string memory) {
return "1.0.0";
}
/**
* @dev Allows contract to receive native tokens
*/
receive() external payable {
// Allow contract to receive native tokens for cross-chain operations
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
import "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
import "@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.sol";
import "../interfaces/IEscrowTrading.sol";
import "../libraries/DataStructures.sol";
import "../libraries/Constants.sol";
import "../libraries/Errors.sol";
import "../libraries/AssetLibrary.sol";
import "../libraries/SignatureLibrary.sol";
import "../core/AccessControl.sol";
import "../core/FeeManager.sol";
import "../core/OfferManager.sol";
import "../security/AssetVerification.sol";
/**
* @title EscrowContract
* @dev Main escrow and trading logic for the Cross-Chain NFT Trading Platform
* @author Blocklabs Studio
*/
contract EscrowContract is
Initializable,
ReentrancyGuardUpgradeable,
IERC721Receiver,
IERC1155Receiver,
IEscrowTrading
{
// ============ STATE VARIABLES ============
/// @dev Reference to the AccessControl contract
AccessControl public accessControl;
/// @dev Reference to the FeeManager contract
FeeManager public feeManager;
/// @dev Reference to the OfferManager contract
OfferManager public offerManager;
/// @dev Reference to the AssetVerification contract
AssetVerification public assetVerification;
/// @dev Mapping from offer ID to escrowed assets for creator
mapping(uint256 => DataStructures.Asset[]) private _creatorEscrowedAssets;
/// @dev Mapping from offer ID to escrowed assets for acceptor
mapping(uint256 => DataStructures.Asset[]) private _acceptorEscrowedAssets;
/// @dev Mapping to track asset deposit status
mapping(uint256 => mapping(address => bool)) private _assetsDeposited;
/// @dev Mapping to track settlement status
mapping(uint256 => bool) private _settledOffers;
/// @dev Platform statistics
uint256 public totalTrades;
uint256 public totalVolume;
uint256 public totalFees;
/// @dev Emergency withdrawal tracking
mapping(uint256 => bool) private _emergencyWithdrawn;
/// @dev EIP-712 domain separator
bytes32 private _domainSeparator;
// ============ ADDITIONAL EVENTS ============
/**
* @dev Emitted when assets are withdrawn from escrow
* @param offerId The offer identifier
* @param withdrawer The address withdrawing assets
* @param assets The assets withdrawn
*/
event AssetsWithdrawn(
uint256 indexed offerId,
address indexed withdrawer,
DataStructures.Asset[] assets
);
/**
* @dev Emitted when a settlement fails and assets are returned
* @param offerId The offer identifier
* @param reason The failure reason
*/
event SettlementFailed(
uint256 indexed offerId,
string reason
);
/**
* @dev Emitted when emergency withdrawal occurs
* @param offerId The offer identifier
* @param recipient The recipient of withdrawn assets
* @param withdrawnBy The admin who performed the withdrawal
*/
event EmergencyWithdrawal(
uint256 indexed offerId,
address indexed recipient,
address indexed withdrawnBy
);
// ============ MODIFIERS ============
/**
* @dev Modifier to ensure contract is not paused
*/
modifier whenNotPaused() {
if (accessControl.paused()) {
revert CustomErrors.ContractPaused();
}
_;
}
/**
* @dev Modifier to check if caller has admin role
*/
modifier onlyAdmin() {
if (!accessControl.hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.ADMIN_ROLE);
}
_;
}
/**
* @dev Modifier to validate offer exists
*/
modifier validOffer(uint256 offerId) {
try offerManager.getOffer(offerId) returns (DataStructures.TradeOffer memory) {
// Offer exists
} catch {
revert CustomErrors.OfferNotFound(offerId);
}
_;
}
// ============ INITIALIZATION ============
/**
* @dev Initializes the EscrowContract
* @param _accessControl Address of the AccessControl contract
* @param _feeManager Address of the FeeManager contract
* @param _offerManager Address of the OfferManager contract
* @param _assetVerification Address of the AssetVerification contract
*/
function initialize(
address _accessControl,
address _feeManager,
address _offerManager,
address _assetVerification
) public initializer {
if (_accessControl == address(0) || _feeManager == address(0) ||
_offerManager == address(0) || _assetVerification == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
__ReentrancyGuard_init();
accessControl = AccessControl(_accessControl);
feeManager = FeeManager(payable(_feeManager));
offerManager = OfferManager(_offerManager);
assetVerification = AssetVerification(_assetVerification);
// Initialize EIP-712 domain separator
_domainSeparator = SignatureLibrary.buildDomainSeparator(address(this), block.chainid);
}
// ============ SAME-CHAIN TRADING FUNCTIONS ============
/**
* @dev Creates a new same-chain trading offer
* @param offer The trade offer details
* @return offerId The unique identifier for the created offer
*/
function createSameChainOffer(DataStructures.TradeOffer calldata offer)
external
payable
override
nonReentrant
whenNotPaused
returns (uint256 offerId)
{
// Validate offer is for same-chain
if (offer.settlementMode != DataStructures.SettlementMode.SAME_CHAIN) {
revert CustomErrors.InvalidOfferParameters("Must be same-chain settlement mode");
}
if (offer.destinationChainId != 0) {
revert CustomErrors.InvalidOfferParameters("Same-chain offers should not have destination chain");
}
// Validate native token amount - msg.value should be at least the required native amount
uint256 requiredNativeAmount = AssetLibrary.calculateNativeTokenAmount(offer.offeredAssets);
if (requiredNativeAmount > 0 && msg.value < requiredNativeAmount) {
revert CustomErrors.NativeAssetAmountMismatch(requiredNativeAmount, msg.value);
}
// Create the offer through OfferManager
offerId = offerManager.createOffer(offer);
// Automatically deposit creator's assets
_depositAssetsForOffer(offerId, offer.creator, offer.offeredAssets);
return offerId;
}
/**
* @dev Accepts a same-chain trading offer
* @param offerId The unique identifier of the offer to accept
*/
function acceptSameChainOffer(uint256 offerId)
external
payable
override
nonReentrant
whenNotPaused
validOffer(offerId)
{
DataStructures.TradeOffer memory offer = offerManager.getOffer(offerId);
// Validate same-chain offer
if (offer.settlementMode != DataStructures.SettlementMode.SAME_CHAIN) {
revert CustomErrors.InvalidOfferParameters("Not a same-chain offer");
}
// Validate acceptor can accept the offer
(bool canAccept, string memory reason) = offerManager.canAcceptOffer(offerId, msg.sender);
if (!canAccept) {
revert CustomErrors.UnauthorizedOfferAcceptance(offerId, msg.sender, offer.counterparty);
}
// Validate native token amount - msg.value should be at least the required native amount
uint256 requiredNativeAmount = AssetLibrary.calculateNativeTokenAmount(offer.requestedAssets);
if (requiredNativeAmount > 0 && msg.value < requiredNativeAmount) {
revert CustomErrors.NativeAssetAmountMismatch(requiredNativeAmount, msg.value);
}
// Accept the offer through OfferManager
offerManager.acceptOffer(offerId, msg.sender);
// Deposit acceptor's assets
_depositAssetsForOffer(offerId, msg.sender, offer.requestedAssets);
// Collect platform fee
uint256 tradeValue = _calculateTradeValue(offer.offeredAssets, offer.requestedAssets);
feeManager.collectFee{value: msg.value}(offerId, tradeValue, address(0));
// Execute atomic swap immediately for same-chain
_executeAtomicSwap(offerId, offer.creator, msg.sender);
emit OfferAccepted(offerId, msg.sender, block.timestamp);
}
// ============ CROSS-CHAIN TRADING FUNCTIONS ============
/**
* @dev Creates a new cross-chain trading offer
* @param offer The trade offer details
* @param destinationChain The target chain for cross-chain settlement
* @return offerId The unique identifier for the created offer
*/
function createCrossChainOffer(
DataStructures.TradeOffer calldata offer,
uint256 destinationChain
) external payable override nonReentrant whenNotPaused returns (uint256 offerId) {
// Validate cross-chain configuration
if (offer.settlementMode != DataStructures.SettlementMode.CROSS_CHAIN) {
revert CustomErrors.InvalidOfferParameters("Must be cross-chain settlement mode");
}
if (destinationChain == 0 || destinationChain == block.chainid) {
revert CustomErrors.InvalidOfferParameters("Invalid destination chain");
}
// Create modified offer with destination chain
DataStructures.TradeOffer memory crossChainOffer = offer;
crossChainOffer.destinationChainId = destinationChain;
// Create the offer through OfferManager
offerId = offerManager.createOffer(crossChainOffer);
// Deposit creator's assets
_depositAssetsForOffer(offerId, offer.creator, offer.offeredAssets);
return offerId;
}
/**
* @dev Accepts a cross-chain trading offer
* @param offerId The unique identifier of the offer to accept
*/
function acceptCrossChainOffer(uint256 offerId)
external
payable
override
nonReentrant
whenNotPaused
validOffer(offerId)
{
DataStructures.TradeOffer memory offer = offerManager.getOffer(offerId);
// Validate cross-chain offer
if (offer.settlementMode != DataStructures.SettlementMode.CROSS_CHAIN) {
revert CustomErrors.InvalidOfferParameters("Not a cross-chain offer");
}
// Validate acceptor can accept the offer
(bool canAccept, string memory reason) = offerManager.canAcceptOffer(offerId, msg.sender);
if (!canAccept) {
revert CustomErrors.UnauthorizedOfferAcceptance(offerId, msg.sender, offer.counterparty);
}
// Accept the offer through OfferManager
offerManager.acceptOffer(offerId, msg.sender);
// Deposit acceptor's assets
_depositAssetsForOffer(offerId, msg.sender, offer.requestedAssets);
// Collect platform fee
uint256 tradeValue = _calculateTradeValue(offer.offeredAssets, offer.requestedAssets);
feeManager.collectFee{value: msg.value}(offerId, tradeValue, address(0));
emit OfferAccepted(offerId, msg.sender, block.timestamp + Constants.CROSS_CHAIN_TIMEOUT);
}
/**
* @dev Initiates cross-chain trade settlement
* @param offerId The unique identifier of the offer
* @param destinationChain The target chain for settlement
*/
function initiateCrossChainTrade(uint256 offerId, uint256 destinationChain)
external
payable
override
nonReentrant
whenNotPaused
validOffer(offerId)
{
DataStructures.TradeOffer memory offer = offerManager.getOffer(offerId);
// Validate cross-chain settlement
if (offer.settlementMode != DataStructures.SettlementMode.CROSS_CHAIN) {
revert CustomErrors.InvalidOfferParameters("Not a cross-chain offer");
}
if (offer.status != DataStructures.OfferStatus.ACCEPTED) {
revert CustomErrors.InvalidOfferStatus(offerId, uint8(offer.status), uint8(DataStructures.OfferStatus.ACCEPTED));
}
// Check both parties have deposited assets
if (!_assetsDeposited[offerId][offer.creator] || !_assetsDeposited[offerId][msg.sender]) {
revert CustomErrors.ConditionNotMet("Assets not deposited by both parties");
}
// Note: Cross-chain bridge integration would be implemented here
// For now, we'll mark as ready for settlement
emit CrossChainMessageSent(offerId, destinationChain, keccak256(abi.encode(offerId, block.timestamp)));
}
/**
* @dev Completes cross-chain trade with proof
* @param offerId The unique identifier of the offer
* @param proof Cross-chain settlement proof
*/
function completeCrossChainTrade(uint256 offerId, bytes calldata proof)
external
override
nonReentrant
whenNotPaused
validOffer(offerId)
{
DataStructures.TradeOffer memory offer = offerManager.getOffer(offerId);
// Validate proof (simplified for now)
if (proof.length == 0) {
revert CustomErrors.InvalidOfferParameters("Invalid proof");
}
// Execute the cross-chain settlement
address acceptor = _getOfferAcceptor(offerId);
_executeAtomicSwap(offerId, offer.creator, acceptor);
emit CrossChainMessageReceived(offerId, offer.sourceChainId, keccak256(proof));
}
// ============ GENERAL OFFER MANAGEMENT ============
/**
* @dev Cancels an existing offer
* @param offerId The unique identifier of the offer to cancel
*/
function cancelOffer(uint256 offerId)
external
override
nonReentrant
whenNotPaused
validOffer(offerId)
{
DataStructures.TradeOffer memory offer = offerManager.getOffer(offerId);
// Cancel through OfferManager
offerManager.cancelOffer(offerId, msg.sender);
// Return escrowed assets to creator
if (_assetsDeposited[offerId][offer.creator]) {
_returnAssetsToUser(offerId, offer.creator, _creatorEscrowedAssets[offerId]);
}
emit OfferCancelled(offerId, offer.creator, block.timestamp);
}
/**
* @dev Creates a counter-offer for an existing offer
* @param offerId The unique identifier of the original offer
* @param newOffer The counter-offer details
* @return counterOfferId The unique identifier for the counter-offer
*/
function counterOffer(uint256 offerId, DataStructures.TradeOffer calldata newOffer)
external
payable
override
nonReentrant
whenNotPaused
validOffer(offerId)
returns (uint256 counterOfferId)
{
// Create counter-offer through OfferManager
counterOfferId = offerManager.createCounterOffer(offerId, newOffer);
// Deposit assets for counter-offer
_depositAssetsForOffer(counterOfferId, newOffer.creator, newOffer.offeredAssets);
return counterOfferId;
}
// ============ ASSET MANAGEMENT ============
/**
* @dev Deposits assets into escrow for an offer
* @param offerId The unique identifier of the offer
* @param assets Array of assets to deposit
*/
function depositAssets(uint256 offerId, DataStructures.Asset[] calldata assets)
external
payable
override
nonReentrant
whenNotPaused
validOffer(offerId)
{
_depositAssetsForOffer(offerId, msg.sender, assets);
}
/**
* @dev Withdraws assets from escrow (for cancelled/expired offers)
* @param offerId The unique identifier of the offer
*/
function withdrawAssets(uint256 offerId)
external
override
nonReentrant
whenNotPaused
validOffer(offerId)
{
DataStructures.TradeOffer memory offer = offerManager.getOffer(offerId);
// Only allow withdrawal for cancelled or expired offers
if (offer.status != DataStructures.OfferStatus.CANCELLED &&
offer.status != DataStructures.OfferStatus.EXPIRED) {
revert CustomErrors.InvalidOfferStatus(offerId, uint8(offer.status), uint8(DataStructures.OfferStatus.CANCELLED));
}
// Return assets to depositor
if (msg.sender == offer.creator && _assetsDeposited[offerId][offer.creator]) {
_returnAssetsToUser(offerId, msg.sender, _creatorEscrowedAssets[offerId]);
} else {
// Find acceptor and return their assets
address acceptor = _getOfferAcceptor(offerId);
if (msg.sender == acceptor && _assetsDeposited[offerId][acceptor]) {
_returnAssetsToUser(offerId, msg.sender, _acceptorEscrowedAssets[offerId]);
} else {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.ADMIN_ROLE);
}
}
}
/**
* @dev Emergency withdrawal of assets (admin only)
* @param offerId The unique identifier of the offer
* @param recipient Address to receive the assets
*/
function emergencyWithdrawAssets(uint256 offerId, address recipient)
external
override
onlyAdmin
nonReentrant
{
if (recipient == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
if (_emergencyWithdrawn[offerId]) {
revert CustomErrors.UpgradeAlreadyExecuted(offerId);
}
_emergencyWithdrawn[offerId] = true;
// Withdraw all escrowed assets for this offer
DataStructures.Asset[] storage creatorAssets = _creatorEscrowedAssets[offerId];
DataStructures.Asset[] storage acceptorAssets = _acceptorEscrowedAssets[offerId];
// Transfer creator assets
for (uint256 i = 0; i < creatorAssets.length; i++) {
AssetLibrary.transferAsset(creatorAssets[i], address(this), recipient);
}
// Transfer acceptor assets
for (uint256 i = 0; i < acceptorAssets.length; i++) {
AssetLibrary.transferAsset(acceptorAssets[i], address(this), recipient);
}
emit EmergencyWithdrawal(offerId, recipient, msg.sender);
}
// ============ BATCH OPERATIONS ============
/**
* @dev Creates multiple offers in a single transaction
* @param offers Array of trade offers to create
* @return offerIds Array of created offer identifiers
*/
function createBatchOffers(DataStructures.TradeOffer[] calldata offers)
external
payable
override
nonReentrant
whenNotPaused
returns (uint256[] memory offerIds)
{
if (offers.length == 0) {
revert CustomErrors.EmptyArray();
}
if (offers.length > Constants.MAX_BATCH_SIZE) {
revert CustomErrors.TooManyAssets(offers.length, Constants.MAX_BATCH_SIZE);
}
offerIds = new uint256[](offers.length);
for (uint256 i = 0; i < offers.length; i++) {
if (offers[i].settlementMode == DataStructures.SettlementMode.SAME_CHAIN) {
offerIds[i] = this.createSameChainOffer(offers[i]);
} else {
offerIds[i] = this.createCrossChainOffer(offers[i], offers[i].destinationChainId);
}
}
return offerIds;
}
/**
* @dev Accepts multiple offers in a single transaction
* @param offerIds Array of offer identifiers to accept
*/
function acceptBatchOffers(uint256[] calldata offerIds)
external
payable
override
nonReentrant
whenNotPaused
{
if (offerIds.length == 0) {
revert CustomErrors.EmptyArray();
}
if (offerIds.length > Constants.MAX_BATCH_SIZE) {
revert CustomErrors.TooManyAssets(offerIds.length, Constants.MAX_BATCH_SIZE);
}
for (uint256 i = 0; i < offerIds.length; i++) {
DataStructures.TradeOffer memory offer = offerManager.getOffer(offerIds[i]);
if (offer.settlementMode == DataStructures.SettlementMode.SAME_CHAIN) {
this.acceptSameChainOffer(offerIds[i]);
} else {
this.acceptCrossChainOffer(offerIds[i]);
}
}
}
/**
* @dev Cancels multiple offers in a single transaction
* @param offerIds Array of offer identifiers to cancel
*/
function cancelBatchOffers(uint256[] calldata offerIds)
external
override
nonReentrant
whenNotPaused
{
if (offerIds.length == 0) {
revert CustomErrors.EmptyArray();
}
for (uint256 i = 0; i < offerIds.length; i++) {
this.cancelOffer(offerIds[i]);
}
}
// ============ VIEW FUNCTIONS ============
/**
* @dev Gets complete offer details
* @param offerId The unique identifier of the offer
* @return offer The complete offer structure
*/
function getOffer(uint256 offerId)
external
view
override
returns (DataStructures.TradeOffer memory offer)
{
return offerManager.getOffer(offerId);
}
/**
* @dev Gets the current status of an offer
* @param offerId The unique identifier of the offer
* @return status The current offer status
*/
function getOfferStatus(uint256 offerId)
external
view
override
returns (DataStructures.OfferStatus status)
{
DataStructures.TradeOffer memory offer = offerManager.getOffer(offerId);
return offer.status;
}
/**
* @dev Gets all offers created by a specific user
* @param user The user address
* @return offerIds Array of offer identifiers
*/
function getUserOffers(address user)
external
view
override
returns (uint256[] memory offerIds)
{
return offerManager.getOffersByCreator(user);
}
/**
* @dev Gets all active same-chain offers
* @return offerIds Array of same-chain offer identifiers
*/
function getSameChainOffers()
external
view
override
returns (uint256[] memory offerIds)
{
uint256[] memory allOffers = offerManager.getActiveOffers();
uint256 sameChainCount = 0;
// Count same-chain offers
for (uint256 i = 0; i < allOffers.length; i++) {
DataStructures.TradeOffer memory offer = offerManager.getOffer(allOffers[i]);
if (offer.settlementMode == DataStructures.SettlementMode.SAME_CHAIN) {
sameChainCount++;
}
}
// Create result array
uint256[] memory sameChainOffers = new uint256[](sameChainCount);
uint256 index = 0;
for (uint256 i = 0; i < allOffers.length; i++) {
DataStructures.TradeOffer memory offer = offerManager.getOffer(allOffers[i]);
if (offer.settlementMode == DataStructures.SettlementMode.SAME_CHAIN) {
sameChainOffers[index] = allOffers[i];
index++;
}
}
return sameChainOffers;
}
/**
* @dev Gets all active cross-chain offers for a specific chain
* @param chainId The target chain ID
* @return offerIds Array of cross-chain offer identifiers
*/
function getCrossChainOffers(uint256 chainId)
external
view
override
returns (uint256[] memory offerIds)
{
uint256[] memory allOffers = offerManager.getActiveOffers();
uint256 crossChainCount = 0;
// Count cross-chain offers for the specified chain
for (uint256 i = 0; i < allOffers.length; i++) {
DataStructures.TradeOffer memory offer = offerManager.getOffer(allOffers[i]);
if (offer.settlementMode == DataStructures.SettlementMode.CROSS_CHAIN &&
offer.destinationChainId == chainId) {
crossChainCount++;
}
}
// Create result array
uint256[] memory crossChainOffers = new uint256[](crossChainCount);
uint256 index = 0;
for (uint256 i = 0; i < allOffers.length; i++) {
DataStructures.TradeOffer memory offer = offerManager.getOffer(allOffers[i]);
if (offer.settlementMode == DataStructures.SettlementMode.CROSS_CHAIN &&
offer.destinationChainId == chainId) {
crossChainOffers[index] = allOffers[i];
index++;
}
}
return crossChainOffers;
}
/**
* @dev Gets cross-chain settlement details (placeholder)
* @param offerId The unique identifier of the offer
* @return settlement The cross-chain settlement information
*/
function getCrossChainSettlement(uint256 offerId)
external
view
override
returns (DataStructures.CrossChainSettlement memory settlement)
{
// This would be implemented with actual cross-chain bridge integration
DataStructures.TradeOffer memory offer = offerManager.getOffer(offerId);
settlement.offerId = offerId;
settlement.sourceChain = offer.sourceChainId;
settlement.destinationChain = offer.destinationChainId;
settlement.state = DataStructures.SettlementState.PENDING;
settlement.timelock = block.timestamp + Constants.CROSS_CHAIN_TIMEOUT;
settlement.gasLimit = Constants.DEFAULT_GAS_LIMIT;
return settlement;
}
/**
* @dev Checks if an offer is valid and can be accepted
* @param offerId The unique identifier of the offer
* @return isValid Whether the offer is valid
* @return reason Reason if offer is invalid
*/
function isOfferValid(uint256 offerId)
external
view
override
returns (bool isValid, string memory reason)
{
try offerManager.getOffer(offerId) returns (DataStructures.TradeOffer memory offer) {
if (offer.status != DataStructures.OfferStatus.PENDING) {
return (false, "Offer is not pending");
}
if (block.timestamp > offer.expirationTime) {
return (false, "Offer has expired");
}
return (true, "");
} catch {
return (false, "Offer does not exist");
}
}
/**
* @dev Estimates gas cost for cross-chain operation (placeholder)
* @param destinationChain The target chain ID
* @param payload The message payload
* @return gasEstimate The estimated gas cost
*/
function estimateCrossChainGas(uint256 destinationChain, bytes calldata payload)
external
view
override
returns (uint256 gasEstimate)
{
// This would integrate with actual cross-chain bridge
return Constants.DEFAULT_GAS_LIMIT + (payload.length * 100);
}
/**
* @dev Gets the next available offer ID
* @return nextOfferId The next offer identifier
*/
function getNextOfferId()
external
view
override
returns (uint256 nextOfferId)
{
return offerManager.getNextOfferId();
}
/**
* @dev Gets total number of offers created
* @return totalOffers The total number of offers
*/
function getTotalOffers()
external
view
override
returns (uint256)
{
return offerManager.getTotalOffers();
}
/**
* @dev Gets platform statistics
* @return totalTradesCount Total completed trades
* @return totalVolumeAmount Total trading volume
* @return totalFeesAmount Total fees collected
*/
function getPlatformStats()
external
view
override
returns (uint256 totalTradesCount, uint256 totalVolumeAmount, uint256 totalFeesAmount)
{
return (totalTrades, totalVolume, totalFees);
}
// ============ INTERNAL FUNCTIONS ============
/**
* @dev Deposits assets for a specific offer
* @param offerId The offer identifier
* @param depositor The address depositing assets
* @param assets The assets to deposit
*/
function _depositAssetsForOffer(
uint256 offerId,
address depositor,
DataStructures.Asset[] memory assets
) internal {
// Verify assets and transfer to escrow
for (uint256 i = 0; i < assets.length; i++) {
// Verify asset ownership and approval
if (!AssetLibrary.verifyOwnership(assets[i], depositor)) {
revert CustomErrors.AssetOwnershipMismatch(
assets[i].tokenContract,
assets[i].tokenId,
depositor,
depositor
);
}
if (!AssetLibrary.verifyApproval(assets[i], depositor, address(this))) {
revert CustomErrors.AssetTransferNotApproved(
assets[i].tokenContract,
assets[i].tokenId,
depositor,
address(this)
);
}
// Transfer asset to escrow
AssetLibrary.transferAsset(assets[i], depositor, address(this));
}
// Store escrowed assets
DataStructures.TradeOffer memory offer = offerManager.getOffer(offerId);
if (depositor == offer.creator) {
for (uint256 i = 0; i < assets.length; i++) {
_creatorEscrowedAssets[offerId].push(assets[i]);
}
} else {
for (uint256 i = 0; i < assets.length; i++) {
_acceptorEscrowedAssets[offerId].push(assets[i]);
}
}
_assetsDeposited[offerId][depositor] = true;
emit AssetsDeposited(offerId, depositor, assets);
}
/**
* @dev Executes atomic swap of assets
* @param offerId The offer identifier
* @param creator The offer creator
* @param acceptor The offer acceptor
*/
function _executeAtomicSwap(uint256 offerId, address creator, address acceptor) internal {
if (_settledOffers[offerId]) {
revert CustomErrors.UpgradeAlreadyExecuted(offerId);
}
// Transfer creator's assets to acceptor
DataStructures.Asset[] storage creatorAssets = _creatorEscrowedAssets[offerId];
for (uint256 i = 0; i < creatorAssets.length; i++) {
AssetLibrary.transferAsset(creatorAssets[i], address(this), acceptor);
}
// Transfer acceptor's assets to creator
DataStructures.Asset[] storage acceptorAssets = _acceptorEscrowedAssets[offerId];
for (uint256 i = 0; i < acceptorAssets.length; i++) {
AssetLibrary.transferAsset(acceptorAssets[i], address(this), creator);
}
_settledOffers[offerId] = true;
totalTrades++;
emit AssetsSwapped(offerId, creator, acceptor, block.timestamp);
}
/**
* @dev Returns assets to a user
* @param offerId The offer identifier
* @param user The user to return assets to
* @param assets The assets to return
*/
function _returnAssetsToUser(
uint256 offerId,
address user,
DataStructures.Asset[] storage assets
) internal {
for (uint256 i = 0; i < assets.length; i++) {
AssetLibrary.transferAsset(assets[i], address(this), user);
}
_assetsDeposited[offerId][user] = false;
emit AssetsWithdrawn(offerId, user, assets);
}
/**
* @dev Calculates trade value for fee calculation
* @param offeredAssets Assets being offered
* @param requestedAssets Assets being requested
* @return value The calculated trade value
*/
function _calculateTradeValue(
DataStructures.Asset[] memory offeredAssets,
DataStructures.Asset[] memory requestedAssets
) internal pure returns (uint256 value) {
// Simplified calculation - in production, this would integrate with price oracles
return offeredAssets.length + requestedAssets.length;
}
/**
* @dev Gets the acceptor of an offer
* @param offerId The offer identifier
* @return acceptor The acceptor address
*/
function _getOfferAcceptor(uint256 offerId) internal view returns (address acceptor) {
// This is a simplified implementation
// In practice, you'd track acceptors more explicitly
DataStructures.TradeOffer memory offer = offerManager.getOffer(offerId);
return offer.counterparty; // Simplified
}
// ============ RECEIVER FUNCTIONS ============
/**
* @dev Handles the receipt of an NFT
*/
function onERC721Received(
address,
address,
uint256,
bytes calldata
) external pure override returns (bytes4) {
return IERC721Receiver.onERC721Received.selector;
}
/**
* @dev Handles the receipt of a single ERC1155 token type
*/
function onERC1155Received(
address,
address,
uint256,
uint256,
bytes calldata
) external pure override returns (bytes4) {
return IERC1155Receiver.onERC1155Received.selector;
}
/**
* @dev Handles the receipt of multiple ERC1155 token types
*/
function onERC1155BatchReceived(
address,
address,
uint256[] calldata,
uint256[] calldata,
bytes calldata
) external pure override returns (bytes4) {
return IERC1155Receiver.onERC1155BatchReceived.selector;
}
/**
* @dev Returns whether this contract supports the given interface
*/
function supportsInterface(bytes4 interfaceId) external pure override returns (bool) {
return interfaceId == type(IERC721Receiver).interfaceId ||
interfaceId == type(IERC1155Receiver).interfaceId ||
interfaceId == type(IERC165).interfaceId;
}
/**
* @dev Returns the version of the contract
* @return version The contract version
*/
function version() external pure returns (string memory) {
return "1.0.0";
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "../interfaces/IFeeManager.sol";
import "../libraries/DataStructures.sol";
import "../libraries/Constants.sol";
import "../libraries/Errors.sol";
import "./AccessControl.sol";
/**
* @title FeeManager
* @dev Platform fee management for the Cross-Chain NFT Trading Platform
* @author Blocklabs Studio
*/
contract FeeManager is
Initializable,
ReentrancyGuardUpgradeable,
IFeeManager
{
using SafeERC20 for IERC20;
// ============ STATE VARIABLES ============
/// @dev Reference to the AccessControl contract
AccessControl public accessControl;
/// @dev Fee configuration per chain
mapping(uint256 => DataStructures.FeeConfig) private _feeConfigs;
/// @dev Fee exemption list
mapping(address => bool) private _feeExemptions;
/// @dev Total fees collected per token
mapping(address => uint256) private _totalFeesCollected;
/// @dev Fee collection history per offer
mapping(uint256 => uint256) private _offerFees;
/// @dev Supported fee tokens per chain
mapping(uint256 => address[]) private _supportedFeeTokens;
/// @dev Fee collection statistics
uint256 public totalOffersProcessed;
uint256 public totalFeeVolume;
// ============ EVENTS ============
/**
* @dev Emitted when fee configuration is updated for a chain
* @param chainId The chain ID
* @param oldConfig The previous fee configuration
* @param newConfig The new fee configuration
* @param updatedBy The address that updated the configuration
*/
event FeeConfigUpdated(
uint256 indexed chainId,
DataStructures.FeeConfig oldConfig,
DataStructures.FeeConfig newConfig,
address indexed updatedBy
);
/**
* @dev Emitted when fee exemption status is updated
* @param account The account whose exemption status was updated
* @param exempt Whether the account is exempt from fees
* @param updatedBy The address that updated the exemption
*/
event FeeExemptionUpdated(
address indexed account,
bool exempt,
address indexed updatedBy
);
/**
* @dev Emitted when fees are collected
* @param offerId The offer ID associated with the fee
* @param token The token address (0x0 for native)
* @param amount The fee amount collected
* @param recipient The fee recipient
* @param payer The address that paid the fee
*/
event FeeCollected(
uint256 indexed offerId,
address indexed token,
uint256 amount,
address indexed recipient,
address payer
);
/**
* @dev Emitted when fees are withdrawn by admin
* @param token The token address (0x0 for native)
* @param amount The amount withdrawn
* @param recipient The withdrawal recipient
* @param withdrawnBy The admin who performed the withdrawal
*/
event FeesWithdrawn(
address indexed token,
uint256 amount,
address indexed recipient,
address indexed withdrawnBy
);
// ============ MODIFIERS ============
/**
* @dev Modifier to check if caller has fee manager role
*/
modifier onlyFeeManager() {
if (!accessControl.hasRole(Constants.FEE_MANAGER_ROLE, msg.sender) &&
!accessControl.hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.FEE_MANAGER_ROLE);
}
_;
}
/**
* @dev Modifier to check if caller has admin role
*/
modifier onlyAdmin() {
if (!accessControl.hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.ADMIN_ROLE);
}
_;
}
/**
* @dev Modifier to ensure contract is not paused
*/
modifier whenNotPaused() {
if (accessControl.paused()) {
revert CustomErrors.ContractPaused();
}
_;
}
// ============ INITIALIZATION ============
/**
* @dev Initializes the FeeManager contract
* @param _accessControl Address of the AccessControl contract
*/
function initialize(address _accessControl) public initializer {
if (_accessControl == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
__ReentrancyGuard_init();
accessControl = AccessControl(_accessControl);
// Initialize default fee configurations for supported chains
_initializeDefaultFeeConfigs();
}
// ============ CORE FUNCTIONS ============
/**
* @dev Calculates the fee for a trade
* @param chainId The chain ID
* @param tradeValue The value of the trade
* @return fee The calculated fee amount
*/
function calculateFee(uint256 chainId, uint256 tradeValue)
external
view
override
returns (uint256 fee)
{
DataStructures.FeeConfig memory config = _feeConfigs[chainId];
if (!config.feeEnabled) {
return 0;
}
// Calculate percentage-based fee
uint256 percentageFee = (tradeValue * config.platformFeePercent) / Constants.BASIS_POINTS;
// Ensure minimum fee is met
if (percentageFee < config.minimumFee) {
return config.minimumFee;
}
return percentageFee;
}
/**
* @dev Collects fee for a trade
* @param offerId The offer ID
* @param tradeValue The value of the trade
* @param feeToken The token to collect fee in (0x0 for native)
*/
function collectFee(uint256 offerId, uint256 tradeValue, address feeToken)
external
payable
override
nonReentrant
whenNotPaused
{
// Check if payer is fee exempt
if (_feeExemptions[msg.sender]) {
return;
}
uint256 chainId = block.chainid;
DataStructures.FeeConfig memory config = _feeConfigs[chainId];
if (!config.feeEnabled) {
return;
}
uint256 feeAmount = this.calculateFee(chainId, tradeValue);
if (feeAmount == 0) {
return;
}
// Collect fee based on token type
if (feeToken == address(0)) {
// Native token fee
if (msg.value < feeAmount) {
revert CustomErrors.InsufficientFee(msg.value, feeAmount);
}
// Send fee to recipient
(bool success, ) = payable(config.feeRecipient).call{value: feeAmount}("");
if (!success) {
revert CustomErrors.FeePaymentFailed(config.feeRecipient, feeAmount);
}
// Refund excess
if (msg.value > feeAmount) {
(bool refundSuccess, ) = payable(msg.sender).call{value: msg.value - feeAmount}("");
if (!refundSuccess) {
revert CustomErrors.FeePaymentFailed(msg.sender, msg.value - feeAmount);
}
}
} else {
// ERC20 token fee
if (!_isSupportedFeeToken(chainId, feeToken)) {
revert CustomErrors.UnsupportedFeeToken(feeToken);
}
IERC20(feeToken).safeTransferFrom(
msg.sender,
config.feeRecipient,
feeAmount
);
}
// Update statistics
_offerFees[offerId] = feeAmount;
_totalFeesCollected[feeToken] += feeAmount;
totalOffersProcessed++;
totalFeeVolume += feeAmount;
emit FeeCollected(offerId, feeToken, feeAmount, config.feeRecipient, msg.sender);
}
// ============ CONFIGURATION FUNCTIONS ============
/**
* @dev Sets fee configuration for a chain
* @param chainId The chain ID
* @param config The fee configuration
*/
function setFeeConfig(uint256 chainId, DataStructures.FeeConfig calldata config)
external
override
onlyFeeManager
nonReentrant
{
if (config.platformFeePercent > Constants.MAX_PLATFORM_FEE) {
revert CustomErrors.FeePercentageTooHigh(config.platformFeePercent, Constants.MAX_PLATFORM_FEE);
}
if (config.feeRecipient == address(0)) {
revert CustomErrors.InvalidFeeRecipient(config.feeRecipient);
}
DataStructures.FeeConfig memory oldConfig = _feeConfigs[chainId];
_feeConfigs[chainId] = config;
emit FeeConfigUpdated(chainId, oldConfig, config, msg.sender);
}
/**
* @dev Sets fee exemption status for an account
* @param account The account to set exemption for
* @param exempt Whether the account should be exempt
*/
function setFeeExemption(address account, bool exempt)
external
override
onlyFeeManager
nonReentrant
{
if (account == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_feeExemptions[account] = exempt;
emit FeeExemptionUpdated(account, exempt, msg.sender);
}
/**
* @dev Adds a supported fee token for a chain
* @param chainId The chain ID
* @param token The token address to add
*/
function addSupportedFeeToken(uint256 chainId, address token)
external
onlyFeeManager
nonReentrant
{
if (token == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
if (_isSupportedFeeToken(chainId, token)) {
revert CustomErrors.DuplicateEntry(keccak256(abi.encodePacked(chainId, token)));
}
_supportedFeeTokens[chainId].push(token);
}
/**
* @dev Removes a supported fee token for a chain
* @param chainId The chain ID
* @param token The token address to remove
*/
function removeSupportedFeeToken(uint256 chainId, address token)
external
onlyFeeManager
nonReentrant
{
address[] storage tokens = _supportedFeeTokens[chainId];
for (uint256 i = 0; i < tokens.length; i++) {
if (tokens[i] == token) {
tokens[i] = tokens[tokens.length - 1];
tokens.pop();
return;
}
}
revert CustomErrors.UnsupportedFeeToken(token);
}
// ============ ADMIN FUNCTIONS ============
/**
* @dev Withdraws collected fees (admin only)
* @param token The token to withdraw (0x0 for native)
* @param amount The amount to withdraw
* @param recipient The withdrawal recipient
*/
function withdrawFees(address token, uint256 amount, address recipient)
external
onlyAdmin
nonReentrant
{
if (recipient == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
if (amount == 0) {
revert CustomErrors.ValueOutOfRange(amount, 1, type(uint256).max);
}
if (token == address(0)) {
// Withdraw native token
if (address(this).balance < amount) {
revert CustomErrors.InsufficientEscrowBalance(token, 0, amount, address(this).balance);
}
(bool success, ) = payable(recipient).call{value: amount}("");
if (!success) {
revert CustomErrors.FeePaymentFailed(recipient, amount);
}
} else {
// Withdraw ERC20 token
uint256 balance = IERC20(token).balanceOf(address(this));
if (balance < amount) {
revert CustomErrors.InsufficientEscrowBalance(token, 0, amount, balance);
}
IERC20(token).safeTransfer(recipient, amount);
}
emit FeesWithdrawn(token, amount, recipient, msg.sender);
}
/**
* @dev Emergency withdrawal of all fees (admin only)
* @param recipient The withdrawal recipient
*/
function emergencyWithdrawAllFees(address recipient)
external
onlyAdmin
nonReentrant
{
if (recipient == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
// Withdraw native balance
uint256 nativeBalance = address(this).balance;
if (nativeBalance > 0) {
(bool success, ) = payable(recipient).call{value: nativeBalance}("");
if (!success) {
revert CustomErrors.FeePaymentFailed(recipient, nativeBalance);
}
emit FeesWithdrawn(address(0), nativeBalance, recipient, msg.sender);
}
// Note: ERC20 tokens would need to be withdrawn individually
// as we don't track all possible tokens that might be sent to this contract
}
// ============ VIEW FUNCTIONS ============
/**
* @dev Gets fee configuration for a chain
* @param chainId The chain ID
* @return config The fee configuration
*/
function getFeeConfig(uint256 chainId)
external
view
override
returns (DataStructures.FeeConfig memory config)
{
return _feeConfigs[chainId];
}
/**
* @dev Checks if an account is fee exempt
* @param account The account to check
* @return exempt Whether the account is exempt
*/
function isFeeExempt(address account)
external
view
override
returns (bool exempt)
{
return _feeExemptions[account];
}
/**
* @dev Gets total fees collected for a token
* @param token The token address (0x0 for native)
* @return total The total fees collected
*/
function getTotalFeesCollected(address token)
external
view
override
returns (uint256 total)
{
return _totalFeesCollected[token];
}
/**
* @dev Gets fee collected for a specific offer
* @param offerId The offer ID
* @return fee The fee amount collected
*/
function getOfferFee(uint256 offerId) external view returns (uint256 fee) {
return _offerFees[offerId];
}
/**
* @dev Gets supported fee tokens for a chain
* @param chainId The chain ID
* @return tokens Array of supported fee token addresses
*/
function getSupportedFeeTokens(uint256 chainId)
external
view
returns (address[] memory tokens)
{
return _supportedFeeTokens[chainId];
}
/**
* @dev Gets fee manager statistics
* @return totalOffers Total offers processed
* @return totalVolume Total fee volume
* @return totalChains Number of chains with fee configuration
*/
function getFeeManagerStats()
external
view
returns (uint256 totalOffers, uint256 totalVolume, uint256 totalChains)
{
totalOffers = totalOffersProcessed;
totalVolume = totalFeeVolume;
// Count chains with fee configuration
uint256[] memory supportedChains = new uint256[](6);
supportedChains[0] = Constants.ETHEREUM_CHAIN_ID;
supportedChains[1] = Constants.ARBITRUM_CHAIN_ID;
supportedChains[2] = Constants.POLYGON_CHAIN_ID;
supportedChains[3] = Constants.OPTIMISM_CHAIN_ID;
supportedChains[4] = Constants.BASE_CHAIN_ID;
supportedChains[5] = block.chainid;
for (uint256 i = 0; i < supportedChains.length; i++) {
if (_feeConfigs[supportedChains[i]].feeEnabled) {
totalChains++;
}
}
}
// ============ INTERNAL FUNCTIONS ============
/**
* @dev Initializes default fee configurations
*/
function _initializeDefaultFeeConfigs() internal {
// Ethereum configuration
_feeConfigs[Constants.ETHEREUM_CHAIN_ID] = DataStructures.FeeConfig({
platformFeePercent: Constants.DEFAULT_PLATFORM_FEE,
minimumFee: Constants.ETHEREUM_MIN_FEE,
feeRecipient: msg.sender, // Will be updated by admin
feeEnabled: true,
preferredFeeToken: address(0) // Native ETH
});
// Polygon configuration
_feeConfigs[Constants.POLYGON_CHAIN_ID] = DataStructures.FeeConfig({
platformFeePercent: Constants.DEFAULT_PLATFORM_FEE,
minimumFee: Constants.POLYGON_MIN_FEE,
feeRecipient: msg.sender,
feeEnabled: true,
preferredFeeToken: address(0) // Native MATIC
});
// Arbitrum configuration
_feeConfigs[Constants.ARBITRUM_CHAIN_ID] = DataStructures.FeeConfig({
platformFeePercent: Constants.DEFAULT_PLATFORM_FEE,
minimumFee: Constants.ARBITRUM_MIN_FEE,
feeRecipient: msg.sender,
feeEnabled: true,
preferredFeeToken: address(0) // Native ETH
});
// Optimism configuration
_feeConfigs[Constants.OPTIMISM_CHAIN_ID] = DataStructures.FeeConfig({
platformFeePercent: Constants.DEFAULT_PLATFORM_FEE,
minimumFee: Constants.OPTIMISM_MIN_FEE,
feeRecipient: msg.sender,
feeEnabled: true,
preferredFeeToken: address(0) // Native ETH
});
// Base configuration
_feeConfigs[Constants.BASE_CHAIN_ID] = DataStructures.FeeConfig({
platformFeePercent: Constants.DEFAULT_PLATFORM_FEE,
minimumFee: Constants.BASE_MIN_FEE,
feeRecipient: msg.sender,
feeEnabled: true,
preferredFeeToken: address(0) // Native ETH
});
}
/**
* @dev Checks if a token is supported for fees on a chain
* @param chainId The chain ID
* @param token The token address
* @return supported Whether the token is supported
*/
function _isSupportedFeeToken(uint256 chainId, address token)
internal
view
returns (bool supported)
{
address[] memory tokens = _supportedFeeTokens[chainId];
for (uint256 i = 0; i < tokens.length; i++) {
if (tokens[i] == token) {
return true;
}
}
return false;
}
/**
* @dev Returns the version of the contract
* @return version The contract version
*/
function version() external pure returns (string memory) {
return "1.0.0";
}
// ============ RECEIVE FUNCTION ============
/**
* @dev Allows contract to receive native tokens
*/
receive() external payable {
// Allow contract to receive native tokens for fee collection
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
import "../interfaces/IOfferManager.sol";
import "../libraries/DataStructures.sol";
import "../libraries/Constants.sol";
import "../libraries/Errors.sol";
import "../libraries/SignatureLibrary.sol";
import "../libraries/AssetLibrary.sol";
import "../core/AccessControl.sol";
import "../security/AssetVerification.sol";
/**
* @title OfferManager
* @dev Trade offer lifecycle management for the Cross-Chain NFT Trading Platform
* @author Blocklabs Studio
*/
contract OfferManager is
Initializable,
ReentrancyGuardUpgradeable,
IOfferManager
{
// ============ STATE VARIABLES ============
/// @dev Reference to the AccessControl contract
AccessControl public accessControl;
/// @dev Reference to the AssetVerification contract
AssetVerification public assetVerification;
/// @dev Mapping from offer ID to trade offer
mapping(uint256 => DataStructures.TradeOffer) private _offers;
/// @dev Mapping from creator address to their offer IDs
mapping(address => uint256[]) private _creatorOffers;
/// @dev Mapping from counterparty address to offers they can accept
mapping(address => uint256[]) private _counterpartyOffers;
/// @dev Array of all active offer IDs
uint256[] private _activeOffers;
/// @dev Mapping to track active offer indices for efficient removal
mapping(uint256 => uint256) private _activeOfferIndices;
/// @dev Next offer ID counter
uint256 private _nextOfferId;
/// @dev Total number of offers created
uint256 public totalOffers;
/// @dev EIP-712 domain separator
bytes32 private _domainSeparator;
/// @dev Mapping to track used nonces for signature replay protection
mapping(address => mapping(uint256 => bool)) private _usedNonces;
/// @dev Mapping to track offer expiration cleanup
mapping(uint256 => bool) private _expiredOffers;
// ============ EVENTS ============
/**
* @dev Emitted when an offer is created
* @param offerId The unique offer identifier
* @param creator The offer creator
* @param mode The settlement mode (same-chain or cross-chain)
* @param expirationTime The offer expiration time
*/
event OfferCreated(
uint256 indexed offerId,
address indexed creator,
DataStructures.SettlementMode mode,
uint256 expirationTime
);
/**
* @dev Emitted when an offer is accepted
* @param offerId The unique offer identifier
* @param acceptor The address that accepted the offer
* @param settlementTime The expected settlement time
*/
event OfferAccepted(
uint256 indexed offerId,
address indexed acceptor,
uint256 settlementTime
);
/**
* @dev Emitted when an offer is cancelled
* @param offerId The unique offer identifier
* @param creator The offer creator
* @param reason The cancellation reason
*/
event OfferCancelled(
uint256 indexed offerId,
address indexed creator,
string reason
);
/**
* @dev Emitted when an offer expires
* @param offerId The unique offer identifier
* @param expirationTime The expiration timestamp
*/
event OfferExpired(
uint256 indexed offerId,
uint256 expirationTime
);
/**
* @dev Emitted when a counter-offer is created
* @param originalOfferId The original offer ID
* @param counterOfferId The counter-offer ID
* @param creator The counter-offer creator
*/
event CounterOfferCreated(
uint256 indexed originalOfferId,
uint256 indexed counterOfferId,
address indexed creator
);
/**
* @dev Emitted when offer cleanup is performed
* @param cleanedOffers Number of offers cleaned up
* @param cleanedBy The address that performed cleanup
*/
event OfferCleanupPerformed(
uint256 cleanedOffers,
address indexed cleanedBy
);
// ============ MODIFIERS ============
/**
* @dev Modifier to ensure contract is not paused
*/
modifier whenNotPaused() {
if (accessControl.paused()) {
revert CustomErrors.ContractPaused();
}
_;
}
/**
* @dev Modifier to check if caller has admin role
*/
modifier onlyAdmin() {
if (!accessControl.hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.ADMIN_ROLE);
}
_;
}
/**
* @dev Modifier to validate offer exists and is not expired
*/
modifier validOffer(uint256 offerId) {
if (offerId == 0 || offerId >= _nextOfferId) {
revert CustomErrors.OfferNotFound(offerId);
}
DataStructures.TradeOffer storage offer = _offers[offerId];
if (offer.status == DataStructures.OfferStatus.EXPIRED ||
block.timestamp > offer.expirationTime) {
revert CustomErrors.OfferExpired(offerId, offer.expirationTime);
}
_;
}
// ============ INITIALIZATION ============
/**
* @dev Initializes the OfferManager contract
* @param _accessControl Address of the AccessControl contract
* @param _assetVerification Address of the AssetVerification contract
*/
function initialize(address _accessControl, address _assetVerification) public initializer {
if (_accessControl == address(0) || _assetVerification == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
__ReentrancyGuard_init();
accessControl = AccessControl(_accessControl);
assetVerification = AssetVerification(_assetVerification);
_nextOfferId = 1; // Start from 1, 0 is reserved for null
// Initialize EIP-712 domain separator
_domainSeparator = SignatureLibrary.buildDomainSeparator(address(this), block.chainid);
}
// ============ CORE FUNCTIONS ============
/**
* @dev Creates a new trade offer
* @param offer The trade offer details
* @return offerId The unique identifier for the created offer
*/
function createOffer(DataStructures.TradeOffer calldata offer)
external
override
nonReentrant
whenNotPaused
returns (uint256 offerId)
{
// Validate offer parameters
(bool valid, string memory reason) = validateOffer(offer);
if (!valid) {
revert CustomErrors.InvalidOfferParameters(reason);
}
// Verify signature if provided
if (offer.signature.length > 0) {
_verifyOfferSignature(offer);
}
// Assign offer ID
offerId = _nextOfferId++;
// Create offer with assigned ID
DataStructures.TradeOffer storage newOffer = _offers[offerId];
newOffer.offerId = offerId;
newOffer.creator = offer.creator;
newOffer.counterparty = offer.counterparty;
newOffer.expirationTime = offer.expirationTime;
newOffer.sourceChainId = offer.sourceChainId;
newOffer.destinationChainId = offer.destinationChainId;
newOffer.settlementMode = offer.settlementMode;
newOffer.signature = offer.signature;
newOffer.status = DataStructures.OfferStatus.PENDING;
newOffer.createdAt = block.timestamp;
newOffer.nonce = offer.nonce;
// Copy asset arrays
for (uint256 i = 0; i < offer.offeredAssets.length; i++) {
newOffer.offeredAssets.push(offer.offeredAssets[i]);
}
for (uint256 i = 0; i < offer.requestedAssets.length; i++) {
newOffer.requestedAssets.push(offer.requestedAssets[i]);
}
// Update tracking mappings
_creatorOffers[offer.creator].push(offerId);
if (offer.counterparty != address(0)) {
_counterpartyOffers[offer.counterparty].push(offerId);
}
// Add to active offers
_activeOfferIndices[offerId] = _activeOffers.length;
_activeOffers.push(offerId);
// Mark nonce as used if signature provided
if (offer.signature.length > 0) {
_usedNonces[offer.creator][offer.nonce] = true;
}
totalOffers++;
emit OfferCreated(offerId, offer.creator, offer.settlementMode, offer.expirationTime);
return offerId;
}
/**
* @dev Accepts a trade offer
* @param offerId The unique identifier of the offer to accept
* @param acceptor The address accepting the offer
*/
function acceptOffer(uint256 offerId, address acceptor)
external
override
nonReentrant
whenNotPaused
validOffer(offerId)
{
DataStructures.TradeOffer storage offer = _offers[offerId];
// Validate acceptance
(bool canAccept, string memory reason) = canAcceptOffer(offerId, acceptor);
if (!canAccept) {
revert CustomErrors.UnauthorizedOfferAcceptance(offerId, acceptor, offer.counterparty);
}
// Update offer status
offer.status = DataStructures.OfferStatus.ACCEPTED;
// Remove from active offers
_removeFromActiveOffers(offerId);
// Calculate settlement time based on mode
uint256 settlementTime;
if (offer.settlementMode == DataStructures.SettlementMode.SAME_CHAIN) {
settlementTime = block.timestamp + Constants.SAME_CHAIN_TIMEOUT;
} else {
settlementTime = block.timestamp + Constants.CROSS_CHAIN_TIMEOUT;
}
emit OfferAccepted(offerId, acceptor, settlementTime);
}
/**
* @dev Cancels a trade offer
* @param offerId The unique identifier of the offer to cancel
* @param caller The address requesting cancellation
*/
function cancelOffer(uint256 offerId, address caller)
external
override
nonReentrant
whenNotPaused
validOffer(offerId)
{
DataStructures.TradeOffer storage offer = _offers[offerId];
// Only creator or admin can cancel
if (caller != offer.creator && !accessControl.hasRole(Constants.ADMIN_ROLE, caller)) {
revert CustomErrors.UnauthorizedAccess(caller, Constants.ADMIN_ROLE);
}
// Update offer status
offer.status = DataStructures.OfferStatus.CANCELLED;
// Remove from active offers
_removeFromActiveOffers(offerId);
string memory reason = caller == offer.creator ? "Cancelled by creator" : "Cancelled by admin";
emit OfferCancelled(offerId, offer.creator, reason);
}
/**
* @dev Creates a counter-offer for an existing offer
* @param originalOfferId The unique identifier of the original offer
* @param counterOffer The counter-offer details
* @return counterOfferId The unique identifier for the counter-offer
*/
function createCounterOffer(uint256 originalOfferId, DataStructures.TradeOffer calldata counterOffer)
external
override
nonReentrant
whenNotPaused
validOffer(originalOfferId)
returns (uint256 counterOfferId)
{
DataStructures.TradeOffer storage originalOffer = _offers[originalOfferId];
// Validate counter-offer creator
if (counterOffer.creator != originalOffer.counterparty && originalOffer.counterparty != address(0)) {
revert CustomErrors.UnauthorizedOfferAcceptance(originalOfferId, counterOffer.creator, originalOffer.counterparty);
}
// Create the counter-offer
counterOfferId = this.createOffer(counterOffer);
emit CounterOfferCreated(originalOfferId, counterOfferId, counterOffer.creator);
return counterOfferId;
}
// ============ VALIDATION FUNCTIONS ============
/**
* @dev Validates a trade offer
* @param offer The offer to validate
* @return valid Whether the offer is valid
* @return reason Reason if offer is invalid
*/
function validateOffer(DataStructures.TradeOffer calldata offer)
public
view
override
returns (bool valid, string memory reason)
{
// Check creator is not zero address
if (offer.creator == address(0)) {
return (false, "Creator cannot be zero address");
}
// Check expiration time
if (offer.expirationTime <= block.timestamp) {
return (false, "Offer already expired");
}
if (offer.expirationTime > block.timestamp + Constants.MAX_OFFER_DURATION) {
return (false, "Offer duration too long");
}
// Check asset arrays
if (offer.offeredAssets.length == 0) {
return (false, "No offered assets");
}
if (offer.requestedAssets.length == 0) {
return (false, "No requested assets");
}
if (offer.offeredAssets.length > Constants.MAX_ASSETS_PER_OFFER) {
return (false, "Too many offered assets");
}
if (offer.requestedAssets.length > Constants.MAX_ASSETS_PER_OFFER) {
return (false, "Too many requested assets");
}
// Validate each offered asset
for (uint256 i = 0; i < offer.offeredAssets.length; i++) {
(bool assetValid, string memory assetReason) = AssetLibrary.validateAsset(offer.offeredAssets[i]);
if (!assetValid) {
return (false, string(abi.encodePacked("Invalid offered asset: ", assetReason)));
}
// Verify asset ownership
if (!AssetLibrary.verifyOwnership(offer.offeredAssets[i], offer.creator)) {
return (false, "Creator does not own offered asset");
}
}
// Validate each requested asset
for (uint256 i = 0; i < offer.requestedAssets.length; i++) {
(bool assetValid, string memory assetReason) = AssetLibrary.validateAsset(offer.requestedAssets[i]);
if (!assetValid) {
return (false, string(abi.encodePacked("Invalid requested asset: ", assetReason)));
}
}
// Validate settlement mode and chain IDs
if (offer.settlementMode == DataStructures.SettlementMode.CROSS_CHAIN) {
if (offer.destinationChainId == 0 || offer.destinationChainId == offer.sourceChainId) {
return (false, "Invalid cross-chain configuration");
}
} else {
if (offer.destinationChainId != 0) {
return (false, "Same-chain offers should not have destination chain");
}
}
return (true, "");
}
/**
* @dev Checks if an offer can be accepted by a specific address
* @param offerId The unique identifier of the offer
* @param acceptor The address wanting to accept the offer
* @return canAccept Whether the offer can be accepted
* @return reason Reason if offer cannot be accepted
*/
function canAcceptOffer(uint256 offerId, address acceptor)
public
view
override
returns (bool canAccept, string memory reason)
{
if (offerId == 0 || offerId >= _nextOfferId) {
return (false, "Offer does not exist");
}
DataStructures.TradeOffer storage offer = _offers[offerId];
// Check offer status
if (offer.status != DataStructures.OfferStatus.PENDING) {
return (false, "Offer is not pending");
}
// Check expiration
if (block.timestamp > offer.expirationTime) {
return (false, "Offer has expired");
}
// Check if acceptor is the creator
if (acceptor == offer.creator) {
return (false, "Creator cannot accept own offer");
}
// Check counterparty restriction
if (offer.counterparty != address(0) && acceptor != offer.counterparty) {
return (false, "Offer is restricted to specific counterparty");
}
// Verify acceptor owns requested assets
for (uint256 i = 0; i < offer.requestedAssets.length; i++) {
if (!AssetLibrary.verifyOwnership(offer.requestedAssets[i], acceptor)) {
return (false, "Acceptor does not own required assets");
}
}
return (true, "");
}
/**
* @dev Checks if an offer has expired
* @param offerId The unique identifier of the offer
* @return expired Whether the offer has expired
*/
function isOfferExpired(uint256 offerId)
external
view
override
returns (bool expired)
{
if (offerId == 0 || offerId >= _nextOfferId) {
return true;
}
DataStructures.TradeOffer storage offer = _offers[offerId];
return block.timestamp > offer.expirationTime;
}
// ============ VIEW FUNCTIONS ============
/**
* @dev Gets a trade offer by ID
* @param offerId The unique identifier of the offer
* @return offer The trade offer
*/
function getOffer(uint256 offerId)
external
view
override
returns (DataStructures.TradeOffer memory offer)
{
if (offerId == 0 || offerId >= _nextOfferId) {
revert CustomErrors.OfferNotFound(offerId);
}
return _offers[offerId];
}
/**
* @dev Gets offers created by a specific address
* @param creator The creator address
* @return offerIds Array of offer IDs created by the address
*/
function getOffersByCreator(address creator)
external
view
override
returns (uint256[] memory offerIds)
{
return _creatorOffers[creator];
}
/**
* @dev Gets all active offer IDs
* @return offerIds Array of active offer IDs
*/
function getActiveOffers()
external
view
override
returns (uint256[] memory offerIds)
{
return _activeOffers;
}
/**
* @dev Gets the total number of offers created
* @return total The total number of offers
*/
function getTotalOffers()
external
view
override
returns (uint256 total)
{
return totalOffers;
}
/**
* @dev Gets the next offer ID that will be assigned
* @return nextId The next offer ID
*/
function getNextOfferId() external view returns (uint256 nextId) {
return _nextOfferId;
}
/**
* @dev Gets offers available to a specific counterparty
* @param counterparty The counterparty address
* @return offerIds Array of offer IDs available to the counterparty
*/
function getCounterpartyOffers(address counterparty)
external
view
returns (uint256[] memory offerIds)
{
return _counterpartyOffers[counterparty];
}
// ============ MAINTENANCE FUNCTIONS ============
/**
* @dev Cleans up expired offers (admin only)
* @param maxCleanup Maximum number of offers to clean up in one call
* @return cleanedCount Number of offers cleaned up
*/
function cleanupExpiredOffers(uint256 maxCleanup)
external
onlyAdmin
nonReentrant
returns (uint256 cleanedCount)
{
uint256 cleaned = 0;
uint256 i = 0;
while (i < _activeOffers.length && cleaned < maxCleanup) {
uint256 offerId = _activeOffers[i];
DataStructures.TradeOffer storage offer = _offers[offerId];
if (block.timestamp > offer.expirationTime && !_expiredOffers[offerId]) {
offer.status = DataStructures.OfferStatus.EXPIRED;
_expiredOffers[offerId] = true;
// Remove from active offers
_removeFromActiveOffers(offerId);
emit OfferExpired(offerId, offer.expirationTime);
cleaned++;
} else {
i++;
}
}
if (cleaned > 0) {
emit OfferCleanupPerformed(cleaned, msg.sender);
}
return cleaned;
}
/**
* @dev Updates the domain separator (admin only)
*/
function updateDomainSeparator() external onlyAdmin {
_domainSeparator = SignatureLibrary.buildDomainSeparator(address(this), block.chainid);
}
// ============ INTERNAL FUNCTIONS ============
/**
* @dev Verifies an offer signature
* @param offer The offer to verify
*/
function _verifyOfferSignature(DataStructures.TradeOffer calldata offer) internal view {
if (!SignatureLibrary.validateSignatureFormat(offer.signature)) {
revert CustomErrors.InvalidSignatureFormat();
}
if (_usedNonces[offer.creator][offer.nonce]) {
revert CustomErrors.NonceAlreadyUsed(offer.creator, offer.nonce);
}
(address signer, bool isValid) = SignatureLibrary.verifyOfferSignature(
offer,
offer.signature,
_domainSeparator
);
if (!isValid || signer != offer.creator) {
revert CustomErrors.InvalidSignature(signer, SignatureLibrary.hashTradeOffer(offer));
}
}
/**
* @dev Removes an offer from the active offers array
* @param offerId The offer ID to remove
*/
function _removeFromActiveOffers(uint256 offerId) internal {
uint256 index = _activeOfferIndices[offerId];
uint256 lastIndex = _activeOffers.length - 1;
if (index != lastIndex) {
uint256 lastOfferId = _activeOffers[lastIndex];
_activeOffers[index] = lastOfferId;
_activeOfferIndices[lastOfferId] = index;
}
_activeOffers.pop();
delete _activeOfferIndices[offerId];
}
/**
* @dev Returns the version of the contract
* @return version The contract version
*/
function version() external pure returns (string memory) {
return "1.0.0";
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "../libraries/DataStructures.sol";
import "../libraries/Constants.sol";
import "../libraries/Errors.sol";
import "../core/AccessControl.sol";
/**
* @dev Interface for ERC721C contracts
*/
interface IERC721C {
function getTransferPolicy() external view returns (uint8);
function isWhitelisted(address operator) external view returns (bool);
function royaltyInfo(uint256 tokenId, uint256 salePrice) external view returns (address, uint256);
function owner() external view returns (address);
}
/**
* @title ERC721CIntegration
* @dev Creator royalty enforcement integration for ERC721C tokens
* @author Blocklabs Studio
*/
contract ERC721CIntegration is
Initializable,
ReentrancyGuardUpgradeable
{
using SafeERC20 for IERC20;
// ============ STATE VARIABLES ============
/// @dev Reference to the AccessControl contract
AccessControl public accessControl;
/// @dev Mapping of ERC721C contracts to their whitelist status
mapping(address => bool) private _whitelistedContracts;
/// @dev Mapping of ERC721C contracts to their royalty configurations
mapping(address => RoyaltyConfig) private _royaltyConfigs;
/// @dev Mapping to track collected royalties per token contract
mapping(address => uint256) private _collectedRoyalties;
/// @dev Mapping to track royalty payments per trade
mapping(uint256 => RoyaltyPayment[]) private _tradeRoyalties;
/// @dev Total royalties collected across all contracts
uint256 public totalRoyaltiesCollected;
/// @dev Total number of royalty payments made
uint256 public totalRoyaltyPayments;
// ============ STRUCTS ============
struct RoyaltyConfig {
bool enforceRoyalties; // Whether to enforce royalty payments
uint256 maxRoyaltyPercent; // Maximum royalty percentage (basis points)
address defaultRecipient; // Default royalty recipient if not specified
bool requireWhitelist; // Whether trading requires whitelist approval
}
struct RoyaltyPayment {
address tokenContract; // The NFT contract
uint256 tokenId; // The token ID
address recipient; // Royalty recipient
uint256 amount; // Royalty amount paid
address paymentToken; // Token used for payment (0x0 for native)
uint256 timestamp; // Payment timestamp
}
// ============ EVENTS ============
/**
* @dev Emitted when a contract is whitelisted for trading
* @param tokenContract The token contract address
* @param whitelisted Whether the contract is whitelisted
* @param whitelistedBy The address that performed the whitelisting
*/
event ContractWhitelisted(
address indexed tokenContract,
bool whitelisted,
address indexed whitelistedBy
);
/**
* @dev Emitted when royalty configuration is updated
* @param tokenContract The token contract address
* @param config The new royalty configuration
* @param updatedBy The address that updated the configuration
*/
event RoyaltyConfigUpdated(
address indexed tokenContract,
RoyaltyConfig config,
address indexed updatedBy
);
/**
* @dev Emitted when royalties are paid
* @param offerId The trade offer ID
* @param tokenContract The NFT contract
* @param tokenId The token ID
* @param recipient The royalty recipient
* @param amount The royalty amount
* @param paymentToken The payment token (0x0 for native)
*/
event RoyaltyPaid(
uint256 indexed offerId,
address indexed tokenContract,
uint256 indexed tokenId,
address recipient,
uint256 amount,
address paymentToken
);
/**
* @dev Emitted when trading policy is checked
* @param tokenContract The token contract address
* @param operator The trading operator
* @param allowed Whether trading is allowed
* @param policy The transfer policy
*/
event TradingPolicyChecked(
address indexed tokenContract,
address indexed operator,
bool allowed,
uint8 policy
);
// ============ MODIFIERS ============
/**
* @dev Modifier to check if caller has project admin role
*/
modifier onlyProjectAdmin() {
if (!accessControl.hasRole(Constants.PROJECT_ADMIN_ROLE, msg.sender) &&
!accessControl.hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.PROJECT_ADMIN_ROLE);
}
_;
}
/**
* @dev Modifier to ensure contract is not paused
*/
modifier whenNotPaused() {
if (accessControl.paused()) {
revert CustomErrors.ContractPaused();
}
_;
}
// ============ INITIALIZATION ============
/**
* @dev Initializes the ERC721CIntegration contract
* @param _accessControl Address of the AccessControl contract
*/
function initialize(address _accessControl) public initializer {
if (_accessControl == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
__ReentrancyGuard_init();
accessControl = AccessControl(_accessControl);
}
// ============ CORE FUNCTIONS ============
/**
* @dev Whitelists a trading contract for ERC721C tokens
* @param nftContract The NFT contract address
*/
function whitelistTradingContract(address nftContract)
external
onlyProjectAdmin
nonReentrant
whenNotPaused
{
if (nftContract == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
// Check if contract supports ERC721C
if (!_isERC721C(nftContract)) {
revert CustomErrors.AssetStandardMismatch(nftContract, uint8(DataStructures.AssetType.ERC721));
}
_whitelistedContracts[nftContract] = true;
emit ContractWhitelisted(nftContract, true, msg.sender);
}
/**
* @dev Checks the transfer policy for an ERC721C contract
* @param nftContract The NFT contract address
* @return policy The transfer policy (0 = no restrictions, 1+ = restricted)
*/
function checkTransferPolicy(address nftContract)
external
view
returns (uint8 policy)
{
if (!_isERC721C(nftContract)) {
return 0; // No restrictions for non-ERC721C contracts
}
try IERC721C(nftContract).getTransferPolicy() returns (uint8 transferPolicy) {
return transferPolicy;
} catch {
return 0; // Default to no restrictions if call fails
}
}
/**
* @dev Checks if an operator is whitelisted for trading
* @param nftContract The NFT contract address
* @param operator The operator address
* @return whitelisted Whether the operator is whitelisted
*/
function isWhitelisted(address nftContract, address operator)
external
view
returns (bool whitelisted)
{
// Check if our trading contract is whitelisted
if (_whitelistedContracts[nftContract]) {
return true;
}
// Check ERC721C whitelist
if (_isERC721C(nftContract)) {
try IERC721C(nftContract).isWhitelisted(operator) returns (bool isWhitelistedOperator) {
return isWhitelistedOperator;
} catch {
return false;
}
}
return false;
}
/**
* @dev Validates trading is allowed for an ERC721C token
* @param nftContract The NFT contract address
* @param operator The trading operator
* @return allowed Whether trading is allowed
* @return reason Reason if trading is not allowed
*/
function validateTrading(address nftContract, address operator)
external
view
returns (bool allowed, string memory reason)
{
if (!_isERC721C(nftContract)) {
return (true, "Not an ERC721C contract");
}
// Check transfer policy
uint8 policy = this.checkTransferPolicy(nftContract);
if (policy == 0) {
return (true, "No transfer restrictions");
}
// Check if operator is whitelisted
bool whitelisted = this.isWhitelisted(nftContract, operator);
if (!whitelisted) {
return (false, "Operator not whitelisted for restricted contract");
}
return (true, "Operator whitelisted");
}
/**
* @dev Calculates and processes royalty payment for a trade
* @param offerId The trade offer ID
* @param nftContract The NFT contract address
* @param tokenId The token ID
* @param salePrice The sale price
* @param paymentToken The payment token (0x0 for native)
* @return royaltyAmount The calculated royalty amount
*/
function processRoyaltyPayment(
uint256 offerId,
address nftContract,
uint256 tokenId,
uint256 salePrice,
address paymentToken
) external payable nonReentrant whenNotPaused returns (uint256 royaltyAmount) {
if (nftContract == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
// Get royalty configuration
RoyaltyConfig memory config = _royaltyConfigs[nftContract];
if (!config.enforceRoyalties) {
return 0; // No royalties to collect
}
// Calculate royalty amount
(address recipient, uint256 amount) = _calculateRoyalty(nftContract, tokenId, salePrice);
if (amount == 0 || recipient == address(0)) {
return 0; // No royalty to pay
}
// Validate royalty amount doesn't exceed maximum
uint256 maxRoyalty = (salePrice * config.maxRoyaltyPercent) / Constants.BASIS_POINTS;
if (amount > maxRoyalty) {
amount = maxRoyalty;
}
// Process payment
if (paymentToken == address(0)) {
// Native token payment
if (msg.value < amount) {
revert CustomErrors.InsufficientFee(msg.value, amount);
}
(bool success, ) = payable(recipient).call{value: amount}("");
if (!success) {
revert CustomErrors.FeePaymentFailed(recipient, amount);
}
// Refund excess
if (msg.value > amount) {
(bool refundSuccess, ) = payable(msg.sender).call{value: msg.value - amount}("");
if (!refundSuccess) {
revert CustomErrors.FeePaymentFailed(msg.sender, msg.value - amount);
}
}
} else {
// ERC20 token payment
IERC20(paymentToken).safeTransferFrom(msg.sender, recipient, amount);
}
// Record royalty payment
_tradeRoyalties[offerId].push(RoyaltyPayment({
tokenContract: nftContract,
tokenId: tokenId,
recipient: recipient,
amount: amount,
paymentToken: paymentToken,
timestamp: block.timestamp
}));
// Update statistics
_collectedRoyalties[nftContract] += amount;
totalRoyaltiesCollected += amount;
totalRoyaltyPayments++;
emit RoyaltyPaid(offerId, nftContract, tokenId, recipient, amount, paymentToken);
return amount;
}
// ============ CONFIGURATION FUNCTIONS ============
/**
* @dev Sets royalty configuration for a contract
* @param nftContract The NFT contract address
* @param config The royalty configuration
*/
function setRoyaltyConfig(address nftContract, RoyaltyConfig calldata config)
external
onlyProjectAdmin
nonReentrant
whenNotPaused
{
if (nftContract == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
if (config.maxRoyaltyPercent > Constants.MAX_ROYALTY_PERCENT) {
revert CustomErrors.FeePercentageTooHigh(config.maxRoyaltyPercent, Constants.MAX_ROYALTY_PERCENT);
}
_royaltyConfigs[nftContract] = config;
emit RoyaltyConfigUpdated(nftContract, config, msg.sender);
}
/**
* @dev Batch whitelists multiple contracts
* @param nftContracts Array of NFT contract addresses
* @param whitelisted Array of whitelist statuses
*/
function batchWhitelistContracts(
address[] calldata nftContracts,
bool[] calldata whitelisted
) external onlyProjectAdmin nonReentrant whenNotPaused {
if (nftContracts.length != whitelisted.length) {
revert CustomErrors.ArrayLengthMismatch(nftContracts.length, whitelisted.length);
}
if (nftContracts.length == 0) {
revert CustomErrors.EmptyArray();
}
for (uint256 i = 0; i < nftContracts.length; i++) {
if (nftContracts[i] == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_whitelistedContracts[nftContracts[i]] = whitelisted[i];
emit ContractWhitelisted(nftContracts[i], whitelisted[i], msg.sender);
}
}
// ============ VIEW FUNCTIONS ============
/**
* @dev Gets royalty configuration for a contract
* @param nftContract The NFT contract address
* @return config The royalty configuration
*/
function getRoyaltyConfig(address nftContract)
external
view
returns (RoyaltyConfig memory config)
{
return _royaltyConfigs[nftContract];
}
/**
* @dev Gets total royalties collected for a contract
* @param nftContract The NFT contract address
* @return amount The total royalties collected
*/
function getCollectedRoyalties(address nftContract)
external
view
returns (uint256 amount)
{
return _collectedRoyalties[nftContract];
}
/**
* @dev Gets royalty payments for a specific trade
* @param offerId The trade offer ID
* @return payments Array of royalty payments
*/
function getTradeRoyalties(uint256 offerId)
external
view
returns (RoyaltyPayment[] memory payments)
{
return _tradeRoyalties[offerId];
}
/**
* @dev Checks if a contract is whitelisted
* @param nftContract The NFT contract address
* @return whitelisted Whether the contract is whitelisted
*/
function isContractWhitelisted(address nftContract)
external
view
returns (bool whitelisted)
{
return _whitelistedContracts[nftContract];
}
/**
* @dev Gets royalty information for a token
* @param nftContract The NFT contract address
* @param tokenId The token ID
* @param salePrice The sale price
* @return recipient The royalty recipient
* @return amount The royalty amount
*/
function getRoyaltyInfo(address nftContract, uint256 tokenId, uint256 salePrice)
external
view
returns (address recipient, uint256 amount)
{
return _calculateRoyalty(nftContract, tokenId, salePrice);
}
/**
* @dev Gets integration statistics
* @return totalContracts Number of whitelisted contracts
* @return totalRoyalties Total royalties collected
* @return totalPayments Total royalty payments made
*/
function getIntegrationStats()
external
view
returns (uint256 totalContracts, uint256 totalRoyalties, uint256 totalPayments)
{
// Count whitelisted contracts (simplified)
totalContracts = 0; // Would need to track this separately in production
totalRoyalties = totalRoyaltiesCollected;
totalPayments = totalRoyaltyPayments;
}
// ============ INTERNAL FUNCTIONS ============
/**
* @dev Checks if a contract implements ERC721C
* @param nftContract The contract to check
* @return isERC721C Whether the contract is ERC721C
*/
function _isERC721C(address nftContract) internal view returns (bool isERC721C) {
try IERC721C(nftContract).getTransferPolicy() returns (uint8) {
return true;
} catch {
return false;
}
}
/**
* @dev Calculates royalty for a token
* @param nftContract The NFT contract address
* @param tokenId The token ID
* @param salePrice The sale price
* @return recipient The royalty recipient
* @return amount The royalty amount
*/
function _calculateRoyalty(address nftContract, uint256 tokenId, uint256 salePrice)
internal
view
returns (address recipient, uint256 amount)
{
// Try ERC2981 royalty standard first
try IERC721C(nftContract).royaltyInfo(tokenId, salePrice) returns (address royaltyRecipient, uint256 royaltyAmount) {
if (royaltyRecipient != address(0) && royaltyAmount > 0) {
return (royaltyRecipient, royaltyAmount);
}
} catch {}
// Fallback to configuration
RoyaltyConfig memory config = _royaltyConfigs[nftContract];
if (config.defaultRecipient != address(0)) {
uint256 defaultAmount = (salePrice * config.maxRoyaltyPercent) / Constants.BASIS_POINTS;
return (config.defaultRecipient, defaultAmount);
}
return (address(0), 0);
}
/**
* @dev Returns the version of the contract
* @return version The contract version
*/
function version() external pure returns (string memory) {
return "1.0.0";
}
/**
* @dev Allows contract to receive native tokens for royalty payments
*/
receive() external payable {
// Allow contract to receive native tokens for royalty processing
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "../libraries/DataStructures.sol";
/**
* @title IAssetVerification
* @dev Interface for asset validation and verification
* @author Blocklabs Studio
*/
interface IAssetVerification {
// ============ EVENTS ============
event AssetWhitelisted(address indexed tokenContract, bool whitelisted);
event AssetBlacklisted(address indexed tokenContract, bool blacklisted);
event ProjectConfigUpdated(address indexed tokenContract, DataStructures.ProjectConfig config);
// ============ CORE FUNCTIONS ============
function verifyAsset(DataStructures.Asset calldata asset, address owner) external view returns (DataStructures.AssetValidation memory);
function verifyAssetOwnership(DataStructures.Asset calldata asset, address owner) external view returns (bool);
function verifyAssetTransferability(DataStructures.Asset calldata asset, address from, address to) external view returns (bool);
// ============ WHITELIST/BLACKLIST FUNCTIONS ============
function setAssetWhitelist(address tokenContract, bool whitelisted) external;
function setAssetBlacklist(address tokenContract, bool blacklisted) external;
function setProjectConfig(address tokenContract, DataStructures.ProjectConfig calldata config) external;
// ============ VIEW FUNCTIONS ============
function isAssetWhitelisted(address tokenContract) external view returns (bool);
function isAssetBlacklisted(address tokenContract) external view returns (bool);
function getProjectConfig(address tokenContract) external view returns (DataStructures.ProjectConfig memory);
function getSupportedAssetTypes() external view returns (DataStructures.AssetType[] memory);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "../libraries/DataStructures.sol";
/**
* @title ICrossChainBridge
* @dev Interface for LayerZero V2 cross-chain bridge integration
* @author Blocklabs Studio
*/
interface ICrossChainBridge {
// ============ EVENTS ============
/**
* @dev Emitted when a cross-chain message is sent
* @param destinationChain Target chain ID
* @param messageHash Hash of the sent message
* @param gasLimit Gas limit for execution
* @param gasUsed Actual gas used for sending
*/
event MessageSent(
uint256 indexed destinationChain,
bytes32 indexed messageHash,
uint256 gasLimit,
uint256 gasUsed
);
/**
* @dev Emitted when a cross-chain message is received
* @param sourceChain Source chain ID
* @param messageHash Hash of the received message
* @param success Whether message execution was successful
*/
event MessageReceived(
uint256 indexed sourceChain,
bytes32 indexed messageHash,
bool success
);
/**
* @dev Emitted when LayerZero endpoint is updated
* @param chainId Chain ID
* @param oldEndpoint Previous endpoint address
* @param newEndpoint New endpoint address
*/
event EndpointUpdated(
uint256 indexed chainId,
address oldEndpoint,
address newEndpoint
);
/**
* @dev Emitted when message retry is attempted
* @param messageHash Hash of the message being retried
* @param attempt Retry attempt number
*/
event MessageRetry(
bytes32 indexed messageHash,
uint256 attempt
);
// ============ CORE FUNCTIONS ============
/**
* @dev Sends a cross-chain message via LayerZero
* @param destinationChain Target chain ID
* @param payload Message payload to send
* @param gasLimit Gas limit for execution on destination
* @return messageHash Hash of the sent message
*/
function sendMessage(
uint256 destinationChain,
bytes calldata payload,
uint256 gasLimit
) external payable returns (bytes32 messageHash);
/**
* @dev Receives and processes a cross-chain message
* @param sourceChain Source chain ID
* @param payload Message payload received
* @return success Whether message processing was successful
*/
function receiveMessage(
uint256 sourceChain,
bytes calldata payload
) external returns (bool success);
/**
* @dev Estimates gas cost for cross-chain message
* @param destinationChain Target chain ID
* @param payload Message payload
* @return gasEstimate Estimated gas cost in native token
*/
function estimateGas(
uint256 destinationChain,
bytes calldata payload
) external view returns (uint256 gasEstimate);
/**
* @dev Retries a failed cross-chain message
* @param messageHash Hash of the message to retry
* @param newGasLimit New gas limit for retry
*/
function retryMessage(
bytes32 messageHash,
uint256 newGasLimit
) external payable;
// ============ CONFIGURATION FUNCTIONS ============
/**
* @dev Sets LayerZero endpoint for a specific chain
* @param chainId Chain ID
* @param endpoint LayerZero endpoint address
*/
function setLayerZeroEndpoint(uint256 chainId, address endpoint) external;
/**
* @dev Sets trusted remote for cross-chain communication
* @param chainId Remote chain ID
* @param remoteAddress Trusted remote contract address
*/
function setTrustedRemote(uint256 chainId, address remoteAddress) external;
/**
* @dev Sets default gas limit for a destination chain
* @param chainId Destination chain ID
* @param gasLimit Default gas limit
*/
function setDefaultGasLimit(uint256 chainId, uint256 gasLimit) external;
/**
* @dev Enables or disables cross-chain communication for a chain
* @param chainId Chain ID
* @param enabled Whether to enable communication
*/
function setChainEnabled(uint256 chainId, bool enabled) external;
// ============ BATCH OPERATIONS ============
/**
* @dev Sends multiple cross-chain messages in batch
* @param destinations Array of destination chain IDs
* @param payloads Array of message payloads
* @param gasLimits Array of gas limits
* @return messageHashes Array of message hashes
*/
function sendBatchMessages(
uint256[] calldata destinations,
bytes[] calldata payloads,
uint256[] calldata gasLimits
) external payable returns (bytes32[] memory messageHashes);
/**
* @dev Retries multiple failed messages in batch
* @param messageHashes Array of message hashes to retry
* @param gasLimits Array of new gas limits
*/
function retryBatchMessages(
bytes32[] calldata messageHashes,
uint256[] calldata gasLimits
) external payable;
// ============ VIEW FUNCTIONS ============
/**
* @dev Gets LayerZero endpoint for a specific chain
* @param chainId Chain ID
* @return endpoint LayerZero endpoint address
*/
function getLayerZeroEndpoint(uint256 chainId) external view returns (address endpoint);
/**
* @dev Gets trusted remote address for a chain
* @param chainId Remote chain ID
* @return remoteAddress Trusted remote contract address
*/
function getTrustedRemote(uint256 chainId) external view returns (address remoteAddress);
/**
* @dev Gets default gas limit for a destination chain
* @param chainId Destination chain ID
* @return gasLimit Default gas limit
*/
function getDefaultGasLimit(uint256 chainId) external view returns (uint256 gasLimit);
/**
* @dev Checks if cross-chain communication is enabled for a chain
* @param chainId Chain ID
* @return enabled Whether communication is enabled
*/
function isChainEnabled(uint256 chainId) external view returns (bool enabled);
/**
* @dev Gets message status and details
* @param messageHash Hash of the message
* @return status Message status (0=pending, 1=delivered, 2=failed)
* @return retryCount Number of retry attempts
* @return lastAttempt Timestamp of last attempt
*/
function getMessageStatus(bytes32 messageHash)
external
view
returns (uint8 status, uint256 retryCount, uint256 lastAttempt);
/**
* @dev Gets all supported chain IDs
* @return chainIds Array of supported chain IDs
*/
function getSupportedChains() external view returns (uint256[] memory chainIds);
/**
* @dev Checks if a message hash has been processed
* @param messageHash Hash of the message
* @return processed Whether the message has been processed
*/
function isMessageProcessed(bytes32 messageHash) external view returns (bool processed);
/**
* @dev Gets cross-chain bridge statistics
* @return totalMessagesSent Total messages sent
* @return totalMessagesReceived Total messages received
* @return totalGasUsed Total gas used for cross-chain operations
*/
function getBridgeStats()
external
view
returns (uint256 totalMessagesSent, uint256 totalMessagesReceived, uint256 totalGasUsed);
// ============ EMERGENCY FUNCTIONS ============
/**
* @dev Emergency pause of cross-chain operations
*/
function emergencyPause() external;
/**
* @dev Resume cross-chain operations after emergency pause
*/
function emergencyUnpause() external;
/**
* @dev Emergency withdrawal of stuck native tokens
* @param recipient Address to receive the tokens
* @param amount Amount to withdraw
*/
function emergencyWithdraw(address recipient, uint256 amount) external;
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "../libraries/DataStructures.sol";
/**
* @title IEscrowTrading
* @dev Main interface for the Cross-Chain NFT Trading Platform
* @author Blocklabs Studio
*/
interface IEscrowTrading {
// ============ EVENTS ============
/**
* @dev Emitted when a new offer is created
* @param offerId Unique offer identifier
* @param creator Address of the offer creator
* @param counterparty Address of specific counterparty (0x0 for open offers)
* @param chainId Chain ID where offer is created
*/
event OfferCreated(
uint256 indexed offerId,
address indexed creator,
address indexed counterparty,
uint256 chainId
);
/**
* @dev Emitted when an offer is accepted
* @param offerId Unique offer identifier
* @param acceptor Address of the offer acceptor
* @param settlementTime Timestamp when settlement will occur
*/
event OfferAccepted(
uint256 indexed offerId,
address indexed acceptor,
uint256 settlementTime
);
/**
* @dev Emitted when an offer is cancelled
* @param offerId Unique offer identifier
* @param creator Address of the offer creator
* @param timestamp Cancellation timestamp
*/
event OfferCancelled(
uint256 indexed offerId,
address indexed creator,
uint256 timestamp
);
/**
* @dev Emitted when assets are deposited into escrow
* @param offerId Associated offer identifier
* @param depositor Address of the depositor
* @param assets Array of deposited assets
*/
event AssetsDeposited(
uint256 indexed offerId,
address indexed depositor,
DataStructures.Asset[] assets
);
/**
* @dev Emitted when assets are successfully swapped
* @param offerId Unique offer identifier
* @param party1 First party in the swap
* @param party2 Second party in the swap
* @param timestamp Swap completion timestamp
*/
event AssetsSwapped(
uint256 indexed offerId,
address indexed party1,
address indexed party2,
uint256 timestamp
);
/**
* @dev Emitted when fees are collected
* @param offerId Associated offer identifier
* @param token Fee token address (0x0 for native)
* @param amount Fee amount collected
* @param recipient Fee recipient address
*/
event FeesCollected(
uint256 indexed offerId,
address indexed token,
uint256 amount,
address recipient
);
/**
* @dev Emitted when a cross-chain message is sent
* @param offerId Associated offer identifier
* @param destinationChain Target chain ID
* @param messageHash Hash of the sent message
*/
event CrossChainMessageSent(
uint256 indexed offerId,
uint256 destinationChain,
bytes32 messageHash
);
/**
* @dev Emitted when a cross-chain message is received
* @param offerId Associated offer identifier
* @param sourceChain Source chain ID
* @param messageHash Hash of the received message
*/
event CrossChainMessageReceived(
uint256 indexed offerId,
uint256 sourceChain,
bytes32 messageHash
);
// ============ SAME-CHAIN TRADING FUNCTIONS ============
/**
* @dev Creates a new same-chain trading offer
* @param offer The trade offer details
* @return offerId The unique identifier for the created offer
*/
function createSameChainOffer(DataStructures.TradeOffer calldata offer)
external
payable
returns (uint256 offerId);
/**
* @dev Accepts a same-chain trading offer
* @param offerId The unique identifier of the offer to accept
*/
function acceptSameChainOffer(uint256 offerId) external payable;
// ============ CROSS-CHAIN TRADING FUNCTIONS ============
/**
* @dev Creates a new cross-chain trading offer
* @param offer The trade offer details
* @param destinationChain The target chain for cross-chain settlement
* @return offerId The unique identifier for the created offer
*/
function createCrossChainOffer(
DataStructures.TradeOffer calldata offer,
uint256 destinationChain
) external payable returns (uint256 offerId);
/**
* @dev Accepts a cross-chain trading offer
* @param offerId The unique identifier of the offer to accept
*/
function acceptCrossChainOffer(uint256 offerId) external payable;
/**
* @dev Initiates cross-chain trade settlement
* @param offerId The unique identifier of the offer
* @param destinationChain The target chain for settlement
*/
function initiateCrossChainTrade(uint256 offerId, uint256 destinationChain) external payable;
/**
* @dev Completes cross-chain trade with proof
* @param offerId The unique identifier of the offer
* @param proof Cross-chain settlement proof
*/
function completeCrossChainTrade(uint256 offerId, bytes calldata proof) external;
// ============ GENERAL OFFER MANAGEMENT ============
/**
* @dev Cancels an existing offer
* @param offerId The unique identifier of the offer to cancel
*/
function cancelOffer(uint256 offerId) external;
/**
* @dev Creates a counter-offer for an existing offer
* @param offerId The unique identifier of the original offer
* @param newOffer The counter-offer details
* @return counterOfferId The unique identifier for the counter-offer
*/
function counterOffer(uint256 offerId, DataStructures.TradeOffer calldata newOffer)
external
payable
returns (uint256 counterOfferId);
// ============ ASSET MANAGEMENT ============
/**
* @dev Deposits assets into escrow for an offer
* @param offerId The unique identifier of the offer
* @param assets Array of assets to deposit
*/
function depositAssets(uint256 offerId, DataStructures.Asset[] calldata assets) external payable;
/**
* @dev Withdraws assets from escrow (for cancelled/expired offers)
* @param offerId The unique identifier of the offer
*/
function withdrawAssets(uint256 offerId) external;
/**
* @dev Emergency withdrawal of assets (admin only)
* @param offerId The unique identifier of the offer
* @param recipient Address to receive the assets
*/
function emergencyWithdrawAssets(uint256 offerId, address recipient) external;
// ============ BATCH OPERATIONS ============
/**
* @dev Creates multiple offers in a single transaction
* @param offers Array of trade offers to create
* @return offerIds Array of created offer identifiers
*/
function createBatchOffers(DataStructures.TradeOffer[] calldata offers)
external
payable
returns (uint256[] memory offerIds);
/**
* @dev Accepts multiple offers in a single transaction
* @param offerIds Array of offer identifiers to accept
*/
function acceptBatchOffers(uint256[] calldata offerIds) external payable;
/**
* @dev Cancels multiple offers in a single transaction
* @param offerIds Array of offer identifiers to cancel
*/
function cancelBatchOffers(uint256[] calldata offerIds) external;
// ============ VIEW FUNCTIONS ============
/**
* @dev Gets complete offer details
* @param offerId The unique identifier of the offer
* @return offer The complete offer structure
*/
function getOffer(uint256 offerId) external view returns (DataStructures.TradeOffer memory offer);
/**
* @dev Gets the current status of an offer
* @param offerId The unique identifier of the offer
* @return status The current offer status
*/
function getOfferStatus(uint256 offerId) external view returns (DataStructures.OfferStatus status);
/**
* @dev Gets all offers created by a specific user
* @param user The user address
* @return offerIds Array of offer identifiers
*/
function getUserOffers(address user) external view returns (uint256[] memory offerIds);
/**
* @dev Gets all active same-chain offers
* @return offerIds Array of same-chain offer identifiers
*/
function getSameChainOffers() external view returns (uint256[] memory offerIds);
/**
* @dev Gets all active cross-chain offers for a specific chain
* @param chainId The target chain ID
* @return offerIds Array of cross-chain offer identifiers
*/
function getCrossChainOffers(uint256 chainId) external view returns (uint256[] memory offerIds);
/**
* @dev Gets cross-chain settlement details
* @param offerId The unique identifier of the offer
* @return settlement The cross-chain settlement information
*/
function getCrossChainSettlement(uint256 offerId)
external
view
returns (DataStructures.CrossChainSettlement memory settlement);
/**
* @dev Checks if an offer is valid and can be accepted
* @param offerId The unique identifier of the offer
* @return isValid Whether the offer is valid
* @return reason Reason if offer is invalid
*/
function isOfferValid(uint256 offerId) external view returns (bool isValid, string memory reason);
/**
* @dev Estimates gas cost for cross-chain operation
* @param destinationChain The target chain ID
* @param payload The message payload
* @return gasEstimate The estimated gas cost
*/
function estimateCrossChainGas(uint256 destinationChain, bytes calldata payload)
external
view
returns (uint256 gasEstimate);
/**
* @dev Gets the next available offer ID
* @return nextOfferId The next offer identifier
*/
function getNextOfferId() external view returns (uint256 nextOfferId);
/**
* @dev Gets total number of offers created
* @return totalOffers The total number of offers
*/
function getTotalOffers() external view returns (uint256 totalOffers);
/**
* @dev Gets platform statistics
* @return totalTrades Total completed trades
* @return totalVolume Total trading volume
* @return totalFees Total fees collected
*/
function getPlatformStats()
external
view
returns (uint256 totalTrades, uint256 totalVolume, uint256 totalFees);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "../libraries/DataStructures.sol";
/**
* @title IFeeManager
* @dev Interface for platform fee management
* @author Blocklabs Studio
*/
interface IFeeManager {
// ============ EVENTS ============
event FeeConfigUpdated(uint256 indexed chainId, DataStructures.FeeConfig config);
event FeeCollected(uint256 indexed offerId, address token, uint256 amount, address recipient);
event FeeExemptionUpdated(address indexed account, bool exempt);
// ============ CORE FUNCTIONS ============
function calculateFee(uint256 chainId, uint256 tradeValue) external view returns (uint256 fee);
function collectFee(uint256 offerId, uint256 tradeValue, address feeToken) external payable;
function setFeeConfig(uint256 chainId, DataStructures.FeeConfig calldata config) external;
function setFeeExemption(address account, bool exempt) external;
// ============ VIEW FUNCTIONS ============
function getFeeConfig(uint256 chainId) external view returns (DataStructures.FeeConfig memory);
function isFeeExempt(address account) external view returns (bool);
function getTotalFeesCollected(address token) external view returns (uint256);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "../libraries/DataStructures.sol";
/**
* @title IOfferManager
* @dev Interface for trade offer lifecycle management
* @author Blocklabs Studio
*/
interface IOfferManager {
// ============ EVENTS ============
event OfferCreated(uint256 indexed offerId, address indexed creator, DataStructures.SettlementMode mode);
event OfferAccepted(uint256 indexed offerId, address indexed acceptor);
event OfferCancelled(uint256 indexed offerId, address indexed creator);
event OfferExpired(uint256 indexed offerId);
event CounterOfferCreated(uint256 indexed originalOfferId, uint256 indexed counterOfferId);
// ============ CORE FUNCTIONS ============
function createOffer(DataStructures.TradeOffer calldata offer) external returns (uint256 offerId);
function acceptOffer(uint256 offerId, address acceptor) external;
function cancelOffer(uint256 offerId, address caller) external;
function createCounterOffer(uint256 originalOfferId, DataStructures.TradeOffer calldata counterOffer) external returns (uint256 counterOfferId);
// ============ VALIDATION FUNCTIONS ============
function validateOffer(DataStructures.TradeOffer calldata offer) external view returns (bool valid, string memory reason);
function canAcceptOffer(uint256 offerId, address acceptor) external view returns (bool canAccept, string memory reason);
function isOfferExpired(uint256 offerId) external view returns (bool expired);
// ============ VIEW FUNCTIONS ============
function getOffer(uint256 offerId) external view returns (DataStructures.TradeOffer memory);
function getOffersByCreator(address creator) external view returns (uint256[] memory);
function getActiveOffers() external view returns (uint256[] memory);
function getTotalOffers() external view returns (uint256);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
import "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import "../libraries/DataStructures.sol";
import "../libraries/Errors.sol";
/**
* @title AssetLibrary
* @dev Utility library for asset handling operations
* @author Blocklabs Studio
*/
library AssetLibrary {
// ============ CONSTANTS ============
/// @dev ERC721 interface ID
bytes4 private constant INTERFACE_ID_ERC721 = 0x80ac58cd;
/// @dev ERC1155 interface ID
bytes4 private constant INTERFACE_ID_ERC1155 = 0xd9b67a26;
/// @dev ERC20 interface ID (not standard, but commonly used)
bytes4 private constant INTERFACE_ID_ERC20 = 0x36372b07;
// ============ ASSET VALIDATION FUNCTIONS ============
/**
* @dev Validates an asset structure
* @param asset The asset to validate
* @return valid Whether the asset is valid
* @return reason Reason if asset is invalid
*/
function validateAsset(DataStructures.Asset memory asset)
internal
view
returns (bool valid, string memory reason)
{
// Check for zero address on non-native assets
if (asset.assetType != DataStructures.AssetType.NATIVE && asset.tokenContract == address(0)) {
return (false, "Token contract cannot be zero address for non-native assets");
}
// Check for non-zero address on native assets
if (asset.assetType == DataStructures.AssetType.NATIVE && asset.tokenContract != address(0)) {
return (false, "Token contract must be zero address for native assets");
}
// Validate amount based on asset type
if (asset.assetType == DataStructures.AssetType.ERC721 && asset.amount != 1) {
return (false, "ERC721 assets must have amount of 1");
}
if (asset.amount == 0) {
return (false, "Asset amount cannot be zero");
}
// Validate token ID based on asset type
if (asset.assetType == DataStructures.AssetType.ERC20 && asset.tokenId != 0) {
return (false, "ERC20 assets must have tokenId of 0");
}
if (asset.assetType == DataStructures.AssetType.NATIVE && asset.tokenId != 0) {
return (false, "Native assets must have tokenId of 0");
}
// Check contract existence for non-native assets
if (asset.assetType != DataStructures.AssetType.NATIVE) {
if (!_isContract(asset.tokenContract)) {
return (false, "Token contract does not exist");
}
// Verify interface support
if (!_supportsInterface(asset.tokenContract, asset.assetType)) {
return (false, "Contract does not support expected interface");
}
}
return (true, "");
}
/**
* @dev Verifies asset ownership
* @param asset The asset to verify
* @param owner The claimed owner
* @return owned Whether the owner owns the asset
*/
function verifyOwnership(DataStructures.Asset memory asset, address owner)
internal
view
returns (bool owned)
{
if (asset.assetType == DataStructures.AssetType.ERC721) {
try IERC721(asset.tokenContract).ownerOf(asset.tokenId) returns (address tokenOwner) {
return tokenOwner == owner;
} catch {
return false;
}
} else if (asset.assetType == DataStructures.AssetType.ERC1155) {
try IERC1155(asset.tokenContract).balanceOf(owner, asset.tokenId) returns (uint256 balance) {
return balance >= asset.amount;
} catch {
return false;
}
} else if (asset.assetType == DataStructures.AssetType.ERC20) {
try IERC20(asset.tokenContract).balanceOf(owner) returns (uint256 balance) {
return balance >= asset.amount;
} catch {
return false;
}
} else if (asset.assetType == DataStructures.AssetType.NATIVE) {
return owner.balance >= asset.amount;
}
return false;
}
/**
* @dev Verifies transfer approval
* @param asset The asset to verify
* @param owner The asset owner
* @param spender The approved spender
* @return approved Whether the spender is approved
*/
function verifyApproval(DataStructures.Asset memory asset, address owner, address spender)
internal
view
returns (bool approved)
{
if (asset.assetType == DataStructures.AssetType.ERC721) {
try IERC721(asset.tokenContract).getApproved(asset.tokenId) returns (address approvedAddress) {
if (approvedAddress == spender) return true;
} catch {}
try IERC721(asset.tokenContract).isApprovedForAll(owner, spender) returns (bool isApproved) {
return isApproved;
} catch {
return false;
}
} else if (asset.assetType == DataStructures.AssetType.ERC1155) {
try IERC1155(asset.tokenContract).isApprovedForAll(owner, spender) returns (bool isApproved) {
return isApproved;
} catch {
return false;
}
} else if (asset.assetType == DataStructures.AssetType.ERC20) {
try IERC20(asset.tokenContract).allowance(owner, spender) returns (uint256 allowance) {
return allowance >= asset.amount;
} catch {
return false;
}
} else if (asset.assetType == DataStructures.AssetType.NATIVE) {
// Native assets don't require approval
return true;
}
return false;
}
// ============ ASSET TRANSFER FUNCTIONS ============
/**
* @dev Transfers an asset from one address to another
* @param asset The asset to transfer
* @param from The sender address
* @param to The recipient address
*/
function transferAsset(DataStructures.Asset memory asset, address from, address to) internal {
if (asset.assetType == DataStructures.AssetType.ERC721) {
IERC721(asset.tokenContract).safeTransferFrom(from, to, asset.tokenId);
} else if (asset.assetType == DataStructures.AssetType.ERC1155) {
IERC1155(asset.tokenContract).safeTransferFrom(from, to, asset.tokenId, asset.amount, "");
} else if (asset.assetType == DataStructures.AssetType.ERC20) {
if (from == address(this)) {
// Transfer from contract
if (!IERC20(asset.tokenContract).transfer(to, asset.amount)) {
revert CustomErrors.AssetWithdrawalFailed(asset.tokenContract, asset.tokenId, asset.amount);
}
} else {
// Transfer from user
if (!IERC20(asset.tokenContract).transferFrom(from, to, asset.amount)) {
revert CustomErrors.AssetDepositFailed(asset.tokenContract, asset.tokenId, asset.amount);
}
}
} else if (asset.assetType == DataStructures.AssetType.NATIVE) {
// Native token transfer - only transfer if not depositing to contract
if (to != address(this)) {
(bool success, ) = payable(to).call{value: asset.amount}("");
if (!success) {
revert CustomErrors.AssetWithdrawalFailed(address(0), 0, asset.amount);
}
}
// If transferring to contract (deposit), native tokens are already received via msg.value
}
}
/**
* @dev Calculates the total native token amount in an asset array
* @param assets Array of assets to check
* @return totalNativeAmount Total amount of native tokens
*/
function calculateNativeTokenAmount(DataStructures.Asset[] memory assets)
internal
pure
returns (uint256 totalNativeAmount)
{
for (uint256 i = 0; i < assets.length; i++) {
if (assets[i].assetType == DataStructures.AssetType.NATIVE) {
totalNativeAmount += assets[i].amount;
}
}
return totalNativeAmount;
}
/**
* @dev Transfers multiple assets in batch
* @param assets Array of assets to transfer
* @param from The sender address
* @param to The recipient address
*/
function transferAssetsBatch(
DataStructures.Asset[] memory assets,
address from,
address to
) internal {
for (uint256 i = 0; i < assets.length; i++) {
transferAsset(assets[i], from, to);
}
}
// ============ ASSET UTILITY FUNCTIONS ============
/**
* @dev Calculates the total value of assets (simplified - returns count for now)
* @param assets Array of assets
* @return totalValue The total value
*/
function calculateAssetValue(DataStructures.Asset[] memory assets)
internal
pure
returns (uint256 totalValue)
{
// Simplified implementation - in production, this would integrate with price oracles
return assets.length;
}
/**
* @dev Generates a hash for an asset
* @param asset The asset to hash
* @return assetHash The keccak256 hash of the asset
*/
function hashAsset(DataStructures.Asset memory asset) internal pure returns (bytes32 assetHash) {
return keccak256(abi.encode(
asset.tokenContract,
asset.tokenId,
asset.amount,
asset.assetType,
asset.chainId
));
}
/**
* @dev Generates a hash for multiple assets
* @param assets Array of assets to hash
* @return assetsHash The keccak256 hash of all assets
*/
function hashAssets(DataStructures.Asset[] memory assets)
internal
pure
returns (bytes32 assetsHash)
{
bytes32[] memory assetHashes = new bytes32[](assets.length);
for (uint256 i = 0; i < assets.length; i++) {
assetHashes[i] = hashAsset(assets[i]);
}
return keccak256(abi.encodePacked(assetHashes));
}
/**
* @dev Compares two assets for equality
* @param asset1 First asset
* @param asset2 Second asset
* @return equal Whether the assets are equal
*/
function assetsEqual(DataStructures.Asset memory asset1, DataStructures.Asset memory asset2)
internal
pure
returns (bool equal)
{
return (
asset1.tokenContract == asset2.tokenContract &&
asset1.tokenId == asset2.tokenId &&
asset1.amount == asset2.amount &&
asset1.assetType == asset2.assetType &&
asset1.chainId == asset2.chainId
);
}
// ============ PRIVATE HELPER FUNCTIONS ============
/**
* @dev Checks if an address is a contract
* @param account The address to check
* @return isContract Whether the address is a contract
*/
function _isContract(address account) private view returns (bool isContract) {
uint256 size;
assembly {
size := extcodesize(account)
}
return size > 0;
}
/**
* @dev Checks if a contract supports the expected interface for an asset type
* @param contractAddress The contract to check
* @param assetType The expected asset type
* @return supported Whether the interface is supported
*/
function _supportsInterface(address contractAddress, DataStructures.AssetType assetType)
private
view
returns (bool supported)
{
try IERC165(contractAddress).supportsInterface(_getInterfaceId(assetType)) returns (bool result) {
return result;
} catch {
// If ERC165 is not supported, try direct interface checks
return _directInterfaceCheck(contractAddress, assetType);
}
}
/**
* @dev Gets the interface ID for an asset type
* @param assetType The asset type
* @return interfaceId The interface ID
*/
function _getInterfaceId(DataStructures.AssetType assetType)
private
pure
returns (bytes4 interfaceId)
{
if (assetType == DataStructures.AssetType.ERC721) {
return INTERFACE_ID_ERC721;
} else if (assetType == DataStructures.AssetType.ERC1155) {
return INTERFACE_ID_ERC1155;
} else if (assetType == DataStructures.AssetType.ERC20) {
return INTERFACE_ID_ERC20;
}
return bytes4(0);
}
/**
* @dev Performs direct interface check when ERC165 is not available
* @param contractAddress The contract to check
* @param assetType The expected asset type
* @return supported Whether the interface is supported
*/
function _directInterfaceCheck(address contractAddress, DataStructures.AssetType assetType)
private
view
returns (bool supported)
{
if (assetType == DataStructures.AssetType.ERC721) {
try IERC721(contractAddress).balanceOf(address(this)) returns (uint256) {
return true;
} catch {
return false;
}
} else if (assetType == DataStructures.AssetType.ERC1155) {
try IERC1155(contractAddress).balanceOf(address(this), 0) returns (uint256) {
return true;
} catch {
return false;
}
} else if (assetType == DataStructures.AssetType.ERC20) {
try IERC20(contractAddress).totalSupply() returns (uint256) {
return true;
} catch {
return false;
}
}
return false;
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/**
* @title Constants
* @dev System constants for the Cross-Chain NFT Trading Platform
* @author Blocklabs Studio
*/
library Constants {
// ============ ROLE CONSTANTS ============
/// @dev Admin role - Full platform control and role management
bytes32 public constant ADMIN_ROLE = keccak256("ADMIN_ROLE");
/// @dev Project admin role - NFT project management and whitelist control
bytes32 public constant PROJECT_ADMIN_ROLE = keccak256("PROJECT_ADMIN_ROLE");
/// @dev Fee manager role - Fee configuration and collection management
bytes32 public constant FEE_MANAGER_ROLE = keccak256("FEE_MANAGER_ROLE");
/// @dev Emergency role - Pause/unpause and emergency functions
bytes32 public constant EMERGENCY_ROLE = keccak256("EMERGENCY_ROLE");
/// @dev Upgrader role - Contract upgrade authorization
bytes32 public constant UPGRADER_ROLE = keccak256("UPGRADER_ROLE");
// ============ TIME CONSTANTS ============
/// @dev Minimum offer duration (1 hour)
uint256 public constant MIN_OFFER_DURATION = 1 hours;
/// @dev Maximum offer duration (30 days)
uint256 public constant MAX_OFFER_DURATION = 30 days;
/// @dev Same-chain settlement timeout (1 hour)
uint256 public constant SAME_CHAIN_TIMEOUT = 1 hours;
/// @dev Default cross-chain settlement timeout (24 hours)
uint256 public constant CROSS_CHAIN_TIMEOUT = 24 hours;
/// @dev Maximum cross-chain settlement timeout (72 hours)
uint256 public constant MAX_CROSS_CHAIN_TIMEOUT = 72 hours;
/// @dev Minimum cross-chain settlement timeout (1 hour)
uint256 public constant MIN_CROSS_CHAIN_TIMEOUT = 1 hours;
// ============ UPGRADE TIMELOCK CONSTANTS ============
/// @dev Major upgrade timelock delay (48 hours)
uint256 public constant MAJOR_UPGRADE_DELAY = 48 hours;
/// @dev Minor upgrade timelock delay (24 hours)
uint256 public constant MINOR_UPGRADE_DELAY = 24 hours;
/// @dev Emergency upgrade delay (6 hours)
uint256 public constant EMERGENCY_UPGRADE_DELAY = 6 hours;
/// @dev Parameter change delay (12 hours)
uint256 public constant PARAMETER_CHANGE_DELAY = 12 hours;
// ============ FEE CONSTANTS ============
/// @dev Maximum platform fee (10% in basis points)
uint256 public constant MAX_PLATFORM_FEE = 1000;
/// @dev Default platform fee (2.5% in basis points)
uint256 public constant DEFAULT_PLATFORM_FEE = 250;
/// @dev Basis points denominator (100% = 10000)
uint256 public constant BASIS_POINTS = 10000;
/// @dev Maximum royalty percentage (10% in basis points)
uint256 public constant MAX_ROYALTY_PERCENT = 1000;
// ============ NETWORK-SPECIFIC MINIMUM FEES ============
/// @dev Ethereum minimum fee (0.001 ETH)
uint256 public constant ETHEREUM_MIN_FEE = 0.001 ether;
/// @dev Polygon minimum fee (1 MATIC)
uint256 public constant POLYGON_MIN_FEE = 1 ether;
/// @dev Arbitrum minimum fee (0.001 ETH)
uint256 public constant ARBITRUM_MIN_FEE = 0.001 ether;
/// @dev Optimism minimum fee (0.001 ETH)
uint256 public constant OPTIMISM_MIN_FEE = 0.001 ether;
/// @dev Base minimum fee (0.001 ETH)
uint256 public constant BASE_MIN_FEE = 0.001 ether;
/// @dev ApeChain minimum fee (1 APE)
uint256 public constant APECHAIN_MIN_FEE = 1 ether;
// ============ GAS CONSTANTS ============
/// @dev Maximum gas limit for cross-chain operations
uint256 public constant MAX_GAS_LIMIT = 500000;
/// @dev Default gas limit for cross-chain operations
uint256 public constant DEFAULT_GAS_LIMIT = 200000;
/// @dev Minimum gas limit for cross-chain operations
uint256 public constant MIN_GAS_LIMIT = 50000;
/// @dev Gas buffer for cross-chain operations (20%)
uint256 public constant GAS_BUFFER_PERCENT = 2000; // 20% in basis points
// ============ ARRAY AND BATCH LIMITS ============
/// @dev Maximum assets per offer
uint256 public constant MAX_ASSETS_PER_OFFER = 10;
/// @dev Maximum batch size for operations
uint256 public constant MAX_BATCH_SIZE = 50;
/// @dev Maximum offers per user query
uint256 public constant MAX_USER_OFFERS_QUERY = 100;
// ============ SIGNATURE CONSTANTS ============
/// @dev EIP-712 domain name
string public constant EIP712_DOMAIN_NAME = "CrossChainNFTTrading";
/// @dev EIP-712 domain version
string public constant EIP712_DOMAIN_VERSION = "1.0";
/// @dev Maximum signature validity period (1 hour)
uint256 public constant MAX_SIGNATURE_VALIDITY = 1 hours;
// ============ CHAIN ID CONSTANTS ============
/// @dev Ethereum mainnet chain ID
uint256 public constant ETHEREUM_CHAIN_ID = 1;
/// @dev Arbitrum mainnet chain ID
uint256 public constant ARBITRUM_CHAIN_ID = 42161;
/// @dev Polygon mainnet chain ID
uint256 public constant POLYGON_CHAIN_ID = 137;
/// @dev Optimism mainnet chain ID
uint256 public constant OPTIMISM_CHAIN_ID = 10;
/// @dev Base mainnet chain ID
uint256 public constant BASE_CHAIN_ID = 8453;
// ============ LAYERZERO CONSTANTS ============
/// @dev LayerZero message gas limit buffer
uint256 public constant LZ_GAS_BUFFER = 50000;
/// @dev Maximum LayerZero message payload size
uint256 public constant MAX_LZ_PAYLOAD_SIZE = 10000;
/// @dev LayerZero message retry limit
uint256 public constant LZ_RETRY_LIMIT = 3;
// ============ SECURITY CONSTANTS ============
/// @dev Maximum failed attempts before temporary ban
uint256 public constant MAX_FAILED_ATTEMPTS = 5;
/// @dev Temporary ban duration (1 hour)
uint256 public constant TEMP_BAN_DURATION = 1 hours;
/// @dev Maximum concurrent offers per user
uint256 public constant MAX_CONCURRENT_OFFERS = 20;
// ============ UPGRADE GOVERNANCE CONSTANTS ============
/// @dev Required signatures for upgrades (3 out of 5)
uint256 public constant REQUIRED_SIGNATURES = 3;
/// @dev Total number of upgrade signers
uint256 public constant TOTAL_SIGNERS = 5;
/// @dev Proposal validity period (7 days)
uint256 public constant PROPOSAL_VALIDITY_PERIOD = 7 days;
// ============ ASSET VALIDATION CONSTANTS ============
/// @dev Maximum token ID for validation (prevents overflow)
uint256 public constant MAX_TOKEN_ID = type(uint128).max;
/// @dev Maximum amount for ERC20/1155 transfers
uint256 public constant MAX_ASSET_AMOUNT = type(uint128).max;
/// @dev Zero address constant
address public constant ZERO_ADDRESS = address(0);
// ============ ERROR MESSAGES ============
/// @dev Common error messages as constants to save gas
string public constant ERROR_UNAUTHORIZED = "Unauthorized access";
string public constant ERROR_INVALID_OFFER = "Invalid offer parameters";
string public constant ERROR_EXPIRED_OFFER = "Offer has expired";
string public constant ERROR_INSUFFICIENT_BALANCE = "Insufficient balance";
string public constant ERROR_TRANSFER_FAILED = "Asset transfer failed";
string public constant ERROR_INVALID_SIGNATURE = "Invalid signature";
string public constant ERROR_ALREADY_EXECUTED = "Already executed";
string public constant ERROR_PAUSED = "Contract is paused";
string public constant ERROR_BLACKLISTED = "Address is blacklisted";
string public constant ERROR_INVALID_CHAIN = "Invalid chain ID";
string public constant ERROR_GAS_LIMIT_EXCEEDED = "Gas limit exceeded";
// ============ EVENT SIGNATURE HASHES ============
/// @dev Pre-computed event signature hashes for gas optimization
bytes32 public constant OFFER_CREATED_HASH = keccak256("OfferCreated(uint256,address,address,uint256)");
bytes32 public constant OFFER_ACCEPTED_HASH = keccak256("OfferAccepted(uint256,address,uint256)");
bytes32 public constant OFFER_CANCELLED_HASH = keccak256("OfferCancelled(uint256,address,uint256)");
bytes32 public constant ASSETS_SWAPPED_HASH = keccak256("AssetsSwapped(uint256,address,address,uint256)");
bytes32 public constant CROSS_CHAIN_MESSAGE_SENT_HASH = keccak256("CrossChainMessageSent(uint256,uint256,bytes32)");
bytes32 public constant CROSS_CHAIN_MESSAGE_RECEIVED_HASH = keccak256("CrossChainMessageReceived(uint256,uint256,bytes32)");
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "../libraries/DataStructures.sol";
import "../libraries/Constants.sol";
import "../libraries/Errors.sol";
/**
* @title CrossChainLibrary
* @dev Utility library for cross-chain operations
* @author Blocklabs Studio
*/
library CrossChainLibrary {
// ============ CONSTANTS ============
/// @dev Salt for hashlock generation
bytes32 private constant HASHLOCK_SALT = keccak256("CROSSCHAIN_HASHLOCK_SALT");
// ============ HASHLOCK/TIMELOCK FUNCTIONS ============
/**
* @dev Generates a hashlock for cross-chain atomic swaps
* @param offerId The offer identifier
* @param secret The secret value
* @param sourceChain The source chain ID
* @param destinationChain The destination chain ID
* @return hashlock The generated hashlock
*/
function generateHashlock(
uint256 offerId,
bytes32 secret,
uint256 sourceChain,
uint256 destinationChain
) internal pure returns (bytes32 hashlock) {
return keccak256(abi.encodePacked(
HASHLOCK_SALT,
offerId,
secret,
sourceChain,
destinationChain
));
}
/**
* @dev Verifies a hashlock against a secret
* @param hashlock The hashlock to verify
* @param secret The secret value
* @param offerId The offer identifier
* @param sourceChain The source chain ID
* @param destinationChain The destination chain ID
* @return isValid Whether the hashlock is valid
*/
function verifyHashlock(
bytes32 hashlock,
bytes32 secret,
uint256 offerId,
uint256 sourceChain,
uint256 destinationChain
) internal pure returns (bool isValid) {
bytes32 expectedHashlock = generateHashlock(
offerId,
secret,
sourceChain,
destinationChain
);
return hashlock == expectedHashlock;
}
/**
* @dev Calculates timelock deadline for cross-chain settlement
* @param settlementMode The settlement mode
* @param customTimeout Custom timeout (0 for default)
* @return timelock The timelock deadline timestamp
*/
function calculateTimelock(
DataStructures.SettlementMode settlementMode,
uint256 customTimeout
) internal view returns (uint256 timelock) {
uint256 timeout;
if (customTimeout > 0) {
// Use custom timeout if provided
if (customTimeout < Constants.MIN_CROSS_CHAIN_TIMEOUT) {
timeout = Constants.MIN_CROSS_CHAIN_TIMEOUT;
} else if (customTimeout > Constants.MAX_CROSS_CHAIN_TIMEOUT) {
timeout = Constants.MAX_CROSS_CHAIN_TIMEOUT;
} else {
timeout = customTimeout;
}
} else {
// Use default timeouts
if (settlementMode == DataStructures.SettlementMode.SAME_CHAIN) {
timeout = Constants.SAME_CHAIN_TIMEOUT;
} else {
timeout = Constants.CROSS_CHAIN_TIMEOUT;
}
}
return block.timestamp + timeout;
}
/**
* @dev Checks if a timelock has expired
* @param timelock The timelock timestamp
* @return expired Whether the timelock has expired
*/
function isTimelockExpired(uint256 timelock) internal view returns (bool expired) {
return block.timestamp > timelock;
}
// ============ MESSAGE ENCODING/DECODING FUNCTIONS ============
/**
* @dev Encodes a cross-chain message
* @param messageType The type of message
* @param offerId The offer identifier
* @param sender The message sender
* @param data Additional message data
* @return payload The encoded message payload
*/
function encodeMessage(
DataStructures.MessageType messageType,
uint256 offerId,
address sender,
bytes memory data
) internal view returns (bytes memory payload) {
DataStructures.CrossChainMessage memory message = DataStructures.CrossChainMessage({
messageType: messageType,
offerId: offerId,
sender: sender,
data: data,
timestamp: block.timestamp
});
return abi.encode(message);
}
/**
* @dev Decodes a cross-chain message
* @param payload The encoded message payload
* @return message The decoded cross-chain message
*/
function decodeMessage(bytes memory payload)
internal
pure
returns (DataStructures.CrossChainMessage memory message)
{
return abi.decode(payload, (DataStructures.CrossChainMessage));
}
/**
* @dev Validates a cross-chain message
* @param message The message to validate
* @param maxAge Maximum message age in seconds
* @return isValid Whether the message is valid
* @return reason Reason if message is invalid
*/
function validateMessage(
DataStructures.CrossChainMessage memory message,
uint256 maxAge
) internal view returns (bool isValid, string memory reason) {
// Check message age
if (block.timestamp > message.timestamp + maxAge) {
return (false, "Message too old");
}
// Check sender is not zero address
if (message.sender == address(0)) {
return (false, "Invalid sender address");
}
// Check offer ID is not zero
if (message.offerId == 0) {
return (false, "Invalid offer ID");
}
return (true, "");
}
// ============ GAS ESTIMATION FUNCTIONS ============
/**
* @dev Estimates gas needed for cross-chain message execution
* @param messageType The type of message
* @param dataSize Size of additional data in bytes
* @return gasEstimate The estimated gas requirement
*/
function estimateExecutionGas(
DataStructures.MessageType messageType,
uint256 dataSize
) internal pure returns (uint256 gasEstimate) {
uint256 baseGas = Constants.DEFAULT_GAS_LIMIT;
// Adjust gas based on message type
if (messageType == DataStructures.MessageType.OFFER_CREATED) {
baseGas += 50000; // Additional gas for offer processing
} else if (messageType == DataStructures.MessageType.OFFER_ACCEPTED) {
baseGas += 100000; // Additional gas for acceptance processing
} else if (messageType == DataStructures.MessageType.ASSETS_LOCKED) {
baseGas += 75000; // Additional gas for asset locking
} else if (messageType == DataStructures.MessageType.SETTLEMENT_READY) {
baseGas += 150000; // Additional gas for settlement
} else if (messageType == DataStructures.MessageType.SETTLEMENT_COMPLETE) {
baseGas += 100000; // Additional gas for completion
} else if (messageType == DataStructures.MessageType.SETTLEMENT_FAILED) {
baseGas += 125000; // Additional gas for rollback
}
// Add gas for data processing (approximate)
baseGas += dataSize * 100; // 100 gas per byte of data
// Add buffer for safety
return baseGas + (baseGas * Constants.GAS_BUFFER_PERCENT / Constants.BASIS_POINTS);
}
/**
* @dev Calculates gas price with buffer for cross-chain operations
* @param baseGasPrice The base gas price
* @return adjustedGasPrice The adjusted gas price with buffer
*/
function calculateGasPriceWithBuffer(uint256 baseGasPrice)
internal
pure
returns (uint256 adjustedGasPrice)
{
return baseGasPrice + (baseGasPrice * Constants.GAS_BUFFER_PERCENT / Constants.BASIS_POINTS);
}
// ============ CHAIN VALIDATION FUNCTIONS ============
/**
* @dev Validates if a chain ID is supported
* @param chainId The chain ID to validate
* @return isSupported Whether the chain is supported
*/
function isSupportedChain(uint256 chainId) internal view returns (bool isSupported) {
return (
chainId == Constants.ETHEREUM_CHAIN_ID ||
chainId == Constants.ARBITRUM_CHAIN_ID ||
chainId == Constants.POLYGON_CHAIN_ID ||
chainId == Constants.OPTIMISM_CHAIN_ID ||
chainId == Constants.BASE_CHAIN_ID ||
chainId == block.chainid // Current chain is always supported
);
}
/**
* @dev Gets the native token symbol for a chain
* @param chainId The chain ID
* @return symbol The native token symbol
*/
function getNativeTokenSymbol(uint256 chainId) internal pure returns (string memory symbol) {
if (chainId == Constants.ETHEREUM_CHAIN_ID) {
return "ETH";
} else if (chainId == Constants.ARBITRUM_CHAIN_ID) {
return "ETH";
} else if (chainId == Constants.POLYGON_CHAIN_ID) {
return "MATIC";
} else if (chainId == Constants.OPTIMISM_CHAIN_ID) {
return "ETH";
} else if (chainId == Constants.BASE_CHAIN_ID) {
return "ETH";
} else {
return "UNKNOWN";
}
}
/**
* @dev Gets the minimum fee for a chain
* @param chainId The chain ID
* @return minFee The minimum fee in native token
*/
function getMinimumFee(uint256 chainId) internal pure returns (uint256 minFee) {
if (chainId == Constants.ETHEREUM_CHAIN_ID) {
return Constants.ETHEREUM_MIN_FEE;
} else if (chainId == Constants.ARBITRUM_CHAIN_ID) {
return Constants.ARBITRUM_MIN_FEE;
} else if (chainId == Constants.POLYGON_CHAIN_ID) {
return Constants.POLYGON_MIN_FEE;
} else if (chainId == Constants.OPTIMISM_CHAIN_ID) {
return Constants.OPTIMISM_MIN_FEE;
} else if (chainId == Constants.BASE_CHAIN_ID) {
return Constants.BASE_MIN_FEE;
} else {
return 0.001 ether; // Default minimum fee
}
}
// ============ SETTLEMENT STATE FUNCTIONS ============
/**
* @dev Validates settlement state transition
* @param currentState The current settlement state
* @param newState The new settlement state
* @return isValid Whether the transition is valid
*/
function isValidStateTransition(
DataStructures.SettlementState currentState,
DataStructures.SettlementState newState
) internal pure returns (bool isValid) {
if (currentState == DataStructures.SettlementState.PENDING) {
return (newState == DataStructures.SettlementState.CONFIRMED ||
newState == DataStructures.SettlementState.FAILED);
} else if (currentState == DataStructures.SettlementState.CONFIRMED) {
return false; // Cannot transition from confirmed
} else if (currentState == DataStructures.SettlementState.FAILED) {
return (newState == DataStructures.SettlementState.ROLLED_BACK);
} else if (currentState == DataStructures.SettlementState.ROLLED_BACK) {
return false; // Cannot transition from rolled back
}
return false;
}
/**
* @dev Checks if a settlement state is final
* @param state The settlement state
* @return isFinal Whether the state is final
*/
function isSettlementStateFinal(DataStructures.SettlementState state)
internal
pure
returns (bool isFinal)
{
return (state == DataStructures.SettlementState.CONFIRMED ||
state == DataStructures.SettlementState.ROLLED_BACK);
}
// ============ UTILITY FUNCTIONS ============
/**
* @dev Generates a unique message hash
* @param message The cross-chain message
* @param nonce Additional nonce for uniqueness
* @return messageHash The unique message hash
*/
function generateMessageHash(
DataStructures.CrossChainMessage memory message,
uint256 nonce
) internal pure returns (bytes32 messageHash) {
return keccak256(abi.encode(message, nonce));
}
/**
* @dev Calculates retry delay based on attempt number
* @param attemptNumber The retry attempt number (1-based)
* @return delay The delay in seconds before retry
*/
function calculateRetryDelay(uint256 attemptNumber) internal pure returns (uint256 delay) {
// Exponential backoff: 2^attempt * 60 seconds, capped at 1 hour
uint256 exponentialDelay = (2 ** attemptNumber) * 60;
return exponentialDelay > 3600 ? 3600 : exponentialDelay;
}
/**
* @dev Validates cross-chain settlement parameters
* @param settlement The settlement to validate
* @return isValid Whether the settlement is valid
* @return reason Reason if settlement is invalid
*/
function validateSettlement(DataStructures.CrossChainSettlement memory settlement)
internal
view
returns (bool isValid, string memory reason)
{
// Check offer ID
if (settlement.offerId == 0) {
return (false, "Invalid offer ID");
}
// Check chain IDs
if (!isSupportedChain(settlement.sourceChain) || !isSupportedChain(settlement.destinationChain)) {
return (false, "Unsupported chain");
}
// Check timelock
if (settlement.timelock <= block.timestamp) {
return (false, "Timelock already expired");
}
// Check gas limit
if (settlement.gasLimit < Constants.MIN_GAS_LIMIT || settlement.gasLimit > Constants.MAX_GAS_LIMIT) {
return (false, "Invalid gas limit");
}
return (true, "");
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/**
* @title DataStructures
* @dev Core data structures for the Cross-Chain NFT Trading Platform
* @author Blocklabs Studio
*/
library DataStructures {
/**
* @dev Asset type enumeration
*/
enum AssetType {
ERC721, // Standard NFTs
ERC1155, // Multi-token NFTs
ERC20, // Fungible tokens
NATIVE // ETH, MATIC, APE, etc.
}
/**
* @dev Asset structure representing any tradeable asset
*/
struct Asset {
address tokenContract; // Contract address (0x0 for native)
uint256 tokenId; // For NFTs, 0 for ERC20
uint256 amount; // For ERC20/1155, 1 for ERC721
AssetType assetType; // Asset type enum
uint256 chainId; // Chain where asset exists
}
/**
* @dev Offer status enumeration
*/
enum OfferStatus {
PENDING, // Offer created, waiting for acceptance
ACCEPTED, // Offer accepted, assets locked
CANCELLED, // Offer cancelled by creator
EXPIRED, // Offer expired due to timeout
COMPLETED // Trade completed successfully
}
/**
* @dev Settlement mode enumeration
*/
enum SettlementMode {
SAME_CHAIN, // Direct atomic swap within same chain
CROSS_CHAIN // Cross-chain settlement via LayerZero
}
/**
* @dev Cross-chain settlement state enumeration
*/
enum SettlementState {
PENDING, // Settlement initiated
CONFIRMED, // Settlement confirmed on both chains
FAILED, // Settlement failed
ROLLED_BACK // Settlement rolled back due to failure
}
/**
* @dev Trade offer structure
*/
struct TradeOffer {
uint256 offerId; // Unique offer identifier
address creator; // Offer creator address
address counterparty; // Specific counterparty (0x0 for open offers)
Asset[] offeredAssets; // Assets being offered
Asset[] requestedAssets; // Assets being requested
uint256 expirationTime; // Offer expiration timestamp
uint256 sourceChainId; // Chain where offer is created
uint256 destinationChainId; // Target chain (0 for same-chain)
SettlementMode settlementMode; // Settlement type
bytes signature; // EIP-712 signature for gasless trading
OfferStatus status; // Current offer status
uint256 createdAt; // Creation timestamp
uint256 nonce; // Replay protection nonce
}
/**
* @dev Cross-chain settlement information
*/
struct CrossChainSettlement {
uint256 offerId; // Associated offer ID
bytes32 hashlock; // Hash for atomic settlement
uint256 timelock; // Settlement deadline timestamp
uint256 sourceChain; // Source chain ID
uint256 destinationChain; // Destination chain ID
SettlementState state; // Current settlement state
bytes32 messageHash; // LayerZero message hash
uint256 gasLimit; // Gas limit for cross-chain execution
address refundAddress; // Gas refund recipient
}
/**
* @dev Fee configuration structure
*/
struct FeeConfig {
uint256 platformFeePercent; // Platform fee in basis points
uint256 minimumFee; // Minimum fee in native token
address feeRecipient; // Fee collection address
bool feeEnabled; // Fee collection toggle
address preferredFeeToken; // Preferred fee token for network
}
/**
* @dev Project configuration for ERC721C integration
*/
struct ProjectConfig {
bool enforceWhitelist; // Enforce whitelist for trading
bool enforceBlacklist; // Enforce blacklist restrictions
bool useGlobalBlacklist; // Use global blacklist
uint256 royaltyPercent; // Creator royalty percentage
address royaltyRecipient; // Royalty recipient address
}
/**
* @dev LayerZero message structure
*/
struct LZMessage {
uint256 destinationChain; // Target chain ID
bytes payload; // Message payload
uint256 gasLimit; // Execution gas limit
address refundAddress; // Gas refund recipient
}
/**
* @dev Cross-chain message types
*/
enum MessageType {
OFFER_CREATED, // New cross-chain offer created
OFFER_ACCEPTED, // Cross-chain offer accepted
ASSETS_LOCKED, // Assets locked in escrow
SETTLEMENT_READY, // Ready for settlement
SETTLEMENT_COMPLETE, // Settlement completed
SETTLEMENT_FAILED // Settlement failed, rollback needed
}
/**
* @dev Cross-chain message payload
*/
struct CrossChainMessage {
MessageType messageType; // Type of cross-chain message
uint256 offerId; // Associated offer ID
address sender; // Message sender
bytes data; // Additional message data
uint256 timestamp; // Message timestamp
}
/**
* @dev Upgrade proposal structure
*/
struct UpgradeProposal {
uint256 proposalId; // Unique proposal ID
address newImplementation; // New contract implementation
UpgradeType upgradeType; // Type of upgrade
string description; // Upgrade description
uint256 proposedAt; // Proposal timestamp
uint256 executionTime; // Earliest execution time
bool executed; // Execution status
bool cancelled; // Cancellation status
address[] signers; // Required signers
mapping(address => bool) signatures; // Collected signatures
}
/**
* @dev Upgrade type enumeration
*/
enum UpgradeType {
MINOR_UPDATE, // Bug fixes, gas optimization
MAJOR_UPDATE, // New features, structural changes
EMERGENCY_FIX, // Critical security patches
PARAMETER_CHANGE // Fee adjustments, configuration changes
}
/**
* @dev EIP-712 domain separator structure
*/
struct EIP712Domain {
string name; // Contract name
string version; // Contract version
uint256 chainId; // Network chain ID
address verifyingContract; // Contract address
}
/**
* @dev Offer signature structure for EIP-712
*/
struct OfferSignature {
address creator; // Offer creator
uint256 nonce; // Replay protection nonce
uint256 deadline; // Signature expiration
bytes32 offerHash; // Hash of offer data
}
/**
* @dev Asset validation result
*/
struct AssetValidation {
bool isValid; // Overall validation result
bool contractExists; // Contract existence check
bool standardCompliant; // ERC standard compliance
bool ownershipVerified; // Ownership verification
bool transferAllowed; // Transfer permission check
bool notBlacklisted; // Blacklist check result
string errorMessage; // Error description if invalid
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/**
* @title Errors
* @dev Custom error definitions for the Cross-Chain NFT Trading Platform
* @author Blocklabs Studio
*/
library CustomErrors {
// ============ ACCESS CONTROL ERRORS ============
/// @dev Thrown when caller lacks required role
error UnauthorizedAccess(address caller, bytes32 requiredRole);
/// @dev Thrown when trying to grant role to zero address
error InvalidRoleRecipient(address recipient);
/// @dev Thrown when role operation fails
error RoleOperationFailed(bytes32 role, address account);
// ============ OFFER MANAGEMENT ERRORS ============
/// @dev Thrown when offer ID doesn't exist
error OfferNotFound(uint256 offerId);
/// @dev Thrown when offer has expired
error OfferExpired(uint256 offerId, uint256 expirationTime);
/// @dev Thrown when offer is not in expected status
error InvalidOfferStatus(uint256 offerId, uint8 currentStatus, uint8 expectedStatus);
/// @dev Thrown when offer creator tries to accept their own offer
error CannotAcceptOwnOffer(uint256 offerId, address creator);
/// @dev Thrown when non-counterparty tries to accept private offer
error UnauthorizedOfferAcceptance(uint256 offerId, address caller, address expectedCounterparty);
/// @dev Thrown when offer has invalid parameters
error InvalidOfferParameters(string reason);
/// @dev Thrown when offer duration is invalid
error InvalidOfferDuration(uint256 duration, uint256 minDuration, uint256 maxDuration);
/// @dev Thrown when too many assets in offer
error TooManyAssets(uint256 assetCount, uint256 maxAssets);
/// @dev Thrown when offer has no assets
error EmptyAssetArray();
// ============ ASSET VALIDATION ERRORS ============
/// @dev Thrown when asset contract doesn't exist
error AssetContractNotFound(address tokenContract);
/// @dev Thrown when asset doesn't comply with expected standard
error AssetStandardMismatch(address tokenContract, uint8 expectedStandard);
/// @dev Thrown when caller doesn't own the asset
error AssetOwnershipMismatch(address tokenContract, uint256 tokenId, address owner, address caller);
/// @dev Thrown when asset transfer is not approved
error AssetTransferNotApproved(address tokenContract, uint256 tokenId, address owner, address spender);
/// @dev Thrown when asset is blacklisted
error AssetBlacklisted(address tokenContract, uint256 tokenId);
/// @dev Thrown when asset amount is invalid
error InvalidAssetAmount(uint256 amount, uint256 minAmount, uint256 maxAmount);
/// @dev Thrown when asset type is invalid
error InvalidAssetType(uint8 assetType);
/// @dev Thrown when native asset amount doesn't match msg.value
error NativeAssetAmountMismatch(uint256 expected, uint256 actual);
// ============ CROSS-CHAIN ERRORS ============
/// @dev Thrown when chain ID is not supported
error UnsupportedChainId(uint256 chainId);
/// @dev Thrown when cross-chain message fails
error CrossChainMessageFailed(uint256 destinationChain, bytes32 messageHash);
/// @dev Thrown when LayerZero endpoint is not set
error LayerZeroEndpointNotSet(uint256 chainId);
/// @dev Thrown when cross-chain settlement times out
error CrossChainSettlementTimeout(uint256 offerId, uint256 timelock);
/// @dev Thrown when hashlock doesn't match
error HashlockMismatch(bytes32 expected, bytes32 actual);
/// @dev Thrown when cross-chain settlement is in wrong state
error InvalidSettlementState(uint256 offerId, uint8 currentState, uint8 expectedState);
/// @dev Thrown when gas limit is insufficient
error InsufficientGasLimit(uint256 provided, uint256 required);
/// @dev Thrown when cross-chain fee is insufficient
error InsufficientCrossChainFee(uint256 provided, uint256 required);
// ============ FEE MANAGEMENT ERRORS ============
/// @dev Thrown when fee percentage exceeds maximum
error FeePercentageTooHigh(uint256 feePercent, uint256 maxFeePercent);
/// @dev Thrown when fee recipient is zero address
error InvalidFeeRecipient(address recipient);
/// @dev Thrown when fee payment fails
error FeePaymentFailed(address recipient, uint256 amount);
/// @dev Thrown when insufficient fee provided
error InsufficientFee(uint256 provided, uint256 required);
/// @dev Thrown when fee token is not supported
error UnsupportedFeeToken(address token);
// ============ SIGNATURE VALIDATION ERRORS ============
/// @dev Thrown when signature is invalid
error InvalidSignature(address signer, bytes32 hash);
/// @dev Thrown when signature has expired
error SignatureExpired(uint256 deadline, uint256 currentTime);
/// @dev Thrown when nonce has already been used
error NonceAlreadyUsed(address signer, uint256 nonce);
/// @dev Thrown when signature format is invalid
error InvalidSignatureFormat();
/// @dev Thrown when domain separator is invalid
error InvalidDomainSeparator();
// ============ ESCROW ERRORS ============
/// @dev Thrown when asset deposit fails
error AssetDepositFailed(address tokenContract, uint256 tokenId, uint256 amount);
/// @dev Thrown when asset withdrawal fails
error AssetWithdrawalFailed(address tokenContract, uint256 tokenId, uint256 amount);
/// @dev Thrown when escrow balance is insufficient
error InsufficientEscrowBalance(address tokenContract, uint256 tokenId, uint256 required, uint256 available);
/// @dev Thrown when settlement fails
error SettlementFailed(uint256 offerId, string reason);
/// @dev Thrown when atomic swap fails
error AtomicSwapFailed(uint256 offerId, string reason);
// ============ UPGRADE ERRORS ============
/// @dev Thrown when upgrade proposal doesn't exist
error UpgradeProposalNotFound(uint256 proposalId);
/// @dev Thrown when upgrade proposal has expired
error UpgradeProposalExpired(uint256 proposalId, uint256 expirationTime);
/// @dev Thrown when upgrade proposal is not ready for execution
error UpgradeProposalNotReady(uint256 proposalId, uint256 executionTime);
/// @dev Thrown when insufficient signatures for upgrade
error InsufficientUpgradeSignatures(uint256 proposalId, uint256 signatures, uint256 required);
/// @dev Thrown when upgrade implementation is invalid
error InvalidUpgradeImplementation(address implementation);
/// @dev Thrown when upgrade has already been executed
error UpgradeAlreadyExecuted(uint256 proposalId);
/// @dev Thrown when upgrade rollback fails
error UpgradeRollbackFailed(uint256 proposalId, string reason);
// ============ SECURITY ERRORS ============
/// @dev Thrown when contract is paused
error ContractPaused();
/// @dev Thrown when address is blacklisted
error AddressBlacklisted(address account);
/// @dev Thrown when operation exceeds rate limit
error RateLimitExceeded(address account, uint256 attempts, uint256 limit);
/// @dev Thrown when reentrancy is detected
error ReentrancyDetected();
/// @dev Thrown when emergency stop is active
error EmergencyStopActive();
/// @dev Thrown when operation is not allowed during emergency
error OperationNotAllowedDuringEmergency();
// ============ GENERAL ERRORS ============
/// @dev Thrown when zero address is provided where not allowed
error ZeroAddressNotAllowed();
/// @dev Thrown when array lengths don't match
error ArrayLengthMismatch(uint256 length1, uint256 length2);
/// @dev Thrown when array is empty when it shouldn't be
error EmptyArray();
/// @dev Thrown when array index is out of bounds
error IndexOutOfBounds(uint256 index, uint256 length);
/// @dev Thrown when value is out of valid range
error ValueOutOfRange(uint256 value, uint256 min, uint256 max);
/// @dev Thrown when operation times out
error OperationTimeout(uint256 deadline, uint256 currentTime);
/// @dev Thrown when duplicate entry is detected
error DuplicateEntry(bytes32 key);
/// @dev Thrown when required condition is not met
error ConditionNotMet(string condition);
/// @dev Thrown when external call fails
error ExternalCallFailed(address target, bytes data);
/// @dev Thrown when initialization fails
error InitializationFailed(string reason);
/// @dev Thrown when contract is already initialized
error AlreadyInitialized();
/// @dev Thrown when function is not implemented
error NotImplemented();
/// @dev Thrown when operation is not supported
error OperationNotSupported(string operation);
// ============ PROXY ERRORS ============
/// @dev Thrown when implementation is not found
error ImplementationNotFound(string name);
/// @dev Thrown when proxy already exists
error ProxyAlreadyExists(string name);
/// @dev Thrown when proxy is not found
error ProxyNotFound(string name);
/// @dev Thrown when implementation is invalid
error InvalidImplementation(address implementation);
/// @dev Thrown when string is empty
error EmptyString();
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
import "@openzeppelin/contracts/utils/cryptography/EIP712.sol";
import "../libraries/DataStructures.sol";
import "../libraries/Constants.sol";
import "../libraries/Errors.sol";
/**
* @title SignatureLibrary
* @dev EIP-712 signature utilities for gasless trading
* @author Blocklabs Studio
*/
library SignatureLibrary {
using ECDSA for bytes32;
// ============ TYPE HASHES ============
/// @dev EIP-712 type hash for TradeOffer
bytes32 public constant TRADE_OFFER_TYPEHASH =
keccak256(
"TradeOffer(address creator,address counterparty,Asset[] offeredAssets,Asset[] requestedAssets,uint256 expirationTime,uint256 sourceChainId,uint256 destinationChainId,uint8 settlementMode,uint256 nonce)"
);
/// @dev EIP-712 type hash for Asset
bytes32 public constant ASSET_TYPEHASH =
keccak256(
"Asset(address tokenContract,uint256 tokenId,uint256 amount,uint8 assetType,uint256 chainId)"
);
/// @dev EIP-712 type hash for OfferSignature
bytes32 public constant OFFER_SIGNATURE_TYPEHASH =
keccak256(
"OfferSignature(address creator,uint256 nonce,uint256 deadline,bytes32 offerHash)"
);
// ============ DOMAIN SEPARATOR FUNCTIONS ============
/**
* @dev Builds the domain separator for EIP-712
* @param contractAddress The verifying contract address
* @param chainId The chain ID
* @return domainSeparator The EIP-712 domain separator
*/
function buildDomainSeparator(
address contractAddress,
uint256 chainId
) internal pure returns (bytes32 domainSeparator) {
return
keccak256(
abi.encode(
keccak256(
"EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"
),
keccak256(bytes(Constants.EIP712_DOMAIN_NAME)),
keccak256(bytes(Constants.EIP712_DOMAIN_VERSION)),
chainId,
contractAddress
)
);
}
// ============ HASH FUNCTIONS ============
/**
* @dev Hashes an Asset struct according to EIP-712
* @param asset The asset to hash
* @return assetHash The EIP-712 hash of the asset
*/
function hashAsset(
DataStructures.Asset memory asset
) internal pure returns (bytes32 assetHash) {
return
keccak256(
abi.encode(
ASSET_TYPEHASH,
asset.tokenContract,
asset.tokenId,
asset.amount,
uint8(asset.assetType),
asset.chainId
)
);
}
/**
* @dev Hashes an array of Assets according to EIP-712
* @param assets The assets to hash
* @return assetsHash The EIP-712 hash of the assets array
*/
function hashAssets(
DataStructures.Asset[] memory assets
) internal pure returns (bytes32 assetsHash) {
bytes32[] memory assetHashes = new bytes32[](assets.length);
for (uint256 i = 0; i < assets.length; i++) {
assetHashes[i] = hashAsset(assets[i]);
}
return keccak256(abi.encodePacked(assetHashes));
}
/**
* @dev Hashes a TradeOffer struct according to EIP-712
* @param offer The trade offer to hash
* @return offerHash The EIP-712 hash of the trade offer
*/
function hashTradeOffer(
DataStructures.TradeOffer memory offer
) internal pure returns (bytes32 offerHash) {
return
keccak256(
abi.encode(
TRADE_OFFER_TYPEHASH,
offer.creator,
offer.counterparty,
hashAssets(offer.offeredAssets),
hashAssets(offer.requestedAssets),
offer.expirationTime,
offer.sourceChainId,
offer.destinationChainId,
uint8(offer.settlementMode),
offer.nonce
)
);
}
/**
* @dev Hashes an OfferSignature struct according to EIP-712
* @param offerSig The offer signature to hash
* @return sigHash The EIP-712 hash of the offer signature
*/
function hashOfferSignature(
DataStructures.OfferSignature memory offerSig
) internal pure returns (bytes32 sigHash) {
return
keccak256(
abi.encode(
OFFER_SIGNATURE_TYPEHASH,
offerSig.creator,
offerSig.nonce,
offerSig.deadline,
offerSig.offerHash
)
);
}
// ============ SIGNATURE VERIFICATION FUNCTIONS ============
/**
* @dev Verifies an EIP-712 signature for a trade offer
* @param offer The trade offer
* @param signature The signature to verify
* @param domainSeparator The EIP-712 domain separator
* @return signer The recovered signer address
* @return isValid Whether the signature is valid
*/
function verifyOfferSignature(
DataStructures.TradeOffer memory offer,
bytes memory signature,
bytes32 domainSeparator
) internal pure returns (address signer, bool isValid) {
bytes32 offerHash = hashTradeOffer(offer);
bytes32 digest = keccak256(
abi.encodePacked("\x19\x01", domainSeparator, offerHash)
);
address recoveredSigner = digest.recover(signature);
return (
recoveredSigner,
recoveredSigner == offer.creator && recoveredSigner != address(0)
);
}
/**
* @dev Verifies an EIP-712 signature for an offer signature struct
* @param offerSig The offer signature struct
* @param signature The signature to verify
* @param domainSeparator The EIP-712 domain separator
* @return signer The recovered signer address
* @return isValid Whether the signature is valid
*/
function verifyOfferSignatureStruct(
DataStructures.OfferSignature memory offerSig,
bytes memory signature,
bytes32 domainSeparator
) internal pure returns (address signer, bool isValid) {
bytes32 sigHash = hashOfferSignature(offerSig);
bytes32 digest = keccak256(
abi.encodePacked("\x19\x01", domainSeparator, sigHash)
);
address recoveredSigner = digest.recover(signature);
return (
recoveredSigner,
recoveredSigner == offerSig.creator && recoveredSigner != address(0)
);
}
/**
* @dev Verifies a generic EIP-712 signature
* @param structHash The hash of the struct being signed
* @param signature The signature to verify
* @param domainSeparator The EIP-712 domain separator
* @param expectedSigner The expected signer address
* @return isValid Whether the signature is valid
*/
function verifySignature(
bytes32 structHash,
bytes memory signature,
bytes32 domainSeparator,
address expectedSigner
) internal pure returns (bool isValid) {
bytes32 digest = keccak256(
abi.encodePacked("\x19\x01", domainSeparator, structHash)
);
address recoveredSigner = digest.recover(signature);
return
recoveredSigner == expectedSigner && recoveredSigner != address(0);
}
// ============ SIGNATURE VALIDATION FUNCTIONS ============
/**
* @dev Validates signature format and basic properties
* @param signature The signature to validate
* @return isValid Whether the signature format is valid
*/
function validateSignatureFormat(
bytes memory signature
) internal pure returns (bool isValid) {
// Standard ECDSA signature should be 65 bytes
if (signature.length != 65) {
return false;
}
// Extract v, r, s components
bytes32 r;
bytes32 s;
uint8 v;
assembly {
r := mload(add(signature, 32))
s := mload(add(signature, 64))
v := byte(0, mload(add(signature, 96)))
}
// Validate v value (should be 27 or 28)
if (v != 27 && v != 28) {
return false;
}
// Validate r and s are not zero
if (r == 0 || s == 0) {
return false;
}
// Validate s is in lower half of curve order (EIP-2)
if (
uint256(s) >
0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0
) {
return false;
}
return true;
}
/**
* @dev Validates signature deadline
* @param deadline The signature deadline
* @return isValid Whether the deadline is valid
*/
function validateSignatureDeadline(
uint256 deadline
) internal view returns (bool isValid) {
return block.timestamp <= deadline;
}
/**
* @dev Validates signature nonce (to be used with nonce tracking)
* @param signer The signer address
* @param nonce The signature nonce
* @param usedNonces Mapping of used nonces
* @return isValid Whether the nonce is valid (not used)
*/
function validateSignatureNonce(
address signer,
uint256 nonce,
mapping(address => mapping(uint256 => bool)) storage usedNonces
) internal view returns (bool isValid) {
return !usedNonces[signer][nonce];
}
/**
* @dev Marks a signature nonce as used
* @param signer The signer address
* @param nonce The signature nonce
* @param usedNonces Mapping of used nonces
*/
function markNonceAsUsed(
address signer,
uint256 nonce,
mapping(address => mapping(uint256 => bool)) storage usedNonces
) internal {
usedNonces[signer][nonce] = true;
}
// ============ UTILITY FUNCTIONS ============
/**
* @dev Splits a signature into its r, s, v components
* @param signature The signature to split
* @return r The r component
* @return s The s component
* @return v The v component
*/
function splitSignature(
bytes memory signature
) internal pure returns (bytes32 r, bytes32 s, uint8 v) {
if (signature.length != 65) {
revert CustomErrors.InvalidSignatureFormat();
}
assembly {
r := mload(add(signature, 32))
s := mload(add(signature, 64))
v := byte(0, mload(add(signature, 96)))
}
}
/**
* @dev Combines r, s, v components into a signature
* @param r The r component
* @param s The s component
* @param v The v component
* @return signature The combined signature
*/
function combineSignature(
bytes32 r,
bytes32 s,
uint8 v
) internal pure returns (bytes memory signature) {
signature = new bytes(65);
assembly {
mstore(add(signature, 32), r)
mstore(add(signature, 64), s)
mstore8(add(signature, 96), v)
}
}
/**
* @dev Generates a message hash for signing
* @param structHash The hash of the struct being signed
* @param domainSeparator The EIP-712 domain separator
* @return messageHash The message hash for signing
*/
function getMessageHash(
bytes32 structHash,
bytes32 domainSeparator
) internal pure returns (bytes32 messageHash) {
return
keccak256(
abi.encodePacked("\x19\x01", domainSeparator, structHash)
);
}
/**
* @dev Validates a complete offer signature including all checks
* @param offer The trade offer
* @param signature The signature to validate
* @param domainSeparator The EIP-712 domain separator
* @param usedNonces Mapping of used nonces
* @return isValid Whether the signature is completely valid
* @return reason Reason if signature is invalid
*/
function validateCompleteOfferSignature(
DataStructures.TradeOffer memory offer,
bytes memory signature,
bytes32 domainSeparator,
mapping(address => mapping(uint256 => bool)) storage usedNonces
) internal view returns (bool isValid, string memory reason) {
// Check signature format
if (!validateSignatureFormat(signature)) {
return (false, "Invalid signature format");
}
// Check nonce
if (!validateSignatureNonce(offer.creator, offer.nonce, usedNonces)) {
return (false, "Nonce already used");
}
// Verify signature
(, bool sigValid) = verifyOfferSignature(
offer,
signature,
domainSeparator
);
if (!sigValid) {
return (false, "Invalid signature");
}
return (true, "");
}
}// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.28;
// Uncomment this line to use console.log
// import "hardhat/console.sol";
contract Lock {
uint public unlockTime;
address payable public owner;
event Withdrawal(uint amount, uint when);
constructor(uint _unlockTime) payable {
require(
block.timestamp < _unlockTime,
"Unlock time should be in the future"
);
unlockTime = _unlockTime;
owner = payable(msg.sender);
}
function withdraw() public {
// Uncomment this line, and the import of "hardhat/console.sol", to print a log in your terminal
// console.log("Unlock time is %o and block timestamp is %o", unlockTime, block.timestamp);
require(block.timestamp >= unlockTime, "You can't withdraw yet");
require(msg.sender == owner, "You aren't the owner");
emit Withdrawal(address(this).balance, block.timestamp);
owner.transfer(address(this).balance);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
/**
* @title MockERC20
* @dev Mock ERC20 token for testing purposes
*/
contract MockERC20 is ERC20 {
constructor(
string memory name,
string memory symbol,
uint256 initialSupply
) ERC20(name, symbol) {
_mint(msg.sender, initialSupply);
}
function mint(address to, uint256 amount) external {
_mint(to, amount);
}
function burn(address from, uint256 amount) external {
_burn(from, amount);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
/**
* @title MockERC721C
* @dev Mock ERC721C contract for testing
*/
contract MockERC721C is ERC721 {
uint8 private _transferPolicy;
mapping(address => bool) private _whitelisted;
address private _royaltyRecipient;
uint256 private _royaltyAmount;
bool private _shouldRevert;
constructor() ERC721("MockERC721C", "M721C") {
_transferPolicy = 0;
}
function setTransferPolicy(uint8 policy) external {
_transferPolicy = policy;
}
function getTransferPolicy() external view returns (uint8) {
if (_shouldRevert) {
revert("Mock revert");
}
return _transferPolicy;
}
function setWhitelisted(address operator, bool whitelisted) external {
_whitelisted[operator] = whitelisted;
}
function isWhitelisted(address operator) external view returns (bool) {
if (_shouldRevert) {
revert("Mock revert");
}
return _whitelisted[operator];
}
function setRoyaltyInfo(address recipient, uint256 amount) external {
_royaltyRecipient = recipient;
_royaltyAmount = amount;
}
function royaltyInfo(uint256, uint256) external view returns (address, uint256) {
if (_shouldRevert) {
revert("Mock revert");
}
return (_royaltyRecipient, _royaltyAmount);
}
function setShouldRevert(bool shouldRevert) external {
_shouldRevert = shouldRevert;
}
function mint(address to, uint256 tokenId) external {
_mint(to, tokenId);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/**
* @title ReentrancyAttacker
* @dev Mock contract that attempts reentrancy attacks for testing
*/
contract ReentrancyAttacker {
address private target;
bool private attacking;
constructor(address _target) {
target = _target;
}
receive() external payable {
if (!attacking) {
attacking = true;
// Attempt to call processRoyaltyPayment again
(bool success,) = target.call{value: msg.value}(
abi.encodeWithSignature(
"processRoyaltyPayment(uint256,address,uint256,uint256,address)",
1,
address(this),
123,
1 ether,
address(0)
)
);
require(success, "Reentrancy attack failed");
}
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/**
* @title ReentrancyERC721CAttacker
* @dev Mock ERC721C contract that attempts reentrancy attacks for testing
*/
contract ReentrancyERC721CAttacker {
address private target;
bool private attacking;
constructor(address _target) {
target = _target;
}
function getTransferPolicy() external returns (uint8) {
if (!attacking) {
attacking = true;
// Attempt to call whitelistTradingContract again
(bool success,) = target.call(
abi.encodeWithSignature(
"whitelistTradingContract(address)",
address(this)
)
);
require(success, "Reentrancy attack failed");
}
return 1;
}
function isWhitelisted(address) external pure returns (bool) {
return false;
}
function royaltyInfo(uint256, uint256) external pure returns (address, uint256) {
return (address(0), 0);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/**
* @title RejectingContract
* @dev Mock contract that rejects native token transfers for testing
*/
contract RejectingContract {
// This contract intentionally has no receive() or fallback() function
// so it will reject native token transfers
}// SPDX-License-Identifier: MIT pragma solidity ^0.8.28; import "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol"; import "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol"; // This file imports proxy contracts to ensure Hardhat compiles them // and their artifacts are available for Hardhat Ignition modules
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
import "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
import "../libraries/Errors.sol";
/**
* @title ProxyFactory
* @dev Factory contract for deploying and managing upgradeable proxies
* @author Blocklabs Studio
*/
contract ProxyFactory is Ownable {
// ============ STATE VARIABLES ============
/// @dev The ProxyAdmin contract that manages all proxies
ProxyAdmin public immutable proxyAdmin;
/// @dev Mapping of contract names to their implementation addresses
mapping(string => address) private _implementations;
/// @dev Mapping of contract names to their proxy addresses
mapping(string => address) private _proxies;
/// @dev Array of all deployed proxy addresses
address[] private _allProxies;
/// @dev Mapping to track if an address is a deployed proxy
mapping(address => bool) private _isProxy;
// ============ EVENTS ============
/**
* @dev Emitted when a new proxy is deployed
*/
event ProxyDeployed(
string indexed name,
address indexed proxy,
address indexed implementation
);
/**
* @dev Emitted when an implementation is registered
*/
event ImplementationRegistered(
string indexed name,
address indexed implementation
);
/**
* @dev Emitted when a proxy is upgraded
*/
event ProxyUpgraded(
address indexed proxy,
address indexed newImplementation
);
// ============ CONSTRUCTOR ============
constructor(address _owner) Ownable(_owner) {
if (_owner == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
proxyAdmin = new ProxyAdmin(_owner);
}
// ============ CORE FUNCTIONS ============
function registerImplementation(string calldata name, address implementation)
external
onlyOwner
{
if (implementation == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
if (bytes(name).length == 0) {
revert CustomErrors.EmptyString();
}
if (implementation.code.length == 0) {
revert CustomErrors.InvalidImplementation(implementation);
}
_implementations[name] = implementation;
emit ImplementationRegistered(name, implementation);
}
function deployProxy(string calldata name, bytes calldata initData)
external
onlyOwner
returns (address proxy)
{
address implementation = _implementations[name];
if (implementation == address(0)) {
revert CustomErrors.ImplementationNotFound(name);
}
if (_proxies[name] != address(0)) {
revert CustomErrors.ProxyAlreadyExists(name);
}
proxy = address(new TransparentUpgradeableProxy(
implementation,
address(proxyAdmin),
initData
));
_proxies[name] = proxy;
_allProxies.push(proxy);
_isProxy[proxy] = true;
emit ProxyDeployed(name, proxy, implementation);
return proxy;
}
function upgradeProxy(string calldata name, address newImplementation)
external
onlyOwner
{
address proxy = _proxies[name];
if (proxy == address(0)) {
revert CustomErrors.ProxyNotFound(name);
}
if (newImplementation == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
if (newImplementation.code.length == 0) {
revert CustomErrors.InvalidImplementation(newImplementation);
}
proxyAdmin.upgradeAndCall(
ITransparentUpgradeableProxy(proxy),
newImplementation,
""
);
_implementations[name] = newImplementation;
emit ProxyUpgraded(proxy, newImplementation);
}
// ============ VIEW FUNCTIONS ============
function getImplementation(string calldata name)
external
view
returns (address implementation)
{
return _implementations[name];
}
function getProxy(string calldata name)
external
view
returns (address proxy)
{
return _proxies[name];
}
function getAllProxies() external view returns (address[] memory proxies) {
return _allProxies;
}
function isProxy(address addr) external view returns (bool) {
return _isProxy[addr];
}
function version() external pure returns (string memory) {
return "1.0.0";
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import "../interfaces/IAssetVerification.sol";
import "../libraries/DataStructures.sol";
import "../libraries/AssetLibrary.sol";
import "../libraries/Constants.sol";
import "../libraries/Errors.sol";
import "../core/AccessControl.sol";
/**
* @title AssetVerification
* @dev Asset validation and verification system for the Cross-Chain NFT Trading Platform
* @author Blocklabs Studio
*/
contract AssetVerification is
Initializable,
ReentrancyGuardUpgradeable,
IAssetVerification
{
// ============ STATE VARIABLES ============
/// @dev Reference to the AccessControl contract
AccessControl public accessControl;
/// @dev Asset whitelist mapping
mapping(address => bool) private _assetWhitelist;
/// @dev Asset blacklist mapping
mapping(address => bool) private _assetBlacklist;
/// @dev Global blacklist for addresses
mapping(address => bool) private _globalBlacklist;
/// @dev Project configurations for ERC721C integration
mapping(address => DataStructures.ProjectConfig) private _projectConfigs;
/// @dev Supported asset types
DataStructures.AssetType[] private _supportedAssetTypes;
/// @dev Asset verification cache to optimize repeated checks
mapping(bytes32 => DataStructures.AssetValidation) private _verificationCache;
/// @dev Cache expiration timestamps
mapping(bytes32 => uint256) private _cacheExpirations;
/// @dev Cache duration (1 hour)
uint256 private constant CACHE_DURATION = 1 hours;
// ============ EVENTS ============
/**
* @dev Emitted when an asset is whitelisted or removed from whitelist
* @param tokenContract The token contract address
* @param whitelisted Whether the asset is whitelisted
* @param updatedBy The address that updated the whitelist
*/
event AssetWhitelisted(
address indexed tokenContract,
bool whitelisted,
address indexed updatedBy
);
/**
* @dev Emitted when an asset is blacklisted or removed from blacklist
* @param tokenContract The token contract address
* @param blacklisted Whether the asset is blacklisted
* @param updatedBy The address that updated the blacklist
*/
event AssetBlacklisted(
address indexed tokenContract,
bool blacklisted,
address indexed updatedBy
);
/**
* @dev Emitted when a project configuration is updated
* @param tokenContract The token contract address
* @param config The new project configuration
* @param updatedBy The address that updated the configuration
*/
event ProjectConfigUpdated(
address indexed tokenContract,
DataStructures.ProjectConfig config,
address indexed updatedBy
);
/**
* @dev Emitted when global blacklist is updated
* @param account The account address
* @param blacklisted Whether the account is blacklisted
* @param updatedBy The address that updated the blacklist
*/
event GlobalBlacklistUpdated(
address indexed account,
bool blacklisted,
address indexed updatedBy
);
/**
* @dev Emitted when verification cache is cleared
* @param clearedBy The address that cleared the cache
* @param timestamp The timestamp of cache clearing
*/
event VerificationCacheCleared(
address indexed clearedBy,
uint256 timestamp
);
// ============ MODIFIERS ============
/**
* @dev Modifier to check if caller has project admin role
*/
modifier onlyProjectAdmin() {
if (!accessControl.hasRole(Constants.PROJECT_ADMIN_ROLE, msg.sender) &&
!accessControl.hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.PROJECT_ADMIN_ROLE);
}
_;
}
/**
* @dev Modifier to check if caller has admin role
*/
modifier onlyAdmin() {
if (!accessControl.hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.ADMIN_ROLE);
}
_;
}
/**
* @dev Modifier to ensure contract is not paused
*/
modifier whenNotPaused() {
if (accessControl.paused()) {
revert CustomErrors.ContractPaused();
}
_;
}
// ============ INITIALIZATION ============
/**
* @dev Initializes the AssetVerification contract
* @param _accessControl Address of the AccessControl contract
*/
function initialize(address _accessControl) public initializer {
if (_accessControl == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
__ReentrancyGuard_init();
accessControl = AccessControl(_accessControl);
// Initialize supported asset types
_supportedAssetTypes.push(DataStructures.AssetType.ERC721);
_supportedAssetTypes.push(DataStructures.AssetType.ERC1155);
_supportedAssetTypes.push(DataStructures.AssetType.ERC20);
_supportedAssetTypes.push(DataStructures.AssetType.NATIVE);
}
// ============ CORE VERIFICATION FUNCTIONS ============
/**
* @dev Verifies an asset comprehensively
* @param asset The asset to verify
* @param owner The claimed owner of the asset
* @return validation The complete asset validation result
*/
function verifyAsset(DataStructures.Asset calldata asset, address owner)
external
view
override
returns (DataStructures.AssetValidation memory validation)
{
// Generate cache key
bytes32 cacheKey = _generateCacheKey(asset, owner);
// Check cache first
if (_isCacheValid(cacheKey)) {
return _verificationCache[cacheKey];
}
// Perform comprehensive verification
validation = _performAssetVerification(asset, owner);
return validation;
}
/**
* @dev Verifies asset ownership
* @param asset The asset to verify
* @param owner The claimed owner
* @return owned Whether the owner owns the asset
*/
function verifyAssetOwnership(DataStructures.Asset calldata asset, address owner)
external
view
override
returns (bool owned)
{
return AssetLibrary.verifyOwnership(asset, owner);
}
/**
* @dev Verifies asset transferability
* @param asset The asset to verify
* @param from The sender address
* @param to The recipient address
* @return transferable Whether the asset can be transferred
*/
function verifyAssetTransferability(DataStructures.Asset calldata asset, address from, address to)
external
view
override
returns (bool transferable)
{
// Check basic asset validation
(bool valid, ) = AssetLibrary.validateAsset(asset);
if (!valid) {
return false;
}
// Check blacklist status
if (_isBlacklisted(asset.tokenContract) || _globalBlacklist[from] || _globalBlacklist[to]) {
return false;
}
// Check project-specific restrictions
DataStructures.ProjectConfig memory config = _projectConfigs[asset.tokenContract];
if (config.enforceBlacklist && (_globalBlacklist[from] || _globalBlacklist[to])) {
return false;
}
if (config.enforceWhitelist && !_assetWhitelist[asset.tokenContract]) {
return false;
}
// Check approval status
return AssetLibrary.verifyApproval(asset, from, to);
}
// ============ WHITELIST/BLACKLIST FUNCTIONS ============
/**
* @dev Sets asset whitelist status
* @param tokenContract The token contract address
* @param whitelisted Whether the asset should be whitelisted
*/
function setAssetWhitelist(address tokenContract, bool whitelisted)
external
override
onlyProjectAdmin
nonReentrant
whenNotPaused
{
if (tokenContract == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_assetWhitelist[tokenContract] = whitelisted;
// Clear related cache entries
_clearAssetCache(tokenContract);
emit AssetWhitelisted(tokenContract, whitelisted, msg.sender);
}
/**
* @dev Sets asset blacklist status
* @param tokenContract The token contract address
* @param blacklisted Whether the asset should be blacklisted
*/
function setAssetBlacklist(address tokenContract, bool blacklisted)
external
override
onlyProjectAdmin
nonReentrant
whenNotPaused
{
if (tokenContract == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_assetBlacklist[tokenContract] = blacklisted;
// Clear related cache entries
_clearAssetCache(tokenContract);
emit AssetBlacklisted(tokenContract, blacklisted, msg.sender);
}
/**
* @dev Sets global blacklist status for an address
* @param account The account address
* @param blacklisted Whether the account should be blacklisted
*/
function setGlobalBlacklist(address account, bool blacklisted)
external
onlyAdmin
nonReentrant
whenNotPaused
{
if (account == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_globalBlacklist[account] = blacklisted;
emit GlobalBlacklistUpdated(account, blacklisted, msg.sender);
}
/**
* @dev Sets project configuration
* @param tokenContract The token contract address
* @param config The project configuration
*/
function setProjectConfig(address tokenContract, DataStructures.ProjectConfig calldata config)
external
override
onlyProjectAdmin
nonReentrant
whenNotPaused
{
if (tokenContract == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
if (config.royaltyPercent > Constants.MAX_ROYALTY_PERCENT) {
revert CustomErrors.FeePercentageTooHigh(config.royaltyPercent, Constants.MAX_ROYALTY_PERCENT);
}
_projectConfigs[tokenContract] = config;
// Clear related cache entries
_clearAssetCache(tokenContract);
emit ProjectConfigUpdated(tokenContract, config, msg.sender);
}
// ============ BATCH OPERATIONS ============
/**
* @dev Batch sets whitelist status for multiple assets
* @param tokenContracts Array of token contract addresses
* @param whitelisted Array of whitelist statuses
*/
function batchSetAssetWhitelist(
address[] calldata tokenContracts,
bool[] calldata whitelisted
) external onlyProjectAdmin nonReentrant whenNotPaused {
if (tokenContracts.length != whitelisted.length) {
revert CustomErrors.ArrayLengthMismatch(tokenContracts.length, whitelisted.length);
}
if (tokenContracts.length == 0) {
revert CustomErrors.EmptyArray();
}
for (uint256 i = 0; i < tokenContracts.length; i++) {
if (tokenContracts[i] == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_assetWhitelist[tokenContracts[i]] = whitelisted[i];
_clearAssetCache(tokenContracts[i]);
emit AssetWhitelisted(tokenContracts[i], whitelisted[i], msg.sender);
}
}
/**
* @dev Batch sets blacklist status for multiple assets
* @param tokenContracts Array of token contract addresses
* @param blacklisted Array of blacklist statuses
*/
function batchSetAssetBlacklist(
address[] calldata tokenContracts,
bool[] calldata blacklisted
) external onlyProjectAdmin nonReentrant whenNotPaused {
if (tokenContracts.length != blacklisted.length) {
revert CustomErrors.ArrayLengthMismatch(tokenContracts.length, blacklisted.length);
}
if (tokenContracts.length == 0) {
revert CustomErrors.EmptyArray();
}
for (uint256 i = 0; i < tokenContracts.length; i++) {
if (tokenContracts[i] == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_assetBlacklist[tokenContracts[i]] = blacklisted[i];
_clearAssetCache(tokenContracts[i]);
emit AssetBlacklisted(tokenContracts[i], blacklisted[i], msg.sender);
}
}
// ============ VIEW FUNCTIONS ============
/**
* @dev Checks if an asset is whitelisted
* @param tokenContract The token contract address
* @return whitelisted Whether the asset is whitelisted
*/
function isAssetWhitelisted(address tokenContract)
external
view
override
returns (bool whitelisted)
{
return _assetWhitelist[tokenContract];
}
/**
* @dev Checks if an asset is blacklisted
* @param tokenContract The token contract address
* @return blacklisted Whether the asset is blacklisted
*/
function isAssetBlacklisted(address tokenContract)
external
view
override
returns (bool blacklisted)
{
return _isBlacklisted(tokenContract);
}
/**
* @dev Gets project configuration for a token contract
* @param tokenContract The token contract address
* @return config The project configuration
*/
function getProjectConfig(address tokenContract)
external
view
override
returns (DataStructures.ProjectConfig memory config)
{
return _projectConfigs[tokenContract];
}
/**
* @dev Gets supported asset types
* @return assetTypes Array of supported asset types
*/
function getSupportedAssetTypes()
external
view
override
returns (DataStructures.AssetType[] memory assetTypes)
{
return _supportedAssetTypes;
}
/**
* @dev Checks if an address is globally blacklisted
* @param account The account address
* @return blacklisted Whether the account is globally blacklisted
*/
function isGloballyBlacklisted(address account) external view returns (bool blacklisted) {
return _globalBlacklist[account];
}
// ============ CACHE MANAGEMENT ============
/**
* @dev Clears the verification cache
*/
function clearVerificationCache() external onlyAdmin nonReentrant {
// Note: In a production environment, you might want to implement
// a more efficient cache clearing mechanism
emit VerificationCacheCleared(msg.sender, block.timestamp);
}
/**
* @dev Updates verification cache for an asset
* @param asset The asset to cache
* @param owner The asset owner
* @param validation The validation result
*/
function updateVerificationCache(
DataStructures.Asset calldata asset,
address owner,
DataStructures.AssetValidation calldata validation
) external onlyProjectAdmin nonReentrant {
bytes32 cacheKey = _generateCacheKey(asset, owner);
_verificationCache[cacheKey] = validation;
_cacheExpirations[cacheKey] = block.timestamp + CACHE_DURATION;
}
// ============ INTERNAL FUNCTIONS ============
/**
* @dev Performs comprehensive asset verification
* @param asset The asset to verify
* @param owner The claimed owner
* @return validation The validation result
*/
function _performAssetVerification(DataStructures.Asset memory asset, address owner)
internal
view
returns (DataStructures.AssetValidation memory validation)
{
// Initialize validation result
validation.isValid = true;
validation.contractExists = true;
validation.standardCompliant = true;
validation.ownershipVerified = true;
validation.transferAllowed = true;
validation.notBlacklisted = true;
validation.errorMessage = "";
// Basic asset structure validation
(bool structValid, string memory structError) = AssetLibrary.validateAsset(asset);
if (!structValid) {
validation.isValid = false;
validation.errorMessage = structError;
return validation;
}
// Check blacklist status
if (_isBlacklisted(asset.tokenContract)) {
validation.isValid = false;
validation.notBlacklisted = false;
validation.errorMessage = "Asset is blacklisted";
return validation;
}
// Check global blacklist for owner
if (_globalBlacklist[owner]) {
validation.isValid = false;
validation.notBlacklisted = false;
validation.errorMessage = "Owner is globally blacklisted";
return validation;
}
// Verify ownership
if (!AssetLibrary.verifyOwnership(asset, owner)) {
validation.isValid = false;
validation.ownershipVerified = false;
validation.errorMessage = "Ownership verification failed";
return validation;
}
// Check project-specific configurations
DataStructures.ProjectConfig memory config = _projectConfigs[asset.tokenContract];
if (config.enforceWhitelist && !_assetWhitelist[asset.tokenContract]) {
validation.isValid = false;
validation.errorMessage = "Asset not whitelisted";
return validation;
}
return validation;
}
/**
* @dev Checks if an asset is blacklisted (including global blacklist)
* @param tokenContract The token contract address
* @return blacklisted Whether the asset is blacklisted
*/
function _isBlacklisted(address tokenContract) internal view returns (bool blacklisted) {
return _assetBlacklist[tokenContract] || _globalBlacklist[tokenContract];
}
/**
* @dev Generates a cache key for asset verification
* @param asset The asset
* @param owner The owner address
* @return cacheKey The generated cache key
*/
function _generateCacheKey(DataStructures.Asset memory asset, address owner)
internal
pure
returns (bytes32 cacheKey)
{
return keccak256(abi.encode(asset, owner));
}
/**
* @dev Checks if a cache entry is valid
* @param cacheKey The cache key
* @return valid Whether the cache entry is valid
*/
function _isCacheValid(bytes32 cacheKey) internal view returns (bool valid) {
return _cacheExpirations[cacheKey] > block.timestamp;
}
/**
* @dev Clears cache entries for a specific asset contract
* @param tokenContract The token contract address
*/
function _clearAssetCache(address tokenContract) internal {
// Note: In a production environment, you might want to implement
// a more efficient cache clearing mechanism that tracks cache keys
// by token contract for easier clearing
}
/**
* @dev Returns the version of the contract
* @return version The contract version
*/
function version() external pure returns (string memory) {
return "1.0.0";
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/utils/PausableUpgradeable.sol";
import "../libraries/DataStructures.sol";
import "../libraries/Constants.sol";
import "../libraries/Errors.sol";
import "../core/AccessControl.sol";
/**
* @title SecurityManager
* @dev Comprehensive security features including reentrancy protection, pausable functionality, and blacklist management
* @author Blocklabs Studio
*/
contract SecurityManager is
Initializable,
ReentrancyGuardUpgradeable,
PausableUpgradeable
{
// ============ STATE VARIABLES ============
/// @dev Reference to the AccessControl contract
AccessControl public accessControl;
/// @dev Mapping of blacklisted addresses
mapping(address => bool) private _blacklisted;
/// @dev Mapping of whitelisted addresses (bypass certain restrictions)
mapping(address => bool) private _whitelisted;
/// @dev Mapping to track rate limiting per address
mapping(address => RateLimit) private _rateLimits;
/// @dev Mapping to track emergency stops per contract
mapping(address => bool) private _emergencyStops;
/// @dev Global emergency stop flag
bool private _globalEmergencyStop;
/// @dev Circuit breaker thresholds
mapping(bytes32 => CircuitBreaker) private _circuitBreakers;
/// @dev Security events log
SecurityEvent[] private _securityEvents;
/// @dev Maximum number of security events to store
uint256 public constant MAX_SECURITY_EVENTS = 10000;
// ============ STRUCTS ============
struct RateLimit {
uint256 count; // Current count
uint256 lastReset; // Last reset timestamp
uint256 limit; // Rate limit threshold
uint256 window; // Time window in seconds
bool enabled; // Whether rate limiting is enabled
}
struct CircuitBreaker {
uint256 failureCount; // Number of failures
uint256 threshold; // Failure threshold
uint256 lastFailure; // Last failure timestamp
uint256 cooldown; // Cooldown period in seconds
bool tripped; // Whether circuit breaker is tripped
bool enabled; // Whether circuit breaker is enabled
}
struct SecurityEvent {
address account; // Account involved
bytes32 eventType; // Type of security event
uint256 timestamp; // Event timestamp
bytes data; // Additional event data
uint256 severity; // Event severity (1-5)
}
// ============ EVENTS ============
/**
* @dev Emitted when an address is blacklisted
* @param account The blacklisted address
* @param blacklisted Whether the address is blacklisted
* @param reason The reason for blacklisting
* @param blacklistedBy The address that performed the blacklisting
*/
event AddressBlacklisted(
address indexed account,
bool blacklisted,
string reason,
address indexed blacklistedBy
);
/**
* @dev Emitted when an address is whitelisted
* @param account The whitelisted address
* @param whitelisted Whether the address is whitelisted
* @param whitelistedBy The address that performed the whitelisting
*/
event AddressWhitelisted(
address indexed account,
bool whitelisted,
address indexed whitelistedBy
);
/**
* @dev Emitted when rate limit is exceeded
* @param account The account that exceeded the limit
* @param attempts The number of attempts
* @param limit The rate limit
* @param window The time window
*/
event RateLimitExceeded(
address indexed account,
uint256 attempts,
uint256 limit,
uint256 window
);
/**
* @dev Emitted when emergency stop is triggered
* @param contract_ The contract address (0x0 for global)
* @param stopped Whether emergency stop is active
* @param triggeredBy The address that triggered the stop
* @param reason The reason for emergency stop
*/
event EmergencyStopTriggered(
address indexed contract_,
bool stopped,
address indexed triggeredBy,
string reason
);
/**
* @dev Emitted when circuit breaker is tripped
* @param operation The operation that tripped the breaker
* @param failureCount The number of failures
* @param threshold The failure threshold
* @param cooldown The cooldown period
*/
event CircuitBreakerTripped(
bytes32 indexed operation,
uint256 failureCount,
uint256 threshold,
uint256 cooldown
);
/**
* @dev Emitted when a security event is logged
* @param account The account involved
* @param eventType The type of security event
* @param severity The event severity
* @param timestamp The event timestamp
*/
event SecurityEventLogged(
address indexed account,
bytes32 indexed eventType,
uint256 severity,
uint256 timestamp
);
// ============ MODIFIERS ============
/**
* @dev Modifier to check if caller has emergency role
*/
modifier onlyEmergency() {
if (!accessControl.hasRole(Constants.EMERGENCY_ROLE, msg.sender) &&
!accessControl.hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.EMERGENCY_ROLE);
}
_;
}
/**
* @dev Modifier to check if caller has project admin role
*/
modifier onlyProjectAdmin() {
if (!accessControl.hasRole(Constants.PROJECT_ADMIN_ROLE, msg.sender) &&
!accessControl.hasRole(Constants.ADMIN_ROLE, msg.sender)) {
revert CustomErrors.UnauthorizedAccess(msg.sender, Constants.PROJECT_ADMIN_ROLE);
}
_;
}
/**
* @dev Modifier to check if address is not blacklisted
*/
modifier notBlacklisted(address account) {
if (_blacklisted[account] && !_whitelisted[account]) {
revert CustomErrors.AddressBlacklisted(account);
}
_;
}
/**
* @dev Modifier to check rate limits
*/
modifier rateLimited(address account) {
_checkRateLimit(account);
_;
}
/**
* @dev Modifier to check if emergency stop is not active
*/
modifier notInEmergency() {
if (_globalEmergencyStop) {
revert CustomErrors.EmergencyStopActive();
}
_;
}
/**
* @dev Modifier to check circuit breaker
*/
modifier circuitBreakerCheck(bytes32 operation) {
_checkCircuitBreaker(operation);
_;
}
// ============ INITIALIZATION ============
/**
* @dev Initializes the SecurityManager contract
* @param _accessControl Address of the AccessControl contract
*/
function initialize(address _accessControl) public initializer {
if (_accessControl == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
__ReentrancyGuard_init();
__Pausable_init();
accessControl = AccessControl(_accessControl);
}
// ============ BLACKLIST MANAGEMENT ============
/**
* @dev Blacklists an address
* @param account The address to blacklist
* @param reason The reason for blacklisting
*/
function blacklistAddress(address account, string calldata reason)
external
onlyProjectAdmin
nonReentrant
{
if (account == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_blacklisted[account] = true;
// Log security event
_logSecurityEvent(
account,
keccak256("BLACKLISTED"),
abi.encode(reason),
4 // High severity
);
emit AddressBlacklisted(account, true, reason, msg.sender);
}
/**
* @dev Removes an address from blacklist
* @param account The address to remove from blacklist
*/
function removeFromBlacklist(address account)
external
onlyProjectAdmin
nonReentrant
{
if (account == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_blacklisted[account] = false;
// Log security event
_logSecurityEvent(
account,
keccak256("BLACKLIST_REMOVED"),
abi.encode("Removed from blacklist"),
2 // Medium severity
);
emit AddressBlacklisted(account, false, "Removed from blacklist", msg.sender);
}
/**
* @dev Whitelists an address (bypasses blacklist)
* @param account The address to whitelist
*/
function whitelistAddress(address account)
external
onlyProjectAdmin
nonReentrant
{
if (account == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_whitelisted[account] = true;
emit AddressWhitelisted(account, true, msg.sender);
}
/**
* @dev Removes an address from whitelist
* @param account The address to remove from whitelist
*/
function removeFromWhitelist(address account)
external
onlyProjectAdmin
nonReentrant
{
if (account == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_whitelisted[account] = false;
emit AddressWhitelisted(account, false, msg.sender);
}
/**
* @dev Batch blacklists multiple addresses
* @param accounts Array of addresses to blacklist
* @param reasons Array of reasons for blacklisting
*/
function batchBlacklistAddresses(
address[] calldata accounts,
string[] calldata reasons
) external onlyProjectAdmin nonReentrant {
if (accounts.length != reasons.length) {
revert CustomErrors.ArrayLengthMismatch(accounts.length, reasons.length);
}
if (accounts.length == 0) {
revert CustomErrors.EmptyArray();
}
for (uint256 i = 0; i < accounts.length; i++) {
if (accounts[i] == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_blacklisted[accounts[i]] = true;
// Log security event
_logSecurityEvent(
accounts[i],
keccak256("BLACKLISTED"),
abi.encode(reasons[i]),
4 // High severity
);
emit AddressBlacklisted(accounts[i], true, reasons[i], msg.sender);
}
}
// ============ RATE LIMITING ============
/**
* @dev Sets rate limit for an address
* @param account The address to set rate limit for
* @param limit The rate limit threshold
* @param window The time window in seconds
*/
function setRateLimit(address account, uint256 limit, uint256 window)
external
onlyProjectAdmin
nonReentrant
{
if (account == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
if (limit == 0 || window == 0) {
revert CustomErrors.ValueOutOfRange(limit == 0 ? limit : window, 1, type(uint256).max);
}
_rateLimits[account] = RateLimit({
count: 0,
lastReset: block.timestamp,
limit: limit,
window: window,
enabled: true
});
}
/**
* @dev Disables rate limiting for an address
* @param account The address to disable rate limiting for
*/
function disableRateLimit(address account)
external
onlyProjectAdmin
nonReentrant
{
if (account == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_rateLimits[account].enabled = false;
}
// ============ EMERGENCY CONTROLS ============
/**
* @dev Triggers global emergency stop
* @param reason The reason for emergency stop
*/
function triggerGlobalEmergencyStop(string calldata reason)
external
onlyEmergency
nonReentrant
{
_globalEmergencyStop = true;
// Log security event
_logSecurityEvent(
msg.sender,
keccak256("GLOBAL_EMERGENCY_STOP"),
abi.encode(reason),
5 // Critical severity
);
emit EmergencyStopTriggered(address(0), true, msg.sender, reason);
}
/**
* @dev Lifts global emergency stop
*/
function liftGlobalEmergencyStop()
external
onlyEmergency
nonReentrant
{
_globalEmergencyStop = false;
// Log security event
_logSecurityEvent(
msg.sender,
keccak256("GLOBAL_EMERGENCY_STOP_LIFTED"),
abi.encode("Emergency stop lifted"),
3 // Medium-high severity
);
emit EmergencyStopTriggered(address(0), false, msg.sender, "Emergency stop lifted");
}
/**
* @dev Triggers emergency stop for a specific contract
* @param contract_ The contract address
* @param reason The reason for emergency stop
*/
function triggerContractEmergencyStop(address contract_, string calldata reason)
external
onlyEmergency
nonReentrant
{
if (contract_ == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_emergencyStops[contract_] = true;
// Log security event
_logSecurityEvent(
contract_,
keccak256("CONTRACT_EMERGENCY_STOP"),
abi.encode(reason),
4 // High severity
);
emit EmergencyStopTriggered(contract_, true, msg.sender, reason);
}
/**
* @dev Lifts emergency stop for a specific contract
* @param contract_ The contract address
*/
function liftContractEmergencyStop(address contract_)
external
onlyEmergency
nonReentrant
{
if (contract_ == address(0)) {
revert CustomErrors.ZeroAddressNotAllowed();
}
_emergencyStops[contract_] = false;
// Log security event
_logSecurityEvent(
contract_,
keccak256("CONTRACT_EMERGENCY_STOP_LIFTED"),
abi.encode("Contract emergency stop lifted"),
3 // Medium-high severity
);
emit EmergencyStopTriggered(contract_, false, msg.sender, "Contract emergency stop lifted");
}
/**
* @dev Pauses the contract
*/
function pause() external onlyEmergency {
_pause();
// Log security event
_logSecurityEvent(
msg.sender,
keccak256("CONTRACT_PAUSED"),
abi.encode("Contract paused"),
4 // High severity
);
}
/**
* @dev Unpauses the contract
*/
function unpause() external onlyEmergency {
_unpause();
// Log security event
_logSecurityEvent(
msg.sender,
keccak256("CONTRACT_UNPAUSED"),
abi.encode("Contract unpaused"),
3 // Medium-high severity
);
}
// ============ CIRCUIT BREAKER ============
/**
* @dev Sets up a circuit breaker for an operation
* @param operation The operation identifier
* @param threshold The failure threshold
* @param cooldown The cooldown period in seconds
*/
function setupCircuitBreaker(
bytes32 operation,
uint256 threshold,
uint256 cooldown
) external onlyProjectAdmin nonReentrant {
if (threshold == 0 || cooldown == 0) {
revert CustomErrors.ValueOutOfRange(threshold == 0 ? threshold : cooldown, 1, type(uint256).max);
}
_circuitBreakers[operation] = CircuitBreaker({
failureCount: 0,
threshold: threshold,
lastFailure: 0,
cooldown: cooldown,
tripped: false,
enabled: true
});
}
/**
* @dev Records a failure for circuit breaker tracking
* @param operation The operation identifier
*/
function recordFailure(bytes32 operation)
external
nonReentrant
{
CircuitBreaker storage breaker = _circuitBreakers[operation];
if (!breaker.enabled) {
return;
}
breaker.failureCount++;
breaker.lastFailure = block.timestamp;
if (breaker.failureCount >= breaker.threshold && !breaker.tripped) {
breaker.tripped = true;
// Log security event
_logSecurityEvent(
msg.sender,
keccak256("CIRCUIT_BREAKER_TRIPPED"),
abi.encode(operation),
4 // High severity
);
emit CircuitBreakerTripped(
operation,
breaker.failureCount,
breaker.threshold,
breaker.cooldown
);
}
}
/**
* @dev Resets a circuit breaker
* @param operation The operation identifier
*/
function resetCircuitBreaker(bytes32 operation)
external
onlyProjectAdmin
nonReentrant
{
CircuitBreaker storage breaker = _circuitBreakers[operation];
breaker.failureCount = 0;
breaker.tripped = false;
breaker.lastFailure = 0;
}
// ============ VIEW FUNCTIONS ============
/**
* @dev Checks if an address is blacklisted
* @param account The address to check
* @return blacklisted Whether the address is blacklisted
*/
function isBlacklisted(address account) external view returns (bool blacklisted) {
return _blacklisted[account] && !_whitelisted[account];
}
/**
* @dev Checks if an address is whitelisted
* @param account The address to check
* @return whitelisted Whether the address is whitelisted
*/
function isWhitelisted(address account) external view returns (bool whitelisted) {
return _whitelisted[account];
}
/**
* @dev Gets rate limit information for an address
* @param account The address to check
* @return rateLimit The rate limit information
*/
function getRateLimit(address account) external view returns (RateLimit memory rateLimit) {
return _rateLimits[account];
}
/**
* @dev Checks if global emergency stop is active
* @return active Whether global emergency stop is active
*/
function isGlobalEmergencyStopActive() external view returns (bool active) {
return _globalEmergencyStop;
}
/**
* @dev Checks if contract emergency stop is active
* @param contract_ The contract address
* @return active Whether contract emergency stop is active
*/
function isContractEmergencyStopActive(address contract_) external view returns (bool active) {
return _emergencyStops[contract_];
}
/**
* @dev Gets circuit breaker information
* @param operation The operation identifier
* @return breaker The circuit breaker information
*/
function getCircuitBreaker(bytes32 operation) external view returns (CircuitBreaker memory breaker) {
return _circuitBreakers[operation];
}
/**
* @dev Gets recent security events
* @param count The number of events to retrieve
* @return events Array of recent security events
*/
function getRecentSecurityEvents(uint256 count)
external
view
returns (SecurityEvent[] memory events)
{
uint256 totalEvents = _securityEvents.length;
if (totalEvents == 0) {
return new SecurityEvent[](0);
}
uint256 returnCount = count > totalEvents ? totalEvents : count;
events = new SecurityEvent[](returnCount);
for (uint256 i = 0; i < returnCount; i++) {
events[i] = _securityEvents[totalEvents - 1 - i];
}
return events;
}
/**
* @dev Gets security statistics
* @return totalBlacklisted Total blacklisted addresses
* @return totalWhitelisted Total whitelisted addresses
* @return totalSecurityEvents Total security events logged
* @return globalEmergencyActive Whether global emergency is active
*/
function getSecurityStats()
external
view
returns (
uint256 totalBlacklisted,
uint256 totalWhitelisted,
uint256 totalSecurityEvents,
bool globalEmergencyActive
)
{
// Note: These would need separate tracking in production
totalBlacklisted = 0;
totalWhitelisted = 0;
totalSecurityEvents = _securityEvents.length;
globalEmergencyActive = _globalEmergencyStop;
}
// ============ INTERNAL FUNCTIONS ============
/**
* @dev Checks rate limit for an address
* @param account The address to check
*/
function _checkRateLimit(address account) internal {
RateLimit storage rateLimit = _rateLimits[account];
if (!rateLimit.enabled || _whitelisted[account]) {
return;
}
// Reset counter if window has passed
if (block.timestamp >= rateLimit.lastReset + rateLimit.window) {
rateLimit.count = 0;
rateLimit.lastReset = block.timestamp;
}
rateLimit.count++;
if (rateLimit.count > rateLimit.limit) {
// Log security event
_logSecurityEvent(
account,
keccak256("RATE_LIMIT_EXCEEDED"),
abi.encode(rateLimit.count, rateLimit.limit),
3 // Medium-high severity
);
emit RateLimitExceeded(account, rateLimit.count, rateLimit.limit, rateLimit.window);
revert CustomErrors.RateLimitExceeded(account, rateLimit.count, rateLimit.limit);
}
}
/**
* @dev Checks circuit breaker for an operation
* @param operation The operation identifier
*/
function _checkCircuitBreaker(bytes32 operation) internal view {
CircuitBreaker storage breaker = _circuitBreakers[operation];
if (!breaker.enabled || !breaker.tripped) {
return;
}
// Check if cooldown period has passed
if (block.timestamp < breaker.lastFailure + breaker.cooldown) {
revert CustomErrors.OperationNotSupported("Circuit breaker tripped");
}
}
/**
* @dev Logs a security event
* @param account The account involved
* @param eventType The type of security event
* @param data Additional event data
* @param severity The event severity (1-5)
*/
function _logSecurityEvent(
address account,
bytes32 eventType,
bytes memory data,
uint256 severity
) internal {
// Remove oldest events if at capacity
if (_securityEvents.length >= MAX_SECURITY_EVENTS) {
// Shift array left (remove first element)
for (uint256 i = 0; i < _securityEvents.length - 1; i++) {
_securityEvents[i] = _securityEvents[i + 1];
}
_securityEvents.pop();
}
_securityEvents.push(SecurityEvent({
account: account,
eventType: eventType,
timestamp: block.timestamp,
data: data,
severity: severity
}));
emit SecurityEventLogged(account, eventType, severity, block.timestamp);
}
/**
* @dev Returns the version of the contract
* @return version The contract version
*/
function version() external pure returns (string memory) {
return "1.0.0";
}
}{
"optimizer": {
"enabled": true,
"runs": 1000
},
"evmVersion": "paris",
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
}
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[{"internalType":"address","name":"_logic","type":"address"},{"internalType":"address","name":"initialOwner","type":"address"},{"internalType":"bytes","name":"_data","type":"bytes"}],"stateMutability":"payable","type":"constructor"},{"inputs":[{"internalType":"address","name":"target","type":"address"}],"name":"AddressEmptyCode","type":"error"},{"inputs":[{"internalType":"address","name":"admin","type":"address"}],"name":"ERC1967InvalidAdmin","type":"error"},{"inputs":[{"internalType":"address","name":"implementation","type":"address"}],"name":"ERC1967InvalidImplementation","type":"error"},{"inputs":[],"name":"ERC1967NonPayable","type":"error"},{"inputs":[],"name":"FailedCall","type":"error"},{"inputs":[],"name":"ProxyDeniedAdminAccess","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":"implementation","type":"address"}],"name":"Upgraded","type":"event"},{"stateMutability":"payable","type":"fallback"}]Contract Creation Code
0x60a06040526040516110033803806110038339810160408190526100229161039c565b828161002e828261008f565b50508160405161003d90610339565b6001600160a01b039091168152602001604051809103906000f080158015610069573d6000803e3d6000fd5b506001600160a01b031660805261008761008260805190565b6100ee565b50505061048e565b6100988261015c565b6040516001600160a01b038316907fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b90600090a28051156100e2576100dd82826101db565b505050565b6100ea610252565b5050565b7f7e644d79422f17c01e4894b5f4f588d331ebfa28653d42ae832dc59e38c9798f61012e600080516020610fe3833981519152546001600160a01b031690565b604080516001600160a01b03928316815291841660208301520160405180910390a161015981610273565b50565b806001600160a01b03163b60000361019757604051634c9c8ce360e01b81526001600160a01b03821660048201526024015b60405180910390fd5b807f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc5b80546001600160a01b0319166001600160a01b039290921691909117905550565b6060600080846001600160a01b0316846040516101f89190610472565b600060405180830381855af49150503d8060008114610233576040519150601f19603f3d011682016040523d82523d6000602084013e610238565b606091505b5090925090506102498583836102b2565b95945050505050565b34156102715760405163b398979f60e01b815260040160405180910390fd5b565b6001600160a01b03811661029d57604051633173bdd160e11b81526000600482015260240161018e565b80600080516020610fe38339815191526101ba565b6060826102c7576102c282610311565b61030a565b81511580156102de57506001600160a01b0384163b155b1561030757604051639996b31560e01b81526001600160a01b038516600482015260240161018e565b50805b9392505050565b80511561032057805160208201fd5b60405163d6bda27560e01b815260040160405180910390fd5b6105ce80610a1583390190565b80516001600160a01b038116811461035d57600080fd5b919050565b634e487b7160e01b600052604160045260246000fd5b60005b8381101561039357818101518382015260200161037b565b50506000910152565b6000806000606084860312156103b157600080fd5b6103ba84610346565b92506103c860208501610346565b60408501519092506001600160401b038111156103e457600080fd5b8401601f810186136103f557600080fd5b80516001600160401b0381111561040e5761040e610362565b604051601f8201601f19908116603f011681016001600160401b038111828210171561043c5761043c610362565b60405281815282820160200188101561045457600080fd5b610465826020830160208601610378565b8093505050509250925092565b60008251610484818460208701610378565b9190910192915050565b60805161056d6104a860003960006010015261056d6000f3fe608060405261000c61000e565b005b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031633036100c5576000357fffffffff00000000000000000000000000000000000000000000000000000000167f4f1ef28600000000000000000000000000000000000000000000000000000000146100bb576040517fd2b576ec00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6100c36100cd565b565b6100c36100fc565b6000806100dd36600481846103d7565b8101906100ea9190610430565b915091506100f8828261010c565b5050565b6100c3610107610167565b61019f565b610115826101c3565b6040516001600160a01b038316907fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b90600090a280511561015f5761015a8282610270565b505050565b6100f86102e6565b600061019a7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc546001600160a01b031690565b905090565b3660008037600080366000845af43d6000803e8080156101be573d6000f35b3d6000fd5b806001600160a01b03163b600003610217576040517f4c9c8ce30000000000000000000000000000000000000000000000000000000081526001600160a01b03821660048201526024015b60405180910390fd5b7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc80547fffffffffffffffffffffffff0000000000000000000000000000000000000000166001600160a01b0392909216919091179055565b6060600080846001600160a01b03168460405161028d9190610508565b600060405180830381855af49150503d80600081146102c8576040519150601f19603f3d011682016040523d82523d6000602084013e6102cd565b606091505b50915091506102dd85838361031e565b95945050505050565b34156100c3576040517fb398979f00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6060826103335761032e82610396565b61038f565b815115801561034a57506001600160a01b0384163b155b1561038c576040517f9996b3150000000000000000000000000000000000000000000000000000000081526001600160a01b038516600482015260240161020e565b50805b9392505050565b8051156103a557805160208201fd5b6040517fd6bda27500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b600080858511156103e757600080fd5b838611156103f457600080fd5b5050820193919092039150565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b6000806040838503121561044357600080fd5b82356001600160a01b038116811461045a57600080fd5b9150602083013567ffffffffffffffff81111561047657600080fd5b8301601f8101851361048757600080fd5b803567ffffffffffffffff8111156104a1576104a1610401565b604051601f8201601f19908116603f0116810167ffffffffffffffff811182821017156104d0576104d0610401565b6040528181528282016020018710156104e857600080fd5b816020840160208301376000602083830101528093505050509250929050565b6000825160005b81811015610529576020818601810151858301520161050f565b50600092019182525091905056fea264697066735822122019e87a553a1e2b0a31e750febbd38e604846bdbc55a7ba75a41611f646828e9e64736f6c634300081c0033608060405234801561001057600080fd5b506040516105ce3803806105ce83398101604081905261002f916100be565b806001600160a01b03811661005e57604051631e4fbdf760e01b81526000600482015260240160405180910390fd5b6100678161006e565b50506100ee565b600080546001600160a01b038381166001600160a01b0319831681178455604051919092169283917f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e09190a35050565b6000602082840312156100d057600080fd5b81516001600160a01b03811681146100e757600080fd5b9392505050565b6104d1806100fd6000396000f3fe60806040526004361061005a5760003560e01c80639623609d116100435780639623609d146100a3578063ad3cb1cc146100b6578063f2fde38b1461010c57600080fd5b8063715018a61461005f5780638da5cb5b14610076575b600080fd5b34801561006b57600080fd5b5061007461012c565b005b34801561008257600080fd5b506000546040516001600160a01b0390911681526020015b60405180910390f35b6100746100b1366004610316565b610140565b3480156100c257600080fd5b506100ff6040518060400160405280600581526020017f352e302e3000000000000000000000000000000000000000000000000000000081525081565b60405161009a919061043a565b34801561011857600080fd5b50610074610127366004610454565b6101c8565b610134610224565b61013e600061026a565b565b610148610224565b6040517f4f1ef2860000000000000000000000000000000000000000000000000000000081526001600160a01b03841690634f1ef2869034906101919086908690600401610471565b6000604051808303818588803b1580156101aa57600080fd5b505af11580156101be573d6000803e3d6000fd5b5050505050505050565b6101d0610224565b6001600160a01b038116610218576040517f1e4fbdf7000000000000000000000000000000000000000000000000000000008152600060048201526024015b60405180910390fd5b6102218161026a565b50565b6000546001600160a01b0316331461013e576040517f118cdaa700000000000000000000000000000000000000000000000000000000815233600482015260240161020f565b600080546001600160a01b038381167fffffffffffffffffffffffff0000000000000000000000000000000000000000831681178455604051919092169283917f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e09190a35050565b6001600160a01b038116811461022157600080fd5b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b60008060006060848603121561032b57600080fd5b8335610336816102d2565b92506020840135610346816102d2565b9150604084013567ffffffffffffffff81111561036257600080fd5b8401601f8101861361037357600080fd5b803567ffffffffffffffff81111561038d5761038d6102e7565b604051601f8201601f19908116603f0116810167ffffffffffffffff811182821017156103bc576103bc6102e7565b6040528181528282016020018810156103d457600080fd5b816020840160208301376000602083830101528093505050509250925092565b6000815180845260005b8181101561041a576020818501810151868301820152016103fe565b506000602082860101526020601f19601f83011685010191505092915050565b60208152600061044d60208301846103f4565b9392505050565b60006020828403121561046657600080fd5b813561044d816102d2565b6001600160a01b038316815260406020820152600061049360408301846103f4565b94935050505056fea2646970667358221220f4e616b1a53507a97c496036c372492b9ff91472fcfd6aee00f221b1e35d2c2664736f6c634300081c0033b53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d61030000000000000000000000003192cb745d2d9cf2fb751ae2ee0d5b65c8b76cb6000000000000000000000000af585f9f41f8536347bc532139a66cc7669a844d00000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000
Deployed Bytecode
0x608060405261000c61000e565b005b7f000000000000000000000000d159af579e7d06ff235fd716a86863d72ddbe1626001600160a01b031633036100c5576000357fffffffff00000000000000000000000000000000000000000000000000000000167f4f1ef28600000000000000000000000000000000000000000000000000000000146100bb576040517fd2b576ec00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6100c36100cd565b565b6100c36100fc565b6000806100dd36600481846103d7565b8101906100ea9190610430565b915091506100f8828261010c565b5050565b6100c3610107610167565b61019f565b610115826101c3565b6040516001600160a01b038316907fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b90600090a280511561015f5761015a8282610270565b505050565b6100f86102e6565b600061019a7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc546001600160a01b031690565b905090565b3660008037600080366000845af43d6000803e8080156101be573d6000f35b3d6000fd5b806001600160a01b03163b600003610217576040517f4c9c8ce30000000000000000000000000000000000000000000000000000000081526001600160a01b03821660048201526024015b60405180910390fd5b7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc80547fffffffffffffffffffffffff0000000000000000000000000000000000000000166001600160a01b0392909216919091179055565b6060600080846001600160a01b03168460405161028d9190610508565b600060405180830381855af49150503d80600081146102c8576040519150601f19603f3d011682016040523d82523d6000602084013e6102cd565b606091505b50915091506102dd85838361031e565b95945050505050565b34156100c3576040517fb398979f00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6060826103335761032e82610396565b61038f565b815115801561034a57506001600160a01b0384163b155b1561038c576040517f9996b3150000000000000000000000000000000000000000000000000000000081526001600160a01b038516600482015260240161020e565b50805b9392505050565b8051156103a557805160208201fd5b6040517fd6bda27500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b600080858511156103e757600080fd5b838611156103f457600080fd5b5050820193919092039150565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b6000806040838503121561044357600080fd5b82356001600160a01b038116811461045a57600080fd5b9150602083013567ffffffffffffffff81111561047657600080fd5b8301601f8101851361048757600080fd5b803567ffffffffffffffff8111156104a1576104a1610401565b604051601f8201601f19908116603f0116810167ffffffffffffffff811182821017156104d0576104d0610401565b6040528181528282016020018710156104e857600080fd5b816020840160208301376000602083830101528093505050509250929050565b6000825160005b81811015610529576020818601810151858301520161050f565b50600092019182525091905056fea264697066735822122019e87a553a1e2b0a31e750febbd38e604846bdbc55a7ba75a41611f646828e9e64736f6c634300081c0033
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.