@artblocks/contracts 1.0.4 → 1.2.0

package/contracts/engine/V3/forks/GenArt721CoreV3_Engine_Flex_PROOF.sol

@@ -5,8 +5,7 @@ pragma solidity 0.8.19;
 
 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/IGenArt721CoreContractV3_Engine_Flex_PreV3p2.sol";
 import "../../../interfaces/v0.8.x/IDependencyRegistryCompatibleV0.sol";
 import "../../../interfaces/v0.8.x/IManifold.sol";
 
@@ -44,7 +43,7 @@ import "../../../libs/v0.8.x/Bytes32Strings.sol";
  * - updateIPFSGateway
  * - updateArweaveGateway
  * ----------------------------------------------------------------------------
- * The following functions are restricted to either the the Artist address or
+ * The following functions are restricted to either the Artist address or
  * the Admin ACL contract, only when the project is not locked:
  * - updateProjectName
  * - updateProjectArtistName
@@ -105,7 +104,7 @@ contract GenArt721CoreV3_Engine_Flex_PROOF is
     Ownable,
     IDependencyRegistryCompatibleV0,
     IManifold,
-    IGenArt721CoreContractV3_Engine_Flex
+    IGenArt721CoreContractV3_Engine_Flex_PreV3p2
 {
     using BytecodeStorageWriter for string;
     using Bytes32Strings for bytes32;
@@ -272,7 +271,7 @@ contract GenArt721CoreV3_Engine_Flex_PROOF is
     bool public immutable autoApproveArtistSplitProposals;
 
     /// version & type of this core contract
-    bytes32 constant CORE_VERSION = "v3.1.2";
+    bytes32 constant CORE_VERSION = "v3.1.6";
 
     function coreVersion() external pure returns (string memory) {
         return CORE_VERSION.toString();
@@ -381,8 +380,7 @@ contract GenArt721CoreV3_Engine_Flex_PROOF is
         address _randomizerContract,
         address _adminACLContract,
         uint248 _startingProjectId,
-        bool _autoApproveArtistSplitProposals,
-        address _engineRegistryContract
+        bool _autoApproveArtistSplitProposals
     ) ERC721_PackedHashSeed(_tokenName, _tokenSymbol) {
         _onlyNonZeroAddress(_renderProviderAddress);
         _onlyNonZeroAddress(_platformProviderAddress);
@@ -413,12 +411,8 @@ contract GenArt721CoreV3_Engine_Flex_PROOF is
         // initialize next project ID
         _nextProjectId = _startingProjectId;
         emit PlatformUpdated(FIELD_NEXT_PROJECT_ID);
-        // register contract as an Engine contract
-        IEngineRegistryV0(_engineRegistryContract).registerContract(
-            address(this),
-            CORE_VERSION,
-            CORE_TYPE
-        );
+        // @dev follow-on action: This contract does not self-register. A core
+        // registry owner must register contract in a subsequent call.
     }
 
     /**

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

@@ -7,7 +7,6 @@ import "./interfaces/IAdminACLV0_PROHIBITION.sol";
 import "./interfaces/IGenArt721CoreContractV3_Engine_Flex_PROHIBITION.sol";
 
 import "../../../../interfaces/v0.8.x/IRandomizerV2.sol";
-import "../../../../interfaces/v0.8.x/IEngineRegistryV0.sol";
 import "../../../../interfaces/v0.8.x/IDependencyRegistryCompatibleV0.sol";
 import "../../../../interfaces/v0.8.x/IManifold.sol";
 
@@ -45,7 +44,7 @@ import "../../../../libs/v0.8.x/Bytes32Strings.sol";
  * - updateIPFSGateway
  * - updateArweaveGateway
  * ----------------------------------------------------------------------------
- * The following functions are restricted to either the the Artist address or
+ * The following functions are restricted to either the Artist address or
  * the Admin ACL contract, only when the project is not locked:
  * - updateProjectName
  * - updateProjectArtistName
@@ -271,7 +270,7 @@ contract GenArt721CoreV3_Engine_Flex_PROHIBITION is
     bool public immutable autoApproveArtistSplitProposals;
 
     /// version & type of this core contract
-    bytes32 constant CORE_VERSION = "v3.1.3";
+    bytes32 constant CORE_VERSION = "v3.1.5";
 
     function coreVersion() external pure returns (string memory) {
         return CORE_VERSION.toString();
@@ -392,8 +391,7 @@ contract GenArt721CoreV3_Engine_Flex_PROHIBITION is
         address _randomizerContract,
         address _adminACLContract,
         uint248 _startingProjectId,
-        bool _autoApproveArtistSplitProposals,
-        address _engineRegistryContract
+        bool _autoApproveArtistSplitProposals
     ) ERC721_PackedHashSeed(_tokenName, _tokenSymbol) {
         _onlyNonZeroAddress(_renderProviderAddress);
         _onlyNonZeroAddress(_platformProviderAddress);
@@ -424,12 +422,8 @@ contract GenArt721CoreV3_Engine_Flex_PROHIBITION is
         // initialize next project ID
         _nextProjectId = _startingProjectId;
         emit PlatformUpdated(FIELD_NEXT_PROJECT_ID);
-        // register contract as an Engine contract
-        IEngineRegistryV0(_engineRegistryContract).registerContract(
-            address(this),
-            CORE_VERSION,
-            CORE_TYPE
-        );
+        // @dev follow-on action: This contract does not self-register. A core
+        // registry owner must register contract in a subsequent call.
     }
 
     /**

package/contracts/engine/V3/forks/PROHIBITION/interfaces/IGenArt721CoreContractV3_Engine_Flex_PROHIBITION.sol

@@ -4,7 +4,7 @@
 pragma solidity ^0.8.0;
 
 import "./IAdminACLV0_PROHIBITION.sol";
-import "../../../../../interfaces/v0.8.x/IGenArt721CoreContractV3_Engine_Flex.sol";
+import "../../../../../interfaces/v0.8.x/IGenArt721CoreContractV3_Engine_Flex_PreV3p2.sol";
 
 /**
  * @title This interface is intended to house interface items that are common
@@ -12,7 +12,7 @@ import "../../../../../interfaces/v0.8.x/IGenArt721CoreContractV3_Engine_Flex.so
  * @author Art Blocks Inc.
  */
 interface IGenArt721CoreContractV3_Engine_Flex_PROHIBITION is
-    IGenArt721CoreContractV3_Engine_Flex
+    IGenArt721CoreContractV3_Engine_Flex_PreV3p2
 {
     /**
      * Function determining if _sender is allowed to call function with

package/contracts/engine-registry/CoreRegistryV1.sol

@@ -1,10 +1,13 @@
 // SPDX-License-Identifier: MIT
 
+// @dev fixed to specific solidity version for clarity and for more clear
+// source code verification purposes.
 pragma solidity 0.8.19;
 
-import "../interfaces/v0.8.x/ICoreRegistryV1.sol";
-import "@openzeppelin-4.7/contracts/access/Ownable.sol";
-import "@openzeppelin-4.7/contracts/utils/structs/EnumerableSet.sol";
+import {ICoreRegistryV1} from "../interfaces/v0.8.x/ICoreRegistryV1.sol";
+
+import {Ownable} from "@openzeppelin-4.7/contracts/access/Ownable.sol";
+import {EnumerableSet} from "@openzeppelin-4.7/contracts/utils/structs/EnumerableSet.sol";
 
 /**
  * @title Art Blocks Core Contract Registry, V1.
@@ -57,20 +60,11 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
     using EnumerableSet for EnumerableSet.AddressSet;
 
     /// private enumerable set of registered contracts
-    EnumerableSet.AddressSet private registeredContracts;
+    EnumerableSet.AddressSet private _registeredContracts;
 
     /// private mapping of registered contract addresses to
     EnumerableSet.AddressSet
-        private registeredMinterFilterV2CompatibleContracts;
-
-    /**
-     * @notice Reverts if `tx.origin` is not the owner.
-     * @dev Warning that this check is only against tx.origin, which may be
-     * misleading when used for security.
-     */
-    function _onlyOwnerOrigin() internal view {
-        require(tx.origin == owner(), "Only tx origin of owner");
-    }
+        private _registeredMinterFilterV2CompatibleContracts;
 
     constructor() Ownable() {}
 
@@ -82,24 +76,19 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
      * registered.
      */
     function registerContract(
-        address _contractAddress,
-        bytes32 _coreVersion,
-        bytes32 _coreType
+        address contractAddress,
+        bytes32 coreVersion,
+        bytes32 coreType
     ) external {
         // CHECKS
-        // Validate against `tx.origin` rather than `msg.sender` as it is
-        // intended that this registration be performed in an automated
-        // fashion at the time of contract deployment of `_contractAddress`.
-        // @dev Security implications of using `tx.origin` are acknowledged
-        _onlyOwnerOrigin();
-        // only allow registration of a contract registering itself, or allow
-        // the owner to register any contract.
-        require(
-            msg.sender == _contractAddress || msg.sender == owner(),
-            "Only owner or registrant"
-        );
+        // revert if not called by owner
+        Ownable._checkOwner();
         // EFFECTS
-        _registerContract(_contractAddress, _coreVersion, _coreType);
+        _registerContract({
+            contractAddress: contractAddress,
+            coreVersion: coreVersion,
+            coreType: coreType
+        });
     }
 
     /**
@@ -108,12 +97,12 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
      * Reverts if authorization fails, or if the contract is not already
      * registered.
      */
-    function unregisterContract(address _contractAddress) external {
+    function unregisterContract(address contractAddress) external {
         // CHECKS
         // revert if not called by owner
         Ownable._checkOwner();
         // EFFECTS
-        _unregisterContract(_contractAddress);
+        _unregisterContract(contractAddress);
     }
 
     /**
@@ -122,32 +111,32 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
      * Reverts if any contract is already registered.
      * @dev This should primarily be used for backfilling the registry with
      * existing contracts shortly after deployment.
-     * @param _contractAddresses Array of contract addresses to register.
-     * @param _coreVersions Array of core versions for each contract (aligned).
-     * @param _coreTypes Array of core types for each contract (aligned).
+     * @param contractAddresses Array of contract addresses to register.
+     * @param coreVersions Array of core versions for each contract (aligned).
+     * @param coreTypes Array of core types for each contract (aligned).
      */
     function registerContracts(
-        address[] calldata _contractAddresses,
-        bytes32[] calldata _coreVersions,
-        bytes32[] calldata _coreTypes
+        address[] calldata contractAddresses,
+        bytes32[] calldata coreVersions,
+        bytes32[] calldata coreTypes
     ) external {
         // CHECKS
         // revert if not called by owner
         Ownable._checkOwner();
         // validate same length arrays
-        uint256 numContracts = _contractAddresses.length;
+        uint256 numContracts = contractAddresses.length;
         require(
-            numContracts == _coreVersions.length &&
-                numContracts == _coreTypes.length,
+            numContracts == coreVersions.length &&
+                numContracts == coreTypes.length,
             "Mismatched array lengths"
         );
         // EFFECTS
         for (uint256 i = 0; i < numContracts; ) {
-            _registerContract(
-                _contractAddresses[i],
-                _coreVersions[i],
-                _coreTypes[i]
-            );
+            _registerContract({
+                contractAddress: contractAddresses[i],
+                coreVersion: coreVersions[i],
+                coreType: coreTypes[i]
+            });
             unchecked {
                 ++i;
             }
@@ -158,18 +147,18 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
      * @notice Unregister multiple contracts at once.
      * Only callable by the owner.
      * Reverts if any contract is not already registered.
-     * @param _contractAddresses Array of contract addresses to unregister.
+     * @param contractAddresses Array of contract addresses to unregister.
      */
     function unregisterContracts(
-        address[] calldata _contractAddresses
+        address[] calldata contractAddresses
     ) external {
         // CHECKS
         // revert if not called by owner
         Ownable._checkOwner();
         // EFFECTS
-        uint256 numContracts = _contractAddresses.length;
+        uint256 numContracts = contractAddresses.length;
         for (uint256 i = 0; i < numContracts; ) {
-            _unregisterContract(_contractAddresses[i]);
+            _unregisterContract(contractAddresses[i]);
             unchecked {
                 ++i;
             }
@@ -181,18 +170,18 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
      * @return The number of registered contracts.
      */
     function getNumRegisteredContracts() external view returns (uint256) {
-        return registeredContracts.length();
+        return _registeredContracts.length();
     }
 
     /**
      * @notice Get the address of a registered contract by index.
-     * @param _index The index of the contract to get.
+     * @param index The index of the contract to get.
      * @return The address of the contract at the given index.
      */
     function getRegisteredContractAt(
-        uint256 _index
+        uint256 index
     ) external view returns (address) {
-        return registeredContracts.at(_index);
+        return _registeredContracts.at(index);
     }
 
     /**
@@ -207,19 +196,19 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
         view
         returns (address[] memory)
     {
-        return registeredContracts.values();
+        return _registeredContracts.values();
     }
 
     /**
      * @notice Returns boolean representing if contract is registered on this
      * registry.
-     * @param _contractAddress The address of the contract to check.
+     * @param contractAddress The address of the contract to check.
      * @return isRegistered True if the contract is registered.
      */
     function isRegisteredContract(
-        address _contractAddress
+        address contractAddress
     ) external view returns (bool isRegistered) {
-        return registeredContracts.contains(_contractAddress);
+        return _registeredContracts.contains(contractAddress);
     }
 
     /**
@@ -227,28 +216,32 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
      * Reverts if the contract is already registered.
      */
     function _registerContract(
-        address _contractAddress,
-        bytes32 _coreVersion,
-        bytes32 _coreType
+        address contractAddress,
+        bytes32 coreVersion,
+        bytes32 coreType
     ) internal {
         // @dev add returns true only if not already registered
         require(
-            registeredContracts.add(_contractAddress),
+            _registeredContracts.add(contractAddress),
             "Contract already registered"
         );
-        emit ContractRegistered(_contractAddress, _coreVersion, _coreType);
+        emit ContractRegistered({
+            _contractAddress: contractAddress,
+            _coreVersion: coreVersion,
+            _coreType: coreType
+        });
     }
 
     /**
      * @notice Internal function to unregister a contract.
      * Reverts if the contract is not already registered.
      */
-    function _unregisterContract(address _contractAddress) internal {
+    function _unregisterContract(address contractAddress) internal {
         // @dev remove returns true only if already in set
         require(
-            registeredContracts.remove(_contractAddress),
+            _registeredContracts.remove(contractAddress),
             "Only registered contracts"
         );
-        emit ContractUnregistered(_contractAddress);
+        emit ContractUnregistered({_contractAddress: contractAddress});
     }
 }

package/contracts/interfaces/v0.8.x/IAdminACLV0_Extended.sol

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import "./IAdminACLV0.sol";
+
+interface IAdminACLV0_Extended is IAdminACLV0 {
+    /**
+     * @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;
+}

package/contracts/interfaces/v0.8.x/IBytecodeStorageReaderV2.sol

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {IBytecodeStorageReader} from "./IBytecodeStorageReader.sol";
+
+/**
+ * @title Art Blocks Script Storage Library (Reader)
+ * @notice This interface defines the expected read functions for the Art Blocks Script Storage Library (Reader).
+ * @dev This interface extends the V1 interface to add a function to get if data are stored in compressed format,
+ * which is functionality added in the V2 format of the bytecode storage.
+ */
+interface IBytecodeStorageReaderV2 is IBytecodeStorageReader {
+    /**
+     * @notice Get if data are stored in compressed format for given contract bytecode
+     * @param _address address of deployed contract with bytecode stored in the V0, V1, or V2 format
+     * @return isCompressed boolean indicating if the stored data are compressed
+     */
+    function getIsCompressedForBytecode(
+        address _address
+    ) external view returns (bool);
+}

package/contracts/interfaces/v0.8.x/ICoreRegistryV1.sol

@@ -6,22 +6,20 @@ import "./IEngineRegistryV0.sol";
 
 interface ICoreRegistryV1 is IEngineRegistryV0 {
     function registerContracts(
-        address[] calldata _contractAddresses,
-        bytes32[] calldata _coreVersions,
-        bytes32[] calldata _coreTypes
+        address[] calldata contractAddresses,
+        bytes32[] calldata coreVersions,
+        bytes32[] calldata coreTypes
     ) external;
 
-    function unregisterContracts(
-        address[] calldata _contractAddresses
-    ) external;
+    function unregisterContracts(address[] calldata contractAddresses) external;
 
     function getNumRegisteredContracts() external view returns (uint256);
 
     function getRegisteredContractAt(
-        uint256 _index
+        uint256 index
     ) external view returns (address);
 
     function isRegisteredContract(
-        address _contractAddress
+        address contractAddress
     ) external view returns (bool isRegistered);
 }

package/contracts/interfaces/v0.8.x/IDependencyRegistryV0.sol

@@ -3,93 +3,98 @@
 pragma solidity ^0.8.19;
 
 interface IDependencyRegistryV0 {
-    event SupportedCoreContractAdded(address indexed _coreContractAddress);
+    event SupportedCoreContractAdded(address indexed coreContractAddress);
 
-    event SupportedCoreContractRemoved(address indexed _coreContractAddress);
+    event SupportedCoreContractRemoved(address indexed coreContractAddress);
 
-    event ProjectDependencyTypeOverrideAdded(
-        address indexed _coreContractAddress,
-        uint256 indexed _projectId,
-        bytes32 _dependencyType
+    event ProjectDependencyOverrideAdded(
+        address indexed coreContractAddress,
+        uint256 indexed projectId,
+        bytes32 dependencyNameAndVersion
     );
 
-    event ProjectDependencyTypeOverrideRemoved(
-        address indexed _coreContractAddress,
-        uint256 indexed _projectId
+    event ProjectDependencyOverrideRemoved(
+        address indexed coreContractAddress,
+        uint256 indexed projectId
     );
 
+    event LicenseTypeAdded(bytes32 indexed licenseType);
+
+    event LicenseTextUpdated(bytes32 indexed licenseType);
+
     event DependencyAdded(
-        bytes32 indexed _dependencyType,
-        string _preferredCDN,
-        string _preferredRepository,
-        string _referenceWebsite
+        bytes32 indexed dependencyNameAndVersion,
+        bytes32 indexed licenseType,
+        string preferredCDN,
+        string preferredRepository,
+        string website
     );
 
-    event DependencyRemoved(bytes32 indexed _dependencyType);
+    event DependencyRemoved(bytes32 indexed dependencyNameAndVersion);
 
-    event DependencyReferenceWebsiteUpdated(
-        bytes32 indexed _dependencyType,
-        string _referenceWebsite
+    event DependencyWebsiteUpdated(
+        bytes32 indexed dependencyNameAndVersion,
+        string website
     );
 
     event DependencyPreferredCDNUpdated(
-        bytes32 indexed _dependencyType,
-        string _preferredCDN
+        bytes32 indexed dependencyNameAndVersion,
+        string preferredCDN
     );
 
     event DependencyPreferredRepositoryUpdated(
-        bytes32 indexed _dependencyType,
-        string _preferredRepository
+        bytes32 indexed dependencyNameAndVersion,
+        string preferredRepository
     );
 
     event DependencyAdditionalCDNUpdated(
-        bytes32 indexed _dependencyType,
-        string _additionalCDN,
-        uint256 _additionalCDNIndex
+        bytes32 indexed dependencyNameAndVersion,
+        string additionalCDN,
+        uint256 additionalCDNIndex
     );
 
     event DependencyAdditionalCDNRemoved(
-        bytes32 indexed _dependencyType,
-        uint256 indexed _additionalCDNIndex
+        bytes32 indexed dependencyNameAndVersion,
+        uint256 indexed additionalCDNIndex
     );
 
     event DependencyAdditionalRepositoryUpdated(
-        bytes32 indexed _dependencyType,
-        string _additionalRepository,
-        uint256 _additionalRepositoryIndex
+        bytes32 indexed dependencyNameAndVersion,
+        string additionalRepository,
+        uint256 additionalRepositoryIndex
     );
 
     event DependencyAdditionalRepositoryRemoved(
-        bytes32 indexed _dependencyType,
-        uint256 indexed _additionalRepositoryIndex
+        bytes32 indexed dependencyNameAndVersion,
+        uint256 indexed additionalRepositoryIndex
     );
 
-    event DependencyScriptUpdated(bytes32 indexed _dependencyType);
+    event DependencyScriptUpdated(bytes32 indexed dependencyNameAndVersion);
 
     /**
-     * @notice Returns the count of scripts for dependency `_dependencyType`.
-     * @param _dependencyType Dependency type to be queried.
+     * @notice Returns the count of scripts for dependency `dependencyNameAndVersion`.
+     * @param dependencyNameAndVersion Dependency type to be queried.
      */
     function getDependencyScriptCount(
-        bytes32 _dependencyType
+        bytes32 dependencyNameAndVersion
     ) external view returns (uint256);
 
     /**
      * @notice Returns address with bytecode containing script for
-     * dependency type `_dependencyTypes` at script index `_index`.
+     * dependency type `dependencyNameAndVersions` at script index `index`.
      */
     function getDependencyScriptBytecodeAddress(
-        bytes32 _dependencyType,
-        uint256 _index
+        bytes32 dependencyNameAndVersion,
+        uint256 index
     ) external view returns (address);
 
     /**
-     * @notice Returns script for dependency type `_dependencyType` at script index `_index`.
-     * @param _dependencyType Dependency type to be queried.
-     * @param _index Index of script to be queried.
+     * @notice Returns script for dependency type `dependencyNameAndVersion` at script index `index`.
+     * @param dependencyNameAndVersion Dependency type to be queried.
+     * @param index Index of script to be queried.
      */
     function getDependencyScript(
-        bytes32 _dependencyType,
-        uint256 _index
+        bytes32 dependencyNameAndVersion,
+        uint256 index
     ) external view returns (string memory);
 }