RAM minter

packages/contracts/contracts/interfaces/v0.8.x/ISharedMinterRAMV0.sol

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface adds support for ranked auction minting.
+ * @author Art Blocks Inc.
+ */
+interface ISharedMinterRAMV0 {
+    function createBid(
+        uint256 projectId,
+        address coreContract,
+        uint16 slotIndex
+    ) external payable;
+
+    function topUpBid(
+        uint256 projectId,
+        address coreContract,
+        uint32 bidId,
+        uint16 newSlotIndex
+    ) external payable;
+}

packages/contracts/contracts/libs/v0.8.x/ABHelpers.sol

@@ -21,10 +21,8 @@ library ABHelpers {
         uint256 tokenId
     ) internal pure returns (uint256) {
         // int division properly rounds down
-        // @dev unchecked because will never divide by zero
-        unchecked {
-            return tokenId / ONE_MILLION;
-        }
+        // @dev no way to disable division by zero check in solidity v0.8.24, so not unchecked
+        return tokenId / ONE_MILLION;
     }
 
     /**
@@ -48,9 +46,11 @@ library ABHelpers {
     function tokenIdToTokenInvocation(
         uint256 tokenId
     ) internal pure returns (uint256) {
-        // mod returns remainder, which is the token number
-        // @dev no way to disable mod zero check in solidity, so not unchecked
-        return (tokenId % ONE_MILLION) + 1;
+        unchecked {
+            // mod returns remainder, which is the token number
+            // @dev no way to disable mod zero check in solidity, unchecked to optimize gas for addition
+            return (tokenId % ONE_MILLION) + 1;
+        }
     }
 
     /**

packages/contracts/contracts/libs/v0.8.x/BitMap.sol

@@ -0,0 +1,112 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @dev Library for using uint256 as a mapping to 256 bool values via a bit map.
+ * This is useful for storing a large number of bool values in a compact way.
+ * @dev This implementation is similar to OpenZeppelin's BitMaps library, but a
+ * single uint256 is used directly in memory instead of operating within a
+ * a mapping within a storage struct.
+ * This design limits the number of indices to 256, but is more gas efficient
+ * for use cases that fit within that limit. This is especially true for
+ * operations that require many reads/writes, since SLOAD/SSTORE can be managed
+ * outside of the library.
+ */
+library BitMaps256 {
+    /**
+     * @notice Checks if the bit at a specific index in the bit map is set.
+     * A bit is considered set if it is 1, and unset if it is 0.
+     * @param bitMap BitMap to check.
+     * @param index The index of the bit to check.
+     * @return Indicating if the bit at the specified index is set, false otherwise.
+     */
+    function get(uint256 bitMap, uint8 index) internal pure returns (bool) {
+        uint256 mask = 1 << index;
+        return bitMap & mask != 0;
+    }
+
+    /**
+     * @notice Sets the bit at a specific index in the bit map to 1.
+     * This function creates a new bit map where the bit at the specified index is set,
+     * leaving other bits unchanged.
+     * @param bitMap The original BitMap.
+     * @param index The index of the bit to set.
+     * @return newBitMap The new bit map after setting the bit at the specified index.
+     */
+    function set(
+        uint256 bitMap,
+        uint8 index
+    ) internal pure returns (uint256 newBitMap) {
+        uint256 mask = 1 << index;
+        return bitMap | mask;
+    }
+
+    /**
+     * @notice Unsets the bit at a specific index in the bit map, setting it to 0.
+     * This function creates a new bit map where the bit at the specified index is unset,
+     * leaving other bits unchanged.
+     * @param bitMap The original BitMap.
+     * @param index The index of the bit to unset.
+     * @return newBitMap The new bit map after unsetting the bit at the specified index.
+     */
+    function unset(
+        uint256 bitMap,
+        uint8 index
+    ) internal pure returns (uint256 newBitMap) {
+        uint256 mask = 1 << index;
+        return bitMap & ~mask;
+    }
+
+    /**
+     * @notice Finds the index of the first bit that is set in the bit map
+     * starting from a given index.
+     * Returns (255, false) if no set bits were found.
+     * @param bitMap BitMap to search
+     * @param startIndex Index to start searching from, inclusive
+     * @return minIndex Index of first set bit, or 255 if no bits were found
+     * @return foundSetBit True if a set bit was found, false otherwise
+     */
+    function minBitSet(
+        uint256 bitMap,
+        uint8 startIndex
+    ) internal pure returns (uint256 minIndex, bool foundSetBit) {
+        // check if there's any set bit at or above startIndex
+        if ((bitMap >> startIndex) == 0) {
+            return (255, false);
+        }
+        minIndex = startIndex;
+        // @dev this is a linear search, optimized to start only if there's a set bit at or above startIndex
+        // worst case 255 iterations in memory
+        while (minIndex < 255 && !get(bitMap, uint8(minIndex))) {
+            minIndex++;
+        }
+        foundSetBit = get(bitMap, uint8(minIndex));
+    }
+
+    /**
+     * @notice Finds the index of the highest bit that is set in the bit map
+     * starting from a given index and counting down.
+     * Returns (0, false) if no set bits were found.
+     * @param bitMap BitMap to search
+     * @param startIndex Index to start searching from, inclusive
+     * @return maxIndex Index of last set bit, or 0 if no bits were found
+     * @return foundSetBit True if a set bit was found, false otherwise
+     */
+    function maxBitSet(
+        uint256 bitMap,
+        uint8 startIndex
+    ) internal pure returns (uint256 maxIndex, bool foundSetBit) {
+        if ((bitMap << (255 - startIndex)) == 0) {
+            return (0, false);
+        }
+
+        maxIndex = startIndex;
+        // @dev this is a linear search, worst case 255 iterations in memory
+        while (maxIndex > 0 && !get(bitMap, uint8(maxIndex))) {
+            maxIndex--;
+        }
+        foundSetBit = get(bitMap, uint8(maxIndex));
+    }
+}

packages/contracts/contracts/libs/v0.8.x/PackedBools.sol

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @dev Library for packing multiple boolean values into a single uint256.
+ * This is useful for storing a large number of bool values in a more compact
+ * way than solidify's native bool type, which uses 8 bytes per bool.
+ *
+ * The implementation is similar to a BitMap, but function names are more
+ * descriptive for packing and unpacking multiple bools.
+ *
+ * Note that the library may still be used in cases where less than 256 bools
+ * are needed to be packed. For example, if <= 8 bools are needed, casting may
+ * be used outside of the library for compatibility with any size uint.
+ */
+library PackedBools {
+    function getBool(
+        uint256 packedBool,
+        uint8 index
+    ) internal pure returns (bool) {
+        uint256 mask = 1 << index;
+        return packedBool & mask != 0;
+    }
+
+    function setBoolTrue(
+        uint256 bitMap,
+        uint8 index
+    ) internal pure returns (uint256 newBitMap) {
+        uint256 mask = 1 << index;
+        return bitMap | mask;
+    }
+
+    function setBoolFalse(
+        uint256 bitMap,
+        uint8 index
+    ) internal pure returns (uint256 newBitMap) {
+        uint256 mask = 1 << index;
+        return bitMap & ~mask;
+    }
+}

packages/contracts/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(