@artblocks/contracts 1.1.0 → 1.2.1

package/contracts/libs/v0.8.x/minter-libs/SplitFundsLib.sol

@@ -96,6 +96,44 @@ library SplitFundsLib {
         }
     }
 
+    /**
+     * @notice pays ETH funds to sender (if refund), with all of token price
+     * being sent to the render provider for a token purchased on project
+     * `projectId`.
+     * WARNING: This function uses msg.value and msg.sender to determine
+     * refund amounts, and therefore may not be applicable to all use cases
+     * (e.g. do not use with Dutch Auctions with on-chain settlement).
+     * @dev This function relies on msg.sender and msg.value, so it must be
+     * called directly from the contract that is receiving the payment.
+     * @dev possible DoS during splits is acknowledged, and mitigated by
+     * business practices, including end-to-end testing on mainnet, and
+     * admin-accepted artist payment addresses.
+     * @param projectId Project ID for which funds shall be split.
+     * @param pricePerTokenInWei Current price of token, in Wei.
+     * @param coreContract Address of the GenArt721CoreContract associated
+     * with the project.
+     */
+    function sendAllToRenderProviderETHRefundSender(
+        uint256 projectId,
+        uint256 pricePerTokenInWei,
+        address coreContract
+    ) internal {
+        if (msg.value > 0) {
+            // send refund to sender
+            uint256 refund = msg.value - pricePerTokenInWei;
+            if (refund > 0) {
+                (bool success_, ) = msg.sender.call{value: refund}("");
+                require(success_, "Refund failed");
+            }
+            // send remaining to render provider
+            sendAllToRenderProviderETHNoRefund({
+                projectId: projectId,
+                valueInWei: pricePerTokenInWei,
+                coreContract: coreContract
+            });
+        }
+    }
+
     /**
      * @notice Splits ETH revenues between providers, artist, and artist's
      * additional payee for revenue generated by project `projectId`.
@@ -185,6 +223,75 @@ library SplitFundsLib {
         });
     }
 
+    /**
+     * @notice Sends all revenue generated by project `projectId` to render
+     * provider.
+     * This function does NOT refund msg.sender, and does NOT use msg.value
+     * when determining the value to be split.
+     * @dev possible DoS during splits is acknowledged, and mitigated by
+     * business practices, including end-to-end testing on mainnet, and
+     * admin-accepted payment addresses.
+     * @param projectId Project ID for which funds shall be sent.
+     * @param valueInWei Value to be sent, in Wei.
+     * @param coreContract Address of the GenArt721CoreContract
+     * associated with the project.
+     */
+    function sendAllToRenderProviderETHNoRefund(
+        uint256 projectId,
+        uint256 valueInWei,
+        address coreContract
+    ) internal {
+        if (valueInWei == 0) {
+            return; // return early
+        }
+        // split funds between platforms, artist, and artist's
+        // additional payee
+        bool isEngine_ = isEngine(coreContract);
+        address payable renderProviderAddress;
+        if (isEngine_) {
+            // get engine splits
+            (
+                ,
+                renderProviderAddress,
+                ,
+                ,
+                ,
+                ,
+                ,
+
+            ) = IGenArt721CoreContractV3_Engine(coreContract)
+                .getPrimaryRevenueSplits({
+                    _projectId: projectId,
+                    _price: valueInWei
+                });
+        } else {
+            // get flagship splits
+            // @dev note that platformProviderAddress and
+            // platformProviderRevenue remain 0 for flagship
+            (
+                ,
+                // artblocks revenue
+                renderProviderAddress, // artblocks address
+                ,
+                ,
+                ,
+
+            ) = IGenArt721CoreContractV3(coreContract).getPrimaryRevenueSplits({
+                _projectId: projectId,
+                _price: valueInWei
+            });
+        }
+        require(
+            renderProviderAddress != address(0),
+            "Render Provider address not set"
+        );
+        // distribute revenue
+        // Render Provider / Art Blocks payment
+        // @dev previous conditional ensures valueInWei is non-zero
+        (bool success, ) = renderProviderAddress.call{value: valueInWei}("");
+        require(success, "Render Provider payment failed");
+    }
+
     /**
      * @notice Splits ERC20 funds between providers, artist, and artist's
      * additional payee, for a token purchased on project `projectId`.
@@ -197,7 +304,9 @@ library SplitFundsLib {
      * business practices, including end-to-end testing on mainnet, and
      * admin-accepted artist payment addresses.
      * @param projectId Project ID for which funds shall be split.
-     * @param pricePerToken Current price of token, no decimals.
+     * @param pricePerToken Current price of token, in base units. For example,
+     * if the ERC20 token has 6 decimals, an input value of `1_000_000` would
+     * represent a price of `1.000000` tokens.
      * @param coreContract Core contract address.
      */
     function splitFundsERC20(
@@ -221,7 +330,6 @@ library SplitFundsLib {
                 currencyAddress != address(0),
                 "ERC20: payment not configured"
             );
-            require(msg.value == 0, "ERC20: No ETH when using ERC20");
             // ERC20 token is used for payment
             validateERC20Approvals({
                 msgSender: msg.sender,
@@ -230,7 +338,7 @@ library SplitFundsLib {
             });
             projectCurrency = IERC20(currencyAddress);
         }
-        // split remaining funds between foundation, artist, and artist's
+        // split remaining funds between foundation, artist, and artist's additional payee
         bool isEngine_ = isEngine(coreContract);
         uint256 renderProviderRevenue;
         address payable renderProviderAddress;
@@ -333,9 +441,8 @@ library SplitFundsLib {
                 coreContract: coreContract
             });
         // recommend price reset if currency address was previously configured
-        if (splitFundsProjectConfig.currencyAddress != address(0)) {
-            recommendPriceReset = true;
-        }
+        recommendPriceReset = (splitFundsProjectConfig.currencyAddress !=
+            address(0));
         splitFundsProjectConfig.currencySymbol = currencySymbol;
         splitFundsProjectConfig.currencyAddress = currencyAddress;
 
@@ -478,10 +585,9 @@ library SplitFundsLib {
             // also note that per Solidity ABI encoding, the address return
             // values are padded to 32 bytes.
             return true;
-        } else {
-            // unexpected return value length
-            revert("Unexpected revenue split bytes");
         }
+        // unexpected return value length
+        revert("Unexpected revenue split bytes");
     }
 
     /**
@@ -491,8 +597,8 @@ library SplitFundsLib {
      * `currencyAddress` is zero.
      * @param projectId Project ID to get config for
      * @param coreContract Core contract address to get config for
-     * @return currencyAddress
-     * @return currencySymbol
+     * @return currencyAddress currency address for the referenced SplitFundsProjectConfig.
+     * @return currencySymbol currency symbol for the referenced SplitFundsProjectConfig.
      */
     function getCurrencyInfoERC20(
         uint256 projectId,
@@ -518,7 +624,7 @@ library SplitFundsLib {
      * @notice Gets the balance of `currencyAddress` ERC20 tokens for `walletAddress`.
      * @param currencyAddress ERC20 token address.
      * @param walletAddress wallet address.
-     * @return balance
+     * @return balance Balance of ERC-20
      */
     function getERC20Balance(
         address currencyAddress,
@@ -533,7 +639,7 @@ library SplitFundsLib {
      * @param currencyAddress ERC20 token address.
      * @param walletAddress wallet address.
      * @param spenderAddress spender address.
-     * @return allowance
+     * @return allowance Allowance of ERC-20
      */
     function getERC20Allowance(
         address currencyAddress,
@@ -555,7 +661,9 @@ library SplitFundsLib {
      * Reverts if insufficient allowance or balance.
      * @param msgSender Address of the message sender to validate.
      * @param currencyAddress Address of the ERC20 token to validate.
-     * @param pricePerToken Price per token to validate (no decimals)
+     * @param pricePerToken Price of token, in base units. For example,
+     * if the ERC20 token has 6 decimals, an input value of `1_000_000` would
+     * represent a price of `1.000000` tokens.
      */
     function validateERC20Approvals(
         address msgSender,
@@ -578,6 +686,9 @@ library SplitFundsLib {
     /**
      * @notice Sends ETH revenues between providers, artist, and artist's
      * additional payee. Reverts if any payment fails.
+     * @dev This function pays priviliged addresses. DoS is acknowledged, and
+     * mitigated by business practices, including end-to-end testing on
+     * mainnet, and admin-accepted artist payment addresses.
      * @param platformProviderRevenue Platform Provider revenue.
      * @param platformProviderAddress Platform Provider address.
      * @param renderProviderRevenue Render Provider revenue.
@@ -628,7 +739,9 @@ library SplitFundsLib {
     /**
      * @notice Sends ERC20 revenues between providers, artist, and artist's
      * additional payee. Reverts if any payment fails. All revenue values
-     * should not use decimals.
+     * should use base units. For example, if the ERC20 token has 6 decimals,
+     * an input value of `1_000_000` would represent an amount of `1.000000`
+     * tokens.
      * @dev This function relies on msg.sender, so it must be called from
      * the contract that is receiving the payment.
      * @param projectCurrency IERC20 payment token.

package/contracts/libs/v0.8.x/minter-libs/TokenHolderLib.sol

@@ -5,6 +5,8 @@ pragma solidity ^0.8.0;
 
 import {IERC721} from "@openzeppelin-4.7/contracts/token/ERC721/IERC721.sol";
 
+import {ABHelpers} from "../ABHelpers.sol";
+
 import {EnumerableSet} from "@openzeppelin-4.5/contracts/utils/structs/EnumerableSet.sol";
 
 /**
@@ -71,9 +73,6 @@ library TokenHolderLib {
     bytes32 constant TOKEN_HOLDER_LIB_STORAGE_POSITION =
         keccak256("tokenholderlib.storage");
 
-    // Define one million to represent the base token ID for each project.
-    uint256 constant ONE_MILLION = 1_000_000;
-
     struct HolderProjectConfig {
         // projects whose holders are allowed to purchase a token on `projectId`
         mapping(address ownedNFTAddress => mapping(uint256 ownedNFTProjectId => bool allowed)) allowedProjectHolders;
@@ -253,7 +252,9 @@ library TokenHolderLib {
                 projectId: projectId,
                 coreContract: coreContract
             });
-        uint256 ownedNFTProjectId = ownedNFTTokenId / ONE_MILLION;
+        uint256 ownedNFTProjectId = ABHelpers.tokenIdToProjectId(
+            ownedNFTTokenId
+        );
         return
             holderProjectConfig.allowedProjectHolders[ownedNFTAddress][
                 ownedNFTProjectId

package/contracts/minter-suite/MinterFilter/MinterFilterV2.sol

@@ -16,6 +16,7 @@ import {Bytes32Strings} from "../../libs/v0.8.x/Bytes32Strings.sol";
 import {Ownable} from "@openzeppelin-4.7/contracts/access/Ownable.sol";
 import {EnumerableMap} from "@openzeppelin-4.7/contracts/utils/structs/EnumerableMap.sol";
 import {EnumerableSet} from "@openzeppelin-4.7/contracts/utils/structs/EnumerableSet.sol";
+import {Math} from "@openzeppelin-4.7/contracts/utils/math/Math.sol";
 
 /**
  * @title MinterFilterV2
@@ -118,8 +119,7 @@ contract MinterFilterV2 is Ownable, IMinterFilterV1 {
 
     /**
      * @notice Function to restrict access to only AdminACL allowed calls
-     * on a given core contract.
-     * @dev defers to the ACL contract used by the core contract
+     * on this minter filter's admin ACL contract.
      * @param selector function selector to be checked
      */
     function _onlyAdminACL(bytes4 selector) internal {
@@ -274,7 +274,7 @@ contract MinterFilterV2 is Ownable, IMinterFilterV1 {
      */
     function approveMinterGlobally(address minter) external {
         _onlyAdminACL(this.approveMinterGlobally.selector);
-        // @dev add() return true if the value was removed from the set
+        // @dev add() return true if the value was added to the set
         require(
             _globallyApprovedMinters.add(minter),
             "Minter already approved"
@@ -326,7 +326,7 @@ contract MinterFilterV2 is Ownable, IMinterFilterV1 {
             coreContract: coreContract,
             selector: this.approveMinterForContract.selector
         });
-        // @dev add() returns true if the value was removed from the Set
+        // @dev add() returns true if the value was added to the Set
         require(
             _contractApprovedMinters[coreContract].add(minter),
             "Minter already approved"
@@ -539,6 +539,7 @@ contract MinterFilterV2 is Ownable, IMinterFilterV1 {
         uint256 projectId,
         address coreContract
     ) external view returns (address) {
+        // @dev use tryGet to control revert message if no minter assigned
         (bool hasMinter, address currentMinter) = _minterForProject[
             coreContract
         ].tryGet(projectId);
@@ -637,16 +638,21 @@ contract MinterFilterV2 is Ownable, IMinterFilterV1 {
         address coreContract,
         address minter
     ) external view returns (uint256[] memory projectIds) {
+        EnumerableMap.UintToAddressMap storage minterMap = _minterForProject[
+            coreContract
+        ];
         // initialize arrays with maximum potential length
-        // @dev use num projects using minter across all contracts since it the
-        // maximum length of this array
-        uint256 maxNumProjects = numProjectsUsingMinter[minter];
+        // @dev use lesser of num projects using minter across all contracts
+        // and number of projects on the contract with minters assigned, since
+        // both values represent an upper bound on the number of projects that
+        // could be using the minter on the contract
+        uint256 maxNumProjects = Math.min(
+            numProjectsUsingMinter[minter],
+            minterMap.length()
+        );
         projectIds = new uint256[](maxNumProjects);
         // iterate over all projects on contract, adding to array if using
         // `minter`
-        EnumerableMap.UintToAddressMap storage minterMap = _minterForProject[
-            coreContract
-        ];
         uint256 numProjects = minterMap.length();
         uint256 numProjectsOnContractUsingMinter;
         for (uint256 i; i < numProjects; ) {

package/contracts/minter-suite/Minters/MinterDAExpHolderV5.sol

@@ -365,7 +365,7 @@ contract MinterDAExpHolderV5 is
                 coreContract: coreContract
             })
         ) {
-            syncProjectMaxInvocationsToCore({
+            MaxInvocationsLib.syncProjectMaxInvocationsToCore({
                 projectId: projectId,
                 coreContract: coreContract
             });
@@ -837,7 +837,7 @@ contract MinterDAExpHolderV5 is
 
         // NOTE: delegate-vault handling **ends here**.
 
-        MaxInvocationsLib.validatePurchaseEffectsInvocations({
+        MaxInvocationsLib.validateMintEffectsInvocations({
             tokenId: tokenId,
             coreContract: coreContract
         });

package/contracts/minter-suite/Minters/MinterDAExpSettlementV3.sol

@@ -342,7 +342,7 @@ contract MinterDAExpSettlementV3 is
     /**
      * @notice Reclaims the sender's payment above current settled price for
      * project `projectId` on core contract `coreContract`.
-     * The current settled price is the the price paid for the most recently
+     * 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
@@ -366,7 +366,7 @@ contract MinterDAExpSettlementV3 is
 
     /**
      * @notice Reclaims the sender's payment above current settled price for
-     * projects in `projectIds`. The current settled price is the the price
+     * projects in `projectIds`. 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
@@ -702,7 +702,7 @@ contract MinterDAExpSettlementV3 is
     /**
      * @notice Reclaims the sender's payment above current settled price for
      * project `projectId` on core contract `coreContract`.
-     * The current settled price is the the price paid for the most recently
+     * 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
@@ -725,13 +725,14 @@ contract MinterDAExpSettlementV3 is
             to: to,
             projectId: projectId,
             coreContract: coreContract,
-            purchaserAddress: msg.sender
+            purchaserAddress: msg.sender,
+            doSendFunds: true
         });
     }
 
     /**
      * @notice Reclaims the sender's payment above current settled price for
-     * projects in `projectIds`. The current settled price is the the price
+     * projects in `projectIds`. 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
@@ -765,12 +766,14 @@ contract MinterDAExpSettlementV3 is
         // the receipt in storage
         uint256 excessSettlementFunds;
         for (uint256 i; i < projectIdsLength; ) {
-            SettlementExpLib.reclaimProjectExcessSettlementFundsTo({
-                to: to,
-                projectId: projectIds[i],
-                coreContract: coreContracts[i],
-                purchaserAddress: msg.sender
-            });
+            excessSettlementFunds += SettlementExpLib
+                .reclaimProjectExcessSettlementFundsTo({
+                    to: to,
+                    projectId: projectIds[i],
+                    coreContract: coreContracts[i],
+                    purchaserAddress: msg.sender,
+                    doSendFunds: false // do not send funds, just tally
+                });
 
             // gas efficiently increment i
             // won't overflow due to for loop, as well as gas limts
@@ -782,9 +785,10 @@ contract MinterDAExpSettlementV3 is
         // INTERACTIONS
         // send excess settlement funds in a single chunk for all
         // projects
-        bool success_;
-        (success_, ) = to.call{value: excessSettlementFunds}("");
-        require(success_, "Reclaiming failed");
+        if (excessSettlementFunds > 0) {
+            (bool success_, ) = to.call{value: excessSettlementFunds}("");
+            require(success_, "Reclaiming failed");
+        }
     }
 
     /**
@@ -849,7 +853,7 @@ contract MinterDAExpSettlementV3 is
 
         // verify token invocation is valid given local minter max invocations,
         // update local maxHasBeenInvoked
-        MaxInvocationsLib.validatePurchaseEffectsInvocations({
+        MaxInvocationsLib.validateMintEffectsInvocations({
             tokenId: tokenId,
             coreContract: coreContract
         });

package/contracts/minter-suite/Minters/MinterDAExpV5.sol

@@ -197,7 +197,7 @@ contract MinterDAExpV5 is
                 coreContract: coreContract
             })
         ) {
-            syncProjectMaxInvocationsToCore({
+            MaxInvocationsLib.syncProjectMaxInvocationsToCore({
                 projectId: projectId,
                 coreContract: coreContract
             });
@@ -528,7 +528,7 @@ contract MinterDAExpV5 is
             sender: msg.sender
         });
 
-        MaxInvocationsLib.validatePurchaseEffectsInvocations({
+        MaxInvocationsLib.validateMintEffectsInvocations({
             tokenId: tokenId,
             coreContract: coreContract
         });

package/contracts/minter-suite/Minters/MinterDALinHolderV5.sol

@@ -364,7 +364,7 @@ contract MinterDALinHolderV5 is
                 coreContract: coreContract
             })
         ) {
-            syncProjectMaxInvocationsToCore({
+            MaxInvocationsLib.syncProjectMaxInvocationsToCore({
                 projectId: projectId,
                 coreContract: coreContract
             });
@@ -827,7 +827,7 @@ contract MinterDALinHolderV5 is
 
         // NOTE: delegate-vault handling **ends here**.
 
-        MaxInvocationsLib.validatePurchaseEffectsInvocations({
+        MaxInvocationsLib.validateMintEffectsInvocations({
             tokenId: tokenId,
             coreContract: coreContract
         });

package/contracts/minter-suite/Minters/MinterDALinV5.sol

@@ -191,7 +191,7 @@ contract MinterDALinV5 is
                 coreContract: coreContract
             })
         ) {
-            syncProjectMaxInvocationsToCore({
+            MaxInvocationsLib.syncProjectMaxInvocationsToCore({
                 projectId: projectId,
                 coreContract: coreContract
             });
@@ -517,7 +517,7 @@ contract MinterDALinV5 is
             sender: msg.sender
         });
 
-        MaxInvocationsLib.validatePurchaseEffectsInvocations({
+        MaxInvocationsLib.validateMintEffectsInvocations({
             tokenId: tokenId,
             coreContract: coreContract
         });