@artblocks/contracts 1.1.0 → 1.2.0

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

@@ -5,7 +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/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";
 
@@ -43,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
@@ -104,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;

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

@@ -44,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

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/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/IDependencyRegistryV0.sol

@@ -3,96 +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 LicenseTypeAdded(bytes32 indexed licenseType);
+
+    event LicenseTextUpdated(bytes32 indexed licenseType);
 
     event DependencyAdded(
-        bytes32 indexed _dependencyType,
-        bytes32 indexed _licenseType,
-        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);
 }

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

@@ -0,0 +1,124 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {EngineConfiguration} from "./IGenArt721CoreContractV3_Engine.sol";
+
+interface IEngineFactoryV0 {
+    /// @notice Engine Core type
+    enum EngineCoreType {
+        Engine, // GenArt721CoreV3_Engine Contract
+        EngineFlex // GenArt721CoreV3_Engine_Flex Contract
+    }
+    /**
+     * @notice This contract was deployed.
+     * @param engineImplementation address with the implementation of the Engine contract
+     * @param engineFlexImplementation address with the implementation of the Engine Flex contract
+     * @param type_ type of this contract
+     */
+    event Deployed(
+        address indexed engineImplementation,
+        address indexed engineFlexImplementation,
+        bytes32 indexed type_
+    );
+    /**
+     * @notice New Engine or Engine Flex contract was created.
+     * @param engineContract address of the newly created Engine contract
+     */
+    event EngineContractCreated(address indexed engineContract);
+    /**
+     * @notice This contract was abandoned and no longer can be used to create
+     * new Engine or Engine Flex contracts.
+     */
+    event Abandoned();
+
+    /**
+     * @notice Creates a new Engine or Engine Flex contract with the provided
+     * `engineConfiguration`, depending on the `engineCoreContractType`.
+     * @param engineCoreContractType Type of Engine Core contract.
+     * @param engineConfiguration EngineConfiguration data to configure the
+     * contract with.
+     * @param adminACLContract Address of admin access control contract, to be
+     * set as contract owner. A new contract will be deployed if address is null.
+     * @param salt Salt used to deterministically deploy the clone.
+     * @return engineContract The address of the newly created Engine or Engine Flex
+     * contract. The address is also emitted in both the `EngineCreated` and
+     * `EngineFlexCreated` events.
+     */
+    function createEngineContract(
+        EngineCoreType engineCoreContractType,
+        EngineConfiguration calldata engineConfiguration,
+        address adminACLContract,
+        bytes32 salt
+    ) external returns (address engineContract);
+
+    /**
+     * @notice Drains the contract's balance to the `recipient`.
+     * @param recipient The address to send funds to.
+     * Only callable by the owner.
+     */
+    function drainETH(address payable recipient) external;
+
+    /**
+     * @notice Drains the contract's balance of an input ERC20 token to
+     * the `recipient`.
+     * @param ERC20TokenAddress The address of the ERC20 token to withdraw.
+     * @param recipient The address to send ERC20 tokens to.
+     * Only callable by the owner.
+     */
+    function drainERC20(address ERC20TokenAddress, address recipient) external;
+
+    /**
+     * @notice Calls transferOwnership on the core registry.
+     * Useful for updating the owner of the core registry contract.
+     * @param _owner address of the new owner
+     */
+    function transferCoreRegistryOwnership(address _owner) external;
+
+    /**
+     * @notice Registers multiple contracts with the core registry.
+     * @param contractAddresses An array of contract addresses to register.
+     * @param coreVersions An array of versions corresponding to the contract addresses.
+     * @param coreTypes An array of types corresponding to the contract addresses.
+     */
+    function registerMultipleContracts(
+        address[] calldata contractAddresses,
+        bytes32[] calldata coreVersions,
+        bytes32[] calldata coreTypes
+    ) external;
+
+    /**
+     * @notice Unregisters multiple contracts from the core registry.
+     * @param contractAddresses An array of contract addresses to unregister.
+     */
+    function unregisterMultipleContracts(
+        address[] calldata contractAddresses
+    ) external;
+
+    /**
+     * @notice The implementation contract that is cloned when creating new
+     * Engine Core contracts.
+     */
+    function engineImplementation() external view returns (address);
+
+    /**
+     * @notice The implementation contract that is cloned when creating new
+     * Engine Flex Core contracts.
+     */
+    function engineFlexImplementation() external view returns (address);
+
+    /**
+     * @notice Indicates whether the contract is abandoned.
+     * Once abandoned, the contract can no longer be used to create new Engine
+     * or Engine Flex contracts.
+     * @return bool True if the contract is abandoned, false otherwise.
+     */
+    function isAbandoned() external view returns (bool);
+
+    /**
+     * @notice Indicates the type of the contract, e.g. `EngineFactoryV0`.
+     * @return type_ The type of the contract.
+     */
+    function type_() external pure returns (bytes32);
+}

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

@@ -16,6 +16,4 @@ interface IFilteredMinterDAExpSettlementV0 is
     IFilteredMinterDAExpSettlement_Mixin,
     IFilteredMinterV1,
     IFilteredMinterDAExpV0
-{
-
-}
+{}

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

@@ -16,6 +16,4 @@ interface IFilteredMinterDAExpSettlementV1 is
     IFilteredMinterDAExpSettlement_Mixin,
     IFilteredMinterV2,
     IFilteredMinterDAExpV0
-{
-
-}
+{}

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

@@ -11,6 +11,4 @@ pragma solidity ^0.8.0;
  * add support for manually setting project max invocations.
  * @author Art Blocks Inc.
  */
-interface IFilteredMinterDAExpV1 is IFilteredMinterDAExpV0, IFilteredMinterV2 {
-
-}
+interface IFilteredMinterDAExpV1 is IFilteredMinterDAExpV0, IFilteredMinterV2 {}

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

@@ -11,6 +11,4 @@ pragma solidity ^0.8.0;
  * add support for manually setting project max invocations.
  * @author Art Blocks Inc.
  */
-interface IFilteredMinterDALinV1 is IFilteredMinterDALinV0, IFilteredMinterV2 {
-
-}
+interface IFilteredMinterDALinV1 is IFilteredMinterDALinV0, IFilteredMinterV2 {}

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

@@ -14,6 +14,4 @@ pragma solidity ^0.8.0;
 interface IFilteredMinterHolderV2 is
     IFilteredMinterHolderV1,
     IFilteredMinterV2
-{
-
-}
+{}

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

@@ -14,6 +14,4 @@ pragma solidity ^0.8.0;
 interface IFilteredMinterMerkleV2 is
     IFilteredMinterMerkleV1,
     IFilteredMinterV2
-{
-
-}
+{}

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

@@ -4,8 +4,6 @@
 pragma solidity ^0.8.0;
 
 import "./IAdminACLV0.sol";
-/// use the Royalty Registry's IManifold interface for token royalties
-import "./IManifold.sol";
 
 /**
  * @title This interface is intended to house interface items that are common
@@ -14,7 +12,121 @@ import "./IManifold.sol";
  * add support the Royalty Registry by default.
  * @author Art Blocks Inc.
  */
-interface IGenArt721CoreContractV3_Base is IManifold {
+interface IGenArt721CoreContractV3_Base {
+    // This interface emits generic events that contain fields that indicate
+    // which parameter has been updated. This is sufficient for application
+    // state management, while also simplifying the contract and indexing code.
+    // This was done as an alternative to having custom events that emit what
+    // field-values have changed for each event, given that changed values can
+    // be introspected by indexers due to the design of this smart contract
+    // exposing these state changes via publicly viewable fields.
+
+    /**
+     * @notice Project's royalty splitter was updated to `_splitter`.
+     * @dev New event in v3.2
+     * @param projectId The project ID.
+     * @param royaltySplitter The new splitter address to receive royalties.
+     */
+    event ProjectRoyaltySplitterUpdated(
+        uint256 indexed projectId,
+        address indexed royaltySplitter
+    );
+
+    // The following fields are used to indicate which contract-level parameter
+    // has been updated in the `PlatformUpdated` event:
+    // @dev only append to the end of this enum in the case of future updates
+    enum PlatformUpdatedFields {
+        FIELD_NEXT_PROJECT_ID, // 0
+        FIELD_NEW_PROJECTS_FORBIDDEN, // 1
+        FIELD_DEFAULT_BASE_URI, // 2
+        FIELD_RANDOMIZER_ADDRESS, // 3
+        FIELD_NEXT_CORE_CONTRACT, // 4
+        FIELD_ARTBLOCKS_DEPENDENCY_REGISTRY_ADDRESS, // 5
+        FIELD_ARTBLOCKS_ON_CHAIN_GENERATOR_ADDRESS, // 6
+        FIELD_PROVIDER_SALES_ADDRESSES, // 7
+        FIELD_PROVIDER_PRIMARY_SALES_PERCENTAGES, // 8
+        FIELD_PROVIDER_SECONDARY_SALES_BPS, // 9
+        FIELD_SPLIT_PROVIDER // 10
+    }
+
+    // The following fields are used to indicate which project-level parameter
+    // has been updated in the `ProjectUpdated` event:
+    // @dev only append to the end of this enum in the case of future updates
+    enum ProjectUpdatedFields {
+        FIELD_PROJECT_COMPLETED, // 0
+        FIELD_PROJECT_ACTIVE, // 1
+        FIELD_PROJECT_ARTIST_ADDRESS, // 2
+        FIELD_PROJECT_PAUSED, // 3
+        FIELD_PROJECT_CREATED, // 4
+        FIELD_PROJECT_NAME, // 5
+        FIELD_PROJECT_ARTIST_NAME, // 6
+        FIELD_PROJECT_SECONDARY_MARKET_ROYALTY_PERCENTAGE, // 7
+        FIELD_PROJECT_DESCRIPTION, // 8
+        FIELD_PROJECT_WEBSITE, // 9
+        FIELD_PROJECT_LICENSE, // 10
+        FIELD_PROJECT_MAX_INVOCATIONS, // 11
+        FIELD_PROJECT_SCRIPT, // 12
+        FIELD_PROJECT_SCRIPT_TYPE, // 13
+        FIELD_PROJECT_ASPECT_RATIO, // 14
+        FIELD_PROJECT_BASE_URI, // 15
+        FIELD_PROJECT_PROVIDER_SECONDARY_FINANCIALS // 16
+    }
+
+    /**
+     * @notice Error codes for the GenArt721 contract. Used by the GenArt721Error
+     * custom error.
+     * @dev only append to the end of this enum in the case of future updates
+     */
+    enum ErrorCodes {
+        OnlyNonZeroAddress, // 0
+        OnlyNonEmptyString, // 1
+        OnlyNonEmptyBytes, // 2
+        TokenDoesNotExist, // 3
+        ProjectDoesNotExist, // 4
+        OnlyUnlockedProjects, // 5
+        OnlyAdminACL, // 6
+        OnlyArtist, // 7
+        OnlyArtistOrAdminACL, // 8
+        OnlyAdminACLOrRenouncedArtist, // 9
+        OnlyMinterContract, // 10
+        MaxInvocationsReached, // 11
+        ProjectMustExistAndBeActive, // 12
+        PurchasesPaused, // 13
+        OnlyRandomizer, // 14
+        TokenHashAlreadySet, // 15
+        NoZeroHashSeed, // 16
+        OverMaxSumOfPercentages, // 17
+        IndexOutOfBounds, // 18
+        OverMaxSumOfBPS, // 19
+        MaxOf100Percent, // 20
+        PrimaryPayeeIsZeroAddress, // 21
+        SecondaryPayeeIsZeroAddress, // 22
+        MustMatchArtistProposal, // 23
+        NewProjectsForbidden, // 24
+        NewProjectsAlreadyForbidden, // 25
+        OnlyArtistOrAdminIfLocked, // 26
+        OverMaxSecondaryRoyaltyPercentage, // 27
+        OnlyMaxInvocationsDecrease, // 28
+        OnlyGteInvocations, // 29
+        ScriptIdOutOfRange, // 30
+        NoScriptsToRemove, // 31
+        ScriptTypeAndVersionFormat, // 32
+        AspectRatioTooLong, // 33
+        AspectRatioNoNumbers, // 34
+        AspectRatioImproperFormat, // 35
+        OnlyNullPlatformProvider, // 36
+        ContractInitialized // 37
+    }
+
+    /**
+     * @notice Emits an error code `_errorCode` in the GenArt721Error event.
+     * @dev Emitting error codes instead of error strings saves significant
+     * contract bytecode size, allowing for more contract functionality within
+     * the 24KB contract size limit.
+     * @param _errorCode The error code to emit. See ErrorCodes enum.
+     */
+    error GenArt721Error(ErrorCodes _errorCode);
+
     /**
      * @notice Token ID `_tokenId` minted to `_to`.
      */
@@ -95,14 +207,6 @@ interface IGenArt721CoreContractV3_Base is IManifold {
         uint256 _projectId
     ) external view returns (address payable);
 
-    function projectIdToAdditionalPayeePrimarySales(
-        uint256 _projectId
-    ) external view returns (address payable);
-
-    function projectIdToAdditionalPayeePrimarySalesPercentage(
-        uint256 _projectId
-    ) external view returns (uint256);
-
     function projectIdToSecondaryMarketRoyaltyPercentage(
         uint256 _projectId
     ) external view returns (uint256);