@artblocks/contracts 1.1.0 → 1.2.0

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

@@ -132,15 +132,10 @@ library DALinLib {
         uint256 projectId,
         address coreContract
     ) internal {
-        DAProjectConfig storage DAProjectConfig_ = getDAProjectConfig({
-            projectId: projectId,
-            coreContract: coreContract
-        });
-
-        DAProjectConfig_.timestampStart = 0;
-        DAProjectConfig_.timestampEnd = 0;
-        DAProjectConfig_.startPrice = 0;
-        DAProjectConfig_.basePrice = 0;
+        // @dev all fields must be deleted, and none of them are a complex type
+        // @dev getDAProjectConfig not used, as deletion of storage pointers is
+        // not supported
+        delete s().DAProjectConfigs_[coreContract][projectId];
 
         emit DALib.ResetAuctionDetails({
             projectId: projectId,

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

@@ -13,11 +13,11 @@ pragma solidity ^0.8.0;
  */
 library GenericMinterEventsLib {
     /**
-     * @notice Generic project minter configuration event. Removes key `key`
+     * @notice Generic project minter configuration event. Removed key `key`
      * for project `projectId`.
-     * @param projectId Project ID to remove key for
+     * @param projectId Project ID key was removed for
      * @param coreContract Core contract address that projectId is on
-     * @param key Key to remove
+     * @param key Key removed
      */
     event ConfigKeyRemoved(
         uint256 indexed projectId,
@@ -26,12 +26,12 @@ library GenericMinterEventsLib {
     );
     /// BOOL
     /**
-     * @notice Generic project minter configuration event. Sets value of key
-     * `key` to `value` for project `projectId`.
-     * @param projectId Project ID to set key for
+     * @notice Generic project minter configuration event. Value of key
+     * `key` was set to `value` for project `projectId`.
+     * @param projectId Project ID key was set for
      * @param coreContract Core contract address that projectId is on
-     * @param key Key to set
-     * @param value Value to set key to
+     * @param key Key set
+     * @param value Value key was set to
      */
     event ConfigValueSet(
         uint256 indexed projectId,
@@ -41,12 +41,12 @@ library GenericMinterEventsLib {
     );
     /// UINT256
     /**
-     * @notice Generic project minter configuration event. Sets value of key
-     * `key` to `value` for project `projectId`.
-     * @param projectId Project ID to set key for
+     * @notice Generic project minter configuration event. Value of key
+     * `key` was set to `value` for project `projectId`.
+     * @param projectId Project ID key was set for
      * @param coreContract Core contract address that projectId is on
-     * @param key Key to set
-     * @param value Value to set key to
+     * @param key Key set
+     * @param value Value key was set to
      */
     event ConfigValueSet(
         uint256 indexed projectId,
@@ -55,12 +55,12 @@ library GenericMinterEventsLib {
         uint256 value
     );
     /**
-     * @notice Generic project minter configuration event. Adds value `value`
+     * @notice Generic project minter configuration event. Added value `value`
      * to the set of uint256 at key `key` for project `projectId`.
-     * @param projectId Project ID to set key for
+     * @param projectId Project ID key was set for
      * @param coreContract Core contract address that projectId is on
-     * @param key Key to modify
-     * @param value Value to add to the key's set
+     * @param key Key modified
+     * @param value Value added to the key's set
      */
     event ConfigValueAddedToSet(
         uint256 indexed projectId,
@@ -69,11 +69,11 @@ library GenericMinterEventsLib {
         uint256 value
     );
     /**
-     * @notice Generic project minter configuration event. Removes value
+     * @notice Generic project minter configuration event. Removed value
      * `value` to the set of uint256 at key `key` for project `projectId`.
-     * @param projectId Project ID to set key for
+     * @param projectId Project ID key was set for
      * @param coreContract Core contract address that projectId is on
-     * @param key Key to modify
+     * @param key Key modified
      * @param value Value removed from the key's set
      */
     event ConfigValueRemovedFromSet(
@@ -84,12 +84,12 @@ library GenericMinterEventsLib {
     );
     /// ADDRESS
     /**
-     * @notice Generic project minter configuration event. Sets value of key
-     * `key` to `value` for project `projectId`.
-     * @param projectId Project ID to set key for
+     * @notice Generic project minter configuration event. Value of key
+     * `key` was set to `value` for project `projectId`.
+     * @param projectId Project ID key was set for
      * @param coreContract Core contract address that projectId is on
-     * @param key Key to set
-     * @param value Value to set key to
+     * @param key Key set
+     * @param value Value key was set to
      */
     event ConfigValueSet(
         uint256 indexed projectId,
@@ -98,12 +98,12 @@ library GenericMinterEventsLib {
         address value
     );
     /**
-     * @notice Generic project minter configuration event. Adds value `value`
+     * @notice Generic project minter configuration event. Added value `value`
      * to the set of addresses at key `key` for project `projectId`.
-     * @param projectId Project ID to set key for
+     * @param projectId Project ID key was set for
      * @param coreContract Core contract address that projectId is on
-     * @param key Key to modify
-     * @param value Value to add to the key's set
+     * @param key Key modified
+     * @param value Value added to the key's set
      */
     event ConfigValueAddedToSet(
         uint256 indexed projectId,
@@ -112,11 +112,11 @@ library GenericMinterEventsLib {
         address value
     );
     /**
-     * @notice Generic project minter configuration event. Removes value
+     * @notice Generic project minter configuration event. Removed value
      * `value` to the set of addresses at key `key` for project `projectId`.
-     * @param projectId Project ID to set key for
+     * @param projectId Project ID key was set for
      * @param coreContract Core contract address that projectId is on
-     * @param key Key to modify
+     * @param key Key modified
      * @param value Value removed from the key's set
      */
     event ConfigValueRemovedFromSet(
@@ -127,12 +127,12 @@ library GenericMinterEventsLib {
     );
     /// BYTES32
     /**
-     * @notice Generic project minter configuration event. Sets value of key
-     * `key` to `value` for project `projectId`.
-     * @param projectId Project ID to set key for
+     * @notice Generic project minter configuration event. Value of key
+     * `key` was set to `value` for project `projectId`.
+     * @param projectId Project ID key was set for
      * @param coreContract Core contract address that projectId is on
-     * @param key Key to set
-     * @param value Value to set key to
+     * @param key Key set
+     * @param value Value key was set to
      */
     event ConfigValueSet(
         uint256 indexed projectId,
@@ -141,12 +141,12 @@ library GenericMinterEventsLib {
         bytes32 value
     );
     /**
-     * @notice Generic project minter configuration event. Adds value `value`
+     * @notice Generic project minter configuration event. Added value `value`
      * to the set of bytes32 at key `key` for project `projectId`.
-     * @param projectId Project ID to set key for
+     * @param projectId Project ID key was set for
      * @param coreContract Core contract address that projectId is on
-     * @param key Key to modify
-     * @param value Value to add to the key's set
+     * @param key Key modified
+     * @param value Value added to the key's set
      */
     event ConfigValueAddedToSet(
         uint256 indexed projectId,
@@ -155,11 +155,11 @@ library GenericMinterEventsLib {
         bytes32 value
     );
     /**
-     * @notice Generic project minter configuration event. Removes value
+     * @notice Generic project minter configuration event. Removed value
      * `value` to the set of bytes32 at key `key` for project `projectId`.
-     * @param projectId Project ID to set key for
+     * @param projectId Project ID key was set for
      * @param coreContract Core contract address that projectId is on
-     * @param key Key to modify
+     * @param key Key modified
      * @param value Value removed from the key's set
      */
     event ConfigValueRemovedFromSet(

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

@@ -8,6 +8,7 @@ import {IGenArt721CoreContractV3_Base} from "../../../interfaces/v0.8.x/IGenArt7
 import {ABHelpers} from "../ABHelpers.sol";
 
 import {Math} from "@openzeppelin-4.7/contracts/utils/math/Math.sol";
+import {SafeCast} from "@openzeppelin-4.7/contracts/utils/math/SafeCast.sol";
 
 /**
  * @title Art Blocks Max Invocations Library
@@ -21,6 +22,8 @@ import {Math} from "@openzeppelin-4.7/contracts/utils/math/Math.sol";
  */
 
 library MaxInvocationsLib {
+    using SafeCast for uint256;
+
     /**
      * @notice Local max invocations for project `projectId`, tied to core contract `coreContractAddress`,
      * updated to `maxInvocations`.
@@ -76,12 +79,13 @@ library MaxInvocationsLib {
                 projectId: projectId,
                 coreContract: coreContract
             });
-        maxInvocationsProjectConfig.maxInvocations = uint24(coreMaxInvocations);
+        // @dev only bugged core would return > 1e6 invocations, but safe-cast
+        // for additional overflow safety
+        maxInvocationsProjectConfig.maxInvocations = coreMaxInvocations
+            .toUint24();
 
         // We need to ensure maxHasBeenInvoked is correctly set after manually syncing the
         // local maxInvocations value with the core contract's maxInvocations value.
-        // This synced value of maxInvocations from the core contract will always be greater
-        // than or equal to the previous value of maxInvocations stored locally.
         maxInvocationsProjectConfig.maxHasBeenInvoked =
             coreInvocations == coreMaxInvocations;
 
@@ -147,7 +151,7 @@ library MaxInvocationsLib {
      * @param tokenId The id of the token.
      * @param coreContract The address of the core contract.
      */
-    function validatePurchaseEffectsInvocations(
+    function validateMintEffectsInvocations(
         uint256 tokenId,
         address coreContract
     ) internal {
@@ -158,34 +162,31 @@ library MaxInvocationsLib {
                 coreContract: coreContract
             });
         // invocation is token number plus one, and will never overflow due to
-        // limit of 1e6 invocations per project. block scope for gas efficiency
-        // (i.e. avoid an unnecessary var initialization to 0).
-        unchecked {
-            uint256 tokenInvocation = (tokenId % ONE_MILLION) + 1;
-            uint256 localMaxInvocations = maxInvocationsProjectConfig
-                .maxInvocations;
-            // handle the case where the token invocation == minter local max
-            // invocations occurred on a different minter, and we have a stale
-            // local maxHasBeenInvoked value returning a false negative.
-            // @dev this is a CHECK after EFFECTS, so security was considered
-            // in detail here.
-            require(
-                tokenInvocation <= localMaxInvocations,
-                "Max invocations reached"
-            );
-            // in typical case, update the local maxHasBeenInvoked value
-            // to true if the token invocation == minter local max invocations
-            // (enables gas efficient reverts after sellout)
-            if (tokenInvocation == localMaxInvocations) {
-                maxInvocationsProjectConfig.maxHasBeenInvoked = true;
-            }
+        // limit of 1e6 invocations per project.
+        uint256 tokenInvocation = ABHelpers.tokenIdToTokenInvocation(tokenId);
+        uint256 localMaxInvocations = maxInvocationsProjectConfig
+            .maxInvocations;
+        // handle the case where the token invocation == minter local max
+        // invocations occurred on a different minter, and we have a stale
+        // local maxHasBeenInvoked value returning a false negative.
+        // @dev this is a CHECK after EFFECTS, so security was considered
+        // in detail here.
+        require(
+            tokenInvocation <= localMaxInvocations,
+            "Max invocations reached"
+        );
+        // in typical case, update the local maxHasBeenInvoked value
+        // to true if the token invocation == minter local max invocations
+        // (enables gas efficient reverts after sellout)
+        if (tokenInvocation == localMaxInvocations) {
+            maxInvocationsProjectConfig.maxHasBeenInvoked = true;
         }
     }
 
     /**
-     * Checks that the max invocations have not been reached for a given
-     * project. This only checks the minter's local max invocations, and does
-     * not consider the core contract's max invocations.
+     * @notice Checks that the max invocations have not been reached for a
+     * given project. This only checks the minter's local max invocations, and
+     * does not consider the core contract's max invocations.
      * The function reverts if the max invocations have been reached.
      * @param projectId The id of the project.
      * @param coreContract The address of the core contract.
@@ -211,7 +212,6 @@ library MaxInvocationsLib {
      * Returns true if not initialized, false if initialized.
      * @param projectId The id of the project.
      * @param coreContract The address of the core contract.
-     * @return bool
      * @dev We know a project's max invocations have never been initialized if
      * both max invocations and maxHasBeenInvoked are still initial values.
      * This is because if maxInvocations were ever set to zero,
@@ -241,31 +241,15 @@ library MaxInvocationsLib {
      * @param projectId The id of the project.
      * @param coreContract The address of the core contract.
      */
-    function invocationsRemain(
+    function invocationsRemainOnCore(
         uint256 projectId,
         address coreContract
     ) internal view returns (bool) {
-        // get up-to-data invocation data from core contract
-        (
-            uint256 coreInvocations,
-            uint256 coreMaxInvocations
-        ) = coreContractInvocationData({
-                projectId: projectId,
-                coreContract: coreContract
-            });
-        // load minter-local max invocations into memory
-        MaxInvocationsProjectConfig
-            storage maxInvocationsProjectConfig = getMaxInvocationsProjectConfig({
+        return
+            getInvocationsAvailable({
                 projectId: projectId,
                 coreContract: coreContract
-            });
-        // invocations remain available if the core contract has not reached
-        // the most limiting max invocations, either on minter or core contract
-        uint256 limitingMaxInvocations = Math.min(
-            coreMaxInvocations,
-            maxInvocationsProjectConfig.maxInvocations // local max invocations
-        );
-        return coreInvocations < limitingMaxInvocations;
+            }) != 0;
     }
 
     /**
@@ -346,6 +330,26 @@ library MaxInvocationsLib {
         uint256 projectId,
         address coreContract
     ) internal view returns (bool) {
+        return
+            getInvocationsAvailable({
+                projectId: projectId,
+                coreContract: coreContract
+            }) == 0;
+    }
+
+    /**
+     * @notice Function returns the number of invocations available for a given
+     * project. Function checks the core contract's invocations and minter's max
+     * invocations, ensuring that the most limiting value is used, even if the
+     * local minter max invocations is stale.
+     * @param projectId The id of the project.
+     * @param coreContract The address of the core contract.
+     * @return Number of invocations available for the project.
+     */
+    function getInvocationsAvailable(
+        uint256 projectId,
+        address coreContract
+    ) internal view returns (uint256) {
         // get max invocations from core contract
         (
             uint256 coreInvocations,
@@ -354,26 +358,23 @@ library MaxInvocationsLib {
                 projectId: projectId,
                 coreContract: coreContract
             });
-
         MaxInvocationsProjectConfig
             storage maxInvocationsProjectConfig = getMaxInvocationsProjectConfig({
                 projectId: projectId,
                 coreContract: coreContract
             });
-        uint256 localMaxInvocations = maxInvocationsProjectConfig
-            .maxInvocations;
-        // value is locally defined, and could be out of date.
-        // only possible illogical state is if local max invocations is
-        // greater than core contract's max invocations, in which case
-        // we should use the core contract's max invocations
-        if (localMaxInvocations > coreMaxInvocations) {
-            // local max invocations is stale and illogical, defer to core
-            // contract's max invocations since it is the limiting factor
-            return (coreMaxInvocations == coreInvocations);
+        uint256 limitingMaxInvocations = Math.min(
+            coreMaxInvocations,
+            maxInvocationsProjectConfig.maxInvocations // local max invocations
+        );
+        // if core invocations are greater than the limiting max invocations,
+        // return 0 since no invocations remain
+        if (coreInvocations >= limitingMaxInvocations) {
+            return 0;
         }
-        // local max invocations is limiting, so check core invocations against
-        // local max invocations
-        return (coreInvocations >= localMaxInvocations);
+        // otherwise, return the number of invocations remaining
+        // @dev will not undeflow due to previous check
+        return limitingMaxInvocations - coreInvocations;
     }
 
     /**

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

@@ -131,8 +131,8 @@ library MerkleLib {
      * @notice Checks that a given proof is valid for the vault address, and
      * also checks that the vault address has not exceeded the maximum number
      * of invocations per address for the project.
-     * Reverts if the proof is invalid or if the vault address has exceeded the
-     * maximum number of invocations per address for the project.
+     * @dev Reverts if the proof is invalid or if the vault address has
+     * exceeded the maximum number of invocations per address for the project.
      * @param projectId project id to check
      * @param coreContract core contract address to check
      * @param proof Merkle proof to check
@@ -313,13 +313,7 @@ library MerkleLib {
         uint256 maxInvocationsPerAddress = projectMaxInvocationsPerAddress(
             projectConfig
         );
-        if (maxInvocationsPerAddress == 0) {
-            // project does not limit mint invocations per address, so leave
-            // `projectLimitsMintInvocationsPerAddress` at solidity initial
-            // value of false. Also leave `mintInvocationsRemaining` at
-            // solidity initial value of zero, as indicated in this function's
-            // documentation.
-        } else {
+        if (maxInvocationsPerAddress != 0) {
             projectLimitsMintInvocationsPerAddress = true;
             uint256 userMintInvocations = projectConfig.userMintInvocations[
                 address_
@@ -337,6 +331,12 @@ library MerkleLib {
             // else user has reached their maximum invocations, so leave
             // `mintInvocationsRemaining` at solidity initial value of zero
         }
+        // else maxInvocationsPerAddress is zero, then the project does not
+        // limit mint invocations per address, so do nothing. Leave
+        // `projectLimitsMintInvocationsPerAddress` at solidity initial
+        // value of false. Also leave `mintInvocationsRemaining` at
+        // solidity initial value of zero, as indicated in this function's
+        // documentation.
     }
 
     /**
@@ -379,6 +379,10 @@ library MerkleLib {
         bytes32[] calldata proof,
         address address_
     ) private pure returns (bool) {
-        return proof.verifyCalldata(proofRoot, hashAddress(address_));
+        return
+            proof.verifyCalldata({
+                root: proofRoot,
+                leaf: hashAddress(address_)
+            });
     }
 }