@artblocks/contracts 1.0.4 → 1.2.0

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

@@ -1,11 +1,14 @@
 // 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;
 
+import {IERC721} from "@openzeppelin-4.7/contracts/token/ERC721/IERC721.sol";
+
+import {ABHelpers} from "../ABHelpers.sol";
+
+import {EnumerableSet} from "@openzeppelin-4.5/contracts/utils/structs/EnumerableSet.sol";
+
 /**
  * @title Art Blocks Token Holder Library
  * @notice This library provides a collection of functions for managing and
@@ -19,98 +22,193 @@ pragma solidity ^0.8.0;
 
 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;
+    /**
+     * @notice Notifies of the contracts' current delegation registry address.
+     * @param delegationRegistry The address of the delegation registry
+     */
+    event DelegationRegistryUpdated(address delegationRegistry);
+    /**
+     * @notice Allow holders of NFTs at addresses `ownedNFTAddresses`, project
+     * IDs `ownedNFTProjectIds` to mint on project `projectId`.
+     * `ownedNFTAddresses` assumed to be aligned with `ownedNFTProjectIds`.
+     * e.g. Allows holders of project `ownedNFTProjectIds[0]` on token
+     * contract `ownedNFTAddresses[0]` to mint.
+     * @param projectId Project ID to allowlist holders for.
+     * @param coreContract Core contract address to allowlist holders for.
+     * @param ownedNFTAddresses NFT core addresses of projects to be
+     * allowlisted. Indexes align with `ownedNFTProjectIds`.
+     * @param ownedNFTProjectIds Project IDs on `ownedNFTAddresses` whose
+     * holders shall be allowlisted to mint project `projectId`. Indexes
+     * align with `ownedNFTAddresses`.
+     */
+    event AllowedHoldersOfProjects(
+        uint256 indexed projectId,
+        address indexed coreContract,
+        address[] ownedNFTAddresses,
+        uint256[] ownedNFTProjectIds
+    );
+    /**
+     * @notice Remove holders of NFTs at addresses `ownedNFTAddresses`,
+     * project IDs `ownedNFTProjectIds` to mint on project `projectId`.
+     * `ownedNFTAddresses` assumed to be aligned with `ownedNFTProjectIds`.
+     * e.g. Removes holders of project `ownedNFTProjectIds[0]` on token
+     * contract `ownedNFTAddresses[0]` from mint allowlist.
+     * @param projectId Project ID to remove holders for.
+     * @param coreContract Core contract address to remove holders for.
+     * @param ownedNFTAddresses NFT core addresses of projects to be removed
+     * from allowlist. Indexes align with `ownedNFTProjectIds`.
+     * @param ownedNFTProjectIds Project IDs on `ownedNFTAddresses` whose
+     * holders will be removed from allowlist to mint project `projectId`.
+     * Indexes align with `ownedNFTAddresses`.
+     */
+    event RemovedHoldersOfProjects(
+        uint256 indexed projectId,
+        address indexed coreContract,
+        address[] ownedNFTAddresses,
+        uint256[] ownedNFTProjectIds
+    );
+
+    // position of Token Holder Lib storage, using a diamond storage pattern
+    // for this library
+    bytes32 constant TOKEN_HOLDER_LIB_STORAGE_POSITION =
+        keccak256("tokenholderlib.storage");
 
     struct HolderProjectConfig {
         // projects whose holders are allowed to purchase a token on `projectId`
-        // ownedNFTAddress => ownedNFTProjectIds => bool
-        mapping(address => mapping(uint256 => bool)) allowedProjectHolders;
+        mapping(address ownedNFTAddress => mapping(uint256 ownedNFTProjectId => bool allowed)) allowedProjectHolders;
+    }
+
+    // Diamond storage pattern is used in this library
+    struct TokenHolderLibStorage {
+        mapping(address coreContract => mapping(uint256 projectId => HolderProjectConfig)) holderProjectConfigs;
     }
 
     /**
-     * @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`.
+     * @notice Allows holders of specific project tokens.
+     * @param projectId Project ID to allowlist holders for.
+     * @param coreContract Core contract address to allowlist holders for.
+     * @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
+        uint256 projectId,
+        address coreContract,
+        address[] calldata ownedNFTAddresses,
+        uint256[] calldata ownedNFTProjectIds
     ) internal {
         require(
-            _ownedNFTAddresses.length == _ownedNFTProjectIds.length,
+            ownedNFTAddresses.length == ownedNFTProjectIds.length,
             "TokenHolderLib: arrays neq length"
         );
-        for (uint256 i = 0; i < _ownedNFTAddresses.length; i++) {
-            holderProjectConfig.allowedProjectHolders[_ownedNFTAddresses[i]][
-                _ownedNFTProjectIds[i]
+        HolderProjectConfig
+            storage holderProjectConfig = getHolderProjectConfig({
+                projectId: projectId,
+                coreContract: coreContract
+            });
+        uint256 ownedNFTLoopLength = ownedNFTAddresses.length;
+        for (uint256 i; i < ownedNFTLoopLength; ) {
+            holderProjectConfig.allowedProjectHolders[ownedNFTAddresses[i]][
+                ownedNFTProjectIds[i]
             ] = true;
+            // gas-efficient loop increment
+            unchecked {
+                ++i;
+            }
         }
+        // emit approve event
+        emit AllowedHoldersOfProjects({
+            projectId: projectId,
+            coreContract: coreContract,
+            ownedNFTAddresses: ownedNFTAddresses,
+            ownedNFTProjectIds: ownedNFTProjectIds
+        });
     }
 
     /**
-     * @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`.
+     * @notice Removes holders of specific project tokens.
+     * @param projectId Project ID to remove holders for.
+     * @param coreContract Core contract address to remove holders for.
+     * @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
+        uint256 projectId,
+        address coreContract,
+        address[] calldata ownedNFTAddresses,
+        uint256[] calldata ownedNFTProjectIds
     ) internal {
         require(
-            _ownedNFTAddresses.length == _ownedNFTProjectIds.length,
+            ownedNFTAddresses.length == ownedNFTProjectIds.length,
             "TokenHolderLib: arrays neq length"
         );
-        for (uint256 i = 0; i < _ownedNFTAddresses.length; i++) {
-            holderProjectConfig.allowedProjectHolders[_ownedNFTAddresses[i]][
-                _ownedNFTProjectIds[i]
+        HolderProjectConfig
+            storage holderProjectConfig = getHolderProjectConfig({
+                projectId: projectId,
+                coreContract: coreContract
+            });
+        uint256 ownedNFTLoopLength = ownedNFTAddresses.length;
+        for (uint256 i; i < ownedNFTLoopLength; ) {
+            holderProjectConfig.allowedProjectHolders[ownedNFTAddresses[i]][
+                ownedNFTProjectIds[i]
             ] = false;
+            // gas-efficient loop increment
+            unchecked {
+                ++i;
+            }
         }
+        // emit removed event
+        emit RemovedHoldersOfProjects({
+            projectId: projectId,
+            coreContract: coreContract,
+            ownedNFTAddresses: ownedNFTAddresses,
+            ownedNFTProjectIds: ownedNFTProjectIds
+        });
     }
 
     /**
-     * @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
+     * @notice Allows and removes holders of specific project tokens in one
+     * operation.
+     * @param projectId Project ID to modify holders for.
+     * @param coreContract Core contract address to modify holders for.
+     * @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`.
+     * `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
+        uint256 projectId,
+        address coreContract,
+        address[] calldata ownedNFTAddressesAdd,
+        uint256[] calldata ownedNFTProjectIdsAdd,
+        address[] calldata ownedNFTAddressesRemove,
+        uint256[] calldata ownedNFTProjectIdsRemove
     ) internal {
-        allowHoldersOfProjects(
-            holderProjectConfig,
-            _ownedNFTAddressesAdd,
-            _ownedNFTProjectIdsAdd
-        );
-        removeHoldersOfProjects(
-            holderProjectConfig,
-            _ownedNFTAddressesRemove,
-            _ownedNFTProjectIdsRemove
-        );
+        allowHoldersOfProjects({
+            projectId: projectId,
+            coreContract: coreContract,
+            ownedNFTAddresses: ownedNFTAddressesAdd,
+            ownedNFTProjectIds: ownedNFTProjectIdsAdd
+        });
+        removeHoldersOfProjects({
+            projectId: projectId,
+            coreContract: coreContract,
+            ownedNFTAddresses: ownedNFTAddressesRemove,
+            ownedNFTProjectIds: ownedNFTProjectIdsRemove
+        });
     }
 
     /**
@@ -120,34 +218,75 @@ library TokenHolderLib {
      * 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.
+     * @param ownedNFTAddress ERC-721 NFT token address to be checked.
+     * @param ownedNFTTokenId ERC-721 NFT token ID to be checked.
+     * @param targetOwner Target owner address to check.
      */
     function validateNFTOwnership(
-        address _ownedNFTAddress,
-        uint256 _ownedNFTTokenId,
-        address _targetOwner
+        address ownedNFTAddress,
+        uint256 ownedNFTTokenId,
+        address targetOwner
     ) internal view {
-        address actualNFTOwner = IERC721(_ownedNFTAddress).ownerOf(
-            _ownedNFTTokenId
+        address actualNFTOwner = IERC721(ownedNFTAddress).ownerOf(
+            ownedNFTTokenId
         );
-        require(actualNFTOwner == _targetOwner, "Only owner of NFT");
+        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.
+     * @notice Checks if a specific NFT is allowlisted.
+     * @param projectId Project ID to be checked.
+     * @param coreContract Core contract address to be checked.
+     * @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
+        uint256 projectId,
+        address coreContract,
+        address ownedNFTAddress,
+        uint256 ownedNFTTokenId
     ) internal view returns (bool) {
-        uint256 ownedNFTProjectId = _ownedNFTTokenId / ONE_MILLION;
+        HolderProjectConfig
+            storage holderProjectConfig = getHolderProjectConfig({
+                projectId: projectId,
+                coreContract: coreContract
+            });
+        uint256 ownedNFTProjectId = ABHelpers.tokenIdToProjectId(
+            ownedNFTTokenId
+        );
         return
-            holderProjectConfig.allowedProjectHolders[_ownedNFTAddress][
+            holderProjectConfig.allowedProjectHolders[ownedNFTAddress][
                 ownedNFTProjectId
             ];
     }
+
+    /**
+     * @notice Loads the HolderProjectConfig for a given project and core
+     * contract.
+     * @param projectId Project Id to get config for
+     * @param coreContract Core contract address to get config for
+     */
+    function getHolderProjectConfig(
+        uint256 projectId,
+        address coreContract
+    ) internal view returns (HolderProjectConfig storage) {
+        return s().holderProjectConfigs[coreContract][projectId];
+    }
+
+    /**
+     * @notice Return the storage struct for reading and writing. This library
+     * uses a diamond storage pattern when managing storage.
+     * @return storageStruct The SetPriceLibStorage struct.
+     */
+    function s()
+        internal
+        pure
+        returns (TokenHolderLibStorage storage storageStruct)
+    {
+        bytes32 position = TOKEN_HOLDER_LIB_STORAGE_POSITION;
+        assembly ("memory-safe") {
+            storageStruct.slot := position
+        }
+    }
 }