Transaction Hash:
Block:
16332201 at Jan-04-2023 08:22:23 AM +UTC
Transaction Fee:
0.002602092260410099 ETH
$5.15
Gas Used:
180,017 Gas / 14.454702947 Gwei
Emitted Events:
| 142 |
0x18b42679b84f86efdf1587d83d6cc4707cdf5bce.0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925( 0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925, 0x000000000000000000000000cf534aaa64d1005a3cfd16918169b0d01eeed1a7, 0x0000000000000000000000000000000000000000000000000000000000000000, 0x0000000000000000000000000000000000000000000000000000000000000002 )
|
| 143 |
0x18b42679b84f86efdf1587d83d6cc4707cdf5bce.0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef( 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef, 0x000000000000000000000000cf534aaa64d1005a3cfd16918169b0d01eeed1a7, 0x000000000000000000000000cda72070e455bb31c7690a170224ce43623d0b6f, 0x0000000000000000000000000000000000000000000000000000000000000002 )
|
| 144 |
AdminUpgradeabilityProxy.0x1062dd3b35f12b4064331244d00f40c1d4831965e4285654157a2409c6217cff( 0x1062dd3b35f12b4064331244d00f40c1d4831965e4285654157a2409c6217cff, 0x000000000000000000000000cf534aaa64d1005a3cfd16918169b0d01eeed1a7, 0x00000000000000000000000018b42679b84f86efdf1587d83d6cc4707cdf5bce, 0x0000000000000000000000000000000000000000000000000000000000000002, 0000000000000000000000000000000000000000000000000000000000015180, 0000000000000000000000000000000000000000000000000000000000000384, 000000000000000000000000000000000000000000000000011c37937e080000, 0000000000000000000000000000000000000000000000000000000000048a33 )
|
Account State Difference:
| Address | Before | After | State Difference | ||
|---|---|---|---|---|---|
| 0x18B42679...07Cdf5bcE | |||||
|
0x9f4B4CeC...De7cb481a
Miner
| (Fee Recipient: 0x9f...81a) | 28.463864799203794581 Eth | 28.464134824703794581 Eth | 0.0002700255 | |
| 0xcDA72070...3623d0B6f | (Foundation: Market) | ||||
| 0xcf534Aaa...01eeEd1a7 |
0.00643999923871813 Eth
Nonce: 4
|
0.003837906978308031 Eth
Nonce: 5
| 0.002602092260410099 |
Execution Trace
AdminUpgradeabilityProxy.4ce6931a( )
NFTMarket.createReserveAuction( nftContract=0x18B42679B84f86EFDf1587d83d6Cc4707Cdf5bcE, tokenId=2, reservePrice=80000000000000000 )
0x18b42679b84f86efdf1587d83d6cc4707cdf5bce.23b872dd( )
-
NFTCollection.transferFrom( from=0xcf534Aaa64D1005a3CFd16918169B0d01eeEd1a7, to=0xcDA72070E455bb31C7690a170224Ce43623d0B6f, tokenId=2 )
-
createReserveAuction[NFTMarketReserveAuction (ln:2265)]
createReserveAuctionV2[NFTMarketReserveAuction (ln:2266)]_getNextAndIncrementAuctionId[NFTMarketReserveAuction (ln:2283)]_transferToEscrow[NFTMarketReserveAuction (ln:2285)]_transferToEscrow[NFTMarketReserveAuction (ln:2537)]NFTMarketReserveAuction_Not_Matching_Seller[NFTMarketReserveAuction (ln:2545)]NFTMarketReserveAuction_Not_Matching_Seller[NFTMarketReserveAuction (ln:2550)]_finalizeReserveAuction[NFTMarketReserveAuction (ln:2553)]hasExpired[NFTMarketReserveAuction (ln:2443)]NFTMarketReserveAuction_Cannot_Finalize_Auction_In_Progress[NFTMarketReserveAuction (ln:2444)]_getExhibitionForPayment[NFTMarketReserveAuction (ln:2449)]_transferFromEscrow[NFTMarketReserveAuction (ln:2455)]_distributeFunds[NFTMarketReserveAuction (ln:2463)]payable[NFTMarketReserveAuction (ln:2468)]ReserveAuctionFinalized[NFTMarketReserveAuction (ln:2472)]
NFTMarketReserveAuction_Already_Listed[NFTMarketReserveAuction (ln:2288)]payable[NFTMarketReserveAuction (ln:2295)]_addNftToExhibition[NFTMarketReserveAuction (ln:2297)]ReserveAuctionCreated[NFTMarketReserveAuction (ln:2298)]
File 1 of 3: AdminUpgradeabilityProxy
File 2 of 3: NFTMarket
File 3 of 3: NFTCollection
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
import './UpgradeabilityProxy.sol';
/**
* @title AdminUpgradeabilityProxy
* @dev This contract combines an upgradeability proxy with an authorization
* mechanism for administrative tasks.
* All external functions in this contract must be guarded by the
* `ifAdmin` modifier. See ethereum/solidity#3864 for a Solidity
* feature proposal that would enable this to be done automatically.
*/
contract AdminUpgradeabilityProxy is UpgradeabilityProxy {
/**
* Contract constructor.
* @param _logic address of the initial implementation.
* @param _admin Address of the proxy administrator.
* @param _data Data to send as msg.data to the implementation to initialize the proxied contract.
* It should include the signature and the parameters of the function to be called, as described in
* https://solidity.readthedocs.io/en/v0.4.24/abi-spec.html#function-selector-and-argument-encoding.
* This parameter is optional, if no data is given the initialization call to proxied contract will be skipped.
*/
constructor(address _logic, address _admin, bytes memory _data) UpgradeabilityProxy(_logic, _data) public payable {
assert(ADMIN_SLOT == bytes32(uint256(keccak256('eip1967.proxy.admin')) - 1));
_setAdmin(_admin);
}
/**
* @dev Emitted when the administration has been transferred.
* @param previousAdmin Address of the previous admin.
* @param newAdmin Address of the new admin.
*/
event AdminChanged(address previousAdmin, address newAdmin);
/**
* @dev Storage slot with the admin of the contract.
* This is the keccak-256 hash of "eip1967.proxy.admin" subtracted by 1, and is
* validated in the constructor.
*/
bytes32 internal constant ADMIN_SLOT = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103;
/**
* @dev Modifier to check whether the `msg.sender` is the admin.
* If it is, it will run the function. Otherwise, it will delegate the call
* to the implementation.
*/
modifier ifAdmin() {
if (msg.sender == _admin()) {
_;
} else {
_fallback();
}
}
/**
* @return The address of the proxy admin.
*/
function admin() external ifAdmin returns (address) {
return _admin();
}
/**
* @return The address of the implementation.
*/
function implementation() external ifAdmin returns (address) {
return _implementation();
}
/**
* @dev Changes the admin of the proxy.
* Only the current admin can call this function.
* @param newAdmin Address to transfer proxy administration to.
*/
function changeAdmin(address newAdmin) external ifAdmin {
require(newAdmin != address(0), "Cannot change the admin of a proxy to the zero address");
emit AdminChanged(_admin(), newAdmin);
_setAdmin(newAdmin);
}
/**
* @dev Upgrade the backing implementation of the proxy.
* Only the admin can call this function.
* @param newImplementation Address of the new implementation.
*/
function upgradeTo(address newImplementation) external ifAdmin {
_upgradeTo(newImplementation);
}
/**
* @dev Upgrade the backing implementation of the proxy and call a function
* on the new implementation.
* This is useful to initialize the proxied contract.
* @param newImplementation Address of the new implementation.
* @param data Data to send as msg.data in the low level call.
* It should include the signature and the parameters of the function to be called, as described in
* https://solidity.readthedocs.io/en/v0.4.24/abi-spec.html#function-selector-and-argument-encoding.
*/
function upgradeToAndCall(address newImplementation, bytes calldata data) payable external ifAdmin {
_upgradeTo(newImplementation);
(bool success,) = newImplementation.delegatecall(data);
require(success);
}
/**
* @return adm The admin slot.
*/
function _admin() internal view returns (address adm) {
bytes32 slot = ADMIN_SLOT;
assembly {
adm := sload(slot)
}
}
/**
* @dev Sets the address of the proxy admin.
* @param newAdmin Address of the new proxy admin.
*/
function _setAdmin(address newAdmin) internal {
bytes32 slot = ADMIN_SLOT;
assembly {
sstore(slot, newAdmin)
}
}
/**
* @dev Only fall back when the sender is not the admin.
*/
function _willFallback() internal override virtual {
require(msg.sender != _admin(), "Cannot call fallback function from the proxy admin");
super._willFallback();
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
import './Proxy.sol';
import '@openzeppelin/contracts/utils/Address.sol';
/**
* @title UpgradeabilityProxy
* @dev This contract implements a proxy that allows to change the
* implementation address to which it will delegate.
* Such a change is called an implementation upgrade.
*/
contract UpgradeabilityProxy is Proxy {
/**
* @dev Contract constructor.
* @param _logic Address of the initial implementation.
* @param _data Data to send as msg.data to the implementation to initialize the proxied contract.
* It should include the signature and the parameters of the function to be called, as described in
* https://solidity.readthedocs.io/en/v0.4.24/abi-spec.html#function-selector-and-argument-encoding.
* This parameter is optional, if no data is given the initialization call to proxied contract will be skipped.
*/
constructor(address _logic, bytes memory _data) public payable {
assert(IMPLEMENTATION_SLOT == bytes32(uint256(keccak256('eip1967.proxy.implementation')) - 1));
_setImplementation(_logic);
if(_data.length > 0) {
(bool success,) = _logic.delegatecall(_data);
require(success);
}
}
/**
* @dev Emitted when the implementation is upgraded.
* @param implementation Address of the new implementation.
*/
event Upgraded(address indexed implementation);
/**
* @dev Storage slot with the address of the current implementation.
* This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1, and is
* validated in the constructor.
*/
bytes32 internal constant IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
/**
* @dev Returns the current implementation.
* @return impl Address of the current implementation
*/
function _implementation() internal override view returns (address impl) {
bytes32 slot = IMPLEMENTATION_SLOT;
assembly {
impl := sload(slot)
}
}
/**
* @dev Upgrades the proxy to a new implementation.
* @param newImplementation Address of the new implementation.
*/
function _upgradeTo(address newImplementation) internal {
_setImplementation(newImplementation);
emit Upgraded(newImplementation);
}
/**
* @dev Sets the implementation address of the proxy.
* @param newImplementation Address of the new implementation.
*/
function _setImplementation(address newImplementation) internal {
require(Address.isContract(newImplementation), "Cannot set a proxy implementation to a non-contract address");
bytes32 slot = IMPLEMENTATION_SLOT;
assembly {
sstore(slot, newImplementation)
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
/**
* @title Proxy
* @dev Implements delegation of calls to other contracts, with proper
* forwarding of return values and bubbling of failures.
* It defines a fallback function that delegates all calls to the address
* returned by the abstract _implementation() internal function.
*/
abstract contract Proxy {
/**
* @dev Fallback function.
* Implemented entirely in `_fallback`.
*/
fallback () payable external {
_fallback();
}
/**
* @dev Receive function.
* Implemented entirely in `_fallback`.
*/
receive () payable external {
_fallback();
}
/**
* @return The Address of the implementation.
*/
function _implementation() internal virtual view returns (address);
/**
* @dev Delegates execution to an implementation contract.
* This is a low level function that doesn't return to its internal call site.
* It will return to the external caller whatever the implementation returns.
* @param implementation Address to delegate.
*/
function _delegate(address implementation) internal {
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 Function that is run as the first thing in the fallback function.
* Can be redefined in derived contracts to add functionality.
* Redefinitions must call super._willFallback().
*/
function _willFallback() internal virtual {
}
/**
* @dev fallback implementation.
* Extracted to enable manual triggering.
*/
function _fallback() internal {
_willFallback();
_delegate(_implementation());
}
}
// SPDX-License-Identifier: MIT
pragma solidity >=0.6.2 <0.8.0;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize, which returns 0 for contracts in
// construction, since the code is only stored at the end of the
// constructor execution.
uint256 size;
// solhint-disable-next-line no-inline-assembly
assembly { size := extcodesize(account) }
return size > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/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.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
// solhint-disable-next-line avoid-low-level-calls, avoid-call-value
(bool success, ) = recipient.call{ value: amount }("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain`call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCall(target, data, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data, string memory errorMessage) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(address target, bytes memory data, uint256 value, string memory errorMessage) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory returndata) = target.call{ value: value }(data);
return _verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data, string memory errorMessage) internal view returns (bytes memory) {
require(isContract(target), "Address: static call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory returndata) = target.staticcall(data);
return _verifyCallResult(success, returndata, errorMessage);
}
function _verifyCallResult(bool success, bytes memory returndata, string memory errorMessage) private pure returns(bytes memory) {
if (success) {
return returndata;
} else {
// 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
// solhint-disable-next-line no-inline-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
File 2 of 3: NFTMarket
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @author: manifold.xyz
import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
/**
* @dev Royalty registry interface
*/
interface IRoyaltyRegistry is IERC165 {
event RoyaltyOverride(address owner, address tokenAddress, address royaltyAddress);
/**
* Override the location of where to look up royalty information for a given token contract.
* Allows for backwards compatibility and implementation of royalty logic for contracts that did not previously support them.
*
* @param tokenAddress - The token address you wish to override
* @param royaltyAddress - The royalty override address
*/
function setRoyaltyLookupAddress(address tokenAddress, address royaltyAddress) external;
/**
* Returns royalty address location. Returns the tokenAddress by default, or the override if it exists
*
* @param tokenAddress - The token address you are looking up the royalty for
*/
function getRoyaltyLookupAddress(address tokenAddress) external view returns(address);
/**
* Whether or not the message sender can override the royalty address for the given token address
*
* @param tokenAddress - The token address you are looking up the royalty for
*/
function overrideAllowed(address tokenAddress) external view returns(bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.2;
import "../../utils/AddressUpgradeable.sol";
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Indicates that the contract has been initialized.
* @custom:oz-retyped-from bool
*/
uint8 private _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private _initializing;
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint8 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts.
*
* Similar to `reinitializer(1)`, except that functions marked with `initializer` can be nested in the context of a
* constructor.
*
* Emits an {Initialized} event.
*/
modifier initializer() {
bool isTopLevelCall = !_initializing;
require(
(isTopLevelCall && _initialized < 1) || (!AddressUpgradeable.isContract(address(this)) && _initialized == 1),
"Initializable: contract is already initialized"
);
_initialized = 1;
if (isTopLevelCall) {
_initializing = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* A reinitializer may be used after the original initialization step. This is essential to configure modules that
* are added through upgrades and that require initialization.
*
* When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
* cannot be nested. If one is invoked in the context of another, execution will revert.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*
* WARNING: setting the version to 255 will prevent any future reinitialization.
*
* Emits an {Initialized} event.
*/
modifier reinitializer(uint8 version) {
require(!_initializing && _initialized < version, "Initializable: contract is already initialized");
_initialized = version;
_initializing = true;
_;
_initializing = false;
emit Initialized(version);
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
require(_initializing, "Initializable: contract is not initializing");
_;
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*
* Emits an {Initialized} event the first time it is successfully executed.
*/
function _disableInitializers() internal virtual {
require(!_initializing, "Initializable: contract is initializing");
if (_initialized < type(uint8).max) {
_initialized = type(uint8).max;
emit Initialized(type(uint8).max);
}
}
/**
* @dev Internal function that returns the initialized version. Returns `_initialized`
*/
function _getInitializedVersion() internal view returns (uint8) {
return _initialized;
}
/**
* @dev Internal function that returns the initialized version. Returns `_initializing`
*/
function _isInitializing() internal view returns (bool) {
return _initializing;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
import "../proxy/utils/Initializable.sol";
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuardUpgradeable is Initializable {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant _NOT_ENTERED = 1;
uint256 private constant _ENTERED = 2;
uint256 private _status;
function __ReentrancyGuard_init() internal onlyInitializing {
__ReentrancyGuard_init_unchained();
}
function __ReentrancyGuard_init_unchained() internal onlyInitializing {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library AddressUpgradeable {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/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.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value
) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (token/ERC721/IERC721.sol)
pragma solidity ^0.8.0;
import "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC721 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 ERC721 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 ERC721
* 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 caller.
*
* 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 v4.8.0) (utils/introspection/ERC165Checker.sol)
pragma solidity ^0.8.0;
import "./IERC165.sol";
/**
* @dev Library used to query support of an interface declared via {IERC165}.
*
* Note that these functions return the actual result of the query: they do not
* `revert` if an interface is not supported. It is up to the caller to decide
* what to do in these cases.
*/
library ERC165Checker {
// As per the EIP-165 spec, no interface should ever match 0xffffffff
bytes4 private constant _INTERFACE_ID_INVALID = 0xffffffff;
/**
* @dev Returns true if `account` supports the {IERC165} interface.
*/
function supportsERC165(address account) internal view returns (bool) {
// Any contract that implements ERC165 must explicitly indicate support of
// InterfaceId_ERC165 and explicitly indicate non-support of InterfaceId_Invalid
return
supportsERC165InterfaceUnchecked(account, type(IERC165).interfaceId) &&
!supportsERC165InterfaceUnchecked(account, _INTERFACE_ID_INVALID);
}
/**
* @dev Returns true if `account` supports the interface defined by
* `interfaceId`. Support for {IERC165} itself is queried automatically.
*
* See {IERC165-supportsInterface}.
*/
function supportsInterface(address account, bytes4 interfaceId) internal view returns (bool) {
// query support of both ERC165 as per the spec and support of _interfaceId
return supportsERC165(account) && supportsERC165InterfaceUnchecked(account, interfaceId);
}
/**
* @dev Returns a boolean array where each value corresponds to the
* interfaces passed in and whether they're supported or not. This allows
* you to batch check interfaces for a contract where your expectation
* is that some interfaces may not be supported.
*
* See {IERC165-supportsInterface}.
*
* _Available since v3.4._
*/
function getSupportedInterfaces(address account, bytes4[] memory interfaceIds)
internal
view
returns (bool[] memory)
{
// an array of booleans corresponding to interfaceIds and whether they're supported or not
bool[] memory interfaceIdsSupported = new bool[](interfaceIds.length);
// query support of ERC165 itself
if (supportsERC165(account)) {
// query support of each interface in interfaceIds
for (uint256 i = 0; i < interfaceIds.length; i++) {
interfaceIdsSupported[i] = supportsERC165InterfaceUnchecked(account, interfaceIds[i]);
}
}
return interfaceIdsSupported;
}
/**
* @dev Returns true if `account` supports all the interfaces defined in
* `interfaceIds`. Support for {IERC165} itself is queried automatically.
*
* Batch-querying can lead to gas savings by skipping repeated checks for
* {IERC165} support.
*
* See {IERC165-supportsInterface}.
*/
function supportsAllInterfaces(address account, bytes4[] memory interfaceIds) internal view returns (bool) {
// query support of ERC165 itself
if (!supportsERC165(account)) {
return false;
}
// query support of each interface in interfaceIds
for (uint256 i = 0; i < interfaceIds.length; i++) {
if (!supportsERC165InterfaceUnchecked(account, interfaceIds[i])) {
return false;
}
}
// all interfaces supported
return true;
}
/**
* @notice Query if a contract implements an interface, does not check ERC165 support
* @param account The address of the contract to query for support of an interface
* @param interfaceId The interface identifier, as specified in ERC-165
* @return true if the contract at account indicates support of the interface with
* identifier interfaceId, false otherwise
* @dev Assumes that account contains a contract that supports ERC165, otherwise
* the behavior of this method is undefined. This precondition can be checked
* with {supportsERC165}.
* Interface identification is specified in ERC-165.
*/
function supportsERC165InterfaceUnchecked(address account, bytes4 interfaceId) internal view returns (bool) {
// prepare call
bytes memory encodedParams = abi.encodeWithSelector(IERC165.supportsInterface.selector, interfaceId);
// perform static call
bool success;
uint256 returnSize;
uint256 returnValue;
assembly {
success := staticcall(30000, account, add(encodedParams, 0x20), mload(encodedParams), 0x00, 0x20)
returnSize := returndatasize()
returnValue := mload(0x00)
}
return success && returnSize >= 0x20 && returnValue > 0;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface 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[EIP section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
/**
* @notice Interface for functions the market uses in FETH.
* @author batu-inal & HardlyDifficult
*/
interface IFethMarket {
function depositFor(address account) external payable;
function marketLockupFor(address account, uint256 amount) external payable returns (uint256 expiration);
function marketWithdrawFrom(address from, uint256 amount) external;
function marketWithdrawLocked(address account, uint256 expiration, uint256 amount) external;
function marketUnlockFor(address account, uint256 expiration, uint256 amount) external;
function marketChangeLockup(
address unlockFrom,
uint256 unlockExpiration,
uint256 unlockAmount,
address lockupFor,
uint256 lockupAmount
) external payable returns (uint256 expiration);
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
/**
* @notice Interface for AdminRole which wraps the default admin role from
* OpenZeppelin's AccessControl for easy integration.
* @author batu-inal & HardlyDifficult
*/
interface IAdminRole {
function isAdmin(address account) external view returns (bool);
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
/**
* @notice Interface for OperatorRole which wraps a role from
* OpenZeppelin's AccessControl for easy integration.
* @author batu-inal & HardlyDifficult
*/
interface IOperatorRole {
function isOperator(address account) external view returns (bool);
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
/**
* @notice An interface for communicating fees to 3rd party marketplaces.
* @dev Originally implemented in mainnet contract 0x44d6e8933f8271abcf253c72f9ed7e0e4c0323b3
*/
interface IGetFees {
/**
* @notice Get the recipient addresses to which creator royalties should be sent.
* @dev The expected royalty amounts are communicated with `getFeeBps`.
* @param tokenId The ID of the NFT to get royalties for.
* @return recipients An array of addresses to which royalties should be sent.
*/
function getFeeRecipients(uint256 tokenId) external view returns (address payable[] memory recipients);
/**
* @notice Get the creator royalty amounts to be sent to each recipient, in basis points.
* @dev The expected recipients are communicated with `getFeeRecipients`.
* @param tokenId The ID of the NFT to get royalties for.
* @return royaltiesInBasisPoints The array of fees to be sent to each recipient, in basis points.
*/
function getFeeBps(uint256 tokenId) external view returns (uint256[] memory royaltiesInBasisPoints);
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
interface IGetRoyalties {
/**
* @notice Get the creator royalties to be sent.
* @dev The data is the same as when calling `getFeeRecipients` and `getFeeBps` separately.
* @param tokenId The ID of the NFT to get royalties for.
* @return recipients An array of addresses to which royalties should be sent.
* @return royaltiesInBasisPoints The array of fees to be sent to each recipient, in basis points.
*/
function getRoyalties(uint256 tokenId)
external
view
returns (address payable[] memory recipients, uint256[] memory royaltiesInBasisPoints);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.12;
interface IOwnable {
/**
* @dev Returns the address of the current owner.
*/
function owner() external view returns (address);
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
/**
* @notice Interface for EIP-2981: NFT Royalty Standard.
* For more see: https://eips.ethereum.org/EIPS/eip-2981.
*/
interface IRoyaltyInfo {
/**
* @notice Get the creator royalties to be sent.
* @param tokenId The ID of the NFT to get royalties for.
* @param salePrice The total price of the sale.
* @return receiver The address to which royalties should be sent.
* @return royaltyAmount The total amount that should be sent to the `receiver`.
*/
function royaltyInfo(uint256 tokenId, uint256 salePrice)
external
view
returns (address receiver, uint256 royaltyAmount);
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
interface ITokenCreator {
/**
* @notice Returns the creator of this NFT collection.
* @param tokenId The ID of the NFT to get the creator payment address for.
* @return creator The creator of this collection.
*/
function tokenCreator(uint256 tokenId) external view returns (address payable creator);
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
/**
* @title Helper functions for arrays.
* @author batu-inal & HardlyDifficult
*/
library ArrayLibrary {
/**
* @notice Reduces the size of an array if it's greater than the specified max size,
* using the first maxSize elements.
*/
function capLength(address payable[] memory data, uint256 maxLength) internal pure {
if (data.length > maxLength) {
assembly {
mstore(data, maxLength)
}
}
}
/**
* @notice Reduces the size of an array if it's greater than the specified max size,
* using the first maxSize elements.
*/
function capLength(uint256[] memory data, uint256 maxLength) internal pure {
if (data.length > maxLength) {
assembly {
mstore(data, maxLength)
}
}
}
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
/**
* @title Helpers for working with time.
* @author batu-inal & HardlyDifficult
*/
library TimeLibrary {
/**
* @notice Checks if the given timestamp is in the past.
* @dev This helper ensures a consistent interpretation of expiry across the codebase.
* This is different than `hasBeenReached` in that it will return false if the expiry is now.
*/
function hasExpired(uint256 expiry) internal view returns (bool) {
return expiry < block.timestamp;
}
/**
* @notice Checks if the given timestamp is now or in the past.
* @dev This helper ensures a consistent interpretation of expiry across the codebase.
* This is different from `hasExpired` in that it will return true if the timestamp is now.
*/
function hasBeenReached(uint256 timestamp) internal view returns (bool) {
return timestamp <= block.timestamp;
}
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
/**
* @title An abstraction layer for auctions.
* @dev This contract can be expanded with reusable calls and data as more auction types are added.
* @author batu-inal & HardlyDifficult
*/
abstract contract NFTMarketAuction is Initializable {
/**
* @notice A global id for auctions of any type.
*/
uint256 private nextAuctionId;
/**
* @notice Called once to configure the contract after the initial proxy deployment.
* @dev This sets the initial auction id to 1, making the first auction cheaper
* and id 0 represents no auction found.
*/
function _initializeNFTMarketAuction() internal onlyInitializing {
nextAuctionId = 1;
}
/**
* @notice Returns id to assign to the next auction.
*/
function _getNextAndIncrementAuctionId() internal returns (uint256) {
// AuctionId cannot overflow 256 bits.
unchecked {
return nextAuctionId++;
}
}
/**
* @notice This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[1_000] private __gap;
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
import "../shared/MarketFees.sol";
import "../shared/FoundationTreasuryNode.sol";
import "../shared/FETHNode.sol";
import "../shared/MarketSharedCore.sol";
import "../shared/SendValueWithFallbackWithdraw.sol";
import "./NFTMarketCore.sol";
/// @param buyPrice The current buy price set for this NFT.
error NFTMarketBuyPrice_Cannot_Buy_At_Lower_Price(uint256 buyPrice);
error NFTMarketBuyPrice_Cannot_Buy_Unset_Price();
error NFTMarketBuyPrice_Cannot_Cancel_Unset_Price();
/// @param owner The current owner of this NFT.
error NFTMarketBuyPrice_Only_Owner_Can_Cancel_Price(address owner);
/// @param owner The current owner of this NFT.
error NFTMarketBuyPrice_Only_Owner_Can_Set_Price(address owner);
error NFTMarketBuyPrice_Price_Already_Set();
error NFTMarketBuyPrice_Price_Too_High();
/// @param seller The current owner of this NFT.
error NFTMarketBuyPrice_Seller_Mismatch(address seller);
/**
* @title Allows sellers to set a buy price of their NFTs that may be accepted and instantly transferred to the buyer.
* @notice NFTs with a buy price set are escrowed in the market contract.
* @author batu-inal & HardlyDifficult
*/
abstract contract NFTMarketBuyPrice is
Initializable,
FoundationTreasuryNode,
FETHNode,
MarketSharedCore,
NFTMarketCore,
ReentrancyGuardUpgradeable,
SendValueWithFallbackWithdraw,
MarketFees
{
using AddressUpgradeable for address payable;
/// @notice Stores the buy price details for a specific NFT.
/// @dev The struct is packed into a single slot to optimize gas.
struct BuyPrice {
/// @notice The current owner of this NFT which set a buy price.
/// @dev A zero price is acceptable so a non-zero address determines whether a price has been set.
address payable seller;
/// @notice The current buy price set for this NFT.
uint96 price;
}
/// @notice Stores the current buy price for each NFT.
mapping(address => mapping(uint256 => BuyPrice)) private nftContractToTokenIdToBuyPrice;
/**
* @notice Emitted when an NFT is bought by accepting the buy price,
* indicating that the NFT has been transferred and revenue from the sale distributed.
* @dev The total buy price that was accepted is `totalFees` + `creatorRev` + `sellerRev`.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param buyer The address of the collector that purchased the NFT using `buy`.
* @param seller The address of the seller which originally set the buy price.
* @param totalFees The amount of ETH that was sent to Foundation & referrals for this sale.
* @param creatorRev The amount of ETH that was sent to the creator for this sale.
* @param sellerRev The amount of ETH that was sent to the owner for this sale.
*/
event BuyPriceAccepted(
address indexed nftContract,
uint256 indexed tokenId,
address indexed seller,
address buyer,
uint256 totalFees,
uint256 creatorRev,
uint256 sellerRev
);
/**
* @notice Emitted when the buy price is removed by the owner of an NFT.
* @dev The NFT is transferred back to the owner unless it's still escrowed for another market tool,
* e.g. listed for sale in an auction.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
*/
event BuyPriceCanceled(address indexed nftContract, uint256 indexed tokenId);
/**
* @notice Emitted when a buy price is invalidated due to other market activity.
* @dev This occurs when the buy price is no longer eligible to be accepted,
* e.g. when a bid is placed in an auction for this NFT.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
*/
event BuyPriceInvalidated(address indexed nftContract, uint256 indexed tokenId);
/**
* @notice Emitted when a buy price is set by the owner of an NFT.
* @dev The NFT is transferred into the market contract for escrow unless it was already escrowed,
* e.g. for auction listing.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param seller The address of the NFT owner which set the buy price.
* @param price The price of the NFT.
*/
event BuyPriceSet(address indexed nftContract, uint256 indexed tokenId, address indexed seller, uint256 price);
/**
* @notice [DEPRECATED] use `buyV2` instead.
* Buy the NFT at the set buy price.
* `msg.value` must be <= `maxPrice` and any delta will be taken from the account's available FETH balance.
* @dev `maxPrice` protects the buyer in case a the price is increased but allows the transaction to continue
* when the price is reduced (and any surplus funds provided are refunded).
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param maxPrice The maximum price to pay for the NFT.
*/
function buy(address nftContract, uint256 tokenId, uint256 maxPrice) external payable {
buyV2(nftContract, tokenId, maxPrice, payable(0));
}
/**
* @notice Buy the NFT at the set buy price.
* `msg.value` must be <= `maxPrice` and any delta will be taken from the account's available FETH balance.
* @dev `maxPrice` protects the buyer in case a the price is increased but allows the transaction to continue
* when the price is reduced (and any surplus funds provided are refunded).
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param maxPrice The maximum price to pay for the NFT.
* @param referrer The address of the referrer.
*/
function buyV2(address nftContract, uint256 tokenId, uint256 maxPrice, address payable referrer) public payable {
BuyPrice storage buyPrice = nftContractToTokenIdToBuyPrice[nftContract][tokenId];
if (buyPrice.price > maxPrice) {
revert NFTMarketBuyPrice_Cannot_Buy_At_Lower_Price(buyPrice.price);
} else if (buyPrice.seller == address(0)) {
revert NFTMarketBuyPrice_Cannot_Buy_Unset_Price();
}
_buy(nftContract, tokenId, referrer);
}
/**
* @notice Removes the buy price set for an NFT.
* @dev The NFT is transferred back to the owner unless it's still escrowed for another market tool,
* e.g. listed for sale in an auction.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
*/
function cancelBuyPrice(address nftContract, uint256 tokenId) external nonReentrant {
address seller = nftContractToTokenIdToBuyPrice[nftContract][tokenId].seller;
if (seller == address(0)) {
// This check is redundant with the next one, but done in order to provide a more clear error message.
revert NFTMarketBuyPrice_Cannot_Cancel_Unset_Price();
} else if (seller != msg.sender) {
revert NFTMarketBuyPrice_Only_Owner_Can_Cancel_Price(seller);
}
// Remove the buy price
delete nftContractToTokenIdToBuyPrice[nftContract][tokenId];
// Transfer the NFT back to the owner if it is not listed in auction.
_transferFromEscrowIfAvailable(nftContract, tokenId, msg.sender);
emit BuyPriceCanceled(nftContract, tokenId);
}
/**
* @notice Sets the buy price for an NFT and escrows it in the market contract.
* A 0 price is acceptable and valid price you can set, enabling a giveaway to the first collector that calls `buy`.
* @dev If there is an offer for this amount or higher, that will be accepted instead of setting a buy price.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param price The price at which someone could buy this NFT.
*/
function setBuyPrice(address nftContract, uint256 tokenId, uint256 price) external nonReentrant {
// If there is a valid offer at this price or higher, accept that instead.
if (_autoAcceptOffer(nftContract, tokenId, price)) {
return;
}
if (price > type(uint96).max) {
// This ensures that no data is lost when storing the price as `uint96`.
revert NFTMarketBuyPrice_Price_Too_High();
}
BuyPrice storage buyPrice = nftContractToTokenIdToBuyPrice[nftContract][tokenId];
address seller = buyPrice.seller;
if (buyPrice.price == price && seller != address(0)) {
revert NFTMarketBuyPrice_Price_Already_Set();
}
// Store the new price for this NFT.
buyPrice.price = uint96(price);
if (seller == address(0)) {
// Transfer the NFT into escrow, if it's already in escrow confirm the `msg.sender` is the owner.
_transferToEscrow(nftContract, tokenId);
// The price was not previously set for this NFT, store the seller.
buyPrice.seller = payable(msg.sender);
} else if (seller != msg.sender) {
// Buy price was previously set by a different user
revert NFTMarketBuyPrice_Only_Owner_Can_Set_Price(seller);
}
emit BuyPriceSet(nftContract, tokenId, msg.sender, price);
}
/**
* @notice If there is a buy price at this price or lower, accept that and return true.
*/
function _autoAcceptBuyPrice(address nftContract, uint256 tokenId, uint256 maxPrice)
internal
override
returns (bool)
{
BuyPrice storage buyPrice = nftContractToTokenIdToBuyPrice[nftContract][tokenId];
if (buyPrice.seller == address(0) || buyPrice.price > maxPrice) {
// No buy price was found, or the price is too high.
return false;
}
_buy(nftContract, tokenId, payable(0));
return true;
}
/**
* @inheritdoc NFTMarketCore
* @dev Invalidates the buy price on a auction start, if one is found.
*/
function _beforeAuctionStarted(address nftContract, uint256 tokenId) internal virtual override {
BuyPrice storage buyPrice = nftContractToTokenIdToBuyPrice[nftContract][tokenId];
if (buyPrice.seller != address(0)) {
// A buy price was set for this NFT, invalidate it.
_invalidateBuyPrice(nftContract, tokenId);
}
super._beforeAuctionStarted(nftContract, tokenId);
}
/**
* @notice Process the purchase of an NFT at the current buy price.
* @dev The caller must confirm that the seller != address(0) before calling this function.
*/
function _buy(address nftContract, uint256 tokenId, address payable referrer) private nonReentrant {
BuyPrice memory buyPrice = nftContractToTokenIdToBuyPrice[nftContract][tokenId];
// Remove the buy now price
delete nftContractToTokenIdToBuyPrice[nftContract][tokenId];
// Cancel the buyer's offer if there is one in order to free up their FETH balance
// even if they don't need the FETH for this specific purchase.
_cancelSendersOffer(nftContract, tokenId);
_tryUseFETHBalance(buyPrice.price, true);
// Transfer the NFT to the buyer.
// The seller was already authorized when the buyPrice was set originally set.
_transferFromEscrow(nftContract, tokenId, msg.sender, address(0));
// Distribute revenue for this sale.
(uint256 totalFees, uint256 creatorRev, uint256 sellerRev) = _distributeFunds(
nftContract,
tokenId,
buyPrice.seller,
buyPrice.price,
referrer,
payable(0),
0
);
emit BuyPriceAccepted(nftContract, tokenId, buyPrice.seller, msg.sender, totalFees, creatorRev, sellerRev);
}
/**
* @notice Clear a buy price and emit BuyPriceInvalidated.
* @dev The caller must confirm the buy price is set before calling this function.
*/
function _invalidateBuyPrice(address nftContract, uint256 tokenId) private {
delete nftContractToTokenIdToBuyPrice[nftContract][tokenId];
emit BuyPriceInvalidated(nftContract, tokenId);
}
/**
* @inheritdoc NFTMarketCore
* @dev Invalidates the buy price if one is found before transferring the NFT.
* This will revert if there is a buy price set but the `authorizeSeller` is not the owner.
*/
function _transferFromEscrow(address nftContract, uint256 tokenId, address recipient, address authorizeSeller)
internal
virtual
override
{
address seller = nftContractToTokenIdToBuyPrice[nftContract][tokenId].seller;
if (seller != address(0)) {
// A buy price was set for this NFT.
// `authorizeSeller != address(0) &&` could be added when other mixins use this flow.
// ATM that additional check would never return false.
if (seller != authorizeSeller) {
// When there is a buy price set, the `buyPrice.seller` is the owner of the NFT.
revert NFTMarketBuyPrice_Seller_Mismatch(seller);
}
// The seller authorization has been confirmed.
authorizeSeller = address(0);
// Invalidate the buy price as the NFT will no longer be in escrow.
_invalidateBuyPrice(nftContract, tokenId);
}
super._transferFromEscrow(nftContract, tokenId, recipient, authorizeSeller);
}
/**
* @inheritdoc NFTMarketCore
* @dev Checks if there is a buy price set, if not then allow the transfer to proceed.
*/
function _transferFromEscrowIfAvailable(address nftContract, uint256 tokenId, address recipient)
internal
virtual
override
{
address seller = nftContractToTokenIdToBuyPrice[nftContract][tokenId].seller;
if (seller == address(0)) {
// A buy price has been set for this NFT so it should remain in escrow.
super._transferFromEscrowIfAvailable(nftContract, tokenId, recipient);
}
}
/**
* @inheritdoc NFTMarketCore
* @dev Checks if the NFT is already in escrow for buy now.
*/
function _transferToEscrow(address nftContract, uint256 tokenId) internal virtual override {
address seller = nftContractToTokenIdToBuyPrice[nftContract][tokenId].seller;
if (seller == address(0)) {
// The NFT is not in escrow for buy now.
super._transferToEscrow(nftContract, tokenId);
} else if (seller != msg.sender) {
// When there is a buy price set, the `seller` is the owner of the NFT.
revert NFTMarketBuyPrice_Seller_Mismatch(seller);
}
}
/**
* @notice Returns the buy price details for an NFT if one is available.
* @dev If no price is found, seller will be address(0) and price will be max uint256.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @return seller The address of the owner that listed a buy price for this NFT.
* Returns `address(0)` if there is no buy price set for this NFT.
* @return price The price of the NFT.
* Returns max uint256 if there is no buy price set for this NFT (since a price of 0 is supported).
*/
function getBuyPrice(address nftContract, uint256 tokenId) external view returns (address seller, uint256 price) {
seller = nftContractToTokenIdToBuyPrice[nftContract][tokenId].seller;
if (seller == address(0)) {
return (seller, type(uint256).max);
}
price = nftContractToTokenIdToBuyPrice[nftContract][tokenId].price;
}
/**
* @inheritdoc MarketSharedCore
* @dev Returns the seller if there is a buy price set for this NFT, otherwise
* bubbles the call up for other considerations.
*/
function _getSellerOf(address nftContract, uint256 tokenId)
internal
view
virtual
override(MarketSharedCore, NFTMarketCore)
returns (address payable seller)
{
seller = nftContractToTokenIdToBuyPrice[nftContract][tokenId].seller;
if (seller == address(0)) {
seller = super._getSellerOf(nftContract, tokenId);
}
}
/**
* @notice This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[1_000] private __gap;
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "../../interfaces/internal/IFethMarket.sol";
import "../shared/Constants.sol";
import "../shared/MarketSharedCore.sol";
error NFTMarketCore_Seller_Not_Found();
/**
* @title A place for common modifiers and functions used by various NFTMarket mixins, if any.
* @dev This also leaves a gap which can be used to add a new mixin to the top of the inheritance tree.
* @author batu-inal & HardlyDifficult
*/
abstract contract NFTMarketCore is Initializable, MarketSharedCore {
using AddressUpgradeable for address;
using AddressUpgradeable for address payable;
/**
* @notice If there is a buy price at this amount or lower, accept that and return true.
*/
function _autoAcceptBuyPrice(address nftContract, uint256 tokenId, uint256 amount) internal virtual returns (bool);
/**
* @notice If there is a valid offer at the given price or higher, accept that and return true.
*/
function _autoAcceptOffer(address nftContract, uint256 tokenId, uint256 minAmount) internal virtual returns (bool);
/**
* @notice Notify implementors when an auction has received its first bid.
* Once a bid is received the sale is guaranteed to the auction winner
* and other sale mechanisms become unavailable.
* @dev Implementors of this interface should update internal state to reflect an auction has been kicked off.
*/
function _beforeAuctionStarted(
address /*nftContract*/,
uint256 /*tokenId*/ // solhint-disable-next-line no-empty-blocks
) internal virtual {
// No-op
}
/**
* @notice Cancel the `msg.sender`'s offer if there is one, freeing up their FETH balance.
* @dev This should be used when it does not make sense to keep the original offer around,
* e.g. if a collector accepts a Buy Price then keeping the offer around is not necessary.
*/
function _cancelSendersOffer(address nftContract, uint256 tokenId) internal virtual;
/**
* @notice Transfers the NFT from escrow and clears any state tracking this escrowed NFT.
* @param authorizeSeller The address of the seller pending authorization.
* Once it's been authorized by one of the escrow managers, it should be set to address(0)
* indicated that it's no longer pending authorization.
*/
function _transferFromEscrow(address nftContract, uint256 tokenId, address recipient, address authorizeSeller)
internal
virtual
{
if (authorizeSeller != address(0)) {
revert NFTMarketCore_Seller_Not_Found();
}
IERC721(nftContract).transferFrom(address(this), recipient, tokenId);
}
/**
* @notice Transfers the NFT from escrow unless there is another reason for it to remain in escrow.
*/
function _transferFromEscrowIfAvailable(address nftContract, uint256 tokenId, address recipient) internal virtual {
_transferFromEscrow(nftContract, tokenId, recipient, address(0));
}
/**
* @notice Transfers an NFT into escrow,
* if already there this requires the msg.sender is authorized to manage the sale of this NFT.
*/
function _transferToEscrow(address nftContract, uint256 tokenId) internal virtual {
IERC721(nftContract).transferFrom(msg.sender, address(this), tokenId);
}
/**
* @dev Determines the minimum amount when increasing an existing offer or bid.
*/
function _getMinIncrement(uint256 currentAmount) internal pure returns (uint256) {
uint256 minIncrement = currentAmount;
unchecked {
minIncrement /= MIN_PERCENT_INCREMENT_DENOMINATOR;
}
if (minIncrement == 0) {
// Since minIncrement reduces from the currentAmount, this cannot overflow.
// The next amount must be at least 1 wei greater than the current.
return currentAmount + 1;
}
return minIncrement + currentAmount;
}
/**
* @inheritdoc MarketSharedCore
*/
function _getSellerOf(address nftContract, uint256 tokenId)
internal
view
virtual
override
returns (address payable seller)
// solhint-disable-next-line no-empty-blocks
{
// No-op by default
}
/**
* @inheritdoc MarketSharedCore
*/
function _getSellerOrOwnerOf(address nftContract, uint256 tokenId)
internal
view
override
returns (address payable sellerOrOwner)
{
sellerOrOwner = _getSellerOf(nftContract, tokenId);
if (sellerOrOwner == address(0)) {
sellerOrOwner = payable(IERC721(nftContract).ownerOf(tokenId));
}
}
/**
* @notice Checks if an escrowed NFT is currently in active auction.
* @return Returns false if the auction has ended, even if it has not yet been settled.
*/
function _isInActiveAuction(address nftContract, uint256 tokenId) internal view virtual returns (bool);
/**
* @notice This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
* @dev 50 slots were consumed by adding `ReentrancyGuard`.
*/
uint256[450] private __gap;
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "../shared/Constants.sol";
/// @param curator The curator for this exhibition.
error NFTMarketExhibition_Caller_Is_Not_Curator(address curator);
error NFTMarketExhibition_Can_Not_Add_Dupe_Seller();
error NFTMarketExhibition_Curator_Automatically_Allowed();
error NFTMarketExhibition_Exhibition_Does_Not_Exist();
error NFTMarketExhibition_Seller_Not_Allowed_In_Exhibition();
error NFTMarketExhibition_Sellers_Required();
error NFTMarketExhibition_Take_Rate_Too_High();
error NFTMarketExhibition_Too_Many_Sellers();
/**
* @title Enables a curation surface for sellers to exhibit their NFTs.
*/
abstract contract NFTMarketExhibition {
/**
* @notice Stores details about an exhibition.
*/
struct Exhibition {
/// @notice The curator which created this exhibition.
address payable curator;
/// @notice The rate of the sale which goes to the curator.
uint16 takeRateInBasisPoints;
// 80-bits available in the first slot
/// @notice A name for the exhibition.
string name;
}
/// @notice Tracks the next sequence ID to be assigned to an exhibition.
uint256 private latestExhibitionId;
/// @notice Maps the exhibition ID to their details.
mapping(uint256 => Exhibition) private idToExhibition;
/// @notice Maps an exhibition to the list of sellers allowed to list with it.
mapping(uint256 => mapping(address => bool)) private exhibitionIdToSellerToIsAllowed;
/// @notice Maps an NFT to the exhibition it was listed with.
mapping(address => mapping(uint256 => uint256)) private nftContractToTokenIdToExhibitionId;
/// @dev The max number of sellers that can be approved for an exhibition.
uint256 private constant MAX_SELLER_LIST_LENGTH = 50;
/**
* @notice Emitted when an exhibition is created.
* @param exhibitionId The ID for this exhibition.
* @param curator The curator which created this exhibition.
* @param name The name for this exhibition.
* @param takeRateInBasisPoints The rate of the sale which goes to the curator.
*/
event ExhibitionCreated(
uint256 indexed exhibitionId,
address indexed curator,
string name,
uint16 takeRateInBasisPoints
);
/**
* @notice Emitted when an exhibition is deleted.
* @param exhibitionId The ID for the exhibition.
*/
event ExhibitionDeleted(uint256 indexed exhibitionId);
/**
* @notice Emitted when an NFT is listed in an exhibition.
* @param nftContract The contract address of the NFT.
* @param tokenId The ID of the NFT.
* @param exhibitionId The ID of the exhibition it was listed with.
*/
event NftAddedToExhibition(address indexed nftContract, uint256 indexed tokenId, uint256 indexed exhibitionId);
/**
* @notice Emitted when an NFT is no longer associated with an exhibition for reasons other than a sale.
* @param nftContract The contract address of the NFT.
* @param tokenId The ID of the NFT.
* @param exhibitionId The ID of the exhibition it was originally listed with.
*/
event NftRemovedFromExhibition(address indexed nftContract, uint256 indexed tokenId, uint256 indexed exhibitionId);
/**
* @notice Emitted when sellers are granted access to list with an exhibition.
* @param exhibitionId The ID of the exhibition.
* @param sellers The list of sellers granted access.
*/
event SellersAddedToExhibition(uint256 indexed exhibitionId, address[] sellers);
/// @notice Requires the caller to be the curator of the exhibition.
modifier onlyExhibitionCurator(uint256 exhibitionId) {
address curator = idToExhibition[exhibitionId].curator;
if (curator != msg.sender) {
if (curator == address(0)) {
// If the curator is not a match, check if the exhibition exists in order to provide a better error message.
revert NFTMarketExhibition_Exhibition_Does_Not_Exist();
}
revert NFTMarketExhibition_Caller_Is_Not_Curator(curator);
}
_;
}
/**
* @notice Creates an exhibition.
* @param name The name for this exhibition.
* @param takeRateInBasisPoints The rate of the sale which goes to the msg.sender as the curator of this exhibition.
* @param sellers The list of sellers allowed to list with this exhibition.
* @dev The list of sellers may not be modified after the exhibition is created.
*/
function createExhibition(string calldata name, uint16 takeRateInBasisPoints, address[] calldata sellers)
external
returns (uint256 exhibitionId)
{
if (takeRateInBasisPoints > MAX_EXHIBITION_TAKE_RATE) {
revert NFTMarketExhibition_Take_Rate_Too_High();
}
if (sellers.length == 0) {
revert NFTMarketExhibition_Sellers_Required();
}
if (sellers.length > MAX_SELLER_LIST_LENGTH) {
revert NFTMarketExhibition_Too_Many_Sellers();
}
// Create exhibition
unchecked {
exhibitionId = ++latestExhibitionId;
}
idToExhibition[exhibitionId] = Exhibition({
curator: payable(msg.sender),
takeRateInBasisPoints: takeRateInBasisPoints,
name: name
});
emit ExhibitionCreated({
exhibitionId: exhibitionId,
curator: msg.sender,
name: name,
takeRateInBasisPoints: takeRateInBasisPoints
});
// Populate allow list
for (uint256 i = 0; i < sellers.length; ) {
address seller = sellers[i];
if (exhibitionIdToSellerToIsAllowed[exhibitionId][seller]) {
revert NFTMarketExhibition_Can_Not_Add_Dupe_Seller();
}
if (seller == msg.sender) {
revert NFTMarketExhibition_Curator_Automatically_Allowed();
}
exhibitionIdToSellerToIsAllowed[exhibitionId][seller] = true;
unchecked {
++i;
}
}
emit SellersAddedToExhibition(exhibitionId, sellers);
}
/**
* @notice Deletes an exhibition created by the msg.sender.
* @param exhibitionId The ID of the exhibition to delete.
* @dev Once deleted, any NFTs listed with this exhibition will still be listed but will no longer be associated with
* or share revenue with the exhibition.
*/
function deleteExhibition(uint256 exhibitionId) external onlyExhibitionCurator(exhibitionId) {
delete idToExhibition[exhibitionId];
emit ExhibitionDeleted(exhibitionId);
}
/**
* @notice Assigns an NFT to an exhibition.
* @param nftContract The contract address of the NFT.
* @param tokenId The ID of the NFT.
* @param exhibitionId The ID of the exhibition to list the NFT with.
* @dev This call is a no-op if the `exhibitionId` is 0.
*/
function _addNftToExhibition(address nftContract, uint256 tokenId, uint256 exhibitionId) internal {
if (exhibitionId != 0) {
Exhibition storage exhibition = idToExhibition[exhibitionId];
if (exhibition.curator == address(0)) {
revert NFTMarketExhibition_Exhibition_Does_Not_Exist();
}
if (!exhibitionIdToSellerToIsAllowed[exhibitionId][msg.sender] && exhibition.curator != msg.sender) {
revert NFTMarketExhibition_Seller_Not_Allowed_In_Exhibition();
}
nftContractToTokenIdToExhibitionId[nftContract][tokenId] = exhibitionId;
emit NftAddedToExhibition(nftContract, tokenId, exhibitionId);
}
}
/**
* @notice Returns exhibition details if this NFT was assigned to one, and clears the assignment.
* @return paymentAddress The address to send the payment to, or address(0) if n/a.
* @return takeRateInBasisPoints The rate of the sale which goes to the curator, or 0 if n/a.
* @dev This does not emit NftRemovedFromExhibition, instead it's expected that SellerReferralPaid will be emitted.
*/
function _getExhibitionForPayment(address nftContract, uint256 tokenId)
internal
returns (address payable paymentAddress, uint16 takeRateInBasisPoints)
{
uint256 exhibitionId = nftContractToTokenIdToExhibitionId[nftContract][tokenId];
if (exhibitionId != 0) {
paymentAddress = idToExhibition[exhibitionId].curator;
takeRateInBasisPoints = idToExhibition[exhibitionId].takeRateInBasisPoints;
delete nftContractToTokenIdToExhibitionId[nftContract][tokenId];
}
}
/**
* @notice Clears an NFT's association with an exhibition.
*/
function _removeNftFromExhibition(address nftContract, uint256 tokenId) internal {
uint256 exhibitionId = nftContractToTokenIdToExhibitionId[nftContract][tokenId];
if (exhibitionId != 0) {
delete nftContractToTokenIdToExhibitionId[nftContract][tokenId];
emit NftRemovedFromExhibition(nftContract, tokenId, exhibitionId);
}
}
/**
* @notice Returns exhibition details for a given ID.
* @param exhibitionId The ID of the exhibition to look up.
* @return name The name of the exhibition.
* @return curator The curator of the exhibition.
* @return takeRateInBasisPoints The rate of the sale which goes to the curator.
* @dev If the exhibition does not exist or has since been deleted, the curator will be address(0).
*/
function getExhibition(uint256 exhibitionId)
external
view
returns (string memory name, address payable curator, uint16 takeRateInBasisPoints)
{
Exhibition memory exhibition = idToExhibition[exhibitionId];
name = exhibition.name;
curator = exhibition.curator;
takeRateInBasisPoints = exhibition.takeRateInBasisPoints;
}
/**
* @notice Returns the exhibition ID for a given NFT.
* @param nftContract The contract address of the NFT.
* @param tokenId The ID of the NFT.
* @return exhibitionId The ID of the exhibition this NFT is assigned to, or 0 if it's not assigned to an exhibition.
*/
function getExhibitionIdForNft(address nftContract, uint256 tokenId) external view returns (uint256 exhibitionId) {
exhibitionId = nftContractToTokenIdToExhibitionId[nftContract][tokenId];
}
/**
* @notice Checks if a given seller is approved to list with a given exhibition.
* @param exhibitionId The ID of the exhibition to check.
* @param seller The address of the seller to check.
* @return allowedSeller True if the seller is approved to list with the exhibition.
*/
function isAllowedSellerForExhibition(uint256 exhibitionId, address seller)
external
view
returns (bool allowedSeller)
{
address curator = idToExhibition[exhibitionId].curator;
if (curator != address(0)) {
allowedSeller = exhibitionIdToSellerToIsAllowed[exhibitionId][seller] || seller == curator;
}
}
/**
* @notice This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
* @dev This file uses a total of 500 slots.
*/
uint256[496] private __gap;
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
import "../../libraries/TimeLibrary.sol";
import "../shared/MarketFees.sol";
import "../shared/FoundationTreasuryNode.sol";
import "../shared/FETHNode.sol";
import "../shared/SendValueWithFallbackWithdraw.sol";
import "./NFTMarketCore.sol";
error NFTMarketOffer_Cannot_Be_Made_While_In_Auction();
/// @param currentOfferAmount The current highest offer available for this NFT.
error NFTMarketOffer_Offer_Below_Min_Amount(uint256 currentOfferAmount);
/// @param expiry The time at which the offer had expired.
error NFTMarketOffer_Offer_Expired(uint256 expiry);
/// @param currentOfferFrom The address of the collector which has made the current highest offer.
error NFTMarketOffer_Offer_From_Does_Not_Match(address currentOfferFrom);
/// @param minOfferAmount The minimum amount that must be offered in order for it to be accepted.
error NFTMarketOffer_Offer_Must_Be_At_Least_Min_Amount(uint256 minOfferAmount);
/**
* @title Allows collectors to make an offer for an NFT, valid for 24-25 hours.
* @notice Funds are escrowed in the FETH ERC-20 token contract.
* @author batu-inal & HardlyDifficult
*/
abstract contract NFTMarketOffer is
Initializable,
FoundationTreasuryNode,
FETHNode,
NFTMarketCore,
ReentrancyGuardUpgradeable,
SendValueWithFallbackWithdraw,
MarketFees
{
using AddressUpgradeable for address;
using TimeLibrary for uint32;
/// @notice Stores offer details for a specific NFT.
struct Offer {
// Slot 1: When increasing an offer, only this slot is updated.
/// @notice The expiration timestamp of when this offer expires.
uint32 expiration;
/// @notice The amount, in wei, of the highest offer.
uint96 amount;
/// @notice First slot (of 16B) used for the offerReferrerAddress.
// The offerReferrerAddress is the address used to pay the
// referrer on an accepted offer.
uint128 offerReferrerAddressSlot0;
// Slot 2: When the buyer changes, both slots need updating
/// @notice The address of the collector who made this offer.
address buyer;
/// @notice Second slot (of 4B) used for the offerReferrerAddress.
uint32 offerReferrerAddressSlot1;
// 96 bits (12B) are available in slot 1.
}
/// @notice Stores the highest offer for each NFT.
mapping(address => mapping(uint256 => Offer)) private nftContractToIdToOffer;
/**
* @notice Emitted when an offer is accepted,
* indicating that the NFT has been transferred and revenue from the sale distributed.
* @dev The accepted total offer amount is `totalFees` + `creatorRev` + `sellerRev`.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param buyer The address of the collector that made the offer which was accepted.
* @param seller The address of the seller which accepted the offer.
* @param totalFees The amount of ETH that was sent to Foundation & referrals for this sale.
* @param creatorRev The amount of ETH that was sent to the creator for this sale.
* @param sellerRev The amount of ETH that was sent to the owner for this sale.
*/
event OfferAccepted(
address indexed nftContract,
uint256 indexed tokenId,
address indexed buyer,
address seller,
uint256 totalFees,
uint256 creatorRev,
uint256 sellerRev
);
/**
* @notice Emitted when an offer is invalidated due to other market activity.
* When this occurs, the collector which made the offer has their FETH balance unlocked
* and the funds are available to place other offers or to be withdrawn.
* @dev This occurs when the offer is no longer eligible to be accepted,
* e.g. when a bid is placed in an auction for this NFT.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
*/
event OfferInvalidated(address indexed nftContract, uint256 indexed tokenId);
/**
* @notice Emitted when an offer is made.
* @dev The `amount` of the offer is locked in the FETH ERC-20 contract, guaranteeing that the funds
* remain available until the `expiration` date.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param buyer The address of the collector that made the offer to buy this NFT.
* @param amount The amount, in wei, of the offer.
* @param expiration The expiration timestamp for the offer.
*/
event OfferMade(
address indexed nftContract,
uint256 indexed tokenId,
address indexed buyer,
uint256 amount,
uint256 expiration
);
/**
* @notice Accept the highest offer for an NFT.
* @dev The offer must not be expired and the NFT owned + approved by the seller or
* available in the market contract's escrow.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param offerFrom The address of the collector that you wish to sell to.
* If the current highest offer is not from this user, the transaction will revert.
* This could happen if a last minute offer was made by another collector,
* and would require the seller to try accepting again.
* @param minAmount The minimum value of the highest offer for it to be accepted.
* If the value is less than this amount, the transaction will revert.
* This could happen if the original offer expires and is replaced with a smaller offer.
*/
function acceptOffer(address nftContract, uint256 tokenId, address offerFrom, uint256 minAmount)
external
nonReentrant
{
Offer storage offer = nftContractToIdToOffer[nftContract][tokenId];
// Validate offer expiry and amount
if (offer.expiration.hasExpired()) {
revert NFTMarketOffer_Offer_Expired(offer.expiration);
} else if (offer.amount < minAmount) {
revert NFTMarketOffer_Offer_Below_Min_Amount(offer.amount);
}
// Validate the buyer
if (offer.buyer != offerFrom) {
revert NFTMarketOffer_Offer_From_Does_Not_Match(offer.buyer);
}
_acceptOffer(nftContract, tokenId);
}
/**
* @notice Make an offer for any NFT which is valid for 24-25 hours.
* The funds will be locked in the FETH token contract and become available once the offer is outbid or has expired.
* @dev An offer may be made for an NFT before it is minted, although we generally not recommend you do that.
* If there is a buy price set at this price or lower, that will be accepted instead of making an offer.
* `msg.value` must be <= `amount` and any delta will be taken from the account's available FETH balance.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param amount The amount to offer for this NFT.
* @param referrer The referrer address for the offer.
* @return expiration The timestamp for when this offer will expire.
* This is provided as a return value in case another contract would like to leverage this information,
* user's should refer to the expiration in the `OfferMade` event log.
* If the buy price is accepted instead, `0` is returned as the expiration since that's n/a.
*/
function makeOfferV2(address nftContract, uint256 tokenId, uint256 amount, address payable referrer)
external
payable
returns (uint256 expiration)
{
// If there is a buy price set at this price or lower, accept that instead.
if (_autoAcceptBuyPrice(nftContract, tokenId, amount)) {
// If the buy price is accepted, `0` is returned as the expiration since that's n/a.
return 0;
}
if (_isInActiveAuction(nftContract, tokenId)) {
revert NFTMarketOffer_Cannot_Be_Made_While_In_Auction();
}
Offer storage offer = nftContractToIdToOffer[nftContract][tokenId];
if (offer.expiration.hasExpired()) {
// This is a new offer for the NFT (no other offer found or the previous offer expired)
// Lock the offer amount in FETH until the offer expires in 24-25 hours.
expiration = feth.marketLockupFor{ value: msg.value }(msg.sender, amount);
} else {
// A previous offer exists and has not expired
uint256 minIncrement = _getMinIncrement(offer.amount);
if (amount < minIncrement) {
// A non-trivial increase in price is required to avoid sniping
revert NFTMarketOffer_Offer_Must_Be_At_Least_Min_Amount(minIncrement);
}
// Unlock the previous offer so that the FETH tokens are available for other offers or to transfer / withdraw
// and lock the new offer amount in FETH until the offer expires in 24-25 hours.
expiration = feth.marketChangeLockup{ value: msg.value }(
offer.buyer,
offer.expiration,
offer.amount,
msg.sender,
amount
);
}
// Record offer details
offer.buyer = msg.sender;
// The FETH contract guarantees that the expiration fits into 32 bits.
offer.expiration = uint32(expiration);
// `amount` is capped by the ETH provided, which cannot realistically overflow 96 bits.
offer.amount = uint96(amount);
// Set offerReferrerAddressSlot0 to the first 16B of the referrer address.
// By shifting the referrer 32 bits to the right we obtain the first 16B.
offer.offerReferrerAddressSlot0 = uint128(uint160(address(referrer)) >> 32);
// Set offerReferrerAddressSlot1 to the last 4B of the referrer address.
// By casting the referrer address to 32bits we discard the first 16B.
offer.offerReferrerAddressSlot1 = uint32(uint160(address(referrer)));
emit OfferMade(nftContract, tokenId, msg.sender, amount, expiration);
}
/**
* @notice Accept the highest offer for an NFT from the `msg.sender` account.
* The NFT will be transferred to the buyer and revenue from the sale will be distributed.
* @dev The caller must validate the expiry and amount before calling this helper.
* This may invalidate other market tools, such as clearing the buy price if set.
*/
function _acceptOffer(address nftContract, uint256 tokenId) private {
Offer memory offer = nftContractToIdToOffer[nftContract][tokenId];
// Remove offer
delete nftContractToIdToOffer[nftContract][tokenId];
// Withdraw ETH from the buyer's account in the FETH token contract.
feth.marketWithdrawLocked(offer.buyer, offer.expiration, offer.amount);
// Transfer the NFT to the buyer.
try
IERC721(nftContract).transferFrom(msg.sender, offer.buyer, tokenId) // solhint-disable-next-line no-empty-blocks
{
// NFT was in the seller's wallet so the transfer is complete.
} catch {
// If the transfer fails then attempt to transfer from escrow instead.
// This should revert if `msg.sender` is not the owner of this NFT.
_transferFromEscrow(nftContract, tokenId, offer.buyer, msg.sender);
}
// Distribute revenue for this sale leveraging the ETH received from the FETH contract in the line above.
(uint256 totalFees, uint256 creatorRev, uint256 sellerRev) = _distributeFunds(
nftContract,
tokenId,
payable(msg.sender),
offer.amount,
_getOfferReferrerFromSlots(offer.offerReferrerAddressSlot0, offer.offerReferrerAddressSlot1),
payable(0),
0
);
emit OfferAccepted(nftContract, tokenId, offer.buyer, msg.sender, totalFees, creatorRev, sellerRev);
}
/**
* @inheritdoc NFTMarketCore
* @dev Invalidates the highest offer when an auction is kicked off, if one is found.
*/
function _beforeAuctionStarted(address nftContract, uint256 tokenId) internal virtual override {
_invalidateOffer(nftContract, tokenId);
super._beforeAuctionStarted(nftContract, tokenId);
}
/**
* @inheritdoc NFTMarketCore
*/
function _autoAcceptOffer(address nftContract, uint256 tokenId, uint256 minAmount) internal override returns (bool) {
Offer storage offer = nftContractToIdToOffer[nftContract][tokenId];
if (offer.expiration.hasExpired() || offer.amount < minAmount) {
// No offer found, the most recent offer is now expired, or the highest offer is below the minimum amount.
return false;
}
_acceptOffer(nftContract, tokenId);
return true;
}
/**
* @inheritdoc NFTMarketCore
*/
function _cancelSendersOffer(address nftContract, uint256 tokenId) internal override {
Offer storage offer = nftContractToIdToOffer[nftContract][tokenId];
if (offer.buyer == msg.sender) {
_invalidateOffer(nftContract, tokenId);
}
}
/**
* @notice Invalidates the offer and frees ETH from escrow, if the offer has not already expired.
* @dev Offers are not invalidated when the NFT is purchased by accepting the buy price unless it
* was purchased by the same user.
* The user which just purchased the NFT may have buyer's remorse and promptly decide they want a fast exit,
* accepting a small loss to limit their exposure.
*/
function _invalidateOffer(address nftContract, uint256 tokenId) private {
if (!nftContractToIdToOffer[nftContract][tokenId].expiration.hasExpired()) {
// An offer was found and it has not already expired
Offer memory offer = nftContractToIdToOffer[nftContract][tokenId];
// Remove offer
delete nftContractToIdToOffer[nftContract][tokenId];
// Unlock the offer so that the FETH tokens are available for other offers or to transfer / withdraw
feth.marketUnlockFor(offer.buyer, offer.expiration, offer.amount);
emit OfferInvalidated(nftContract, tokenId);
}
}
/**
* @notice Returns the minimum amount a collector must offer for this NFT in order for the offer to be valid.
* @dev Offers for this NFT which are less than this value will revert.
* Once the previous offer has expired smaller offers can be made.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @return minimum The minimum amount that must be offered for this NFT.
*/
function getMinOfferAmount(address nftContract, uint256 tokenId) external view returns (uint256 minimum) {
Offer storage offer = nftContractToIdToOffer[nftContract][tokenId];
if (!offer.expiration.hasExpired()) {
return _getMinIncrement(offer.amount);
}
// Absolute min is anything > 0
return 1;
}
/**
* @notice Returns details about the current highest offer for an NFT.
* @dev Default values are returned if there is no offer or the offer has expired.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @return buyer The address of the buyer that made the current highest offer.
* Returns `address(0)` if there is no offer or the most recent offer has expired.
* @return expiration The timestamp that the current highest offer expires.
* Returns `0` if there is no offer or the most recent offer has expired.
* @return amount The amount being offered for this NFT.
* Returns `0` if there is no offer or the most recent offer has expired.
*/
function getOffer(address nftContract, uint256 tokenId)
external
view
returns (address buyer, uint256 expiration, uint256 amount)
{
Offer storage offer = nftContractToIdToOffer[nftContract][tokenId];
if (offer.expiration.hasExpired()) {
// Offer not found or has expired
return (address(0), 0, 0);
}
// An offer was found and it has not yet expired.
return (offer.buyer, offer.expiration, offer.amount);
}
/**
* @notice Returns the current highest offer's referral for an NFT.
* @dev Default value of `payable(0)` is returned if
* there is no offer, the offer has expired or does not have a referral.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @return referrer The payable address of the referrer for the offer.
*/
function getOfferReferrer(address nftContract, uint256 tokenId) external view returns (address payable referrer) {
Offer storage offer = nftContractToIdToOffer[nftContract][tokenId];
if (offer.expiration.hasExpired()) {
// Offer not found or has expired
return payable(0);
}
return _getOfferReferrerFromSlots(offer.offerReferrerAddressSlot0, offer.offerReferrerAddressSlot1);
}
function _getOfferReferrerFromSlots(uint128 offerReferrerAddressSlot0, uint32 offerReferrerAddressSlot1)
private
pure
returns (address payable referrer)
{
// Stitch offerReferrerAddressSlot0 and offerReferrerAddressSlot1 to obtain the payable offerReferrerAddress.
// Left shift offerReferrerAddressSlot0 by 32 bits OR it with offerReferrerAddressSlot1.
referrer = payable(address((uint160(offerReferrerAddressSlot0) << 32) | uint160(offerReferrerAddressSlot1)));
}
/**
* @notice This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[1_000] private __gap;
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
/**
* @title Reserves space previously occupied by private sales.
* @author batu-inal & HardlyDifficult
*/
abstract contract NFTMarketPrivateSaleGap {
// Original data:
// bytes32 private __gap_was_DOMAIN_SEPARATOR;
// mapping(address => mapping(uint256 => mapping(address => mapping(address => mapping(uint256 =>
// mapping(uint256 => bool)))))) private privateSaleInvalidated;
// uint256[999] private __gap;
/**
* @notice This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
* @dev 1 slot was consumed by privateSaleInvalidated.
*/
uint256[1001] private __gap;
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
import "../../libraries/TimeLibrary.sol";
import "../shared/FoundationTreasuryNode.sol";
import "../shared/FETHNode.sol";
import "../shared/MarketFees.sol";
import "../shared/MarketSharedCore.sol";
import "../shared/SendValueWithFallbackWithdraw.sol";
import "./NFTMarketAuction.sol";
import "./NFTMarketCore.sol";
import "./NFTMarketExhibition.sol";
/// @param auctionId The already listed auctionId for this NFT.
error NFTMarketReserveAuction_Already_Listed(uint256 auctionId);
/// @param minAmount The minimum amount that must be bid in order for it to be accepted.
error NFTMarketReserveAuction_Bid_Must_Be_At_Least_Min_Amount(uint256 minAmount);
/// @param reservePrice The current reserve price.
error NFTMarketReserveAuction_Cannot_Bid_Lower_Than_Reserve_Price(uint256 reservePrice);
/// @param endTime The timestamp at which the auction had ended.
error NFTMarketReserveAuction_Cannot_Bid_On_Ended_Auction(uint256 endTime);
error NFTMarketReserveAuction_Cannot_Bid_On_Nonexistent_Auction();
error NFTMarketReserveAuction_Cannot_Finalize_Already_Settled_Auction();
/// @param endTime The timestamp at which the auction will end.
error NFTMarketReserveAuction_Cannot_Finalize_Auction_In_Progress(uint256 endTime);
error NFTMarketReserveAuction_Cannot_Rebid_Over_Outstanding_Bid();
error NFTMarketReserveAuction_Cannot_Update_Auction_In_Progress();
/// @param maxDuration The maximum configuration for a duration of the auction, in seconds.
error NFTMarketReserveAuction_Exceeds_Max_Duration(uint256 maxDuration);
/// @param extensionDuration The extension duration, in seconds.
error NFTMarketReserveAuction_Less_Than_Extension_Duration(uint256 extensionDuration);
error NFTMarketReserveAuction_Must_Set_Non_Zero_Reserve_Price();
/// @param seller The current owner of the NFT.
error NFTMarketReserveAuction_Not_Matching_Seller(address seller);
/// @param owner The current owner of the NFT.
error NFTMarketReserveAuction_Only_Owner_Can_Update_Auction(address owner);
error NFTMarketReserveAuction_Price_Already_Set();
error NFTMarketReserveAuction_Too_Much_Value_Provided();
/**
* @title Allows the owner of an NFT to list it in auction.
* @notice NFTs in auction are escrowed in the market contract.
* @dev There is room to optimize the storage for auctions, significantly reducing gas costs.
* This may be done in the future, but for now it will remain as is in order to ease upgrade compatibility.
* @author batu-inal & HardlyDifficult
*/
abstract contract NFTMarketReserveAuction is
Initializable,
FoundationTreasuryNode,
FETHNode,
MarketSharedCore,
NFTMarketCore,
ReentrancyGuardUpgradeable,
SendValueWithFallbackWithdraw,
MarketFees,
NFTMarketExhibition,
NFTMarketAuction
{
using TimeLibrary for uint256;
/// @notice The auction configuration for a specific NFT.
struct ReserveAuction {
/// @notice The address of the NFT contract.
address nftContract;
/// @notice The id of the NFT.
uint256 tokenId;
/// @notice The owner of the NFT which listed it in auction.
address payable seller;
/// @notice The duration for this auction.
uint256 duration;
/// @notice The extension window for this auction.
uint256 extensionDuration;
/// @notice The time at which this auction will not accept any new bids.
/// @dev This is `0` until the first bid is placed.
uint256 endTime;
/// @notice The current highest bidder in this auction.
/// @dev This is `address(0)` until the first bid is placed.
address payable bidder;
/// @notice The latest price of the NFT in this auction.
/// @dev This is set to the reserve price, and then to the highest bid once the auction has started.
uint256 amount;
}
/// @notice Stores the auction configuration for a specific NFT.
/// @dev This allows us to modify the storage struct without changing external APIs.
struct ReserveAuctionStorage {
/// @notice The address of the NFT contract.
address nftContract;
/// @notice The id of the NFT.
uint256 tokenId;
/// @notice The owner of the NFT which listed it in auction.
address payable seller;
/// @notice First slot (of 12B) used for the bidReferrerAddress.
/// The bidReferrerAddress is the address used to pay the referrer on finalize.
/// @dev This approach is used in order to pack storage, saving gas.
uint96 bidReferrerAddressSlot0;
/// @dev This field is no longer used.
uint256 __gap_was_duration;
/// @dev This field is no longer used.
uint256 __gap_was_extensionDuration;
/// @notice The time at which this auction will not accept any new bids.
/// @dev This is `0` until the first bid is placed.
uint256 endTime;
/// @notice The current highest bidder in this auction.
/// @dev This is `address(0)` until the first bid is placed.
address payable bidder;
/// @notice Second slot (of 8B) used for the bidReferrerAddress.
uint64 bidReferrerAddressSlot1;
/// @notice The latest price of the NFT in this auction.
/// @dev This is set to the reserve price, and then to the highest bid once the auction has started.
uint256 amount;
}
/// @notice The auction configuration for a specific auction id.
mapping(address => mapping(uint256 => uint256)) private nftContractToTokenIdToAuctionId;
/// @notice The auction id for a specific NFT.
/// @dev This is deleted when an auction is finalized or canceled.
mapping(uint256 => ReserveAuctionStorage) private auctionIdToAuction;
/**
* @dev Removing old unused variables in an upgrade safe way. Was:
* uint256 private __gap_was_minPercentIncrementInBasisPoints;
* uint256 private __gap_was_maxBidIncrementRequirement;
* uint256 private __gap_was_duration;
* uint256 private __gap_was_extensionDuration;
* uint256 private __gap_was_goLiveDate;
*/
uint256[5] private __gap_was_config;
/// @notice How long an auction lasts for once the first bid has been received.
uint256 private immutable DURATION;
/// @notice The window for auction extensions, any bid placed in the final 15 minutes
/// of an auction will reset the time remaining to 15 minutes.
uint256 private constant EXTENSION_DURATION = 15 minutes;
/// @notice Caps the max duration that may be configured so that overflows will not occur.
uint256 private constant MAX_MAX_DURATION = 1_000 days;
/**
* @notice Emitted when a bid is placed.
* @param auctionId The id of the auction this bid was for.
* @param bidder The address of the bidder.
* @param amount The amount of the bid.
* @param endTime The new end time of the auction (which may have been set or extended by this bid).
*/
event ReserveAuctionBidPlaced(uint256 indexed auctionId, address indexed bidder, uint256 amount, uint256 endTime);
/**
* @notice Emitted when an auction is canceled.
* @dev This is only possible if the auction has not received any bids.
* @param auctionId The id of the auction that was canceled.
*/
event ReserveAuctionCanceled(uint256 indexed auctionId);
/**
* @notice Emitted when an NFT is listed for auction.
* @param seller The address of the seller.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param duration The duration of the auction (always 24-hours).
* @param extensionDuration The duration of the auction extension window (always 15-minutes).
* @param reservePrice The reserve price to kick off the auction.
* @param auctionId The id of the auction that was created.
*/
event ReserveAuctionCreated(
address indexed seller,
address indexed nftContract,
uint256 indexed tokenId,
uint256 duration,
uint256 extensionDuration,
uint256 reservePrice,
uint256 auctionId
);
/**
* @notice Emitted when an auction that has already ended is finalized,
* indicating that the NFT has been transferred and revenue from the sale distributed.
* @dev The amount of the highest bid / final sale price for this auction
* is `totalFees` + `creatorRev` + `sellerRev`.
* @param auctionId The id of the auction that was finalized.
* @param seller The address of the seller.
* @param bidder The address of the highest bidder that won the NFT.
* @param totalFees The amount of ETH that was sent to Foundation & referrals for this sale.
* @param creatorRev The amount of ETH that was sent to the creator for this sale.
* @param sellerRev The amount of ETH that was sent to the owner for this sale.
*/
event ReserveAuctionFinalized(
uint256 indexed auctionId,
address indexed seller,
address indexed bidder,
uint256 totalFees,
uint256 creatorRev,
uint256 sellerRev
);
/**
* @notice Emitted when an auction is invalidated due to other market activity.
* @dev This occurs when the NFT is sold another way, such as with `buy` or `acceptOffer`.
* @param auctionId The id of the auction that was invalidated.
*/
event ReserveAuctionInvalidated(uint256 indexed auctionId);
/**
* @notice Emitted when the auction's reserve price is changed.
* @dev This is only possible if the auction has not received any bids.
* @param auctionId The id of the auction that was updated.
* @param reservePrice The new reserve price for the auction.
*/
event ReserveAuctionUpdated(uint256 indexed auctionId, uint256 reservePrice);
/// @notice Confirms that the reserve price is not zero.
modifier onlyValidAuctionConfig(uint256 reservePrice) {
if (reservePrice == 0) {
revert NFTMarketReserveAuction_Must_Set_Non_Zero_Reserve_Price();
}
_;
}
/**
* @notice Configures the duration for auctions.
* @param duration The duration for auctions, in seconds.
*/
constructor(uint256 duration) {
if (duration > MAX_MAX_DURATION) {
// This ensures that math in this file will not overflow due to a huge duration.
revert NFTMarketReserveAuction_Exceeds_Max_Duration(MAX_MAX_DURATION);
}
if (duration < EXTENSION_DURATION) {
// The auction duration configuration must be greater than the extension window of 15 minutes
revert NFTMarketReserveAuction_Less_Than_Extension_Duration(EXTENSION_DURATION);
}
DURATION = duration;
}
/**
* @notice If an auction has been created but has not yet received bids, it may be canceled by the seller.
* @dev The NFT is transferred back to the owner unless there is still a buy price set.
* @param auctionId The id of the auction to cancel.
*/
function cancelReserveAuction(uint256 auctionId) external nonReentrant {
ReserveAuctionStorage memory auction = auctionIdToAuction[auctionId];
if (auction.seller != msg.sender) {
revert NFTMarketReserveAuction_Only_Owner_Can_Update_Auction(auction.seller);
}
if (auction.endTime != 0) {
revert NFTMarketReserveAuction_Cannot_Update_Auction_In_Progress();
}
// Remove the auction.
delete nftContractToTokenIdToAuctionId[auction.nftContract][auction.tokenId];
delete auctionIdToAuction[auctionId];
_removeNftFromExhibition(auction.nftContract, auction.tokenId);
// Transfer the NFT unless it still has a buy price set.
_transferFromEscrowIfAvailable(auction.nftContract, auction.tokenId, auction.seller);
emit ReserveAuctionCanceled(auctionId);
}
/**
* @notice [DEPRECATED] use `createReserveAuctionV2` instead.
* Creates an auction for the given NFT.
* The NFT is held in escrow until the auction is finalized or canceled.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param reservePrice The initial reserve price for the auction.
*/
function createReserveAuction(address nftContract, uint256 tokenId, uint256 reservePrice) external {
createReserveAuctionV2({ nftContract: nftContract, tokenId: tokenId, reservePrice: reservePrice, exhibitionId: 0 });
}
/**
* @notice Creates an auction for the given NFT.
* The NFT is held in escrow until the auction is finalized or canceled.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param reservePrice The initial reserve price for the auction.
* @param exhibitionId The exhibition to list with, or 0 if n/a.
* @return auctionId The id of the auction that was created.
*/
function createReserveAuctionV2(address nftContract, uint256 tokenId, uint256 reservePrice, uint256 exhibitionId)
public
nonReentrant
onlyValidAuctionConfig(reservePrice)
returns (uint256 auctionId)
{
auctionId = _getNextAndIncrementAuctionId();
// If the `msg.sender` is not the owner of the NFT, transferring into escrow should fail.
_transferToEscrow(nftContract, tokenId);
// This check must be after _transferToEscrow in case auto-settle was required
if (nftContractToTokenIdToAuctionId[nftContract][tokenId] != 0) {
revert NFTMarketReserveAuction_Already_Listed(nftContractToTokenIdToAuctionId[nftContract][tokenId]);
}
// Store the auction details
nftContractToTokenIdToAuctionId[nftContract][tokenId] = auctionId;
ReserveAuctionStorage storage auction = auctionIdToAuction[auctionId];
auction.nftContract = nftContract;
auction.tokenId = tokenId;
auction.seller = payable(msg.sender);
auction.amount = reservePrice;
_addNftToExhibition(nftContract, tokenId, exhibitionId);
emit ReserveAuctionCreated({
seller: msg.sender,
nftContract: nftContract,
tokenId: tokenId,
duration: DURATION,
extensionDuration: EXTENSION_DURATION,
reservePrice: reservePrice,
auctionId: auctionId
});
}
/**
* @notice Once the countdown has expired for an auction, anyone can settle the auction.
* This will send the NFT to the highest bidder and distribute revenue for this sale.
* @param auctionId The id of the auction to settle.
*/
function finalizeReserveAuction(uint256 auctionId) external nonReentrant {
if (auctionIdToAuction[auctionId].endTime == 0) {
revert NFTMarketReserveAuction_Cannot_Finalize_Already_Settled_Auction();
}
_finalizeReserveAuction({ auctionId: auctionId, keepInEscrow: false });
}
/**
* @notice [DEPRECATED] use `placeBidV2` instead.
* Place a bid in an auction.
* A bidder may place a bid which is at least the value defined by `getMinBidAmount`.
* If this is the first bid on the auction, the countdown will begin.
* If there is already an outstanding bid, the previous bidder will be refunded at this time
* and if the bid is placed in the final moments of the auction, the countdown may be extended.
* @param auctionId The id of the auction to bid on.
*/
function placeBid(uint256 auctionId) external payable {
placeBidV2({ auctionId: auctionId, amount: msg.value, referrer: payable(0) });
}
/**
* @notice Place a bid in an auction.
* A bidder may place a bid which is at least the amount defined by `getMinBidAmount`.
* If this is the first bid on the auction, the countdown will begin.
* If there is already an outstanding bid, the previous bidder will be refunded at this time
* and if the bid is placed in the final moments of the auction, the countdown may be extended.
* @dev `amount` - `msg.value` is withdrawn from the bidder's FETH balance.
* @param auctionId The id of the auction to bid on.
* @param amount The amount to bid, if this is more than `msg.value` funds will be withdrawn from your FETH balance.
* @param referrer The address of the referrer of this bid, or 0 if n/a.
*/
/* solhint-disable-next-line code-complexity */
function placeBidV2(uint256 auctionId, uint256 amount, address payable referrer) public payable nonReentrant {
ReserveAuctionStorage storage auction = auctionIdToAuction[auctionId];
if (auction.amount == 0) {
// No auction found
revert NFTMarketReserveAuction_Cannot_Bid_On_Nonexistent_Auction();
} else if (amount < msg.value) {
// The amount is specified by the bidder, so if too much ETH is sent then something went wrong.
revert NFTMarketReserveAuction_Too_Much_Value_Provided();
}
uint256 endTime = auction.endTime;
// Store the bid referral
if (referrer != address(0) || endTime != 0) {
auction.bidReferrerAddressSlot0 = uint96(uint160(address(referrer)) >> 64);
auction.bidReferrerAddressSlot1 = uint64(uint160(address(referrer)));
}
if (endTime == 0) {
// This is the first bid, kicking off the auction.
if (amount < auction.amount) {
// The bid must be >= the reserve price.
revert NFTMarketReserveAuction_Cannot_Bid_Lower_Than_Reserve_Price(auction.amount);
}
// Notify other market tools that an auction for this NFT has been kicked off.
// The only state change before this call is potentially withdrawing funds from FETH.
_beforeAuctionStarted(auction.nftContract, auction.tokenId);
// Store the bid details.
auction.amount = amount;
auction.bidder = payable(msg.sender);
// On the first bid, set the endTime to now + duration.
unchecked {
// Duration is always set to 24hrs so the below can't overflow.
endTime = block.timestamp + DURATION;
}
auction.endTime = endTime;
} else {
if (endTime.hasExpired()) {
// The auction has already ended.
revert NFTMarketReserveAuction_Cannot_Bid_On_Ended_Auction(endTime);
} else if (auction.bidder == msg.sender) {
// We currently do not allow a bidder to increase their bid unless another user has outbid them first.
revert NFTMarketReserveAuction_Cannot_Rebid_Over_Outstanding_Bid();
} else {
uint256 minIncrement = _getMinIncrement(auction.amount);
if (amount < minIncrement) {
// If this bid outbids another, it must be at least 10% greater than the last bid.
revert NFTMarketReserveAuction_Bid_Must_Be_At_Least_Min_Amount(minIncrement);
}
}
// Cache and update bidder state
uint256 originalAmount = auction.amount;
address payable originalBidder = auction.bidder;
auction.amount = amount;
auction.bidder = payable(msg.sender);
unchecked {
// When a bid outbids another, check to see if a time extension should apply.
// We confirmed that the auction has not ended, so endTime is always >= the current timestamp.
// Current time plus extension duration (always 15 mins) cannot overflow.
uint256 endTimeWithExtension = block.timestamp + EXTENSION_DURATION;
if (endTime < endTimeWithExtension) {
endTime = endTimeWithExtension;
auction.endTime = endTime;
}
}
// Refund the previous bidder
_sendValueWithFallbackWithdraw({
user: originalBidder,
amount: originalAmount,
gasLimit: SEND_VALUE_GAS_LIMIT_SINGLE_RECIPIENT
});
}
_tryUseFETHBalance({ totalAmount: amount, shouldRefundSurplus: false });
emit ReserveAuctionBidPlaced({ auctionId: auctionId, bidder: msg.sender, amount: amount, endTime: endTime });
}
/**
* @notice If an auction has been created but has not yet received bids, the reservePrice may be
* changed by the seller.
* @param auctionId The id of the auction to change.
* @param reservePrice The new reserve price for this auction.
*/
function updateReserveAuction(uint256 auctionId, uint256 reservePrice) external onlyValidAuctionConfig(reservePrice) {
ReserveAuctionStorage storage auction = auctionIdToAuction[auctionId];
if (auction.seller != msg.sender) {
revert NFTMarketReserveAuction_Only_Owner_Can_Update_Auction(auction.seller);
} else if (auction.endTime != 0) {
revert NFTMarketReserveAuction_Cannot_Update_Auction_In_Progress();
} else if (auction.amount == reservePrice) {
revert NFTMarketReserveAuction_Price_Already_Set();
}
// Update the current reserve price.
auction.amount = reservePrice;
emit ReserveAuctionUpdated(auctionId, reservePrice);
}
/**
* @notice Settle an auction that has already ended.
* This will send the NFT to the highest bidder and distribute revenue for this sale.
* @param keepInEscrow If true, the NFT will be kept in escrow to save gas by avoiding
* redundant transfers if the NFT should remain in escrow, such as when the new owner
* sets a buy price or lists it in a new auction.
*/
function _finalizeReserveAuction(uint256 auctionId, bool keepInEscrow) private {
ReserveAuctionStorage memory auction = auctionIdToAuction[auctionId];
if (!auction.endTime.hasExpired()) {
revert NFTMarketReserveAuction_Cannot_Finalize_Auction_In_Progress(auction.endTime);
}
(
address payable sellerReferrerPaymentAddress,
uint16 sellerReferrerTakeRateInBasisPoints
) = _getExhibitionForPayment(auction.nftContract, auction.tokenId);
// Remove the auction.
delete nftContractToTokenIdToAuctionId[auction.nftContract][auction.tokenId];
delete auctionIdToAuction[auctionId];
if (!keepInEscrow) {
// The seller was authorized when the auction was originally created
super._transferFromEscrow({
nftContract: auction.nftContract,
tokenId: auction.tokenId,
recipient: auction.bidder,
authorizeSeller: address(0)
});
}
// Distribute revenue for this sale.
(uint256 totalFees, uint256 creatorRev, uint256 sellerRev) = _distributeFunds(
auction.nftContract,
auction.tokenId,
auction.seller,
auction.amount,
payable(address((uint160(auction.bidReferrerAddressSlot0) << 64) | uint160(auction.bidReferrerAddressSlot1))),
sellerReferrerPaymentAddress,
sellerReferrerTakeRateInBasisPoints
);
emit ReserveAuctionFinalized(auctionId, auction.seller, auction.bidder, totalFees, creatorRev, sellerRev);
}
/**
* @inheritdoc NFTMarketCore
* @dev If an auction is found:
* - If the auction is over, it will settle the auction and confirm the new seller won the auction.
* - If the auction has not received a bid, it will invalidate the auction.
* - If the auction is in progress, this will revert.
*/
function _transferFromEscrow(address nftContract, uint256 tokenId, address recipient, address authorizeSeller)
internal
virtual
override
{
uint256 auctionId = nftContractToTokenIdToAuctionId[nftContract][tokenId];
if (auctionId != 0) {
ReserveAuctionStorage storage auction = auctionIdToAuction[auctionId];
if (auction.endTime == 0) {
// The auction has not received any bids yet so it may be invalided.
if (authorizeSeller != address(0) && auction.seller != authorizeSeller) {
// The account trying to transfer the NFT is not the current owner.
revert NFTMarketReserveAuction_Not_Matching_Seller(auction.seller);
}
// Remove the auction.
delete nftContractToTokenIdToAuctionId[nftContract][tokenId];
delete auctionIdToAuction[auctionId];
_removeNftFromExhibition(nftContract, tokenId);
emit ReserveAuctionInvalidated(auctionId);
} else {
// If the auction has ended, the highest bidder will be the new owner
// and if the auction is in progress, this will revert.
// `authorizeSeller != address(0)` does not apply here since an unsettled auction must go
// through this path to know who the authorized seller should be.
if (auction.bidder != authorizeSeller) {
revert NFTMarketReserveAuction_Not_Matching_Seller(auction.bidder);
}
// Finalization will revert if the auction has not yet ended.
_finalizeReserveAuction({ auctionId: auctionId, keepInEscrow: true });
}
// The seller authorization has been confirmed.
authorizeSeller = address(0);
}
super._transferFromEscrow(nftContract, tokenId, recipient, authorizeSeller);
}
/**
* @inheritdoc NFTMarketCore
* @dev Checks if there is an auction for this NFT before allowing the transfer to continue.
*/
function _transferFromEscrowIfAvailable(address nftContract, uint256 tokenId, address recipient)
internal
virtual
override
{
if (nftContractToTokenIdToAuctionId[nftContract][tokenId] == 0) {
// No auction was found
super._transferFromEscrowIfAvailable(nftContract, tokenId, recipient);
}
}
/**
* @inheritdoc NFTMarketCore
*/
function _transferToEscrow(address nftContract, uint256 tokenId) internal virtual override {
uint256 auctionId = nftContractToTokenIdToAuctionId[nftContract][tokenId];
if (auctionId == 0) {
// NFT is not in auction
super._transferToEscrow(nftContract, tokenId);
return;
}
// Using storage saves gas since most of the data is not needed
ReserveAuctionStorage storage auction = auctionIdToAuction[auctionId];
if (auction.endTime == 0) {
// Reserve price set, confirm the seller is a match
if (auction.seller != msg.sender) {
revert NFTMarketReserveAuction_Not_Matching_Seller(auction.seller);
}
} else {
// Auction in progress, confirm the highest bidder is a match
if (auction.bidder != msg.sender) {
revert NFTMarketReserveAuction_Not_Matching_Seller(auction.bidder);
}
// Finalize auction but leave NFT in escrow, reverts if the auction has not ended
_finalizeReserveAuction({ auctionId: auctionId, keepInEscrow: true });
}
}
/**
* @notice Returns the minimum amount a bidder must spend to participate in an auction.
* Bids must be greater than or equal to this value or they will revert.
* @param auctionId The id of the auction to check.
* @return minimum The minimum amount for a bid to be accepted.
*/
function getMinBidAmount(uint256 auctionId) external view returns (uint256 minimum) {
ReserveAuctionStorage storage auction = auctionIdToAuction[auctionId];
if (auction.endTime == 0) {
return auction.amount;
}
return _getMinIncrement(auction.amount);
}
/**
* @notice Returns auction details for a given auctionId.
* @param auctionId The id of the auction to lookup.
*/
function getReserveAuction(uint256 auctionId) external view returns (ReserveAuction memory auction) {
ReserveAuctionStorage storage auctionStorage = auctionIdToAuction[auctionId];
auction = ReserveAuction(
auctionStorage.nftContract,
auctionStorage.tokenId,
auctionStorage.seller,
DURATION,
EXTENSION_DURATION,
auctionStorage.endTime,
auctionStorage.bidder,
auctionStorage.amount
);
}
/**
* @notice Returns the auctionId for a given NFT, or 0 if no auction is found.
* @dev If an auction is canceled, it will not be returned. However the auction may be over and pending finalization.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @return auctionId The id of the auction, or 0 if no auction is found.
*/
function getReserveAuctionIdFor(address nftContract, uint256 tokenId) external view returns (uint256 auctionId) {
auctionId = nftContractToTokenIdToAuctionId[nftContract][tokenId];
}
/**
* @notice Returns the referrer for the current highest bid in the auction, or address(0).
*/
function getReserveAuctionBidReferrer(uint256 auctionId) external view returns (address payable referrer) {
ReserveAuctionStorage storage auction = auctionIdToAuction[auctionId];
referrer = payable(
address((uint160(auction.bidReferrerAddressSlot0) << 64) | uint160(auction.bidReferrerAddressSlot1))
);
}
/**
* @inheritdoc MarketSharedCore
* @dev Returns the seller that has the given NFT in escrow for an auction,
* or bubbles the call up for other considerations.
*/
function _getSellerOf(address nftContract, uint256 tokenId)
internal
view
virtual
override(MarketSharedCore, NFTMarketCore)
returns (address payable seller)
{
seller = auctionIdToAuction[nftContractToTokenIdToAuctionId[nftContract][tokenId]].seller;
if (seller == address(0)) {
seller = super._getSellerOf(nftContract, tokenId);
}
}
/**
* @inheritdoc NFTMarketCore
*/
function _isInActiveAuction(address nftContract, uint256 tokenId) internal view override returns (bool) {
uint256 auctionId = nftContractToTokenIdToAuctionId[nftContract][tokenId];
return auctionId != 0 && !auctionIdToAuction[auctionId].endTime.hasExpired();
}
/**
* @notice This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[1_000] private __gap;
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
/// Constant values shared across mixins.
/**
* @dev 100% in basis points.
*/
uint256 constant BASIS_POINTS = 10_000;
/**
* @dev The default admin role defined by OZ ACL modules.
*/
bytes32 constant DEFAULT_ADMIN_ROLE = 0x00;
/**
* @dev The max take rate an exhibition can have.
*/
uint256 constant MAX_EXHIBITION_TAKE_RATE = 5_000;
/**
* @dev Cap the number of royalty recipients.
* A cap is required to ensure gas costs are not too high when a sale is settled.
*/
uint256 constant MAX_ROYALTY_RECIPIENTS = 5;
/**
* @dev The minimum increase of 10% required when making an offer or placing a bid.
*/
uint256 constant MIN_PERCENT_INCREMENT_DENOMINATOR = BASIS_POINTS / 1_000;
/**
* @dev The gas limit used when making external read-only calls.
* This helps to ensure that external calls does not prevent the market from executing.
*/
uint256 constant READ_ONLY_GAS_LIMIT = 40_000;
/**
* @dev Default royalty cut paid out on secondary sales.
* Set to 10% of the secondary sale.
*/
uint96 constant ROYALTY_IN_BASIS_POINTS = 1_000;
/**
* @dev 10%, expressed as a denominator for more efficient calculations.
*/
uint256 constant ROYALTY_RATIO = BASIS_POINTS / ROYALTY_IN_BASIS_POINTS;
/**
* @dev The gas limit to send ETH to multiple recipients, enough for a 5-way split.
*/
uint256 constant SEND_VALUE_GAS_LIMIT_MULTIPLE_RECIPIENTS = 210_000;
/**
* @dev The gas limit to send ETH to a single recipient, enough for a contract with a simple receiver.
*/
uint256 constant SEND_VALUE_GAS_LIMIT_SINGLE_RECIPIENT = 20_000;
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
import "../../interfaces/internal/IFethMarket.sol";
error FETHNode_FETH_Address_Is_Not_A_Contract();
error FETHNode_Only_FETH_Can_Transfer_ETH();
/**
* @title A mixin for interacting with the FETH contract.
* @author batu-inal & HardlyDifficult
*/
abstract contract FETHNode {
using AddressUpgradeable for address;
using AddressUpgradeable for address payable;
/// @notice The FETH ERC-20 token for managing escrow and lockup.
IFethMarket internal immutable feth;
constructor(address _feth) {
if (!_feth.isContract()) {
revert FETHNode_FETH_Address_Is_Not_A_Contract();
}
feth = IFethMarket(_feth);
}
/**
* @notice Only used by FETH. Any direct transfer from users will revert.
*/
receive() external payable {
if (msg.sender != address(feth)) {
revert FETHNode_Only_FETH_Can_Transfer_ETH();
}
}
/**
* @notice Withdraw the msg.sender's available FETH balance if they requested more than the msg.value provided.
* @dev This may revert if the msg.sender is non-receivable.
* This helper should not be used anywhere that may lead to locked assets.
* @param totalAmount The total amount of ETH required (including the msg.value).
* @param shouldRefundSurplus If true, refund msg.value - totalAmount to the msg.sender.
*/
function _tryUseFETHBalance(uint256 totalAmount, bool shouldRefundSurplus) internal {
if (totalAmount > msg.value) {
// Withdraw additional ETH required from the user's available FETH balance.
unchecked {
// The if above ensures delta will not underflow.
// Withdraw ETH from the user's account in the FETH token contract,
// making the funds available in this contract as ETH.
feth.marketWithdrawFrom(msg.sender, totalAmount - msg.value);
}
} else if (shouldRefundSurplus && totalAmount < msg.value) {
// Return any surplus ETH to the user.
unchecked {
// The if above ensures this will not underflow
payable(msg.sender).sendValue(msg.value - totalAmount);
}
}
}
/**
* @notice Gets the FETH contract used to escrow offer funds.
* @return fethAddress The FETH contract address.
*/
function getFethAddress() external view returns (address fethAddress) {
fethAddress = address(feth);
}
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
import "../../interfaces/internal/roles/IAdminRole.sol";
import "../../interfaces/internal/roles/IOperatorRole.sol";
error FoundationTreasuryNode_Address_Is_Not_A_Contract();
error FoundationTreasuryNode_Caller_Not_Admin();
error FoundationTreasuryNode_Caller_Not_Operator();
/**
* @title A mixin that stores a reference to the Foundation treasury contract.
* @notice The treasury collects fees and defines admin/operator roles.
* @author batu-inal & HardlyDifficult
*/
abstract contract FoundationTreasuryNode {
using AddressUpgradeable for address payable;
/// @dev This value was replaced with an immutable version.
address payable private __gap_was_treasury;
/// @notice The address of the treasury contract.
address payable private immutable treasury;
/// @notice Requires the caller is a Foundation admin.
modifier onlyFoundationAdmin() {
if (!IAdminRole(treasury).isAdmin(msg.sender)) {
revert FoundationTreasuryNode_Caller_Not_Admin();
}
_;
}
/// @notice Requires the caller is a Foundation operator.
modifier onlyFoundationOperator() {
if (!IOperatorRole(treasury).isOperator(msg.sender)) {
revert FoundationTreasuryNode_Caller_Not_Operator();
}
_;
}
/**
* @notice Set immutable variables for the implementation contract.
* @dev Assigns the treasury contract address.
*/
constructor(address payable _treasury) {
if (!_treasury.isContract()) {
revert FoundationTreasuryNode_Address_Is_Not_A_Contract();
}
treasury = _treasury;
}
/**
* @notice Gets the Foundation treasury contract.
* @dev This call is used in the royalty registry contract.
* @return treasuryAddress The address of the Foundation treasury contract.
*/
function getFoundationTreasury() public view returns (address payable treasuryAddress) {
treasuryAddress = treasury;
}
/**
* @notice This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[2_000] private __gap;
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
import "@manifoldxyz/royalty-registry-solidity/contracts/IRoyaltyRegistry.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
import "../../interfaces/standards/royalties/IGetFees.sol";
import "../../interfaces/standards/royalties/IGetRoyalties.sol";
import "../../interfaces/standards/royalties/IOwnable.sol";
import "../../interfaces/standards/royalties/IRoyaltyInfo.sol";
import "../../interfaces/standards/royalties/ITokenCreator.sol";
import "../../libraries/ArrayLibrary.sol";
import "./Constants.sol";
import "./FoundationTreasuryNode.sol";
import "./SendValueWithFallbackWithdraw.sol";
import "./MarketSharedCore.sol";
error NFTMarketFees_Address_Does_Not_Support_IRoyaltyRegistry();
error NFTMarketFees_Invalid_Protocol_Fee();
/**
* @title A mixin to distribute funds when an NFT is sold.
* @author batu-inal & HardlyDifficult
*/
abstract contract MarketFees is FoundationTreasuryNode, MarketSharedCore, SendValueWithFallbackWithdraw {
using AddressUpgradeable for address;
using ArrayLibrary for address payable[];
using ArrayLibrary for uint256[];
using ERC165Checker for address;
/**
* @dev Removing old unused variables in an upgrade safe way. Was:
* uint256 private _primaryFoundationFeeBasisPoints;
* uint256 private _secondaryFoundationFeeBasisPoints;
* uint256 private _secondaryCreatorFeeBasisPoints;
* mapping(address => mapping(uint256 => bool)) private _nftContractToTokenIdToFirstSaleCompleted;
*/
uint256[4] private __gap_was_fees;
/// @notice The royalties sent to creator recipients on secondary sales.
uint256 private constant CREATOR_ROYALTY_DENOMINATOR = BASIS_POINTS / 1_000; // 10%
/// @notice The fee collected by Foundation for sales facilitated by this market contract.
uint256 private immutable PROTOCOL_FEE_IN_BASIS_POINTS;
/// @notice The fee collected by the buy referrer for sales facilitated by this market contract.
/// This fee is calculated from the total protocol fee.
uint256 private constant BUY_REFERRER_FEE_DENOMINATOR = BASIS_POINTS / 100; // 1%
/// @notice The address of the royalty registry which may be used to define royalty overrides for some collections.
IRoyaltyRegistry private immutable royaltyRegistry;
/// @notice The address of this contract's implementation.
/// @dev This is used when making stateless external calls to this contract,
/// saving gas over hopping through the proxy which is only necessary when accessing state.
MarketFees private immutable implementationAddress;
/// @notice True for the Drop market which only performs primary sales. False if primary & secondary are supported.
bool private immutable assumePrimarySale;
/**
* @notice Emitted when an NFT sold with a referrer.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param buyReferrer The account which received the buy referral incentive.
* @param buyReferrerFee The portion of the protocol fee collected by the buy referrer.
* @param buyReferrerSellerFee The portion of the owner revenue collected by the buy referrer (not implemented).
*/
event BuyReferralPaid(
address indexed nftContract,
uint256 indexed tokenId,
address buyReferrer,
uint256 buyReferrerFee,
uint256 buyReferrerSellerFee
);
/**
* @notice Emitted when an NFT is sold when associated with a sell referrer.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param sellerReferrer The account which received the sell referral incentive.
* @param sellerReferrerFee The portion of the seller revenue collected by the sell referrer.
*/
event SellerReferralPaid(
address indexed nftContract,
uint256 indexed tokenId,
address sellerReferrer,
uint256 sellerReferrerFee
);
/**
* @notice Configures the registry allowing for royalty overrides to be defined.
* @param _royaltyRegistry The registry to use for royalty overrides.
* @param _assumePrimarySale True for the Drop market which only performs primary sales.
* False if primary & secondary are supported.
*/
constructor(uint16 protocolFeeInBasisPoints, address _royaltyRegistry, bool _assumePrimarySale) {
if (
protocolFeeInBasisPoints < BASIS_POINTS / BUY_REFERRER_FEE_DENOMINATOR ||
protocolFeeInBasisPoints + BASIS_POINTS / CREATOR_ROYALTY_DENOMINATOR >= BASIS_POINTS - MAX_EXHIBITION_TAKE_RATE
) {
/* If the protocol fee is invalid, revert:
* Protocol fee must be greater than the buy referrer fee since referrer fees are deducted from the protocol fee.
* The protocol fee must leave room for the creator royalties and the max exhibition take rate.
*/
revert NFTMarketFees_Invalid_Protocol_Fee();
}
PROTOCOL_FEE_IN_BASIS_POINTS = protocolFeeInBasisPoints;
if (!_royaltyRegistry.supportsInterface(type(IRoyaltyRegistry).interfaceId)) {
revert NFTMarketFees_Address_Does_Not_Support_IRoyaltyRegistry();
}
royaltyRegistry = IRoyaltyRegistry(_royaltyRegistry);
assumePrimarySale = _assumePrimarySale;
// In the constructor, `this` refers to the implementation address. Everywhere else it'll be the proxy.
implementationAddress = this;
}
/**
* @notice Distributes funds to foundation, creator recipients, and NFT owner after a sale.
*/
function _distributeFunds(
address nftContract,
uint256 tokenId,
address payable seller,
uint256 price,
address payable buyReferrer,
address payable sellerReferrerPaymentAddress,
uint16 sellerReferrerTakeRateInBasisPoints
) internal returns (uint256 totalFees, uint256 creatorRev, uint256 sellerRev) {
if (price == 0) {
// When the sale price is 0, there are no revenue to distribute.
return (0, 0, 0);
}
address payable[] memory creatorRecipients;
uint256[] memory creatorShares;
uint256 buyReferrerFee;
uint256 sellerReferrerFee;
(totalFees, creatorRecipients, creatorShares, sellerRev, buyReferrerFee, sellerReferrerFee) = _getFees(
nftContract,
tokenId,
seller,
price,
buyReferrer,
sellerReferrerTakeRateInBasisPoints
);
// Pay the creator(s)
// If just a single recipient was defined, use a larger gas limit in order to support in-contract split logic.
uint256 creatorGasLimit = creatorRecipients.length == 1
? SEND_VALUE_GAS_LIMIT_MULTIPLE_RECIPIENTS
: SEND_VALUE_GAS_LIMIT_SINGLE_RECIPIENT;
unchecked {
for (uint256 i = 0; i < creatorRecipients.length; ++i) {
_sendValueWithFallbackWithdraw(creatorRecipients[i], creatorShares[i], creatorGasLimit);
// Sum the total creator rev from shares
// creatorShares is in ETH so creatorRev will not overflow here.
creatorRev += creatorShares[i];
}
}
// Pay the seller
_sendValueWithFallbackWithdraw(seller, sellerRev, SEND_VALUE_GAS_LIMIT_SINGLE_RECIPIENT);
// Pay the protocol fee
_sendValueWithFallbackWithdraw(getFoundationTreasury(), totalFees, SEND_VALUE_GAS_LIMIT_SINGLE_RECIPIENT);
// Pay the buy referrer fee
if (buyReferrerFee != 0) {
_sendValueWithFallbackWithdraw(buyReferrer, buyReferrerFee, SEND_VALUE_GAS_LIMIT_SINGLE_RECIPIENT);
emit BuyReferralPaid({
nftContract: nftContract,
tokenId: tokenId,
buyReferrer: buyReferrer,
buyReferrerFee: buyReferrerFee,
buyReferrerSellerFee: 0
});
unchecked {
// Add the referrer fee back into the total fees so that all 3 return fields sum to the total price for events
totalFees += buyReferrerFee;
}
}
if (sellerReferrerPaymentAddress != address(0)) {
if (sellerReferrerFee != 0) {
// Add the seller referrer fee back to revenue so that all 3 return fields sum to the total price for events.
unchecked {
if (sellerRev == 0) {
// When sellerRev is 0, this is a primary sale and all revenue is attributed to the "creator".
creatorRev += sellerReferrerFee;
} else {
sellerRev += sellerReferrerFee;
}
}
_sendValueWithFallbackWithdraw(
sellerReferrerPaymentAddress,
sellerReferrerFee,
SEND_VALUE_GAS_LIMIT_SINGLE_RECIPIENT
);
}
emit SellerReferralPaid(nftContract, tokenId, sellerReferrerPaymentAddress, sellerReferrerFee);
}
}
/**
* @notice Returns how funds will be distributed for a sale at the given price point.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param price The sale price to calculate the fees for.
* @return totalFees How much will be sent to the Foundation treasury and/or referrals.
* @return creatorRev How much will be sent across all the `creatorRecipients` defined.
* @return creatorRecipients The addresses of the recipients to receive a portion of the creator fee.
* @return creatorShares The percentage of the creator fee to be distributed to each `creatorRecipient`.
* If there is only one `creatorRecipient`, this may be an empty array.
* Otherwise `creatorShares.length` == `creatorRecipients.length`.
* @return sellerRev How much will be sent to the owner/seller of the NFT.
* If the NFT is being sold by the creator, this may be 0 and the full revenue will appear as `creatorRev`.
* @return seller The address of the owner of the NFT.
* If `sellerRev` is 0, this may be `address(0)`.
*/
function getFeesAndRecipients(address nftContract, uint256 tokenId, uint256 price)
external
view
returns (
uint256 totalFees,
uint256 creatorRev,
address payable[] memory creatorRecipients,
uint256[] memory creatorShares,
uint256 sellerRev,
address payable seller
)
{
seller = _getSellerOrOwnerOf(nftContract, tokenId);
(totalFees, creatorRecipients, creatorShares, sellerRev, , ) = _getFees({
nftContract: nftContract,
tokenId: tokenId,
seller: seller,
price: price,
// Notice: Setting this value is a breaking change for the FNDMiddleware contract.
// Will be wired in an upcoming release to communicate the buy referral information.
buyReferrer: payable(0),
sellerReferrerTakeRateInBasisPoints: 0
});
// Sum the total creator rev from shares
unchecked {
for (uint256 i = 0; i < creatorShares.length; ++i) {
creatorRev += creatorShares[i];
}
}
}
/**
* @notice Returns the address of the registry allowing for royalty configuration overrides.
* @dev See https://royaltyregistry.xyz/
* @return registry The address of the royalty registry contract.
*/
function getRoyaltyRegistry() external view returns (address registry) {
registry = address(royaltyRegistry);
}
/**
* @notice **For internal use only.**
* @dev This function is external to allow using try/catch but is not intended for external use.
* This checks the token creator.
*/
function internalGetTokenCreator(address nftContract, uint256 tokenId)
external
view
returns (address payable creator)
{
creator = ITokenCreator(nftContract).tokenCreator{ gas: READ_ONLY_GAS_LIMIT }(tokenId);
}
/**
* @notice **For internal use only.**
* @dev This function is external to allow using try/catch but is not intended for external use.
* If ERC2981 royalties (or getRoyalties) are defined by the NFT contract, allow this standard to define immutable
* royalties that cannot be later changed via the royalty registry.
*/
function internalGetImmutableRoyalties(address nftContract, uint256 tokenId)
external
view
returns (address payable[] memory recipients, uint256[] memory splitPerRecipientInBasisPoints)
{
// 1st priority: ERC-2981
if (nftContract.supportsERC165InterfaceUnchecked(type(IRoyaltyInfo).interfaceId)) {
try IRoyaltyInfo(nftContract).royaltyInfo{ gas: READ_ONLY_GAS_LIMIT }(tokenId, BASIS_POINTS) returns (
address receiver,
uint256 royaltyAmount
) {
// Manifold contracts return (address(this), 0) when royalties are not defined
// - so ignore results when the amount is 0
if (royaltyAmount > 0) {
recipients = new address payable[](1);
recipients[0] = payable(receiver);
splitPerRecipientInBasisPoints = new uint256[](1);
// The split amount is assumed to be 100% when only 1 recipient is returned
return (recipients, splitPerRecipientInBasisPoints);
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
// 2nd priority: getRoyalties
if (nftContract.supportsERC165InterfaceUnchecked(type(IGetRoyalties).interfaceId)) {
try IGetRoyalties(nftContract).getRoyalties{ gas: READ_ONLY_GAS_LIMIT }(tokenId) returns (
address payable[] memory _recipients,
uint256[] memory recipientBasisPoints
) {
if (_recipients.length != 0 && _recipients.length == recipientBasisPoints.length) {
return (_recipients, recipientBasisPoints);
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
}
/**
* @notice **For internal use only.**
* @dev This function is external to allow using try/catch but is not intended for external use.
* This checks for royalties defined in the royalty registry or via a non-standard royalty API.
*/
// solhint-disable-next-line code-complexity
function internalGetMutableRoyalties(address nftContract, uint256 tokenId, address payable creator)
external
view
returns (address payable[] memory recipients, uint256[] memory splitPerRecipientInBasisPoints)
{
/* Overrides must support ERC-165 when registered, except for overrides defined by the registry owner.
If that results in an override w/o 165 we may need to upgrade the market to support or ignore that override. */
// The registry requires overrides are not 0 and contracts when set.
// If no override is set, the nftContract address is returned.
try royaltyRegistry.getRoyaltyLookupAddress{ gas: READ_ONLY_GAS_LIMIT }(nftContract) returns (
address overrideContract
) {
if (overrideContract != nftContract) {
nftContract = overrideContract;
// The functions above are repeated here if an override is set.
// 3rd priority: ERC-2981 override
if (nftContract.supportsERC165InterfaceUnchecked(type(IRoyaltyInfo).interfaceId)) {
try IRoyaltyInfo(nftContract).royaltyInfo{ gas: READ_ONLY_GAS_LIMIT }(tokenId, BASIS_POINTS) returns (
address receiver,
uint256 royaltyAmount
) {
// Manifold contracts return (address(this), 0) when royalties are not defined
// - so ignore results when the amount is 0
if (royaltyAmount != 0) {
recipients = new address payable[](1);
recipients[0] = payable(receiver);
splitPerRecipientInBasisPoints = new uint256[](1);
// The split amount is assumed to be 100% when only 1 recipient is returned
return (recipients, splitPerRecipientInBasisPoints);
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
// 4th priority: getRoyalties override
if (recipients.length == 0 && nftContract.supportsERC165InterfaceUnchecked(type(IGetRoyalties).interfaceId)) {
try IGetRoyalties(nftContract).getRoyalties{ gas: READ_ONLY_GAS_LIMIT }(tokenId) returns (
address payable[] memory _recipients,
uint256[] memory recipientBasisPoints
) {
if (_recipients.length != 0 && _recipients.length == recipientBasisPoints.length) {
return (_recipients, recipientBasisPoints);
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Ignore out of gas errors and continue using the nftContract address
}
// 5th priority: getFee* from contract or override
if (nftContract.supportsERC165InterfaceUnchecked(type(IGetFees).interfaceId)) {
try IGetFees(nftContract).getFeeRecipients{ gas: READ_ONLY_GAS_LIMIT }(tokenId) returns (
address payable[] memory _recipients
) {
if (_recipients.length != 0) {
try IGetFees(nftContract).getFeeBps{ gas: READ_ONLY_GAS_LIMIT }(tokenId) returns (
uint256[] memory recipientBasisPoints
) {
if (_recipients.length == recipientBasisPoints.length) {
return (_recipients, recipientBasisPoints);
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
// 6th priority: tokenCreator w/ or w/o requiring 165 from contract or override
if (creator != address(0)) {
// Only pay the tokenCreator if there wasn't another royalty defined
recipients = new address payable[](1);
recipients[0] = creator;
splitPerRecipientInBasisPoints = new uint256[](1);
// The split amount is assumed to be 100% when only 1 recipient is returned
return (recipients, splitPerRecipientInBasisPoints);
}
// 7th priority: owner from contract or override
try IOwnable(nftContract).owner{ gas: READ_ONLY_GAS_LIMIT }() returns (address owner) {
if (owner != address(0)) {
// Only pay the owner if there wasn't another royalty defined
recipients = new address payable[](1);
recipients[0] = payable(owner);
splitPerRecipientInBasisPoints = new uint256[](1);
// The split amount is assumed to be 100% when only 1 recipient is returned
return (recipients, splitPerRecipientInBasisPoints);
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
// If no valid payment address or creator is found, return 0 recipients
}
/**
* @notice Calculates how funds should be distributed for the given sale details.
* @dev When the NFT is being sold by the `tokenCreator`, all the seller revenue will
* be split with the royalty recipients defined for that NFT.
*/
// solhint-disable-next-line code-complexity
function _getFees(
address nftContract,
uint256 tokenId,
address payable seller,
uint256 price,
address payable buyReferrer,
uint16 sellerReferrerTakeRateInBasisPoints
)
private
view
returns (
uint256 totalFees,
address payable[] memory creatorRecipients,
uint256[] memory creatorShares,
uint256 sellerRev,
uint256 buyReferrerFee,
uint256 sellerReferrerFee
)
{
// Calculate the protocol fee
totalFees = (price * PROTOCOL_FEE_IN_BASIS_POINTS) / BASIS_POINTS;
address payable creator;
try implementationAddress.internalGetTokenCreator(nftContract, tokenId) returns (address payable _creator) {
creator = _creator;
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
try implementationAddress.internalGetImmutableRoyalties(nftContract, tokenId) returns (
address payable[] memory _recipients,
uint256[] memory _splitPerRecipientInBasisPoints
) {
(creatorRecipients, creatorShares) = (_recipients, _splitPerRecipientInBasisPoints);
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
if (creatorRecipients.length == 0) {
// Check mutable royalties only if we didn't find results from the immutable API
try implementationAddress.internalGetMutableRoyalties(nftContract, tokenId, creator) returns (
address payable[] memory _recipients,
uint256[] memory _splitPerRecipientInBasisPoints
) {
(creatorRecipients, creatorShares) = (_recipients, _splitPerRecipientInBasisPoints);
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
if (creatorRecipients.length != 0 || assumePrimarySale) {
uint256 creatorRev;
if (assumePrimarySale) {
// All revenue should go to the creator recipients
unchecked {
// totalFees is always < price.
creatorRev = price - totalFees;
}
if (creatorRecipients.length == 0) {
// If no creators were found via the royalty APIs, then set that recipient to the seller's address
creatorRecipients = new address payable[](1);
creatorRecipients[0] = seller;
creatorShares = new uint256[](1);
// The split amount is assumed to be 100% when only 1 recipient is returned
}
} else if (seller == creator || (creatorRecipients.length != 0 && seller == creatorRecipients[0])) {
// When sold by the creator, all revenue is split if applicable.
unchecked {
// totalFees is always < price.
creatorRev = price - totalFees;
}
} else {
// Rounding favors the owner first, then creator, and foundation last.
unchecked {
// Safe math is not required when dividing by a non-zero constant.
creatorRev = price / CREATOR_ROYALTY_DENOMINATOR;
}
sellerRev = price - totalFees - creatorRev;
}
// Cap the max number of recipients supported
creatorRecipients.capLength(MAX_ROYALTY_RECIPIENTS);
creatorShares.capLength(MAX_ROYALTY_RECIPIENTS);
// Calculate the seller referrer fee when some revenue is awarded to the creator
if (sellerReferrerTakeRateInBasisPoints != 0) {
sellerReferrerFee = (price * sellerReferrerTakeRateInBasisPoints) / BASIS_POINTS;
// Subtract the seller referrer fee from the seller revenue so we do not double pay.
if (sellerRev == 0) {
// If the seller revenue is 0, this is a primary sale where all seller revenue is attributed to the "creator".
creatorRev -= sellerReferrerFee;
} else {
sellerRev -= sellerReferrerFee;
}
}
// Sum the total shares defined
uint256 totalShares;
if (creatorRecipients.length > 1) {
unchecked {
for (uint256 i = 0; i < creatorRecipients.length; ++i) {
if (creatorRecipients[i] == seller) {
// If the seller is any of the recipients defined, assume a primary sale
creatorRev += sellerRev;
sellerRev = 0;
}
if (totalShares != type(uint256).max) {
if (creatorShares[i] > BASIS_POINTS) {
// If the numbers are >100% we ignore the fee recipients and pay just the first instead
totalShares = type(uint256).max;
// Continue the loop in order to detect a potential primary sale condition
} else {
totalShares += creatorShares[i];
}
}
}
}
if (totalShares == 0 || totalShares == type(uint256).max) {
// If no shares were defined or shares were out of bounds, pay only the first recipient
creatorRecipients.capLength(1);
creatorShares.capLength(1);
}
}
// Send payouts to each additional recipient if more than 1 was defined
uint256 totalRoyaltiesDistributed;
for (uint256 i = 1; i < creatorRecipients.length; ) {
uint256 royalty = (creatorRev * creatorShares[i]) / totalShares;
totalRoyaltiesDistributed += royalty;
creatorShares[i] = royalty;
unchecked {
++i;
}
}
// Send the remainder to the 1st creator, rounding in their favor
creatorShares[0] = creatorRev - totalRoyaltiesDistributed;
} else {
// No royalty recipients found.
unchecked {
// totalFees is always < price.
sellerRev = price - totalFees;
}
// Calculate the seller referrer fee when there is no creator royalty
if (sellerReferrerTakeRateInBasisPoints != 0) {
sellerReferrerFee = (price * sellerReferrerTakeRateInBasisPoints) / BASIS_POINTS;
sellerRev -= sellerReferrerFee;
}
}
if (buyReferrer != address(0) && buyReferrer != msg.sender && buyReferrer != seller && buyReferrer != creator) {
unchecked {
buyReferrerFee = price / BUY_REFERRER_FEE_DENOMINATOR;
// buyReferrerFee is always <= totalFees
totalFees -= buyReferrerFee;
}
}
}
/**
* @notice This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[500] private __gap;
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "./FETHNode.sol";
/**
* @title A place for common modifiers and functions used by various market mixins, if any.
* @dev This also leaves a gap which can be used to add a new mixin to the top of the inheritance tree.
* @author batu-inal & HardlyDifficult
*/
abstract contract MarketSharedCore is FETHNode {
/**
* @notice Checks who the seller for an NFT is if listed in this market.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @return seller The seller which listed this NFT for sale, or address(0) if not listed.
*/
function getSellerOf(address nftContract, uint256 tokenId) external view returns (address payable seller) {
seller = _getSellerOf(nftContract, tokenId);
}
/**
* @notice Checks who the seller for an NFT is if listed in this market.
*/
function _getSellerOf(address nftContract, uint256 tokenId) internal view virtual returns (address payable seller);
/**
* @notice Checks who the seller for an NFT is if listed in this market or returns the current owner.
*/
function _getSellerOrOwnerOf(address nftContract, uint256 tokenId)
internal
view
virtual
returns (address payable sellerOrOwner);
/**
* @notice This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[500] private __gap;
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
import "./FETHNode.sol";
/**
* @title A mixin for sending ETH with a fallback withdraw mechanism.
* @notice Attempt to send ETH and if the transfer fails or runs out of gas, store the balance
* in the FETH token contract for future withdrawal instead.
* @dev This mixin was recently switched to escrow funds in FETH.
* Once we have confirmed all pending balances have been withdrawn, we can remove the escrow tracking here.
* @author batu-inal & HardlyDifficult
*/
abstract contract SendValueWithFallbackWithdraw is FETHNode {
using AddressUpgradeable for address payable;
/// @dev Removing old unused variables in an upgrade safe way.
uint256 private __gap_was_pendingWithdrawals;
/**
* @notice Emitted when escrowed funds are withdrawn to FETH.
* @param user The account which has withdrawn ETH.
* @param amount The amount of ETH which has been withdrawn.
*/
event WithdrawalToFETH(address indexed user, uint256 amount);
/**
* @notice Attempt to send a user or contract ETH.
* If it fails store the amount owned for later withdrawal in FETH.
* @dev This may fail when sending ETH to a contract that is non-receivable or exceeds the gas limit specified.
*/
function _sendValueWithFallbackWithdraw(address payable user, uint256 amount, uint256 gasLimit) internal {
if (amount == 0) {
return;
}
// Cap the gas to prevent consuming all available gas to block a tx from completing successfully
// solhint-disable-next-line avoid-low-level-calls
(bool success, ) = user.call{ value: amount, gas: gasLimit }("");
if (!success) {
// Store the funds that failed to send for the user in the FETH token
feth.depositFor{ value: amount }(user);
emit WithdrawalToFETH(user, amount);
}
}
/**
* @notice This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[999] private __gap;
}
/*
・
* ★
・ 。
・ ゚☆ 。
* ★ ゚・。 * 。
* ☆ 。・゚*.。
゚ *.。☆。★ ・
` .-:::::-.` `-::---...```
`-:` .:+ssssoooo++//:.` .-/+shhhhhhhhhhhhhyyyssooo:
.--::. .+ossso+/////++/:://-` .////+shhhhhhhhhhhhhhhhhhhhhy
`-----::. `/+////+++///+++/:--:/+/- -////+shhhhhhhhhhhhhhhhhhhhhy
`------:::-` `//-.``.-/+ooosso+:-.-/oso- -////+shhhhhhhhhhhhhhhhhhhhhy
.--------:::-` :+:.` .-/osyyyyyyso++syhyo.-////+shhhhhhhhhhhhhhhhhhhhhy
`-----------:::-. +o+:-.-:/oyhhhhhhdhhhhhdddy:-////+shhhhhhhhhhhhhhhhhhhhhy
.------------::::-- `oys+/::/+shhhhhhhdddddddddy/-////+shhhhhhhhhhhhhhhhhhhhhy
.--------------:::::-` +ys+////+yhhhhhhhddddddddhy:-////+yhhhhhhhhhhhhhhhhhhhhhy
`----------------::::::-`.ss+/:::+oyhhhhhhhhhhhhhhho`-////+shhhhhhhhhhhhhhhhhhhhhy
.------------------:::::::.-so//::/+osyyyhhhhhhhhhys` -////+shhhhhhhhhhhhhhhhhhhhhy
`.-------------------::/:::::..+o+////+oosssyyyyyyys+` .////+shhhhhhhhhhhhhhhhhhhhhy
.--------------------::/:::.` -+o++++++oooosssss/. `-//+shhhhhhhhhhhhhhhhhhhhyo
.------- ``````.......--` `-/+ooooosso+/-` `./++++///:::--...``hhhhyo
`````
*
・ 。
・ ゚☆ 。
* ★ ゚・。 * 。
* ☆ 。・゚*.。
゚ *.。☆。★ ・
* ゚。·*・。 ゚*
☆゚・。°*. ゚
・ ゚*。・゚★。
・ *゚。 *
・゚*。★・
☆∴。 *
・ 。
*/
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
import "./mixins/shared/Constants.sol";
import "./mixins/shared/FETHNode.sol";
import "./mixins/shared/FoundationTreasuryNode.sol";
import "./mixins/shared/MarketFees.sol";
import "./mixins/shared/MarketSharedCore.sol";
import "./mixins/shared/SendValueWithFallbackWithdraw.sol";
import "./mixins/nftMarket/NFTMarketAuction.sol";
import "./mixins/nftMarket/NFTMarketBuyPrice.sol";
import "./mixins/nftMarket/NFTMarketCore.sol";
import "./mixins/nftMarket/NFTMarketOffer.sol";
import "./mixins/nftMarket/NFTMarketPrivateSaleGap.sol";
import "./mixins/nftMarket/NFTMarketReserveAuction.sol";
import "./mixins/nftMarket/NFTMarketExhibition.sol";
/**
* @title A market for NFTs on Foundation.
* @notice The Foundation marketplace is a contract which allows traders to buy and sell NFTs.
* It supports buying and selling via auctions, private sales, buy price, and offers.
* @dev All sales in the Foundation market will pay the creator 10% royalties on secondary sales. This is not specific
* to NFTs minted on Foundation, it should work for any NFT. If royalty information was not defined when the NFT was
* originally deployed, it may be added using the [Royalty Registry](https://royaltyregistry.xyz/) which will be
* respected by our market contract.
* @author batu-inal & HardlyDifficult
*/
contract NFTMarket is
Initializable,
FoundationTreasuryNode,
FETHNode,
MarketSharedCore,
NFTMarketCore,
ReentrancyGuardUpgradeable,
SendValueWithFallbackWithdraw,
MarketFees,
NFTMarketExhibition,
NFTMarketAuction,
NFTMarketReserveAuction,
NFTMarketPrivateSaleGap,
NFTMarketBuyPrice,
NFTMarketOffer
{
/**
* @notice Set immutable variables for the implementation contract.
* @dev Using immutable instead of constants allows us to use different values on testnet.
* @param treasury The Foundation Treasury contract address.
* @param feth The FETH ERC-20 token contract address.
* @param royaltyRegistry The Royalty Registry contract address.
* @param duration The duration of the auction in seconds.
*/
constructor(address payable treasury, address feth, address royaltyRegistry, uint256 duration)
FoundationTreasuryNode(treasury)
FETHNode(feth)
MarketFees(
/* protocolFeeInBasisPoints: */
500,
royaltyRegistry,
/* assumePrimarySale: */
false
)
NFTMarketReserveAuction(duration)
initializer // solhint-disable-next-line no-empty-blocks
{}
/**
* @notice Called once to configure the contract after the initial proxy deployment.
* @dev This farms the initialize call out to inherited contracts as needed to initialize mutable variables.
*/
function initialize() external initializer {
ReentrancyGuardUpgradeable.__ReentrancyGuard_init();
NFTMarketAuction._initializeNFTMarketAuction();
}
/**
* @inheritdoc NFTMarketCore
*/
function _beforeAuctionStarted(address nftContract, uint256 tokenId)
internal
override(NFTMarketCore, NFTMarketBuyPrice, NFTMarketOffer)
{
// This is a no-op function required to avoid compile errors.
super._beforeAuctionStarted(nftContract, tokenId);
}
/**
* @inheritdoc NFTMarketCore
*/
function _transferFromEscrow(address nftContract, uint256 tokenId, address recipient, address authorizeSeller)
internal
override(NFTMarketCore, NFTMarketReserveAuction, NFTMarketBuyPrice)
{
// This is a no-op function required to avoid compile errors.
super._transferFromEscrow(nftContract, tokenId, recipient, authorizeSeller);
}
/**
* @inheritdoc NFTMarketCore
*/
function _transferFromEscrowIfAvailable(address nftContract, uint256 tokenId, address recipient)
internal
override(NFTMarketCore, NFTMarketReserveAuction, NFTMarketBuyPrice)
{
// This is a no-op function required to avoid compile errors.
super._transferFromEscrowIfAvailable(nftContract, tokenId, recipient);
}
/**
* @inheritdoc NFTMarketCore
*/
function _transferToEscrow(address nftContract, uint256 tokenId)
internal
override(NFTMarketCore, NFTMarketReserveAuction, NFTMarketBuyPrice)
{
// This is a no-op function required to avoid compile errors.
super._transferToEscrow(nftContract, tokenId);
}
/**
* @inheritdoc MarketSharedCore
*/
function _getSellerOf(address nftContract, uint256 tokenId)
internal
view
override(MarketSharedCore, NFTMarketCore, NFTMarketReserveAuction, NFTMarketBuyPrice)
returns (address payable seller)
{
// This is a no-op function required to avoid compile errors.
seller = super._getSellerOf(nftContract, tokenId);
}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/interfaces/internal/IFethMarket.sol";
abstract contract $IFethMarket is IFethMarket {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../../contracts/interfaces/internal/roles/IAdminRole.sol";
abstract contract $IAdminRole is IAdminRole {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../../contracts/interfaces/internal/roles/IOperatorRole.sol";
abstract contract $IOperatorRole is IOperatorRole {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../../contracts/interfaces/standards/royalties/IGetFees.sol";
abstract contract $IGetFees is IGetFees {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../../contracts/interfaces/standards/royalties/IGetRoyalties.sol";
abstract contract $IGetRoyalties is IGetRoyalties {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../../contracts/interfaces/standards/royalties/IOwnable.sol";
abstract contract $IOwnable is IOwnable {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../../contracts/interfaces/standards/royalties/IRoyaltyInfo.sol";
abstract contract $IRoyaltyInfo is IRoyaltyInfo {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../../contracts/interfaces/standards/royalties/ITokenCreator.sol";
abstract contract $ITokenCreator is ITokenCreator {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../contracts/libraries/ArrayLibrary.sol";
contract $ArrayLibrary {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
function $capLength(address payable[] calldata data,uint256 maxLength) external pure {
return ArrayLibrary.capLength(data,maxLength);
}
function $capLength(uint256[] calldata data,uint256 maxLength) external pure {
return ArrayLibrary.capLength(data,maxLength);
}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../contracts/libraries/TimeLibrary.sol";
contract $TimeLibrary {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
function $hasExpired(uint256 expiry) external view returns (bool) {
return TimeLibrary.hasExpired(expiry);
}
function $hasBeenReached(uint256 timestamp) external view returns (bool) {
return TimeLibrary.hasBeenReached(timestamp);
}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/mixins/nftMarket/NFTMarketAuction.sol";
contract $NFTMarketAuction is NFTMarketAuction {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
event $_getNextAndIncrementAuctionId_Returned(uint256 arg0);
constructor() {}
function $_initializeNFTMarketAuction() external {
return super._initializeNFTMarketAuction();
}
function $_getNextAndIncrementAuctionId() external returns (uint256) {
(uint256 ret0) = super._getNextAndIncrementAuctionId();
emit $_getNextAndIncrementAuctionId_Returned(ret0);
return (ret0);
}
function $_disableInitializers() external {
return super._disableInitializers();
}
function $_getInitializedVersion() external view returns (uint8) {
return super._getInitializedVersion();
}
function $_isInitializing() external view returns (bool) {
return super._isInitializing();
}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/mixins/nftMarket/NFTMarketBuyPrice.sol";
abstract contract $NFTMarketBuyPrice is NFTMarketBuyPrice {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
event $_autoAcceptBuyPrice_Returned(bool arg0);
event $_distributeFunds_Returned(uint256 arg0, uint256 arg1, uint256 arg2);
constructor(address payable _treasury, address _feth, uint16 protocolFeeInBasisPoints, address _royaltyRegistry, bool _assumePrimarySale) FoundationTreasuryNode(_treasury) FETHNode(_feth) MarketFees(protocolFeeInBasisPoints, _royaltyRegistry, _assumePrimarySale) {}
function $feth() external view returns (IFethMarket) {
return feth;
}
function $_autoAcceptBuyPrice(address nftContract,uint256 tokenId,uint256 maxPrice) external returns (bool) {
(bool ret0) = super._autoAcceptBuyPrice(nftContract,tokenId,maxPrice);
emit $_autoAcceptBuyPrice_Returned(ret0);
return (ret0);
}
function $_beforeAuctionStarted(address nftContract,uint256 tokenId) external {
return super._beforeAuctionStarted(nftContract,tokenId);
}
function $_transferFromEscrow(address nftContract,uint256 tokenId,address recipient,address authorizeSeller) external {
return super._transferFromEscrow(nftContract,tokenId,recipient,authorizeSeller);
}
function $_transferFromEscrowIfAvailable(address nftContract,uint256 tokenId,address recipient) external {
return super._transferFromEscrowIfAvailable(nftContract,tokenId,recipient);
}
function $_transferToEscrow(address nftContract,uint256 tokenId) external {
return super._transferToEscrow(nftContract,tokenId);
}
function $_getSellerOf(address nftContract,uint256 tokenId) external view returns (address payable) {
return super._getSellerOf(nftContract,tokenId);
}
function $_distributeFunds(address nftContract,uint256 tokenId,address payable seller,uint256 price,address payable buyReferrer,address payable sellerReferrerPaymentAddress,uint16 sellerReferrerTakeRateInBasisPoints) external returns (uint256, uint256, uint256) {
(uint256 ret0, uint256 ret1, uint256 ret2) = super._distributeFunds(nftContract,tokenId,seller,price,buyReferrer,sellerReferrerPaymentAddress,sellerReferrerTakeRateInBasisPoints);
emit $_distributeFunds_Returned(ret0, ret1, ret2);
return (ret0, ret1, ret2);
}
function $_sendValueWithFallbackWithdraw(address payable user,uint256 amount,uint256 gasLimit) external {
return super._sendValueWithFallbackWithdraw(user,amount,gasLimit);
}
function $__ReentrancyGuard_init() external {
return super.__ReentrancyGuard_init();
}
function $__ReentrancyGuard_init_unchained() external {
return super.__ReentrancyGuard_init_unchained();
}
function $_getMinIncrement(uint256 currentAmount) external pure returns (uint256) {
return super._getMinIncrement(currentAmount);
}
function $_getSellerOrOwnerOf(address nftContract,uint256 tokenId) external view returns (address payable) {
return super._getSellerOrOwnerOf(nftContract,tokenId);
}
function $_tryUseFETHBalance(uint256 totalAmount,bool shouldRefundSurplus) external {
return super._tryUseFETHBalance(totalAmount,shouldRefundSurplus);
}
function $_disableInitializers() external {
return super._disableInitializers();
}
function $_getInitializedVersion() external view returns (uint8) {
return super._getInitializedVersion();
}
function $_isInitializing() external view returns (bool) {
return super._isInitializing();
}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/mixins/nftMarket/NFTMarketCore.sol";
abstract contract $NFTMarketCore is NFTMarketCore {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor(address _feth) FETHNode(_feth) {}
function $feth() external view returns (IFethMarket) {
return feth;
}
function $_beforeAuctionStarted(address arg0,uint256 arg1) external {
return super._beforeAuctionStarted(arg0,arg1);
}
function $_transferFromEscrow(address nftContract,uint256 tokenId,address recipient,address authorizeSeller) external {
return super._transferFromEscrow(nftContract,tokenId,recipient,authorizeSeller);
}
function $_transferFromEscrowIfAvailable(address nftContract,uint256 tokenId,address recipient) external {
return super._transferFromEscrowIfAvailable(nftContract,tokenId,recipient);
}
function $_transferToEscrow(address nftContract,uint256 tokenId) external {
return super._transferToEscrow(nftContract,tokenId);
}
function $_getMinIncrement(uint256 currentAmount) external pure returns (uint256) {
return super._getMinIncrement(currentAmount);
}
function $_getSellerOf(address nftContract,uint256 tokenId) external view returns (address payable) {
return super._getSellerOf(nftContract,tokenId);
}
function $_getSellerOrOwnerOf(address nftContract,uint256 tokenId) external view returns (address payable) {
return super._getSellerOrOwnerOf(nftContract,tokenId);
}
function $_tryUseFETHBalance(uint256 totalAmount,bool shouldRefundSurplus) external {
return super._tryUseFETHBalance(totalAmount,shouldRefundSurplus);
}
function $_disableInitializers() external {
return super._disableInitializers();
}
function $_getInitializedVersion() external view returns (uint8) {
return super._getInitializedVersion();
}
function $_isInitializing() external view returns (bool) {
return super._isInitializing();
}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/mixins/nftMarket/NFTMarketExhibition.sol";
contract $NFTMarketExhibition is NFTMarketExhibition {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
event $_getExhibitionForPayment_Returned(address payable arg0, uint16 arg1);
constructor() {}
function $_addNftToExhibition(address nftContract,uint256 tokenId,uint256 exhibitionId) external {
return super._addNftToExhibition(nftContract,tokenId,exhibitionId);
}
function $_getExhibitionForPayment(address nftContract,uint256 tokenId) external returns (address payable, uint16) {
(address payable ret0, uint16 ret1) = super._getExhibitionForPayment(nftContract,tokenId);
emit $_getExhibitionForPayment_Returned(ret0, ret1);
return (ret0, ret1);
}
function $_removeNftFromExhibition(address nftContract,uint256 tokenId) external {
return super._removeNftFromExhibition(nftContract,tokenId);
}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/mixins/nftMarket/NFTMarketOffer.sol";
abstract contract $NFTMarketOffer is NFTMarketOffer {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
event $_autoAcceptOffer_Returned(bool arg0);
event $_distributeFunds_Returned(uint256 arg0, uint256 arg1, uint256 arg2);
constructor(address payable _treasury, address _feth, uint16 protocolFeeInBasisPoints, address _royaltyRegistry, bool _assumePrimarySale) FoundationTreasuryNode(_treasury) FETHNode(_feth) MarketFees(protocolFeeInBasisPoints, _royaltyRegistry, _assumePrimarySale) {}
function $feth() external view returns (IFethMarket) {
return feth;
}
function $_beforeAuctionStarted(address nftContract,uint256 tokenId) external {
return super._beforeAuctionStarted(nftContract,tokenId);
}
function $_autoAcceptOffer(address nftContract,uint256 tokenId,uint256 minAmount) external returns (bool) {
(bool ret0) = super._autoAcceptOffer(nftContract,tokenId,minAmount);
emit $_autoAcceptOffer_Returned(ret0);
return (ret0);
}
function $_cancelSendersOffer(address nftContract,uint256 tokenId) external {
return super._cancelSendersOffer(nftContract,tokenId);
}
function $_distributeFunds(address nftContract,uint256 tokenId,address payable seller,uint256 price,address payable buyReferrer,address payable sellerReferrerPaymentAddress,uint16 sellerReferrerTakeRateInBasisPoints) external returns (uint256, uint256, uint256) {
(uint256 ret0, uint256 ret1, uint256 ret2) = super._distributeFunds(nftContract,tokenId,seller,price,buyReferrer,sellerReferrerPaymentAddress,sellerReferrerTakeRateInBasisPoints);
emit $_distributeFunds_Returned(ret0, ret1, ret2);
return (ret0, ret1, ret2);
}
function $_sendValueWithFallbackWithdraw(address payable user,uint256 amount,uint256 gasLimit) external {
return super._sendValueWithFallbackWithdraw(user,amount,gasLimit);
}
function $__ReentrancyGuard_init() external {
return super.__ReentrancyGuard_init();
}
function $__ReentrancyGuard_init_unchained() external {
return super.__ReentrancyGuard_init_unchained();
}
function $_transferFromEscrow(address nftContract,uint256 tokenId,address recipient,address authorizeSeller) external {
return super._transferFromEscrow(nftContract,tokenId,recipient,authorizeSeller);
}
function $_transferFromEscrowIfAvailable(address nftContract,uint256 tokenId,address recipient) external {
return super._transferFromEscrowIfAvailable(nftContract,tokenId,recipient);
}
function $_transferToEscrow(address nftContract,uint256 tokenId) external {
return super._transferToEscrow(nftContract,tokenId);
}
function $_getMinIncrement(uint256 currentAmount) external pure returns (uint256) {
return super._getMinIncrement(currentAmount);
}
function $_getSellerOf(address nftContract,uint256 tokenId) external view returns (address payable) {
return super._getSellerOf(nftContract,tokenId);
}
function $_getSellerOrOwnerOf(address nftContract,uint256 tokenId) external view returns (address payable) {
return super._getSellerOrOwnerOf(nftContract,tokenId);
}
function $_tryUseFETHBalance(uint256 totalAmount,bool shouldRefundSurplus) external {
return super._tryUseFETHBalance(totalAmount,shouldRefundSurplus);
}
function $_disableInitializers() external {
return super._disableInitializers();
}
function $_getInitializedVersion() external view returns (uint8) {
return super._getInitializedVersion();
}
function $_isInitializing() external view returns (bool) {
return super._isInitializing();
}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/mixins/nftMarket/NFTMarketPrivateSaleGap.sol";
contract $NFTMarketPrivateSaleGap is NFTMarketPrivateSaleGap {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/mixins/nftMarket/NFTMarketReserveAuction.sol";
abstract contract $NFTMarketReserveAuction is NFTMarketReserveAuction {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
event $_getNextAndIncrementAuctionId_Returned(uint256 arg0);
event $_getExhibitionForPayment_Returned(address payable arg0, uint16 arg1);
event $_distributeFunds_Returned(uint256 arg0, uint256 arg1, uint256 arg2);
constructor(address payable _treasury, address _feth, uint16 protocolFeeInBasisPoints, address _royaltyRegistry, bool _assumePrimarySale, uint256 duration) FoundationTreasuryNode(_treasury) FETHNode(_feth) MarketFees(protocolFeeInBasisPoints, _royaltyRegistry, _assumePrimarySale) NFTMarketReserveAuction(duration) {}
function $feth() external view returns (IFethMarket) {
return feth;
}
function $_transferFromEscrow(address nftContract,uint256 tokenId,address recipient,address authorizeSeller) external {
return super._transferFromEscrow(nftContract,tokenId,recipient,authorizeSeller);
}
function $_transferFromEscrowIfAvailable(address nftContract,uint256 tokenId,address recipient) external {
return super._transferFromEscrowIfAvailable(nftContract,tokenId,recipient);
}
function $_transferToEscrow(address nftContract,uint256 tokenId) external {
return super._transferToEscrow(nftContract,tokenId);
}
function $_getSellerOf(address nftContract,uint256 tokenId) external view returns (address payable) {
return super._getSellerOf(nftContract,tokenId);
}
function $_isInActiveAuction(address nftContract,uint256 tokenId) external view returns (bool) {
return super._isInActiveAuction(nftContract,tokenId);
}
function $_initializeNFTMarketAuction() external {
return super._initializeNFTMarketAuction();
}
function $_getNextAndIncrementAuctionId() external returns (uint256) {
(uint256 ret0) = super._getNextAndIncrementAuctionId();
emit $_getNextAndIncrementAuctionId_Returned(ret0);
return (ret0);
}
function $_addNftToExhibition(address nftContract,uint256 tokenId,uint256 exhibitionId) external {
return super._addNftToExhibition(nftContract,tokenId,exhibitionId);
}
function $_getExhibitionForPayment(address nftContract,uint256 tokenId) external returns (address payable, uint16) {
(address payable ret0, uint16 ret1) = super._getExhibitionForPayment(nftContract,tokenId);
emit $_getExhibitionForPayment_Returned(ret0, ret1);
return (ret0, ret1);
}
function $_removeNftFromExhibition(address nftContract,uint256 tokenId) external {
return super._removeNftFromExhibition(nftContract,tokenId);
}
function $_distributeFunds(address nftContract,uint256 tokenId,address payable seller,uint256 price,address payable buyReferrer,address payable sellerReferrerPaymentAddress,uint16 sellerReferrerTakeRateInBasisPoints) external returns (uint256, uint256, uint256) {
(uint256 ret0, uint256 ret1, uint256 ret2) = super._distributeFunds(nftContract,tokenId,seller,price,buyReferrer,sellerReferrerPaymentAddress,sellerReferrerTakeRateInBasisPoints);
emit $_distributeFunds_Returned(ret0, ret1, ret2);
return (ret0, ret1, ret2);
}
function $_sendValueWithFallbackWithdraw(address payable user,uint256 amount,uint256 gasLimit) external {
return super._sendValueWithFallbackWithdraw(user,amount,gasLimit);
}
function $__ReentrancyGuard_init() external {
return super.__ReentrancyGuard_init();
}
function $__ReentrancyGuard_init_unchained() external {
return super.__ReentrancyGuard_init_unchained();
}
function $_beforeAuctionStarted(address arg0,uint256 arg1) external {
return super._beforeAuctionStarted(arg0,arg1);
}
function $_getMinIncrement(uint256 currentAmount) external pure returns (uint256) {
return super._getMinIncrement(currentAmount);
}
function $_getSellerOrOwnerOf(address nftContract,uint256 tokenId) external view returns (address payable) {
return super._getSellerOrOwnerOf(nftContract,tokenId);
}
function $_tryUseFETHBalance(uint256 totalAmount,bool shouldRefundSurplus) external {
return super._tryUseFETHBalance(totalAmount,shouldRefundSurplus);
}
function $_disableInitializers() external {
return super._disableInitializers();
}
function $_getInitializedVersion() external view returns (uint8) {
return super._getInitializedVersion();
}
function $_isInitializing() external view returns (bool) {
return super._isInitializing();
}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/mixins/shared/Constants.sol";
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/mixins/shared/FETHNode.sol";
contract $FETHNode is FETHNode {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor(address _feth) FETHNode(_feth) {}
function $feth() external view returns (IFethMarket) {
return feth;
}
function $_tryUseFETHBalance(uint256 totalAmount,bool shouldRefundSurplus) external {
return super._tryUseFETHBalance(totalAmount,shouldRefundSurplus);
}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/mixins/shared/FoundationTreasuryNode.sol";
contract $FoundationTreasuryNode is FoundationTreasuryNode {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor(address payable _treasury) FoundationTreasuryNode(_treasury) {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/mixins/shared/MarketFees.sol";
abstract contract $MarketFees is MarketFees {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
event $_distributeFunds_Returned(uint256 arg0, uint256 arg1, uint256 arg2);
constructor(address payable _treasury, address _feth, uint16 protocolFeeInBasisPoints, address _royaltyRegistry, bool _assumePrimarySale) FoundationTreasuryNode(_treasury) FETHNode(_feth) MarketFees(protocolFeeInBasisPoints, _royaltyRegistry, _assumePrimarySale) {}
function $feth() external view returns (IFethMarket) {
return feth;
}
function $_distributeFunds(address nftContract,uint256 tokenId,address payable seller,uint256 price,address payable buyReferrer,address payable sellerReferrerPaymentAddress,uint16 sellerReferrerTakeRateInBasisPoints) external returns (uint256, uint256, uint256) {
(uint256 ret0, uint256 ret1, uint256 ret2) = super._distributeFunds(nftContract,tokenId,seller,price,buyReferrer,sellerReferrerPaymentAddress,sellerReferrerTakeRateInBasisPoints);
emit $_distributeFunds_Returned(ret0, ret1, ret2);
return (ret0, ret1, ret2);
}
function $_sendValueWithFallbackWithdraw(address payable user,uint256 amount,uint256 gasLimit) external {
return super._sendValueWithFallbackWithdraw(user,amount,gasLimit);
}
function $_tryUseFETHBalance(uint256 totalAmount,bool shouldRefundSurplus) external {
return super._tryUseFETHBalance(totalAmount,shouldRefundSurplus);
}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/mixins/shared/MarketSharedCore.sol";
abstract contract $MarketSharedCore is MarketSharedCore {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor(address _feth) FETHNode(_feth) {}
function $feth() external view returns (IFethMarket) {
return feth;
}
function $_tryUseFETHBalance(uint256 totalAmount,bool shouldRefundSurplus) external {
return super._tryUseFETHBalance(totalAmount,shouldRefundSurplus);
}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/mixins/shared/SendValueWithFallbackWithdraw.sol";
contract $SendValueWithFallbackWithdraw is SendValueWithFallbackWithdraw {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor(address _feth) FETHNode(_feth) {}
function $feth() external view returns (IFethMarket) {
return feth;
}
function $_sendValueWithFallbackWithdraw(address payable user,uint256 amount,uint256 gasLimit) external {
return super._sendValueWithFallbackWithdraw(user,amount,gasLimit);
}
function $_tryUseFETHBalance(uint256 totalAmount,bool shouldRefundSurplus) external {
return super._tryUseFETHBalance(totalAmount,shouldRefundSurplus);
}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../contracts/NFTMarket.sol";
contract $NFTMarket is NFTMarket {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
event $_autoAcceptOffer_Returned(bool arg0);
event $_autoAcceptBuyPrice_Returned(bool arg0);
event $_getNextAndIncrementAuctionId_Returned(uint256 arg0);
event $_getExhibitionForPayment_Returned(address payable arg0, uint16 arg1);
event $_distributeFunds_Returned(uint256 arg0, uint256 arg1, uint256 arg2);
constructor(address payable treasury, address feth, address royaltyRegistry, uint256 duration) NFTMarket(treasury, feth, royaltyRegistry, duration) {}
function $feth() external view returns (IFethMarket) {
return feth;
}
function $_beforeAuctionStarted(address nftContract,uint256 tokenId) external {
return super._beforeAuctionStarted(nftContract,tokenId);
}
function $_transferFromEscrow(address nftContract,uint256 tokenId,address recipient,address authorizeSeller) external {
return super._transferFromEscrow(nftContract,tokenId,recipient,authorizeSeller);
}
function $_transferFromEscrowIfAvailable(address nftContract,uint256 tokenId,address recipient) external {
return super._transferFromEscrowIfAvailable(nftContract,tokenId,recipient);
}
function $_transferToEscrow(address nftContract,uint256 tokenId) external {
return super._transferToEscrow(nftContract,tokenId);
}
function $_getSellerOf(address nftContract,uint256 tokenId) external view returns (address payable) {
return super._getSellerOf(nftContract,tokenId);
}
function $_autoAcceptOffer(address nftContract,uint256 tokenId,uint256 minAmount) external returns (bool) {
(bool ret0) = super._autoAcceptOffer(nftContract,tokenId,minAmount);
emit $_autoAcceptOffer_Returned(ret0);
return (ret0);
}
function $_cancelSendersOffer(address nftContract,uint256 tokenId) external {
return super._cancelSendersOffer(nftContract,tokenId);
}
function $_autoAcceptBuyPrice(address nftContract,uint256 tokenId,uint256 maxPrice) external returns (bool) {
(bool ret0) = super._autoAcceptBuyPrice(nftContract,tokenId,maxPrice);
emit $_autoAcceptBuyPrice_Returned(ret0);
return (ret0);
}
function $_isInActiveAuction(address nftContract,uint256 tokenId) external view returns (bool) {
return super._isInActiveAuction(nftContract,tokenId);
}
function $_initializeNFTMarketAuction() external {
return super._initializeNFTMarketAuction();
}
function $_getNextAndIncrementAuctionId() external returns (uint256) {
(uint256 ret0) = super._getNextAndIncrementAuctionId();
emit $_getNextAndIncrementAuctionId_Returned(ret0);
return (ret0);
}
function $_addNftToExhibition(address nftContract,uint256 tokenId,uint256 exhibitionId) external {
return super._addNftToExhibition(nftContract,tokenId,exhibitionId);
}
function $_getExhibitionForPayment(address nftContract,uint256 tokenId) external returns (address payable, uint16) {
(address payable ret0, uint16 ret1) = super._getExhibitionForPayment(nftContract,tokenId);
emit $_getExhibitionForPayment_Returned(ret0, ret1);
return (ret0, ret1);
}
function $_removeNftFromExhibition(address nftContract,uint256 tokenId) external {
return super._removeNftFromExhibition(nftContract,tokenId);
}
function $_distributeFunds(address nftContract,uint256 tokenId,address payable seller,uint256 price,address payable buyReferrer,address payable sellerReferrerPaymentAddress,uint16 sellerReferrerTakeRateInBasisPoints) external returns (uint256, uint256, uint256) {
(uint256 ret0, uint256 ret1, uint256 ret2) = super._distributeFunds(nftContract,tokenId,seller,price,buyReferrer,sellerReferrerPaymentAddress,sellerReferrerTakeRateInBasisPoints);
emit $_distributeFunds_Returned(ret0, ret1, ret2);
return (ret0, ret1, ret2);
}
function $_sendValueWithFallbackWithdraw(address payable user,uint256 amount,uint256 gasLimit) external {
return super._sendValueWithFallbackWithdraw(user,amount,gasLimit);
}
function $__ReentrancyGuard_init() external {
return super.__ReentrancyGuard_init();
}
function $__ReentrancyGuard_init_unchained() external {
return super.__ReentrancyGuard_init_unchained();
}
function $_getMinIncrement(uint256 currentAmount) external pure returns (uint256) {
return super._getMinIncrement(currentAmount);
}
function $_getSellerOrOwnerOf(address nftContract,uint256 tokenId) external view returns (address payable) {
return super._getSellerOrOwnerOf(nftContract,tokenId);
}
function $_tryUseFETHBalance(uint256 totalAmount,bool shouldRefundSurplus) external {
return super._tryUseFETHBalance(totalAmount,shouldRefundSurplus);
}
function $_disableInitializers() external {
return super._disableInitializers();
}
function $_getInitializedVersion() external view returns (uint8) {
return super._getInitializedVersion();
}
function $_isInitializing() external view returns (bool) {
return super._isInitializing();
}
}
File 3 of 3: NFTCollection
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "./interfaces/internal/INFTCollectionInitializer.sol";
import "./interfaces/standards/royalties/IGetRoyalties.sol";
import "./interfaces/standards/royalties/ITokenCreator.sol";
import "./interfaces/standards/royalties/IGetFees.sol";
import "./interfaces/standards/royalties/IRoyaltyInfo.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/utils/introspection/ERC165Upgradeable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC721/ERC721Upgradeable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC721/extensions/ERC721BurnableUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
import "./libraries/AddressLibrary.sol";
import "./mixins/collections/SequentialMintCollection.sol";
import "./mixins/collections/CollectionRoyalties.sol";
import "./mixins/shared/ContractFactory.sol";
/**
* @title A collection of NFTs by a single creator.
* @notice All NFTs from this contract are minted by the same creator.
* A 10% royalty to the creator is included which may be split with collaborators on a per-NFT basis.
* @author batu-inal & HardlyDifficult
*/
contract NFTCollection is
INFTCollectionInitializer,
IGetRoyalties,
IGetFees,
IRoyaltyInfo,
ITokenCreator,
ContractFactory,
Initializable,
ERC165Upgradeable,
ERC721Upgradeable,
ERC721BurnableUpgradeable,
SequentialMintCollection,
CollectionRoyalties
{
using AddressLibrary for address;
using AddressUpgradeable for address;
/**
* @notice The baseURI to use for the tokenURI, if undefined then `ipfs://` is used.
*/
string private baseURI_;
/**
* @notice Stores hashes minted to prevent duplicates.
* @dev 0 means not yet minted, set to 1 when minted.
* For why using uint is better than using bool here:
* github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.7.3/contracts/security/ReentrancyGuard.sol#L23-L27
*/
mapping(string => uint256) private cidToMinted;
/**
* @dev Stores an optional alternate address to receive creator revenue and royalty payments.
* The target address may be a contract which could split or escrow payments.
*/
mapping(uint256 => address payable) private tokenIdToCreatorPaymentAddress;
/**
* @dev Stores a CID for each NFT.
*/
mapping(uint256 => string) private _tokenCIDs;
/**
* @notice Emitted when the owner changes the base URI to be used for NFTs in this collection.
* @param baseURI The new base URI to use.
*/
event BaseURIUpdated(string baseURI);
/**
* @notice Emitted when a new NFT is minted.
* @param creator The address of the collection owner at this time this NFT was minted.
* @param tokenId The tokenId of the newly minted NFT.
* @param indexedTokenCID The CID of the newly minted NFT, indexed to enable watching for mint events by the tokenCID.
* @param tokenCID The actual CID of the newly minted NFT.
*/
event Minted(address indexed creator, uint256 indexed tokenId, string indexed indexedTokenCID, string tokenCID);
/**
* @notice Emitted when the payment address for creator royalties is set.
* @param fromPaymentAddress The original address used for royalty payments.
* @param toPaymentAddress The new address used for royalty payments.
* @param tokenId The NFT which had the royalty payment address updated.
*/
event TokenCreatorPaymentAddressSet(
address indexed fromPaymentAddress,
address indexed toPaymentAddress,
uint256 indexed tokenId
);
/**
* @notice Initialize the template's immutable variables.
* @param _contractFactory The factory which will be used to create collection contracts.
*/
constructor(address _contractFactory)
ContractFactory(_contractFactory) // solhint-disable-next-line no-empty-blocks
{}
/**
* @notice Called by the contract factory on creation.
* @param _creator The creator of this collection.
* @param _name The collection's `name`.
* @param _symbol The collection's `symbol`.
*/
function initialize(
address payable _creator,
string calldata _name,
string calldata _symbol
) external initializer onlyContractFactory {
__ERC721_init(_name, _symbol);
_initializeSequentialMintCollection(_creator, 0);
}
/**
* @notice Allows the creator to burn a specific token if they currently own the NFT.
* @param tokenId The ID of the NFT to burn.
* @dev The function here asserts `onlyOwner` while the super confirms ownership.
*/
function burn(uint256 tokenId) public override onlyOwner {
super.burn(tokenId);
}
/**
* @notice Mint an NFT defined by its metadata path.
* @dev This is only callable by the collection creator/owner.
* @param tokenCID The CID for the metadata json of the NFT to mint.
* @return tokenId The tokenId of the newly minted NFT.
*/
function mint(string calldata tokenCID) external returns (uint256 tokenId) {
tokenId = _mint(tokenCID);
}
/**
* @notice Mint an NFT defined by its metadata path and approves the provided operator address.
* @dev This is only callable by the collection creator/owner.
* It can be used the first time they mint to save having to issue a separate approval
* transaction before listing the NFT for sale.
* @param tokenCID The CID for the metadata json of the NFT to mint.
* @param operator The address to set as an approved operator for the creator's account.
* @return tokenId The tokenId of the newly minted NFT.
*/
function mintAndApprove(string calldata tokenCID, address operator) external returns (uint256 tokenId) {
tokenId = _mint(tokenCID);
setApprovalForAll(operator, true);
}
/**
* @notice Mint an NFT defined by its metadata path and have creator revenue/royalties sent to an alternate address.
* @dev This is only callable by the collection creator/owner.
* @param tokenCID The CID for the metadata json of the NFT to mint.
* @param tokenCreatorPaymentAddress The royalty recipient address to use for this NFT.
* @return tokenId The tokenId of the newly minted NFT.
*/
function mintWithCreatorPaymentAddress(string calldata tokenCID, address payable tokenCreatorPaymentAddress)
public
returns (uint256 tokenId)
{
require(tokenCreatorPaymentAddress != address(0), "NFTCollection: tokenCreatorPaymentAddress is required");
tokenId = _mint(tokenCID);
tokenIdToCreatorPaymentAddress[tokenId] = tokenCreatorPaymentAddress;
emit TokenCreatorPaymentAddressSet(address(0), tokenCreatorPaymentAddress, tokenId);
}
/**
* @notice Mint an NFT defined by its metadata path and approves the provided operator address.
* @dev This is only callable by the collection creator/owner.
* It can be used the first time they mint to save having to issue a separate approval
* transaction before listing the NFT for sale.
* @param tokenCID The CID for the metadata json of the NFT to mint.
* @param tokenCreatorPaymentAddress The royalty recipient address to use for this NFT.
* @param operator The address to set as an approved operator for the creator's account.
* @return tokenId The tokenId of the newly minted NFT.
*/
function mintWithCreatorPaymentAddressAndApprove(
string calldata tokenCID,
address payable tokenCreatorPaymentAddress,
address operator
) external returns (uint256 tokenId) {
tokenId = mintWithCreatorPaymentAddress(tokenCID, tokenCreatorPaymentAddress);
setApprovalForAll(operator, true);
}
/**
* @notice Mint an NFT defined by its metadata path and have creator revenue/royalties sent to an alternate address
* which is defined by a contract call, typically a proxy contract address representing the payment terms.
* @dev This is only callable by the collection creator/owner.
* @param tokenCID The CID for the metadata json of the NFT to mint.
* @param paymentAddressFactory The contract to call which will return the address to use for payments.
* @param paymentAddressCall The call details to send to the factory provided.
* @return tokenId The tokenId of the newly minted NFT.
*/
function mintWithCreatorPaymentFactory(
string calldata tokenCID,
address paymentAddressFactory,
bytes calldata paymentAddressCall
) public returns (uint256 tokenId) {
address payable tokenCreatorPaymentAddress = paymentAddressFactory.callAndReturnContractAddress(paymentAddressCall);
tokenId = mintWithCreatorPaymentAddress(tokenCID, tokenCreatorPaymentAddress);
}
/**
* @notice Mint an NFT defined by its metadata path and have creator revenue/royalties sent to an alternate address
* which is defined by a contract call, typically a proxy contract address representing the payment terms.
* @dev This is only callable by the collection creator/owner.
* It can be used the first time they mint to save having to issue a separate approval
* transaction before listing the NFT for sale.
* @param tokenCID The CID for the metadata json of the NFT to mint.
* @param paymentAddressFactory The contract to call which will return the address to use for payments.
* @param paymentAddressCall The call details to send to the factory provided.
* @param operator The address to set as an approved operator for the creator's account.
* @return tokenId The tokenId of the newly minted NFT.
*/
function mintWithCreatorPaymentFactoryAndApprove(
string calldata tokenCID,
address paymentAddressFactory,
bytes calldata paymentAddressCall,
address operator
) external returns (uint256 tokenId) {
tokenId = mintWithCreatorPaymentFactory(tokenCID, paymentAddressFactory, paymentAddressCall);
setApprovalForAll(operator, true);
}
/**
* @notice Allows the collection creator to destroy this contract only if
* no NFTs have been minted yet or the minted NFTs have been burned.
* @dev Once destructed, a new collection could be deployed to this address (although that's discouraged).
*/
function selfDestruct() external onlyOwner {
_selfDestruct();
}
/**
* @notice Allows the owner to assign a baseURI to use for the tokenURI instead of the default `ipfs://`.
* @param baseURIOverride The new base URI to use for all NFTs in this collection.
*/
function updateBaseURI(string calldata baseURIOverride) external onlyOwner {
baseURI_ = baseURIOverride;
emit BaseURIUpdated(baseURIOverride);
}
/**
* @notice Allows the owner to set a max tokenID.
* This provides a guarantee to collectors about the limit of this collection contract, if applicable.
* @dev Once this value has been set, it may be decreased but can never be increased.
* This max may be more than the final `totalSupply` if 1 or more tokens were burned.
* @param _maxTokenId The max tokenId to set, all NFTs must have a tokenId less than or equal to this value.
*/
function updateMaxTokenId(uint32 _maxTokenId) external onlyOwner {
_updateMaxTokenId(_maxTokenId);
}
function _burn(uint256 tokenId) internal override(ERC721Upgradeable, SequentialMintCollection) {
delete cidToMinted[_tokenCIDs[tokenId]];
delete tokenIdToCreatorPaymentAddress[tokenId];
delete _tokenCIDs[tokenId];
super._burn(tokenId);
}
function _mint(string calldata tokenCID) private onlyOwner returns (uint256 tokenId) {
require(bytes(tokenCID).length != 0, "NFTCollection: tokenCID is required");
require(cidToMinted[tokenCID] == 0, "NFTCollection: NFT was already minted");
// Number of tokens cannot realistically overflow 32 bits.
tokenId = ++latestTokenId;
require(maxTokenId == 0 || tokenId <= maxTokenId, "NFTCollection: Max token count has already been minted");
cidToMinted[tokenCID] = 1;
_tokenCIDs[tokenId] = tokenCID;
_safeMint(msg.sender, tokenId);
emit Minted(msg.sender, tokenId, tokenCID, tokenCID);
}
/**
* @notice The base URI used for all NFTs in this collection.
* @dev The `tokenCID` is appended to this to obtain an NFT's `tokenURI`.
* e.g. The URI for a token with the `tokenCID`: "foo" and `baseURI`: "ipfs://" is "ipfs://foo".
* @return uri The base URI used by this collection.
*/
function baseURI() external view returns (string memory uri) {
uri = _baseURI();
}
/**
* @notice Checks if the creator has already minted a given NFT using this collection contract.
* @param tokenCID The CID to check for.
* @return hasBeenMinted True if the creator has already minted an NFT with this CID.
*/
function getHasMintedCID(string calldata tokenCID) external view returns (bool hasBeenMinted) {
hasBeenMinted = cidToMinted[tokenCID] != 0;
}
/**
* @inheritdoc CollectionRoyalties
*/
function getTokenCreatorPaymentAddress(uint256 tokenId)
public
view
override
returns (address payable creatorPaymentAddress)
{
creatorPaymentAddress = tokenIdToCreatorPaymentAddress[tokenId];
if (creatorPaymentAddress == address(0)) {
creatorPaymentAddress = owner;
}
}
/**
* @inheritdoc IERC165Upgradeable
*/
function supportsInterface(bytes4 interfaceId)
public
view
override(ERC165Upgradeable, ERC721Upgradeable, CollectionRoyalties)
returns (bool interfaceSupported)
{
// This is a no-op function required to avoid compile errors.
interfaceSupported = super.supportsInterface(interfaceId);
}
/**
* @inheritdoc IERC721MetadataUpgradeable
*/
function tokenURI(uint256 tokenId) public view override returns (string memory uri) {
require(_exists(tokenId), "NFTCollection: URI query for nonexistent token");
uri = string.concat(_baseURI(), _tokenCIDs[tokenId]);
}
function _baseURI() internal view override returns (string memory uri) {
uri = baseURI_;
if (bytes(uri).length == 0) {
uri = "ipfs://";
}
}
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
struct CallWithoutValue {
address target;
bytes callData;
}
/**
* @title A library for address helpers not already covered by the OZ library.
* @author batu-inal & HardlyDifficult
*/
library AddressLibrary {
using AddressUpgradeable for address;
using AddressUpgradeable for address payable;
/**
* @notice Calls an external contract with arbitrary data and parse the return value into an address.
* @param externalContract The address of the contract to call.
* @param callData The data to send to the contract.
* @return contractAddress The address of the contract returned by the call.
*/
function callAndReturnContractAddress(address externalContract, bytes calldata callData)
internal
returns (address payable contractAddress)
{
bytes memory returnData = externalContract.functionCall(callData);
contractAddress = abi.decode(returnData, (address));
require(contractAddress.isContract(), "InternalProxyCall: did not return a contract");
}
function callAndReturnContractAddress(CallWithoutValue calldata call)
internal
returns (address payable contractAddress)
{
contractAddress = callAndReturnContractAddress(call.target, call.callData);
}
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
/**
* @author batu-inal & HardlyDifficult
*/
interface INFTCollectionInitializer {
function initialize(
address payable _creator,
string memory _name,
string memory _symbol
) external;
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC721/extensions/ERC721BurnableUpgradeable.sol";
import "../../interfaces/standards/royalties/ITokenCreator.sol";
/**
* @title Extends the OZ ERC721 implementation for collections which mint sequential token IDs.
* @author batu-inal & HardlyDifficult
*/
abstract contract SequentialMintCollection is ITokenCreator, Initializable, ERC721BurnableUpgradeable {
/****** Slot 0 (after inheritance) ******/
/**
* @notice The creator/owner of this NFT collection.
* @dev This is the default royalty recipient if a different `paymentAddress` was not provided.
* @return The collection's creator/owner address.
*/
address payable public owner;
/**
* @notice The tokenId of the most recently created NFT.
* @dev Minting starts at tokenId 1. Each mint will use this value + 1.
* @return The most recently minted tokenId, or 0 if no NFTs have been minted yet.
*/
uint32 public latestTokenId;
/**
* @notice The max tokenId which can be minted.
* @dev This max may be less than the final `totalSupply` if 1 or more tokens were burned.
* @return The max tokenId which can be minted.
*/
uint32 public maxTokenId;
/**
* @notice Tracks how many tokens have been burned.
* @dev This number is used to calculate the total supply efficiently.
*/
uint32 private burnCounter;
/****** End of storage ******/
/**
* @notice Emitted when the max tokenId supported by this collection is updated.
* @param maxTokenId The new max tokenId. All NFTs in this collection will have a tokenId less than
* or equal to this value.
*/
event MaxTokenIdUpdated(uint256 indexed maxTokenId);
/**
* @notice Emitted when this collection is self destructed by the creator/owner/admin.
* @param admin The account which requested this contract be self destructed.
*/
event SelfDestruct(address indexed admin);
modifier onlyOwner() {
require(msg.sender == owner, "SequentialMintCollection: Caller is not owner");
_;
}
function _initializeSequentialMintCollection(address payable _creator, uint32 _maxTokenId) internal onlyInitializing {
owner = _creator;
maxTokenId = _maxTokenId;
}
/**
* @notice Allows the collection owner to destroy this contract only if
* no NFTs have been minted yet or the minted NFTs have been burned.
*/
function _selfDestruct() internal {
require(totalSupply() == 0, "SequentialMintCollection: Any NFTs minted must be burned first");
emit SelfDestruct(msg.sender);
selfdestruct(payable(msg.sender));
}
/**
* @notice Allows the owner to set a max tokenID.
* This provides a guarantee to collectors about the limit of this collection contract, if applicable.
* @dev Once this value has been set, it may be decreased but can never be increased.
* @param _maxTokenId The max tokenId to set, all NFTs must have a tokenId less than or equal to this value.
*/
function _updateMaxTokenId(uint32 _maxTokenId) internal {
require(_maxTokenId != 0, "SequentialMintCollection: Max token ID may not be cleared");
require(maxTokenId == 0 || _maxTokenId < maxTokenId, "SequentialMintCollection: Max token ID may not increase");
require(latestTokenId <= _maxTokenId, "SequentialMintCollection: Max token ID must be >= last mint");
maxTokenId = _maxTokenId;
emit MaxTokenIdUpdated(_maxTokenId);
}
function _burn(uint256 tokenId) internal virtual override {
unchecked {
// Number of burned tokens cannot exceed latestTokenId which is the same size.
++burnCounter;
}
super._burn(tokenId);
}
/**
* @inheritdoc ITokenCreator
* @dev The tokenId param is ignored since all NFTs return the same value.
*/
function tokenCreator(
uint256 /* tokenId */
) external view returns (address payable creator) {
creator = owner;
}
/**
* @notice Returns the total amount of tokens stored by the contract.
* @dev From the ERC-721 enumerable standard.
* @return supply The total number of NFTs tracked by this contract.
*/
function totalSupply() public view returns (uint256 supply) {
unchecked {
// Number of tokens minted is always >= burned tokens.
supply = latestTokenId - burnCounter;
}
}
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/utils/introspection/ERC165Upgradeable.sol";
import "../../interfaces/standards/royalties/IGetFees.sol";
import "../../interfaces/standards/royalties/IGetRoyalties.sol";
import "../../interfaces/standards/royalties/IRoyaltyInfo.sol";
import "../../interfaces/standards/royalties/ITokenCreator.sol";
import "../shared/Constants.sol";
/**
* @title Defines various royalty APIs for broad marketplace support.
* @author batu-inal & HardlyDifficult
*/
abstract contract CollectionRoyalties is IGetRoyalties, IGetFees, IRoyaltyInfo, ITokenCreator, ERC165Upgradeable {
/**
* @inheritdoc IGetFees
*/
function getFeeRecipients(uint256 tokenId) external view returns (address payable[] memory recipients) {
recipients = new address payable[](1);
recipients[0] = getTokenCreatorPaymentAddress(tokenId);
}
/**
* @inheritdoc IGetFees
* @dev The tokenId param is ignored since all NFTs return the same value.
*/
function getFeeBps(
uint256 /* tokenId */
) external pure returns (uint256[] memory royaltiesInBasisPoints) {
royaltiesInBasisPoints = new uint256[](1);
royaltiesInBasisPoints[0] = ROYALTY_IN_BASIS_POINTS;
}
/**
* @inheritdoc IGetRoyalties
*/
function getRoyalties(uint256 tokenId)
external
view
returns (address payable[] memory recipients, uint256[] memory royaltiesInBasisPoints)
{
recipients = new address payable[](1);
recipients[0] = getTokenCreatorPaymentAddress(tokenId);
royaltiesInBasisPoints = new uint256[](1);
royaltiesInBasisPoints[0] = ROYALTY_IN_BASIS_POINTS;
}
/**
* @notice The address to pay the creator proceeds/royalties for the collection.
* @param tokenId The ID of the NFT to get the creator payment address for.
* @return creatorPaymentAddress The address to which royalties should be paid.
*/
function getTokenCreatorPaymentAddress(uint256 tokenId)
public
view
virtual
returns (address payable creatorPaymentAddress);
/**
* @inheritdoc IRoyaltyInfo
*/
function royaltyInfo(uint256 tokenId, uint256 salePrice)
external
view
returns (address receiver, uint256 royaltyAmount)
{
receiver = getTokenCreatorPaymentAddress(tokenId);
unchecked {
royaltyAmount = salePrice / ROYALTY_RATIO;
}
}
/**
* @inheritdoc IERC165Upgradeable
* @dev Checks the supported royalty interfaces.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool interfaceSupported) {
interfaceSupported = (interfaceId == type(IRoyaltyInfo).interfaceId ||
interfaceId == type(ITokenCreator).interfaceId ||
interfaceId == type(IGetRoyalties).interfaceId ||
interfaceId == type(IGetFees).interfaceId ||
super.supportsInterface(interfaceId));
}
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
/**
* @title Stores a reference to the factory which is used to create contract proxies.
* @author batu-inal & HardlyDifficult
*/
abstract contract ContractFactory {
using AddressUpgradeable for address;
/**
* @notice The address of the factory which was used to create this contract.
* @return The factory contract address.
*/
address public immutable contractFactory;
modifier onlyContractFactory() {
require(msg.sender == contractFactory, "ContractFactory: Caller is not the factory");
_;
}
/**
* @notice Initialize the template's immutable variables.
* @param _contractFactory The factory which will be used to create these contracts.
*/
constructor(address _contractFactory) {
require(_contractFactory.isContract(), "ContractFactory: Factory is not a contract");
contractFactory = _contractFactory;
}
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
interface IGetRoyalties {
/**
* @notice Get the creator royalties to be sent.
* @dev The data is the same as when calling `getFeeRecipients` and `getFeeBps` separately.
* @param tokenId The ID of the NFT to get royalties for.
* @return recipients An array of addresses to which royalties should be sent.
* @return royaltiesInBasisPoints The array of fees to be sent to each recipient, in basis points.
*/
function getRoyalties(uint256 tokenId)
external
view
returns (address payable[] memory recipients, uint256[] memory royaltiesInBasisPoints);
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
interface ITokenCreator {
/**
* @notice Returns the creator of this NFT collection.
* @param tokenId The ID of the NFT to get the creator payment address for.
* @return creator The creator of this collection.
*/
function tokenCreator(uint256 tokenId) external view returns (address payable creator);
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
/**
* @notice An interface for communicating fees to 3rd party marketplaces.
* @dev Originally implemented in mainnet contract 0x44d6e8933f8271abcf253c72f9ed7e0e4c0323b3
*/
interface IGetFees {
/**
* @notice Get the recipient addresses to which creator royalties should be sent.
* @dev The expected royalty amounts are communicated with `getFeeBps`.
* @param tokenId The ID of the NFT to get royalties for.
* @return recipients An array of addresses to which royalties should be sent.
*/
function getFeeRecipients(uint256 tokenId) external view returns (address payable[] memory recipients);
/**
* @notice Get the creator royalty amounts to be sent to each recipient, in basis points.
* @dev The expected recipients are communicated with `getFeeRecipients`.
* @param tokenId The ID of the NFT to get royalties for.
* @return royaltiesInBasisPoints The array of fees to be sent to each recipient, in basis points.
*/
function getFeeBps(uint256 tokenId) external view returns (uint256[] memory royaltiesInBasisPoints);
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
/**
* @notice Interface for EIP-2981: NFT Royalty Standard.
* For more see: https://eips.ethereum.org/EIPS/eip-2981.
*/
interface IRoyaltyInfo {
/**
* @notice Get the creator royalties to be sent.
* @param tokenId The ID of the NFT to get royalties for.
* @param salePrice The total price of the sale.
* @return receiver The address to which royalties should be sent.
* @return royaltyAmount The total amount that should be sent to the `receiver`.
*/
function royaltyInfo(uint256 tokenId, uint256 salePrice)
external
view
returns (address receiver, uint256 royaltyAmount);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.2;
import "../../utils/AddressUpgradeable.sol";
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Indicates that the contract has been initialized.
* @custom:oz-retyped-from bool
*/
uint8 private _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private _initializing;
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint8 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts. Equivalent to `reinitializer(1)`.
*/
modifier initializer() {
bool isTopLevelCall = !_initializing;
require(
(isTopLevelCall && _initialized < 1) || (!AddressUpgradeable.isContract(address(this)) && _initialized == 1),
"Initializable: contract is already initialized"
);
_initialized = 1;
if (isTopLevelCall) {
_initializing = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* `initializer` is equivalent to `reinitializer(1)`, so 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.
*
* 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.
*/
modifier reinitializer(uint8 version) {
require(!_initializing && _initialized < version, "Initializable: contract is already initialized");
_initialized = version;
_initializing = true;
_;
_initializing = false;
emit Initialized(version);
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
require(_initializing, "Initializable: contract is not initializing");
_;
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*/
function _disableInitializers() internal virtual {
require(!_initializing, "Initializable: contract is initializing");
if (_initialized < type(uint8).max) {
_initialized = type(uint8).max;
emit Initialized(type(uint8).max);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)
pragma solidity ^0.8.0;
import "./IERC165Upgradeable.sol";
import "../../proxy/utils/Initializable.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*
* Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
*/
abstract contract ERC165Upgradeable is Initializable, IERC165Upgradeable {
function __ERC165_init() internal onlyInitializing {
}
function __ERC165_init_unchained() internal onlyInitializing {
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IERC165Upgradeable).interfaceId;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (token/ERC721/ERC721.sol)
pragma solidity ^0.8.0;
import "./IERC721Upgradeable.sol";
import "./IERC721ReceiverUpgradeable.sol";
import "./extensions/IERC721MetadataUpgradeable.sol";
import "../../utils/AddressUpgradeable.sol";
import "../../utils/ContextUpgradeable.sol";
import "../../utils/StringsUpgradeable.sol";
import "../../utils/introspection/ERC165Upgradeable.sol";
import "../../proxy/utils/Initializable.sol";
/**
* @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC721] Non-Fungible Token Standard, including
* the Metadata extension, but not including the Enumerable extension, which is available separately as
* {ERC721Enumerable}.
*/
contract ERC721Upgradeable is Initializable, ContextUpgradeable, ERC165Upgradeable, IERC721Upgradeable, IERC721MetadataUpgradeable {
using AddressUpgradeable for address;
using StringsUpgradeable for uint256;
// Token name
string private _name;
// Token symbol
string private _symbol;
// Mapping from token ID to owner address
mapping(uint256 => address) private _owners;
// Mapping owner address to token count
mapping(address => uint256) private _balances;
// Mapping from token ID to approved address
mapping(uint256 => address) private _tokenApprovals;
// Mapping from owner to operator approvals
mapping(address => mapping(address => bool)) private _operatorApprovals;
/**
* @dev Initializes the contract by setting a `name` and a `symbol` to the token collection.
*/
function __ERC721_init(string memory name_, string memory symbol_) internal onlyInitializing {
__ERC721_init_unchained(name_, symbol_);
}
function __ERC721_init_unchained(string memory name_, string memory symbol_) internal onlyInitializing {
_name = name_;
_symbol = symbol_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165Upgradeable, IERC165Upgradeable) returns (bool) {
return
interfaceId == type(IERC721Upgradeable).interfaceId ||
interfaceId == type(IERC721MetadataUpgradeable).interfaceId ||
super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC721-balanceOf}.
*/
function balanceOf(address owner) public view virtual override returns (uint256) {
require(owner != address(0), "ERC721: address zero is not a valid owner");
return _balances[owner];
}
/**
* @dev See {IERC721-ownerOf}.
*/
function ownerOf(uint256 tokenId) public view virtual override returns (address) {
address owner = _owners[tokenId];
require(owner != address(0), "ERC721: invalid token ID");
return owner;
}
/**
* @dev See {IERC721Metadata-name}.
*/
function name() public view virtual override returns (string memory) {
return _name;
}
/**
* @dev See {IERC721Metadata-symbol}.
*/
function symbol() public view virtual override returns (string memory) {
return _symbol;
}
/**
* @dev See {IERC721Metadata-tokenURI}.
*/
function tokenURI(uint256 tokenId) public view virtual override returns (string memory) {
_requireMinted(tokenId);
string memory baseURI = _baseURI();
return bytes(baseURI).length > 0 ? string(abi.encodePacked(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 "";
}
/**
* @dev See {IERC721-approve}.
*/
function approve(address to, uint256 tokenId) public virtual override {
address owner = ERC721Upgradeable.ownerOf(tokenId);
require(to != owner, "ERC721: approval to current owner");
require(
_msgSender() == owner || isApprovedForAll(owner, _msgSender()),
"ERC721: approve caller is not token owner nor approved for all"
);
_approve(to, tokenId);
}
/**
* @dev See {IERC721-getApproved}.
*/
function getApproved(uint256 tokenId) public view virtual override returns (address) {
_requireMinted(tokenId);
return _tokenApprovals[tokenId];
}
/**
* @dev See {IERC721-setApprovalForAll}.
*/
function setApprovalForAll(address operator, bool approved) public virtual override {
_setApprovalForAll(_msgSender(), operator, approved);
}
/**
* @dev See {IERC721-isApprovedForAll}.
*/
function isApprovedForAll(address owner, address operator) public view virtual override returns (bool) {
return _operatorApprovals[owner][operator];
}
/**
* @dev See {IERC721-transferFrom}.
*/
function transferFrom(
address from,
address to,
uint256 tokenId
) public virtual override {
//solhint-disable-next-line max-line-length
require(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721: caller is not token owner nor approved");
_transfer(from, to, tokenId);
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(
address from,
address to,
uint256 tokenId
) public virtual override {
safeTransferFrom(from, to, tokenId, "");
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(
address from,
address to,
uint256 tokenId,
bytes memory data
) public virtual override {
require(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721: caller is not token owner nor approved");
_safeTransfer(from, to, tokenId, data);
}
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC721 protocol 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 equivalent to {safeTransferFrom}, and can be used to e.g.
* implement alternative mechanisms to perform token transfer, such as signature-based.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - 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,
bytes memory data
) internal virtual {
_transfer(from, to, tokenId);
require(_checkOnERC721Received(from, to, tokenId, data), "ERC721: transfer to non ERC721Receiver implementer");
}
/**
* @dev Returns whether `tokenId` exists.
*
* Tokens can be managed by their owner or approved accounts via {approve} or {setApprovalForAll}.
*
* Tokens start existing when they are minted (`_mint`),
* and stop existing when they are burned (`_burn`).
*/
function _exists(uint256 tokenId) internal view virtual returns (bool) {
return _owners[tokenId] != address(0);
}
/**
* @dev Returns whether `spender` is allowed to manage `tokenId`.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function _isApprovedOrOwner(address spender, uint256 tokenId) internal view virtual returns (bool) {
address owner = ERC721Upgradeable.ownerOf(tokenId);
return (spender == owner || isApprovedForAll(owner, spender) || getApproved(tokenId) == spender);
}
/**
* @dev Safely mints `tokenId` and transfers it to `to`.
*
* 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 virtual {
_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);
require(
_checkOnERC721Received(address(0), to, tokenId, data),
"ERC721: transfer to non ERC721Receiver implementer"
);
}
/**
* @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 virtual {
require(to != address(0), "ERC721: mint to the zero address");
require(!_exists(tokenId), "ERC721: token already minted");
_beforeTokenTransfer(address(0), to, tokenId);
_balances[to] += 1;
_owners[tokenId] = to;
emit Transfer(address(0), to, tokenId);
_afterTokenTransfer(address(0), to, tokenId);
}
/**
* @dev Destroys `tokenId`.
* The approval is cleared when the token is burned.
*
* Requirements:
*
* - `tokenId` must exist.
*
* Emits a {Transfer} event.
*/
function _burn(uint256 tokenId) internal virtual {
address owner = ERC721Upgradeable.ownerOf(tokenId);
_beforeTokenTransfer(owner, address(0), tokenId);
// Clear approvals
_approve(address(0), tokenId);
_balances[owner] -= 1;
delete _owners[tokenId];
emit Transfer(owner, address(0), tokenId);
_afterTokenTransfer(owner, address(0), 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 virtual {
require(ERC721Upgradeable.ownerOf(tokenId) == from, "ERC721: transfer from incorrect owner");
require(to != address(0), "ERC721: transfer to the zero address");
_beforeTokenTransfer(from, to, tokenId);
// Clear approvals from the previous owner
_approve(address(0), tokenId);
_balances[from] -= 1;
_balances[to] += 1;
_owners[tokenId] = to;
emit Transfer(from, to, tokenId);
_afterTokenTransfer(from, to, tokenId);
}
/**
* @dev Approve `to` to operate on `tokenId`
*
* Emits an {Approval} event.
*/
function _approve(address to, uint256 tokenId) internal virtual {
_tokenApprovals[tokenId] = to;
emit Approval(ERC721Upgradeable.ownerOf(tokenId), to, tokenId);
}
/**
* @dev Approve `operator` to operate on all of `owner` tokens
*
* Emits an {ApprovalForAll} event.
*/
function _setApprovalForAll(
address owner,
address operator,
bool approved
) internal virtual {
require(owner != operator, "ERC721: approve to caller");
_operatorApprovals[owner][operator] = approved;
emit ApprovalForAll(owner, operator, approved);
}
/**
* @dev Reverts if the `tokenId` has not been minted yet.
*/
function _requireMinted(uint256 tokenId) internal view virtual {
require(_exists(tokenId), "ERC721: invalid token ID");
}
/**
* @dev Internal function to invoke {IERC721Receiver-onERC721Received} on a target address.
* The call is not executed if the target address is not a contract.
*
* @param from address representing the previous owner of the given token ID
* @param to target address that will receive the tokens
* @param tokenId uint256 ID of the token to be transferred
* @param data bytes optional data to send along with the call
* @return bool whether the call correctly returned the expected magic value
*/
function _checkOnERC721Received(
address from,
address to,
uint256 tokenId,
bytes memory data
) private returns (bool) {
if (to.isContract()) {
try IERC721ReceiverUpgradeable(to).onERC721Received(_msgSender(), from, tokenId, data) returns (bytes4 retval) {
return retval == IERC721ReceiverUpgradeable.onERC721Received.selector;
} catch (bytes memory reason) {
if (reason.length == 0) {
revert("ERC721: transfer to non ERC721Receiver implementer");
} else {
/// @solidity memory-safe-assembly
assembly {
revert(add(32, reason), mload(reason))
}
}
}
} else {
return true;
}
}
/**
* @dev Hook that is called before any token transfer. This includes minting
* and burning.
*
* Calling conditions:
*
* - When `from` and `to` are both non-zero, ``from``'s `tokenId` will be
* transferred to `to`.
* - When `from` is zero, `tokenId` will be minted for `to`.
* - When `to` is zero, ``from``'s `tokenId` will be burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _beforeTokenTransfer(
address from,
address to,
uint256 tokenId
) internal virtual {}
/**
* @dev Hook that is called after any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _afterTokenTransfer(
address from,
address to,
uint256 tokenId
) internal virtual {}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[44] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library AddressUpgradeable {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/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.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCall(target, data, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value
) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
require(isContract(target), "Address: static call to non-contract");
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (token/ERC721/extensions/ERC721Burnable.sol)
pragma solidity ^0.8.0;
import "../ERC721Upgradeable.sol";
import "../../../utils/ContextUpgradeable.sol";
import "../../../proxy/utils/Initializable.sol";
/**
* @title ERC721 Burnable Token
* @dev ERC721 Token that can be burned (destroyed).
*/
abstract contract ERC721BurnableUpgradeable is Initializable, ContextUpgradeable, ERC721Upgradeable {
function __ERC721Burnable_init() internal onlyInitializing {
}
function __ERC721Burnable_init_unchained() internal onlyInitializing {
}
/**
* @dev Burns `tokenId`. See {ERC721-_burn}.
*
* Requirements:
*
* - The caller must own `tokenId` or be an approved operator.
*/
function burn(uint256 tokenId) public virtual {
//solhint-disable-next-line max-line-length
require(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721: caller is not token owner nor approved");
_burn(tokenId);
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
pragma solidity ^0.8.0;
import "../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;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (utils/Strings.sol)
pragma solidity ^0.8.0;
/**
* @dev String operations.
*/
library StringsUpgradeable {
bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef";
uint8 private constant _ADDRESS_LENGTH = 20;
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
// Inspired by OraclizeAPI's implementation - MIT licence
// https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol
if (value == 0) {
return "0";
}
uint256 temp = value;
uint256 digits;
while (temp != 0) {
digits++;
temp /= 10;
}
bytes memory buffer = new bytes(digits);
while (value != 0) {
digits -= 1;
buffer[digits] = bytes1(uint8(48 + uint256(value % 10)));
value /= 10;
}
return string(buffer);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
if (value == 0) {
return "0x00";
}
uint256 temp = value;
uint256 length = 0;
while (temp != 0) {
length++;
temp >>= 8;
}
return toHexString(value, length);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = _HEX_SYMBOLS[value & 0xf];
value >>= 4;
}
require(value == 0, "Strings: hex length insufficient");
return string(buffer);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation.
*/
function toHexString(address addr) internal pure returns (string memory) {
return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (token/ERC721/IERC721.sol)
pragma solidity ^0.8.0;
import "../../utils/introspection/IERC165Upgradeable.sol";
/**
* @dev Required interface of an ERC721 compliant contract.
*/
interface IERC721Upgradeable is IERC165Upgradeable {
/**
* @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 ERC721 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: Usage of this method is discouraged, use {safeTransferFrom} whenever possible.
*
* 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 caller.
*
* 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 v4.6.0) (token/ERC721/IERC721Receiver.sol)
pragma solidity ^0.8.0;
/**
* @title ERC721 token receiver interface
* @dev Interface for any contract that wants to support safeTransfers
* from ERC721 asset contracts.
*/
interface IERC721ReceiverUpgradeable {
/**
* @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 v4.4.1 (token/ERC721/extensions/IERC721Metadata.sol)
pragma solidity ^0.8.0;
import "../IERC721Upgradeable.sol";
/**
* @title ERC-721 Non-Fungible Token Standard, optional metadata extension
* @dev See https://eips.ethereum.org/EIPS/eip-721
*/
interface IERC721MetadataUpgradeable is IERC721Upgradeable {
/**
* @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 v4.4.1 (utils/introspection/IERC165.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165Upgradeable {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
/// Constant values shared across mixins.
/**
* @dev 100% in basis points.
*/
uint256 constant BASIS_POINTS = 10_000;
/**
* @dev The default admin role defined by OZ ACL modules.
*/
bytes32 constant DEFAULT_ADMIN_ROLE = 0x00;
/**
* @dev Cap the number of royalty recipients.
* A cap is required to ensure gas costs are not too high when a sale is settled.
*/
uint256 constant MAX_ROYALTY_RECIPIENTS = 5;
/**
* @dev The minimum increase of 10% required when making an offer or placing a bid.
*/
uint256 constant MIN_PERCENT_INCREMENT_DENOMINATOR = BASIS_POINTS / 1_000;
/**
* @dev The gas limit used when making external read-only calls.
* This helps to ensure that external calls does not prevent the market from executing.
*/
uint256 constant READ_ONLY_GAS_LIMIT = 40_000;
/**
* @dev Default royalty cut paid out on secondary sales.
* Set to 10% of the secondary sale.
*/
uint96 constant ROYALTY_IN_BASIS_POINTS = 1_000;
/**
* @dev 10%, expressed as a denominator for more efficient calculations.
*/
uint256 constant ROYALTY_RATIO = BASIS_POINTS / ROYALTY_IN_BASIS_POINTS;
/**
* @dev The gas limit to send ETH to multiple recipients, enough for a 5-way split.
*/
uint256 constant SEND_VALUE_GAS_LIMIT_MULTIPLE_RECIPIENTS = 210_000;
/**
* @dev The gas limit to send ETH to a single recipient, enough for a contract with a simple receiver.
*/
uint256 constant SEND_VALUE_GAS_LIMIT_SINGLE_RECIPIENT = 20_000;
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../contracts/NFTCollection.sol";
contract $NFTCollection is NFTCollection {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor(address _contractFactory) NFTCollection(_contractFactory) {}
function $_burn(uint256 tokenId) external {
return super._burn(tokenId);
}
function $_baseURI() external view returns (string memory) {
return super._baseURI();
}
function $_initializeSequentialMintCollection(address payable _creator,uint32 _maxTokenId) external {
return super._initializeSequentialMintCollection(_creator,_maxTokenId);
}
function $_selfDestruct() external {
return super._selfDestruct();
}
function $_updateMaxTokenId(uint32 _maxTokenId) external {
return super._updateMaxTokenId(_maxTokenId);
}
function $__ERC721Burnable_init() external {
return super.__ERC721Burnable_init();
}
function $__ERC721Burnable_init_unchained() external {
return super.__ERC721Burnable_init_unchained();
}
function $__ERC721_init(string calldata name_,string calldata symbol_) external {
return super.__ERC721_init(name_,symbol_);
}
function $__ERC721_init_unchained(string calldata name_,string calldata symbol_) external {
return super.__ERC721_init_unchained(name_,symbol_);
}
function $_safeTransfer(address from,address to,uint256 tokenId,bytes calldata data) external {
return super._safeTransfer(from,to,tokenId,data);
}
function $_exists(uint256 tokenId) external view returns (bool) {
return super._exists(tokenId);
}
function $_isApprovedOrOwner(address spender,uint256 tokenId) external view returns (bool) {
return super._isApprovedOrOwner(spender,tokenId);
}
function $_safeMint(address to,uint256 tokenId) external {
return super._safeMint(to,tokenId);
}
function $_safeMint(address to,uint256 tokenId,bytes calldata data) external {
return super._safeMint(to,tokenId,data);
}
function $_mint(address to,uint256 tokenId) external {
return super._mint(to,tokenId);
}
function $_transfer(address from,address to,uint256 tokenId) external {
return super._transfer(from,to,tokenId);
}
function $_approve(address to,uint256 tokenId) external {
return super._approve(to,tokenId);
}
function $_setApprovalForAll(address owner,address operator,bool approved) external {
return super._setApprovalForAll(owner,operator,approved);
}
function $_requireMinted(uint256 tokenId) external view {
return super._requireMinted(tokenId);
}
function $_beforeTokenTransfer(address from,address to,uint256 tokenId) external {
return super._beforeTokenTransfer(from,to,tokenId);
}
function $_afterTokenTransfer(address from,address to,uint256 tokenId) external {
return super._afterTokenTransfer(from,to,tokenId);
}
function $__ERC165_init() external {
return super.__ERC165_init();
}
function $__ERC165_init_unchained() external {
return super.__ERC165_init_unchained();
}
function $__Context_init() external {
return super.__Context_init();
}
function $__Context_init_unchained() external {
return super.__Context_init_unchained();
}
function $_msgSender() external view returns (address) {
return super._msgSender();
}
function $_msgData() external view returns (bytes memory) {
return super._msgData();
}
function $_disableInitializers() external {
return super._disableInitializers();
}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../contracts/interfaces/internal/INFTCollectionInitializer.sol";
abstract contract $INFTCollectionInitializer is INFTCollectionInitializer {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/interfaces/standards/royalties/IGetFees.sol";
abstract contract $IGetFees is IGetFees {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/interfaces/standards/royalties/IGetRoyalties.sol";
abstract contract $IGetRoyalties is IGetRoyalties {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/interfaces/standards/royalties/IRoyaltyInfo.sol";
abstract contract $IRoyaltyInfo is IRoyaltyInfo {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../../contracts/interfaces/standards/royalties/ITokenCreator.sol";
abstract contract $ITokenCreator is ITokenCreator {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../contracts/libraries/AddressLibrary.sol";
contract $AddressLibrary {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
event $callAndReturnContractAddress_address_bytes_Returned(address payable arg0);
event $callAndReturnContractAddress_CallWithoutValue_Returned(address payable arg0);
constructor() {}
function $callAndReturnContractAddress(address externalContract,bytes calldata callData) external payable returns (address payable) {
(address payable ret0) = AddressLibrary.callAndReturnContractAddress(externalContract,callData);
emit $callAndReturnContractAddress_address_bytes_Returned(ret0);
return (ret0);
}
function $callAndReturnContractAddress(CallWithoutValue calldata call) external payable returns (address payable) {
(address payable ret0) = AddressLibrary.callAndReturnContractAddress(call);
emit $callAndReturnContractAddress_CallWithoutValue_Returned(ret0);
return (ret0);
}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../contracts/mixins/collections/CollectionRoyalties.sol";
abstract contract $CollectionRoyalties is CollectionRoyalties {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
function $__ERC165_init() external {
return super.__ERC165_init();
}
function $__ERC165_init_unchained() external {
return super.__ERC165_init_unchained();
}
function $_disableInitializers() external {
return super._disableInitializers();
}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../contracts/mixins/collections/SequentialMintCollection.sol";
contract $SequentialMintCollection is SequentialMintCollection {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor() {}
function $_initializeSequentialMintCollection(address payable _creator,uint32 _maxTokenId) external {
return super._initializeSequentialMintCollection(_creator,_maxTokenId);
}
function $_selfDestruct() external {
return super._selfDestruct();
}
function $_updateMaxTokenId(uint32 _maxTokenId) external {
return super._updateMaxTokenId(_maxTokenId);
}
function $_burn(uint256 tokenId) external {
return super._burn(tokenId);
}
function $__ERC721Burnable_init() external {
return super.__ERC721Burnable_init();
}
function $__ERC721Burnable_init_unchained() external {
return super.__ERC721Burnable_init_unchained();
}
function $__ERC721_init(string calldata name_,string calldata symbol_) external {
return super.__ERC721_init(name_,symbol_);
}
function $__ERC721_init_unchained(string calldata name_,string calldata symbol_) external {
return super.__ERC721_init_unchained(name_,symbol_);
}
function $_baseURI() external view returns (string memory) {
return super._baseURI();
}
function $_safeTransfer(address from,address to,uint256 tokenId,bytes calldata data) external {
return super._safeTransfer(from,to,tokenId,data);
}
function $_exists(uint256 tokenId) external view returns (bool) {
return super._exists(tokenId);
}
function $_isApprovedOrOwner(address spender,uint256 tokenId) external view returns (bool) {
return super._isApprovedOrOwner(spender,tokenId);
}
function $_safeMint(address to,uint256 tokenId) external {
return super._safeMint(to,tokenId);
}
function $_safeMint(address to,uint256 tokenId,bytes calldata data) external {
return super._safeMint(to,tokenId,data);
}
function $_mint(address to,uint256 tokenId) external {
return super._mint(to,tokenId);
}
function $_transfer(address from,address to,uint256 tokenId) external {
return super._transfer(from,to,tokenId);
}
function $_approve(address to,uint256 tokenId) external {
return super._approve(to,tokenId);
}
function $_setApprovalForAll(address owner,address operator,bool approved) external {
return super._setApprovalForAll(owner,operator,approved);
}
function $_requireMinted(uint256 tokenId) external view {
return super._requireMinted(tokenId);
}
function $_beforeTokenTransfer(address from,address to,uint256 tokenId) external {
return super._beforeTokenTransfer(from,to,tokenId);
}
function $_afterTokenTransfer(address from,address to,uint256 tokenId) external {
return super._afterTokenTransfer(from,to,tokenId);
}
function $__ERC165_init() external {
return super.__ERC165_init();
}
function $__ERC165_init_unchained() external {
return super.__ERC165_init_unchained();
}
function $__Context_init() external {
return super.__Context_init();
}
function $__Context_init_unchained() external {
return super.__Context_init_unchained();
}
function $_msgSender() external view returns (address) {
return super._msgSender();
}
function $_msgData() external view returns (bytes memory) {
return super._msgData();
}
function $_disableInitializers() external {
return super._disableInitializers();
}
receive() external payable {}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../contracts/mixins/shared/Constants.sol";
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.6.0;
import "../../../contracts/mixins/shared/ContractFactory.sol";
contract $ContractFactory is ContractFactory {
bytes32 public __hh_exposed_bytecode_marker = "hardhat-exposed";
constructor(address _contractFactory) ContractFactory(_contractFactory) {}
receive() external payable {}
}