@artblocks/contracts 1.1.0 → 1.2.0

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

@@ -291,8 +291,9 @@ contract MinterSEAV1 is ReentrancyGuard, ISharedMinterV0, ISharedMinterSEAV0 {
         uint8 minBidIncrementPercentage
     ) external {
         // CHECKS
-        _onlyNonZero(basePrice);
-        _onlyNonZero(minBidIncrementPercentage);
+        // @dev non-zero basePrice and minBidIncrementPercentage are checked in
+        // SEALib.configureFutureAuctions, therefore not redundantly checked
+        // here
         AuthLib.onlyArtist({
             projectId: projectId,
             coreContract: coreContract,
@@ -311,32 +312,21 @@ contract MinterSEAV1 is ReentrancyGuard, ISharedMinterV0, ISharedMinterSEAV0 {
             minBidIncrementPercentage: minBidIncrementPercentage
         });
 
-        // for convenience, sync local max invocations to the core contract if
-        // and only if max invocations have not already been synced.
-        // @dev do not sync if max invocations have already been synced, as
-        // local max invocations could have been manually set to be
-        // intentionally less than the core contract's max invocations.
-        // sync local max invocations if not initially populated
-        if (
-            MaxInvocationsLib.maxInvocationsIsUnconfigured({
-                projectId: projectId,
-                coreContract: coreContract
-            })
-        ) {
-            syncProjectMaxInvocationsToCore({
-                projectId: projectId,
-                coreContract: coreContract
-            });
-            // @dev syncProjectMaxInvocationsToCore function calls
-            // SEALib.tryMintTokenToNextSlot, so we do not call it here.
-        } else {
-            // for convenience, try to mint to next token slot
-            SEALib.tryMintTokenToNextSlot({
-                projectId: projectId,
-                coreContract: coreContract,
-                minterFilter: _minterFilter
-            });
-        }
+        // for convenience, refresh max invocations to ensure they are
+        // populated and updated, without imposing any additional restrictions
+        // if already configured.
+        MaxInvocationsLib.refreshMaxInvocations({
+            projectId: projectId,
+            coreContract: coreContract
+        });
+
+        // try to mint to the next token slot to ensure that the next token
+        // slot is populated, if possible
+        SEALib.tryMintTokenToNextSlot({
+            projectId: projectId,
+            coreContract: coreContract,
+            minterFilter: _minterFilter
+        });
     }
 
     /**
@@ -737,7 +727,7 @@ contract MinterSEAV1 is ReentrancyGuard, ISharedMinterV0, ISharedMinterSEAV0 {
 
     /**
      * @notice Emergency, Artist-only function that attempts to mint a new
-     * token and set it as the the next token to be auctioned for project
+     * token and set it as the next token to be auctioned for project
      * `projectId`.
      * Note: This function is only included for emergency, unforseen use cases,
      * and should not be used in normal operation. It is here only for
@@ -785,13 +775,12 @@ contract MinterSEAV1 is ReentrancyGuard, ISharedMinterV0, ISharedMinterSEAV0 {
     /**
      * @notice Settles a completed auction for `tokenId`, if it exists and is
      * not yet settled.
-     * Function reverts if there is no initialized auction for the project.
      * Function returns early (does not modify state) if
      *   - there is an auction that has already been settled for the project
      *   - 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.
+     * Function reverts if there is no initialized auction for the project, or
+     * if the auction for `tokenId` exists, but has not yet ended.
      * @param tokenId Token ID to settle auction for.
      * @param coreContract Core contract address for the given token.
      */

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

@@ -108,13 +108,15 @@ contract MinterSetPriceERC20V5 is ReentrancyGuard, ISharedMinterV0 {
      * @notice Updates this minter's price per token of project `projectId`
      * to be `pricePerTokenInWei`. Note that "in wei" is a misnomer on this
      * ERC20 minter, but is used for consistency with the ETH minters. The
-     * price value represents the ERC20 token price without decimals.
+     * price value represents the ERC20 token price in base units.
      * @dev Note that it is intentionally supported here that the configured
      * price may be explicitly set to `0`.
      * @param projectId Project ID to set the price per token for.
      * @param coreContract Core contract address for the given project.
      * @param pricePerTokenInWei Price per token to set for the project.
-     * Represents the ERC20 token price without decimals.
+     * Represents the ERC20 token price 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 updatePricePerTokenInWei(
         uint256 projectId,
@@ -145,7 +147,7 @@ contract MinterSetPriceERC20V5 is ReentrancyGuard, ISharedMinterV0 {
                 coreContract: coreContract
             })
         ) {
-            syncProjectMaxInvocationsToCore({
+            MaxInvocationsLib.syncProjectMaxInvocationsToCore({
                 projectId: projectId,
                 coreContract: coreContract
             });
@@ -197,7 +199,10 @@ contract MinterSetPriceERC20V5 is ReentrancyGuard, ISharedMinterV0 {
      * @notice Purchases a token from project `projectId`.
      * @param projectId Project ID to mint a token on.
      * @param coreContract Core contract address for the given project.
-     * @param maxPricePerToken Maximum price of token being allowed by the purchaser, no decimal places
+     * @param maxPricePerToken Maximum price of token being allowed by the
+     * purchaser, in base units. For example, if the ERC20 token has 6
+     * decimals, an input value of `1_000_000` would represent a maximum price
+     * of `1.000000` tokens.
      * @param currencyAddress Currency address of token.
      * @return tokenId Token ID of minted token
      */
@@ -397,8 +402,9 @@ contract MinterSetPriceERC20V5 is ReentrancyGuard, ISharedMinterV0 {
      * @return tokenPriceInWei current price of token on this minter - invalid
      * if price has not yet been configured. Note that "in wei" is a misnomer
      * for ERC20 tokens, but is used here for ABI consistency with the ETH
-     * minters. The value returned represents the price per token, with no
-     * decimals.
+     * minters. The value returned represents the price per 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.
      * @return currencySymbol currency symbol for purchases of project on this
      * minter. "UNCONFIG" if not yet configured. Note that currency symbol is
      * defined by the artist, and is not necessarily the same as the ERC20
@@ -467,7 +473,10 @@ contract MinterSetPriceERC20V5 is ReentrancyGuard, ISharedMinterV0 {
      * @param to Address to be the new token's owner.
      * @param projectId Project ID to mint a token on.
      * @param coreContract Core contract address for the given project.
-     * @param maxPricePerToken Maximum price of token being allowed by the purchaser, no decimal places
+     * @param maxPricePerToken Maximum price of token being allowed by the
+     * purchaser, in base units. For example, if the ERC20 token has 6
+     * decimals, an input value of `1_000_000` would represent a maximum price
+     * of `1.000000` tokens.
      * @param currencyAddress Currency address of token.
      * @return tokenId Token ID of minted token
      */
@@ -527,7 +536,7 @@ contract MinterSetPriceERC20V5 is ReentrancyGuard, ISharedMinterV0 {
             sender: msg.sender
         });
 
-        MaxInvocationsLib.validatePurchaseEffectsInvocations({
+        MaxInvocationsLib.validateMintEffectsInvocations({
             tokenId: tokenId,
             coreContract: coreContract
         });

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

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

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

@@ -182,7 +182,7 @@ contract MinterSetPriceMerkleV5 is
                 coreContract: coreContract
             })
         ) {
-            syncProjectMaxInvocationsToCore({
+            MaxInvocationsLib.syncProjectMaxInvocationsToCore({
                 projectId: projectId,
                 coreContract: coreContract
             });
@@ -697,7 +697,7 @@ contract MinterSetPriceMerkleV5 is
             sender: vault_
         });
 
-        MaxInvocationsLib.validatePurchaseEffectsInvocations({
+        MaxInvocationsLib.validateMintEffectsInvocations({
             tokenId: tokenId,
             coreContract: coreContract
         });

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

@@ -171,13 +171,17 @@ contract MinterSetPricePolyptychERC20V5 is
      * @notice Updates this minter's price per token of project `projectId`
      * to be `pricePerTokenInWei`. Note that "in wei" is a misnomer on this
      * ERC20 minter, but is used for consistency with the ETH minters. The
-     * price value represents the ERC20 token price without decimals.
+     * price value represents the ERC20 token price in base units.
+     * @dev Note that it is intentionally supported here that the configured
+     * price may be explicitly set to `0`.
      * @dev Note that it is intentionally supported here that the configured
      * price may be explicitly set to `0`.
      * @param projectId Project ID to set the price per token for.
      * @param coreContract Core contract address for the given project.
      * @param pricePerTokenInWei Price per token to set for the project.
-     * Represents the ERC20 token price without decimals.
+     * Represents the ERC20 token price 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 updatePricePerTokenInWei(
         uint256 projectId,
@@ -208,7 +212,7 @@ contract MinterSetPricePolyptychERC20V5 is
                 coreContract: coreContract
             })
         ) {
-            syncProjectMaxInvocationsToCore({
+            MaxInvocationsLib.syncProjectMaxInvocationsToCore({
                 projectId: projectId,
                 coreContract: coreContract
             });
@@ -407,7 +411,10 @@ contract MinterSetPricePolyptychERC20V5 is
      * token ID `ownedNFTTokenId` as the parent token.
      * @param projectId Project ID to mint a token on.
      * @param coreContract Core contract address for the given project.
-     * @param maxPricePerToken Maximum price of token being allowed by the purchaser, no decimal places
+     * @param maxPricePerToken Maximum price of token being allowed by the
+     * purchaser, in base units. For example, if the ERC20 token has 6
+     * decimals, an input value of `1_000_000` would represent a maximum price
+     * of `1.000000` tokens.
      * @param currencyAddress Currency address of token.
      * @param ownedNFTAddress ERC-721 NFT address holding the project token
      * owned by msg.sender being used as the parent token.
@@ -444,7 +451,10 @@ contract MinterSetPricePolyptychERC20V5 is
      * @param to Address to be the new token's owner.
      * @param projectId Project ID to mint a token on.
      * @param coreContract Core contract address for the given project.
-     * @param maxPricePerToken Maximum price of token being allowed by the purchaser, no decimal places
+     * @param maxPricePerToken Maximum price of token being allowed by the
+     * purchaser, in base units. For example, if the ERC20 token has 6
+     * decimals, an input value of `1_000_000` would represent a maximum price
+     * of `1.000000` tokens.
      * @param currencyAddress Currency address of token.
      * @param ownedNFTAddress ERC-721 NFT holding the project token owned by
      * msg.sender being used as the parent token.
@@ -704,8 +714,9 @@ contract MinterSetPricePolyptychERC20V5 is
      * @return tokenPriceInWei current price of token on this minter - invalid
      * if price has not yet been configured. Note that "in wei" is a misnomer
      * for ERC20 tokens, but is used here for ABI consistency with the ETH
-     * minters. The value returned represents the price per token, with no
-     * decimals.
+     * minters. The value returned represents the price per 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.
      * @return currencySymbol currency symbol for purchases of project on this
      * minter. "UNCONFIG" if not yet configured. Note that currency symbol is
      * defined by the artist, and is not necessarily the same as the ERC20
@@ -823,7 +834,10 @@ contract MinterSetPricePolyptychERC20V5 is
      * @param to Address to be the new token's owner.
      * @param projectId Project ID to mint a token on.
      * @param coreContract Core contract address for the given project.
-     * @param maxPricePerToken Maximum price of token being allowed by the purchaser, no decimal places
+     * @param maxPricePerToken Maximum price of token being allowed by the
+     * purchaser, in base units. For example, if the ERC20 token has 6
+     * decimals, an input value of `1_000_000` would represent a maximum price
+     * of `1.000000` tokens.
      * @param currencyAddress Currency address of token.
      * @param ownedNFTAddress ERC-721 NFT holding the project token owned by
      * msg.sender or `vault` being used as the parent token.
@@ -971,7 +985,7 @@ contract MinterSetPricePolyptychERC20V5 is
             });
         }
 
-        MaxInvocationsLib.validatePurchaseEffectsInvocations({
+        MaxInvocationsLib.validateMintEffectsInvocations({
             tokenId: tokenId,
             coreContract: coreContract
         });

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

@@ -200,7 +200,7 @@ contract MinterSetPricePolyptychV5 is
                 coreContract: coreContract
             })
         ) {
-            syncProjectMaxInvocationsToCore({
+            MaxInvocationsLib.syncProjectMaxInvocationsToCore({
                 projectId: projectId,
                 coreContract: coreContract
             });
@@ -828,7 +828,7 @@ contract MinterSetPricePolyptychV5 is
             });
         }
 
-        MaxInvocationsLib.validatePurchaseEffectsInvocations({
+        MaxInvocationsLib.validateMintEffectsInvocations({
             tokenId: tokenId,
             coreContract: coreContract
         });

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

@@ -145,7 +145,7 @@ contract MinterSetPriceV5 is
                 coreContract: coreContract
             })
         ) {
-            syncProjectMaxInvocationsToCore({
+            MaxInvocationsLib.syncProjectMaxInvocationsToCore({
                 projectId: projectId,
                 coreContract: coreContract
             });
@@ -397,7 +397,7 @@ contract MinterSetPriceV5 is
             sender: msg.sender
         });
 
-        MaxInvocationsLib.validatePurchaseEffectsInvocations({
+        MaxInvocationsLib.validateMintEffectsInvocations({
             tokenId: tokenId,
             coreContract: coreContract
         });