@artblocks/contracts 1.0.4 → 1.2.0

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

@@ -1,14 +1,14 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Created By: Art Blocks Inc.
 
-import "../../../interfaces/v0.8.x/IMinterBaseV0.sol";
-import "../../../interfaces/v0.8.x/IGenArt721CoreContractV3_Base.sol";
-import "../../../interfaces/v0.8.x/IGenArt721CoreContractV3.sol";
-import "../../../interfaces/v0.8.x/IGenArt721CoreContractV3_Engine.sol";
+pragma solidity ^0.8.0;
 
-import "@openzeppelin-4.7/contracts/token/ERC20/IERC20.sol";
+import {IMinterBaseV0} from "../../../interfaces/v0.8.x/IMinterBaseV0.sol";
+import {IGenArt721CoreContractV3_Base} from "../../../interfaces/v0.8.x/IGenArt721CoreContractV3_Base.sol";
+import {IGenArt721CoreContractV3} from "../../../interfaces/v0.8.x/IGenArt721CoreContractV3.sol";
+import {IGenArt721CoreContractV3_Engine} from "../../../interfaces/v0.8.x/IGenArt721CoreContractV3_Engine.sol";
 
-pragma solidity ^0.8.0;
+import {IERC20} from "@openzeppelin-4.7/contracts/token/ERC20/IERC20.sol";
 
 /**
  * @title Art Blocks Split Funds Library
@@ -20,6 +20,26 @@ pragma solidity ^0.8.0;
  */
 
 library SplitFundsLib {
+    /**
+     * @notice Currency updated for project `projectId` to symbol
+     * `currencySymbol` and address `currencyAddress`.
+     * @param projectId Project ID currency was updated for
+     * @param coreContract Core contract address currency was updated for
+     * @param currencyAddress Currency address
+     * @param currencySymbol Currency symbol
+     */
+    event ProjectCurrencyInfoUpdated(
+        uint256 indexed projectId,
+        address indexed coreContract,
+        address indexed currencyAddress,
+        string currencySymbol
+    );
+
+    // position of Split Funds Lib storage, using a diamond storage pattern
+    // for this library
+    bytes32 constant SPLIT_FUNDS_LIB_STORAGE_POSITION =
+        keccak256("splitfundslib.storage");
+
     // contract-level variables
     struct IsEngineCache {
         bool isEngine;
@@ -32,10 +52,16 @@ library SplitFundsLib {
         string currencySymbol; // Assumed to be ETH if null
     }
 
+    // Diamond storage pattern is used in this library
+    struct SplitFundsLibStorage {
+        mapping(address coreContract => mapping(uint256 projectId => SplitFundsProjectConfig)) splitFundsProjectConfigs;
+        mapping(address coreContract => IsEngineCache) isEngineCacheConfigs;
+    }
+
     /**
      * @notice splits ETH funds between sender (if refund), providers,
      * artist, and artist's additional payee for a token purchased on
-     * project `_projectId`.
+     * 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).
@@ -44,269 +70,281 @@ library SplitFundsLib {
      * @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
+     * @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.
-     * @param _isEngine Whether the core contract is an engine contract.
      */
-    function splitFundsETH(
-        uint256 _projectId,
-        uint256 _pricePerTokenInWei,
-        address _coreContract,
-        bool _isEngine
+    function splitFundsETHRefundSender(
+        uint256 projectId,
+        uint256 pricePerTokenInWei,
+        address coreContract
     ) internal {
         if (msg.value > 0) {
-            bool success_;
             // send refund to sender
-            uint256 refund = msg.value - _pricePerTokenInWei;
+            uint256 refund = msg.value - pricePerTokenInWei;
             if (refund > 0) {
-                (success_, ) = msg.sender.call{value: refund}("");
+                (bool success_, ) = msg.sender.call{value: refund}("");
                 require(success_, "Refund failed");
             }
             // split revenues
-            splitRevenuesETH(
-                _projectId,
-                _pricePerTokenInWei,
-                _coreContract,
-                _isEngine
-            );
+            splitRevenuesETHNoRefund({
+                projectId: projectId,
+                valueInWei: pricePerTokenInWei,
+                coreContract: coreContract
+            });
         }
     }
 
     /**
      * @notice Splits ETH revenues between providers, artist, and artist's
-     * additional payee for revenue generated by project `_projectId`.
+     * additional payee for revenue generated by project `projectId`.
+     * 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 artist payment addresses.
-     * @param _projectId Project ID for which funds shall be split.
-     * @param _valueInWei Value to be split, in Wei.
-     * @param _coreContract Address of the GenArt721CoreContract
+     * @param projectId Project ID for which funds shall be split.
+     * @param valueInWei Value to be split, in Wei.
+     * @param coreContract Address of the GenArt721CoreContract
      * associated with the project.
-     * @param _isEngine Whether the core contract is an engine contract.
      */
-    function splitRevenuesETH(
-        uint256 _projectId,
-        uint256 _valueInWei,
-        address _coreContract,
-        bool _isEngine
+    function splitRevenuesETHNoRefund(
+        uint256 projectId,
+        uint256 valueInWei,
+        address coreContract
     ) internal {
-        if (_valueInWei == 0) {
+        if (valueInWei == 0) {
             return; // return early
         }
-        bool success;
         // split funds between platforms, artist, and artist's
         // additional payee
-        uint256 renderProviderRevenue_;
-        address payable renderProviderAddress_;
-        uint256 artistRevenue_;
-        address payable artistAddress_;
-        uint256 additionalPayeePrimaryRevenue_;
-        address payable additionalPayeePrimaryAddress_;
-
-        if (_isEngine) {
+        bool isEngine_ = isEngine(coreContract);
+        uint256 renderProviderRevenue;
+        address payable renderProviderAddress;
+        uint256 platformProviderRevenue;
+        address payable platformProviderAddress;
+        uint256 artistRevenue;
+        address payable artistAddress;
+        uint256 additionalPayeePrimaryRevenue;
+        address payable additionalPayeePrimaryAddress;
+        if (isEngine_) {
             // get engine splits
-            uint256 platformProviderRevenue_;
-            address payable platformProviderAddress_;
             (
-                renderProviderRevenue_,
-                renderProviderAddress_,
-                platformProviderRevenue_,
-                platformProviderAddress_,
-                artistRevenue_,
-                artistAddress_,
-                additionalPayeePrimaryRevenue_,
-                additionalPayeePrimaryAddress_
-            ) = IGenArt721CoreContractV3_Engine(_coreContract)
-                .getPrimaryRevenueSplits(_projectId, _valueInWei);
-            // Platform Provider payment (only possible if engine)
-            if (platformProviderRevenue_ > 0) {
-                (success, ) = platformProviderAddress_.call{
-                    value: platformProviderRevenue_
-                }("");
-                require(success, "Platform Provider payment failed");
-            }
+                renderProviderRevenue,
+                renderProviderAddress,
+                platformProviderRevenue,
+                platformProviderAddress,
+                artistRevenue,
+                artistAddress,
+                additionalPayeePrimaryRevenue,
+                additionalPayeePrimaryAddress
+            ) = IGenArt721CoreContractV3_Engine(coreContract)
+                .getPrimaryRevenueSplits({
+                    _projectId: projectId,
+                    _price: valueInWei
+                });
         } else {
             // get flagship splits
+            // @dev note that platformProviderAddress and
+            // platformProviderRevenue remain 0 for flagship
             (
-                renderProviderRevenue_, // artblocks revenue
-                renderProviderAddress_, // artblocks address
-                artistRevenue_,
-                artistAddress_,
-                additionalPayeePrimaryRevenue_,
-                additionalPayeePrimaryAddress_
-            ) = IGenArt721CoreContractV3(_coreContract).getPrimaryRevenueSplits(
-                _projectId,
-                _valueInWei
-            );
-        }
-        // Render Provider / Art Blocks payment
-        if (renderProviderRevenue_ > 0) {
-            (success, ) = renderProviderAddress_.call{
-                value: renderProviderRevenue_
-            }("");
-            require(success, "Render Provider payment failed");
-        }
-        // artist payment
-        if (artistRevenue_ > 0) {
-            (success, ) = artistAddress_.call{value: artistRevenue_}("");
-            require(success, "Artist payment failed");
-        }
-        // additional payee payment
-        if (additionalPayeePrimaryRevenue_ > 0) {
-            (success, ) = additionalPayeePrimaryAddress_.call{
-                value: additionalPayeePrimaryRevenue_
-            }("");
-            require(success, "Additional Payee payment failed");
+                renderProviderRevenue, // artblocks revenue
+                renderProviderAddress, // artblocks address
+                artistRevenue,
+                artistAddress,
+                additionalPayeePrimaryRevenue,
+                additionalPayeePrimaryAddress
+            ) = IGenArt721CoreContractV3(coreContract).getPrimaryRevenueSplits({
+                _projectId: projectId,
+                _price: valueInWei
+            });
         }
+        // require total revenue split is 100%
+        // @dev note that platformProviderRevenue remains 0 for flagship
+        require(
+            renderProviderRevenue +
+                platformProviderRevenue +
+                artistRevenue +
+                additionalPayeePrimaryRevenue ==
+                valueInWei,
+            "Invalid revenue split totals"
+        );
+        // distribute revenues
+        // @dev note that platformProviderAddress and platformProviderRevenue
+        // remain 0 for flagship
+        _sendPaymentsETH({
+            platformProviderRevenue: platformProviderRevenue,
+            platformProviderAddress: platformProviderAddress,
+            renderProviderRevenue: renderProviderRevenue,
+            renderProviderAddress: renderProviderAddress,
+            artistRevenue: artistRevenue,
+            artistAddress: artistAddress,
+            additionalPayeePrimaryRevenue: additionalPayeePrimaryRevenue,
+            additionalPayeePrimaryAddress: additionalPayeePrimaryAddress
+        });
     }
 
     /**
      * @notice Splits ERC20 funds between providers, artist, and artist's
-     * additional payee, for a token purchased on project `_projectId`.
+     * additional payee, for a token purchased on project `projectId`.
      * The function performs checks to ensure that the ERC20 token is
      * approved for transfer, and that a non-zero ERC20 token address is
      * configured.
-     * @dev This function relies on msg.sender and msg.value, so it must be
+     * @dev This function relies on msg.sender, 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 _splitFundsProjectConfig SplitFundsProjectConfig of the project.
-     * @param _projectId Project ID for which funds shall be split.
-     * @param _pricePerTokenInWei Current price of token, in Wei.
-     * @param _coreContract Core contract address.
-     * @param _isEngine Whether the core contract is an engine contract.
+     * @param projectId Project ID for which funds shall be split.
+     * @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(
-        SplitFundsProjectConfig storage _splitFundsProjectConfig,
-        uint256 _projectId,
-        uint256 _pricePerTokenInWei,
-        address _coreContract,
-        bool _isEngine
+        uint256 projectId,
+        uint256 pricePerToken,
+        address coreContract
     ) internal {
-        if (_pricePerTokenInWei == 0) {
+        if (pricePerToken == 0) {
             return; // nothing to split, return early
         }
-        address currencyAddress = _splitFundsProjectConfig.currencyAddress;
-        require(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,
-            _currencyAddress: currencyAddress,
-            _pricePerTokenInWei: _pricePerTokenInWei
-        });
-        IERC20 _projectCurrency = IERC20(currencyAddress);
-        // split remaining funds between foundation, artist, and artist's
-        // additional payee
-        uint256 renderProviderRevenue_;
-        address payable renderProviderAddress_;
-        uint256 artistRevenue_;
-        address payable artistAddress_;
-        uint256 additionalPayeePrimaryRevenue_;
-        address payable additionalPayeePrimaryAddress_;
-
-        if (_isEngine) {
+        IERC20 projectCurrency;
+        // block scope to avoid stack too deep error
+        {
+            SplitFundsProjectConfig
+                storage splitFundsProjectConfig = getSplitFundsProjectConfig({
+                    projectId: projectId,
+                    coreContract: coreContract
+                });
+            address currencyAddress = splitFundsProjectConfig.currencyAddress;
+            require(
+                currencyAddress != address(0),
+                "ERC20: payment not configured"
+            );
+            // ERC20 token is used for payment
+            validateERC20Approvals({
+                msgSender: msg.sender,
+                currencyAddress: currencyAddress,
+                pricePerToken: pricePerToken
+            });
+            projectCurrency = IERC20(currencyAddress);
+        }
+        // split remaining funds between foundation, artist, and artist's additional payee
+        bool isEngine_ = isEngine(coreContract);
+        uint256 renderProviderRevenue;
+        address payable renderProviderAddress;
+        uint256 platformProviderRevenue;
+        address payable platformProviderAddress;
+        uint256 artistRevenue;
+        address payable artistAddress;
+        uint256 additionalPayeePrimaryRevenue;
+        address payable additionalPayeePrimaryAddress;
+        if (isEngine_) {
             // get engine splits
-            uint256 platformProviderRevenue_;
-            address payable platformProviderAddress_;
             (
-                renderProviderRevenue_,
-                renderProviderAddress_,
-                platformProviderRevenue_,
-                platformProviderAddress_,
-                artistRevenue_,
-                artistAddress_,
-                additionalPayeePrimaryRevenue_,
-                additionalPayeePrimaryAddress_
-            ) = IGenArt721CoreContractV3_Engine(_coreContract)
-                .getPrimaryRevenueSplits(_projectId, _pricePerTokenInWei);
-            // Platform Provider payment (only possible if engine)
-            if (platformProviderRevenue_ > 0) {
-                require(
-                    _projectCurrency.transferFrom(
-                        msg.sender,
-                        platformProviderAddress_,
-                        platformProviderRevenue_
-                    ),
-                    "Platform Provider payment failed"
-                );
-            }
+                renderProviderRevenue,
+                renderProviderAddress,
+                platformProviderRevenue,
+                platformProviderAddress,
+                artistRevenue,
+                artistAddress,
+                additionalPayeePrimaryRevenue,
+                additionalPayeePrimaryAddress
+            ) = IGenArt721CoreContractV3_Engine(coreContract)
+                .getPrimaryRevenueSplits({
+                    _projectId: projectId,
+                    _price: pricePerToken
+                });
         } else {
             // get flagship splits
+            // @dev note that platformProviderAddress and
+            // platformProviderRevenue remain 0 for flagship
             (
-                renderProviderRevenue_, // artblocks revenue
-                renderProviderAddress_, // artblocks address
-                artistRevenue_,
-                artistAddress_,
-                additionalPayeePrimaryRevenue_,
-                additionalPayeePrimaryAddress_
-            ) = IGenArt721CoreContractV3(_coreContract).getPrimaryRevenueSplits(
-                _projectId,
-                _pricePerTokenInWei
-            );
-        }
-        // Art Blocks payment
-        if (renderProviderRevenue_ > 0) {
-            require(
-                _projectCurrency.transferFrom(
-                    msg.sender,
-                    renderProviderAddress_,
-                    renderProviderRevenue_
-                ),
-                "Render Provider payment failed"
-            );
-        }
-        // artist payment
-        if (artistRevenue_ > 0) {
-            require(
-                _projectCurrency.transferFrom(
-                    msg.sender,
-                    artistAddress_,
-                    artistRevenue_
-                ),
-                "Artist payment failed"
-            );
-        }
-        // additional payee payment
-        if (additionalPayeePrimaryRevenue_ > 0) {
-            // @dev some ERC20 may not revert on transfer failure, so we
-            // check the return value
-            require(
-                _projectCurrency.transferFrom(
-                    msg.sender,
-                    additionalPayeePrimaryAddress_,
-                    additionalPayeePrimaryRevenue_
-                ),
-                "Additional Payee payment failed"
-            );
+                renderProviderRevenue, // artblocks revenue
+                renderProviderAddress, // artblocks address
+                artistRevenue,
+                artistAddress,
+                additionalPayeePrimaryRevenue,
+                additionalPayeePrimaryAddress
+            ) = IGenArt721CoreContractV3(coreContract).getPrimaryRevenueSplits({
+                _projectId: projectId,
+                _price: pricePerToken
+            });
         }
+        // require total revenue split is 100%
+        // @dev note that platformProviderRevenue remains 0 for flagship
+        require(
+            renderProviderRevenue +
+                platformProviderRevenue +
+                artistRevenue +
+                additionalPayeePrimaryRevenue ==
+                pricePerToken,
+            "Invalid revenue split totals"
+        );
+        // distribute revenues
+        // @dev note that platformProviderAddress and platformProviderRevenue
+        // remain 0 for flagship
+        _sendPaymentsERC20({
+            projectCurrency: projectCurrency,
+            platformProviderRevenue: platformProviderRevenue,
+            platformProviderAddress: platformProviderAddress,
+            renderProviderRevenue: renderProviderRevenue,
+            renderProviderAddress: renderProviderAddress,
+            artistRevenue: artistRevenue,
+            artistAddress: artistAddress,
+            additionalPayeePrimaryRevenue: additionalPayeePrimaryRevenue,
+            additionalPayeePrimaryAddress: additionalPayeePrimaryAddress
+        });
     }
 
     /**
      * @notice Updates payment currency of the referenced
-     * SplitFundsProjectConfig to be `_currencySymbol` at address
-     * `_currencyAddress`.
+     * SplitFundsProjectConfig to be `currencySymbol` at address
+     * `currencyAddress`.
      * Only supports setting currency info of ERC20 tokens.
+     * Returns bool that is true if the price should be reset after this
+     * update. Price is recommended to be reset if the currency address was
+     * previously configured, but is now being updated to a different currency
+     * address. This is to protect accidental price reductions when changing
+     * currency if an artist is changing currencies in an unpaused state.
      * @dev artist-defined currency symbol is used instead of any on-chain
      * currency symbol.
-     * @param _splitFundsProjectConfig SplitFundsProjectConfig to update.
-     * @param _currencySymbol Currency symbol.
-     * @param _currencyAddress Currency address.
+     * @param projectId Project ID to update.
+     * @param coreContract Core contract address.
+     * @param currencySymbol Currency symbol.
+     * @param currencyAddress Currency address.
+     * @return recommendPriceReset True if the price should be reset after this
+     * update.
      */
     function updateProjectCurrencyInfoERC20(
-        SplitFundsProjectConfig storage _splitFundsProjectConfig,
-        string memory _currencySymbol,
-        address _currencyAddress
-    ) internal {
+        uint256 projectId,
+        address coreContract,
+        string memory currencySymbol,
+        address currencyAddress
+    ) internal returns (bool recommendPriceReset) {
         // CHECKS
-        require(_currencyAddress != address(0), "null address, only ERC20");
-        require(bytes(_currencySymbol).length > 0, "only non-null symbol");
+        require(currencyAddress != address(0), "null address, only ERC20");
+        require(bytes(currencySymbol).length > 0, "only non-null symbol");
         // EFFECTS
-        _splitFundsProjectConfig.currencySymbol = _currencySymbol;
-        _splitFundsProjectConfig.currencyAddress = _currencyAddress;
+        SplitFundsProjectConfig
+            storage splitFundsProjectConfig = getSplitFundsProjectConfig({
+                projectId: projectId,
+                coreContract: coreContract
+            });
+        // recommend price reset if currency address was previously configured
+        recommendPriceReset = (splitFundsProjectConfig.currencyAddress !=
+            address(0));
+        splitFundsProjectConfig.currencySymbol = currencySymbol;
+        splitFundsProjectConfig.currencyAddress = currencyAddress;
+
+        emit ProjectCurrencyInfoUpdated({
+            projectId: projectId,
+            coreContract: coreContract,
+            currencyAddress: currencyAddress,
+            currencySymbol: currencySymbol
+        });
     }
 
     /**
@@ -316,8 +354,10 @@ library SplitFundsLib {
      * creating a temporary contract which uses `SELFDESTRUCT` to force send
      * the ETH.
      * Reverts if the current contract has insufficient balance.
-     * @param _to The address to send ETH to.
-     * @param _amount The amount of ETH to send.
+     * @param to The address to send ETH to.
+     * @param amount The amount of ETH to send.
+     * @param minterRefundGasLimit The gas limit to use when sending ETH, prior
+     * to fallback.
      * @dev This function is adapted from the `forceSafeTransferETH` function
      * in the `https://github.com/Vectorized/solady` repository, with
      * modifications to not check if the current contract has sufficient
@@ -326,9 +366,9 @@ library SplitFundsLib {
      * applicable.
      */
     function forceSafeTransferETH(
-        address _to,
-        uint256 _amount,
-        uint256 _minterRefundGasLimit
+        address to,
+        uint256 amount,
+        uint256 minterRefundGasLimit
     ) internal {
         // Manually inlined because the compiler doesn't inline functions with
         // branches.
@@ -338,7 +378,7 @@ library SplitFundsLib {
             // balance, because that is not intended to be a valid state.
 
             // Transfer the ETH and check if it succeeded or not.
-            if iszero(call(_minterRefundGasLimit, _to, _amount, 0, 0, 0, 0)) {
+            if iszero(call(minterRefundGasLimit, to, amount, 0, 0, 0, 0)) {
                 // if the transfer failed, we create a temporary contract with
                 // initialization code that uses `SELFDESTRUCT` to force send
                 // the ETH.
@@ -356,14 +396,14 @@ library SplitFundsLib {
                 //---------------------------------------------------------------------------------------------------------------//
                 // Store the address in scratch space, starting at 0x00, which begins the 20-byte address at 32-20=12 in memory
                 // @dev use scratch space because we have enough space for simple creation code (less than 0x40 bytes)
-                mstore(0x00, _to)
+                mstore(0x00, to)
                 // store opcode PUSH20 immediately before the address, starting at 0x0b (11) in memory
                 mstore8(0x0b, 0x73)
                 // store opcode SELFDESTRUCT immediately after the address, starting at 0x20 (32) in memory
                 mstore8(0x20, 0xff)
                 // this will always succeed because the contract creation code is
                 // valid, and the address is valid because it is a 20-byte value
-                if iszero(create(_amount, 0x0b, 0x16)) {
+                if iszero(create(amount, 0x0b, 0x16)) {
                     // @dev For better gas estimation.
                     if iszero(gt(gas(), 1000000)) {
                         revert(0, 0)
@@ -374,22 +414,23 @@ library SplitFundsLib {
     }
 
     /**
-     * @notice Returns whether or not the provided address `_coreContract`
+     * @notice Returns whether or not the provided address `coreContract`
      * is an Art Blocks Engine core contract. Caches the result for future access.
-     * @param _coreContract Address of the core contract to check.
-     * @param _isEngineCache The storage pointer to the project's
-     * SplitFundsProjectConfig struct.
+     * @param coreContract Address of the core contract to check.
      */
-    function isEngine(
-        address _coreContract,
-        IsEngineCache storage _isEngineCache
-    ) internal returns (bool) {
-        if (_isEngineCache.isCached) {
-            return _isEngineCache.isEngine;
-        } else {
-            bool _isEngine = getV3CoreIsEngine(_coreContract, _isEngineCache);
-            return _isEngine;
+    function isEngine(address coreContract) internal returns (bool) {
+        IsEngineCache storage isEngineCache = getIsEngineCacheConfig(
+            coreContract
+        );
+        // check cache, return early if cached
+        if (isEngineCache.isCached) {
+            return isEngineCache.isEngine;
         }
+        // populate cache and return result
+        bool isEngine_ = getV3CoreIsEngineView(coreContract);
+        isEngineCache.isCached = true;
+        isEngineCache.isEngine = isEngine_;
+        return isEngine_;
     }
 
     /**
@@ -402,10 +443,10 @@ library SplitFundsLib {
      * either a flagship or engine core contract.
      * @dev this function uses the length of the return data (in bytes) to
      * determine whether the core is an engine or not.
-     * @param _coreContract The address of the deployed core contract.
+     * @param coreContract The address of the deployed core contract.
      */
     function getV3CoreIsEngineView(
-        address _coreContract
+        address coreContract
     ) internal view returns (bool) {
         // call getPrimaryRevenueSplits() on core contract
         bytes memory payload = abi.encodeWithSignature(
@@ -413,7 +454,7 @@ library SplitFundsLib {
             0,
             0
         );
-        (bool success, bytes memory returnData) = _coreContract.staticcall(
+        (bool success, bytes memory returnData) = coreContract.staticcall(
             payload
         );
         require(success, "getPrimaryRevenueSplits() call failed");
@@ -437,147 +478,270 @@ 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");
     }
 
     /**
-     * Gets the currency address and symbol for the referenced
+     * @notice Gets the currency address and symbol for the referenced
      * SplitFundsProjectConfig.
      * Only supports ERC20 tokens - returns currencySymbol of `UNCONFIG` if
      * `currencyAddress` is zero.
-     * @param _splitFundsProjectConfig SplitFundsProjectConfig to read
-     * @return currencyAddress
-     * @return currencySymbol
+     * @param projectId Project ID to get config for
+     * @param coreContract Core contract address to get config for
+     * @return currencyAddress currency address for the referenced SplitFundsProjectConfig.
+     * @return currencySymbol currency symbol for the referenced SplitFundsProjectConfig.
      */
     function getCurrencyInfoERC20(
-        SplitFundsProjectConfig storage _splitFundsProjectConfig
+        uint256 projectId,
+        address coreContract
     )
         internal
         view
         returns (address currencyAddress, string memory currencySymbol)
     {
-        currencyAddress = _splitFundsProjectConfig.currencyAddress;
+        SplitFundsProjectConfig
+            storage splitFundsProjectConfig = getSplitFundsProjectConfig({
+                projectId: projectId,
+                coreContract: coreContract
+            });
+        currencyAddress = splitFundsProjectConfig.currencyAddress;
         // default to "UNCONFIG" if project currency address is initial value
         currencySymbol = currencyAddress == address(0)
             ? "UNCONFIG"
-            : _splitFundsProjectConfig.currencySymbol;
+            : splitFundsProjectConfig.currencySymbol;
     }
 
     /**
-     * Get the balance of `_currencyAddress` ERC20 tokens for `_walletAddress`.
-     * @param _currencyAddress ERC20 token address.
-     * @param _walletAddress wallet address.
-     * @return balance
+     * @notice Gets the balance of `currencyAddress` ERC20 tokens for `walletAddress`.
+     * @param currencyAddress ERC20 token address.
+     * @param walletAddress wallet address.
+     * @return balance Balance of ERC-20
      */
     function getERC20Balance(
-        address _currencyAddress,
-        address _walletAddress
+        address currencyAddress,
+        address walletAddress
     ) internal view returns (uint256) {
-        return IERC20(_currencyAddress).balanceOf(_walletAddress);
+        return IERC20(currencyAddress).balanceOf(walletAddress);
     }
 
     /**
-     * Gets the allowance of `_spenderAddress` to spend `_walletAddress`'s
-     * `_currencyAddress` ERC20 tokens.
-     * @param _currencyAddress ERC20 token address.
-     * @param _walletAddress wallet address.
-     * @param _spenderAddress spender address.
-     * @return allowance
+     * @notice Gets the allowance of `spenderAddress` to spend `walletAddress`'s
+     * `currencyAddress` ERC20 tokens.
+     * @param currencyAddress ERC20 token address.
+     * @param walletAddress wallet address.
+     * @param spenderAddress spender address.
+     * @return allowance Allowance of ERC-20
      */
     function getERC20Allowance(
-        address _currencyAddress,
-        address _walletAddress,
-        address _spenderAddress
+        address currencyAddress,
+        address walletAddress,
+        address spenderAddress
     ) internal view returns (uint256 allowance) {
-        allowance = IERC20(_currencyAddress).allowance(
-            _walletAddress,
-            _spenderAddress
-        );
+        allowance = IERC20(currencyAddress).allowance({
+            owner: walletAddress,
+            spender: spenderAddress
+        });
         return allowance;
     }
 
     /**
-     * @notice Returns whether a V3 core contract is an Art Blocks Engine
-     * contract or not. Return value of false indicates that the core is a
-     * flagship contract. If this function resolves without reverting, it also
-     * updates the cache state for the given V3 core contract.
-     * @dev this function reverts if a core contract does not return the
-     * expected number of return values from getPrimaryRevenueSplits() for
-     * either a flagship or engine core contract.
-     * @dev this function uses the length of the return data (in bytes) to
-     * determine whether the core is an engine or not.
-     * @param _coreContract The address of the deployed core contract.
-     * @param _isEngineCache The storage pointer to the project's
-     * IsEngineCache struct.
-     */
-    function getV3CoreIsEngine(
-        address _coreContract,
-        IsEngineCache storage _isEngineCache
-    ) private returns (bool) {
-        // call getPrimaryRevenueSplits() on core contract
-        bytes memory payload = abi.encodeWithSignature(
-            "getPrimaryRevenueSplits(uint256,uint256)",
-            0,
-            0
-        );
-        (bool success, bytes memory returnData) = _coreContract.call(payload);
-        require(success, "getPrimaryRevenueSplits() call failed");
-        // determine whether core is engine or not, based on return data length
-        uint256 returnDataLength = returnData.length;
-        if (returnDataLength == 6 * 32) {
-            // 6 32-byte words returned if flagship (not engine)
-            // @dev 6 32-byte words are expected because the non-engine core
-            // contracts return a payout address and uint256 payment value for
-            // the artist, and artist's additional payee, and Art Blocks.
-            // also note that per Solidity ABI encoding, the address return
-            // values are padded to 32 bytes.
-            _isEngineCache.isCached = true;
-            _isEngineCache.isEngine = false;
-            return false;
-        } else if (returnDataLength == 8 * 32) {
-            // 8 32-byte words returned if engine
-            // @dev 8 32-byte words are expected because the engine core
-            // contracts return a payout address and uint256 payment value for
-            // the artist, artist's additional payee, render provider
-            // typically Art Blocks, and platform provider (partner).
-            // also note that per Solidity ABI encoding, the address return
-            // values are padded to 32 bytes.
-            _isEngineCache.isCached = true;
-            _isEngineCache.isEngine = true;
-            return true;
-        } else {
-            // unexpected return value length
-            revert("Unexpected revenue split bytes");
-        }
-    }
-
-    /**
-     * Validate that `_msgSender` has approved the contract to spend at least
-     * `_pricePerTokenInWei` of `_currencyAddress` ERC20 tokens, and that
-     * `_msgSender` has a balance of at least `_pricePerTokenInWei` of
-     * `_currencyAddress` ERC20 tokens.
+     * @notice Function validates that `msgSender` has approved the contract to spend at least
+     * `pricePerToken` of `currencyAddress` ERC20 tokens, and that
+     * `msgSender` has a balance of at least `pricePerToken` of
+     * `currencyAddress` ERC20 tokens.
      * 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 _pricePerTokenInWei Price per token in wei to validate.
+     * @param msgSender Address of the message sender to validate.
+     * @param currencyAddress Address of the ERC20 token to validate.
+     * @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,
-        address _currencyAddress,
-        uint256 _pricePerTokenInWei
+        address msgSender,
+        address currencyAddress,
+        uint256 pricePerToken
     ) private view {
         require(
-            IERC20(_currencyAddress).allowance(_msgSender, address(this)) >=
-                _pricePerTokenInWei,
+            IERC20(currencyAddress).allowance({
+                owner: msgSender,
+                spender: address(this)
+            }) >= pricePerToken,
             "Insufficient ERC20 allowance"
         );
         require(
-            IERC20(_currencyAddress).balanceOf(_msgSender) >=
-                _pricePerTokenInWei,
+            IERC20(currencyAddress).balanceOf(msgSender) >= pricePerToken,
             "Insufficient ERC20 balance"
         );
     }
+
+    /**
+     * @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.
+     * @param renderProviderAddress Render Provider address.
+     * @param artistRevenue Artist revenue.
+     * @param artistAddress Artist address.
+     * @param additionalPayeePrimaryRevenue Additional Payee revenue.
+     * @param additionalPayeePrimaryAddress Additional Payee address.
+     */
+    function _sendPaymentsETH(
+        uint256 platformProviderRevenue,
+        address payable platformProviderAddress,
+        uint256 renderProviderRevenue,
+        address payable renderProviderAddress,
+        uint256 artistRevenue,
+        address payable artistAddress,
+        uint256 additionalPayeePrimaryRevenue,
+        address payable additionalPayeePrimaryAddress
+    ) private {
+        // Platform Provider payment (only possible if engine)
+        if (platformProviderRevenue > 0) {
+            (bool success, ) = platformProviderAddress.call{
+                value: platformProviderRevenue
+            }("");
+            require(success, "Platform Provider payment failed");
+        }
+        // Render Provider / Art Blocks payment
+        if (renderProviderRevenue > 0) {
+            (bool success, ) = renderProviderAddress.call{
+                value: renderProviderRevenue
+            }("");
+            require(success, "Render Provider payment failed");
+        }
+        // artist payment
+        if (artistRevenue > 0) {
+            (bool success, ) = artistAddress.call{value: artistRevenue}("");
+            require(success, "Artist payment failed");
+        }
+        // additional payee payment
+        if (additionalPayeePrimaryRevenue > 0) {
+            (bool success, ) = additionalPayeePrimaryAddress.call{
+                value: additionalPayeePrimaryRevenue
+            }("");
+            require(success, "Additional Payee payment failed");
+        }
+    }
+
+    /**
+     * @notice Sends ERC20 revenues between providers, artist, and artist's
+     * additional payee. Reverts if any payment fails. All revenue values
+     * 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.
+     * @param platformProviderRevenue Platform Provider revenue.
+     * @param platformProviderAddress Platform Provider address.
+     * @param renderProviderRevenue Render Provider revenue.
+     * @param renderProviderAddress Render Provider address.
+     * @param artistRevenue Artist revenue.
+     * @param artistAddress Artist address.
+     * @param additionalPayeePrimaryRevenue Additional Payee revenue.
+     * @param additionalPayeePrimaryAddress Additional Payee address.
+     */
+    function _sendPaymentsERC20(
+        IERC20 projectCurrency,
+        uint256 platformProviderRevenue,
+        address payable platformProviderAddress,
+        uint256 renderProviderRevenue,
+        address payable renderProviderAddress,
+        uint256 artistRevenue,
+        address payable artistAddress,
+        uint256 additionalPayeePrimaryRevenue,
+        address payable additionalPayeePrimaryAddress
+    ) private {
+        // Platform Provider payment (only possible if engine)
+        if (platformProviderRevenue > 0) {
+            require(
+                projectCurrency.transferFrom({
+                    from: msg.sender,
+                    to: platformProviderAddress,
+                    amount: platformProviderRevenue
+                }),
+                "Platform Provider payment failed"
+            );
+        }
+        // Art Blocks payment
+        if (renderProviderRevenue > 0) {
+            require(
+                projectCurrency.transferFrom({
+                    from: msg.sender,
+                    to: renderProviderAddress,
+                    amount: renderProviderRevenue
+                }),
+                "Render Provider payment failed"
+            );
+        }
+        // artist payment
+        if (artistRevenue > 0) {
+            require(
+                projectCurrency.transferFrom({
+                    from: msg.sender,
+                    to: artistAddress,
+                    amount: artistRevenue
+                }),
+                "Artist payment failed"
+            );
+        }
+        // additional payee payment
+        if (additionalPayeePrimaryRevenue > 0) {
+            // @dev some ERC20 may not revert on transfer failure, so we
+            // check the return value
+            require(
+                projectCurrency.transferFrom({
+                    from: msg.sender,
+                    to: additionalPayeePrimaryAddress,
+                    amount: additionalPayeePrimaryRevenue
+                }),
+                "Additional Payee payment failed"
+            );
+        }
+    }
+
+    /**
+     * @notice Loads the SplitFundsProjectConfig for a given project and core
+     * contract.
+     * @param projectId Project Id to get config for
+     * @param coreContract Core contract address to get config for
+     */
+    function getSplitFundsProjectConfig(
+        uint256 projectId,
+        address coreContract
+    ) internal view returns (SplitFundsProjectConfig storage) {
+        return s().splitFundsProjectConfigs[coreContract][projectId];
+    }
+
+    /**
+     * @notice Loads the IsEngineCache for a given core contract.
+     * @param coreContract Core contract address to get config for
+     */
+    function getIsEngineCacheConfig(
+        address coreContract
+    ) internal view returns (IsEngineCache storage) {
+        return s().isEngineCacheConfigs[coreContract];
+    }
+
+    /**
+     * @notice Return the storage struct for reading and writing. This library
+     * uses a diamond storage pattern when managing storage.
+     * @return storageStruct The SetPriceLibStorage struct.
+     */
+    function s()
+        internal
+        pure
+        returns (SplitFundsLibStorage storage storageStruct)
+    {
+        bytes32 position = SPLIT_FUNDS_LIB_STORAGE_POSITION;
+        assembly ("memory-safe") {
+            storageStruct.slot := position
+        }
+    }
 }