@bananapus/721-hook-v6 0.0.56 → 0.0.58

package/README.md

@@ -73,7 +73,7 @@ That split is why UI bugs, economic bugs, and deployment bugs often land in diff
 1. `test/E2E/Pay_Mint_Redeem_E2E.t.sol`
 2. `test/invariants/TierLifecycleInvariant.t.sol`
 3. `test/invariants/TieredHookStoreInvariant.t.sol`
-4. `test/regression/RegressionSplitCreditsMismatch.t.sol`
+4. `test/regression/SplitCreditsMismatch.t.sol`
 5. `test/regression/ProjectDeployerRulesets.t.sol`
 
 ## Install

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bananapus/721-hook-v6",
-  "version": "0.0.56",
+  "version": "0.0.58",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -26,8 +26,8 @@
   },
   "dependencies": {
     "@bananapus/address-registry-v6": "^0.0.26",
-    "@bananapus/core-v6": "^0.0.60",
-    "@bananapus/ownable-v6": "^0.0.28",
+    "@bananapus/core-v6": "^0.0.70",
+    "@bananapus/ownable-v6": "^0.0.31",
     "@bananapus/permission-ids-v6": "^0.0.27",
     "@openzeppelin/contracts": "5.6.1",
     "@prb/math": "4.1.1",

package/src/JB721TiersHookProjectDeployer.sol

@@ -77,6 +77,7 @@ contract JB721TiersHookProjectDeployer is
     /// @param salt A salt to use for the deterministic deployment.
     /// @return projectId The ID of the newly launched project.
     /// @return hook The 721 tiers hook that was deployed for the project.
+    /// @dev Forwards `msg.value` to `JBProjects.createFor` to cover any configured project creation fee.
     function launchProjectFor(
         address owner,
         JBDeploy721TiersHookConfig calldata deployTiersHookConfig,
@@ -85,12 +86,13 @@ contract JB721TiersHookProjectDeployer is
         bytes32 salt
     )
         external
+        payable
         override
         returns (uint256 projectId, IJB721TiersHook hook)
     {
         // Reserve the project ID up front so permissionless project creations cannot invalidate hook deployment.
         IJBProjects projects = DIRECTORY.PROJECTS();
-        projectId = projects.createFor(address(this));
+        projectId = projects.createFor{value: msg.value}(address(this));
 
         // Deploy the hook.
         hook = HOOK_DEPLOYER.deployHookFor({

package/src/JB721TiersHookStore.sol

@@ -296,7 +296,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
         // Keep a reference to the tier being iterated upon.
         JBStored721Tier memory storedTier;
 
-        // Initialize a `JBBitmapWord` to track if whether tiers have been removed.
+        // Initialize a `JBBitmapWord` to track whether tiers have been removed.
         JBBitmapWord memory bitmapWord;
 
         // Keep a reference to an iterator variable to represent the category being iterated upon.
@@ -578,7 +578,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
     /// @notice Get the first tier ID from an 721 contract (when sorted by category) within a provided category.
     /// @param hook The 721 contract to get the first sorted tier ID of.
     /// @param category The category to get the first sorted tier ID within. Send 0 for the first ID across all tiers,
-    /// which might not be in the 0th category if the 0th category does not exist.
+    /// which may belong to any category.
     /// @return id The first sorted tier ID within the provided category.
     function _firstSortedTierIdOf(address hook, uint256 category) internal view returns (uint256 id) {
         id = category == 0 ? _tierIdAfter[hook][0] : _startingTierIdOfCategory[hook][category];
@@ -952,7 +952,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
             if (i != 0) {
                 uint256 previousCategory = tiersToAdd[i - 1].category;
 
-                // Revert if the category is not equal or greater than the previously added tier's category.
+                // Revert if the category is less than the previously added tier's category.
                 if (tierToAdd.category < previousCategory) {
                     revert JB721TiersHookStore_InvalidCategorySortOrder({
                         tierCategory: tierToAdd.category, previousTierCategory: previousCategory
@@ -1043,8 +1043,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
             // If this is the first tier in a category within this batch, store it as that category's traversal start.
             // Same-category additions are inserted before older tiers in the category-sorted linked list, so a later
             // batch must overwrite the previous start pointer to keep category-filtered `tiersOf` queries complete.
-            // The `_startingTierIdOfCategory` of the category "0" will always be the same as the `_tierIdAfter` the 0th
-            // tier.
+            // Category 0 starts at the same tier as the default traversal.
             // Access the previous tier's category directly from calldata (0 when i == 0, matching the old
             // uninitialized-memory behavior).
             if ((i == 0 ? 0 : tiersToAdd[i - 1].category) != tierToAdd.category && tierToAdd.category != 0) {
@@ -1104,9 +1103,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
 
                         // If the previous tier's `_tierIdAfter` was set to something else, update it.
                         if (previousTierId != tierId - 1 || _tierIdAfter[msg.sender][previousTierId] != 0) {
-                            // Set the the previous tier's `_tierIdAfter` to the tier being added, or 0 if the tier ID
-                            // is
-                            // incremented.
+                            // Point the previous tier at the tier being added, or store 0 when the next ID is implicit.
                             _tierIdAfter[msg.sender][previousTierId] = previousTierId == tierId - 1 ? 0 : tierId;
                         }
 

package/src/abstract/JB721Hook.sol

@@ -61,8 +61,7 @@ abstract contract JB721Hook is ERC721, IJB721Hook {
     /// @param directory A directory of terminals and controllers for projects.
     constructor(IJBDirectory directory) {
         DIRECTORY = directory;
-        // Store the address of the original hook deploy. Clones will each use the address of the instance they're based
-        // on.
+        // Store the implementation address. Clones use their own address when they initialize.
         METADATA_ID_TARGET = address(this);
     }
 
@@ -168,7 +167,7 @@ abstract contract JB721Hook is ERC721, IJB721Hook {
     /// @notice Indicates if this contract adheres to the specified interface.
     /// @dev See {IERC165-supportsInterface}.
     /// @param interfaceId The ID of the interface to check for adherence to.
-    // ERC-2981 royalty support was removed — no royaltyInfo implementation exists.
+    // No ERC-2981 royalty interface is exposed.
     function supportsInterface(bytes4 interfaceId) public view virtual override(ERC721, IERC165) returns (bool) {
         return interfaceId == type(IJB721Hook).interfaceId || interfaceId == type(IJBRulesetDataHook).interfaceId
             || interfaceId == type(IJBPayHook).interfaceId || interfaceId == type(IJBCashOutHook).interfaceId
@@ -262,7 +261,7 @@ abstract contract JB721Hook is ERC721, IJB721Hook {
         // the terminal, so any ETH sent alongside an ERC-20 context would be accidental value trapped in the hook.
         uint256 expectedMsgValue =
             context.forwardedAmount.token == JBConstants.NATIVE_TOKEN ? context.forwardedAmount.value : 0;
-        // Keep the terminal-reported forwarded amount and the actual ETH attached to the callback in lockstep.
+        // Keep the terminal-reported forwarded amount and the ETH attached to the callback in lockstep.
         if (msg.value != expectedMsgValue) {
             revert JB721Hook_InvalidPayValue({
                 token: context.forwardedAmount.token, msgValue: msg.value, forwardedValue: context.forwardedAmount.value

package/src/interfaces/IJB721TiersHookProjectDeployer.sol

@@ -29,6 +29,7 @@ interface IJB721TiersHookProjectDeployer {
     /// @param salt A salt to use for the deterministic deployment.
     /// @return projectId The ID of the newly launched project.
     /// @return hook The 721 tiers hook that was deployed for the project.
+    /// @dev Forwards `msg.value` to `JBProjects.createFor` to cover any configured project creation fee.
     function launchProjectFor(
         address owner,
         JBDeploy721TiersHookConfig memory deployTiersHookConfig,
@@ -37,6 +38,7 @@ interface IJB721TiersHookProjectDeployer {
         bytes32 salt
     )
         external
+        payable
         returns (uint256 projectId, IJB721TiersHook hook);
 
     /// @notice Launches rulesets for a project with an attached 721 tiers hook.

package/src/structs/JB721Tier.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.0;
 import {JB721TierFlags} from "./JB721TierFlags.sol";
 
 /// @custom:member id The tier's ID.
-/// @custom:member price The price to buy an NFT in this tier, in terms of the currency in its `JBInitTiersConfig`.
+/// @custom:member price The price to buy an NFT in this tier, in terms of the currency in its `JB721InitTiersConfig`.
 /// @custom:member remainingSupply The remaining number of NFTs which can be minted from this tier.
 /// @custom:member initialSupply The total number of NFTs which can be minted from this tier.
 /// @custom:member votingUnits The number of votes that each NFT in this tier gets.
@@ -13,14 +13,13 @@ import {JB721TierFlags} from "./JB721TierFlags.sol";
 /// purchased.
 /// @custom:member reserveBeneficiary The address which receives any reserve NFTs from this tier.
 /// @custom:member encodedIpfsUri The IPFS URI to use for each NFT in this tier.
-/// @custom:member category The category that NFTs in this tier belongs to. Used to group NFT tiers.
+/// @custom:member category The category that NFTs in this tier belong to. Used to group NFT tiers.
 /// @custom:member discountPercent The discount that should be applied to the tier.
 /// @custom:member flags Boolean flags for this tier (allowOwnerMint, transfersPausable, cantBeRemoved,
 /// cantIncreaseDiscountPercent, cantBuyWithCredits).
 /// @custom:member splitPercent The percentage of the tier's price that gets routed to the project's split group when
 /// an NFT from this tier is minted. Out of `JBConstants.SPLITS_TOTAL_PERCENT`.
-/// @custom:member resolvedUri A resolved token URI for NFTs in this tier. Only available if the NFT this tier belongs
-/// to has a resolver.
+/// @custom:member resolvedUri A resolved token URI for NFTs in this tier. Only available if the hook has a resolver.
 struct JB721Tier {
     uint32 id;
     uint104 price;

package/src/structs/JB721TierConfig.sol

@@ -6,7 +6,7 @@ import {JBSplit} from "@bananapus/core-v6/src/structs/JBSplit.sol";
 import {JB721TierConfigFlags} from "./JB721TierConfigFlags.sol";
 
 /// @notice Config for a single NFT tier within a `JB721TiersHook`.
-/// @custom:member price The price to buy an NFT in this tier, in terms of the currency in its `JBInitTiersConfig`.
+/// @custom:member price The price to buy an NFT in this tier, in terms of the currency in its `JB721InitTiersConfig`.
 /// @custom:member initialSupply The total number of NFTs which can be minted from this tier.
 /// @custom:member votingUnits The number of votes that each NFT in this tier gets if `useVotingUnits` is true.
 /// @custom:member reserveFrequency The frequency at which an extra NFT is minted for the `reserveBeneficiary` from this
@@ -15,7 +15,7 @@ import {JB721TierConfigFlags} from "./JB721TierConfigFlags.sol";
 /// @custom:member reserveBeneficiary The address which receives any reserve NFTs from this tier. Overrides the default
 /// reserve beneficiary if one is set.
 /// @custom:member encodedIpfsUri The IPFS URI to use for each NFT in this tier.
-/// @custom:member category The category that NFTs in this tier belongs to. Used to group NFT tiers.
+/// @custom:member category The category that NFTs in this tier belong to. Used to group NFT tiers.
 /// @custom:member discountPercent The discount that should be applied to the tier.
 /// @custom:member flags Boolean flags for this tier config (allowOwnerMint, useReserveBeneficiaryAsDefault,
 /// transfersPausable, useVotingUnits, cantBeRemoved, cantIncreaseDiscountPercent, cantBuyWithCredits).

package/src/structs/JBBitmapWord.sol

@@ -3,8 +3,8 @@ pragma solidity ^0.8.0;
 
 /// @dev A "word" is a 256-bit integer that stores the status of 256 bits (true/false values). Each row of the
 /// `JBBitmap` matrix is a "word".
-/// @custom:member The information stored at the index.
-/// @custom:member The index.
+/// @custom:member currentWord The 256-bit bitmap word at `currentDepth`.
+/// @custom:member currentDepth The bitmap row index for `currentWord`.
 struct JBBitmapWord {
     uint256 currentWord;
     uint256 currentDepth;

package/src/structs/JBLaunchRulesetsConfig.sol

@@ -10,7 +10,7 @@ import {JBPayDataHookRulesetConfig} from "./JBPayDataHookRulesetConfig.sol";
 /// @custom:member terminalConfigurations The terminal configurations to add for the project.
 /// @custom:member memo A memo to pass along to the emitted event.
 struct JBLaunchRulesetsConfig {
-    uint56 projectId;
+    uint64 projectId;
     JBPayDataHookRulesetConfig[] rulesetConfigurations;
     JBTerminalConfig[] terminalConfigurations;
     string memo;

package/src/structs/JBPayDataHookRulesetMetadata.sol

@@ -8,7 +8,7 @@ pragma solidity ^0.8.0;
 /// @custom:member baseCurrency The currency on which to base the ruleset's weight.
 /// @custom:member pausePay A flag indicating if the pay functionality should be paused during the ruleset.
 /// @custom:member pauseCreditTransfers A flag indicating if the project token transfer functionality should be paused
-/// during the funding cycle.
+/// during the ruleset.
 /// @custom:member allowOwnerMinting A flag indicating if the project owner or an operator with the `MINT_TOKENS`
 /// permission from the owner should be allowed to mint project tokens on demand during this ruleset.
 /// @custom:member allowSetCustomToken A flag indicating if the project owner can set the project's token to a custom
@@ -21,13 +21,13 @@ pragma solidity ^0.8.0;
 /// terminals to use.
 /// @custom:member allowAddPriceFeed A flag indicating if a project can add new price feeds to calculate exchange rates
 /// between its tokens.
+/// @custom:member ownerMustSendPayouts A flag indicating if the owner must manually trigger payout distributions.
 /// @custom:member holdFees A flag indicating if fees should be held during this ruleset.
 /// @custom:member scopeCashOutsToLocalBalances A flag indicating if omnichain cash-out calculations should use only
 /// the local chain's terminal balance instead of the project's balance held in all terminals.
-/// @custom:member useDataHookForCashOuts A flag indicating if the data hook should be used for cash out transactions
-/// during
-/// this ruleset.
-/// @custom:member metadata Metadata of the metadata, up to uint8 in size.
+/// @custom:member useDataHookForCashOut A flag indicating if the data hook should be used for cash out transactions
+/// during this ruleset.
+/// @custom:member metadata Extra controller-specific metadata packed into the ruleset metadata.
 struct JBPayDataHookRulesetMetadata {
     uint16 reservedPercent;
     uint16 cashOutTaxRate;

package/src/structs/JBQueueRulesetsConfig.sol

@@ -7,7 +7,7 @@ import {JBPayDataHookRulesetConfig} from "./JBPayDataHookRulesetConfig.sol";
 /// @custom:member rulesetConfigurations The ruleset configurations to queue.
 /// @custom:member memo A memo to pass along to the emitted event.
 struct JBQueueRulesetsConfig {
-    uint56 projectId;
+    uint64 projectId;
     JBPayDataHookRulesetConfig[] rulesetConfigurations;
     string memo;
 }

package/src/structs/JBStored721Tier.sol

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-/// @custom:member price The price to buy an NFT in this tier, in terms of the currency in its `JBInitTiersConfig`.
+/// @custom:member price The price to buy an NFT in this tier, in terms of the currency in its `JB721InitTiersConfig`.
 /// @custom:member remainingSupply The remaining number of NFTs which can be minted from this tier.
 /// @custom:member initialSupply The total number of NFTs which can be minted from this tier.
 /// @custom:member splitPercent The percentage of the tier's price that gets routed to the tier's split group when
 /// an NFT from this tier is minted. Out of `JBConstants.SPLITS_TOTAL_PERCENT`.
-/// @custom:member category The category that NFTs in this tier belongs to. Used to group NFT tiers.
+/// @custom:member category The category that NFTs in this tier belong to. Used to group NFT tiers.
 /// @custom:member discountPercent The discount that should be applied to the tier.
 /// @custom:member reserveFrequency The frequency at which an extra NFT is minted for the `reserveBeneficiary` from this
 /// tier. With a `reserveFrequency` of 5, an extra NFT will be minted for the `reserveBeneficiary` for every 5 NFTs