@artblocks/contracts 0.0.1

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

@@ -0,0 +1,79 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import "./IAdminACLV0.sol";
+import "./IGenArt721CoreContractV3_Base.sol";
+
+/**
+ * @title This interface extends IGenArt721CoreContractV3_Base with functions
+ * that are part of the Art Blocks Flagship core contract.
+ * @author Art Blocks Inc.
+ */
+// This interface extends IGenArt721CoreContractV3_Base with functions that are
+// in part of the Art Blocks Flagship core contract.
+interface IGenArt721CoreContractV3 is IGenArt721CoreContractV3_Base {
+    // @dev new function in V3
+    function getPrimaryRevenueSplits(
+        uint256 _projectId,
+        uint256 _price
+    )
+        external
+        view
+        returns (
+            uint256 artblocksRevenue_,
+            address payable artblocksAddress_,
+            uint256 artistRevenue_,
+            address payable artistAddress_,
+            uint256 additionalPayeePrimaryRevenue_,
+            address payable additionalPayeePrimaryAddress_
+        );
+
+    // @dev Art Blocks primary sales payment address
+    function artblocksPrimarySalesAddress()
+        external
+        view
+        returns (address payable);
+
+    /**
+     * @notice Backwards-compatible (pre-V3) function returning Art Blocks
+     * primary sales payment address (now called artblocksPrimarySalesAddress).
+     */
+    function artblocksAddress() external view returns (address payable);
+
+    // @dev Percentage of primary sales allocated to Art Blocks
+    function artblocksPrimarySalesPercentage() external view returns (uint256);
+
+    /**
+     * @notice Backwards-compatible (pre-V3) function returning Art Blocks
+     * primary sales percentage (now called artblocksPrimarySalesPercentage).
+     */
+    function artblocksPercentage() external view returns (uint256);
+
+    // @dev Art Blocks secondary sales royalties payment address
+    function artblocksSecondarySalesAddress()
+        external
+        view
+        returns (address payable);
+
+    // @dev Basis points of secondary sales allocated to Art Blocks
+    function artblocksSecondarySalesBPS() external view returns (uint256);
+
+    /**
+     * @notice Backwards-compatible (pre-V3) function  that gets artist +
+     * artist's additional payee royalty data for token ID `_tokenId`.
+     * WARNING: Does not include Art Blocks portion of royalties.
+     */
+    function getRoyaltyData(
+        uint256 _tokenId
+    )
+        external
+        view
+        returns (
+            address artistAddress,
+            address additionalPayee,
+            uint256 additionalPayeePercentage,
+            uint256 royaltyFeeByID
+        );
+}

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

@@ -0,0 +1,127 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import "./IAdminACLV0.sol";
+/// use the Royalty Registry's IManifold interface for token royalties
+import "./IManifold.sol";
+
+/**
+ * @title This interface is intended to house interface items that are common
+ * across all GenArt721CoreContractV3 flagship and derivative implementations.
+ * This interface extends the IManifold royalty interface in order to
+ * add support the Royalty Registry by default.
+ * @author Art Blocks Inc.
+ */
+interface IGenArt721CoreContractV3_Base is IManifold {
+    /**
+     * @notice Token ID `_tokenId` minted to `_to`.
+     */
+    event Mint(address indexed _to, uint256 indexed _tokenId);
+
+    /**
+     * @notice currentMinter updated to `_currentMinter`.
+     * @dev Implemented starting with V3 core
+     */
+    event MinterUpdated(address indexed _currentMinter);
+
+    /**
+     * @notice Platform updated on bytes32-encoded field `_field`.
+     */
+    event PlatformUpdated(bytes32 indexed _field);
+
+    /**
+     * @notice Project ID `_projectId` updated on bytes32-encoded field
+     * `_update`.
+     */
+    event ProjectUpdated(uint256 indexed _projectId, bytes32 indexed _update);
+
+    event ProposedArtistAddressesAndSplits(
+        uint256 indexed _projectId,
+        address _artistAddress,
+        address _additionalPayeePrimarySales,
+        uint256 _additionalPayeePrimarySalesPercentage,
+        address _additionalPayeeSecondarySales,
+        uint256 _additionalPayeeSecondarySalesPercentage
+    );
+
+    event AcceptedArtistAddressesAndSplits(uint256 indexed _projectId);
+
+    // version and type of the core contract
+    // coreVersion is a string of the form "0.x.y"
+    function coreVersion() external view returns (string memory);
+
+    // coreType is a string of the form "GenArt721CoreV3"
+    function coreType() external view returns (string memory);
+
+    // owner (pre-V3 was named admin) of contract
+    // this is expected to be an Admin ACL contract for V3
+    function owner() external view returns (address);
+
+    // Admin ACL contract for V3, will be at the address owner()
+    function adminACLContract() external returns (IAdminACLV0);
+
+    // backwards-compatible (pre-V3) admin - equal to owner()
+    function admin() external view returns (address);
+
+    /**
+     * Function determining if _sender is allowed to call function with
+     * selector _selector on contract `_contract`. Intended to be used with
+     * peripheral contracts such as minters, as well as internally by the
+     * core contract itself.
+     */
+    function adminACLAllowed(
+        address _sender,
+        address _contract,
+        bytes4 _selector
+    ) external returns (bool);
+
+    // getter function of public variable
+    function nextProjectId() external view returns (uint256);
+
+    // getter function of public mapping
+    function tokenIdToProjectId(
+        uint256 tokenId
+    ) external view returns (uint256 projectId);
+
+    // @dev this is not available in V0
+    function isMintWhitelisted(address minter) external view returns (bool);
+
+    function projectIdToArtistAddress(
+        uint256 _projectId
+    ) external view returns (address payable);
+
+    function projectIdToAdditionalPayeePrimarySales(
+        uint256 _projectId
+    ) external view returns (address payable);
+
+    function projectIdToAdditionalPayeePrimarySalesPercentage(
+        uint256 _projectId
+    ) external view returns (uint256);
+
+    // @dev new function in V3
+    function projectStateData(
+        uint256 _projectId
+    )
+        external
+        view
+        returns (
+            uint256 invocations,
+            uint256 maxInvocations,
+            bool active,
+            bool paused,
+            uint256 completedTimestamp,
+            bool locked
+        );
+
+    // function to set a token's hash (must be guarded)
+    function setTokenHash_8PT(uint256 _tokenId, bytes32 _hash) external;
+
+    // @dev gas-optimized signature in V3 for `mint`
+    function mint_Ecf(
+        address _to,
+        uint256 _projectId,
+        address _by
+    ) external returns (uint256 tokenId);
+}

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

@@ -0,0 +1,80 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import "./IAdminACLV0.sol";
+import "./IGenArt721CoreContractV3_Base.sol";
+
+interface IGenArt721CoreContractV3_Engine is IGenArt721CoreContractV3_Base {
+    // @dev new function in V3
+    function getPrimaryRevenueSplits(
+        uint256 _projectId,
+        uint256 _price
+    )
+        external
+        view
+        returns (
+            uint256 renderProviderRevenue_,
+            address payable renderProviderAddress_,
+            uint256 platformProviderRevenue_,
+            address payable platformProviderAddress_,
+            uint256 artistRevenue_,
+            address payable artistAddress_,
+            uint256 additionalPayeePrimaryRevenue_,
+            address payable additionalPayeePrimaryAddress_
+        );
+
+    // @dev The render provider primary sales payment address
+    function renderProviderPrimarySalesAddress()
+        external
+        view
+        returns (address payable);
+
+    // @dev The platform provider primary sales payment address
+    function platformProviderPrimarySalesAddress()
+        external
+        view
+        returns (address payable);
+
+    // @dev Percentage of primary sales allocated to the render provider
+    function renderProviderPrimarySalesPercentage()
+        external
+        view
+        returns (uint256);
+
+    // @dev Percentage of primary sales allocated to the platform provider
+    function platformProviderPrimarySalesPercentage()
+        external
+        view
+        returns (uint256);
+
+    // @dev The render provider secondary sales royalties payment address
+    function renderProviderSecondarySalesAddress()
+        external
+        view
+        returns (address payable);
+
+    // @dev The platform provider secondary sales royalties payment address
+    function platformProviderSecondarySalesAddress()
+        external
+        view
+        returns (address payable);
+
+    // @dev Basis points of secondary sales allocated to the render provider
+    function renderProviderSecondarySalesBPS() external view returns (uint256);
+
+    // @dev Basis points of secondary sales allocated to the platform provider
+    function platformProviderSecondarySalesBPS()
+        external
+        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
+    ) external view returns (bytes12);
+}

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

@@ -0,0 +1,91 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface IGenArt721CoreV2_PBAB {
+    /**
+     * @notice Token ID `_tokenId` minted on project ID `_projectId` to `_to`.
+     */
+    event Mint(
+        address indexed _to,
+        uint256 indexed _tokenId,
+        uint256 indexed _projectId
+    );
+
+    // getter function of public variable
+    function admin() external view returns (address);
+
+    // getter function of public variable
+    function nextProjectId() external view returns (uint256);
+
+    // getter function of public mapping
+    function tokenIdToProjectId(
+        uint256 tokenId
+    ) external view returns (uint256 projectId);
+
+    function isWhitelisted(address sender) external view returns (bool);
+
+    function projectIdToCurrencySymbol(
+        uint256 _projectId
+    ) external view returns (string memory);
+
+    function projectIdToCurrencyAddress(
+        uint256 _projectId
+    ) external view returns (address);
+
+    function projectIdToArtistAddress(
+        uint256 _projectId
+    ) external view returns (address payable);
+
+    function projectIdToPricePerTokenInWei(
+        uint256 _projectId
+    ) external view returns (uint256);
+
+    function projectIdToAdditionalPayee(
+        uint256 _projectId
+    ) external view returns (address payable);
+
+    function projectIdToAdditionalPayeePercentage(
+        uint256 _projectId
+    ) external view returns (uint256);
+
+    function projectTokenInfo(
+        uint256 _projectId
+    )
+        external
+        view
+        returns (
+            address,
+            uint256,
+            uint256,
+            uint256,
+            bool,
+            address,
+            uint256,
+            string memory,
+            address
+        );
+
+    function renderProviderAddress() external view returns (address payable);
+
+    function renderProviderPercentage() external view returns (uint256);
+
+    function mint(
+        address _to,
+        uint256 _projectId,
+        address _by
+    ) external returns (uint256 tokenId);
+
+    function getRoyaltyData(
+        uint256 _tokenId
+    )
+        external
+        view
+        returns (
+            address artistAddress,
+            address additionalPayee,
+            uint256 additionalPayeePercentage,
+            uint256 royaltyFeeByID
+        );
+}

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

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+/// @dev Royalty Registry interface, used to support the Royalty Registry.
+/// @dev Source: https://github.com/manifoldxyz/royalty-registry-solidity/blob/main/contracts/specs/IManifold.sol
+
+/// @author: manifold.xyz
+
+/**
+ * @dev Royalty interface for creator core classes
+ */
+interface IManifold {
+    /**
+     * @dev Get royalites of a token.  Returns list of receivers and basisPoints
+     *
+     *  bytes4(keccak256('getRoyalties(uint256)')) == 0xbb3bafd6
+     *
+     *  => 0xbb3bafd6 = 0xbb3bafd6
+     */
+    function getRoyalties(
+        uint256 tokenId
+    ) external view returns (address payable[] memory, uint256[] memory);
+}

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

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface IMinterFilterV0 {
+    /**
+     * @notice Approved minter `_minterAddress`.
+     */
+    event MinterApproved(address indexed _minterAddress, string _minterType);
+
+    /**
+     * @notice Revoked approval for minter `_minterAddress`
+     */
+    event MinterRevoked(address indexed _minterAddress);
+
+    /**
+     * @notice Minter `_minterAddress` of type `_minterType`
+     * registered for project `_projectId`.
+     */
+    event ProjectMinterRegistered(
+        uint256 indexed _projectId,
+        address indexed _minterAddress,
+        string _minterType
+    );
+
+    /**
+     * @notice Any active minter removed for project `_projectId`.
+     */
+    event ProjectMinterRemoved(uint256 indexed _projectId);
+
+    function genArt721CoreAddress() external returns (address);
+
+    function setMinterForProject(uint256, address) external;
+
+    function removeMinterForProject(uint256) external;
+
+    function mint(
+        address _to,
+        uint256 _projectId,
+        address sender
+    ) external returns (uint256);
+
+    function getMinterForProject(uint256) external view returns (address);
+
+    function projectHasMinter(uint256) external view returns (bool);
+}

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

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface IRandomizer {
+    function returnValue() external view returns (bytes32);
+}

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

@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import "./IGenArt721CoreContractV3.sol";
+
+interface IRandomizerV2 {
+    // The core contract that may interact with this randomizer contract.
+    function genArt721Core() external view returns (IGenArt721CoreContractV3);
+
+    // 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;
+}