@artblocks/contracts 0.0.1 → 1.0.1

package/contracts/archive/minter-suite/Minters/MinterSetPriceERC20/MinterSetPriceERC20V1.sol

@@ -0,0 +1,411 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "../../../../interfaces/0.8.x/IGenArt721CoreContractV1.sol";
+import "../../../../interfaces/0.8.x/IMinterFilterV0.sol";
+import "../../../../interfaces/0.8.x/IFilteredMinterV0.sol";
+
+import "@openzeppelin-4.5/contracts/token/ERC20/IERC20.sol";
+import "@openzeppelin-4.5/contracts/security/ReentrancyGuard.sol";
+
+pragma solidity 0.8.9;
+
+/**
+ * @title Filtered Minter contract that allows tokens to be minted with ETH
+ * or any ERC-20 token.
+ * @author Art Blocks Inc.
+ */
+contract MinterSetPriceERC20V1 is ReentrancyGuard, IFilteredMinterV0 {
+    /// Core contract address this minter interacts with
+    address public immutable genArt721CoreAddress;
+
+    /// This contract handles cores with interface IV1
+    IGenArt721CoreContractV1 private immutable genArtCoreContract;
+
+    /// Minter filter address this minter interacts with
+    address public immutable minterFilterAddress;
+
+    /// Minter filter this minter may interact with.
+    IMinterFilterV0 private immutable minterFilter;
+
+    /// minterType for this minter
+    string public constant minterType = "MinterSetPriceERC20V1";
+
+    uint256 constant ONE_MILLION = 1_000_000;
+
+    /// projectId => has project reached its maximum number of invocations?
+    mapping(uint256 => bool) public projectMaxHasBeenInvoked;
+    /// projectId => project's maximum number of invocations
+    mapping(uint256 => uint256) public projectMaxInvocations;
+    /// projectId => price per token in wei - supersedes any defined core price
+    mapping(uint256 => uint256) private projectIdToPricePerTokenInWei;
+    /// projectId => price per token has been configured on this minter
+    mapping(uint256 => bool) private projectIdToPriceIsConfigured;
+    /// projectId => currency symbol - supersedes any defined core value
+    mapping(uint256 => string) private projectIdToCurrencySymbol;
+    /// projectId => currency address - supersedes any defined core value
+    mapping(uint256 => address) private projectIdToCurrencyAddress;
+
+    modifier onlyCoreWhitelisted() {
+        require(
+            genArtCoreContract.isWhitelisted(msg.sender),
+            "Only Core whitelisted"
+        );
+        _;
+    }
+
+    modifier onlyArtist(uint256 _projectId) {
+        require(
+            msg.sender ==
+                genArtCoreContract.projectIdToArtistAddress(_projectId),
+            "Only Artist"
+        );
+        _;
+    }
+
+    /**
+     * @notice Initializes contract to be a Filtered Minter for
+     * `_minterFilter`, integrated with Art Blocks core contract
+     * at address `_genArt721Address`.
+     * @param _genArt721Address Art Blocks core contract for which this
+     * contract will be a minter.
+     * @param _minterFilter Minter filter for which
+     * this will a filtered minter.
+     */
+    constructor(
+        address _genArt721Address,
+        address _minterFilter
+    ) ReentrancyGuard() {
+        genArt721CoreAddress = _genArt721Address;
+        genArtCoreContract = IGenArt721CoreContractV1(_genArt721Address);
+        minterFilterAddress = _minterFilter;
+        minterFilter = IMinterFilterV0(_minterFilter);
+        require(
+            minterFilter.genArt721CoreAddress() == _genArt721Address,
+            "Illegal contract pairing"
+        );
+    }
+
+    /**
+     * @notice Gets your balance of the ERC-20 token currently set
+     * as the payment currency for project `_projectId`.
+     * @param _projectId Project ID to be queried.
+     * @return balance Balance of ERC-20
+     */
+    function getYourBalanceOfProjectERC20(
+        uint256 _projectId
+    ) external view returns (uint256 balance) {
+        balance = IERC20(projectIdToCurrencyAddress[_projectId]).balanceOf(
+            msg.sender
+        );
+        return balance;
+    }
+
+    /**
+     * @notice Gets your allowance for this minter of the ERC-20
+     * token currently set as the payment currency for project
+     * `_projectId`.
+     * @param _projectId Project ID to be queried.
+     * @return remaining Remaining allowance of ERC-20
+     */
+    function checkYourAllowanceOfProjectERC20(
+        uint256 _projectId
+    ) external view returns (uint256 remaining) {
+        remaining = IERC20(projectIdToCurrencyAddress[_projectId]).allowance(
+            msg.sender,
+            address(this)
+        );
+        return remaining;
+    }
+
+    /**
+     * @notice Sets the maximum invocations of project `_projectId` based
+     * on the value currently defined in the core contract.
+     * @param _projectId Project ID to set the maximum invocations for.
+     * @dev also checks and may refresh projectMaxHasBeenInvoked for project
+     * @dev this enables gas reduction after maxInvocations have been reached -
+     * core contracts shall still enforce a maxInvocation check during mint.
+     */
+    function setProjectMaxInvocations(
+        uint256 _projectId
+    ) external onlyCoreWhitelisted {
+        uint256 invocations;
+        uint256 maxInvocations;
+        (, , invocations, maxInvocations, , , , , ) = genArtCoreContract
+            .projectTokenInfo(_projectId);
+        // update storage with results
+        projectMaxInvocations[_projectId] = maxInvocations;
+        if (invocations < maxInvocations) {
+            projectMaxHasBeenInvoked[_projectId] = false;
+        }
+    }
+
+    /**
+     * @notice Warning: Disabling purchaseTo is not supported on this minter.
+     * This method exists purely for interface-conformance purposes.
+     */
+    function togglePurchaseToDisabled(
+        uint256 _projectId
+    ) external view onlyArtist(_projectId) {
+        revert("Action not supported");
+    }
+
+    /**
+     * @notice Updates this minter's price per token of project `_projectId`
+     * to be '_pricePerTokenInWei`, in Wei.
+     * This price supersedes any legacy core contract price per token value.
+     */
+    function updatePricePerTokenInWei(
+        uint256 _projectId,
+        uint256 _pricePerTokenInWei
+    ) external onlyArtist(_projectId) {
+        projectIdToPricePerTokenInWei[_projectId] = _pricePerTokenInWei;
+        projectIdToPriceIsConfigured[_projectId] = true;
+        emit PricePerTokenInWeiUpdated(_projectId, _pricePerTokenInWei);
+    }
+
+    /**
+     * @notice Updates payment currency of project `_projectId` to be
+     * `_currencySymbol` at address `_currencyAddress`.
+     * @param _projectId Project ID to update.
+     * @param _currencySymbol Currency symbol.
+     * @param _currencyAddress Currency address.
+     */
+    function updateProjectCurrencyInfo(
+        uint256 _projectId,
+        string memory _currencySymbol,
+        address _currencyAddress
+    ) external onlyArtist(_projectId) {
+        // require null address if symbol is "ETH"
+        require(
+            (keccak256(abi.encodePacked(_currencySymbol)) ==
+                keccak256(abi.encodePacked("ETH"))) ==
+                (_currencyAddress == address(0)),
+            "ETH is only null address"
+        );
+        projectIdToCurrencySymbol[_projectId] = _currencySymbol;
+        projectIdToCurrencyAddress[_projectId] = _currencyAddress;
+        emit ProjectCurrencyInfoUpdated(
+            _projectId,
+            _currencyAddress,
+            _currencySymbol
+        );
+    }
+
+    /**
+     * @notice Purchases a token from project `_projectId`.
+     * @param _projectId Project ID to mint a token on.
+     * @return tokenId Token ID of minted token
+     */
+    function purchase(
+        uint256 _projectId
+    ) external payable returns (uint256 tokenId) {
+        tokenId = purchaseTo(msg.sender, _projectId);
+        return tokenId;
+    }
+
+    /**
+     * @notice Purchases a token from project `_projectId` and sets
+     * the token's owner to `_to`.
+     * @param _to Address to be the new token's owner.
+     * @param _projectId Project ID to mint a token on.
+     * @return tokenId Token ID of minted token
+     */
+    function purchaseTo(
+        address _to,
+        uint256 _projectId
+    ) public payable nonReentrant returns (uint256 tokenId) {
+        // CHECKS
+        require(
+            !projectMaxHasBeenInvoked[_projectId],
+            "Maximum number of invocations reached"
+        );
+
+        // require artist to have configured price of token on this minter
+        require(
+            projectIdToPriceIsConfigured[_projectId],
+            "Price not configured"
+        );
+
+        // EFFECTS
+        tokenId = minterFilter.mint(_to, _projectId, msg.sender);
+        // what if projectMaxInvocations[_projectId] is 0 (default value)?
+        // that is intended, so that by default the minter allows infinite transactions,
+        // allowing the artblocks contract to stop minting
+        // uint256 tokenInvocation = tokenId % ONE_MILLION;
+        if (
+            projectMaxInvocations[_projectId] > 0 &&
+            tokenId % ONE_MILLION == projectMaxInvocations[_projectId] - 1
+        ) {
+            projectMaxHasBeenInvoked[_projectId] = true;
+        }
+
+        // INTERACTIONS
+        if (projectIdToCurrencyAddress[_projectId] != address(0)) {
+            require(
+                msg.value == 0,
+                "this project accepts a different currency and cannot accept ETH"
+            );
+            require(
+                IERC20(projectIdToCurrencyAddress[_projectId]).allowance(
+                    msg.sender,
+                    address(this)
+                ) >= projectIdToPricePerTokenInWei[_projectId],
+                "Insufficient Funds Approved for TX"
+            );
+            require(
+                IERC20(projectIdToCurrencyAddress[_projectId]).balanceOf(
+                    msg.sender
+                ) >= projectIdToPricePerTokenInWei[_projectId],
+                "Insufficient balance."
+            );
+            _splitFundsERC20(_projectId);
+        } else {
+            require(
+                msg.value >= projectIdToPricePerTokenInWei[_projectId],
+                "Must send minimum value to mint!"
+            );
+            _splitFundsETH(_projectId);
+        }
+
+        return tokenId;
+    }
+
+    /**
+     * @dev splits ETH funds between sender (if refund), foundation,
+     * artist, and artist's additional payee for a token purchased on
+     * project `_projectId`.
+     * @dev utilizes transfer() to send ETH, so access lists may need to be
+     * populated when purchasing tokens.
+     */
+    function _splitFundsETH(uint256 _projectId) internal {
+        if (msg.value > 0) {
+            uint256 pricePerTokenInWei = projectIdToPricePerTokenInWei[
+                _projectId
+            ];
+            uint256 refund = msg.value - pricePerTokenInWei;
+            if (refund > 0) {
+                (bool success_, ) = msg.sender.call{value: refund}("");
+                require(success_, "Refund failed");
+            }
+            uint256 foundationAmount = (pricePerTokenInWei *
+                genArtCoreContract.artblocksPercentage()) / 100;
+            if (foundationAmount > 0) {
+                (bool success_, ) = genArtCoreContract.artblocksAddress().call{
+                    value: foundationAmount
+                }("");
+                require(success_, "Foundation payment failed");
+            }
+            uint256 projectFunds = pricePerTokenInWei - foundationAmount;
+            uint256 additionalPayeeAmount;
+            if (
+                genArtCoreContract.projectIdToAdditionalPayeePercentage(
+                    _projectId
+                ) > 0
+            ) {
+                additionalPayeeAmount =
+                    (projectFunds *
+                        genArtCoreContract.projectIdToAdditionalPayeePercentage(
+                            _projectId
+                        )) /
+                    100;
+                if (additionalPayeeAmount > 0) {
+                    (bool success_, ) = genArtCoreContract
+                        .projectIdToAdditionalPayee(_projectId)
+                        .call{value: additionalPayeeAmount}("");
+                    require(success_, "Additional payment failed");
+                }
+            }
+            uint256 creatorFunds = projectFunds - additionalPayeeAmount;
+            if (creatorFunds > 0) {
+                (bool success_, ) = genArtCoreContract
+                    .projectIdToArtistAddress(_projectId)
+                    .call{value: creatorFunds}("");
+                require(success_, "Artist payment failed");
+            }
+        }
+    }
+
+    /**
+     * @dev splits ERC-20 funds between foundation, artist, and artist's
+     * additional payee, for a token purchased on project `_projectId`.
+     */
+    function _splitFundsERC20(uint256 _projectId) internal {
+        uint256 pricePerTokenInWei = projectIdToPricePerTokenInWei[_projectId];
+        uint256 foundationAmount = (pricePerTokenInWei *
+            genArtCoreContract.artblocksPercentage()) / 100;
+        if (foundationAmount > 0) {
+            IERC20(projectIdToCurrencyAddress[_projectId]).transferFrom(
+                msg.sender,
+                genArtCoreContract.artblocksAddress(),
+                foundationAmount
+            );
+        }
+        uint256 projectFunds = pricePerTokenInWei - foundationAmount;
+        uint256 additionalPayeeAmount;
+        if (
+            genArtCoreContract.projectIdToAdditionalPayeePercentage(
+                _projectId
+            ) > 0
+        ) {
+            additionalPayeeAmount =
+                (projectFunds *
+                    genArtCoreContract.projectIdToAdditionalPayeePercentage(
+                        _projectId
+                    )) /
+                100;
+            if (additionalPayeeAmount > 0) {
+                IERC20(projectIdToCurrencyAddress[_projectId]).transferFrom(
+                    msg.sender,
+                    genArtCoreContract.projectIdToAdditionalPayee(_projectId),
+                    additionalPayeeAmount
+                );
+            }
+        }
+        uint256 creatorFunds = projectFunds - additionalPayeeAmount;
+        if (creatorFunds > 0) {
+            IERC20(projectIdToCurrencyAddress[_projectId]).transferFrom(
+                msg.sender,
+                genArtCoreContract.projectIdToArtistAddress(_projectId),
+                creatorFunds
+            );
+        }
+    }
+
+    /**
+     * @notice Gets if price of token is configured, price of minting a
+     * token on project `_projectId`, and currency symbol and address to be
+     * used as payment. Supersedes any core contract price information.
+     * @param _projectId Project ID to get price information for.
+     * @return isConfigured true only if token price has been configured on
+     * this minter
+     * @return tokenPriceInWei current price of token on this minter - invalid
+     * if price has not yet been configured
+     * @return currencySymbol currency symbol for purchases of project on this
+     * minter. "ETH" reserved for ether.
+     * @return currencyAddress currency address for purchases of project on
+     * this minter. Null address reserved for ether.
+     */
+    function getPriceInfo(
+        uint256 _projectId
+    )
+        external
+        view
+        returns (
+            bool isConfigured,
+            uint256 tokenPriceInWei,
+            string memory currencySymbol,
+            address currencyAddress
+        )
+    {
+        isConfigured = projectIdToPriceIsConfigured[_projectId];
+        tokenPriceInWei = projectIdToPricePerTokenInWei[_projectId];
+        currencyAddress = projectIdToCurrencyAddress[_projectId];
+        if (currencyAddress == address(0)) {
+            // defaults to ETH
+            currencySymbol = "ETH";
+        } else {
+            currencySymbol = projectIdToCurrencySymbol[_projectId];
+        }
+    }
+}

package/contracts/{minter-suite → archive/minter-suite}/Minters/MinterSetPriceERC20/MinterSetPriceERC20V2.sol

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Created By: Art Blocks Inc.
 
-import "../../../interfaces/0.8.x/IGenArt721CoreContractV3.sol";
-import "../../../interfaces/0.8.x/IMinterFilterV0.sol";
-import "../../../interfaces/0.8.x/IFilteredMinterV0.sol";
+import "../../../../interfaces/0.8.x/IGenArt721CoreContractV3.sol";
+import "../../../../interfaces/0.8.x/IMinterFilterV0.sol";
+import "../../../../interfaces/0.8.x/IFilteredMinterV0.sol";
 
 import "@openzeppelin-4.5/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin-4.5/contracts/security/ReentrancyGuard.sol";

package/contracts/{minter-suite → archive/minter-suite}/Minters/MinterSetPriceERC20/MinterSetPriceERC20V3.sol

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Created By: Art Blocks Inc.
 
-import "../../../interfaces/0.8.x/IGenArt721CoreContractV3.sol";
-import "../../../interfaces/0.8.x/IMinterFilterV0.sol";
-import "../../../interfaces/0.8.x/IFilteredMinterV2.sol";
+import "../../../../interfaces/0.8.x/IGenArt721CoreContractV3.sol";
+import "../../../../interfaces/0.8.x/IMinterFilterV0.sol";
+import "../../../../interfaces/0.8.x/IFilteredMinterV2.sol";
 
 import "@openzeppelin-4.5/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin-4.5/contracts/security/ReentrancyGuard.sol";

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

@@ -1,70 +1,21 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Created By: Art Blocks Inc.
 
+import "./IFilteredMinterDAExpSettlement_Mixin.sol";
 import "./IFilteredMinterV1.sol";
 import "./IFilteredMinterDAExpV0.sol";
 
 pragma solidity ^0.8.0;
 
 /**
- * @title This interface extends the IFilteredMinterV1 interface in order to
- * add support for Dutch Auction with Settlement minter updates.
- * @dev keys represent strings of finite length encoded in bytes32 to minimize
- * gas.
+ * @title This interface combines the set of interfaces that add support for
+ * a Dutch Auction with Settlement minter.
  * @author Art Blocks Inc.
  */
 interface IFilteredMinterDAExpSettlementV0 is
+    IFilteredMinterDAExpSettlement_Mixin,
     IFilteredMinterV1,
     IFilteredMinterDAExpV0
 {
-    /// Auction details cleared for project `projectId`.
-    /// At time of reset, the project has had `numPurchases` purchases on this
-    /// minter, with a most recent purchase price of `latestPurchasePrice`. If
-    /// the number of purchases is 0, the latest purchase price will have a
-    /// dummy value of 0.
-    event ResetAuctionDetails(
-        uint256 indexed projectId,
-        uint256 numPurchases,
-        uint256 latestPurchasePrice
-    );
 
-    /// sellout price updated for project `projectId`.
-    /// @dev does not use generic event because likely will trigger additional
-    /// actions in indexing layer
-    event SelloutPriceUpdated(
-        uint256 indexed _projectId,
-        uint256 _selloutPrice
-    );
-
-    /// artist and admin have withdrawn revenues from settleable purchases for
-    /// project `projectId`.
-    /// @dev does not use generic event because likely will trigger additional
-    /// actions in indexing layer
-    event ArtistAndAdminRevenuesWithdrawn(uint256 indexed _projectId);
-
-    /// receipt has an updated state
-    event ReceiptUpdated(
-        address indexed _purchaser,
-        uint256 indexed _projectId,
-        uint256 _numPurchased,
-        uint256 _netPosted
-    );
-
-    /// returns latest purchase price for project `_projectId`, or 0 if no
-    /// purchases have been made.
-    function getProjectLatestPurchasePrice(
-        uint256 _projectId
-    ) external view returns (uint256 latestPurchasePrice);
-
-    /// returns the number of settleable invocations for project `_projectId`.
-    function getNumSettleableInvocations(
-        uint256 _projectId
-    ) external view returns (uint256 numSettleableInvocations);
-
-    /// Returns the current excess settlement funds on project `_projectId`
-    /// for address `_walletAddress`.
-    function getProjectExcessSettlementFunds(
-        uint256 _projectId,
-        address _walletAddress
-    ) external view returns (uint256 excessSettlementFundsInWei);
 }

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/IFilteredMinterDAExpSettlement_Mixin.sol

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface is a mixin for IFilteredMinterExpSettlementV<version>
+ * interfaces to use when defining settlement minter interfaces.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterDAExpSettlement_Mixin {
+    /// Auction details cleared for project `projectId`.
+    /// At time of reset, the project has had `numPurchases` purchases on this
+    /// minter, with a most recent purchase price of `latestPurchasePrice`. If
+    /// the number of purchases is 0, the latest purchase price will have a
+    /// dummy value of 0.
+    event ResetAuctionDetails(
+        uint256 indexed projectId,
+        uint256 numPurchases,
+        uint256 latestPurchasePrice
+    );
+
+    /// sellout price updated for project `projectId`.
+    /// @dev does not use generic event because likely will trigger additional
+    /// actions in indexing layer
+    event SelloutPriceUpdated(
+        uint256 indexed _projectId,
+        uint256 _selloutPrice
+    );
+
+    /// artist and admin have withdrawn revenues from settleable purchases for
+    /// project `projectId`.
+    /// @dev does not use generic event because likely will trigger additional
+    /// actions in indexing layer
+    event ArtistAndAdminRevenuesWithdrawn(uint256 indexed _projectId);
+
+    /// receipt has an updated state
+    event ReceiptUpdated(
+        address indexed _purchaser,
+        uint256 indexed _projectId,
+        uint256 _numPurchased,
+        uint256 _netPosted
+    );
+
+    /// returns latest purchase price for project `_projectId`, or 0 if no
+    /// purchases have been made.
+    function getProjectLatestPurchasePrice(
+        uint256 _projectId
+    ) external view returns (uint256 latestPurchasePrice);
+
+    /// returns the number of settleable invocations for project `_projectId`.
+    function getNumSettleableInvocations(
+        uint256 _projectId
+    ) external view returns (uint256 numSettleableInvocations);
+
+    /// Returns the current excess settlement funds on project `_projectId`
+    /// for address `_walletAddress`.
+    function getProjectExcessSettlementFunds(
+        uint256 _projectId,
+        address _walletAddress
+    ) external view returns (uint256 excessSettlementFundsInWei);
+}

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

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterV2.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface defines any events or functions required for a minter
+ * to conform to the MinterBase contract.
+ * @dev The MinterBase contract was not implemented from the beginning of the
+ * MinterSuite contract suite, therefore early versions of some minters may not
+ * conform to this interface.
+ * @author Art Blocks Inc.
+ */
+interface IMinterBaseV0 {
+    // Function that returns if a minter is configured to integrate with a V3 flagship or V3 engine contract.
+    // Returns true only if the minter is configured to integrate with an engine contract.
+    function isEngine() external returns (bool isEngine);
+}

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`.
      */