@bannynet/core-v6 0.0.41 → 0.0.43

package/README.md

@@ -2,13 +2,18 @@
 
 Banny Retail is an onchain avatar system for Juicebox 721 collections. A body NFT can wear outfit NFTs, use a background NFT, and resolve to a base64 JSON token URI whose image is an onchain SVG.
 
-Docs: <https://docs.juicebox.money>
-Architecture: [ARCHITECTURE.md](./ARCHITECTURE.md)  
-User journeys: [USER_JOURNEYS.md](./USER_JOURNEYS.md)  
-Skills: [SKILLS.md](./SKILLS.md)  
-Risks: [RISKS.md](./RISKS.md)  
-Administration: [ADMINISTRATION.md](./ADMINISTRATION.md)  
-Audit instructions: [AUDIT_INSTRUCTIONS.md](./AUDIT_INSTRUCTIONS.md)
+
+## Documentation
+
+- [ARCHITECTURE.md](./ARCHITECTURE.md) — system structure and contract responsibilities
+- [USER_JOURNEYS.md](./USER_JOURNEYS.md) — end-to-end flows for body owners and asset holders
+- [INVARIANTS.md](./INVARIANTS.md) — properties guaranteed by the resolver
+- [RISKS.md](./RISKS.md) — known risks and edge cases
+- [ADMINISTRATION.md](./ADMINISTRATION.md) — owner-only actions and operational levers
+- [AUDIT_INSTRUCTIONS.md](./AUDIT_INSTRUCTIONS.md) — guidance for security reviewers
+- [SKILLS.md](./SKILLS.md) — repo-specific gotchas and integration notes
+- [STYLE_GUIDE.md](./STYLE_GUIDE.md) — coding and naming conventions
+- [CHANGELOG.md](./CHANGELOG.md) — notable changes
 
 ## Overview
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bannynet/core-v6",
-  "version": "0.0.41",
+  "version": "0.0.43",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -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.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",
+    "@bananapus/721-hook-v6": "^0.0.65",
+    "@bananapus/buyback-hook-v6": "^0.0.66",
+    "@bananapus/core-v6": "^0.0.78",
+    "@bananapus/router-terminal-v6": "^0.0.60",
+    "@bananapus/suckers-v6": "^0.0.67",
+    "@croptop/core-v6": "^0.0.64",
     "@openzeppelin/contracts": "5.6.1",
-    "@rev-net/core-v6": "^0.0.78",
+    "@rev-net/core-v6": "^0.0.84",
     "keccak": "3.0.4"
   },
   "devDependencies": {
-    "@bananapus/address-registry-v6": "^0.0.29",
+    "@bananapus/address-registry-v6": "^0.0.32",
     "@sphinx-labs/plugins": "0.33.3"
   }
 }

package/script/Drop1.s.sol

@@ -50,11 +50,58 @@ contract Drop1Script is Script, Sphinx {
     }
 
     function deploy() public sphinx {
+        // Build the Drop 1 tier set, resolving every reserve-bearing tier's beneficiary to the configured
+        // `reserveBeneficiary`.
+        (string[] memory names, bytes32[] memory svgHashes, JB721TierConfig[] memory products) =
+            buildDrop1Tiers(reserveBeneficiary);
+
+        // Capture the pre-existing maxTierIdOf so we can detect drift between Sphinx proposal-time simulation and
+        // execution. Without this guard, an authorized `ADJUST_721_TIERS` call landing between proposal and
+        // execution would shift our 47 new tier IDs upward, and the metadata writes below would silently target
+        // the wrong UPC range (or land on tiers that did not get our SVG/name data).
+        uint256 maxTierIdBeforeAdjust = hook.STORE().maxTierIdOf(address(hook));
+
+        hook.adjustTiers({tiersToAdd: products, tierIdsToRemove: new uint256[](0)});
+
+        // Read maxTierIdOf after adjustTiers so the value reflects our newly added tiers,
+        // avoiding a race condition where another transaction could change maxTierIdOf between
+        // the read and the adjustTiers call.
+        uint256 maxTierId = hook.STORE().maxTierIdOf(address(hook));
+
+        // Drift detection: our 47 tiers should occupy exactly the range (maxTierIdBeforeAdjust, maxTierId]. If
+        // another transaction added tiers between proposal and execution, the range no longer matches the 47-tier
+        // assumption and the metadata writes would target the wrong UPCs.
+        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 this drop's tiers.
+        uint256[] memory productIds = new uint256[](47);
+        for (uint256 i; i < 47; i++) {
+            productIds[i] = maxTierId - 46 + i;
+        }
+
+        bannyverse.resolver.setSvgHashesOf({upcs: productIds, svgHashes: svgHashes});
+        bannyverse.resolver.setProductNames({upcs: productIds, names: names});
+    }
+
+    /// @notice Builds the Drop 1 tier set: product names, SVG hashes, and tier configs.
+    /// @dev Tiers must be sorted by category ascending, and any tier with a non-zero `reserveFrequency` must have a
+    /// resolvable reserve beneficiary at add time. The first reserve-bearing tier sets the hook's default reserve
+    /// beneficiary (via `useReserveBeneficiaryAsDefault`) so that every later reserve-bearing tier inherits it.
+    /// @param reserveBeneficiary_ The address that receives reserve NFTs for every reserve-bearing tier in the drop.
+    /// @return names The product name for each tier, indexed to `products`.
+    /// @return svgHashes The SVG content hash for each tier, indexed to `products`.
+    /// @return products The tier configs to add.
+    function buildDrop1Tiers(address reserveBeneficiary_)
+        public
+        pure
+        returns (string[] memory names, bytes32[] memory svgHashes, JB721TierConfig[] memory products)
+    {
         uint256 decimals = 18;
 
-        string[] memory names = new string[](47);
-        bytes32[] memory svgHashes = new bytes32[](47);
-        JB721TierConfig[] memory products = new JB721TierConfig[](47);
+        names = new string[](47);
+        svgHashes = new bytes32[](47);
+        products = new JB721TierConfig[](47);
 
         // Desk
         names[0] = "Work Station";
@@ -153,6 +200,10 @@ contract Drop1Script is Script, Sphinx {
             splits: new JBSplit[](0)
         });
         // Block chain
+        // This is the first reserve-bearing tier in the drop (sorted by category ascending), so it establishes the
+        // hook's default reserve beneficiary. Setting it here means every later reserve-bearing tier can leave
+        // `reserveBeneficiary` as `address(0)` and inherit this default at add time, and the tiers add in one pass
+        // without a missing-beneficiary revert.
         names[4] = "Block Chain";
         svgHashes[4] = bytes32(0x5e609d387ea091bc8884a753ddd28dd43b8ed1243b29de6e9354ef1ab109a0b9);
         products[4] = JB721TierConfig({
@@ -160,13 +211,13 @@ contract Drop1Script is Script, Sphinx {
             initialSupply: 12,
             votingUnits: 0,
             reserveFrequency: 12,
-            reserveBeneficiary: address(0),
+            reserveBeneficiary: reserveBeneficiary_,
             encodedIpfsUri: bytes32(0xef6478be50575bade53e7ce4c9fb5b399643bcabed94f2111afb63e97fb9fd44),
             category: 3,
             discountPercent: 0,
             flags: JB721TierConfigFlags({
                 allowOwnerMint: true,
-                useReserveBeneficiaryAsDefault: false,
+                useReserveBeneficiaryAsDefault: true,
                 transfersPausable: false,
                 useVotingUnits: false,
                 cantBeRemoved: false,
@@ -232,7 +283,7 @@ contract Drop1Script is Script, Sphinx {
             initialSupply: 100,
             votingUnits: 0,
             reserveFrequency: 25,
-            reserveBeneficiary: reserveBeneficiary,
+            reserveBeneficiary: reserveBeneficiary_,
             encodedIpfsUri: bytes32(0xf01423f9dae3de4adc7e372e6902a351e2c6193a385dde90f5baf37165914831),
             category: 6,
             discountPercent: 0,
@@ -1184,33 +1235,5 @@ contract Drop1Script is Script, Sphinx {
             splitPercent: 0,
             splits: new JBSplit[](0)
         });
-
-        // Capture the pre-existing maxTierIdOf so we can detect drift between Sphinx proposal-time simulation and
-        // execution. Without this guard, an authorized `ADJUST_721_TIERS` call landing between proposal and
-        // execution would shift our 47 new tier IDs upward, and the metadata writes below would silently target
-        // the wrong UPC range (or land on tiers that did not get our SVG/name data).
-        uint256 maxTierIdBeforeAdjust = hook.STORE().maxTierIdOf(address(hook));
-
-        hook.adjustTiers({tiersToAdd: products, tierIdsToRemove: new uint256[](0)});
-
-        // Read maxTierIdOf after adjustTiers so the value reflects our newly added tiers,
-        // avoiding a race condition where another transaction could change maxTierIdOf between
-        // the read and the adjustTiers call.
-        uint256 maxTierId = hook.STORE().maxTierIdOf(address(hook));
-
-        // Drift detection: our 47 tiers should occupy exactly the range (maxTierIdBeforeAdjust, maxTierId]. If
-        // another transaction added tiers between proposal and execution, the range no longer matches the 47-tier
-        // assumption and the metadata writes would target the wrong UPCs.
-        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 this drop's tiers.
-        uint256[] memory productIds = new uint256[](47);
-        for (uint256 i; i < 47; i++) {
-            productIds[i] = maxTierId - 46 + i;
-        }
-
-        bannyverse.resolver.setSvgHashesOf({upcs: productIds, svgHashes: svgHashes});
-        bannyverse.resolver.setProductNames({upcs: productIds, names: names});
     }
 }