// 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 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
*
* Furthermore, `isContract` will also return true if the target contract within
* the same transaction is already scheduled for destruction by `SELFDESTRUCT`,
* which only has an effect at the end of a transaction.
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.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 Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
pragma solidity ^0.8.0;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.15;
/**
* @title IERC1644 Controller Token Operation (part of the ERC1400 Security
* Token Standards)
* @author Syndicate Inc.
* @custom:license MIT license. Copyright (c) 2021-present Syndicate Inc.
*
* See https://github.com/ethereum/EIPs/issues/1644. Data and operatorData
* parameters were removed.
*/
interface IERC1644 {
event ControllerRedemption(
address account,
address indexed from,
uint256 value
);
event ControllerTransfer(
address controller,
address indexed from,
address indexed to,
uint256 value
);
/**
* Burns `tokenId` without checking whether the caller owns or is approved
* to spend the token.
*
* Emits a `Transfer` event with `address(0)` as `to` AND a
* `ControllerRedemption` event.
*
* Requirements:
* - The caller must be the token contract owner or the batcher.
* - `isControllable` must be true.
* @param account The account whose token will be burned.
* @param value Amount (ERC20) or token ID (ERC721)
*/
function controllerRedeem(
address account,
uint256 value // amount (ERC20) or tokenId (ERC721))
) external;
/**
* Transfers `tokenId` token from `from` to `to`, without checking whether
* the caller owns or is approved to spend the token.
*
* Emits a `Transfer` event AND a `ControllerRedemption` event.
*
* Requirements:
* - The caller must be the token contract owner or the batcher.
* - `isControllable` must be true.
* @param from The account sending the token.
* @param to The account to receive the token.
* @param value Amount (ERC20) or token ID (ERC721)
*/
function controllerTransfer(
address from,
address to,
uint256 value // amount (ERC20) or tokenId (ERC721)
) external;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165Upgradeable {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 amount) external returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.15;
import {ITokenEnforceable} from "src/contracts/common/ITokenEnforceable.sol";
import {IERC721UpgradeableFork} from "./IERC721UpgradeableFork.sol";
import {IERC1644} from "src/contracts/common/IERC1644.sol";
/**
* @title IERC721CollectiveUnchained
* @author Syndicate Inc.
* @custom:license MIT license. Copyright (c) 2021-present Syndicate Inc.
*
* Interface for only functions defined in `ERC721Collective` (excludes
* inherited and overridden functions)
*/
interface IERC721CollectiveUnchained is IERC1644 {
event RendererUpdated(address indexed implementation);
event RendererLocked();
/**
* Initializes `ERC721Collective`.
*
* Emits an `Initialized` event.
*
* @param name_ Name of token
* @param symbol_ Symbol of token
* @param mintGuard_ Address of mint guard
* @param burnGuard_ Address of burn guard
* @param transferGuard_ Address of transfer guard
* @param renderer_ Address of renderer
*/
function __ERC721Collective_init(
string memory name_,
string memory symbol_,
address mintGuard_,
address burnGuard_,
address transferGuard_,
address renderer_
) external;
/**
* @return Number of currently-existing tokens (tokens that have been
* minted and that have not been burned).
*/
function totalSupply() external view returns (uint256);
// name(), symbol(), and tokenURI() overriding ERC721UpgradeableFork
// declared in IERC721Fork
/**
* @return The address of the token Renderer. The contract at this address
* is assumed to implement the IRenderer interface.
*/
function renderer() external view returns (address);
/**
* @return True iff the Renderer cannot be changed.
*/
function rendererLocked() external view returns (bool);
/**
* Update the address of the token Renderer. The contract at the passed-in
* address is assumed to implement the IRenderer interface.
*
* Emits a `RendererUpdated` event.
*
* Requirements:
* - The caller must be the token contract owner or the batcher.
* - Renderer must not be locked.
* @param implementation Address of new Renderer
*/
function updateRenderer(address implementation) external;
/**
* Irreversibly prevents the token contract owner from changing the token
* Renderer.
*
* Emits a `RendererLocked` event.
*
* Requirements:
* - The caller must be the token contract owner or the batcher.
*/
function lockRenderer() external;
// supportsInterface(bytes4 interfaceId) overriding ERC1644 declared in
// IERC1644
/**
* @return True after successfully executing mint and transfer of
* `nextTokenId` to `account`.
*
* Emits a `Transfer` event with `address(0)` as `from`.
*
* Requirements:
* - `account` cannot be the zero address.
* @param account The account to receive the minted token.
*/
function mintTo(address account) external returns (bool);
/**
* @return True after successfully bulk minting and transferring the
* `nextTokenId` through `nextTokenId + amount` tokens to `account`.
*
* Emits a `Transfer` event (with `address(0)` as `from`) for each token
* that is minted.
*
* Requirements:
* - `account` cannot be the zero address.
* @param account The account to receive the minted tokens.
* @param amount The number of tokens to be minted.
*/
function bulkMintToOneAddress(address account, uint256 amount)
external
returns (bool);
/**
* @return True after successfully bulk minting and transferring one of the
* `nextTokenId` through `nextTokenId + accounts.length` tokens to each of
* the addresses in `accounts`.
*
* Emits a `Transfer` event (with `address(0)` as `from`) for each token
* that is minted.
*
* Requirements:
* - `accounts` cannot have length 0.
* - None of the addresses in `accounts` can be the zero address.
* @param accounts The accounts to receive the minted tokens.
*/
function bulkMintToNAddresses(address[] calldata accounts)
external
returns (bool);
/**
* @return True after successfully burning `tokenId`.
*
* Emits a `Transfer` event with `address(0)` as `to`.
*
* Requirements:
* - The caller must either own or be approved to spend the `tokenId` token.
* - `tokenId` must exist.
* @param tokenId The tokenId to be burned.
*/
function redeem(uint256 tokenId) external returns (bool);
// controllerRedeem() and controllerTransfer() declared in IERC1644
/**
* Sets the default royalty fee percentage for the ERC721.
*
* A custom royalty fee will override the default if set for specific tokenIds.
*
* Requirements:
* - The caller must be the token contract owner.
* - `isControllable` must be true.
* @param receiver The account to receive the royalty.
* @param feeNumerator The fee amount in basis points.
*/
function setDefaultRoyalty(address receiver, uint96 feeNumerator) external;
/**
* Sets a custom royalty fee percentage for the specified `tokenId`.
*
* Requirements:
* - The caller must be the token contract owner.
* - `isControllable` must be true.
* - `tokenId` must exist.
* @param tokenId The tokenId to set a custom royalty for.
* @param receiver The account to receive the royalty.
* @param feeNumerator The fee amount in basis points.
*/
function setTokenRoyalty(
uint256 tokenId,
address receiver,
uint96 feeNumerator
) external;
}
/**
* @title IERC721Collective
* @author Syndicate Inc.
* @custom:license MIT license. Copyright (c) 2021-present Syndicate Inc.
*
* Interface for all functions in ERC721Collective, including inherited and
* overridden functions.
*/
interface IERC721Collective is
ITokenEnforceable,
IERC721UpgradeableFork,
IERC721CollectiveUnchained
{
}
// 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 (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: 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
pragma solidity 0.8.15;
import {IERC721MetadataUpgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC721/extensions/IERC721MetadataUpgradeable.sol";
/**
* @title IERC721UpgradeableFork
* @author Syndicate Inc.
* @custom:license MIT license. Copyright (c) 2021-present Syndicate Inc.
*
* Interface for functions defined in ERC721UpgradeableFork, a fork of
* OpenZeppelin's ERC721Upgradeable with additional tokenId-tracking and
* royalty functionality.
*/
interface IERC721UpgradeableFork is IERC721MetadataUpgradeable {
/**
* @return ID of the first token that will be minted.
*/
// solhint-disable-next-line func-name-mixedcase
function STARTING_TOKEN_ID() external view returns (uint256);
/**
* @return Max consecutive tokenIds of bulk-minted tokens whose owner can
* be stored as address(0). This number is capped to reduce the cost of
* owner lookup.
*/
// solhint-disable-next-line func-name-mixedcase
function OWNER_ID_STAGGER() external view returns (uint256);
/**
* @return ID of the next token that will be minted. Existing tokens are
* limited to IDs between `STARTING_TOKEN_ID` and `_nextTokenId` (including
* `STARTING_TOKEN_ID` and excluding `_nextTokenId`, though not all of these
* IDs may be in use if tokens have been burned).
*/
function nextTokenId() external view returns (uint256);
/**
* @return receiver Address that should receive royalties from sales.
* @return royaltyAmount How much royalty that should be sent to `receiver`,
* denominated in the same unit of exchange as `salePrice`.
* @param tokenId The token being sold.
* @param salePrice The sale price of the token, denominated in any unit of
* exchange. The royalty amount will be denominated and should be paid in
* that same unit of exchange.
*/
function royaltyInfo(uint256 tokenId, uint256 salePrice)
external
view
returns (address receiver, uint256 royaltyAmount);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.15;
/**
* @title IGuard
* @author Syndicate Inc.
* @custom:license MIT license. Copyright (c) 2021-present Syndicate Inc.
*
* Interface for a Guard that governs whether a token can be minted, burned, or
* transferred by a particular operator, from a particular sender (`from` is
* address 0 iff the token is being minted), to a particular recipient (`to` is
* address 0 iff the token is being burned).
*/
interface IGuard {
/**
* @return True iff the transaction is allowed
* @param operator Transaction msg.sender
* @param from Token sender
* @param to Token recipient
* @param value Amount (ERC20) or token ID (ERC721)
*/
function isAllowed(
address operator,
address from,
address to,
uint256 value // amount (ERC20) or tokenId (ERC721)
) external view returns (bool);
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.15;
interface IOwner {
function owner() external view returns (address);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.15;
/**
* @title IRenderer
* @author Syndicate Inc.
* @custom:license MIT license. Copyright (c) 2021-present Syndicate Inc.
*
* Interface for a Renderer that returns the Uniform Resource Identifier (URI)
* of a Collective NFT.
*/
interface IRenderer {
/**
* @return The URI of a particular Collective NFT
* @param collective Address of the Collective
* @param tokenId Token ID to render
* @dev This function is intended for use by the front end, e.g. to render
* a given token from a given Collective.
*/
function tokenURIOf(address collective, uint256 tokenId)
external
view
returns (string memory);
/**
* @return The URI of a particular NFT from the calling Collective
* @param tokenId Token ID to render
* @dev This function is intended for use in ERC721Collective itself:
* `msg.sender` is assumed to be the Collective. This allows external
* contracts to access the URI of any of the Collective NFTs.
*/
function tokenURI(uint256 tokenId) external view returns (string memory);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.15;
import {ITokenRecoverable} from "./ITokenRecoverable.sol";
import {IGuard} from "src/contracts/guards/IGuard.sol";
/**
* @title ITokenEnforceable
* @author Syndicate Inc.
* @custom:license MIT license. Copyright (c) 2021-present Syndicate Inc.
*
* Interface for tokens with modular conditions on mint, burn, and transfer
* functions enforced by Guard contracts, such as `ERC20Club` and
* `ERC721Collective`.
*/
interface ITokenEnforceable is ITokenRecoverable {
event ControlDisabled(address indexed controller);
event BatcherUpdated(address batcher);
event GuardUpdated(GuardType indexed guard, address indexed implementation);
event GuardLocked(
bool mintGuardLocked,
bool burnGuardLocked,
bool transferGuardLocked
);
/**
* @return The address of the transaction batcher used to batch calls over
* onlyOwner functions.
*/
function batcher() external view returns (address);
/**
* @return True iff the token contract owner is allowed to mint, burn, or
* transfer on behalf of arbitrary addresses.
*/
function isControllable() external view returns (bool);
/**
* @return The address of the Guard used to determine whether a mint is
* allowed. The contract at this address is assumed to implement the IGuard
* interface.
*/
function mintGuard() external view returns (IGuard);
/**
* @return The address of the Guard used to determine whether a burn is
* allowed. The contract at this address is assumed to implement the IGuard
* interface.
*/
function burnGuard() external view returns (IGuard);
/**
* @return The address of the Guard used to determine whether a transfer is
* allowed. The contract at this address is assumed to implement the IGuard
* interface.
*/
function transferGuard() external view returns (IGuard);
/**
* @return True iff the mint Guard cannot be changed.
*/
function mintGuardLocked() external view returns (bool);
/**
* @return True iff the burn Guard cannot be changed.
*/
function burnGuardLocked() external view returns (bool);
/**
* @return True iff the transfer Guard cannot be changed.
*/
function transferGuardLocked() external view returns (bool);
/**
* Irreversibly disables the token contract owner from minting, burning,
* and transferring on behalf of arbitrary addresses.
*
* Emits a `ControlDisabled` event.
*
* Requirements:
* - The caller must be the token contract owner or the batcher.
*/
function disableControl() external;
/**
* Irreversibly prevents the token contract owner from changing the mint,
* burn, and/or transfer Guards.
*
* If at least one guard was requested to be locked, emits a `GuardLocked`
* event confirming whether each Guard is locked.
*
* Requirements:
* - The caller must be the token contract owner or the batcher.
* @param mintGuardLock If true, the mint Guard will be locked. If false,
* does nothing to the mint Guard.
* @param burnGuardLock If true, the mint Guard will be locked. If false,
* does nothing to the burn Guard.
* @param transferGuardLock If true, the mint Guard will be locked. If
* false, does nothing to the transfer Guard.
*/
function lockGuards(
bool mintGuardLock,
bool burnGuardLock,
bool transferGuardLock
) external;
/**
* Update the address of the batcher for batching calls over
* onlyOwner functions.
*
* Emits a `BatcherUpdated` event.
*
* Requirements:
* - The caller must be the token contract owner or the batcher.
* @param implementation Address of new batcher
*/
function updateBatcher(address implementation) external;
/**
* Update the address of the Guard for minting. The contract at the
* passed-in address is assumed to implement the IGuard interface.
*
* Emits a `GuardUpdated` event with `GuardType.Mint`.
*
* Requirements:
* - The caller must be the token contract owner or the batcher.
* - The mint Guard must not be locked.
* @param implementation Address of new mint Guard
*/
function updateMintGuard(address implementation) external;
/**
* Update the address of the Guard for burning. The contract at the
* passed-in address is assumed to implement the IGuard interface.
*
* Emits a `GuardUpdated` event with `GuardType.Burn`.
*
* Requirements:
* - The caller must be the token contract owner or the batcher.
* - The burn Guard must not be locked.
* @param implementation Address of new burn Guard
*/
function updateBurnGuard(address implementation) external;
/**
* Update the address of the Guard for transferring. The contract at the
* passed-in address is assumed to implement the IGuard interface.
*
* Emits a `GuardUpdated` event with `GuardType.Transfer`.
*
* Requirements:
* - The caller must be the token contract owner or the batcher.
* - The transfer Guard must not be locked.
* @param implementation Address of transfer Guard
*/
function updateTransferGuard(address implementation) external;
/**
* @return True iff a token can be minted, burned, or transferred by a
* particular operator, from a particular sender (`from` is address 0 iff
* the token is being minted), to a particular recipient (`to` is address 0
* iff the token is being burned).
* @param operator Transaction msg.sender
* @param from Token sender
* @param to Token recipient
* @param value Amount (ERC20) or token ID (ERC721)
*/
function isAllowed(
address operator,
address from,
address to,
uint256 value // amount (ERC20) or tokenId (ERC721)
) external view returns (bool);
/**
* @return owner The address of the token contract owner
*/
function owner() external view returns (address);
/**
* Transfers ownership of the contract to a new account (`newOwner`)
*
* Emits an `OwnershipTransferred` event.
*
* Requirements:
* - The caller must be the current owner.
* @param newOwner Address that will become the owner
*/
function transferOwnership(address newOwner) external;
/**
* Leaves the contract without an owner. After calling this function, it
* will no longer be possible to call `onlyOwner` functions.
*
* Requirements:
* - The caller must be the current owner.
*/
function renounceOwnership() external;
}
enum GuardType {
Mint,
Burn,
Transfer
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.15;
/**
* @title ITokenRecoverable
* @author Syndicate Inc.
* @custom:license MIT license. Copyright (c) 2021-present Syndicate Inc.
*
* Interface for a token recovery utility allowing ERC20 and ERC721 tokens
* erroneously sent to the contract to be returned.
*/
interface ITokenRecoverable {
// Events for token recovery (ERC20) and (ERC721)
event TokenRecoveredERC20(
address indexed recipient,
address indexed erc20,
uint256 amount
);
event TokenRecoveredERC721(
address indexed recipient,
address indexed erc721,
uint256 tokenId
);
/**
* Transfers ERC20 tokens erroneously sent to the contract.
*
* Emits a `TokenRecoveredERC20` event.
*
* Requirements:
* - The caller must be the admin.
* - `recipient` cannot be the zero address.
* - This contract must have a balance in `erc20` of at least `amount`.
* @param recipient Address that erroneously sent the ERC20 token(s)
* @param erc20 Erroneously-sent ERC20 token to recover
* @param amount Amount to recover
*/
function recoverERC20(
address recipient,
address erc20,
uint256 amount
) external;
/**
* Transfers ERC721 tokens erroneously sent to the contract.
*
* Emits a `TokenRecoveredERC721` event.
*
* Requirements:
* - The caller must be the admin.
* - `recipient` cannot be the zero address.
* - `tokenId` must exist in `erc721`.
* - `tokenId` in `erc721` must be owned by this contract.
* @param recipient Address that erroneously sent the ERC721 token
* @param erc721 Erroneously-sent ERC721 token to recover
* @param tokenId The tokenId to recover
*/
function recoverERC721(
address recipient,
address erc721,
uint256 tokenId
) external;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/math/Math.sol)
pragma solidity ^0.8.0;
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
enum Rounding {
Down, // Toward negative infinity
Up, // Toward infinity
Zero // Toward zero
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds up instead
* of rounding down.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b - 1) / b can overflow on addition, so we distribute.
return a == 0 ? 0 : (a - 1) / b + 1;
}
/**
* @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
* @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv)
* with further edits by Uniswap Labs also under MIT license.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
// 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
// use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = prod1 * 2^256 + prod0.
uint256 prod0; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(x, y, not(0))
prod0 := mul(x, y)
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Handle non-overflow cases, 256 by 256 division.
if (prod1 == 0) {
return prod0 / denominator;
}
// Make sure the result is less than 2^256. Also prevents denominator == 0.
require(denominator > prod1, "Math: mulDiv overflow");
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0].
uint256 remainder;
assembly {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1.
// See https://cs.stackexchange.com/q/138556/92363.
// Does not overflow because the denominator cannot be zero at this stage in the function.
uint256 twos = denominator & (~denominator + 1);
assembly {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [prod1 prod0] by twos.
prod0 := div(prod0, twos)
// Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from prod1 into prod0.
prod0 |= prod1 * twos;
// Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
// that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv = 1 mod 2^4.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works
// in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2^8
inverse *= 2 - denominator * inverse; // inverse mod 2^16
inverse *= 2 - denominator * inverse; // inverse mod 2^32
inverse *= 2 - denominator * inverse; // inverse mod 2^64
inverse *= 2 - denominator * inverse; // inverse mod 2^128
inverse *= 2 - denominator * inverse; // inverse mod 2^256
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
// less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
// is no longer required.
result = prod0 * inverse;
return result;
}
}
/**
* @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
uint256 result = mulDiv(x, y, denominator);
if (rounding == Rounding.Up && mulmod(x, y, denominator) > 0) {
result += 1;
}
return result;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded down.
*
* Inspired by Henry S. Warren, Jr.'s "Hacker's Delight" (Chapter 11).
*/
function sqrt(uint256 a) internal pure returns (uint256) {
if (a == 0) {
return 0;
}
// For our first guess, we get the biggest power of 2 which is smaller than the square root of the target.
//
// We know that the "msb" (most significant bit) of our target number `a` is a power of 2 such that we have
// `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`.
//
// This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)`
// → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))`
// → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)`
//
// Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit.
uint256 result = 1 << (log2(a) >> 1);
// At this point `result` is an estimation with one bit of precision. We know the true value is a uint128,
// since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at
// every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision
// into the expected uint128 result.
unchecked {
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
return min(result, a / result);
}
}
/**
* @notice Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + (rounding == Rounding.Up && result * result < a ? 1 : 0);
}
}
/**
* @dev Return the log in base 2, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 128;
}
if (value >> 64 > 0) {
value >>= 64;
result += 64;
}
if (value >> 32 > 0) {
value >>= 32;
result += 32;
}
if (value >> 16 > 0) {
value >>= 16;
result += 16;
}
if (value >> 8 > 0) {
value >>= 8;
result += 8;
}
if (value >> 4 > 0) {
value >>= 4;
result += 4;
}
if (value >> 2 > 0) {
value >>= 2;
result += 2;
}
if (value >> 1 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + (rounding == Rounding.Up && 1 << result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 10, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10 ** 64) {
value /= 10 ** 64;
result += 64;
}
if (value >= 10 ** 32) {
value /= 10 ** 32;
result += 32;
}
if (value >= 10 ** 16) {
value /= 10 ** 16;
result += 16;
}
if (value >= 10 ** 8) {
value /= 10 ** 8;
result += 8;
}
if (value >= 10 ** 4) {
value /= 10 ** 4;
result += 4;
}
if (value >= 10 ** 2) {
value /= 10 ** 2;
result += 2;
}
if (value >= 10 ** 1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + (rounding == Rounding.Up && 10 ** result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 256, rounded down, of a positive value.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 16;
}
if (value >> 64 > 0) {
value >>= 64;
result += 8;
}
if (value >> 32 > 0) {
value >>= 32;
result += 4;
}
if (value >> 16 > 0) {
value >>= 16;
result += 2;
}
if (value >> 8 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + (rounding == Rounding.Up && 1 << (result << 3) < value ? 1 : 0);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol)
pragma solidity ^0.8.0;
import "../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
require(newOwner != address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
/**
* @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 ReentrancyGuard {
// 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;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _status == _ENTERED;
}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.15;
import {RugUtilityProperties} from "./RugUtilityProperties.sol";
import {ReentrancyGuard} from "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
import {IERC721Collective} from "src/contracts/ERC721Collective/IERC721Collective.sol";
import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {TokenOwnerChecker} from "src/contracts/utils/TokenOwnerChecker.sol";
/// This mint module allows for 1 or more "mint passes" or required token, which can be marked as used
/// Requirements can be found at: https://twitter.com/farokh/status/1601627199446319104
/// Based on RequiredTokensMintModule
contract RugPFPMintModule is ReentrancyGuard, TokenOwnerChecker {
// Price per NFT (can be 0)
uint256 public constant RUG_PFP_PRICE = 690 * 10**18;
// solhint-disable-next-line var-name-mixedcase
address public immutable RUG_PFP_ADDRESS;
address public constant RUG_TOKEN_ADDRESS =
0xD2d8D78087D0E43BC4804B6F946674b2Ee406b80;
address public constant GENESIS_NFT_ADDRESS =
0x8ff1523091c9517BC328223D50b52Ef450200339;
address public constant GENESIS_RENDERER_ADDRESS =
0x1aCc3a26FCB9751D5E3b698D009b9C944eb98F9e;
IERC20 public constant RUG_TOKEN = IERC20(RUG_TOKEN_ADDRESS);
// solhint-disable-next-line var-name-mixedcase
IERC721Collective public immutable RUG_PFP;
IERC721Collective public constant GENESIS_NFT =
IERC721Collective(GENESIS_NFT_ADDRESS);
RugUtilityProperties public constant GENESIS_RENDERER =
RugUtilityProperties(GENESIS_RENDERER_ADDRESS);
// Genesis token ID => tokens redeemed
mapping(uint256 => uint256) public pfpsRedeemedPerGenesisNFT;
event Redeemed(
address indexed collective,
address indexed account,
uint256 indexed tokenId
);
// solhint-disable-next-line var-name-mixedcase
constructor(address RUG_PFP_ADDRESS_) {
RUG_PFP_ADDRESS = RUG_PFP_ADDRESS_;
RUG_PFP = IERC721Collective(RUG_PFP_ADDRESS);
}
function redeem(uint256 tokenId, uint256 amountToMint) public payable {
// Follows the Checks-Effects-Interactions pattern
// Checks and Effect
_redeemCommon(tokenId, amountToMint);
// Interactions
// Mint PFPs
RUG_PFP.bulkMintToOneAddress(msg.sender, amountToMint);
// Transfer the required token to the contract
SafeERC20.safeTransferFrom(
RUG_TOKEN,
msg.sender,
RUG_PFP.owner(),
amountToMint * RUG_PFP_PRICE
);
}
function redeemMany(
uint256[] calldata tokenIds,
uint256[] calldata amountsToMint
) public payable {
require(
tokenIds.length == amountsToMint.length,
"Arrays must be same length"
);
uint256 length = tokenIds.length;
uint256 totalToMint;
for (uint256 i = 0; i < length; ) {
// Checks and Effects
_redeemCommon(tokenIds[i], amountsToMint[i]);
totalToMint += amountsToMint[i];
unchecked {
++i;
}
}
// Interactions
// Mint PFPs
RUG_PFP.bulkMintToOneAddress(msg.sender, totalToMint);
// Transfer the required token to the contract
SafeERC20.safeTransferFrom(
RUG_TOKEN,
msg.sender,
RUG_PFP.owner(),
totalToMint * RUG_PFP_PRICE
);
}
function getMintsPerNFT(uint256 tokenId) public view returns (uint256) {
uint256 tokenIdRole = GENESIS_RENDERER.getRole(tokenId);
// Order from least scarce to most for the most gas savings
if (tokenIdRole == 2 || tokenIdRole == 3 || tokenIdRole == 4) {
// Scarce 1, Scarce 2, and Standard have 1 mint per NFT
return 1;
} else if (tokenIdRole == 1) {
// Rare 2 has 2 mints per NFT
return 2;
} else if (tokenIdRole == 0) {
// Rare 1 has 5 mints per NFT
return 5;
} else {
return 0;
}
}
function getMintsRemainingPerNFT(uint256 tokenId)
public
view
returns (uint256)
{
uint256 mintsPerNFT = getMintsPerNFT(tokenId);
// Return mints remaining. If a user tries to mint more than their mints
// remaining, this will revert to avoid overflow
return mintsPerNFT - pfpsRedeemedPerGenesisNFT[tokenId];
}
function getMintsRemainingPerNFTs(uint256[] calldata tokenIds)
public
view
returns (uint256[] memory)
{
uint256[] memory mintsRemaining = new uint256[](tokenIds.length);
for (uint256 i = 0; i < tokenIds.length; ) {
mintsRemaining[i] = getMintsRemainingPerNFT(tokenIds[i]);
unchecked {
++i;
}
}
return mintsRemaining;
}
function _redeemCommon(uint256 tokenId, uint256 amountToMint) internal {
// Common checks
require(
getMintsRemainingPerNFT(tokenId) >= amountToMint,
"RugPFPMintModule: Remaining mints exceeded"
);
require(
msg.sender == GENESIS_NFT.ownerOf(tokenId),
"RugPFPMintModule: Must be owner of tokenId attempting to redeem"
);
// Common effects
// Mark token as redeemed
pfpsRedeemedPerGenesisNFT[tokenId] += amountToMint;
// Emit Event per tokenId
emit Redeemed(RUG_PFP_ADDRESS, msg.sender, tokenId);
}
/// This function is called for all messages sent to this contract (there
/// are no other functions). Sending Ether to this contract will cause an
/// exception, because the fallback function does not have the `payable`
/// modifier.
/// Source: https://docs.soliditylang.org/en/v0.8.9/contracts.html?highlight=fallback#fallback-function
fallback() external {
revert("RugPFPMintModule: non-existent function");
}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.15;
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
import {IRenderer} from "src/contracts/ERC721Collective/renderer/IRenderer.sol";
/// Custom contract for RugRadio utility NFTsproperties
contract RugUtilityProperties is Ownable, IRenderer {
using Strings for uint256;
uint256 public seed;
string public baseURI; // https://pinata.cloud/<location>/
// tokenId => custom combination ID
mapping(uint256 => uint256) public oneOfOneCombination;
// tokenId => custom token production
mapping(uint256 => uint256) public oneOfOneProduction;
event SeedGenerated(string phrase, uint256 seed);
event UpdateBaseURI(string baseURI);
event UpdateCombination(
uint256 indexed tokenId,
uint256 indexed combinationId
);
event UpdateProduction(uint256 indexed tokenId, uint256 indexed production);
modifier onlyAfterReveal() {
require(
seed > 0 && bytes(baseURI).length > 0,
"RugUtilityProperties: Reveal not released yet"
);
_;
}
function generateSeed(string memory phrase) external onlyOwner {
require(seed == 0, "RugUtilityProperties: Seed already set");
seed = uint256(keccak256(abi.encode(phrase)));
emit SeedGenerated(phrase, seed);
}
function updateBaseURI(string memory uri) external onlyOwner {
baseURI = uri;
emit UpdateBaseURI(baseURI);
}
function updateOneOfOneCombination(uint256 tokenId, uint256 combination)
external
onlyOwner
{
// max combination Id = 4 * 100 + 16 = 416 -> use 500 for clean separation
// additionally let people set to 0 in case an error occured and need a reset
require(
combination >= 500 || combination == 0,
"RugUtilityProperties: One-of-One combination ID invalid"
);
oneOfOneCombination[tokenId] = combination;
emit UpdateCombination(tokenId, combination);
}
function updateOneOfOneProduction(uint256 tokenId, uint256 production)
external
onlyOwner
{
oneOfOneProduction[tokenId] = production;
emit UpdateProduction(tokenId, production);
}
function tokenURI(uint256 tokenId) public view returns (string memory) {
if (seed == 0) {
// fixed URL for utility NFT pre-reveal, allows us to switch renderer before reveal easily
return "ipfs://QmPLizWkV3zmDybjXZnr7AALNLjab67QsmfrzHC8bhUm4S";
}
return
string(
abi.encodePacked(
baseURI,
getCombinationId(tokenId).toString(),
".json"
)
);
}
function tokenURIOf(address, uint256 tokenId)
external
view
returns (string memory)
{
return tokenURI(tokenId);
}
function getSlot(uint256 tokenId)
internal
view
onlyAfterReveal
returns (uint256)
{
// randomly distributee tokenId's across slots by re-hashing with seed
uint256 slotSeed = uint256(keccak256(abi.encode(seed, tokenId)));
return slotSeed % 19989;
}
function getCombinationId(uint256 tokenId) internal view returns (uint256) {
if (oneOfOneCombination[tokenId] == 0) {
return uint256(getRole(tokenId)) * 100 + getMeme(tokenId);
} else {
return oneOfOneCombination[tokenId];
}
}
function getRole(uint256 tokenId) public view returns (uint8) {
if (oneOfOneCombination[tokenId] == 0) {
uint256 slot = getSlot(tokenId);
if (slot < 112) {
// 7 * 16 rows = 112 "Rare 2" roles
return 1;
} else if (slot < 112 + 1104) {
// 69 * 16 rows = 1104 "Scarce 1" roles
return 2;
} else if (slot < 112 + 1104 + 7648) {
// 478 * 16 rows = 7648 "Scarce 2" roles
return 3;
} else {
// rest of roles are "Standard"
return 4;
}
} else {
// custom additions of "Rare 1" roles
return 0;
}
}
function getMeme(uint256 tokenId) public view returns (uint8) {
if (oneOfOneCombination[tokenId] == 0) {
// all rows share uniform distribution of different meme values
return uint8((getSlot(tokenId) % 16) + 1);
} else {
// "One-of-One" for special tokens with override
return 0;
}
}
function getProduction(uint256 tokenId) external view returns (uint256) {
if (oneOfOneProduction[tokenId] > 0) {
// "Rare 1" roles with additional custom production rate
return oneOfOneProduction[tokenId];
}
uint8 role = getRole(tokenId);
if (role <= 1) {
// "Rare X" roles
return 11;
} else if (role <= 3) {
// "Scarce X" roles
return 7;
} else {
// "Standard" roles
return 5;
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "../IERC20.sol";
import "../extensions/IERC20Permit.sol";
import "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using Address for address;
function safeTransfer(IERC20 token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/
function safeApprove(IERC20 token, address spender, uint256 value) internal {
// safeApprove should only be called when setting an initial allowance,
// or when resetting it to zero. To increase and decrease it, use
// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
require(
(value == 0) || (token.allowance(address(this), spender) == 0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 newAllowance = token.allowance(address(this), spender) + value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
function safeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
uint256 newAllowance = oldAllowance - value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
}
function safePermit(
IERC20Permit token,
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal {
uint256 nonceBefore = token.nonces(owner);
token.permit(owner, spender, value, deadline, v, r, s);
uint256 nonceAfter = token.nonces(owner);
require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
if (returndata.length > 0) {
// Return data is optional
require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/math/SignedMath.sol)
pragma solidity ^0.8.0;
/**
* @dev Standard signed math utilities missing in the Solidity language.
*/
library SignedMath {
/**
* @dev Returns the largest of two signed numbers.
*/
function max(int256 a, int256 b) internal pure returns (int256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two signed numbers.
*/
function min(int256 a, int256 b) internal pure returns (int256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two signed numbers without overflow.
* The result is rounded towards zero.
*/
function average(int256 a, int256 b) internal pure returns (int256) {
// Formula from the book "Hacker's Delight"
int256 x = (a & b) + ((a ^ b) >> 1);
return x + (int256(uint256(x) >> 255) & (a ^ b));
}
/**
* @dev Returns the absolute unsigned value of a signed value.
*/
function abs(int256 n) internal pure returns (uint256) {
unchecked {
// must be unchecked in order to support `n = type(int256).min`
return uint256(n >= 0 ? n : -n);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/Strings.sol)
pragma solidity ^0.8.0;
import "./math/Math.sol";
import "./math/SignedMath.sol";
/**
* @dev String operations.
*/
library Strings {
bytes16 private constant _SYMBOLS = "0123456789abcdef";
uint8 private constant _ADDRESS_LENGTH = 20;
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
unchecked {
uint256 length = Math.log10(value) + 1;
string memory buffer = new string(length);
uint256 ptr;
/// @solidity memory-safe-assembly
assembly {
ptr := add(buffer, add(32, length))
}
while (true) {
ptr--;
/// @solidity memory-safe-assembly
assembly {
mstore8(ptr, byte(mod(value, 10), _SYMBOLS))
}
value /= 10;
if (value == 0) break;
}
return buffer;
}
}
/**
* @dev Converts a `int256` to its ASCII `string` decimal representation.
*/
function toString(int256 value) internal pure returns (string memory) {
return string(abi.encodePacked(value < 0 ? "-" : "", toString(SignedMath.abs(value))));
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
unchecked {
return toHexString(value, Math.log256(value) + 1);
}
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = _SYMBOLS[value & 0xf];
value >>= 4;
}
require(value == 0, "Strings: hex length insufficient");
return string(buffer);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation.
*/
function toHexString(address addr) internal pure returns (string memory) {
return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH);
}
/**
* @dev Returns true if the two strings are equal.
*/
function equal(string memory a, string memory b) internal pure returns (bool) {
return keccak256(bytes(a)) == keccak256(bytes(b));
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.15;
import {IOwner} from "./IOwner.sol";
/**
* @title TokenOwnerChecker
* @author Syndicate Inc.
* @custom:license MIT license. Copyright (c) 2021-present Syndicate Inc.
*
* Utility for use by any Module or Guard that needs to check if an address is
* the owner of the TokenEnforceable (ERC20Club or ERC721Collective)
*/
abstract contract TokenOwnerChecker {
/**
* Only proceed if msg.sender owns TokenEnforceable contract
* @param token TokenEnforceable whose owner to check
*/
modifier onlyTokenOwner(address token) {
_onlyTokenOwner(token);
_;
}
function _onlyTokenOwner(address token) internal view {
require(
msg.sender == IOwner(token).owner(),
"TokenOwnerChecker: Caller not token owner"
);
}
}
{
"compilationTarget": {
"src/contracts/custom/RugPFPMintModule.sol": "RugPFPMintModule"
},
"evmVersion": "london",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 200
},
"remappings": [
":@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/",
":@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/",
":ds-test/=lib/ds-test/src/",
":erc4626-tests/=lib/openzeppelin-contracts/lib/erc4626-tests/",
":forge-std/=lib/forge-std/src/",
":openzeppelin-contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/",
":openzeppelin-contracts/=lib/openzeppelin-contracts/"
]
}
[{"inputs":[{"internalType":"address","name":"RUG_PFP_ADDRESS_","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"collective","type":"address"},{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":true,"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"Redeemed","type":"event"},{"stateMutability":"nonpayable","type":"fallback"},{"inputs":[],"name":"GENESIS_NFT","outputs":[{"internalType":"contract IERC721Collective","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"GENESIS_NFT_ADDRESS","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"GENESIS_RENDERER","outputs":[{"internalType":"contract RugUtilityProperties","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"GENESIS_RENDERER_ADDRESS","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"RUG_PFP","outputs":[{"internalType":"contract IERC721Collective","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"RUG_PFP_ADDRESS","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"RUG_PFP_PRICE","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"RUG_TOKEN","outputs":[{"internalType":"contract IERC20","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"RUG_TOKEN_ADDRESS","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"getMintsPerNFT","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"getMintsRemainingPerNFT","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"tokenIds","type":"uint256[]"}],"name":"getMintsRemainingPerNFTs","outputs":[{"internalType":"uint256[]","name":"","type":"uint256[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"pfpsRedeemedPerGenesisNFT","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"uint256","name":"amountToMint","type":"uint256"}],"name":"redeem","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"tokenIds","type":"uint256[]"},{"internalType":"uint256[]","name":"amountsToMint","type":"uint256[]"}],"name":"redeemMany","outputs":[],"stateMutability":"payable","type":"function"}]