@bannynet/core-v6 0.0.39 → 0.0.41

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@bannynet/core-v6",
-  "version": "0.0.39",
+  "version": "0.0.41",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mejango/banny-retail-v6"
+    "url": "git+https://github.com/mejango/banny-retail-v6.git"
   },
   "files": [
     "foundry.toml",
@@ -27,18 +27,18 @@
     "artifacts": "source ./.env && npx sphinx artifacts --org-id 'ea165b21-7cdc-4d7b-be59-ecdd4c26bee4' --project-name 'banny-core-v6'"
   },
   "dependencies": {
-    "@bananapus/721-hook-v6": "^0.0.55",
-    "@bananapus/buyback-hook-v6": "^0.0.51",
-    "@bananapus/core-v6": "^0.0.60",
-    "@bananapus/router-terminal-v6": "^0.0.49",
-    "@bananapus/suckers-v6": "^0.0.52",
-    "@croptop/core-v6": "^0.0.53",
+    "@bananapus/721-hook-v6": "^0.0.59",
+    "@bananapus/buyback-hook-v6": "^0.0.58",
+    "@bananapus/core-v6": "^0.0.72",
+    "@bananapus/router-terminal-v6": "^0.0.55",
+    "@bananapus/suckers-v6": "^0.0.60",
+    "@croptop/core-v6": "^0.0.60",
     "@openzeppelin/contracts": "5.6.1",
-    "@rev-net/core-v6": "^0.0.67",
+    "@rev-net/core-v6": "^0.0.78",
     "keccak": "3.0.4"
   },
   "devDependencies": {
-    "@bananapus/address-registry-v6": "^0.0.26",
+    "@bananapus/address-registry-v6": "^0.0.29",
     "@sphinx-labs/plugins": "0.33.3"
   }
 }

package/script/Drop1.s.sol

@@ -1204,7 +1204,7 @@ contract Drop1Script is Script, Sphinx {
         require(maxTierId == maxTierIdBeforeAdjust + 47, "Drop1: maxTierIdOf drift between proposal and execution");
 
         // Build the product IDs array for the newly added tiers.
-        // The last 47 tier IDs correspond to the 47 tiers we just added.
+        // The last 47 tier IDs correspond to this drop's tiers.
         uint256[] memory productIds = new uint256[](47);
         for (uint256 i; i < 47; i++) {
             productIds[i] = maxTierId - 46 + i;

package/script/helpers/MigrationHelper.sol

@@ -23,25 +23,26 @@ library MigrationHelper {
         internal
         view
     {
-        // Get V5 asset token IDs (from V5 hook)
-        (uint256 v5BackgroundId, uint256[] memory v5OutfitIds) =
+        // Get target asset token IDs from the hook being verified.
+        (uint256 targetBackgroundId, uint256[] memory targetOutfitIds) =
             resolver.assetIdsOf({hook: hookAddress, bannyBodyId: tokenId});
         // Get V4 asset token IDs (from V4 hook)
         (uint256 v4BackgroundId, uint256[] memory v4OutfitIds) =
             v4Resolver.assetIdsOf({hook: v4HookAddress, bannyBodyId: tokenId});
 
         // Compare background UPCs (not token IDs, since they may differ)
-        uint256 v5BackgroundUpc = v5BackgroundId == 0 ? 0 : _getUpc({hook: hookAddress, tokenId: v5BackgroundId});
+        uint256 targetBackgroundUpc =
+            targetBackgroundId == 0 ? 0 : _getUpc({hook: hookAddress, tokenId: targetBackgroundId});
         uint256 v4BackgroundUpc = v4BackgroundId == 0 ? 0 : _getUpc({hook: v4HookAddress, tokenId: v4BackgroundId});
 
-        bool matches = v5BackgroundUpc == v4BackgroundUpc && v5OutfitIds.length == v4OutfitIds.length;
+        bool matches = targetBackgroundUpc == v4BackgroundUpc && targetOutfitIds.length == v4OutfitIds.length;
 
         if (matches) {
             // Compare outfit UPCs
-            for (uint256 i = 0; i < v5OutfitIds.length; i++) {
-                uint256 v5OutfitUpc = _getUpc({hook: hookAddress, tokenId: v5OutfitIds[i]});
+            for (uint256 i = 0; i < targetOutfitIds.length; i++) {
+                uint256 targetOutfitUpc = _getUpc({hook: hookAddress, tokenId: targetOutfitIds[i]});
                 uint256 v4OutfitUpc = _getUpc({hook: v4HookAddress, tokenId: v4OutfitIds[i]});
-                if (v5OutfitUpc != v4OutfitUpc) {
+                if (targetOutfitUpc != v4OutfitUpc) {
                     matches = false;
                     break;
                 }
@@ -54,19 +55,20 @@ library MigrationHelper {
             v4BackgroundUpc = v4BackgroundId == 0 ? 0 : _getUpc({hook: v4HookAddress, tokenId: v4BackgroundId});
 
             require(
-                v5BackgroundUpc == v4BackgroundUpc && v5OutfitIds.length == v4OutfitIds.length, "V4/V5 asset mismatch"
+                targetBackgroundUpc == v4BackgroundUpc && targetOutfitIds.length == v4OutfitIds.length,
+                "V4/target asset mismatch"
             );
 
-            for (uint256 i = 0; i < v5OutfitIds.length; i++) {
-                uint256 v5OutfitUpc = _getUpc({hook: hookAddress, tokenId: v5OutfitIds[i]});
+            for (uint256 i = 0; i < targetOutfitIds.length; i++) {
+                uint256 targetOutfitUpc = _getUpc({hook: hookAddress, tokenId: targetOutfitIds[i]});
                 uint256 v4OutfitUpc = _getUpc({hook: v4HookAddress, tokenId: v4OutfitIds[i]});
-                require(v5OutfitUpc == v4OutfitUpc, "V4/V5 asset mismatch");
+                require(targetOutfitUpc == v4OutfitUpc, "V4/target asset mismatch");
             }
         }
     }
 
-    /// @notice Verify that tier balances in V5 are never greater than in V4 for all owners and tiers
-    /// @param hookAddress V5 hook address
+    /// @notice Verify that target tier balances are never greater than V4 for all owners and tiers
+    /// @param hookAddress Target hook address
     /// @param v4HookAddress V4 hook address
     /// @param v4FallbackResolverAddress V4 fallback resolver address (legacy resolver)
     /// @param owners Array of owner addresses to check
@@ -81,7 +83,7 @@ library MigrationHelper {
         internal
         view
     {
-        IJB721TiersHookStore v5Store = JB721TiersHook(hookAddress).STORE();
+        IJB721TiersHookStore targetStore = JB721TiersHook(hookAddress).STORE();
         IJB721TiersHookStore v4Store = JB721TiersHook(v4HookAddress).STORE();
 
         for (uint256 i = 0; i < owners.length; i++) {
@@ -90,30 +92,30 @@ library MigrationHelper {
             for (uint256 j = 0; j < tierIds.length; j++) {
                 uint256 tierId = tierIds[j];
 
-                // Check if this tier is owned by the fallback resolver in V4
-                // If so, skip verification (these are now owned by rightful owners in V5)
+                // Check if this tier is owned by the fallback resolver in V4.
+                // If so, skip verification because target ownership was intentionally reassigned.
                 uint256 v4FallbackResolverBalance =
                     v4Store.tierBalanceOf({hook: v4HookAddress, owner: v4FallbackResolverAddress, tierId: tierId});
                 if (v4FallbackResolverBalance > 0) {
                     continue;
                 }
 
-                // Get V4 and V5 tier balances for this owner and tier
+                // Get V4 and target tier balances for this owner and tier.
                 uint256 v4Balance = v4Store.tierBalanceOf({hook: v4HookAddress, owner: owner, tierId: tierId});
-                uint256 v5Balance = v5Store.tierBalanceOf({hook: hookAddress, owner: owner, tierId: tierId});
+                uint256 targetBalance = targetStore.tierBalanceOf({hook: hookAddress, owner: owner, tierId: tierId});
 
-                // Require that V5 balance is never greater than V4 balance
+                // Require that the target balance is never greater than the V4 balance.
                 require(
-                    v5Balance <= v4Balance,
+                    targetBalance <= v4Balance,
                     string.concat(
-                        "V5 tier balance exceeds V4: owner=",
+                        "target tier balance exceeds V4: owner=",
                         _addressToString(owner),
                         " tier=",
                         _uint256ToString(tierId),
                         " v4Balance=",
                         _uint256ToString(v4Balance),
-                        " v5Balance=",
-                        _uint256ToString(v5Balance)
+                        " targetBalance=",
+                        _uint256ToString(targetBalance)
                     )
                 );
             }
@@ -155,4 +157,3 @@ library MigrationHelper {
         return string(buffer);
     }
 }
-

package/src/Banny721TokenUriResolver.sol

@@ -65,8 +65,8 @@ contract Banny721TokenUriResolver is
     // ------------------------ private constants ------------------------ //
     //*********************************************************************//
 
-    /// @notice Just a kind reminder to our readers.
-    /// @dev Used in 721 token ID generation.
+    /// @notice The product-token ID divisor used by the 721 tiers hook.
+    /// @dev Token IDs are `productId * 1_000_000_000 + tokenNumber`.
     uint256 private constant _ONE_BILLION = 1_000_000_000;
 
     /// @notice The duration that banny bodies can be locked for.
@@ -100,10 +100,10 @@ contract Banny721TokenUriResolver is
     // --------------------- public stored properties -------------------- //
     //*********************************************************************//
 
-    /// @notice The amount of time each banny body is currently locked for.
+    /// @notice The timestamp until which each banny body's outfit changes are locked.
     /// @custom:param hook The hook address of the collection.
     /// @custom:param bannyBodyId The ID of the banny body to lock.
-    mapping(address hook => mapping(uint256 upc => uint256)) public override outfitLockedUntil;
+    mapping(address hook => mapping(uint256 bannyBodyId => uint256)) public override outfitLockedUntil;
 
     /// @notice The base of the domain hosting the SVG files that can be lazily uploaded to the contract.
     string public override svgBaseUri;
@@ -138,7 +138,7 @@ contract Banny721TokenUriResolver is
     //*********************************************************************//
 
     /// @notice The outfits currently attached to each banny body.
-    /// @dev Naked Banny's will only be shown with outfits currently owned by the owner of the banny body.
+    /// @dev Naked Banny bodies are shown only with outfits currently owned by the body owner.
     /// @dev NOTE: Equipped outfits travel with the banny body NFT on transfer. When a body is transferred,
     /// the new owner inherits all equipped outfits and can unequip them to receive the outfit NFTs.
     // The _attachedOutfitIdsOf array grows with each attachment. Gas cost for operations
@@ -152,7 +152,7 @@ contract Banny721TokenUriResolver is
     mapping(address hook => mapping(uint256 bannyBodyId => uint256[])) internal _attachedOutfitIdsOf;
 
     /// @notice The background currently attached to each banny body.
-    /// @dev Naked Banny's will only be shown with a background currently owned by the owner of the banny body.
+    /// @dev Naked Banny bodies are shown only with a background currently owned by the body owner.
     /// @dev NOTE: Equipped backgrounds travel with the banny body NFT on transfer, same as outfits.
     /// @custom:param hook The hook address of the collection.
     /// @custom:param bannyBodyId The ID of the banny body of the background.
@@ -226,7 +226,7 @@ contract Banny721TokenUriResolver is
         string memory extraMetadata = "";
         string memory attributes = '"attributes": [';
 
-        // If this isn't a banny body, return the asset SVG alone (or on a manakin banny).
+        // If this isn't a banny body, return the asset SVG alone (or on a mannequin banny).
         if (product.category != _BODY_CATEGORY) {
             // Keep a reference to the SVG contents.
             contents = _svgOf({hook: hook, upc: product.id});
@@ -523,7 +523,7 @@ contract Banny721TokenUriResolver is
         // Get a reference to the banny body using the background.
         uint256 bannyBodyId = _userOf[hook][backgroundId];
 
-        // If no banny body is wearing the outfit, or if its no longer the background attached, return 0.
+        // If no banny body is using the background, or if it's no longer attached, return 0.
         if (bannyBodyId == 0 || _attachedBackgroundIdOf[hook][bannyBodyId] != backgroundId) return 0;
 
         // Return the banny body ID.
@@ -745,7 +745,7 @@ contract Banny721TokenUriResolver is
         // Start with the item's name.
         name = string.concat(_productNameOf(product.id), " ");
 
-        // Get just the token ID without the product ID included.
+        // Strip the product prefix from the token ID.
         uint256 rawTokenId = tokenId % _ONE_BILLION;
 
         string memory remainingString = " remaining";
@@ -1428,7 +1428,7 @@ contract Banny721TokenUriResolver is
                     }
                 }
 
-                // Effects: update state now that the old background has been successfully returned.
+                // Update state after the old background has been successfully returned.
                 _attachedBackgroundIdOf[hook][bannyBodyId] = backgroundId;
                 _userOf[hook][backgroundId] = bannyBodyId;
 
@@ -1446,7 +1446,7 @@ contract Banny721TokenUriResolver is
                         _attachedBackgroundIdOf[hook][bannyBodyId] = 0;
                     }
                 } else {
-                    // No transfer needed — just clear the stale attachment record.
+                    // No transfer is needed; clear the stale attachment record.
                     _attachedBackgroundIdOf[hook][bannyBodyId] = 0;
                 }
             }
@@ -1493,7 +1493,7 @@ contract Banny721TokenUriResolver is
             previousOutfitProductCategory = _productOfTokenId({hook: hook, tokenId: previousOutfitId}).category;
         }
 
-        // Iterate through each outfit, transfering them in and adding them to the banny if needed, while transfering
+        // Iterate through each outfit, transferring it in and adding it to the banny if needed, while transferring
         // out and removing old outfits no longer being worn.
         for (uint256 i; i < outfitIds.length;) {
             // Set the outfit ID being iterated on.
@@ -1564,8 +1564,8 @@ contract Banny721TokenUriResolver is
             // Category 0 means the tier was removed — these entries are always processed (transferred out and
             // skipped) so the index advances past them.
             while (previousOutfitId != 0 && previousOutfitProductCategory <= outfitProductCategory) {
-                // Transfer the previous outfit to the owner of the banny if its not being worn.
-                // `_attachedOutfitIdsOf` hasnt been called yet, so the wearer should still be the banny body being
+                // Transfer the previous outfit to the owner of the banny if it's not being worn.
+                // `_attachedOutfitIdsOf` has not been rewritten yet, so the wearer should still be the banny body being
                 // decorated.
                 if (previousOutfitId != outfitId && wearerOf({hook: hook, outfitId: previousOutfitId}) == bannyBodyId) {
                     // Use try-transfer: the previous outfit may have been burned or its tier removed.
@@ -1581,9 +1581,9 @@ contract Banny721TokenUriResolver is
                 }
 
                 if (++previousOutfitIndex < previousOutfitIds.length) {
-                    // set the next previous outfit.
+                    // Advance to the next previous outfit.
                     previousOutfitId = previousOutfitIds[previousOutfitIndex];
-                    // Get the next previous outfit.
+                    // Get the next previous outfit's category.
                     previousOutfitProductCategory = _productOfTokenId({hook: hook, tokenId: previousOutfitId}).category;
                 } else {
                     previousOutfitId = 0;
@@ -1593,7 +1593,7 @@ contract Banny721TokenUriResolver is
 
             // If the outfit is not already being worn by the banny, transfer it to this contract.
             if (wearerOf({hook: hook, outfitId: outfitId}) != bannyBodyId) {
-                // Store the banny that's in the background.
+                // Track the banny body now wearing this outfit.
                 _wearerOf[hook][outfitId] = bannyBodyId;
 
                 // Transfer the outfit to this contract.
@@ -1614,7 +1614,7 @@ contract Banny721TokenUriResolver is
         // attached to this banny. Since only one outfit per category is allowed, this is bounded by the number of
         // outfit categories (a small, fixed set).
         while (previousOutfitId != 0) {
-            // `_attachedOutfitIdsOf` hasnt been called yet, so the wearer should still be the banny body being
+            // `_attachedOutfitIdsOf` has not been rewritten yet, so the wearer should still be the banny body being
             // decorated.
             // Skip outfits that are being re-equipped in the new outfit set.
             if (_isInArray({value: previousOutfitId, array: outfitIds})) {
@@ -1632,7 +1632,7 @@ contract Banny721TokenUriResolver is
             }
 
             if (++previousOutfitIndex < previousOutfitIds.length) {
-                // remove previous product.
+                // Advance to the next previous outfit.
                 previousOutfitId = previousOutfitIds[previousOutfitIndex];
             } else {
                 previousOutfitId = 0;