Contract Name:
MinterMerkleV2
Contract Source Code:
// SPDX-License-Identifier: LGPL-3.0-only
// Created By: Art Blocks Inc.
import "../../../interfaces/0.8.x/IGenArt721CoreContractV3.sol";
import "../../../interfaces/0.8.x/IMinterFilterV0.sol";
import "../../../interfaces/0.8.x/IFilteredMinterMerkleV0.sol";
import "../../../interfaces/0.8.x/IDelegationRegistry.sol";
import "@openzeppelin-4.7/contracts/utils/cryptography/MerkleProof.sol";
import "@openzeppelin-4.7/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin-4.7/contracts/security/ReentrancyGuard.sol";
pragma solidity 0.8.17;
/**
* @title Filtered Minter contract that allows tokens to be minted with ETH
* for addresses in a Merkle allowlist.
* This is designed to be used with IGenArt721CoreContractV3 contracts.
* @author Art Blocks Inc.
* @notice Privileged Roles and Ownership:
* This contract is designed to be managed, with limited powers.
* Privileged roles and abilities are controlled by the project's artist, which
* can be modified by the core contract's Admin ACL contract. Both of these
* roles hold extensive power and can modify minter details.
* Care must be taken to ensure that the admin ACL contract and artist
* addresses are secure behind a multi-sig or other access control mechanism.
* ----------------------------------------------------------------------------
* The following functions are restricted to a project's artist:
* - updateMerkleRoot
* - updatePricePerTokenInWei
* - setProjectInvocationsPerAddress
* ----------------------------------------------------------------------------
* Additional admin and artist privileged roles may be described on other
* contracts that this minter integrates with.
* ----------------------------------------------------------------------------
* This contract allows vaults to configure token-level or wallet-level
* delegation of minting privileges. This allows a vault on an allowlist to
* delegate minting privileges to a wallet that is not on the allowlist,
* enabling the vault to remain air-gapped while still allowing minting. The
* delegation registry contract is responsible for managing these delegations,
* and is available at the address returned by the public constant
* `DELEGATION_REGISTRY_ADDRESS`. At the time of writing, the delegation
* registry enables easy delegation configuring at https://delegate.cash/.
* Art Blocks does not guarentee the security of the delegation registry, and
* users should take care to ensure that the delegation registry is secure.
* Token-level delegations are configured by the vault owner, and contract-
* level delegations must be configured for the core token contract as returned
* by the public immutable variable `genArt721CoreAddress`.
*/
contract MinterMerkleV2 is ReentrancyGuard, IFilteredMinterMerkleV0 {
using MerkleProof for bytes32[];
/// Delegation registry address
address public constant DELEGATION_REGISTRY_ADDRESS =
0x00000000000076A84feF008CDAbe6409d2FE638B;
/// Delegation registry address
IDelegationRegistry private immutable delegationRegistryContract;
/// Core contract address this minter interacts with
address public immutable genArt721CoreAddress;
/// This contract handles cores with interface IV3
IGenArt721CoreContractV3 private immutable genArtCoreContract;
/// Minter filter address this minter interacts with
address public immutable minterFilterAddress;
/// Minter filter this minter may interact with.
IMinterFilterV0 private immutable minterFilter;
/// minterType for this minter
string public constant minterType = "MinterMerkleV2";
/// project minter configuration keys used by this minter
bytes32 private constant CONFIG_MERKLE_ROOT = "merkleRoot";
bytes32 private constant CONFIG_USE_MAX_INVOCATIONS_PER_ADDRESS_OVERRIDE =
"useMaxMintsPerAddrOverride"; // shortened to fit in 32 bytes
bytes32 private constant CONFIG_MAX_INVOCATIONS_OVERRIDE =
"maxMintsPerAddrOverride"; // shortened to match format of previous key
uint256 constant ONE_MILLION = 1_000_000;
uint256 public constant DEFAULT_MAX_INVOCATIONS_PER_ADDRESS = 1;
struct ProjectConfig {
bool maxHasBeenInvoked;
bool priceIsConfigured;
// initial value is false, so by default, projects limit allowlisted
// addresses to a mint qty of `DEFAULT_MAX_INVOCATIONS_PER_ADDRESS`
bool useMaxInvocationsPerAddressOverride;
// a value of 0 means no limit
// (only used if `useMaxInvocationsPerAddressOverride` is true)
uint24 maxInvocationsPerAddressOverride;
uint24 maxInvocations;
uint256 pricePerTokenInWei;
}
mapping(uint256 => ProjectConfig) public projectConfig;
/// projectId => merkle root
mapping(uint256 => bytes32) public projectMerkleRoot;
/// projectId => purchaser address => qty of mints purchased for project
mapping(uint256 => mapping(address => uint256))
public projectUserMintInvocations;
modifier onlyArtist(uint256 _projectId) {
require(
msg.sender ==
genArtCoreContract.projectIdToArtistAddress(_projectId),
"Only Artist"
);
_;
}
/**
* @notice Initializes contract to be a Filtered Minter for
* `_minterFilter`, integrated with Art Blocks core contract
* at address `_genArt721Address`.
* @param _genArt721Address Art Blocks core contract address for
* which this contract will be a minter.
* @param _minterFilter Minter filter for which this will be a
* filtered minter.
*/
constructor(address _genArt721Address, address _minterFilter)
ReentrancyGuard()
{
genArt721CoreAddress = _genArt721Address;
genArtCoreContract = IGenArt721CoreContractV3(_genArt721Address);
delegationRegistryContract = IDelegationRegistry(
DELEGATION_REGISTRY_ADDRESS
);
minterFilterAddress = _minterFilter;
minterFilter = IMinterFilterV0(_minterFilter);
require(
minterFilter.genArt721CoreAddress() == _genArt721Address,
"Illegal contract pairing"
);
// broadcast default max invocations per address for this minter
emit DefaultMaxInvocationsPerAddress(
DEFAULT_MAX_INVOCATIONS_PER_ADDRESS
);
}
/**
* @notice Update the Merkle root for project `_projectId`.
* @param _projectId Project ID to be updated.
* @param _root root of Merkle tree defining addresses allowed to mint
* on project `_projectId`.
*/
function updateMerkleRoot(uint256 _projectId, bytes32 _root)
external
onlyArtist(_projectId)
{
require(_root != bytes32(0), "Root must be provided");
projectMerkleRoot[_projectId] = _root;
emit ConfigValueSet(_projectId, CONFIG_MERKLE_ROOT, _root);
}
/**
* @notice Returns hashed address (to be used as merkle tree leaf).
* Included as a public function to enable users to calculate their hashed
* address in Solidity when generating proofs off-chain.
* @param _address address to be hashed
* @return bytes32 hashed address, via keccak256 (using encodePacked)
*/
function hashAddress(address _address) public pure returns (bytes32) {
return keccak256(abi.encodePacked(_address));
}
/**
* @notice Verify if address is allowed to mint on project `_projectId`.
* @param _projectId Project ID to be checked.
* @param _proof Merkle proof for address.
* @param _address Address to check.
* @return inAllowlist true only if address is allowed to mint and valid
* Merkle proof was provided
*/
function verifyAddress(
uint256 _projectId,
bytes32[] calldata _proof,
address _address
) public view returns (bool) {
return
_proof.verifyCalldata(
projectMerkleRoot[_projectId],
hashAddress(_address)
);
}
/**
* @notice Sets maximum allowed invocations per allowlisted address for
* project `_project` to `limit`. If `limit` is set to 0, allowlisted
* addresses will be able to mint as many times as desired, until the
* project reaches its maximum invocations.
* Default is a value of 1 if never configured by artist.
* @param _projectId Project ID to toggle the mint limit.
* @param _maxInvocationsPerAddress Maximum allowed invocations per
* allowlisted address.
* @dev default value stated above must be updated if the value of
* CONFIG_USE_MAX_INVOCATIONS_PER_ADDRESS_OVERRIDE is changed.
*/
function setProjectInvocationsPerAddress(
uint256 _projectId,
uint24 _maxInvocationsPerAddress
) external onlyArtist(_projectId) {
ProjectConfig storage _projectConfig = projectConfig[_projectId];
// use override value instead of the contract's default
// @dev this never changes from true to false; default value is only
// used if artist has never configured project invocations per address
_projectConfig.useMaxInvocationsPerAddressOverride = true;
// update the override value
_projectConfig
.maxInvocationsPerAddressOverride = _maxInvocationsPerAddress;
// generic events
emit ConfigValueSet(
_projectId,
CONFIG_USE_MAX_INVOCATIONS_PER_ADDRESS_OVERRIDE,
true
);
emit ConfigValueSet(
_projectId,
CONFIG_MAX_INVOCATIONS_OVERRIDE,
uint256(_maxInvocationsPerAddress)
);
}
/**
* @notice Syncs local maximum invocations of project `_projectId` based on
* the value currently defined in the core contract. Only used for gas
* optimization of mints after maxInvocations has been reached.
* @param _projectId Project ID to set the maximum invocations for.
* @dev this enables gas reduction after maxInvocations have been reached -
* core contracts shall still enforce a maxInvocation check during mint.
* @dev function is intentionally not gated to any specific access control;
* it only syncs a local state variable to the core contract's state.
*/
function setProjectMaxInvocations(uint256 _projectId) external {
uint256 maxInvocations;
(, maxInvocations, , , , ) = genArtCoreContract.projectStateData(
_projectId
);
// update storage with results
projectConfig[_projectId].maxInvocations = uint24(maxInvocations);
}
/**
* @notice Warning: Disabling purchaseTo is not supported on this minter.
* This method exists purely for interface-conformance purposes.
*/
function togglePurchaseToDisabled(uint256 _projectId)
external
view
onlyArtist(_projectId)
{
revert("Action not supported");
}
/**
* @notice projectId => has project reached its maximum number of
* invocations? Note that this returns a local cache of the core contract's
* state, and may be out of sync with the core contract. This is
* intentional, as it only enables gas optimization of mints after a
* project's maximum invocations has been reached. A false negative will
* only result in a gas cost increase, since the core contract will still
* enforce a maxInvocation check during minting. A false positive is not
* possible because the V3 core contract only allows maximum invocations
* to be reduced, not increased. Based on this rationale, we intentionally
* do not do input validation in this method as to whether or not the input
* `_projectId` is an existing project ID.
*/
function projectMaxHasBeenInvoked(uint256 _projectId)
external
view
returns (bool)
{
return projectConfig[_projectId].maxHasBeenInvoked;
}
/**
* @notice projectId => project's maximum number of invocations.
* Optionally synced with core contract value, for gas optimization.
* Note that this returns a local cache of the core contract's
* state, and may be out of sync with the core contract. This is
* intentional, as it only enables gas optimization of mints after a
* project's maximum invocations has been reached.
* @dev A number greater than the core contract's project max invocations
* will only result in a gas cost increase, since the core contract will
* still enforce a maxInvocation check during minting. A number less than
* the core contract's project max invocations is only possible when the
* project's max invocations have not been synced on this minter, since the
* V3 core contract only allows maximum invocations to be reduced, not
* increased. When this happens, the minter will enable minting, allowing
* the core contract to enforce the max invocations check. Based on this
* rationale, we intentionally do not do input validation in this method as
* to whether or not the input `_projectId` is an existing project ID.
*/
function projectMaxInvocations(uint256 _projectId)
external
view
returns (uint256)
{
return uint256(projectConfig[_projectId].maxInvocations);
}
/**
* @notice Updates this minter's price per token of project `_projectId`
* to be '_pricePerTokenInWei`, in Wei.
* This price supersedes any legacy core contract price per token value.
* @dev Note that it is intentionally supported here that the configured
* price may be explicitly set to `0`.
*/
function updatePricePerTokenInWei(
uint256 _projectId,
uint256 _pricePerTokenInWei
) external onlyArtist(_projectId) {
projectConfig[_projectId].pricePerTokenInWei = _pricePerTokenInWei;
projectConfig[_projectId].priceIsConfigured = true;
emit PricePerTokenInWeiUpdated(_projectId, _pricePerTokenInWei);
}
/**
* @notice Inactive function - requires Merkle proof to purchase.
*/
function purchase(uint256) external payable returns (uint256) {
revert("Must provide Merkle proof");
}
/**
* @notice Inactive function - requires Merkle proof to purchase.
*/
function purchaseTo(address, uint256) public payable returns (uint256) {
revert("Must provide Merkle proof");
}
/**
* @notice Purchases a token from project `_projectId`.
* @param _projectId Project ID to mint a token on.
* @param _proof Merkle proof.
* @return tokenId Token ID of minted token
*/
function purchase(uint256 _projectId, bytes32[] calldata _proof)
external
payable
returns (uint256 tokenId)
{
tokenId = purchaseTo_kem(msg.sender, _projectId, _proof, address(0));
return tokenId;
}
/**
* @notice gas-optimized version of purchase(uint256,bytes32[]).
*/
function purchase_gD5(uint256 _projectId, bytes32[] calldata _proof)
external
payable
returns (uint256 tokenId)
{
tokenId = purchaseTo_kem(msg.sender, _projectId, _proof, address(0));
return tokenId;
}
/**
* @notice Purchases a token from project `_projectId` and sets
* the token's owner to `_to`.
* @param _to Address to be the new token's owner.
* @param _projectId Project ID to mint a token on.
* @param _proof Merkle proof.
* @return tokenId Token ID of minted token
*/
function purchaseTo(
address _to,
uint256 _projectId,
bytes32[] calldata _proof
) external payable returns (uint256 tokenId) {
return purchaseTo_kem(_to, _projectId, _proof, address(0));
}
/**
* @notice Purchases a token from project `_projectId` and sets
* the token's owner to `_to`, as a delegate, (the `msg.sender`)
* on behalf of an explicitly defined vault.
* @param _to Address to be the new token's owner.
* @param _projectId Project ID to mint a token on.
* @param _proof Merkle proof.
* @param _vault Vault being purchased on behalf of.
* @return tokenId Token ID of minted token
*/
function purchaseTo(
address _to,
uint256 _projectId,
bytes32[] calldata _proof,
address _vault
) external payable returns (uint256 tokenId) {
return purchaseTo_kem(_to, _projectId, _proof, _vault);
}
/**
* @notice gas-optimized version of
* purchaseTo(address,uint256,bytes32[],address).
* @param _to Address to be the new token's owner.
* @param _projectId Project ID to mint a token on.
* @param _proof Merkle proof. Must be a valid proof of either `msg.sender`
* if `_vault` is `address(0)`, or `_vault` if `_vault` is not `address(0)`.
* @param _vault Vault being purchased on behalf of. Acceptable to be
* address(0) if no vault.
*/
function purchaseTo_kem(
address _to,
uint256 _projectId,
bytes32[] calldata _proof,
address _vault // acceptable to be `address(0)` if no vault
) public payable nonReentrant returns (uint256 tokenId) {
// CHECKS
ProjectConfig storage _projectConfig = projectConfig[_projectId];
// Note that `maxHasBeenInvoked` is only checked here to reduce gas
// consumption after a project has been fully minted.
// `_projectConfig.maxHasBeenInvoked` is locally cached to reduce
// gas consumption, but if not in sync with the core contract's value,
// the core contract also enforces its own max invocation check during
// minting.
require(
!_projectConfig.maxHasBeenInvoked,
"Maximum number of invocations reached"
);
// load price of token into memory
uint256 _pricePerTokenInWei = _projectConfig.pricePerTokenInWei;
require(
msg.value >= _pricePerTokenInWei,
"Must send minimum value to mint!"
);
// require artist to have configured price of token on this minter
require(_projectConfig.priceIsConfigured, "Price not configured");
// no contract filter since Merkle tree controls allowed addresses
// NOTE: delegate-vault handling **begins here**.
// handle that the vault may be either the `msg.sender` in the case
// that there is not a true vault, or may be `_vault` if one is
// provided explicitly (and it is valid).
address vault = msg.sender;
if (_vault != address(0)) {
// If a vault is provided, it must be valid, otherwise throw rather
// than optimistically-minting with original `msg.sender`.
// Note, we do not check `checkDelegateForAll` as well, as it is known
// to be implicitly checked by calling `checkDelegateForContract`.
bool isValidDelegee = delegationRegistryContract
.checkDelegateForContract(
msg.sender, // delegate
_vault, // vault
genArt721CoreAddress // contract
);
require(isValidDelegee, "Invalid delegate-vault pairing");
vault = _vault;
}
// require valid Merkle proof
require(
verifyAddress(_projectId, _proof, vault),
"Invalid Merkle proof"
);
// limit mints per address by project
uint256 _maxProjectInvocationsPerAddress = _projectConfig
.useMaxInvocationsPerAddressOverride
? _projectConfig.maxInvocationsPerAddressOverride
: DEFAULT_MAX_INVOCATIONS_PER_ADDRESS;
// note that mint limits index off of the `vault` (when applicable)
require(
projectUserMintInvocations[_projectId][vault] <
_maxProjectInvocationsPerAddress ||
_maxProjectInvocationsPerAddress == 0,
"Maximum number of invocations per address reached"
);
// EFFECTS
// increment user's invocations for this project
unchecked {
// this will never overflow since user's invocations on a project
// are limited by the project's max invocations
projectUserMintInvocations[_projectId][vault]++;
}
// mint token
tokenId = minterFilter.mint(_to, _projectId, vault);
// NOTE: delegate-vault handling **ends here**.
// okay if this underflows because if statement will always eval false.
// this is only for gas optimization (core enforces maxInvocations).
unchecked {
if (tokenId % ONE_MILLION == _projectConfig.maxInvocations - 1) {
_projectConfig.maxHasBeenInvoked = true;
}
}
// INTERACTIONS
_splitFundsETH(_projectId, _pricePerTokenInWei);
return tokenId;
}
/**
* @dev splits ETH funds between sender (if refund), foundation,
* artist, and artist's additional payee for a token purchased on
* project `_projectId`.
* @dev possible DoS during splits is acknowledged, and mitigated by
* business practices, including end-to-end testing on mainnet, and
* admin-accepted artist payment addresses.
*/
function _splitFundsETH(uint256 _projectId, uint256 _pricePerTokenInWei)
internal
{
if (msg.value > 0) {
bool success_;
// send refund to sender
uint256 refund = msg.value - _pricePerTokenInWei;
if (refund > 0) {
(success_, ) = msg.sender.call{value: refund}("");
require(success_, "Refund failed");
}
// split remaining funds between foundation, artist, and artist's
// additional payee
(
uint256 artblocksRevenue_,
address payable artblocksAddress_,
uint256 artistRevenue_,
address payable artistAddress_,
uint256 additionalPayeePrimaryRevenue_,
address payable additionalPayeePrimaryAddress_
) = genArtCoreContract.getPrimaryRevenueSplits(
_projectId,
_pricePerTokenInWei
);
// Art Blocks payment
if (artblocksRevenue_ > 0) {
(success_, ) = artblocksAddress_.call{value: artblocksRevenue_}(
""
);
require(success_, "Art Blocks payment failed");
}
// artist payment
if (artistRevenue_ > 0) {
(success_, ) = artistAddress_.call{value: artistRevenue_}("");
require(success_, "Artist payment failed");
}
// additional payee payment
if (additionalPayeePrimaryRevenue_ > 0) {
(success_, ) = additionalPayeePrimaryAddress_.call{
value: additionalPayeePrimaryRevenue_
}("");
require(success_, "Additional Payee payment failed");
}
}
}
/**
* @notice projectId => maximum invocations per allowlisted address. If a
* a value of 0 is returned, there is no limit on the number of mints per
* allowlisted address.
* Default behavior is limit 1 mint per address.
* This value can be changed at any time by the artist.
* @dev default value stated above must be updated if the value of
* CONFIG_USE_MAX_INVOCATIONS_PER_ADDRESS_OVERRIDE is changed.
*/
function projectMaxInvocationsPerAddress(uint256 _projectId)
public
view
returns (uint256)
{
ProjectConfig storage _projectConfig = projectConfig[_projectId];
if (_projectConfig.useMaxInvocationsPerAddressOverride) {
return uint256(_projectConfig.maxInvocationsPerAddressOverride);
} else {
return DEFAULT_MAX_INVOCATIONS_PER_ADDRESS;
}
}
/**
* @notice Returns remaining invocations for a given address.
* If `projectLimitsMintInvocationsPerAddress` is false, individual
* addresses are only limited by the project's maximum invocations, and a
* dummy value of zero is returned for `mintInvocationsRemaining`.
* If `projectLimitsMintInvocationsPerAddress` is true, the quantity of
* remaining mint invocations for address `_address` is returned as
* `mintInvocationsRemaining`.
* Note that mint invocations per address can be changed at any time by the
* artist of a project.
* Also note that all mint invocations are limited by a project's maximum
* invocations as defined on the core contract. This function may return
* a value greater than the project's remaining invocations.
*/
function projectRemainingInvocationsForAddress(
uint256 _projectId,
address _address
)
external
view
returns (
bool projectLimitsMintInvocationsPerAddress,
uint256 mintInvocationsRemaining
)
{
uint256 maxInvocationsPerAddress = projectMaxInvocationsPerAddress(
_projectId
);
if (maxInvocationsPerAddress == 0) {
// project does not limit mint invocations per address, so leave
// `projectLimitsMintInvocationsPerAddress` at solidity initial
// value of false. Also leave `mintInvocationsRemaining` at
// solidity initial value of zero, as indicated in this function's
// documentation.
} else {
projectLimitsMintInvocationsPerAddress = true;
uint256 userMintInvocations = projectUserMintInvocations[
_projectId
][_address];
// if user has not reached max invocations per address, return
// remaining invocations
if (maxInvocationsPerAddress > userMintInvocations) {
unchecked {
// will never underflow due to the check above
mintInvocationsRemaining =
maxInvocationsPerAddress -
userMintInvocations;
}
}
// else user has reached their maximum invocations, so leave
// `mintInvocationsRemaining` at solidity initial value of zero
}
}
/**
* @notice Process proof for an address. Returns Merkle root. Included to
* enable users to easily verify a proof's validity.
* @param _proof Merkle proof for address.
* @param _address Address to process.
* @return merkleRoot Merkle root for `_address` and `_proof`
*/
function processProofForAddress(bytes32[] calldata _proof, address _address)
external
pure
returns (bytes32)
{
return _proof.processProofCalldata(hashAddress(_address));
}
/**
* @notice Gets if price of token is configured, price of minting a
* token on project `_projectId`, and currency symbol and address to be
* used as payment. Supersedes any core contract price information.
* @param _projectId Project ID to get price information for.
* @return isConfigured true only if token price has been configured on
* this minter
* @return tokenPriceInWei current price of token on this minter - invalid
* if price has not yet been configured
* @return currencySymbol currency symbol for purchases of project on this
* minter. This minter always returns "ETH"
* @return currencyAddress currency address for purchases of project on
* this minter. This minter always returns null address, reserved for ether
*/
function getPriceInfo(uint256 _projectId)
external
view
returns (
bool isConfigured,
uint256 tokenPriceInWei,
string memory currencySymbol,
address currencyAddress
)
{
ProjectConfig storage _projectConfig = projectConfig[_projectId];
isConfigured = _projectConfig.priceIsConfigured;
tokenPriceInWei = _projectConfig.pricePerTokenInWei;
currencySymbol = "ETH";
currencyAddress = address(0);
}
}
// SPDX-License-Identifier: LGPL-3.0-only
// Created By: Art Blocks Inc.
pragma solidity ^0.8.0;
import "./IAdminACLV0.sol";
/// use the Royalty Registry's IManifold interface for token royalties
import "./IManifold.sol";
interface IGenArt721CoreContractV3 is IManifold {
/**
* @notice Token ID `_tokenId` minted to `_to`.
*/
event Mint(address indexed _to, uint256 indexed _tokenId);
/**
* @notice currentMinter updated to `_currentMinter`.
* @dev Implemented starting with V3 core
*/
event MinterUpdated(address indexed _currentMinter);
/**
* @notice Platform updated on bytes32-encoded field `_field`.
*/
event PlatformUpdated(bytes32 indexed _field);
/**
* @notice Project ID `_projectId` updated on bytes32-encoded field
* `_update`.
*/
event ProjectUpdated(uint256 indexed _projectId, bytes32 indexed _update);
event ProposedArtistAddressesAndSplits(
uint256 indexed _projectId,
address _artistAddress,
address _additionalPayeePrimarySales,
uint256 _additionalPayeePrimarySalesPercentage,
address _additionalPayeeSecondarySales,
uint256 _additionalPayeeSecondarySalesPercentage
);
event AcceptedArtistAddressesAndSplits(uint256 indexed _projectId);
// version and type of the core contract
// coreVersion is a string of the form "0.x.y"
function coreVersion() external view returns (string memory);
// coreType is a string of the form "GenArt721CoreV3"
function coreType() external view returns (string memory);
// owner (pre-V3 was named admin) of contract
// this is expected to be an Admin ACL contract for V3
function owner() external view returns (address);
// Admin ACL contract for V3, will be at the address owner()
function adminACLContract() external returns (IAdminACLV0);
// backwards-compatible (pre-V3) admin - equal to owner()
function admin() external view returns (address);
/**
* Function determining if _sender is allowed to call function with
* selector _selector on contract `_contract`. Intended to be used with
* peripheral contracts such as minters, as well as internally by the
* core contract itself.
*/
function adminACLAllowed(
address _sender,
address _contract,
bytes4 _selector
) external returns (bool);
// getter function of public variable
function nextProjectId() external view returns (uint256);
// getter function of public mapping
function tokenIdToProjectId(uint256 tokenId)
external
view
returns (uint256 projectId);
// @dev this is not available in V0
function isMintWhitelisted(address minter) external view returns (bool);
function projectIdToArtistAddress(uint256 _projectId)
external
view
returns (address payable);
function projectIdToAdditionalPayeePrimarySales(uint256 _projectId)
external
view
returns (address payable);
function projectIdToAdditionalPayeePrimarySalesPercentage(
uint256 _projectId
) external view returns (uint256);
// @dev new function in V3
function getPrimaryRevenueSplits(uint256 _projectId, uint256 _price)
external
view
returns (
uint256 artblocksRevenue_,
address payable artblocksAddress_,
uint256 artistRevenue_,
address payable artistAddress_,
uint256 additionalPayeePrimaryRevenue_,
address payable additionalPayeePrimaryAddress_
);
// @dev new function in V3
function projectStateData(uint256 _projectId)
external
view
returns (
uint256 invocations,
uint256 maxInvocations,
bool active,
bool paused,
uint256 completedTimestamp,
bool locked
);
// @dev Art Blocks primary sales payment address
function artblocksPrimarySalesAddress()
external
view
returns (address payable);
/**
* @notice Backwards-compatible (pre-V3) function returning Art Blocks
* primary sales payment address (now called artblocksPrimarySalesAddress).
*/
function artblocksAddress() external view returns (address payable);
// @dev Percentage of primary sales allocated to Art Blocks
function artblocksPrimarySalesPercentage() external view returns (uint256);
/**
* @notice Backwards-compatible (pre-V3) function returning Art Blocks
* primary sales percentage (now called artblocksPrimarySalesPercentage).
*/
function artblocksPercentage() external view returns (uint256);
// @dev Art Blocks secondary sales royalties payment address
function artblocksSecondarySalesAddress()
external
view
returns (address payable);
// @dev Basis points of secondary sales allocated to Art Blocks
function artblocksSecondarySalesBPS() external view returns (uint256);
// function to set a token's hash (must be guarded)
function setTokenHash_8PT(uint256 _tokenId, bytes32 _hash) external;
// @dev gas-optimized signature in V3 for `mint`
function mint_Ecf(
address _to,
uint256 _projectId,
address _by
) external returns (uint256 tokenId);
/**
* @notice Backwards-compatible (pre-V3) function that gets artist +
* artist's additional payee royalty data for token ID `_tokenId`.
* WARNING: Does not include Art Blocks portion of royalties.
*/
function getRoyaltyData(uint256 _tokenId)
external
view
returns (
address artistAddress,
address additionalPayee,
uint256 additionalPayeePercentage,
uint256 royaltyFeeByID
);
}
// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.17;
/// @dev Source: https://github.com/0xfoobar/delegation-registry/blob/main/src/IDelegationRegistry.sol
/**
* @title An immutable registry contract to be deployed as a standalone primitive
* @dev See EIP-5639, new project launches can read previous cold wallet -> hot wallet delegations
* from here and integrate those permissions into their flow
*/
interface IDelegationRegistry {
/// @notice Delegation type
enum DelegationType {
NONE,
ALL,
CONTRACT,
TOKEN
}
/// @notice Info about a single delegation, used for onchain enumeration
struct DelegationInfo {
DelegationType type_;
address vault;
address delegate;
address contract_;
uint256 tokenId;
}
/// @notice Info about a single contract-level delegation
struct ContractDelegation {
address contract_;
address delegate;
}
/// @notice Info about a single token-level delegation
struct TokenDelegation {
address contract_;
uint256 tokenId;
address delegate;
}
/// @notice Emitted when a user delegates their entire wallet
event DelegateForAll(address vault, address delegate, bool value);
/// @notice Emitted when a user delegates a specific contract
event DelegateForContract(
address vault,
address delegate,
address contract_,
bool value
);
/// @notice Emitted when a user delegates a specific token
event DelegateForToken(
address vault,
address delegate,
address contract_,
uint256 tokenId,
bool value
);
/// @notice Emitted when a user revokes all delegations
event RevokeAllDelegates(address vault);
/// @notice Emitted when a user revoes all delegations for a given delegate
event RevokeDelegate(address vault, address delegate);
/**
* ----------- WRITE -----------
*/
/**
* @notice Allow the delegate to act on your behalf for all contracts
* @param delegate The hotwallet to act on your behalf
* @param value Whether to enable or disable delegation for this address, true for setting and false for revoking
*/
function delegateForAll(address delegate, bool value) external;
/**
* @notice Allow the delegate to act on your behalf for a specific contract
* @param delegate The hotwallet to act on your behalf
* @param contract_ The address for the contract you're delegating
* @param value Whether to enable or disable delegation for this address, true for setting and false for revoking
*/
function delegateForContract(
address delegate,
address contract_,
bool value
) external;
/**
* @notice Allow the delegate to act on your behalf for a specific token
* @param delegate The hotwallet to act on your behalf
* @param contract_ The address for the contract you're delegating
* @param tokenId The token id for the token you're delegating
* @param value Whether to enable or disable delegation for this address, true for setting and false for revoking
*/
function delegateForToken(
address delegate,
address contract_,
uint256 tokenId,
bool value
) external;
/**
* @notice Revoke all delegates
*/
function revokeAllDelegates() external;
/**
* @notice Revoke a specific delegate for all their permissions
* @param delegate The hotwallet to revoke
*/
function revokeDelegate(address delegate) external;
/**
* @notice Remove yourself as a delegate for a specific vault
* @param vault The vault which delegated to the msg.sender, and should be removed
*/
function revokeSelf(address vault) external;
/**
* ----------- READ -----------
*/
/**
* @notice Returns all active delegations a given delegate is able to claim on behalf of
* @param delegate The delegate that you would like to retrieve delegations for
* @return info Array of DelegationInfo structs
*/
function getDelegationsByDelegate(address delegate)
external
view
returns (DelegationInfo[] memory);
/**
* @notice Returns an array of wallet-level delegates for a given vault
* @param vault The cold wallet who issued the delegation
* @return addresses Array of wallet-level delegates for a given vault
*/
function getDelegatesForAll(address vault)
external
view
returns (address[] memory);
/**
* @notice Returns an array of contract-level delegates for a given vault and contract
* @param vault The cold wallet who issued the delegation
* @param contract_ The address for the contract you're delegating
* @return addresses Array of contract-level delegates for a given vault and contract
*/
function getDelegatesForContract(address vault, address contract_)
external
view
returns (address[] memory);
/**
* @notice Returns an array of contract-level delegates for a given vault's token
* @param vault The cold wallet who issued the delegation
* @param contract_ The address for the contract holding the token
* @param tokenId The token id for the token you're delegating
* @return addresses Array of contract-level delegates for a given vault's token
*/
function getDelegatesForToken(
address vault,
address contract_,
uint256 tokenId
) external view returns (address[] memory);
/**
* @notice Returns all contract-level delegations for a given vault
* @param vault The cold wallet who issued the delegations
* @return delegations Array of ContractDelegation structs
*/
function getContractLevelDelegations(address vault)
external
view
returns (ContractDelegation[] memory delegations);
/**
* @notice Returns all token-level delegations for a given vault
* @param vault The cold wallet who issued the delegations
* @return delegations Array of TokenDelegation structs
*/
function getTokenLevelDelegations(address vault)
external
view
returns (TokenDelegation[] memory delegations);
/**
* @notice Returns true if the address is delegated to act on the entire vault
* @param delegate The hotwallet to act on your behalf
* @param vault The cold wallet who issued the delegation
*/
function checkDelegateForAll(address delegate, address vault)
external
view
returns (bool);
/**
* @notice Returns true if the address is delegated to act on your behalf for a token contract or an entire vault
* @param delegate The hotwallet to act on your behalf
* @param contract_ The address for the contract you're delegating
* @param vault The cold wallet who issued the delegation
*/
function checkDelegateForContract(
address delegate,
address vault,
address contract_
) external view returns (bool);
/**
* @notice Returns true if the address is delegated to act on your behalf for a specific token, the token's contract or an entire vault
* @param delegate The hotwallet to act on your behalf
* @param contract_ The address for the contract you're delegating
* @param tokenId The token id for the token you're delegating
* @param vault The cold wallet who issued the delegation
*/
function checkDelegateForToken(
address delegate,
address vault,
address contract_,
uint256 tokenId
) external view returns (bool);
}
// SPDX-License-Identifier: LGPL-3.0-only
// Created By: Art Blocks Inc.
import "./IFilteredMinterV1.sol";
pragma solidity ^0.8.0;
/**
* @title This interface extends the IFilteredMinterV1 interface in order to
* add support for including Merkle proofs when purchasing.
* @author Art Blocks Inc.
*/
interface IFilteredMinterMerkleV0 is IFilteredMinterV1 {
/**
* @notice Notifies of the contract's default maximum mints allowed per
* user for a given project, on this minter. This value can be overridden
* by the artist of any project at any time.
*/
event DefaultMaxInvocationsPerAddress(
uint256 defaultMaxInvocationsPerAddress
);
// Triggers a purchase of a token from the desired project, to the
// TX-sending address. Requires Merkle proof.
function purchase(uint256 _projectId, bytes32[] memory _proof)
external
payable
returns (uint256 tokenId);
// Triggers a purchase of a token from the desired project, to the specified
// receiving address. Requires Merkle proof.
function purchaseTo(
address _to,
uint256 _projectId,
bytes32[] memory _proof
) external payable returns (uint256 tokenId);
}
// SPDX-License-Identifier: LGPL-3.0-only
// Created By: Art Blocks Inc.
pragma solidity ^0.8.0;
interface IMinterFilterV0 {
/**
* @notice Approved minter `_minterAddress`.
*/
event MinterApproved(address indexed _minterAddress, string _minterType);
/**
* @notice Revoked approval for minter `_minterAddress`
*/
event MinterRevoked(address indexed _minterAddress);
/**
* @notice Minter `_minterAddress` of type `_minterType`
* registered for project `_projectId`.
*/
event ProjectMinterRegistered(
uint256 indexed _projectId,
address indexed _minterAddress,
string _minterType
);
/**
* @notice Any active minter removed for project `_projectId`.
*/
event ProjectMinterRemoved(uint256 indexed _projectId);
function genArt721CoreAddress() external returns (address);
function setMinterForProject(uint256, address) external;
function removeMinterForProject(uint256) external;
function mint(
address _to,
uint256 _projectId,
address sender
) external returns (uint256);
function getMinterForProject(uint256) external view returns (address);
function projectHasMinter(uint256) external view returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (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() {
// On the first call to nonReentrant, _notEntered will be true
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
_;
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (utils/cryptography/MerkleProof.sol)
pragma solidity ^0.8.0;
/**
* @dev These functions deal with verification of Merkle Tree proofs.
*
* The proofs can be generated using the JavaScript library
* https://github.com/miguelmota/merkletreejs[merkletreejs].
* Note: the hashing algorithm should be keccak256 and pair sorting should be enabled.
*
* See `test/utils/cryptography/MerkleProof.test.js` for some examples.
*
* WARNING: You should avoid using leaf values that are 64 bytes long prior to
* hashing, or use a hash function other than keccak256 for hashing leaves.
* This is because the concatenation of a sorted pair of internal nodes in
* the merkle tree could be reinterpreted as a leaf value.
*/
library MerkleProof {
/**
* @dev Returns true if a `leaf` can be proved to be a part of a Merkle tree
* defined by `root`. For this, a `proof` must be provided, containing
* sibling hashes on the branch from the leaf to the root of the tree. Each
* pair of leaves and each pair of pre-images are assumed to be sorted.
*/
function verify(
bytes32[] memory proof,
bytes32 root,
bytes32 leaf
) internal pure returns (bool) {
return processProof(proof, leaf) == root;
}
/**
* @dev Calldata version of {verify}
*
* _Available since v4.7._
*/
function verifyCalldata(
bytes32[] calldata proof,
bytes32 root,
bytes32 leaf
) internal pure returns (bool) {
return processProofCalldata(proof, leaf) == root;
}
/**
* @dev Returns the rebuilt hash obtained by traversing a Merkle tree up
* from `leaf` using `proof`. A `proof` is valid if and only if the rebuilt
* hash matches the root of the tree. When processing the proof, the pairs
* of leafs & pre-images are assumed to be sorted.
*
* _Available since v4.4._
*/
function processProof(bytes32[] memory proof, bytes32 leaf) internal pure returns (bytes32) {
bytes32 computedHash = leaf;
for (uint256 i = 0; i < proof.length; i++) {
computedHash = _hashPair(computedHash, proof[i]);
}
return computedHash;
}
/**
* @dev Calldata version of {processProof}
*
* _Available since v4.7._
*/
function processProofCalldata(bytes32[] calldata proof, bytes32 leaf) internal pure returns (bytes32) {
bytes32 computedHash = leaf;
for (uint256 i = 0; i < proof.length; i++) {
computedHash = _hashPair(computedHash, proof[i]);
}
return computedHash;
}
/**
* @dev Returns true if the `leaves` can be proved to be a part of a Merkle tree defined by
* `root`, according to `proof` and `proofFlags` as described in {processMultiProof}.
*
* _Available since v4.7._
*/
function multiProofVerify(
bytes32[] memory proof,
bool[] memory proofFlags,
bytes32 root,
bytes32[] memory leaves
) internal pure returns (bool) {
return processMultiProof(proof, proofFlags, leaves) == root;
}
/**
* @dev Calldata version of {multiProofVerify}
*
* _Available since v4.7._
*/
function multiProofVerifyCalldata(
bytes32[] calldata proof,
bool[] calldata proofFlags,
bytes32 root,
bytes32[] memory leaves
) internal pure returns (bool) {
return processMultiProofCalldata(proof, proofFlags, leaves) == root;
}
/**
* @dev Returns the root of a tree reconstructed from `leaves` and the sibling nodes in `proof`,
* consuming from one or the other at each step according to the instructions given by
* `proofFlags`.
*
* _Available since v4.7._
*/
function processMultiProof(
bytes32[] memory proof,
bool[] memory proofFlags,
bytes32[] memory leaves
) internal pure returns (bytes32 merkleRoot) {
// This function rebuild the root hash by traversing the tree up from the leaves. The root is rebuilt by
// consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the
// `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of
// the merkle tree.
uint256 leavesLen = leaves.length;
uint256 totalHashes = proofFlags.length;
// Check proof validity.
require(leavesLen + proof.length - 1 == totalHashes, "MerkleProof: invalid multiproof");
// The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using
// `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop".
bytes32[] memory hashes = new bytes32[](totalHashes);
uint256 leafPos = 0;
uint256 hashPos = 0;
uint256 proofPos = 0;
// At each step, we compute the next hash using two values:
// - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we
// get the next hash.
// - depending on the flag, either another value for the "main queue" (merging branches) or an element from the
// `proof` array.
for (uint256 i = 0; i < totalHashes; i++) {
bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++];
bytes32 b = proofFlags[i] ? leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++] : proof[proofPos++];
hashes[i] = _hashPair(a, b);
}
if (totalHashes > 0) {
return hashes[totalHashes - 1];
} else if (leavesLen > 0) {
return leaves[0];
} else {
return proof[0];
}
}
/**
* @dev Calldata version of {processMultiProof}
*
* _Available since v4.7._
*/
function processMultiProofCalldata(
bytes32[] calldata proof,
bool[] calldata proofFlags,
bytes32[] memory leaves
) internal pure returns (bytes32 merkleRoot) {
// This function rebuild the root hash by traversing the tree up from the leaves. The root is rebuilt by
// consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the
// `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of
// the merkle tree.
uint256 leavesLen = leaves.length;
uint256 totalHashes = proofFlags.length;
// Check proof validity.
require(leavesLen + proof.length - 1 == totalHashes, "MerkleProof: invalid multiproof");
// The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using
// `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop".
bytes32[] memory hashes = new bytes32[](totalHashes);
uint256 leafPos = 0;
uint256 hashPos = 0;
uint256 proofPos = 0;
// At each step, we compute the next hash using two values:
// - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we
// get the next hash.
// - depending on the flag, either another value for the "main queue" (merging branches) or an element from the
// `proof` array.
for (uint256 i = 0; i < totalHashes; i++) {
bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++];
bytes32 b = proofFlags[i] ? leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++] : proof[proofPos++];
hashes[i] = _hashPair(a, b);
}
if (totalHashes > 0) {
return hashes[totalHashes - 1];
} else if (leavesLen > 0) {
return leaves[0];
} else {
return proof[0];
}
}
function _hashPair(bytes32 a, bytes32 b) private pure returns (bytes32) {
return a < b ? _efficientHash(a, b) : _efficientHash(b, a);
}
function _efficientHash(bytes32 a, bytes32 b) private pure returns (bytes32 value) {
/// @solidity memory-safe-assembly
assembly {
mstore(0x00, a)
mstore(0x20, b)
value := keccak256(0x00, 0x40)
}
}
}
// 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
pragma solidity ^0.8.0;
/// @dev Royalty Registry interface, used to support the Royalty Registry.
/// @dev Source: https://github.com/manifoldxyz/royalty-registry-solidity/blob/main/contracts/specs/IManifold.sol
/// @author: manifold.xyz
/**
* @dev Royalty interface for creator core classes
*/
interface IManifold {
/**
* @dev Get royalites of a token. Returns list of receivers and basisPoints
*
* bytes4(keccak256('getRoyalties(uint256)')) == 0xbb3bafd6
*
* => 0xbb3bafd6 = 0xbb3bafd6
*/
function getRoyalties(uint256 tokenId)
external
view
returns (address payable[] memory, uint256[] memory);
}
// SPDX-License-Identifier: LGPL-3.0-only
// Created By: Art Blocks Inc.
pragma solidity ^0.8.0;
interface IAdminACLV0 {
/**
* @notice Token ID `_tokenId` minted to `_to`.
* @param previousSuperAdmin The previous superAdmin address.
* @param newSuperAdmin The new superAdmin address.
* @param genArt721CoreAddressesToUpdate Array of genArt721Core
* addresses to update to the new superAdmin, for indexing purposes only.
*/
event SuperAdminTransferred(
address indexed previousSuperAdmin,
address indexed newSuperAdmin,
address[] genArt721CoreAddressesToUpdate
);
/// Type of the Admin ACL contract, e.g. "AdminACLV0"
function AdminACLType() external view returns (string memory);
/// super admin address
function superAdmin() external view returns (address);
/**
* @notice Calls transferOwnership on other contract from this contract.
* This is useful for updating to a new AdminACL contract.
* @dev this function should be gated to only superAdmin-like addresses.
*/
function transferOwnershipOn(address _contract, address _newAdminACL)
external;
/**
* @notice Calls renounceOwnership on other contract from this contract.
* @dev this function should be gated to only superAdmin-like addresses.
*/
function renounceOwnershipOn(address _contract) external;
/**
* @notice Checks if sender `_sender` is allowed to call function with selector
* `_selector` on contract `_contract`.
*/
function allowed(
address _sender,
address _contract,
bytes4 _selector
) external returns (bool);
}
// SPDX-License-Identifier: LGPL-3.0-only
// Created By: Art Blocks Inc.
import "./IFilteredMinterV0.sol";
pragma solidity ^0.8.0;
/**
* @title This interface extends the IFilteredMinterV0 interface in order to
* add support for generic project minter configuration updates.
* @dev keys represent strings of finite length encoded in bytes32 to minimize
* gas.
* @author Art Blocks Inc.
*/
interface IFilteredMinterV1 is IFilteredMinterV0 {
/// ANY
/**
* @notice Generic project minter configuration event. Removes key `_key`
* for project `_projectId`.
*/
event ConfigKeyRemoved(uint256 indexed _projectId, bytes32 _key);
/// BOOL
/**
* @notice Generic project minter configuration event. Sets value of key
* `_key` to `_value` for project `_projectId`.
*/
event ConfigValueSet(uint256 indexed _projectId, bytes32 _key, bool _value);
/// UINT256
/**
* @notice Generic project minter configuration event. Sets value of key
* `_key` to `_value` for project `_projectId`.
*/
event ConfigValueSet(
uint256 indexed _projectId,
bytes32 _key,
uint256 _value
);
/**
* @notice Generic project minter configuration event. Adds value `_value`
* to the set of uint256 at key `_key` for project `_projectId`.
*/
event ConfigValueAddedToSet(
uint256 indexed _projectId,
bytes32 _key,
uint256 _value
);
/**
* @notice Generic project minter configuration event. Removes value
* `_value` to the set of uint256 at key `_key` for project `_projectId`.
*/
event ConfigValueRemovedFromSet(
uint256 indexed _projectId,
bytes32 _key,
uint256 _value
);
/// ADDRESS
/**
* @notice Generic project minter configuration event. Sets value of key
* `_key` to `_value` for project `_projectId`.
*/
event ConfigValueSet(
uint256 indexed _projectId,
bytes32 _key,
address _value
);
/**
* @notice Generic project minter configuration event. Adds value `_value`
* to the set of addresses at key `_key` for project `_projectId`.
*/
event ConfigValueAddedToSet(
uint256 indexed _projectId,
bytes32 _key,
address _value
);
/**
* @notice Generic project minter configuration event. Removes value
* `_value` to the set of addresses at key `_key` for project `_projectId`.
*/
event ConfigValueRemovedFromSet(
uint256 indexed _projectId,
bytes32 _key,
address _value
);
/// BYTES32
/**
* @notice Generic project minter configuration event. Sets value of key
* `_key` to `_value` for project `_projectId`.
*/
event ConfigValueSet(
uint256 indexed _projectId,
bytes32 _key,
bytes32 _value
);
/**
* @notice Generic project minter configuration event. Adds value `_value`
* to the set of bytes32 at key `_key` for project `_projectId`.
*/
event ConfigValueAddedToSet(
uint256 indexed _projectId,
bytes32 _key,
bytes32 _value
);
/**
* @notice Generic project minter configuration event. Removes value
* `_value` to the set of bytes32 at key `_key` for project `_projectId`.
*/
event ConfigValueRemovedFromSet(
uint256 indexed _projectId,
bytes32 _key,
bytes32 _value
);
/**
* @dev Strings not supported. Recommend conversion of (short) strings to
* bytes32 to remain gas-efficient.
*/
}
// SPDX-License-Identifier: LGPL-3.0-only
// Created By: Art Blocks Inc.
pragma solidity ^0.8.0;
interface IFilteredMinterV0 {
/**
* @notice Price per token in wei updated for project `_projectId` to
* `_pricePerTokenInWei`.
*/
event PricePerTokenInWeiUpdated(
uint256 indexed _projectId,
uint256 indexed _pricePerTokenInWei
);
/**
* @notice Currency updated for project `_projectId` to symbol
* `_currencySymbol` and address `_currencyAddress`.
*/
event ProjectCurrencyInfoUpdated(
uint256 indexed _projectId,
address indexed _currencyAddress,
string _currencySymbol
);
/// togglePurchaseToDisabled updated
event PurchaseToDisabledUpdated(
uint256 indexed _projectId,
bool _purchaseToDisabled
);
// getter function of public variable
function minterType() external view returns (string memory);
function genArt721CoreAddress() external returns (address);
function minterFilterAddress() external returns (address);
// Triggers a purchase of a token from the desired project, to the
// TX-sending address.
function purchase(uint256 _projectId)
external
payable
returns (uint256 tokenId);
// Triggers a purchase of a token from the desired project, to the specified
// receiving address.
function purchaseTo(address _to, uint256 _projectId)
external
payable
returns (uint256 tokenId);
// Toggles the ability for `purchaseTo` to be called directly with a
// specified receiving address that differs from the TX-sending address.
function togglePurchaseToDisabled(uint256 _projectId) external;
// Called to make the minter contract aware of the max invocations for a
// given project.
function setProjectMaxInvocations(uint256 _projectId) external;
// Gets if token price is configured, token price in wei, currency symbol,
// and currency address, assuming this is project's minter.
// Supersedes any defined core price.
function getPriceInfo(uint256 _projectId)
external
view
returns (
bool isConfigured,
uint256 tokenPriceInWei,
string memory currencySymbol,
address currencyAddress
);
}