@artblocks/contracts 1.0.0 → 1.0.1

package/contracts/BasicPolyptychRandomizerV0.sol

@@ -0,0 +1,126 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity 0.8.17;
+
+import "./interfaces/0.8.x/IGenArt721CoreContractV3_Base.sol";
+import "./interfaces/0.8.x/IRandomizerPolyptychV0.sol";
+
+import "@openzeppelin-4.7/contracts/access/Ownable.sol";
+
+/**
+ * @title Basic Polytych Randomizer contract that enables the copying of token hash seeds.
+ * @notice This contract requires several configuration options to be set properly before
+ * it enables the copying of token hashes from an original token (the first panel of a polyptych)
+ * to subsequent diptych, triptych, or polyptych panels.
+ *
+ * Requirements to use the polyptych randomizer:
+ * - Core contract must be an instance of `GenArt721CoreV3_Engine`
+ * - The initial project used as the first panel should be minted with a pseudo random token hash
+ * - An `MinterPolyptychV0` contract or similar must be deployed and configured as the `hashSeedSetterContract`
+ * - The `projectDuplicateHashSeedLimit` should be configured for each project
+ *
+ * Once the contract is configured, it will enable newly-minted tokens to use a copy of the hash
+ * seed from a previously-minted token.
+ */
+contract BasicPolyptychRandomizerV0 is IRandomizerPolyptychV0, Ownable {
+    // The core contract that may interact with this randomizer contract.
+    IGenArt721CoreContractV3_Base public genArt721Core;
+
+    // Used to obtain the project ID from the token ID
+    uint256 constant ONE_MILLION = 1_000_000;
+
+    // Mapping of token IDs to hash seeds
+    mapping(uint256 => bytes12) public polyptychHashSeeds;
+
+    // Configures the maximum number of hash seed copies that can exist per project (default zero)
+    mapping(uint256 => bool) public projectIsPolyptych;
+
+    // The contract allowed to assign hash seeds (e.g. PolyptychMinterV0)
+    address public hashSeedSetterContract;
+
+    function assignCoreAndRenounce(address _genArt721Core) external onlyOwner {
+        renounceOwnership();
+        genArt721Core = IGenArt721CoreContractV3_Base(_genArt721Core);
+    }
+
+    // modifier to restrict access to only AdminACL allowed calls
+    // @dev defers which ACL contract is used to the core contract
+    modifier onlyCoreAdminACL(bytes4 _selector) {
+        require(
+            genArt721Core.adminACLAllowed(msg.sender, address(this), _selector),
+            "Only Core AdminACL allowed"
+        );
+        _;
+    }
+
+    modifier onlyArtist(uint256 _projectId) {
+        require(
+            msg.sender == genArt721Core.projectIdToArtistAddress(_projectId),
+            "Only Artist"
+        );
+        _;
+    }
+
+    // Allows the owner of the core contract to set the minter that is allowed to assign hash seeds
+    function setHashSeedSetterContract(
+        address _contractAddress
+    ) external onlyCoreAdminACL(this.setHashSeedSetterContract.selector) {
+        hashSeedSetterContract = _contractAddress;
+        emit HashSeedSetterUpdated(_contractAddress);
+    }
+
+    /**
+     * @notice Allows the owner of the core contract to configure a project as a polyptych
+     * @param _projectId - The ID of the project that has a polyptych panel (second, third, etc.)
+     */
+    function toggleProjectIsPolyptych(
+        uint256 _projectId
+    ) external onlyArtist(_projectId) {
+        projectIsPolyptych[_projectId] = !projectIsPolyptych[_projectId];
+        emit ProjectIsPolyptychUpdated(
+            _projectId,
+            projectIsPolyptych[_projectId]
+        );
+    }
+
+    // Sets the token hash seed to be re-used in the subsequent panels of a polyptych
+    function setPolyptychHashSeed(
+        uint256 _tokenId,
+        bytes12 _hashSeed
+    ) external {
+        require(
+            msg.sender == hashSeedSetterContract,
+            "Only hashSeedSetterContract"
+        );
+        polyptychHashSeeds[_tokenId] = _hashSeed;
+        // @dev event indicating token hash seed assigned is not required for subgraph indexing
+        // because token hash seeds are still assigned atomically in `assignTokenHash` function.
+        // If token hash seeds were assigned async, event emission may be required to support
+        // subgraph indexing.
+    }
+
+    // When `genArt721Core` calls this, it can be assured that the randomizer
+    // will set a bytes32 hash for tokenId `_tokenId` on the core contract.
+    function assignTokenHash(uint256 _tokenId) external virtual {
+        require(msg.sender == address(genArt721Core), "Only core may call");
+
+        if (projectIsPolyptych[_tokenId / ONE_MILLION]) {
+            bytes12 seededHash = polyptychHashSeeds[_tokenId];
+            require(seededHash != 0, "Only non-zero hash seed");
+            genArt721Core.setTokenHash_8PT(_tokenId, seededHash);
+        } else {
+            uint256 time = block.timestamp;
+            bytes32 hash = keccak256(
+                abi.encodePacked(
+                    _tokenId,
+                    block.number,
+                    blockhash(block.number - 1),
+                    time,
+                    (time % 200) + 1
+                )
+            );
+            genArt721Core.setTokenHash_8PT(_tokenId, hash);
+        }
+    }
+}

package/contracts/BasicRandomizerV2.sol

@@ -4,17 +4,17 @@
 pragma solidity 0.8.17;
 
 import "./interfaces/0.8.x/IRandomizerV2.sol";
-import "./interfaces/0.8.x/IGenArt721CoreContractV3.sol";
+import "./interfaces/0.8.x/IGenArt721CoreContractV3_Base.sol";
 
 import "@openzeppelin-4.7/contracts/access/Ownable.sol";
 
 contract BasicRandomizerV2 is IRandomizerV2, Ownable {
     // The core contract that may interact with this randomizer contract.
-    IGenArt721CoreContractV3 public genArt721Core;
+    IGenArt721CoreContractV3_Base public genArt721Core;
 
     function assignCoreAndRenounce(address _genArt721Core) external onlyOwner {
         renounceOwnership();
-        genArt721Core = IGenArt721CoreContractV3(_genArt721Core);
+        genArt721Core = IGenArt721CoreContractV3_Base(_genArt721Core);
     }
 
     // When `genArt721Core` calls this, it can be assured that the randomizer

package/contracts/{minter-suite/Minters → archive/minter-suite/Minters/MinterDAExpSettlement}/MinterDAExpSettlementV1.sol

@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Created By: Art Blocks Inc.
 
-import "../../interfaces/0.8.x/IGenArt721CoreContractV3_Base.sol";
-import "../../interfaces/0.8.x/IMinterFilterV0.sol";
-import "../../interfaces/0.8.x/IFilteredMinterDAExpSettlementV0.sol";
-import "./MinterBase_v0_1_1.sol";
+import "../../../../interfaces/0.8.x/IGenArt721CoreContractV3_Base.sol";
+import "../../../../interfaces/0.8.x/IMinterFilterV0.sol";
+import "../../../../interfaces/0.8.x/IFilteredMinterDAExpSettlementV0.sol";
+import "../../../../minter-suite/Minters/MinterBase_v0_1_1.sol";
 
 import "@openzeppelin-4.7/contracts/security/ReentrancyGuard.sol";
 import "@openzeppelin-4.7/contracts/utils/math/SafeCast.sol";

package/contracts/interfaces/0.8.x/IFilteredMinterDAExpSettlementV1.sol

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterDAExpSettlement_Mixin.sol";
+import "./IFilteredMinterV2.sol";
+import "./IFilteredMinterDAExpV0.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface combines the set of interfaces that add support for
+ * a Dutch Auction with Settlement minter.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterDAExpSettlementV1 is
+    IFilteredMinterDAExpSettlement_Mixin,
+    IFilteredMinterV2,
+    IFilteredMinterDAExpV0
+{
+
+}

package/contracts/interfaces/0.8.x/IMinterFilterV0.sol

@@ -4,6 +4,12 @@
 pragma solidity ^0.8.0;
 
 interface IMinterFilterV0 {
+    /**
+     * @notice Emitted when contract is deployed to notify indexing services
+     * of the new contract deployment.
+     */
+    event Deployed();
+
     /**
      * @notice Approved minter `_minterAddress`.
      */

package/contracts/interfaces/0.8.x/IRandomizerPolyptychV0.sol

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity 0.8.17;
+
+import "./IRandomizerV2.sol";
+
+interface IRandomizerPolyptychV0 is IRandomizerV2 {
+    /**
+     * @notice Minter contract at `_contractAddress` allowed to assign token hash seeds.
+     */
+    event HashSeedSetterUpdated(address indexed _contractAddress);
+
+    /**
+     * @notice Project with ID `_projectId` is enabled/disabled for polyptych minting.
+     */
+    event ProjectIsPolyptychUpdated(uint256 _projectId, bool _isPolyptych);
+
+    /**
+     * @notice When a core contract calls this, it can be assured that the randomizer
+     * will set a bytes32 hash for tokenId `_tokenId` on the core contract. This function
+     * may only be called by the contract configured as the `hashSeedSetterContract` via
+     * the `setHashSeedSetterContract` available to the core contract admin.
+     */
+    function assignTokenHash(uint256 _tokenId) external;
+
+    /**
+     * @notice Store the token hash seed for an existing token to be re-used in a polyptych panel.
+     */
+    function setPolyptychHashSeed(uint256 _tokenId, bytes12 _hashSeed) external;
+}

package/contracts/interfaces/0.8.x/IRandomizerV2.sol

@@ -3,11 +3,14 @@
 
 pragma solidity ^0.8.0;
 
-import "./IGenArt721CoreContractV3.sol";
+import "./IGenArt721CoreContractV3_Base.sol";
 
 interface IRandomizerV2 {
     // The core contract that may interact with this randomizer contract.
-    function genArt721Core() external view returns (IGenArt721CoreContractV3);
+    function genArt721Core()
+        external
+        view
+        returns (IGenArt721CoreContractV3_Base);
 
     // When a core contract calls this, it can be assured that the randomizer
     // will set a bytes32 hash for tokenId `_tokenId` on the core contract.

package/contracts/minter-suite/MinterFilter/MinterFilterV1.sol

@@ -6,6 +6,8 @@ import "../../interfaces/0.8.x/IFilteredMinterV0.sol";
 import "../../interfaces/0.8.x/IAdminACLV0.sol";
 import "../../interfaces/0.8.x/IGenArt721CoreContractV3.sol";
 
+import "../../libs/0.8.x/Bytes32Strings.sol";
+
 import "@openzeppelin-4.5/contracts/utils/structs/EnumerableMap.sol";
 
 pragma solidity 0.8.17;
@@ -39,6 +41,21 @@ pragma solidity 0.8.17;
 contract MinterFilterV1 is IMinterFilterV0 {
     // add Enumerable Map methods
     using EnumerableMap for EnumerableMap.UintToAddressMap;
+    // add Bytes32Strings methods
+    using Bytes32Strings for bytes32;
+
+    /// version & type of this core contract
+    bytes32 constant MINTER_FILTER_VERSION = "v1.0.1";
+
+    function minterFilterVersion() external pure returns (string memory) {
+        return MINTER_FILTER_VERSION.toString();
+    }
+
+    bytes32 constant MINTER_FILTER_TYPE = "MinterFilterV1";
+
+    function minterFilterType() external pure returns (string memory) {
+        return MINTER_FILTER_TYPE.toString();
+    }
 
     /// Core contract address this minter interacts with
     address public immutable genArt721CoreAddress;
@@ -106,6 +123,7 @@ contract MinterFilterV1 is IMinterFilterV0 {
     ) onlyNonZeroAddress(_genArt721Address) {
         genArt721CoreAddress = _genArt721Address;
         genArtCoreContract = IGenArt721CoreContractV3(_genArt721Address);
+        emit Deployed();
     }
 
     /**