@artblocks/contracts 1.1.0 → 1.2.1

package/contracts/generator/scripty-support/Scripty.sol

@@ -0,0 +1,5 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+pragma solidity ^0.8.0;
+
+// This file is just used to make sure ScriptyBuilderV2.sol is compiled for use in tests.
+import "scripty.sol/contracts/scripty/ScriptyBuilderV2.sol";

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

@@ -3,60 +3,58 @@
 
 pragma solidity ^0.8.0;
 
+import {IBytecodeStorageReader_Base} from "./IBytecodeStorageReader_Base.sol";
+
 /**
- * @title Art Blocks Script Storage Library (Reader)
- * @notice This interface defines the expected read functions for the Art Blocks Script Storage Library (Reader).
+ * @title Art Blocks Script Storage Library - Reader Contract
+ * @notice This interface defines the expected read functions for the Art Blocks Script Storage Library's Reader
+ * Contracts. It is extended from the base interface to add additional read functions for further introspection of
+ * stored data.
  */
-interface IBytecodeStorageReader {
-    /**
-     * @notice Read a string from contract bytecode
-     * @param _address address of deployed contract with bytecode stored in the V0 or V1 format
-     * @return data string read from contract bytecode
-     * @dev This function performs input validation that the contract to read is in an expected format
-     */
-    function readFromBytecode(
-        address _address
-    ) external view returns (string memory data);
-
+interface IBytecodeStorageReader is IBytecodeStorageReader_Base {
     /**
-     * @notice Read the bytes from contract bytecode that was written to the EVM using SSTORE2
-     * @param _address address of deployed contract with bytecode stored in the SSTORE2 format
-     * @return data bytes read from contract bytecode
-     * @dev This function performs no input validation on the provided contract,
-     *      other than that there is content to read (but not that its a "storage contract")
+     * @notice Read a bytes array from the SSTORE2-formatted bytecode of a contract.
+     * Note that this function is only compatible with contracts that have been deployed using the popular SSTORE2
+     * library.
+     * @dev see versioned BytecodeStorageReader implementation details to understand which data are being returned,
+     * espcially in the context of EOF updates.
+     * @param address_ address of contract with SSTORE2-formatted bytecode to be read
+     * @return data The bytes data stored at the specific address.
      */
     function readBytesFromSSTORE2Bytecode(
-        address _address
+        address address_
     ) external view returns (bytes memory data);
 
     /**
-     * @notice Read the bytes from contract bytecode, with an explicitly provided starting offset
-     * @param _address address of deployed contract with bytecode stored in the V0 or V1 format
-     * @param _offset offset to read from in contract bytecode, explicitly provided (not calculated)
-     * @return data bytes read from contract bytecode
-     * @dev This function performs no input validation on the provided contract,
-     *      other than that there is content to read (but not that its a "storage contract")
+     * @notice Read a bytes array from the a contract deployed via BytecodeStorage.
+     * @dev see versioned BytecodeStorageReader implementation details to understand which data are being returned, and
+     * how offset is interpreted, especially in the context of EOF updates.
+     * @param address_ address of contract with valid bytecode to be read
+     * @param offset offset to read from in contract bytecode, explicitly provided (not calculated)
+     * @return The bytes data stored at the specific address.
      */
     function readBytesFromBytecode(
-        address _address,
-        uint256 _offset
-    ) external view returns (bytes memory data);
+        address address_,
+        uint256 offset
+    ) external view returns (bytes memory);
+
+    //------ Metadata Functions ------//
 
     /**
-     * @notice Get address for deployer for given contract bytecode
-     * @param _address address of deployed contract with bytecode stored in the V0 or V1 format
-     * @return writerAddress address read from contract bytecode
+     * @notice Get address of deployer for given contract deployed via BytecodeStorage.
+     * @param address_ address of deployed contract
+     * @return writerAddress address of deployer
      */
     function getWriterAddressForBytecode(
-        address _address
+        address address_
     ) external view returns (address);
 
     /**
-     * @notice Get version for given contract bytecode
-     * @param _address address of deployed contract with bytecode stored in the V0 or V1 format
-     * @return version version read from contract bytecode
+     * @notice Get version for given contract deployed via BytecodeStorage.
+     * @param address_ address of deployed contract
+     * @return version version of the contract
      */
     function getLibraryVersionForBytecode(
-        address _address
+        address address_
     ) external view returns (bytes32);
 }

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

@@ -0,0 +1,25 @@
+// 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 a Bytecode Storage Reader contract.
+ * @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 {
+    //------ Metadata Functions ------//
+
+    /**
+     * @notice Get if data are stored in compressed format for given contract deployed via BytecodeStorage.
+     * @param _address address of deployed contract
+     * @return isCompressed boolean indicating if the stored data are compressed
+     */
+    function getIsCompressedForBytecode(
+        address _address
+    ) external view returns (bool);
+}

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

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title Art Blocks Script Storage Library - Minimal Interface for Reader Contracts
+ * @notice This interface defines the minimal expected read function(s) for a Bytecode Storage Reader contract.
+ */
+interface IBytecodeStorageReader_Base {
+    /**
+     * @notice Read a string from a data contract deployed via BytecodeStorage.
+     * @dev may also support reading additional stored data formats in the future.
+     * @param address_ address of contract deployed via BytecodeStorage to be read
+     * @return data The string data stored at the specific address.
+     */
+    function readFromBytecode(
+        address address_
+    ) external view returns (string memory data);
+}

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

@@ -22,4 +22,9 @@ interface ICoreRegistryV1 is IEngineRegistryV0 {
     function isRegisteredContract(
         address contractAddress
     ) external view returns (bool isRegistered);
+
+    function getAllRegisteredContracts()
+        external
+        view
+        returns (address[] memory);
 }

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

@@ -3,96 +3,192 @@
 pragma solidity ^0.8.19;
 
 interface IDependencyRegistryV0 {
-    event SupportedCoreContractAdded(address indexed _coreContractAddress);
+    // legacy event used before deferring to core registry for allowlist
+    event SupportedCoreContractAdded(address indexed coreContractAddress);
 
-    event SupportedCoreContractRemoved(address indexed _coreContractAddress);
+    // legacy event used before deferring to core registry for allowlist
+    event SupportedCoreContractRemoved(address indexed coreContractAddress);
 
-    event ProjectDependencyTypeOverrideAdded(
-        address indexed _coreContractAddress,
-        uint256 indexed _projectId,
-        bytes32 _dependencyType
+    // active event used to add additional supported contracts beyond what core registry allows
+    event SupportedCoreContractOverrideAdded(
+        address indexed coreContractAddress
     );
 
-    event ProjectDependencyTypeOverrideRemoved(
-        address indexed _coreContractAddress,
-        uint256 indexed _projectId
+    // active event used to remove additional supported contracts beyond what core registry allows
+    event SupportedCoreContractOverrideRemoved(
+        address indexed coreContractAddress
     );
 
-    event LicenseTypeAdded(bytes32 indexed _licenseType);
+    event ProjectDependencyOverrideAdded(
+        address indexed coreContractAddress,
+        uint256 indexed projectId,
+        bytes32 dependencyNameAndVersion
+    );
+
+    event ProjectDependencyOverrideRemoved(
+        address indexed coreContractAddress,
+        uint256 indexed projectId
+    );
+
+    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);
+
+    event CoreRegistryAddressUpdated(address indexed coreRegistryAddress);
 
     /**
-     * @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);
+
+    /**
+     * @notice Returns details for a given dependency type `dependencyNameAndVersion`.
+     * @param dependencyNameAndVersion Name and version of dependency (i.e. "name@version") used to identify dependency.
+     * @return nameAndVersion String representation of `dependencyNameAndVersion`.
+     *                        (e.g. "p5js(atSymbol)1.0.0")
+     * @return licenseType License type for dependency
+     * @return preferredCDN Preferred CDN URL for dependency
+     * @return additionalCDNCount Count of additional CDN URLs for dependency
+     * @return preferredRepository Preferred repository URL for dependency
+     * @return additionalRepositoryCount Count of additional repository URLs for dependency
+     * @return dependencyWebsite Project website URL for dependency
+     * @return availableOnChain Whether dependency is available on chain
+     * @return scriptCount Count of on-chain scripts for dependency
+     */
+    function getDependencyDetails(
+        bytes32 dependencyNameAndVersion
+    )
+        external
+        view
+        returns (
+            string memory nameAndVersion,
+            string memory licenseType,
+            string memory preferredCDN,
+            uint24 additionalCDNCount,
+            string memory preferredRepository,
+            uint24 additionalRepositoryCount,
+            string memory dependencyWebsite,
+            bool availableOnChain,
+            uint24 scriptCount
+        );
+
+    /**
+     * @notice Returns the dependency name and version for a given project (`projectId`)
+     * on a given core contract (`_contractAddress`). If no override is set,
+     * the core contract is called to retrieve the script type and version as
+     * dependency type. For any contract earlier than v3, that does not have
+     * an override set, this will revert.
+     * @param contractAddress Core contract address.
+     * @param projectId Project to return dependency type for.
+     * @return dependencyType Identifier for the dependency (i.e. "name@version") used by project.
+     */
+    function getDependencyNameAndVersionForProject(
+        address contractAddress,
+        uint256 projectId
+    ) external view returns (string memory);
+
+    /**
+     * @notice Returns whether the given contract address is a supported core contract.
+     * @param coreContractAddress Address of the core contract to be queried.
+     * @return True if the given contract address is a supported core contract.
+     */
+    function isSupportedCoreContract(
+        address coreContractAddress
+    ) external view returns (bool);
+
+    /**
+     * @notice Convenience function that returns whether `_sender` is allowed
+     * to call function with selector `_selector` on contract `_contract`, as
+     * determined by this contract's current Admin ACL contract. Expected use
+     * cases include minter contracts checking if caller is allowed to call
+     * admin-gated functions on minter contracts.
+     * @param sender Address of the sender calling function with selector
+     * `selector` on contract `contract_`.
+     * @param contract_ Address of the contract being called by `sender`.
+     * @param selector Function selector of the function being called by
+     * `sender`.
+     * @return bool Whether `sender` is allowed to call function with selector
+     * `selector` on contract `contract_`.
+     * @dev assumes the Admin ACL contract is the owner of this contract, which
+     * is expected to always be true.
+     * @dev adminACLContract is expected to either be null address (if owner
+     * has renounced ownership), or conform to IAdminACLV0 interface. Check for
+     * null address first to avoid revert when admin has renounced ownership.
+     */
+    function adminACLAllowed(
+        address sender,
+        address contract_,
+        bytes4 selector
+    ) external returns (bool);
 }

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
-{
-
-}
+{}