@artblocks/contracts 1.1.0 → 1.2.1

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

@@ -151,11 +151,16 @@ library SEALib {
     // for this library
     bytes32 constant SEA_LIB_STORAGE_POSITION = keccak256("sealib.storage");
 
-    uint256 constant ONE_MILLION = 1_000_000;
-
     // project-specific parameters
     struct SEAProjectConfig {
+        // bool to indicate if next token number has been populated, or is
+        // still default value of 0
+        // @dev required to handle edge case where next token number is 0
+        bool nextTokenNumberIsPopulated;
+        // timestamp at/after which new auctions may be created
         uint64 timestampStart;
+        //
+        // ---- Auction Factory Settings Start ----
         // duration of each new auction, before any extensions due to late bids
         // @dev for configured auctions, this will be gt 0, so it may be used
         // to determine if an auction is configured
@@ -173,12 +178,10 @@ library SEALib {
         // be derived from this value in combination with project ID
         // max uint24 ~= 1.6e7, > max possible project invocations of 1e6
         uint24 nextTokenNumber;
-        // bool to indicate if next token number has been populated, or is
-        // still default value of 0
-        // @dev required to handle edge case where next token number is 0
-        bool nextTokenNumberIsPopulated;
         // reserve price, i.e. minimum starting bid price, in wei
         uint256 basePrice;
+        // ---- Auction Factory Settings End ----
+        //
         // active auction for project
         Auction activeAuction;
     }
@@ -264,6 +267,13 @@ library SEALib {
             projectId: projectId,
             coreContract: coreContract
         });
+        // base price of zero breaks auction system as percent min increase
+        // makes no sense
+        require(basePrice != 0, "Only non-zero");
+        // midBidIncrementPercentage of zero would allow a bidder to "outbid"
+        // previous users without posting more, so don't allow it
+        require(minBidIncrementPercentage != 0, "Only non-zero");
+
         require(
             timestampStart == 0 || block.timestamp < timestampStart,
             "Only future start times or 0"
@@ -279,7 +289,7 @@ library SEALib {
             projectId: projectId,
             coreContract: coreContract,
             timestampStart: uint64(timestampStart), // @dev safe-casting already previously checked
-            auctionDurationSeconds: auctionDurationSeconds.toUint32(),
+            auctionDurationSeconds: uint32(auctionDurationSeconds), // @dev safe-casting already previously checked
             basePrice: basePrice,
             minBidIncrementPercentage: minBidIncrementPercentage
         });
@@ -378,7 +388,7 @@ library SEALib {
      *   - there is an auction for a different token ID on the project
      *     (likely due to a front-run)
      * This function reverts if the auction for `tokenId` exists, but has not
-     * yet ended.
+     * yet ended. Function also reverts if there is no initialized auction.
      * @param tokenId Token ID to settle auction for.
      * @param coreContract Core contract address for the given token.
      */
@@ -393,8 +403,6 @@ library SEALib {
         address currentBidder = auction.currentBidder;
         uint256 currentBid = auction.currentBid;
         // CHECKS
-        // @dev this check is not strictly necessary, but is included for
-        // clear error messaging
         require(auctionIsInitialized(auction), "Auction not initialized");
         if (auction.settled || (auction.tokenId != tokenId)) {
             // auction already settled or is for a different token ID, so
@@ -572,10 +580,10 @@ library SEALib {
         // invocations has not been reached
         // we require up-to-date invocation data to properly handle last token
         // and avoid revert if relying on core to limit invocations, therefore
-        // use MaxInvocationsLib.invocationsRemain, which calls core contract
+        // use MaxInvocationsLib.invocationsRemainOnCore, which calls core contract
         // to get latest invocation data
         if (
-            !MaxInvocationsLib.invocationsRemain({
+            !MaxInvocationsLib.invocationsRemainOnCore({
                 projectId: projectId,
                 coreContract: coreContract
             })
@@ -605,7 +613,7 @@ library SEALib {
             );
         }
         // update local maxHasBeenInvoked value if necessary
-        MaxInvocationsLib.validatePurchaseEffectsInvocations({
+        MaxInvocationsLib.validateMintEffectsInvocations({
             tokenId: nextTokenId,
             coreContract: coreContract
         });
@@ -650,12 +658,12 @@ library SEALib {
     }
 
     /**
-     * @notice Function returns bool representing if an auction is accepting bids above base
-     * price. It is accepting bids if it is initialized and has not reached its
-     * end time.
+     * @notice Function returns bool representing if an auction is live and
+     * accepting bids above base price. It is live if it is initialized and
+     * has not reached its end time.
      * @param auction The auction to check.
      */
-    function auctionIsAcceptingIncreasingBids(
+    function isAuctionLive(
         Auction storage auction
     ) internal view returns (bool isAcceptingBids) {
         // auction is accepting bids if it is initialized and has not reached
@@ -713,9 +721,7 @@ library SEALib {
         Auction storage auction = SEAProjectConfig_.activeAuction;
         // if project has an active token auction that is not settled, return
         // that token ID
-        if (
-            auctionIsInitialized(auction) && (auction.endTime > block.timestamp)
-        ) {
+        if (isAuctionLive(auction)) {
             return auction.tokenId;
         }
         // otherwise, return the next expected token ID to be auctioned.
@@ -742,10 +748,10 @@ library SEALib {
             "Next token not populated"
         );
 
-        // @dev overflow automatically checked in Solidity ^0.8.0
-        nextTokenId =
-            (projectId * ONE_MILLION) +
-            SEAProjectConfig_.nextTokenNumber;
+        nextTokenId = ABHelpers.tokenIdFromProjectIdAndTokenNumber({
+            projectId: projectId,
+            tokenNumber: SEAProjectConfig_.nextTokenNumber
+        });
     }
 
     /**
@@ -776,21 +782,15 @@ library SEALib {
             coreContract: coreContract
         });
         Auction storage auction = SEAProjectConfig_.activeAuction;
-        // base price of zero not allowed when configuring auctions, so use it
-        // as indicator of whether auctions are configured for the project
         bool projectIsConfigured_ = projectIsConfigured({
             projectId: projectId,
             coreContract: coreContract
         });
-        bool auctionIsAcceptingIncreasingBids_ = auctionIsAcceptingIncreasingBids(
-                auction
-            );
-        isConfigured =
-            projectIsConfigured_ ||
-            auctionIsAcceptingIncreasingBids_;
+        bool isAuctionLive_ = isAuctionLive(auction);
+        isConfigured = projectIsConfigured_ || isAuctionLive_;
         // only return non-zero price if auction is configured
         if (isConfigured) {
-            if (auctionIsAcceptingIncreasingBids_) {
+            if (isAuctionLive_) {
                 // return minimum next bid, given current bid
                 tokenPriceInWei = getMinimumNextBid(auction);
             } else {
@@ -858,8 +858,6 @@ library SEALib {
         Auction storage auction = SEAProjectConfig_.activeAuction;
         // CHECKS
         // ensure project auctions are configured
-        // @dev base price of zero indicates auctions are not configured
-        // because only base price of gt zero is allowed when configuring
         require(
             projectIsConfigured({
                 projectId: projectId,
@@ -903,7 +901,7 @@ library SEALib {
 
         // EFFECTS
         // create new auction, overwriting previous auction if it exists
-        uint64 endTime = overwriteProjectActiveAuction({
+        uint64 endTime = _overwriteProjectActiveAuction({
             SEAProjectConfig_: SEAProjectConfig_,
             targetTokenId: targetTokenId,
             bidAmount: msg.value,
@@ -937,6 +935,31 @@ library SEALib {
         });
     }
 
+    /**
+     * Loads the SEAProjectConfig 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 getSEAProjectConfig(
+        uint256 projectId,
+        address coreContract
+    ) internal view returns (SEAProjectConfig storage) {
+        return s().SEAProjectConfigs[coreContract][projectId];
+    }
+
+    /**
+     * @notice Return the storage struct for reading and writing. This library
+     * uses a diamond storage pattern when managing storage.
+     * @return storageStruct The SEALibStorage struct.
+     */
+    function s() internal pure returns (SEALibStorage storage storageStruct) {
+        bytes32 position = SEA_LIB_STORAGE_POSITION;
+        assembly ("memory-safe") {
+            storageStruct.slot := position
+        }
+    }
+
     /**
      * @notice Function to overwrite the active auction for a project with a new auction.
      * @dev This function is used to initialize a new auction. Care must be
@@ -947,7 +970,7 @@ library SEALib {
      * @param bidder initial bidder's payable address
      * @return endTime end time of the newly created auction
      */
-    function overwriteProjectActiveAuction(
+    function _overwriteProjectActiveAuction(
         SEAProjectConfig storage SEAProjectConfig_,
         uint256 targetTokenId,
         uint256 bidAmount,
@@ -967,29 +990,4 @@ library SEALib {
             settled: false
         });
     }
-
-    /**
-     * Loads the SEAProjectConfig 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 getSEAProjectConfig(
-        uint256 projectId,
-        address coreContract
-    ) internal view returns (SEAProjectConfig storage) {
-        return s().SEAProjectConfigs[coreContract][projectId];
-    }
-
-    /**
-     * @notice Return the storage struct for reading and writing. This library
-     * uses a diamond storage pattern when managing storage.
-     * @return storageStruct The SEALibStorage struct.
-     */
-    function s() internal pure returns (SEALibStorage storage storageStruct) {
-        bytes32 position = SEA_LIB_STORAGE_POSITION;
-        assembly ("memory-safe") {
-            storageStruct.slot := position
-        }
-    }
 }

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

@@ -95,14 +95,10 @@ library SetPriceLib {
         uint256 projectId,
         address coreContract
     ) internal {
-        SetPriceProjectConfig
-            storage setPriceProjectConfig = getSetPriceProjectConfig({
-                projectId: projectId,
-                coreContract: coreContract
-            });
-        // update storage with solidity initial values
-        setPriceProjectConfig.pricePerToken = uint248(0);
-        setPriceProjectConfig.priceIsConfigured = false;
+        // @dev all fields must be deleted, and none of them are a complex type
+        // @dev getSetPriceProjectConfig not used, as deletion of storage
+        // pointers is not supported
+        delete s().setPriceProjectConfigs[coreContract][projectId];
 
         emit PricePerTokenReset({
             projectId: projectId,

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

@@ -41,7 +41,7 @@ library SettlementExpLib {
     // position of Settlement Exp Lib storage, using a diamond storage pattern
     // for this library
     bytes32 constant SETTLEMENT_EXP_LIB_STORAGE_POSITION =
-        keccak256("settlementExpLib.storage");
+        keccak256("settlementexplib.storage");
 
     bytes32 internal constant CONFIG_CURRENT_SETTLED_PRICE =
         "currentSettledPrice";
@@ -106,58 +106,6 @@ library SettlementExpLib {
         mapping(address walletAddress => mapping(address coreContract => mapping(uint256 projectId => Receipt))) receipts;
     }
 
-    /**
-     * @notice This function updates the _receipt to include `msg.value` and increments
-     * the number of tokens purchased by 1. It then checks that the updated
-     * receipt is valid (i.e. sufficient funds have been posted for the
-     * number of tokens purchased on the updated receipt), and reverts if not.
-     * The new receipt net posted and num purchased are then returned to make
-     * the values available in a gas-efficient manner to the caller of this
-     * function.
-     * @param walletAddress Address of user to update receipt for
-     * @param projectId Project ID to update receipt for
-     * @param coreContract Core contract address
-     * @param currentPriceInWei current price of token in Wei
-     * @return netPosted total funds posted by user on project (that have not
-     * been yet settled), including the current transaction
-     * @return numPurchased total number of tokens purchased by user on
-     * project, including the current transaction
-     */
-    function _validateReceiptEffects(
-        address walletAddress,
-        uint256 projectId,
-        address coreContract,
-        uint256 currentPriceInWei
-    ) private returns (uint232 netPosted, uint24 numPurchased) {
-        Receipt storage receipt = getReceipt({
-            walletAddress: walletAddress,
-            projectId: projectId,
-            coreContract: coreContract
-        });
-        // in memory copy + update
-        netPosted = (receipt.netPosted + msg.value).toUint232();
-        numPurchased = receipt.numPurchased + 1;
-
-        // require sufficient payment on project
-        require(
-            netPosted >= numPurchased * currentPriceInWei,
-            "Min value to mint req."
-        );
-
-        // update Receipt in storage
-        receipt.netPosted = netPosted;
-        receipt.numPurchased = numPurchased;
-
-        // emit event indicating new receipt state
-        emit ReceiptUpdated({
-            purchaser: msg.sender,
-            projectId: projectId,
-            coreContract: coreContract,
-            numPurchased: numPurchased,
-            netPosted: netPosted
-        });
-    }
-
     /**
      * @notice Distributes the net revenues from the project's auction, and
      * marks the auction as having had its revenues collected.
@@ -193,9 +141,9 @@ library SettlementExpLib {
 
         // get the current net price of the auction - reverts if no auction
         // is configured.
-        // @dev we use _getPriceUnsafe here, since we just safely synced the
+        // @dev we use getPriceUnsafe here, since we just safely synced the
         // project's max invocations and maxHasBeenInvoked, which guarantees
-        // an accurate price calculation from _getPriceUnsafe, while being
+        // an accurate price calculation from getPriceUnsafe, while being
         // more gas efficient than getPriceSafe.
         // @dev price is guaranteed <= _projectConfig.latestPurchasePrice,
         // since this minter enforces monotonically decreasing purchase prices.
@@ -252,7 +200,8 @@ library SettlementExpLib {
         } else {
             // base price of zero indicates that the auction has not been configured,
             // since base price of zero is not allowed when configuring an auction.
-            // @dev no coverage else branch of following line because redundant
+            // @dev no coverage else branch of following line because redundant,
+            // acknowledge redundant check
             require(basePrice > 0, "Only latestPurchasePrice > 0");
             // if the price is base price, the auction is valid and may be claimed
             // update the latest purchase price to the base price, to ensure
@@ -309,13 +258,20 @@ library SettlementExpLib {
      * @param coreContract Core contract address
      * @param purchaserAddress Address to reclaim excess settlement funds for
      * @param to Address to send excess settlement funds to
+     * @param doSendFunds If true, sends funds to `to`. If false, only updates
+     * the receipt to reflect the new funds posted, and returns the amount of
+     * excess settlement funds that still need to be sent to `to`.
+     * @return remainingUnsentExcessSettlementFunds amount of excess settlement
+     * funds that still need to be sent to `to`, in wei. If doSendFunds, this
+     * value will be zero, because funds will have been sent to `to`.
      */
     function reclaimProjectExcessSettlementFundsTo(
         address payable to,
         uint256 projectId,
         address coreContract,
-        address purchaserAddress
-    ) internal {
+        address purchaserAddress,
+        bool doSendFunds
+    ) internal returns (uint256 remainingUnsentExcessSettlementFunds) {
         (
             uint256 excessSettlementFunds,
             uint256 requiredAmountPosted
@@ -353,9 +309,14 @@ library SettlementExpLib {
         });
 
         // INTERACTIONS
-        bool success_;
-        (success_, ) = to.call{value: excessSettlementFunds}("");
-        require(success_, "Reclaiming failed");
+        if (doSendFunds) {
+            bool success_;
+            (success_, ) = to.call{value: excessSettlementFunds}("");
+            require(success_, "Reclaiming failed");
+        } else {
+            // return unsent funds amount to caller
+            remainingUnsentExcessSettlementFunds = excessSettlementFunds;
+        }
     }
 
     /**
@@ -516,7 +477,7 @@ library SettlementExpLib {
     }
 
     /**
-     * Returns number of purchases that have been made on the minter, for a
+     * @notice Returns number of purchases that have been made on the minter, for a
      * given project.
      * @param projectId The id of the project.
      * @param coreContract The address of the core contract.
@@ -651,37 +612,25 @@ library SettlementExpLib {
         uint256 projectId,
         address coreContract
     ) internal view returns (uint256 tokenPriceInWei) {
-        // load the project's settlement auction config
-        SettlementAuctionProjectConfig
-            storage settlementAuctionProjectConfig = getSettlementAuctionProjectConfig({
+        // get up-to-date maxHasBeenInvoked state from core contract
+        bool maxHasBeenInvokedSafe = MaxInvocationsLib
+            .projectMaxHasBeenInvokedSafe({
                 projectId: projectId,
                 coreContract: coreContract
             });
-        // accurately check if project has sold out
-        if (
-            MaxInvocationsLib.projectMaxHasBeenInvokedSafe({
-                projectId: projectId,
-                coreContract: coreContract
-            })
-        ) {
-            // max invocations have been reached, return the latest purchased
-            // price
-            tokenPriceInWei = settlementAuctionProjectConfig
-                .latestPurchasePrice;
-        } else {
-            // if not sold out, return the current price via getPriceUnsafe
-            tokenPriceInWei = getPriceUnsafe({
-                projectId: projectId,
-                coreContract: coreContract,
-                maxHasBeenInvoked: false // this branch is only reached if max invocations have not been reached
-            });
-        }
-        return tokenPriceInWei;
+        // get price using up-to-date maxHasBeenInvoked state
+        tokenPriceInWei = getPriceUnsafe({
+            projectId: projectId,
+            coreContract: coreContract,
+            maxHasBeenInvoked: maxHasBeenInvokedSafe
+        });
     }
 
     /**
      * @notice Returns if a new auction's start price is valid, given the current
      * state of the project's settlement auction configuration.
+     * @dev does not check for non-zero start price, since startPrice > basePrice
+     * is checked in DAExpLib.
      * @param projectId Project ID to check start price for
      * @param coreContract Core contract address to check start price for
      * @param startPrice starting price of new auction, in wei
@@ -702,13 +651,15 @@ library SettlementExpLib {
         // claiming logic. Since base price is always non-zero, if
         // latestPurchasePrice is zero, then no previous purchases have been
         // made, and startPrice may be set to any value.
+        // @dev DAExpLib checks that startPrice > basePrice, so no need to
+        // check for non-zero startPrice here.
         return (settlementAuctionProjectConfig.latestPurchasePrice == 0 || // never purchased
             startPrice <= settlementAuctionProjectConfig.latestPurchasePrice);
     }
 
     /**
-     * Loads the SettlementAuctionProjectConfig for a given project and core
-     * contract.
+     * @notice Loads the SettlementAuctionProjectConfig for a given project and
+     * core contract.
      * @param projectId Project Id to get config for
      * @param coreContract Core contract address to get config for
      */
@@ -720,7 +671,7 @@ library SettlementExpLib {
     }
 
     /**
-     * Loads the Receipt for a given user, project and core contract.
+     * @notice Loads the Receipt for a given user, project and core contract.
      * @param walletAddress User address to get receipt for
      * @param projectId Project Id to get config for
      * @param coreContract Core contract address to get config for
@@ -750,7 +701,7 @@ library SettlementExpLib {
     }
 
     /**
-     * Returns if all tokens to be auctioned were sold, for a given project.
+     * @notice Returns if all tokens to be auctioned were sold, for a given project.
      * Returns false if the number of tokens to be auctioned is zero, since
      * that is the default value for unconfigured values.
      * @param settlementAuctionProjectConfig The SettlementAuctionProjectConfig
@@ -767,4 +718,56 @@ library SettlementExpLib {
             settlementAuctionProjectConfig.numPurchasesOnMinter ==
             numTokensToBeAuctioned;
     }
+
+    /**
+     * @notice This function updates the receipt to include `msg.value` and increments
+     * the number of tokens purchased by 1. It then checks that the updated
+     * receipt is valid (i.e. sufficient funds have been posted for the
+     * number of tokens purchased on the updated receipt), and reverts if not.
+     * The new receipt net posted and num purchased are then returned to make
+     * the values available in a gas-efficient manner to the caller of this
+     * function.
+     * @param walletAddress Address of user to update receipt for
+     * @param projectId Project ID to update receipt for
+     * @param coreContract Core contract address
+     * @param currentPriceInWei current price of token in Wei
+     * @return netPosted total funds posted by user on project (that have not
+     * been yet settled), including the current transaction
+     * @return numPurchased total number of tokens purchased by user on
+     * project, including the current transaction
+     */
+    function _validateReceiptEffects(
+        address walletAddress,
+        uint256 projectId,
+        address coreContract,
+        uint256 currentPriceInWei
+    ) private returns (uint232 netPosted, uint24 numPurchased) {
+        Receipt storage receipt = getReceipt({
+            walletAddress: walletAddress,
+            projectId: projectId,
+            coreContract: coreContract
+        });
+        // in memory copy + update
+        netPosted = (receipt.netPosted + msg.value).toUint232();
+        numPurchased = receipt.numPurchased + 1;
+
+        // require sufficient payment on project
+        require(
+            netPosted >= numPurchased * currentPriceInWei,
+            "Min value to mint req."
+        );
+
+        // update Receipt in storage
+        receipt.netPosted = netPosted;
+        receipt.numPurchased = numPurchased;
+
+        // emit event indicating new receipt state
+        emit ReceiptUpdated({
+            purchaser: msg.sender,
+            projectId: projectId,
+            coreContract: coreContract,
+            numPurchased: numPurchased,
+            netPosted: netPosted
+        });
+    }
 }