@artblocks/contracts 1.0.2 → 1.0.4

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

@@ -0,0 +1,27 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+pragma solidity ^0.8.0;
+
+import "./IEngineRegistryV0.sol";
+
+interface ICoreRegistryV1 is IEngineRegistryV0 {
+    function registerContracts(
+        address[] calldata _contractAddresses,
+        bytes32[] calldata _coreVersions,
+        bytes32[] calldata _coreTypes
+    ) external;
+
+    function unregisterContracts(
+        address[] calldata _contractAddresses
+    ) external;
+
+    function getNumRegisteredContracts() external view returns (uint256);
+
+    function getRegisteredContractAt(
+        uint256 _index
+    ) external view returns (address);
+
+    function isRegisteredContract(
+        address _contractAddress
+    ) external view returns (bool isRegistered);
+}

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

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: CC0-1.0
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 /// @dev Source: https://github.com/0xfoobar/delegation-registry/blob/main/src/IDelegationRegistry.sol
 

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

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Created By: Art Blocks Inc.
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 interface IDependencyRegistryCompatibleV0 {
     /// Dependency registry managed by Art Blocks

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

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Created By: Art Blocks Inc.
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 interface IDependencyRegistryV0 {
     event SupportedCoreContractAdded(address indexed _coreContractAddress);
@@ -78,7 +78,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 +88,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/{0.8.x → v0.8.x}/IEngineRegistryV0.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Created By: Art Blocks Inc.
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.0;
 
 interface IEngineRegistryV0 {
     /// ADDRESS

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

@@ -12,6 +12,37 @@ pragma solidity ^0.8.0;
  * @author Art Blocks Inc.
  */
 interface IFilteredMinterSEAV0 is IFilteredMinterV2 {
+    // project-specific parameters
+    struct ProjectConfig {
+        bool maxHasBeenInvoked;
+        // max uint24 ~= 1.6e7, > max possible project invocations of 1e6
+        uint24 maxInvocations;
+        // time after which new auctions may be started
+        // note: new auctions must always be started with a new bid, at which
+        // point the auction will actually start
+        // @dev this is a project-level constraint, and individual auctions
+        // will each have their own start time defined in `activeAuction`
+        // max uint64 ~= 1.8e19 sec ~= 570 billion years
+        uint64 timestampStart;
+        // duration of each new auction, before any extensions due to late bids
+        // @dev for configured auctions, this will be gt 0, so it may be used
+        // to determine if an auction is configured
+        uint32 auctionDurationSeconds;
+        // next token number to be auctioned, owned by minter
+        // @dev store token number to enable storage packing, as token ID can
+        // be derived from this value in combination with project ID
+        // max uint24 ~= 1.6e7, > max possible project invocations of 1e6
+        uint24 nextTokenNumber;
+        // bool to indicate if next token number has been populated, or is
+        // still default value of 0
+        // @dev required to handle edge case where next token number is 0
+        bool nextTokenNumberIsPopulated;
+        // reserve price, i.e. minimum starting bid price, in wei
+        uint256 basePrice;
+        // active auction for project
+        Auction activeAuction;
+    }
+
     /// Struct that defines a single token English auction
     struct Auction {
         // token number of NFT being auctioned
@@ -19,15 +50,14 @@ interface IFilteredMinterSEAV0 is IFilteredMinterV2 {
         // The current highest bid amount (in wei)
         uint256 currentBid;
         // The address of the current highest bidder
+        // @dev if this is not the zero address, then the auction is
+        // considered initialized
         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
@@ -124,18 +154,7 @@ interface IFilteredMinterSEAV0 is IFilteredMinterV2 {
 
     function projectConfigurationDetails(
         uint256 _projectId
-    )
-        external
-        view
-        returns (
-            uint24 maxInvocations,
-            uint64 timestampStart,
-            uint32 auctionDurationSeconds,
-            uint256 basePrice,
-            bool nextTokenNumberIsPopulated,
-            uint24 nextTokenNumber,
-            Auction memory auction
-        );
+    ) external view returns (ProjectConfig memory projectConfiguration_);
 
     function projectActiveAuctionDetails(
         uint256 _projectId

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

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface IGenArt721CoreContractExposesHashSeed {
+    // function to read the hash-seed for a given tokenId
+    function tokenIdToHashSeed(
+        uint256 _tokenId
+    ) external view returns (bytes12);
+}

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}/IGenArt721CoreContractV3_Base.sol

@@ -77,6 +77,9 @@ interface IGenArt721CoreContractV3_Base is IManifold {
         bytes4 _selector
     ) external returns (bool);
 
+    /// getter function of public variable
+    function startingProjectId() external view returns (uint256);
+
     // getter function of public variable
     function nextProjectId() external view returns (uint256);
 

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

@@ -69,9 +69,4 @@ interface IGenArt721CoreContractV3_Engine is IGenArt721CoreContractV3_Base {
         external
         view
         returns (uint256);
-
-    // function to read the hash-seed for a given tokenId
-    function tokenIdToHashSeed(
-        uint256 _tokenId
-    ) external view returns (bytes12);
 }

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

@@ -0,0 +1,184 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import "./ICoreRegistryV1.sol";
+import "./IAdminACLV0.sol";
+
+/**
+ * @title IMinterFilterV1
+ * @author Art Blocks Inc.
+ * @notice Interface for a new minter filter contract.
+ * This interface does not extend the previous version of the minter filter
+ * interface, as the previous version is not compatible with the new
+ * minter filter architecture.
+ * @dev This interface is for a minter filter that supports multiple core
+ * contracts, and allows for a minter to be set on a per-project basis.
+ */
+interface IMinterFilterV1 {
+    /**
+     * @notice Emitted when contract is deployed to notify indexing services
+     * of the new contract deployment.
+     */
+    event Deployed();
+
+    /**
+     * @notice Globally approved minter `minter`.
+     */
+    event MinterApprovedGlobally(address indexed minter, string minterType);
+
+    /**
+     * @notice Globally revoked minter `minter`.
+     * @dev contract owner may still approve this minter on a per-contract
+     * basis.
+     */
+    event MinterRevokedGlobally(address indexed minter);
+
+    /**
+     * @notice Approved minter `minter` on core contract
+     * `coreContract`.
+     */
+    event MinterApprovedForContract(
+        address indexed coreContract,
+        address indexed minter,
+        string minterType
+    );
+
+    /**
+     * @notice Revoked minter `minter` on core contract `coreContract`.
+     * @dev minter filter owner may still globally approve this minter for all
+     * contracts.
+     */
+    event MinterRevokedForContract(
+        address indexed coreContract,
+        address indexed minter
+    );
+
+    /**
+     * @notice Minter at address `minter` set as minter for project
+     * `projectId` on core contract `coreContract`.
+     */
+    event ProjectMinterRegistered(
+        uint256 indexed projectId,
+        address indexed coreContract,
+        address indexed minter,
+        string minterType
+    );
+
+    /**
+     * @notice Minter removed for project `projectId` on core contract
+     * `coreContract`.
+     */
+    event ProjectMinterRemoved(
+        uint256 indexed projectId,
+        address indexed coreContract
+    );
+
+    /**
+     * @notice Admin ACL contract updated to `adminACLContract`.
+     */
+    event AdminACLUpdated(address indexed adminACLContract);
+
+    /**
+     * @notice Core Registry contract updated to `coreRegistry`.
+     */
+    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
+    ) external;
+
+    function removeMinterForProject(
+        uint256 _projectId,
+        address _coreContract
+    ) external;
+
+    // @dev function name is optimized for gas
+    function mint_joo(
+        address _to,
+        uint256 _projectId,
+        address _coreContract,
+        address _sender
+    ) external returns (uint256);
+
+    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
+    ) external view returns (address);
+
+    function projectHasMinter(
+        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
+     */
+    function isRegisteredCoreContract(
+        address _coreContract
+    ) external view returns (bool);
+
+    /// Address of current core registry contract
+    function coreRegistry() external view returns (ICoreRegistryV1);
+
+    /// The current admin ACL contract
+    function adminACLContract() external view returns (IAdminACLV0);
+
+    /// The quantity of projects on a core contract that have assigned minters
+    function getNumProjectsOnContractWithMinters(
+        address _coreContract
+    ) external view returns (uint256);
+
+    function getProjectAndMinterInfoOnContractAt(
+        address _coreContract,
+        uint256 _index
+    )
+        external
+        view
+        returns (
+            uint256 projectId,
+            address minterAddress,
+            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.
+     */
+    function owner() external view returns (address);
+}

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

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface IPseudorandomAtomic {
+    /**
+     * @notice This function atomically returns a pseudorandom bytes32 value.
+     * @param _entropy entropy to be included during the pseudorandom
+     * generation process. An example of entropy might be the hash of a core
+     * contract's address, and the ID of the token being generated.
+     */
+    function getPseudorandomAtomic(
+        bytes32 _entropy
+    ) external view returns (bytes32);
+}

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

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Creatd By: Art Blocks Inc.
 
-pragma solidity 0.8.17;
+pragma solidity 0.8.19;
 
 import "./IRandomizerV2.sol";
 

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

@@ -4,15 +4,12 @@
 pragma solidity ^0.8.0;
 
 import "./IGenArt721CoreContractV3_Base.sol";
+import "./IRandomizer_V3CoreBase.sol";
 
-interface IRandomizerV2 {
+interface IRandomizerV2 is IRandomizer_V3CoreBase {
     // The core contract that may interact with this randomizer contract.
     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.
-    function assignTokenHash(uint256 _tokenId) external;
 }

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,37 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+import "./ISharedMinterDAExpV0.sol";
+
+interface ISharedMinterDAExpSettlementV0 is ISharedMinterDAExpV0 {
+    /// receipt has an updated state
+    event ReceiptUpdated(
+        address indexed _purchaser,
+        uint256 indexed _projectId,
+        address indexed _coreContract,
+        uint24 _numPurchased,
+        uint256 _netPosted
+    );
+
+    /// 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,25 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface ISharedMinterDAExpV0 {
+    event SetAuctionDetailsExp(
+        uint256 indexed _projectId,
+        address indexed _coreContract,
+        uint40 _auctionTimestampStart,
+        uint40 _priceDecayHalfLifeSeconds,
+        uint256 _startPrice,
+        uint256 _basePrice
+    );
+    /// Minimum allowed price decay half life seconds updated.
+    event AuctionMinHalfLifeSecondsUpdated(
+        uint256 _minimumPriceDecayHalfLifeSeconds
+    );
+
+    function minimumPriceDecayHalfLifeSeconds() external view returns (uint256);
+
+    function setMinimumPriceDecayHalfLifeSeconds(
+        uint256 _minimumPriceDecayHalfLifeSeconds
+    ) external;
+}

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

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface ISharedMinterDALinV0 {
+    event SetAuctionDetailsLin(
+        uint256 indexed _projectId,
+        address indexed _coreContract,
+        uint40 _auctionTimestampStart,
+        uint40 _auctionTimestampEnd,
+        uint256 _startPrice,
+        uint256 _basePrice
+    );
+
+    /// Minimum allowed auction length updated
+    event AuctionMinimumLengthSecondsUpdated(
+        uint256 _minimumAuctionLengthSeconds
+    );
+
+    function minimumAuctionLengthSeconds() external view returns (uint256);
+
+    function setMinimumAuctionLengthSeconds(
+        uint256 _minimumAuctionLengthSeconds
+    ) external;
+}

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

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface ISharedMinterDAV0 {
+    /// Auction details cleared for project `projectId`.
+    event ResetAuctionDetails(
+        uint256 indexed _projectId,
+        address indexed _coreContract
+    );
+
+    // @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/ISharedMinterHolderV0.sol

@@ -0,0 +1,69 @@
+// 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 {
+    event DelegationRegistryUpdated(address delegationRegistry);
+    /**
+     * @notice Allow holders of NFTs at addresses `_ownedNFTAddresses`, project
+     * IDs `_ownedNFTProjectIds` to mint on project `_projectId`.
+     * `_ownedNFTAddresses` assumed to be aligned with `_ownedNFTProjectIds`.
+     * e.g. Allows holders of project `_ownedNFTProjectIds[0]` on token
+     * contract `_ownedNFTAddresses[0]` to mint.
+     */
+    event AllowedHoldersOfProjects(
+        uint256 indexed _projectId,
+        address indexed _coreContract,
+        address[] _ownedNFTAddresses,
+        uint256[] _ownedNFTProjectIds
+    );
+    /**
+     * @notice Remove holders of NFTs at addresses `_ownedNFTAddresses`,
+     * project IDs `_ownedNFTProjectIds` to mint on project `_projectId`.
+     * `_ownedNFTAddresses` assumed to be aligned with `_ownedNFTProjectIds`.
+     * e.g. Removes holders of project `_ownedNFTProjectIds[0]` on token
+     * contract `_ownedNFTAddresses[0]` from mint allowlist.
+     */
+    event RemovedHoldersOfProjects(
+        uint256 indexed _projectId,
+        address indexed _coreContract,
+        address[] _ownedNFTAddresses,
+        uint256[] _ownedNFTProjectIds
+    );
+
+    // 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);
+}