@artblocks/contracts 1.0.3 → 1.0.4

package/contracts/libs/v0.8.x/minter-libs/TokenHolderLib.sol

@@ -0,0 +1,153 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "@openzeppelin-4.5/contracts/utils/structs/EnumerableSet.sol";
+import "@openzeppelin-4.7/contracts/token/ERC721/IERC721.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title Art Blocks Token Holder Library
+ * @notice This library provides a collection of functions for managing and
+ * interacting with holders of specific NFTs, in the context of purchase gating for
+ * Art Blocks projects. The primary features of this library include the ability
+ * to register and unregister NFT addresses, the allowance and removal of holders
+ * from specific project tokens, as well as the ability to check if a specific NFT is
+ * allowlisted.
+ * @author Art Blocks Inc.
+ */
+
+library TokenHolderLib {
+    using EnumerableSet for EnumerableSet.AddressSet;
+    // Define one million to represent the base token ID for each project.
+    uint256 constant ONE_MILLION = 1_000_000;
+
+    struct HolderProjectConfig {
+        // projects whose holders are allowed to purchase a token on `projectId`
+        // ownedNFTAddress => ownedNFTProjectIds => bool
+        mapping(address => mapping(uint256 => bool)) allowedProjectHolders;
+    }
+
+    /**
+     * @dev Allows holders of specific project tokens.
+     * @param holderProjectConfig A mapping of the allowed holders for a specific project.
+     * @param _ownedNFTAddresses NFT core addresses of projects to be
+     * allowlisted. Indexes must align with `_ownedNFTProjectIds`.
+     * @param _ownedNFTProjectIds Project IDs on `_ownedNFTAddresses` whose
+     * holders shall be allowlisted to mint project `_projectId`. Indexes must
+     * align with `_ownedNFTAddresses`.
+     */
+    function allowHoldersOfProjects(
+        HolderProjectConfig storage holderProjectConfig,
+        address[] memory _ownedNFTAddresses,
+        uint256[] memory _ownedNFTProjectIds
+    ) internal {
+        require(
+            _ownedNFTAddresses.length == _ownedNFTProjectIds.length,
+            "TokenHolderLib: arrays neq length"
+        );
+        for (uint256 i = 0; i < _ownedNFTAddresses.length; i++) {
+            holderProjectConfig.allowedProjectHolders[_ownedNFTAddresses[i]][
+                _ownedNFTProjectIds[i]
+            ] = true;
+        }
+    }
+
+    /**
+     * @dev Removes holders of specific project tokens.
+     * @param holderProjectConfig A mapping of the allowed holders for a specific project.
+     * @param _ownedNFTAddresses NFT core addresses of projects to be removed
+     * from allowlist. Indexes must align with `_ownedNFTProjectIds`.
+     * @param _ownedNFTProjectIds Project IDs on `_ownedNFTAddresses` whose
+     * holders will be removed from allowlist to mint project `_projectId`.
+     * Indexes must align with `_ownedNFTAddresses`.
+     */
+    function removeHoldersOfProjects(
+        HolderProjectConfig storage holderProjectConfig,
+        address[] memory _ownedNFTAddresses,
+        uint256[] memory _ownedNFTProjectIds
+    ) internal {
+        require(
+            _ownedNFTAddresses.length == _ownedNFTProjectIds.length,
+            "TokenHolderLib: arrays neq length"
+        );
+        for (uint256 i = 0; i < _ownedNFTAddresses.length; i++) {
+            holderProjectConfig.allowedProjectHolders[_ownedNFTAddresses[i]][
+                _ownedNFTProjectIds[i]
+            ] = false;
+        }
+    }
+
+    /**
+     * @dev Allows and removes holders of specific project tokens in one operation.
+     * @param holderProjectConfig A mapping of the allowed holders for a specific project.
+     * @param _ownedNFTAddressesAdd NFT core addresses of projects to be
+     * allowlisted. Indexes must align with `_ownedNFTProjectIdsAdd`.
+     * @param _ownedNFTProjectIdsAdd Project IDs on `_ownedNFTAddressesAdd`
+     * whose holders shall be allowlisted to mint project `_projectId`. Indexes
+     * must align with `_ownedNFTAddressesAdd`.
+     * @param _ownedNFTAddressesRemove NFT core addresses of projects to be
+     * removed from allowlist. Indexes must align with
+     * `_ownedNFTProjectIdsRemove`.
+     * @param _ownedNFTProjectIdsRemove Project IDs on
+     * `_ownedNFTAddressesRemove` whose holders will be removed from allowlist
+     * to mint project `_projectId`. Indexes must align with
+     * `_ownedNFTAddressesRemove`.
+     */
+    function allowAndRemoveHoldersOfProjects(
+        HolderProjectConfig storage holderProjectConfig,
+        address[] memory _ownedNFTAddressesAdd,
+        uint256[] memory _ownedNFTProjectIdsAdd,
+        address[] memory _ownedNFTAddressesRemove,
+        uint256[] memory _ownedNFTProjectIdsRemove
+    ) internal {
+        allowHoldersOfProjects(
+            holderProjectConfig,
+            _ownedNFTAddressesAdd,
+            _ownedNFTProjectIdsAdd
+        );
+        removeHoldersOfProjects(
+            holderProjectConfig,
+            _ownedNFTAddressesRemove,
+            _ownedNFTProjectIdsRemove
+        );
+    }
+
+    /**
+     * @notice Verify that an NFT is owned by the target owner.
+     * Reverts if target owner is not the owner of the NFT.
+     * @dev Considered an interaction because calling ownerOf on an NFT
+     * contract. Plan is to only integrate with AB/PBAB NFTs on the minter, but
+     * in case other NFTs are registered, better to check here. Also,
+     * function is non-reentrant, so this is extra cautious.
+     */
+    function validateNFTOwnership(
+        address _ownedNFTAddress,
+        uint256 _ownedNFTTokenId,
+        address _targetOwner
+    ) internal view {
+        address actualNFTOwner = IERC721(_ownedNFTAddress).ownerOf(
+            _ownedNFTTokenId
+        );
+        require(actualNFTOwner == _targetOwner, "Only owner of NFT");
+    }
+
+    /**
+     * @dev Checks if a specific NFT is allowlisted.
+     * @param holderProjectConfig A mapping of the allowed holders for a specific project.
+     * @param _ownedNFTAddress ERC-721 NFT token address to be checked.
+     * @param _ownedNFTTokenId ERC-721 NFT token ID to be checked.
+     * @return bool true if the NFT is allowlisted; false otherwise.
+     */
+    function isAllowlistedNFT(
+        HolderProjectConfig storage holderProjectConfig,
+        address _ownedNFTAddress,
+        uint256 _ownedNFTTokenId
+    ) internal view returns (bool) {
+        uint256 ownedNFTProjectId = _ownedNFTTokenId / ONE_MILLION;
+        return
+            holderProjectConfig.allowedProjectHolders[_ownedNFTAddress][
+                ownedNFTProjectId
+            ];
+    }
+}

package/contracts/minter-suite/MinterFilter/MinterFilterV0.sol

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Created By: Art Blocks Inc.
 
-import "../../interfaces/0.8.x/IMinterFilterV0.sol";
-import "../../interfaces/0.8.x/IFilteredMinterV0.sol";
-import "../../interfaces/0.8.x/IGenArt721CoreContractV1.sol";
+import "../../interfaces/v0.8.x/IMinterFilterV0.sol";
+import "../../interfaces/v0.8.x/IFilteredMinterV0.sol";
+import "../../interfaces/v0.8.x/IGenArt721CoreContractV1.sol";
 
 import "@openzeppelin-4.5/contracts/utils/structs/EnumerableMap.sol";
 

package/contracts/minter-suite/MinterFilter/MinterFilterV1.sol

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Created By: Art Blocks Inc.
 
-import "../../interfaces/0.8.x/IMinterFilterV0.sol";
-import "../../interfaces/0.8.x/IFilteredMinterV0.sol";
-import "../../interfaces/0.8.x/IAdminACLV0.sol";
-import "../../interfaces/0.8.x/IGenArt721CoreContractV3.sol";
+import "../../interfaces/v0.8.x/IMinterFilterV0.sol";
+import "../../interfaces/v0.8.x/IFilteredMinterV0.sol";
+import "../../interfaces/v0.8.x/IAdminACLV0.sol";
+import "../../interfaces/v0.8.x/IGenArt721CoreContractV3.sol";
 
-import "../../libs/0.8.x/Bytes32Strings.sol";
+import "../../libs/v0.8.x/Bytes32Strings.sol";
 
 import "@openzeppelin-4.5/contracts/utils/structs/EnumerableMap.sol";
 

package/contracts/minter-suite/MinterFilter/MinterFilterV2.sol

@@ -3,12 +3,12 @@
 
 pragma solidity 0.8.19;
 
-import "../../interfaces/0.8.x/IMinterFilterV1.sol";
-import "../../interfaces/0.8.x/IFilteredMinterV0.sol";
-import "../../interfaces/0.8.x/IGenArt721CoreContractV3_Base.sol";
-import "../../interfaces/0.8.x/ICoreRegistryV1.sol";
+import "../../interfaces/v0.8.x/IMinterFilterV1.sol";
+import "../../interfaces/v0.8.x/ISharedMinterV0.sol";
+import "../../interfaces/v0.8.x/IGenArt721CoreContractV3_Base.sol";
+import "../../interfaces/v0.8.x/ICoreRegistryV1.sol";
 
-import "../../libs/0.8.x/Bytes32Strings.sol";
+import "../../libs/v0.8.x/Bytes32Strings.sol";
 
 import "@openzeppelin-4.7/contracts/access/Ownable.sol";
 import "@openzeppelin-4.7/contracts/utils/structs/EnumerableMap.sol";
@@ -254,7 +254,7 @@ contract MinterFilterV2 is Ownable, IMinterFilterV1 {
         );
         emit MinterApprovedGlobally(
             _minter,
-            IFilteredMinterV0(_minter).minterType()
+            ISharedMinterV0(_minter).minterType()
         );
     }
 
@@ -307,7 +307,7 @@ contract MinterFilterV2 is Ownable, IMinterFilterV1 {
         emit MinterApprovedForContract({
             coreContract: _coreContract,
             minter: _minter,
-            minterType: IFilteredMinterV0(_minter).minterType()
+            minterType: ISharedMinterV0(_minter).minterType()
         });
     }
 
@@ -390,7 +390,7 @@ contract MinterFilterV2 is Ownable, IMinterFilterV1 {
             projectId: _projectId,
             coreContract: _coreContract,
             minter: _minter,
-            minterType: IFilteredMinterV0(_minter).minterType()
+            minterType: ISharedMinterV0(_minter).minterType()
         });
     }
 
@@ -571,7 +571,7 @@ contract MinterFilterV2 is Ownable, IMinterFilterV1 {
     {
         // @dev at() reverts if index is out of bounds
         (projectId, minterAddress) = minterForProject[_coreContract].at(_index);
-        minterType = IFilteredMinterV0(minterAddress).minterType();
+        minterType = ISharedMinterV0(minterAddress).minterType();
         return (projectId, minterAddress, minterType);
     }
 
@@ -634,6 +634,80 @@ contract MinterFilterV2 is Ownable, IMinterFilterV1 {
         return projectIds;
     }
 
+    /**
+     * @notice Gets all minters that are globally approved on this minter
+     * filter. Returns an array of MinterWithType structs, which contain the
+     * minter address and minter type.
+     * This function has unbounded gas, and should only be used for off-chain
+     * queries.
+     * Alternatively, the subgraph indexing layer may be used to query these
+     * values.
+     * @return mintersWithTypes Array of MinterWithType structs, which contain
+     * the minter address and minter type.
+     */
+    function getAllGloballyApprovedMinters()
+        external
+        view
+        returns (MinterWithType[] memory mintersWithTypes)
+    {
+        // initialize arrays with appropriate length
+        uint256 numMinters = globallyApprovedMinters.length();
+        mintersWithTypes = new MinterWithType[](numMinters);
+        // iterate over all globally approved minters, adding to array
+        for (uint256 i; i < numMinters; ) {
+            address minterAddress = globallyApprovedMinters.at(i);
+            // @dev we know minterType() does not revert, because it was called
+            // when globally approving the minter
+            string memory minterType = ISharedMinterV0(minterAddress)
+                .minterType();
+            mintersWithTypes[i] = MinterWithType({
+                minterAddress: minterAddress,
+                minterType: minterType
+            });
+            unchecked {
+                ++i;
+            }
+        }
+    }
+
+    /**
+     * @notice Gets all minters that are approved for a specific core contract.
+     * Returns an array of MinterWithType structs, which contain the minter
+     * address and minter type.
+     * This function has unbounded gas, and should only be used for off-chain
+     * queries.
+     * @param _coreContract Core contract to query.
+     * @return mintersWithTypes Array of MinterWithType structs, which contain
+     * the minter address and minter type.
+     */
+    function getAllContractApprovedMinters(
+        address _coreContract
+    ) external view returns (MinterWithType[] memory mintersWithTypes) {
+        // initialize arrays with appropriate length
+        EnumerableSet.AddressSet
+            storage _contractApprovedMinters = contractApprovedMinters[
+                _coreContract
+            ];
+        uint256 numMinters = _contractApprovedMinters.length();
+        mintersWithTypes = new MinterWithType[](numMinters);
+        // iterate over all minters approved for a given contract, adding to
+        // array
+        for (uint256 i; i < numMinters; ) {
+            address minterAddress = _contractApprovedMinters.at(i);
+            // @dev we know minterType() does not revert, because it was called
+            // when approving the minter for a contract
+            string memory minterType = ISharedMinterV0(minterAddress)
+                .minterType();
+            mintersWithTypes[i] = MinterWithType({
+                minterAddress: minterAddress,
+                minterType: minterType
+            });
+            unchecked {
+                ++i;
+            }
+        }
+    }
+
     /**
      * @notice Convenience function that returns whether `_sender` is allowed
      * to call function with selector `_selector` on contract `_contract`, as

package/contracts/minter-suite/Minters/MinterBase_v0_1_1.sol

@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Created By: Art Blocks Inc.
 
-import "../../interfaces/0.8.x/IMinterBaseV0.sol";
-import "../../interfaces/0.8.x/IGenArt721CoreContractV3_Base.sol";
-import "../../interfaces/0.8.x/IGenArt721CoreContractV3.sol";
-import "../../interfaces/0.8.x/IGenArt721CoreContractV3_Engine.sol";
+import "../../interfaces/v0.8.x/IMinterBaseV0.sol";
+import "../../interfaces/v0.8.x/IGenArt721CoreContractV3_Base.sol";
+import "../../interfaces/v0.8.x/IGenArt721CoreContractV3.sol";
+import "../../interfaces/v0.8.x/IGenArt721CoreContractV3_Engine.sol";
 
 import "@openzeppelin-4.7/contracts/token/ERC20/IERC20.sol";