@artblocks/contracts 1.0.4 → 1.2.0

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

@@ -0,0 +1,78 @@
+// 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 is intended to house interface items that were used on the
+// GenArt721CoreContractV3 Engine and derivative implementations prior to v3.2.0.
+// Namely, the platform and render provider secondary sales functions are exposed at the contract-level
+// instead of having only defaults defined at the contract level.
+interface IGenArt721CoreContractV3_Engine_PreV3p2 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);
+}

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

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import "./IAdminACLV0.sol";
+
+/**
+ * @title This interface defines a project finance struct that is used in the
+ * GenArt721CoreContractV3 flagship and derivative implementations beginning
+ * with v3.2.0. This struct is intended to house all financial information
+ * related to a project, including royalties, artist splits, and platform
+ * provider splits.
+ * @author Art Blocks Inc.
+ */
+interface IGenArt721CoreContractV3_ProjectFinance {
+    /// packed struct containing project financial information
+    struct ProjectFinance {
+        address payable additionalPayeePrimarySales;
+        // packed uint: max of 95, max uint8 = 255
+        uint8 secondaryMarketRoyaltyPercentage;
+        address payable additionalPayeeSecondarySales;
+        // packed uint: max of 100, max uint8 = 255
+        uint8 additionalPayeeSecondarySalesPercentage;
+        address payable artistAddress;
+        // packed uint: max of 100, max uint8 = 255
+        uint8 additionalPayeePrimarySalesPercentage;
+        address platformProviderSecondarySalesAddress;
+        // packed uint: max of 10_000 max uint16 = 65_535
+        uint16 platformProviderSecondarySalesBPS;
+        address renderProviderSecondarySalesAddress;
+        // packed uint: max of 10_000 max uint16 = 65_535
+        uint16 renderProviderSecondarySalesBPS;
+        // address to send ERC-2981 royalties to
+        address royaltySplitter;
+    }
+
+    /**
+     * @notice View function returning project financial details for project
+     * `_projectId`.
+     * @param _projectId Project ID to be queried.
+     * @return ProjectFinance Project financial details.
+     */
+    function projectIdToFinancials(
+        uint256 _projectId
+    ) external view returns (ProjectFinance memory);
+}

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

@@ -0,0 +1,91 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface IGenArt721Minter_PBAB {
+    /**
+     * @notice Price per token in wei updated for project `_projectId` to
+     * `_pricePerTokenInWei`.
+     */
+    event PricePerTokenInWeiUpdated(
+        uint256 indexed _projectId,
+        uint256 indexed _pricePerTokenInWei
+    );
+
+    /**
+     * @notice Currency updated for project `_projectId` to symbol
+     * `_currencySymbol` and address `_currencyAddress`.
+     */
+    event ProjectCurrencyInfoUpdated(
+        uint256 indexed _projectId,
+        address indexed _currencyAddress,
+        string _currencySymbol
+    );
+
+    /// togglePurchaseToDisabled updated
+    event PurchaseToDisabledUpdated(
+        uint256 indexed _projectId,
+        bool _purchaseToDisabled
+    );
+
+    // getter function of public variable
+    function minterType() external view returns (string memory);
+
+    function genArt721CoreAddress() external returns (address);
+
+    function minterFilterAddress() external returns (address);
+
+    // Triggers a purchase of a token from the desired project with ETH, to the
+    // TX-sending address.
+    function purchase(
+        uint256 _projectId
+    ) external payable returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project with ETH or any ERC-20 token, to the
+    // TX-sending address.
+    function purchase(
+        uint256 _projectId,
+        uint256 _maxPricePerToken,
+        address _currencyAddress
+    ) external payable returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project with ETH, to the specified
+    // receiving address.
+    function purchaseTo(
+        address _to,
+        uint256 _projectId
+    ) external payable returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project with ETH or any ERC-20 token, to the specified
+    // receiving address.
+    function purchaseTo(
+        address _to,
+        uint256 _projectId,
+        uint256 _maxPricePerToken,
+        address _currencyAddress
+    ) external payable returns (uint256 tokenId);
+
+    // Toggles the ability for `purchaseTo` to be called directly with a
+    // specified receiving address that differs from the TX-sending address.
+    function togglePurchaseToDisabled(uint256 _projectId) external;
+
+    // Called to make the minter contract aware of the max invocations for a
+    // given project.
+    function setProjectMaxInvocations(uint256 _projectId) external;
+
+    // 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
+    )
+        external
+        view
+        returns (
+            bool isConfigured,
+            uint256 tokenPriceInWei,
+            string memory currencySymbol,
+            address currencyAddress
+        );
+}

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

@@ -93,55 +93,55 @@ interface IMinterFilterV1 {
     }
 
     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.
+     * @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
+        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
@@ -152,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
@@ -173,7 +173,7 @@ interface IMinterFilterV1 {
         returns (MinterWithType[] memory mintersWithTypes);
 
     function getAllContractApprovedMinters(
-        address _coreContract
+        address coreContract
     ) external view returns (MinterWithType[] memory mintersWithTypes);
 
     /**

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

@@ -10,7 +10,5 @@ interface IPseudorandomAtomic {
      * 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);
+    function getPseudorandomAtomic(bytes32 _entropy) external returns (bytes32);
 }

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

@@ -5,33 +5,43 @@ 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
+    /// returns latest purchase price for project `projectId`, or 0 if no
     /// purchases have been made.
     function getProjectLatestPurchasePrice(
-        uint256 _projectId,
-        address _coreContract
+        uint256 projectId,
+        address coreContract
     ) external view returns (uint256 latestPurchasePrice);
 
-    /// returns the number of settleable invocations for project `_projectId`.
+    /// returns the number of settleable invocations for project `projectId`.
     function getNumSettleableInvocations(
-        uint256 _projectId,
-        address _coreContract
+        uint256 projectId,
+        address coreContract
     ) external view returns (uint256 numSettleableInvocations);
 
-    /// Returns the current excess settlement funds on project `_projectId`
-    /// for address `_walletAddress`.
+    /// Returns the current excess settlement funds on project `projectId`
+    /// for address `walletAddress`.
     function getProjectExcessSettlementFunds(
-        uint256 _projectId,
-        address _coreContract,
-        address _walletAddress
+        uint256 projectId,
+        address coreContract,
+        address walletAddress
     ) external view returns (uint256 excessSettlementFundsInWei);
+
+    /**
+     * @notice Reclaims the sender's payment above current settled price for
+     * project `projectId` on core contract `coreContract`.
+     * The current settled price is the price paid for the most recently
+     * purchased token, or the base price if the artist has withdrawn revenues
+     * after the auction reached base price.
+     * This function is callable at any point, but is expected to typically be
+     * called after auction has sold out above base price or after the auction
+     * has been purchased at base price. This minimizes the amount of gas
+     * required to send all excess settlement funds to the sender.
+     * Sends excess settlement funds to msg.sender.
+     * @param projectId Project ID to reclaim excess settlement funds on.
+     * @param coreContract Contract address of the core contract
+     */
+    function reclaimProjectExcessSettlementFunds(
+        uint256 projectId,
+        address coreContract
+    ) external;
 }

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

@@ -4,22 +4,9 @@
 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
+        uint256 minimumPriceDecayHalfLifeSeconds
     ) external;
 }

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

@@ -4,23 +4,9 @@
 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
+        uint256 minimumAuctionLengthSeconds
     ) external;
 }

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

@@ -4,16 +4,10 @@
 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
+        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

@@ -8,62 +8,34 @@ pragma solidity ^0.8.0;
  * @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
+        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
+        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
+        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

@@ -8,37 +8,27 @@ pragma solidity ^0.8.0;
  * @author Art Blocks Inc.
  */
 interface ISharedMinterMerkleV0 {
-    /**
-     * @notice Notifies of the contract's default maximum mints allowed per
-     * user for a given project, on this minter. This value can be overridden
-     * by the artist of any project at any time.
-     */
-    event DefaultMaxInvocationsPerAddress(
-        uint256 defaultMaxInvocationsPerAddress
-    );
-    event DelegationRegistryUpdated(address delegationRegistry);
-
     // 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
+        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
+        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
+        uint256 projectId,
+        address coreContract,
+        bytes32 root
     ) external;
 }

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

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface adds support for ranked auction minting.
+ * @author Art Blocks Inc.
+ */
+interface ISharedMinterRAMV0 {
+    function createBid(
+        uint256 projectId,
+        address coreContract,
+        uint16 slotIndex
+    ) external payable;
+
+    function topUpBid(
+        uint256 projectId,
+        address coreContract,
+        uint32 bidId,
+        uint16 newSlotIndex
+    ) external payable;
+}