@artblocks/contracts 1.0.0 → 1.0.2

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

@@ -6,6 +6,8 @@ import "../../interfaces/0.8.x/IFilteredMinterV0.sol";
 import "../../interfaces/0.8.x/IAdminACLV0.sol";
 import "../../interfaces/0.8.x/IGenArt721CoreContractV3.sol";
 
+import "../../libs/0.8.x/Bytes32Strings.sol";
+
 import "@openzeppelin-4.5/contracts/utils/structs/EnumerableMap.sol";
 
 pragma solidity 0.8.17;
@@ -25,8 +27,8 @@ pragma solidity 0.8.17;
  * ----------------------------------------------------------------------------
  * The following functions are restricted to the core contract's Admin ACL
  * contract:
- * - addApprovedMinters
- * - removeApprovedMinters
+ * - addApprovedMinter
+ * - removeApprovedMinter
  * - removeMintersForProjects
  * ----------------------------------------------------------------------------
  * The following functions are restricted to the core contract's Admin ACL
@@ -39,6 +41,21 @@ pragma solidity 0.8.17;
 contract MinterFilterV1 is IMinterFilterV0 {
     // add Enumerable Map methods
     using EnumerableMap for EnumerableMap.UintToAddressMap;
+    // add Bytes32Strings methods
+    using Bytes32Strings for bytes32;
+
+    /// version & type of this core contract
+    bytes32 constant MINTER_FILTER_VERSION = "v1.0.1";
+
+    function minterFilterVersion() external pure returns (string memory) {
+        return MINTER_FILTER_VERSION.toString();
+    }
+
+    bytes32 constant MINTER_FILTER_TYPE = "MinterFilterV1";
+
+    function minterFilterType() external pure returns (string memory) {
+        return MINTER_FILTER_TYPE.toString();
+    }
 
     /// Core contract address this minter interacts with
     address public immutable genArt721CoreAddress;
@@ -55,45 +72,43 @@ contract MinterFilterV1 is IMinterFilterV0 {
     /// minter address => is an approved minter?
     mapping(address => bool) public isApprovedMinter;
 
-    modifier onlyNonZeroAddress(address _address) {
+    function _onlyNonZeroAddress(address _address) internal pure {
         require(_address != address(0), "Must input non-zero address");
-        _;
     }
 
-    // modifier to restrict access to only AdminACL allowed calls
+    // function to restrict access to only AdminACL allowed calls
     // @dev defers which ACL contract is used to the core contract
-    modifier onlyCoreAdminACL(bytes4 _selector) {
+    function _onlyCoreAdminACL(bytes4 _selector) internal {
         require(_coreAdminACLAllowed(_selector), "Only Core AdminACL allowed");
-        _;
     }
 
-    // modifier to restrict access to only the artist of `_projectId`, or
+    // function to restrict access to only the artist of `_projectId`, or
     // AdminACL allowed calls
     // @dev defers which ACL contract is used to the core contract
-    modifier onlyCoreAdminACLOrArtist(uint256 _projectId, bytes4 _selector) {
+    function _onlyCoreAdminACLOrArtist(
+        uint256 _projectId,
+        bytes4 _selector
+    ) internal {
         require(
             msg.sender ==
                 genArtCoreContract.projectIdToArtistAddress(_projectId) ||
                 _coreAdminACLAllowed(_selector),
             "Only Core AdminACL or Artist"
         );
-        _;
     }
 
-    modifier onlyValidProjectId(uint256 _projectId) {
+    function _onlyValidProjectId(uint256 _projectId) internal view {
         require(
             _projectId < genArtCoreContract.nextProjectId(),
             "Only existing projects"
         );
-        _;
     }
 
-    modifier usingApprovedMinter(address _minterAddress) {
+    function _usingApprovedMinter(address _minterAddress) internal view {
         require(
             isApprovedMinter[_minterAddress],
             "Only approved minters are allowed"
         );
-        _;
     }
 
     /**
@@ -101,11 +116,11 @@ contract MinterFilterV1 is IMinterFilterV0 {
      * @param _genArt721Address Art Blocks core contract address
      * this contract will be a minter for. Can never be updated.
      */
-    constructor(
-        address _genArt721Address
-    ) onlyNonZeroAddress(_genArt721Address) {
+    constructor(address _genArt721Address) {
+        _onlyNonZeroAddress(_genArt721Address);
         genArt721CoreAddress = _genArt721Address;
         genArtCoreContract = IGenArt721CoreContractV3(_genArt721Address);
+        emit Deployed();
     }
 
     /**
@@ -126,13 +141,9 @@ contract MinterFilterV1 is IMinterFilterV0 {
      * @notice Approves minter `_minterAddress`.
      * @param _minterAddress Minter to be added as an approved minter.
      */
-    function addApprovedMinter(
-        address _minterAddress
-    )
-        external
-        onlyCoreAdminACL(this.addApprovedMinter.selector)
-        onlyNonZeroAddress(_minterAddress)
-    {
+    function addApprovedMinter(address _minterAddress) external {
+        _onlyCoreAdminACL(this.addApprovedMinter.selector);
+        _onlyNonZeroAddress(_minterAddress);
         isApprovedMinter[_minterAddress] = true;
         emit MinterApproved(
             _minterAddress,
@@ -144,9 +155,8 @@ contract MinterFilterV1 is IMinterFilterV0 {
      * @notice Removes previously approved minter `_minterAddress`.
      * @param _minterAddress Minter to remove.
      */
-    function removeApprovedMinter(
-        address _minterAddress
-    ) external onlyCoreAdminACL(this.removeApprovedMinter.selector) {
+    function removeApprovedMinter(address _minterAddress) external {
+        _onlyCoreAdminACL(this.removeApprovedMinter.selector);
         require(isApprovedMinter[_minterAddress], "Only approved minters");
         require(
             numProjectsUsingMinter[_minterAddress] == 0,
@@ -165,12 +175,13 @@ contract MinterFilterV1 is IMinterFilterV0 {
     function setMinterForProject(
         uint256 _projectId,
         address _minterAddress
-    )
-        external
-        onlyCoreAdminACLOrArtist(_projectId, this.setMinterForProject.selector)
-        usingApprovedMinter(_minterAddress)
-        onlyValidProjectId(_projectId)
-    {
+    ) external {
+        _onlyCoreAdminACLOrArtist(
+            _projectId,
+            this.setMinterForProject.selector
+        );
+        _usingApprovedMinter(_minterAddress);
+        _onlyValidProjectId(_projectId);
         // decrement number of projects using a previous minter
         (bool hasPreviousMinter, address previousMinter) = minterForProject
             .tryGet(_projectId);
@@ -192,15 +203,11 @@ contract MinterFilterV1 is IMinterFilterV0 {
      * @param _projectId Project ID to remove minter.
      * @dev requires project to have an assigned minter
      */
-    function removeMinterForProject(
-        uint256 _projectId
-    )
-        external
-        onlyCoreAdminACLOrArtist(
+    function removeMinterForProject(uint256 _projectId) external {
+        _onlyCoreAdminACLOrArtist(
             _projectId,
             this.removeMinterForProject.selector
-        )
-    {
+        );
         _removeMinterForProject(_projectId);
     }
 
@@ -210,9 +217,8 @@ contract MinterFilterV1 is IMinterFilterV0 {
      * @dev requires all project IDs to have an assigned minter
      * @dev caution with respect to single tx gas limits
      */
-    function removeMintersForProjects(
-        uint256[] calldata _projectIds
-    ) external onlyCoreAdminACL(this.removeMintersForProjects.selector) {
+    function removeMintersForProjects(uint256[] calldata _projectIds) external {
+        _onlyCoreAdminACL(this.removeMintersForProjects.selector);
         uint256 numProjects = _projectIds.length;
         for (uint256 i; i < numProjects; i++) {
             _removeMinterForProject(_projectIds[i]);
@@ -265,7 +271,8 @@ contract MinterFilterV1 is IMinterFilterV0 {
      */
     function getMinterForProject(
         uint256 _projectId
-    ) external view onlyValidProjectId(_projectId) returns (address) {
+    ) external view returns (address) {
+        _onlyValidProjectId(_projectId);
         (bool _hasMinter, address _currentMinter) = minterForProject.tryGet(
             _projectId
         );
@@ -278,9 +285,8 @@ contract MinterFilterV1 is IMinterFilterV0 {
      * @param _projectId Project ID to query.
      * @return bool true if project has an assigned minter, else false
      */
-    function projectHasMinter(
-        uint256 _projectId
-    ) external view onlyValidProjectId(_projectId) returns (bool) {
+    function projectHasMinter(uint256 _projectId) external view returns (bool) {
+        _onlyValidProjectId(_projectId);
         (bool _hasMinter, ) = minterForProject.tryGet(_projectId);
         return _hasMinter;
     }