@artblocks/contracts 1.0.0 → 1.0.2

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

@@ -0,0 +1,145 @@
+// SPDX-License-Identifier: GPL-3.0
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterV2.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title Interface for MinterSEA, inspired by nouns.wtf.
+ * This interface combines the set of interfaces that add support for
+ * a Serial English Auction Minter.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterSEAV0 is IFilteredMinterV2 {
+    /// Struct that defines a single token English auction
+    struct Auction {
+        // token number of NFT being auctioned
+        uint256 tokenId;
+        // The current highest bid amount (in wei)
+        uint256 currentBid;
+        // The address of the current highest bidder
+        address payable currentBidder;
+        // The time that the auction is scheduled to end
+        // max uint64 ~= 1.8e19 sec ~= 570 billion years
+        uint64 endTime;
+        // Whether or not the auction has been settled
+        bool settled;
+        // Whether or not the auction has been initialized (used to determine
+        // if auction is the default struct)
+        bool initialized;
+    }
+
+    /// Admin-controlled range of allowed auction durations updated
+    event AuctionDurationSecondsRangeUpdated(
+        uint32 minAuctionDurationSeconds,
+        uint32 maxAuctionDurationSeconds
+    );
+
+    /// Admin-controlled minimum bid increment percentage updated
+    event MinterMinBidIncrementPercentageUpdated(
+        uint8 minterMinBidIncrementPercentage
+    );
+
+    /// Admin-controlled time buffer updated
+    event MinterTimeBufferUpdated(uint32 minterTimeBufferSeconds);
+
+    // Admin-controlled refund gas limit updated
+    event MinterRefundGasLimitUpdated(uint16 refundGasLimit);
+
+    /// Artist configured future auction details
+    event ConfiguredFutureAuctions(
+        uint256 indexed projectId,
+        uint64 timestampStart,
+        uint32 auctionDurationSeconds,
+        uint256 basePrice
+    );
+
+    /// Future auction details for project `projectId` reset
+    event ResetAuctionDetails(uint256 indexed projectId);
+
+    /// New token auction created, token created and sent to minter
+    event AuctionInitialized(
+        uint256 indexed tokenId,
+        address indexed bidder,
+        uint256 bidAmount,
+        uint64 endTime
+    );
+
+    /// Successful bid placed on token auction
+    event AuctionBid(
+        uint256 indexed tokenId,
+        address indexed bidder,
+        uint256 bidAmount
+    );
+
+    /// Token auction was settled (token distributed to winner)
+    event AuctionSettled(
+        uint256 indexed tokenId,
+        address indexed winner,
+        uint256 price
+    );
+
+    // Next token ID for project `projectId` updated
+    event ProjectNextTokenUpdated(uint256 indexed projectId, uint256 tokenId);
+
+    // Next token ID for project `projectId` was ejected from the minter
+    // and is no longer populated
+    event ProjectNextTokenEjected(uint256 indexed projectId);
+
+    function configureFutureAuctions(
+        uint256 _projectId,
+        uint256 _timestampStart,
+        uint256 _auctionDurationSeconds,
+        uint256 _basePrice
+    ) external;
+
+    function resetAuctionDetails(uint256 _projectId) external;
+
+    // artist-only function that populates the next token ID to be auctioned
+    // for project `projectId`
+    function tryPopulateNextToken(uint256 _projectId) external;
+
+    function settleAuctionAndCreateBid(
+        uint256 _settleTokenId,
+        uint256 _bidTokenId
+    ) external payable;
+
+    function settleAuction(uint256 _tokenId) external;
+
+    function createBid(uint256 _tokenId) external payable;
+
+    function createBid_l34(uint256 _tokenId) external payable;
+
+    function minterConfigurationDetails()
+        external
+        view
+        returns (
+            uint32 minAuctionDurationSeconds_,
+            uint32 maxAuctionDurationSeconds_,
+            uint8 minterMinBidIncrementPercentage_,
+            uint32 minterTimeBufferSeconds_,
+            uint16 minterRefundGasLimit_
+        );
+
+    function projectConfigurationDetails(
+        uint256 _projectId
+    )
+        external
+        view
+        returns (
+            uint24 maxInvocations,
+            uint64 timestampStart,
+            uint32 auctionDurationSeconds,
+            uint256 basePrice,
+            bool nextTokenNumberIsPopulated,
+            uint24 nextTokenNumber,
+            Auction memory auction
+        );
+
+    function projectActiveAuctionDetails(
+        uint256 _projectId
+    ) external view returns (Auction memory);
+
+    function getTokenToBid(uint256 _projectId) external view returns (uint256);
+}

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

@@ -100,6 +100,14 @@ interface IGenArt721CoreContractV3_Base is IManifold {
         uint256 _projectId
     ) external view returns (uint256);
 
+    function projectIdToSecondaryMarketRoyaltyPercentage(
+        uint256 _projectId
+    ) external view returns (uint256);
+
+    function projectURIInfo(
+        uint256 _projectId
+    ) external view returns (string memory projectBaseURI);
+
     // @dev new function in V3
     function projectStateData(
         uint256 _projectId
@@ -115,6 +123,37 @@ interface IGenArt721CoreContractV3_Base is IManifold {
             bool locked
         );
 
+    function projectDetails(
+        uint256 _projectId
+    )
+        external
+        view
+        returns (
+            string memory projectName,
+            string memory artist,
+            string memory description,
+            string memory website,
+            string memory license
+        );
+
+    function projectScriptDetails(
+        uint256 _projectId
+    )
+        external
+        view
+        returns (
+            string memory scriptTypeAndVersion,
+            string memory aspectRatio,
+            uint256 scriptCount
+        );
+
+    function projectScriptByIndex(
+        uint256 _projectId,
+        uint256 _index
+    ) external view returns (string memory);
+
+    function tokenIdToHash(uint256 _tokenId) external view returns (bytes32);
+
     // function to set a token's hash (must be guarded)
     function setTokenHash_8PT(uint256 _tokenId, bytes32 _hash) external;
 

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

@@ -70,9 +70,6 @@ interface IGenArt721CoreContractV3_Engine is IGenArt721CoreContractV3_Base {
         view
         returns (uint256);
 
-    // function to read the hash for a given tokenId
-    function tokenIdToHash(uint256 _tokenId) external view returns (bytes32);
-
     // function to read the hash-seed for a given tokenId
     function tokenIdToHashSeed(
         uint256 _tokenId

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

@@ -0,0 +1,132 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import "./IAdminACLV0.sol";
+import "./IGenArt721CoreContractV3_Engine.sol";
+
+/**
+ * @title This interface is intended to house interface items that are common
+ * across all GenArt721CoreContractV3 Engine Flex and derivative implementations.
+ * @author Art Blocks Inc.
+ */
+interface IGenArt721CoreContractV3_Engine_Flex is
+    IGenArt721CoreContractV3_Engine
+{
+    /**
+     * @notice When an external asset dependency is updated or added, this event is emitted.
+     * @param _projectId The project ID of the project that was updated.
+     * @param _index The index of the external asset dependency that was updated.
+     * @param _cid The content ID of the external asset dependency. This is an empty string
+     * if the dependency type is ONCHAIN.
+     * @param _dependencyType The type of the external asset dependency.
+     * @param _externalAssetDependencyCount The number of external asset dependencies.
+     */
+    event ExternalAssetDependencyUpdated(
+        uint256 indexed _projectId,
+        uint256 indexed _index,
+        string _cid,
+        ExternalAssetDependencyType _dependencyType,
+        uint24 _externalAssetDependencyCount
+    );
+
+    /**
+     * @notice The project id `_projectId` has had an external asset dependency removed at index `_index`.
+     */
+    event ExternalAssetDependencyRemoved(
+        uint256 indexed _projectId,
+        uint256 indexed _index
+    );
+
+    /**
+     * @notice The preferred gateway for dependency type `_dependencyType` has been updated to `_gatewayAddress`.
+     */
+    event GatewayUpdated(
+        ExternalAssetDependencyType indexed _dependencyType,
+        string _gatewayAddress
+    );
+
+    /**
+     * @notice The project id `_projectId` has had all external asset dependencies locked.
+     * @dev This is a one-way operation. Once locked, the external asset dependencies cannot be updated.
+     */
+    event ProjectExternalAssetDependenciesLocked(uint256 indexed _projectId);
+
+    /**
+     * @notice An external asset dependency type. Can be one of IPFS, ARWEAVE, or ONCHAIN.
+     */
+    enum ExternalAssetDependencyType {
+        IPFS,
+        ARWEAVE,
+        ONCHAIN
+    }
+
+    /**
+     * @notice An external asset dependency. This is a struct that contains the CID of the dependency,
+     * the type of the dependency, and the address of the bytecode for this dependency.
+     */
+    struct ExternalAssetDependency {
+        string cid;
+        ExternalAssetDependencyType dependencyType;
+        address bytecodeAddress;
+    }
+
+    /**
+     * @notice An external asset dependency with data. This is a convenience struct that contains the CID of the dependency,
+     * the type of the dependency, the address of the bytecode for this dependency, and the data retrieved from this bytecode address.
+     */
+    struct ExternalAssetDependencyWithData {
+        string cid;
+        ExternalAssetDependencyType dependencyType;
+        address bytecodeAddress;
+        string data;
+    }
+
+    // preferredIPFSGateway is a url string
+    function preferredIPFSGateway() external view returns (string memory);
+
+    // preferredArweaveGateway is a url string
+    function preferredArweaveGateway() external view returns (string memory);
+
+    // updates the preferred IPFS gateway
+    function updateIPFSGateway(string calldata _gateway) external;
+
+    // updates the preferred Arweave gateway
+    function updateArweaveGateway(string calldata _gateway) external;
+
+    // locks the external asset dependencies for a project
+    function lockProjectExternalAssetDependencies(uint256 _projectId) external;
+
+    // updates the external asset dependency for a project at a given index
+    function updateProjectExternalAssetDependency(
+        uint256 _projectId,
+        uint256 _index,
+        string memory _cidOrData,
+        ExternalAssetDependencyType _dependencyType
+    ) external;
+
+    // adds an external asset dependency for a project
+    function addProjectExternalAssetDependency(
+        uint256 _projectId,
+        string memory _cidOrData,
+        ExternalAssetDependencyType _dependencyType
+    ) external;
+
+    // removes an external asset dependency for a project at a given index
+    function removeProjectExternalAssetDependency(
+        uint256 _projectId,
+        uint256 _index
+    ) external;
+
+    // getter function for project external asset dependencies
+    function projectExternalAssetDependencyByIndex(
+        uint256 _projectId,
+        uint256 _index
+    ) external view returns (ExternalAssetDependencyWithData memory);
+
+    // getter function project external asset dependency count
+    function projectExternalAssetDependencyCount(
+        uint256 _projectId
+    ) external view returns (uint256);
+}

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/interfaces/0.8.x/IWETH.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: GPL-3.0
+
+pragma solidity ^0.8.0;
+
+interface IWETH {
+    function deposit() external payable;
+
+    function withdraw(uint256 wad) external;
+
+    function transfer(address to, uint256 value) external returns (bool);
+}