@artblocks/contracts 1.0.2 → 1.0.4

package/contracts/{GenArt721CoreV3_Engine_Flex.sol → engine/V3/forks/GenArt721CoreV3_Engine_Flex_PROOF.sol}

@@ -1,19 +1,19 @@
 // SPDX-License-Identifier: LGPL-3.0-only
-pragma solidity 0.8.17;
+pragma solidity 0.8.19;
 
 // Created By: Art Blocks Inc.
 
-import "./interfaces/0.8.x/IRandomizerV2.sol";
-import "./interfaces/0.8.x/IAdminACLV0.sol";
-import "./interfaces/0.8.x/IEngineRegistryV0.sol";
-import "./interfaces/0.8.x/IGenArt721CoreContractV3_Engine_Flex.sol";
-import "./interfaces/0.8.x/IDependencyRegistryCompatibleV0.sol";
-import "./interfaces/0.8.x/IManifold.sol";
+import "../../../interfaces/v0.8.x/IRandomizerV2.sol";
+import "../../../interfaces/v0.8.x/IAdminACLV0.sol";
+import "../../../interfaces/v0.8.x/IEngineRegistryV0.sol";
+import "../../../interfaces/v0.8.x/IGenArt721CoreContractV3_Engine_Flex.sol";
+import "../../../interfaces/v0.8.x/IDependencyRegistryCompatibleV0.sol";
+import "../../../interfaces/v0.8.x/IManifold.sol";
 
 import "@openzeppelin-4.7/contracts/access/Ownable.sol";
-import "./libs/0.8.x/ERC721_PackedHashSeed.sol";
-import "./libs/0.8.x/BytecodeStorage.sol";
-import "./libs/0.8.x/Bytes32Strings.sol";
+import "../../../libs/v0.8.x/ERC721_PackedHashSeed.sol";
+import "../../../libs/v0.8.x/BytecodeStorageV1.sol";
+import "../../../libs/v0.8.x/Bytes32Strings.sol";
 
 /**
  * @title Art Blocks Engine Flex ERC-721 core contract, V3.
@@ -54,7 +54,8 @@ import "./libs/0.8.x/Bytes32Strings.sol";
  * - updateProjectScriptType
  * - updateProjectAspectRatio
  * ----------------------------------------------------------------------------
- * The following functions are restricted to only the Artist address:
+ * The following functions are restricted to only the Artist or Admin ACL
+ * contract of a valid project ID:
  * - proposeArtistPaymentAddressesAndSplits (Note that this has to be accepted
  *   by adminAcceptArtistAddressesAndSplits to take effect, which is restricted
  *   to the Admin ACL contract, or the artist if the core contract owner has
@@ -64,7 +65,7 @@ import "./libs/0.8.x/Bytes32Strings.sol";
  *   if the global config `autoApproveArtistSplitProposals` is set to `true`.)
  * - toggleProjectIsPaused (note the artist can still mint while paused)
  * - updateProjectSecondaryMarketRoyaltyPercentage (up to
-     ARTIST_MAX_SECONDARY_ROYALTY_PERCENTAGE percent)
+ *   ARTIST_MAX_SECONDARY_ROYALTY_PERCENTAGE percent)
  * - updateProjectWebsite
  * - updateProjectMaxInvocations (to a number greater than or equal to the
  *   current number of invocations, and less than current project maximum
@@ -83,7 +84,7 @@ import "./libs/0.8.x/Bytes32Strings.sol";
  * ----------------------------------------------------------------------------
  * The following functions for managing external asset dependencies are restricted
  * to projects with external asset dependencies that are unlocked:
- * - lockProjectExternalAssetDependencies 
+ * - lockProjectExternalAssetDependencies
  * - updateProjectExternalAssetDependency
  * - removeProjectExternalAssetDependency
  * - addProjectExternalAssetDependency
@@ -99,16 +100,16 @@ import "./libs/0.8.x/Bytes32Strings.sol";
  * Additional admin and artist privileged roles may be described on minters,
  * registries, and other contracts that may interact with this core contract.
  */
-contract GenArt721CoreV3_Engine_Flex is
+contract GenArt721CoreV3_Engine_Flex_PROOF is
     ERC721_PackedHashSeed,
     Ownable,
     IDependencyRegistryCompatibleV0,
     IManifold,
     IGenArt721CoreContractV3_Engine_Flex
 {
-    using BytecodeStorage for string;
-    using BytecodeStorage for address;
+    using BytecodeStorageWriter for string;
     using Bytes32Strings for bytes32;
+
     uint256 constant ONE_HUNDRED = 100;
     uint256 constant ONE_MILLION = 1_000_000;
     uint24 constant ONE_MILLION_UINT24 = 1_000_000;
@@ -214,6 +215,7 @@ contract GenArt721CoreV3_Engine_Flex is
         uint8 additionalPayeePrimarySalesPercentage;
     }
     // Project financials mapping
+
     mapping(uint256 => ProjectFinance) projectIdToFinancials;
 
     /// hash of artist's proposed payment updates to be approved by admin
@@ -326,13 +328,6 @@ contract GenArt721CoreV3_Engine_Flex is
         );
     }
 
-    function _onlyArtist(uint256 _projectId) internal view {
-        require(
-            msg.sender == projectIdToFinancials[_projectId].artistAddress,
-            "Only artist"
-        );
-    }
-
     function _onlyArtistOrAdminACL(
         uint256 _projectId,
         bytes4 _selector
@@ -901,7 +896,10 @@ contract GenArt721CoreV3_Engine_Flex is
         uint256 _additionalPayeeSecondarySalesPercentage
     ) external {
         _onlyValidProjectId(_projectId);
-        _onlyArtist(_projectId);
+        _onlyArtistOrAdminACL(
+            _projectId,
+            this.proposeArtistPaymentAddressesAndSplits.selector
+        );
         _onlyNonZeroAddress(_artistAddress);
         ProjectFinance storage projectFinance = projectIdToFinancials[
             _projectId
@@ -1088,7 +1086,8 @@ contract GenArt721CoreV3_Engine_Flex is
      * @param _projectId Project ID to be toggled.
      */
     function toggleProjectIsPaused(uint256 _projectId) external {
-        _onlyArtist(_projectId);
+        _onlyValidProjectId(_projectId);
+        _onlyArtistOrAdminACL(_projectId, this.toggleProjectIsPaused.selector);
         projects[_projectId].paused = !projects[_projectId].paused;
         emit ProjectUpdated(_projectId, FIELD_PROJECT_PAUSED);
     }
@@ -1178,7 +1177,11 @@ contract GenArt721CoreV3_Engine_Flex is
         uint256 _projectId,
         uint256 _secondMarketRoyalty
     ) external {
-        _onlyArtist(_projectId);
+        _onlyValidProjectId(_projectId);
+        _onlyArtistOrAdminACL(
+            _projectId,
+            this.updateProjectSecondaryMarketRoyaltyPercentage.selector
+        );
         require(
             _secondMarketRoyalty <= ARTIST_MAX_SECONDARY_ROYALTY_PERCENTAGE,
             "Over max percent"
@@ -1227,7 +1230,8 @@ contract GenArt721CoreV3_Engine_Flex is
         uint256 _projectId,
         string memory _projectWebsite
     ) external {
-        _onlyArtist(_projectId);
+        _onlyValidProjectId(_projectId);
+        _onlyArtistOrAdminACL(_projectId, this.updateProjectWebsite.selector);
         projects[_projectId].website = _projectWebsite;
         emit ProjectUpdated(_projectId, FIELD_PROJECT_WEBSITE);
     }
@@ -1261,7 +1265,11 @@ contract GenArt721CoreV3_Engine_Flex is
         uint256 _projectId,
         uint24 _maxInvocations
     ) external {
-        _onlyArtist(_projectId);
+        _onlyValidProjectId(_projectId);
+        _onlyArtistOrAdminACL(
+            _projectId,
+            this.updateProjectMaxInvocations.selector
+        );
         // CHECKS
         Project storage project = projects[_projectId];
         uint256 _invocations = project.invocations;
@@ -1434,7 +1442,8 @@ contract GenArt721CoreV3_Engine_Flex is
         uint256 _projectId,
         string memory _newBaseURI
     ) external {
-        _onlyArtist(_projectId);
+        _onlyValidProjectId(_projectId);
+        _onlyArtistOrAdminACL(_projectId, this.updateProjectBaseURI.selector);
         _onlyNonEmptyString(_newBaseURI);
         projects[_projectId].projectBaseURI = _newBaseURI;
         emit ProjectUpdated(_projectId, FIELD_PROJECT_BASE_URI);
@@ -1763,7 +1772,7 @@ contract GenArt721CoreV3_Engine_Flex is
         if (_index >= project.scriptCount) {
             return "";
         }
-        return project.scriptBytecodeAddresses[_index].readFromBytecode();
+        return _readFromBytecode(project.scriptBytecodeAddresses[_index]);
     }
 
     /**
@@ -1994,7 +2003,7 @@ contract GenArt721CoreV3_Engine_Flex is
                 bytecodeAddress: _bytecodeAddress,
                 data: (_dependency.dependencyType ==
                     ExternalAssetDependencyType.ONCHAIN)
-                    ? _bytecodeAddress.readFromBytecode()
+                    ? _readFromBytecode(_bytecodeAddress)
                     : ""
             });
     }
@@ -2217,6 +2226,16 @@ contract GenArt721CoreV3_Engine_Flex is
                 FOUR_WEEKS_IN_SECONDS);
     }
 
+    /**
+     * Helper for calling `BytecodeStorageReader` external library reader method,
+     * added for bytecode size reduction purposes.
+     */
+    function _readFromBytecode(
+        address _address
+    ) internal view returns (string memory) {
+        return BytecodeStorageReader.readFromBytecode(_address);
+    }
+
     // strings library from OpenZeppelin, modified for no constants
 
     bytes16 private _HEX_SYMBOLS = "0123456789abcdef";

package/contracts/engine/V3/forks/PROHIBITION/AdminACLV0_PROHIBITION.sol

@@ -0,0 +1,281 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity 0.8.19;
+
+import "./interfaces/IAdminACLV0_PROHIBITION.sol";
+import "../../../../interfaces/v0.8.x/IGenArt721CoreContractV3_Base.sol";
+
+import "@openzeppelin-4.7/contracts/access/Ownable.sol";
+import "@openzeppelin-4.7/contracts/utils/introspection/ERC165.sol";
+
+/**
+ * @title Admin ACL contract, V0.
+ * @author Art Blocks Inc.
+ * @notice Privileged Roles and Ownership:
+ * This contract has a single superAdmin that passes all ACL checks. All checks
+ * for any other address will return false.
+ * The superAdmin can be changed by the current superAdmin.
+ * Care must be taken to ensure that the admin ACL contract is secure behind a
+ * multi-sig or other secure access control mechanism.
+ */
+contract AdminACLV0_PROHIBITION is IAdminACLV0_PROHIBITION, ERC165 {
+    string public AdminACLType = "AdminACLV0_PROHIBITION";
+
+    /// superAdmin is the only address that passes any and all ACL checks
+    address public superAdmin;
+
+    /// contractSelectorApprovals is a mapping of:
+    ///   keccak256(contracts, selectors, account) -> approved to call.
+    /// It is used to determine if an account is approved to call a function on specific contracts.
+    mapping(bytes32 => bool) contractSelectorApprovals;
+
+    /// contractArtistApprovals is a mapping of:
+    ///   keccak256(contracts, artist) -> approved to call.
+    /// It is used to determine if an account is approved to call a functions for specific projects.
+    mapping(bytes32 => bool) contractArtistApprovals;
+
+    constructor() {
+        superAdmin = msg.sender;
+    }
+
+    /**
+     * @notice Allows superAdmin change the superAdmin address.
+     * @param _newSuperAdmin The new superAdmin address.
+     * @param _genArt721CoreAddressesToUpdate Array of genArt721Core
+     * addresses to update to the new superAdmin, for indexing purposes only.
+     * @dev this function is gated to only superAdmin address.
+     */
+    function changeSuperAdmin(
+        address _newSuperAdmin,
+        address[] calldata _genArt721CoreAddressesToUpdate
+    ) external {
+        require(msg.sender == superAdmin, "Only superAdmin");
+        address previousSuperAdmin = superAdmin;
+        superAdmin = _newSuperAdmin;
+        emit SuperAdminTransferred(
+            previousSuperAdmin,
+            _newSuperAdmin,
+            _genArt721CoreAddressesToUpdate
+        );
+    }
+
+    /**
+     * Calls transferOwnership on other contract from this contract.
+     * This is useful for updating to a new AdminACL contract.
+     * @param _contract The contract address.
+     * @param _newAdminACL The new AdminACL contract address.
+     * @dev This function is gated to only superAdmin address.
+     * @dev This implementation requires that the new AdminACL contract
+     * broadcasts support of IAdminACLV0 via ERC165 interface detection.
+     */
+    function transferOwnershipOn(
+        address _contract,
+        address _newAdminACL
+    ) external {
+        require(msg.sender == superAdmin, "Only superAdmin");
+        // ensure new AdminACL contract supports IAdminACLV0
+        require(
+            ERC165(_newAdminACL).supportsInterface(
+                type(IAdminACLV0).interfaceId
+            ),
+            "AdminACLV0: new admin ACL does not support IAdminACLV0"
+        );
+        Ownable(_contract).transferOwnership(_newAdminACL);
+    }
+
+    /**
+     * @notice Calls renounceOwnership on other contract from this contract.
+     * @param _contract The contract address.
+     * @dev this function is gated to only superAdmin address.
+     */
+    function renounceOwnershipOn(address _contract) external {
+        require(msg.sender == superAdmin, "Only superAdmin");
+        Ownable(_contract).renounceOwnership();
+    }
+
+    /**
+     * @notice Retrieve the address of the caller that is allowed to call a contract's function
+     * @param _contract The contract address.
+     * @param _selector The function selector.
+     * @param _caller The caller address.
+     * @return isApproved The approval status.
+     */
+    function getContractSelectorApproval(
+        address _contract,
+        bytes4 _selector,
+        address _caller
+    ) public view returns (bool) {
+        return
+            contractSelectorApprovals[
+                hashSelectorApprovalKey(_contract, _selector, _caller)
+            ];
+    }
+
+    /**
+     * @notice Retrieve whether of the caller is allowed to call a functions for a project
+     * @param _contract The contract address.
+     * @param _caller The caller address.
+     * @return isApproved The approval status.
+     */
+    function getContractArtistApproval(
+        address _contract,
+        address _caller
+    ) public view returns (bool) {
+        return
+            contractArtistApprovals[hashArtistApprovalKey(_contract, _caller)];
+    }
+
+    /**
+     * @notice Toggles ability for caller to call specific function on a contract
+     * @param _contract The contract address.
+     * @param _selector The function selector.
+     * @param _caller The caller address.
+     * @dev this function is gated to only allwed addressed.
+     */
+    function toggleContractSelectorApproval(
+        address _contract,
+        bytes4 _selector,
+        address _caller
+    ) external {
+        require(
+            allowed(
+                msg.sender,
+                address(this),
+                this.toggleContractSelectorApproval.selector
+            ),
+            "Only allowed caller"
+        );
+
+        bytes32 approvalHash = hashSelectorApprovalKey(
+            _contract,
+            _selector,
+            _caller
+        );
+        contractSelectorApprovals[approvalHash] = !contractSelectorApprovals[
+            approvalHash
+        ];
+        emit ContractSelectorApprovalUpdated(
+            _contract,
+            _selector,
+            _caller,
+            contractSelectorApprovals[approvalHash]
+        );
+    }
+
+    /**
+     * @notice Toggles verification for artists to call functions relating to their projects
+     * on a contract
+     * @param _contract The contract address.
+     * @param _caller The caller address.
+     * @dev this function is gated to only allwed addressed.
+     */
+    function toggleContractArtistApproval(
+        address _contract,
+        address _caller
+    ) external {
+        require(
+            allowed(
+                msg.sender,
+                address(this),
+                this.toggleContractArtistApproval.selector
+            ),
+            "Only allowed caller"
+        );
+
+        bytes32 approvalHash = hashArtistApprovalKey(_contract, _caller);
+        contractArtistApprovals[approvalHash] = !contractArtistApprovals[
+            approvalHash
+        ];
+        emit ContractArtistApprovalUpdated(
+            _contract,
+            _caller,
+            contractArtistApprovals[approvalHash]
+        );
+    }
+
+    /**
+     * @notice Checks if sender `_sender` is allowed to call function with method
+     * `_selector` on `_contract`. Returns true if sender is superAdmin.
+     * @param _sender The sender address.
+     * @param _contract The contract address.
+     * @param _selector The function selector.
+     * @return isApproved The approval status.
+     * @dev this function is public insteaad of internal so that the right to toggle approvals
+     * can also be delegated
+     */
+    function allowed(
+        address _sender,
+        address _contract,
+        bytes4 _selector
+    ) public view returns (bool) {
+        return
+            superAdmin == _sender ||
+            getContractSelectorApproval(_contract, _selector, _sender);
+    }
+
+    /**
+     * @notice Checks if sender `_sender` is allowed to call function (or functions) for projects
+     * `projectId` with method `_selector` on `_contract`. Returns true if sender is superAdmin.
+     * @param _sender The sender address.
+     * @param _contract The contract address.
+     * @param _selector The function selector.
+     * @param _projectId The project ID.
+     * @return isApproved The approval status.
+     * @dev this function is public insteaad of internal so that the right to toggle approvals
+     * can also be delegated
+     */
+    function allowed(
+        address _sender,
+        address _contract,
+        bytes4 _selector,
+        uint256 _projectId
+    ) external view returns (bool) {
+        IGenArt721CoreContractV3_Base coreV3 = IGenArt721CoreContractV3_Base(
+            _contract
+        );
+        return
+            allowed(_sender, _contract, _selector) ||
+            (getContractArtistApproval(_contract, _sender) &&
+                coreV3.projectIdToArtistAddress(_projectId) == _sender);
+    }
+
+    /**
+     * @notice Hash the contract address, selector, and caller address.
+     * @param _contract The contract address.
+     * @param _selector The function selector.
+     * @param _caller The caller address.
+     * @return hash The hash.
+     */
+    function hashSelectorApprovalKey(
+        address _contract,
+        bytes4 _selector,
+        address _caller
+    ) public pure returns (bytes32) {
+        return keccak256(abi.encodePacked(_contract, _selector, _caller));
+    }
+
+    /**
+     * @notice Hash the contract address and artist address.
+     * @param _contract The contract address.
+     * @param _caller The artist address.
+     * @return hash The hash.
+     */
+    function hashArtistApprovalKey(
+        address _contract,
+        address _caller
+    ) public pure returns (bytes32) {
+        return keccak256(abi.encodePacked(_contract, _caller));
+    }
+
+    /**
+     * @inheritdoc ERC165
+     */
+    function supportsInterface(
+        bytes4 interfaceId
+    ) public view virtual override(ERC165) returns (bool) {
+        return
+            interfaceId == type(IAdminACLV0_PROHIBITION).interfaceId ||
+            interfaceId == type(IAdminACLV0).interfaceId ||
+            super.supportsInterface(interfaceId);
+    }
+}