@artblocks/contracts 1.0.3 → 1.1.0

package/contracts/explorations/GenArt721CoreV3_Explorations.sol

@@ -3,17 +3,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/IGenArt721CoreContractV3.sol";
-import "../interfaces/0.8.x/IGenArt721CoreContractExposesHashSeed.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/IGenArt721CoreContractV3.sol";
+import "../interfaces/v0.8.x/IGenArt721CoreContractExposesHashSeed.sol";
+import "../interfaces/v0.8.x/IManifold.sol";
 
 import "@openzeppelin-4.7/contracts/utils/Strings.sol";
 import "@openzeppelin-4.7/contracts/access/Ownable.sol";
-import "../libs/0.8.x/ERC721_PackedHashSeed.sol";
-import "../libs/0.8.x/BytecodeStorageV1.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 ERC-721 core contract, V3_Explorations.
@@ -181,7 +181,7 @@ contract GenArt721CoreV3_Explorations is
         bool paused;
         string name;
         string artist;
-        string description;
+        address descriptionAddress;
         string website;
         string license;
         string projectBaseURI;
@@ -238,7 +238,7 @@ contract GenArt721CoreV3_Explorations is
     /// version & type of this core contract
     /// coreVersion is updated from Flagship V3 core due to minor changes
     /// implemented in the Explorations version of the contract.
-    string public constant coreVersion = "v3.2.1";
+    string public constant coreVersion = "v3.2.3";
     /// coreType remains consistent with flagship V3 core because external &
     /// public functions used for indexing are unchanged.
     string public constant coreType = "GenArt721CoreV3";
@@ -950,6 +950,13 @@ contract GenArt721CoreV3_Explorations is
     /**
      * @notice Updates description of project `_projectId`.
      * Only artist may call when unlocked, only admin may call when locked.
+     * Note: The BytecodeStorage library is used to store the description to
+     * reduce initial upload cost, however, even minor edits will require an
+     * expensive, entirely new bytecode storage contract to be deployed instead
+     * of relatively cheap updates to already-warm storage slots. This results
+     * in an increased gas cost for minor edits to the description after the
+     * initial upload, but an overall decrease in gas cost for projects with
+     * less than ~3-5 edits (depending on the length of the description).
      * @param _projectId Project ID.
      * @param _projectDescription New project description.
      */
@@ -969,7 +976,10 @@ contract GenArt721CoreV3_Explorations is
             "Only artist when unlocked, owner when locked"
         );
         // effects
-        projects[_projectId].description = _projectDescription;
+        // store description in contract bytecode, replacing reference address from
+        // the old storage description with the newly created one
+        projects[_projectId].descriptionAddress = _projectDescription
+            .writeToBytecode();
         emit ProjectUpdated(_projectId, FIELD_PROJECT_DESCRIPTION);
     }
 
@@ -1360,7 +1370,12 @@ contract GenArt721CoreV3_Explorations is
         Project storage project = projects[_projectId];
         projectName = project.name;
         artist = project.artist;
-        description = project.description;
+        address projectDescriptionBytecodeAddress = project.descriptionAddress;
+        if (projectDescriptionBytecodeAddress == address(0)) {
+            description = "";
+        } else {
+            description = _readFromBytecode(projectDescriptionBytecodeAddress);
+        }
         website = project.website;
         license = project.license;
     }

package/contracts/interfaces/{0.8.x → 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/{0.8.x → v0.8.x}/IDependencyRegistryV0.sol

@@ -18,8 +18,11 @@ interface IDependencyRegistryV0 {
         uint256 indexed _projectId
     );
 
+    event LicenseTypeAdded(bytes32 indexed _licenseType);
+
     event DependencyAdded(
         bytes32 indexed _dependencyType,
+        bytes32 indexed _licenseType,
         string _preferredCDN,
         string _preferredRepository,
         string _referenceWebsite
@@ -78,7 +81,7 @@ interface IDependencyRegistryV0 {
      * @notice Returns address with bytecode containing script for
      * dependency type `_dependencyTypes` at script index `_index`.
      */
-    function getDependencyScriptBytecodeAddressAtIndex(
+    function getDependencyScriptBytecodeAddress(
         bytes32 _dependencyType,
         uint256 _index
     ) external view returns (address);
@@ -88,7 +91,7 @@ interface IDependencyRegistryV0 {
      * @param _dependencyType Dependency type to be queried.
      * @param _index Index of script to be queried.
      */
-    function getDependencyScriptAtIndex(
+    function getDependencyScript(
         bytes32 _dependencyType,
         uint256 _index
     ) external view returns (string memory);

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

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import "./ISharedRandomizerV0.sol";
+
+/**
+ * @title Interface for accessing a shared randomizer on a core contract.
+ * @notice This interface provides access to a V3 core contract's shared
+ * randomizer. Note that randomizers are configurable by core contract admin,
+ * and therefore may not currently be assigned a shared randomizer. For that
+ * reason, this is a separate interface from `IGenArt721CoreContractV3_Base,
+ * and casting a contract as this interface makes the assumption that the core
+ * contract's randomizer conforms to `ISharedRandomizerV0`.
+ * This interface is expected to be most useful for minters that explicitly
+ * assign hash seeds via mechanisms on the shared randomizer (e.g. Polyptych
+ * minters)
+ */
+interface IGenArt721CoreContractV3WithSharedRandomizer {
+    /// current randomizer contract, that we cast as a shared randomizer
+    function randomizerContract() external returns (ISharedRandomizerV0);
+}

package/contracts/interfaces/{0.8.x → v0.8.x}/IMinterFilterV1.sol

@@ -85,46 +85,63 @@ interface IMinterFilterV1 {
      */
     event CoreRegistryUpdated(address indexed coreRegistry);
 
+    // struct used to return minter info
+    // @dev this is not used for storage of data
+    struct MinterWithType {
+        address minterAddress;
+        string minterType;
+    }
+
     function setMinterForProject(
-        uint256 _projectId,
-        address _coreContract,
-        address _minter
+        uint256 projectId,
+        address coreContract,
+        address minter
     ) external;
 
     function removeMinterForProject(
-        uint256 _projectId,
-        address _coreContract
+        uint256 projectId,
+        address coreContract
     ) external;
 
     // @dev function name is optimized for gas
     function mint_joo(
-        address _to,
-        uint256 _projectId,
-        address _coreContract,
-        address _sender
+        address to,
+        uint256 projectId,
+        address coreContract,
+        address sender
     ) external returns (uint256);
 
-    function updateCoreRegistry(address _coreRegistry) external;
+    function updateCoreRegistry(address coreRegistry) external;
+
+    /**
+     * @notice Returns if `sender` is allowed to call function on `contract`
+     * with `selector` selector, according to the MinterFilter's Admin ACL.
+     */
+    function adminACLAllowed(
+        address sender,
+        address contract_,
+        bytes4 selector
+    ) external returns (bool);
 
     function minterFilterType() external pure returns (string memory);
 
     function getMinterForProject(
-        uint256 _projectId,
-        address _coreContract
+        uint256 projectId,
+        address coreContract
     ) external view returns (address);
 
     function projectHasMinter(
-        uint256 _projectId,
-        address _coreContract
+        uint256 projectId,
+        address coreContract
     ) external view returns (bool);
 
     /**
      * @notice View that returns if a core contract is registered with the
      * core registry, allowing this minter filter to service it.
-     * @param _coreContract core contract address to be checked
+     * @param coreContract core contract address to be checked
      */
     function isRegisteredCoreContract(
-        address _coreContract
+        address coreContract
     ) external view returns (bool);
 
     /// Address of current core registry contract
@@ -135,12 +152,12 @@ interface IMinterFilterV1 {
 
     /// The quantity of projects on a core contract that have assigned minters
     function getNumProjectsOnContractWithMinters(
-        address _coreContract
+        address coreContract
     ) external view returns (uint256);
 
     function getProjectAndMinterInfoOnContractAt(
-        address _coreContract,
-        uint256 _index
+        address coreContract,
+        uint256 index
     )
         external
         view
@@ -150,6 +167,15 @@ interface IMinterFilterV1 {
             string memory minterType
         );
 
+    function getAllGloballyApprovedMinters()
+        external
+        view
+        returns (MinterWithType[] memory mintersWithTypes);
+
+    function getAllContractApprovedMinters(
+        address coreContract
+    ) external view returns (MinterWithType[] memory mintersWithTypes);
+
     /**
      * Owner of contract.
      * @dev This returns the address of the Admin ACL contract.

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

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface IRandomizer_V3CoreBase {
+    /**
+     * @notice This function is intended to be called by a core contract, and
+     * the core contract can be assured that the randomizer will call back to
+     * the calling contract to set the token hash seed for `_tokenId` via
+     * `setTokenHash_8PT`.
+     * @dev This function may revert if hash seed generation is improperly
+     * configured (for example, if in polyptych mode, but no hash seed has been
+     * previously configured).
+     * @dev This function is not specifically gated to any specific caller, but
+     * will only call back to the calling contract, `msg.sender`, to set the
+     * specified token's hash seed.
+     * A third party contract calling this function will not be able to set the
+     * token hash seed on a different core contract.
+     * @param _tokenId The token ID must be assigned a hash.
+     */
+    function assignTokenHash(uint256 _tokenId) external;
+}

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

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+import "./ISharedMinterDAExpV0.sol";
+
+interface ISharedMinterDAExpSettlementV0 is ISharedMinterDAExpV0 {
+    /// returns latest purchase price for project `projectId`, or 0 if no
+    /// purchases have been made.
+    function getProjectLatestPurchasePrice(
+        uint256 projectId,
+        address coreContract
+    ) external view returns (uint256 latestPurchasePrice);
+
+    /// returns the number of settleable invocations for project `projectId`.
+    function getNumSettleableInvocations(
+        uint256 projectId,
+        address coreContract
+    ) external view returns (uint256 numSettleableInvocations);
+
+    /// Returns the current excess settlement funds on project `projectId`
+    /// for address `walletAddress`.
+    function getProjectExcessSettlementFunds(
+        uint256 projectId,
+        address coreContract,
+        address walletAddress
+    ) external view returns (uint256 excessSettlementFundsInWei);
+}

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

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface ISharedMinterDAExpV0 {
+    function minimumPriceDecayHalfLifeSeconds() external view returns (uint256);
+
+    function setMinimumPriceDecayHalfLifeSeconds(
+        uint256 minimumPriceDecayHalfLifeSeconds
+    ) external;
+}

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

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface ISharedMinterDALinV0 {
+    function minimumAuctionLengthSeconds() external view returns (uint256);
+
+    function setMinimumAuctionLengthSeconds(
+        uint256 minimumAuctionLengthSeconds
+    ) external;
+}

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

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface ISharedMinterDAV0 {
+    // @dev return variables left unnamed because specific minter
+    // implementations may return different values for the same slots
+    function projectAuctionParameters(
+        uint256 projectId,
+        address coreContract
+    ) external view returns (uint40, uint40, uint256, uint256);
+}

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

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface adds support for including token holder gating when purchasing with ERC20 tokens.
+ * @author Art Blocks Inc.
+ */
+interface ISharedMinterHolderERC20V0 {
+    // Triggers a purchase of a token from the desired project, to the
+    // TX-sending address, using owned ERC-721 NFT to claim right to purchase.
+    function purchase(
+        uint256 projectId,
+        address coreContract,
+        uint256 maxPricePerToken,
+        address currencyAddress,
+        address ownedNFTAddress,
+        uint256 ownedNFTTokenId
+    ) external returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project, to the specified
+    // receiving address, using owned ERC-721 NFT to claim right to purchase.
+    function purchaseTo(
+        address to,
+        uint256 projectId,
+        address coreContract,
+        uint256 maxPricePerToken,
+        address currencyAddress,
+        address ownedNFTAddress,
+        uint256 ownedNFTTokenId
+    ) external returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project, on behalf of
+    // the provided vault, to the specified receiving address, using owned
+    // ERC-721 NFT to claim right to purchase.
+    function purchaseTo(
+        address to,
+        uint256 projectId,
+        address coreContract,
+        uint256 maxPricePerToken,
+        address currencyAddress,
+        address ownedNFTAddress,
+        uint256 ownedNFTTokenId,
+        address vault
+    ) external returns (uint256 tokenId);
+}

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

@@ -0,0 +1,41 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface adds support for including token holder gating when purchasing.
+ * @author Art Blocks Inc.
+ */
+interface ISharedMinterHolderV0 {
+    // Triggers a purchase of a token from the desired project, to the
+    // TX-sending address, using owned ERC-721 NFT to claim right to purchase.
+    function purchase(
+        uint256 projectId,
+        address coreContract,
+        address ownedNFTAddress,
+        uint256 ownedNFTTokenId
+    ) external payable returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project, to the specified
+    // receiving address, using owned ERC-721 NFT to claim right to purchase.
+    function purchaseTo(
+        address to,
+        uint256 projectId,
+        address coreContract,
+        address ownedNFTAddress,
+        uint256 ownedNFTTokenId
+    ) external payable returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project, on behalf of
+    // the provided vault, to the specified receiving address, using owned
+    // ERC-721 NFT to claim right to purchase.
+    function purchaseTo(
+        address to,
+        uint256 projectId,
+        address coreContract,
+        address ownedNFTAddress,
+        uint256 ownedNFTTokenId,
+        address vault
+    ) external payable returns (uint256 tokenId);
+}

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

@@ -0,0 +1,34 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface adds support for including Merkle proofs when purchasing.
+ * @author Art Blocks Inc.
+ */
+interface ISharedMinterMerkleV0 {
+    // Triggers a purchase of a token from the desired project, to the
+    // TX-sending address. Requires Merkle proof.
+    function purchase(
+        uint256 projectId,
+        address coreContract,
+        bytes32[] calldata proof
+    ) external payable returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project, to the specified
+    // receiving address. Requires Merkle proof.
+    function purchaseTo(
+        address to,
+        uint256 projectId,
+        address coreContract,
+        bytes32[] calldata proof
+    ) external payable returns (uint256 tokenId);
+
+    // Updates the Merkle root for the desired project.
+    function updateMerkleRoot(
+        uint256 projectId,
+        address coreContract,
+        bytes32 root
+    ) external;
+}

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

@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface adds support for serial English auction minting.
+ * @author Art Blocks Inc.
+ */
+interface ISharedMinterSEAV0 {
+    function createBid(
+        uint256 projectId,
+        address coreContract
+    ) external payable;
+}

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

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title Art Blocks Shared Minter Simple Purchase Interface
+ * @notice This interface is designed to be used by minter contracts that
+ * implement a simple purchase model, such that the only args required to
+ * purchase a token are the project id and the core contract address, and an
+ * optional recipient address.
+ */
+interface ISharedMinterSimplePurchaseV0 {
+    // Triggers a purchase of a token from the desired project, to the
+    // TX-sending address.
+    function purchase(
+        uint256 projectId,
+        address coreContract
+    ) external payable returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project, to the specified
+    // receiving address.
+    function purchaseTo(
+        address to,
+        uint256 projectId,
+        address coreContract
+    ) external payable returns (uint256 tokenId);
+}

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

@@ -0,0 +1,43 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface ISharedMinterV0 {
+    // Sets the local max invocations for a given project, checking that the provided max invocations is
+    // less than or equal to the global max invocations for the project set on the core contract.
+    // This does not impact the max invocations value defined on the core contract.
+    function manuallyLimitProjectMaxInvocations(
+        uint256 projectId,
+        address coreContract,
+        uint24 maxInvocations
+    ) external;
+
+    // Called to make the minter contract aware of the max invocations for a
+    // given project.
+    function syncProjectMaxInvocationsToCore(
+        uint256 projectId,
+        address coreContract
+    ) external;
+
+    // getter function of public variable
+    function minterType() external view returns (string memory);
+
+    function minterFilterAddress() external returns (address);
+
+    // Gets if token price is configured, token price in wei, currency symbol,
+    // and currency address, assuming this is project's minter.
+    // Supersedes any defined core price.
+    function getPriceInfo(
+        uint256 projectId,
+        address coreContract
+    )
+        external
+        view
+        returns (
+            bool isConfigured,
+            uint256 tokenPriceInWei,
+            string memory currencySymbol,
+            address currencyAddress
+        );
+}