@bananapus/721-hook-v6 0.0.10 → 0.0.11

package/README.md

@@ -222,7 +222,7 @@ Each pay/cash out hook can then execute custom behavior based on the custom data
 A project using a 721 tiers hook can specify any number of NFT tiers (up to 65,535 total).
 
 - NFT tiers can be removed by the project owner as long as they are not locked (`cannotBeRemoved`). After removing tiers, call `cleanTiers()` on the store to optimize tier iteration.
-- NFT tiers can be added by the project owner as long as they respect the hook's `flags`. The flags specify if newly added tiers can have votes (voting units), if new tiers can have non-zero reserve frequencies, if new tiers can allow on-demand minting by the project's owner, and if overspending is allowed.
+- NFT tiers can be added by the project owner as long as they respect the hook's `flags`. Tiers must be sorted by category in ascending order — the store reverts with `JB721TiersHookStore_InvalidCategorySortOrder` if not. The flags specify if newly added tiers can have votes (voting units), if new tiers can have non-zero reserve frequencies, if new tiers can allow on-demand minting by the project's owner, and if overspending is allowed.
 
 Each tier has the following properties:
 
@@ -235,8 +235,8 @@ Each tier has the following properties:
 - Voting units (optional). By default, each NFT's voting power equals its tier price. If `useVotingUnits` is true, a custom `votingUnits` value is used instead.
 - A flag to specify whether the NFTs in the tier can always be transferred, or if transfers can be paused depending on the project's ruleset.
 - A flag to specify whether the contract's owner can mint NFTs from the tier on-demand.
-- A split percent and a set of splits (optional). Each tier can route a percentage of its mint price to configured split recipients (other projects, addresses, etc.) every time an NFT from the tier is purchased. The remaining funds stay in the project's balance. The `splitPercent` is out of `JBConstants.SPLITS_TOTAL_PERCENT` (1,000,000,000).
-- A set of flags which restrict tiers added in the future (the votes/reserved frequency/on-demand minting/overspending flags noted above).
+- A split percent and a set of splits (optional). Each tier can route a percentage of its mint price to configured split recipients (other projects, addresses, etc.) every time an NFT from the tier is purchased. The remaining funds stay in the project's balance. The `splitPercent` is out of `JBConstants.SPLITS_TOTAL_PERCENT` (1,000,000,000). When splits are active, the hook adjusts the returned weight so the terminal only mints tokens proportional to the amount that actually enters the project treasury (e.g., a 50% split on a 1 ETH payment results in half the normal token issuance). This weight adjustment can be disabled with the `issueTokensForSplits` flag, which gives payers full token credit regardless of where the funds go.
+- A set of flags which restrict tiers added in the future (the votes/reserved frequency/on-demand minting/overspending/issueTokensForSplits flags noted above).
 
 Additional notes:
 

package/SKILLS.md

@@ -25,7 +25,7 @@ Tiered ERC-721 NFT hook for Juicebox V6 that mints NFTs when a project is paid a
 | `afterPayRecordedWith(context)` | `JB721Hook` | Called by terminal after payment. Validates caller is a project terminal, delegates to virtual `_processPayment`. |
 | `_processPayment(context)` | `JB721TiersHook` | Normalizes payment value via pricing context, decodes payer metadata for tier IDs to mint, calls `_mintAll`, manages pay credits for overspending. Distributes tier split funds via `JB721TiersHookLib.distributeAll` if split amounts were forwarded. |
 | `afterCashOutRecordedWith(context)` | `JB721Hook` | Called by terminal during cash out. Decodes token IDs from metadata, validates ownership, burns NFTs, delegates to virtual `_didBurn`. Reverts if `msg.value != 0`. |
-| `beforePayRecordedWith(context)` | `JB721TiersHook` | Data hook: returns original weight, calculates per-tier split amounts via `JB721TiersHookLib.calculateSplitAmounts`, and sets this contract as the pay hook with the total split amount forwarded. |
+| `beforePayRecordedWith(context)` | `JB721TiersHook` | Data hook: calculates per-tier split amounts via `JB721TiersHookLib.calculateSplitAmounts`, adjusts the weight proportionally so the terminal only mints tokens for the amount that actually enters the project (i.e., `weight = mulDiv(context.weight, amount - totalSplitAmount, amount)`), and sets this contract as the pay hook with the total split amount forwarded. If no splits, returns original weight unchanged. If splits consume the entire payment, returns weight 0. If the `issueTokensForSplits` flag is set, returns the full `context.weight` regardless of splits. |
 | `beforeCashOutRecordedWith(context)` | `JB721Hook` | Data hook: calculates `cashOutCount` (via virtual `cashOutWeightOf`) and `totalSupply` (via virtual `totalCashOutWeight`). Rejects if fungible tokens are also being cashed out. |
 | `adjustTiers(tiersToAdd, tierIdsToRemove)` | `JB721TiersHook` | Owner-only. Adds/removes tiers via `JB721TiersHookLib.adjustTiersFor` (DELEGATECALL). Requires `ADJUST_721_TIERS` permission. Registers tier splits in `JBSplits` if configured. |
 | `mintFor(tierIds, beneficiary)` | `JB721TiersHook` | Owner-only manual mint. Requires `MINT_721` permission. Passes `amount: type(uint256).max` and `isOwnerMint: true` to force the mint. |
@@ -86,7 +86,7 @@ Tiered ERC-721 NFT hook for Juicebox V6 that mints NFTs when a project is paid a
 | `JBStored721Tier` | `uint104 price`, `uint32 remainingSupply`, `uint32 initialSupply`, `uint32 splitPercent`, `uint24 category`, `uint8 discountPercent`, `uint16 reserveFrequency`, `uint8 packedBools` (allowOwnerMint, transfersPausable, useVotingUnits, cannotBeRemoved, cannotIncreaseDiscountPercent) | Internal storage in `JB721TiersHookStore`. Voting units stored separately in `_tierVotingUnitsOf` when `useVotingUnits` is true. |
 | `JB721InitTiersConfig` | `JB721TierConfig[] tiers`, `uint32 currency`, `uint8 decimals`, `IJBPrices prices` | `initialize` -- defines tiers and pricing context |
 | `JBDeploy721TiersHookConfig` | `string name`, `string symbol`, `string baseUri`, `IJB721TokenUriResolver tokenUriResolver`, `string contractUri`, `JB721InitTiersConfig tiersConfig`, `address reserveBeneficiary`, `JB721TiersHookFlags flags` | `deployHookFor`, `launchProjectFor` |
-| `JB721TiersHookFlags` | `bool noNewTiersWithReserves`, `bool noNewTiersWithVotes`, `bool noNewTiersWithOwnerMinting`, `bool preventOverspending` | `initialize`, `recordFlags` |
+| `JB721TiersHookFlags` | `bool noNewTiersWithReserves`, `bool noNewTiersWithVotes`, `bool noNewTiersWithOwnerMinting`, `bool preventOverspending`, `bool issueTokensForSplits` | `initialize`, `recordFlags` |
 | `JB721TiersRulesetMetadata` | `bool pauseTransfers`, `bool pauseMintPendingReserves` | Packed into `JBRulesetMetadata.metadata` per-ruleset (bit 0 = pauseTransfers, bit 1 = pauseMintPendingReserves) |
 | `JBPayDataHookRulesetConfig` | `uint48 mustStartAtOrAfter`, `uint32 duration`, `uint112 weight`, `uint32 weightCutPercent`, `IJBRulesetApprovalHook approvalHook`, `JBPayDataHookRulesetMetadata metadata`, `JBSplitGroup[] splitGroups`, `JBFundAccessLimitGroup[] fundAccessLimitGroups` | `JB721TiersHookProjectDeployer` -- wraps core ruleset config with `useDataHookForPay: true` hardcoded |
 | `JBPayDataHookRulesetMetadata` | Same as `JBRulesetMetadata` minus `allowSetCustomToken` (hardcoded false) and `useDataHookForPay` (hardcoded true) and `dataHook` (set to deployed hook). Includes `ownerMustSendPayouts`. | `launchProjectFor`, `launchRulesetsFor`, `queueRulesetsOf` |
@@ -138,7 +138,7 @@ Each tier has configurable voting power:
 - Each tier can route a percentage of its mint price to configured split recipients. The `splitPercent` field (out of `JBConstants.SPLITS_TOTAL_PERCENT` = 1,000,000,000) determines how much of the price is forwarded.
 - Split recipients are stored in `JBSplits` using group IDs computed as `uint256(uint160(hookAddress)) | (uint256(tierId) << 160)`.
 - Splits are registered via `JB721TiersHookLib._setSplitGroupsFor` when tiers with `splits` are added.
-- In `beforePayRecordedWith`, `calculateSplitAmounts` decodes tier IDs from payer metadata, computes `mulDiv(price, splitPercent, SPLITS_TOTAL_PERCENT)` per tier, and returns the total to be forwarded to the hook.
+- In `beforePayRecordedWith`, `calculateSplitAmounts` decodes tier IDs from payer metadata, computes `mulDiv(price, splitPercent, SPLITS_TOTAL_PERCENT)` per tier, and returns the total to be forwarded to the hook. The weight is adjusted down proportionally unless the `issueTokensForSplits` flag is set, in which case the full `context.weight` is returned.
 - In `afterPayRecordedWith`, `distributeAll` distributes forwarded funds to each tier's split group recipients. Leftover after all splits goes back to the project's balance via `addToBalance`.
 - Split recipients can be projects (via `terminal.pay` or `terminal.addToBalance`) or plain addresses (direct ETH transfer or `SafeERC20.safeTransfer`). Splits with no `projectId` and no `beneficiary` are skipped -- their share stays in the leftover and is routed to the project's own balance via `addToBalanceOf`, preventing a misconfigured split from bricking the payout distribution.
 
@@ -169,6 +169,8 @@ Each tier has configurable voting power:
 - **Max initial supply per tier is 999,999,999** (`_ONE_BILLION - 1`). Exceeding this would cause token ID overflow into the next tier's ID space.
 - **`noNewTiersWithVotes` blocks all voting power**: It rejects tiers where voting units would be non-zero, whether from custom `votingUnits` or from a non-zero `price` (when `useVotingUnits` is false).
 - **`firstOwnerOf` is lazy**: The first owner is only stored when the token is first transferred away from its original holder. Before any transfer, `firstOwnerOf` returns the current owner.
+- **Tiers must be sorted by category, NOT price.** `recordAddTiers` reverts with `JB721TiersHookStore_InvalidCategorySortOrder` if tiers aren't in ascending category order. The `JB721InitTiersConfig` struct comment previously said "sorted by price" but the code enforces category ordering. Within the same category, tiers can be in any order.
+- **Always use `JB721TiersHookProjectDeployer.launchProjectFor` even without NFTs.** Pass an empty tiers array to enable future NFT additions without migration. If a project is launched via `JBController.launchProjectFor` instead, adding NFT tiers later requires wiring a new data hook into a new ruleset — using the 721 deployer from the start avoids this.
 
 ## Example Integration
 
@@ -223,7 +225,8 @@ tiers[0] = JB721TierConfig({
             noNewTiersWithReserves: false,
             noNewTiersWithVotes: false,
             noNewTiersWithOwnerMinting: false,
-            preventOverspending: false
+            preventOverspending: false,
+            issueTokensForSplits: false
         })
     }),
     launchProjectConfig: launchConfig,  // JBLaunchProjectConfig with rulesets, terminals, etc.

package/docs/src/src/JB721TiersHookStore.sol/contract.JB721TiersHookStore.md

@@ -167,7 +167,7 @@ mapping(address hook => mapping(uint256 tierId => JBStored721Tier)) internal _st
 
 
 ### _tierIdAfter
-Returns the ID of the tier which comes after the provided tier ID (sorted by price).
+Returns the ID of the tier which comes after the provided tier ID (sorted by category).
 
 *If empty, assume the next tier ID should come after.*
 
@@ -386,7 +386,7 @@ function tiersOf(
 |`hook`|`address`|The 721 contract to get the tiers of.|
 |`categories`|`uint256[]`|An array tier categories to get tiers from. Send an empty array to get all categories.|
 |`includeResolvedUri`|`bool`|If set to `true`, if the contract has a token URI resolver, its content will be resolved and included.|
-|`startingId`|`uint256`|The ID of the first tier to get (sorted by price). Send 0 to get all active tiers.|
+|`startingId`|`uint256`|The ID of the first tier to get (sorted by category). Send 0 to get all active tiers.|
 |`size`|`uint256`|The number of tiers to include.|
 
 **Returns**
@@ -561,7 +561,7 @@ function totalCashOutWeight(address hook) public view override returns (uint256
 
 ### _firstSortedTierIdOf
 
-Get the first tier ID from an 721 contract (when sorted by price) within a provided category.
+Get the first tier ID from an 721 contract (when sorted by category) within a provided category.
 
 
 ```solidity
@@ -669,7 +669,7 @@ function _isTierRemovedWithRefresh(
 
 ### _lastSortedTierIdOf
 
-The last sorted tier ID from an 721 contract (when sorted by price).
+The last sorted tier ID from an 721 contract (when sorted by category).
 
 
 ```solidity
@@ -690,7 +690,7 @@ function _lastSortedTierIdOf(address hook) internal view returns (uint256 id);
 
 ### _nextSortedTierIdOf
 
-Get the tier ID which comes after the provided one when sorted by price.
+Get the tier ID which comes after the provided one when sorted by category.
 
 
 ```solidity

package/docs/src/src/structs/JB721InitTiersConfig.sol/struct.JB721InitTiersConfig.md

@@ -3,7 +3,7 @@
 
 Config to initialize a `JB721TiersHook` with tiers and price data.
 
-*The `tiers` must be sorted by price (from least to greatest).*
+*The `tiers` must be sorted by category (from least to greatest).*
 
 **Notes:**
 - member: tiers The tiers to initialize the hook with.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bananapus/721-hook-v6",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "license": "MIT",
   "repository": {
     "type": "git",

package/src/JB721TiersHook.sol

@@ -22,6 +22,7 @@ import {IJB721TiersHook} from "./interfaces/IJB721TiersHook.sol";
 import {IJB721TiersHookStore} from "./interfaces/IJB721TiersHookStore.sol";
 import {IJB721TokenUriResolver} from "./interfaces/IJB721TokenUriResolver.sol";
 import {JB721TiersHookLib} from "./libraries/JB721TiersHookLib.sol";
+import {mulDiv} from "@prb/math/src/Common.sol";
 import {JB721TiersRulesetMetadataResolver} from "./libraries/JB721TiersRulesetMetadataResolver.sol";
 import {JB721InitTiersConfig} from "./structs/JB721InitTiersConfig.sol";
 import {JB721Tier} from "./structs/JB721Tier.sol";
@@ -162,7 +163,8 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
     /// @notice The data calculated before a payment is recorded in the terminal store.
     /// @dev Overrides the base to calculate the split amount to forward based on tier split percentages.
     /// @param context The payment context.
-    /// @return weight The weight to use for token minting (unchanged from ruleset weight).
+    /// @return weight The weight to use for token minting, adjusted down when tier splits route funds away from the
+    /// project (unless `issueTokensForSplits` is set).
     /// @return hookSpecifications The hook specifications, with the split amount to forward.
     function beforePayRecordedWith(JBBeforePayRecordedContext calldata context)
         public
@@ -171,13 +173,24 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
         override(JB721Hook, IJBRulesetDataHook)
         returns (uint256 weight, JBPayHookSpecification[] memory hookSpecifications)
     {
-        weight = context.weight;
         hookSpecifications = new JBPayHookSpecification[](1);
 
         // Calculate per-tier split amounts via the library.
         (uint256 totalSplitAmount, bytes memory splitMetadata) =
             JB721TiersHookLib.calculateSplitAmounts(STORE, address(this), METADATA_ID_TARGET, context.metadata);
 
+        // Adjust weight so the terminal mints tokens only for the amount that actually enters the project.
+        if (totalSplitAmount == 0 || STORE.flagsOf(address(this)).issueTokensForSplits) {
+            // No splits, or hook configured to give full token credit regardless — full weight.
+            weight = context.weight;
+        } else if (context.amount.value > totalSplitAmount) {
+            // Partial splits — scale weight by the fraction that enters the project.
+            weight = mulDiv(context.weight, context.amount.value - totalSplitAmount, context.amount.value);
+        } else {
+            // Splits consume the entire payment — no tokens should be minted.
+            weight = 0;
+        }
+
         hookSpecifications[0] = JBPayHookSpecification({hook: this, amount: totalSplitAmount, metadata: splitMetadata});
     }
 
@@ -255,7 +268,7 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
         // Set the flags if needed.
         if (
             flags.noNewTiersWithReserves || flags.noNewTiersWithVotes || flags.noNewTiersWithOwnerMinting
-                || flags.preventOverspending
+                || flags.preventOverspending || flags.issueTokensForSplits
         ) STORE.recordFlags(flags);
 
         // Transfer ownership to the initializer.

package/src/JB721TiersHookStore.sol

@@ -132,7 +132,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
     /// @custom:returns The stored tier, as a `JBStored721Tier` struct.
     mapping(address hook => mapping(uint256 tierId => JBStored721Tier)) internal _storedTierOf;
 
-    /// @notice Returns the ID of the tier which comes after the provided tier ID (sorted by price).
+    /// @notice Returns the ID of the tier which comes after the provided tier ID (sorted by category).
     /// @dev If empty, assume the next tier ID should come after.
     /// @custom:param hook The address of the 721 contract to get the next tier ID from.
     /// @custom:param tierId The ID of the tier to get the next tier ID in relation to.
@@ -247,7 +247,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
     /// @param categories An array tier categories to get tiers from. Send an empty array to get all categories.
     /// @param includeResolvedUri If set to `true`, if the contract has a token URI resolver, its content will be
     /// resolved and included.
-    /// @param startingId The ID of the first tier to get (sorted by price). Send 0 to get all active tiers.
+    /// @param startingId The ID of the first tier to get (sorted by category). Send 0 to get all active tiers.
     /// @param size The number of tiers to include.
     /// @return tiers An array of active 721 tiers.
     function tiersOf(
@@ -482,7 +482,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
     // -------------------------- internal views ------------------------- //
     //*********************************************************************//
 
-    /// @notice Get the first tier ID from an 721 contract (when sorted by price) within a provided category.
+    /// @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.
@@ -578,7 +578,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
         return bitmapWord.isTierIdRemoved(tierId);
     }
 
-    /// @notice The last sorted tier ID from an 721 contract (when sorted by price).
+    /// @notice The last sorted tier ID from an 721 contract (when sorted by category).
     /// @param hook The 721 contract to get the last sorted tier ID of.
     /// @return id The last sorted tier ID.
     function _lastSortedTierIdOf(address hook) internal view returns (uint256 id) {
@@ -587,7 +587,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
         if (id == 0) id = maxTierIdOf[hook];
     }
 
-    /// @notice Get the tier ID which comes after the provided one when sorted by price.
+    /// @notice Get the tier ID which comes after the provided one when sorted by category.
     /// @param hook The 721 contract to get the next sorted tier ID from.
     /// @param id The tier ID to get the next sorted tier ID relative to.
     /// @param max The maximum tier ID.
@@ -782,7 +782,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
             revert JB721TiersHookStore_MaxTiersExceeded(currentMaxTierIdOf + tiersToAdd.length, type(uint16).max);
         }
 
-        // Keep a reference to the current last sorted tier ID (sorted by price).
+        // Keep a reference to the current last sorted tier ID (sorted by category).
         uint256 currentLastSortedTierId = _lastSortedTierIdOf(msg.sender);
 
         // Initialize an array for the new tier IDs to be returned.

package/src/structs/JB721InitTiersConfig.sol

@@ -6,7 +6,7 @@ import {IJBPrices} from "@bananapus/core-v6/src/interfaces/IJBPrices.sol";
 import {JB721TierConfig} from "./JB721TierConfig.sol";
 
 /// @notice Config to initialize a `JB721TiersHook` with tiers and price data.
-/// @dev The `tiers` must be sorted by price (from least to greatest).
+/// @dev The `tiers` must be sorted by category (from least to greatest).
 /// @custom:member tiers The tiers to initialize the hook with.
 /// @custom:member currency The currency that the tier prices are denoted in. See `JBPrices`.
 /// @custom:member decimals The number of decimals in the fixed point tier prices.

package/src/structs/JB721TiersHookFlags.sol

@@ -9,9 +9,12 @@ pragma solidity ^0.8.0;
 /// `allowOwnerMint` set to true will revert.
 /// @custom:member preventOverspending A boolean indicating whether payments attempting to spend more than the price of
 /// the NFTs being minted will revert.
+/// @custom:member issueTokensForSplits A boolean indicating whether payers receive token credit for the portion of
+/// their payment that is routed to tier splits. When false (default), weight is reduced proportionally.
 struct JB721TiersHookFlags {
     bool noNewTiersWithReserves;
     bool noNewTiersWithVotes;
     bool noNewTiersWithOwnerMinting;
     bool preventOverspending;
+    bool issueTokensForSplits;
 }

package/test/E2E/Pay_Mint_Redeem_E2E.t.sol

@@ -798,6 +798,7 @@ contract Test_TiersHook_E2E is TestBaseWorkflow {
             reserveBeneficiary: reserveBeneficiary,
             flags: JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: false,
                 noNewTiersWithVotes: false,
                 noNewTiersWithOwnerMinting: true
@@ -891,6 +892,7 @@ contract Test_TiersHook_E2E is TestBaseWorkflow {
             reserveBeneficiary: reserveBeneficiary,
             flags: JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: false,
                 noNewTiersWithVotes: false,
                 noNewTiersWithOwnerMinting: true

package/test/regression/L34_ReserveBeneficiaryOverwrite.t.sol

@@ -4,7 +4,7 @@ pragma solidity 0.8.26;
 import "../utils/UnitTestSetup.sol";
 import {IJB721TiersHookStore} from "../../src/interfaces/IJB721TiersHookStore.sol";
 
-/// @notice Regression test for L-34: defaultReserveBeneficiaryOf is globally overwritten when adding a tier with
+/// @notice defaultReserveBeneficiaryOf is globally overwritten when adding a tier with
 /// useReserveBeneficiaryAsDefault=true.
 contract Test_L34_ReserveBeneficiaryOverwrite is UnitTestSetup {
     using stdStorage for StdStorage;

package/test/regression/L35_CacheTierLookup.t.sol

@@ -5,13 +5,13 @@ import "../utils/UnitTestSetup.sol";
 import {IJB721TiersHookStore} from "../../src/interfaces/IJB721TiersHookStore.sol";
 import {JB721TiersHookLib} from "../../src/libraries/JB721TiersHookLib.sol";
 
-/// @notice Regression test for L-35: calculateSplitAmounts cached the tierOf result to avoid a duplicate external call.
+/// @notice calculateSplitAmounts caches the tierOf result to avoid a duplicate external call.
 /// Verifies that the cached tier lookup returns the same split amounts as reading price and splitPercent individually.
 contract Test_L35_CacheTierLookup is UnitTestSetup {
     using stdStorage for StdStorage;
 
     /// @notice Verify that calculateSplitAmounts returns correct per-tier amounts when multiple tiers have different
-    /// prices and split percentages. This exercises the cached `tier` variable introduced by L-35.
+    /// prices and split percentages. This exercises the cached `tier` variable.
     function test_calculateSplitAmounts_multiTier_correctAmounts() public {
         ForTest_JB721TiersHook testHook = _initializeForTestHook(0);
         IJB721TiersHookStore hookStore = testHook.STORE();

package/test/regression/L36_SplitNoBeneficiary.t.sol

@@ -10,7 +10,7 @@ import {IJBSplits} from "@bananapus/core-v6/src/interfaces/IJBSplits.sol";
 import {IJBController} from "@bananapus/core-v6/src/interfaces/IJBController.sol";
 import {IJBTerminal} from "@bananapus/core-v6/src/interfaces/IJBTerminal.sol";
 
-/// @notice Regression test for L-36: Split with no beneficiary and no projectId should route funds to the project's
+/// @notice Split with no beneficiary and no projectId should route funds to the project's
 /// balance instead of silently dropping them.
 contract Test_L36_SplitNoBeneficiary is UnitTestSetup {
     using stdStorage for StdStorage;

package/test/unit/adjustTier_Unit.t.sol

@@ -585,6 +585,7 @@ contract Test_adjustTier_Unit is UnitTestSetup {
             IJB721TiersHookStore(address(store)),
             JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: false,
                 noNewTiersWithVotes: false,
                 noNewTiersWithOwnerMinting: true
@@ -715,6 +716,7 @@ contract Test_adjustTier_Unit is UnitTestSetup {
             }),
             JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: false,
                 noNewTiersWithVotes: false,
                 noNewTiersWithOwnerMinting: true
@@ -904,6 +906,7 @@ contract Test_adjustTier_Unit is UnitTestSetup {
             IJB721TiersHookStore(address(store)),
             JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: false,
                 noNewTiersWithVotes: true,
                 noNewTiersWithOwnerMinting: true
@@ -1023,6 +1026,7 @@ contract Test_adjustTier_Unit is UnitTestSetup {
             IJB721TiersHookStore(address(store)),
             JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: true, // <-- This is the flag we're testing.
                 noNewTiersWithVotes: false,
                 noNewTiersWithOwnerMinting: true
@@ -1141,6 +1145,7 @@ contract Test_adjustTier_Unit is UnitTestSetup {
             }),
             JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: false,
                 noNewTiersWithVotes: false,
                 noNewTiersWithOwnerMinting: true
@@ -1213,6 +1218,7 @@ contract Test_adjustTier_Unit is UnitTestSetup {
             IJB721TiersHookStore(address(store)),
             JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: false,
                 noNewTiersWithVotes: false,
                 noNewTiersWithOwnerMinting: true
@@ -1359,6 +1365,7 @@ contract Test_adjustTier_Unit is UnitTestSetup {
             IJB721TiersHookStore(address(store)),
             JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: false,
                 noNewTiersWithVotes: true, // <-- This is the flag we're testing.
                 noNewTiersWithOwnerMinting: true
@@ -1444,6 +1451,7 @@ contract Test_adjustTier_Unit is UnitTestSetup {
             IJB721TiersHookStore(address(store)),
             JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: false,
                 noNewTiersWithVotes: true, // <-- This is the flag we're testing.
                 noNewTiersWithOwnerMinting: true
@@ -1578,6 +1586,7 @@ contract Test_adjustTier_Unit is UnitTestSetup {
             IJB721TiersHookStore(address(store)),
             JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: false,
                 noNewTiersWithVotes: false,
                 noNewTiersWithOwnerMinting: true
@@ -1686,6 +1695,7 @@ contract Test_adjustTier_Unit is UnitTestSetup {
             }),
             JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: false,
                 noNewTiersWithVotes: false,
                 noNewTiersWithOwnerMinting: true
@@ -1762,6 +1772,7 @@ contract Test_adjustTier_Unit is UnitTestSetup {
             }),
             JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: false,
                 noNewTiersWithVotes: false,
                 noNewTiersWithOwnerMinting: true

package/test/unit/getters_constructor_Unit.t.sol

@@ -38,6 +38,7 @@ contract Test_Getters_Constructor_Unit is UnitTestSetup {
             address(0),
             JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: true,
                 noNewTiersWithVotes: true,
                 noNewTiersWithOwnerMinting: true
@@ -544,6 +545,7 @@ contract Test_Getters_Constructor_Unit is UnitTestSetup {
             }),
             JB721TiersHookFlags({
                 preventOverspending: false,
+                issueTokensForSplits: false,
                 noNewTiersWithReserves: true,
                 noNewTiersWithVotes: true,
                 noNewTiersWithOwnerMinting: true

package/test/unit/tierSplitRouting_Unit.t.sol

@@ -7,6 +7,7 @@ import {JBSplit} from "@bananapus/core-v6/src/structs/JBSplit.sol";
 import {IJBSplitHook} from "@bananapus/core-v6/src/interfaces/IJBSplitHook.sol";
 import {IJBSplits} from "@bananapus/core-v6/src/interfaces/IJBSplits.sol";
 import {IJBController} from "@bananapus/core-v6/src/interfaces/IJBController.sol";
+import {JB721TiersHookFlags} from "../../src/structs/JB721TiersHookFlags.sol";
 
 contract Test_TierSplitRouting is UnitTestSetup {
     using stdStorage for StdStorage;
@@ -91,8 +92,8 @@ contract Test_TierSplitRouting is UnitTestSetup {
 
         (uint256 weight, JBPayHookSpecification[] memory specs) = testHook.beforePayRecordedWith(context);
 
-        // Weight unchanged.
-        assertEq(weight, 10e18);
+        // Weight adjusted for 50% split: 10e18 * 0.5 = 5e18.
+        assertEq(weight, 5e18);
         // Hook spec should forward 50% of 1 ETH = 0.5 ETH.
         assertEq(specs.length, 1);
         assertEq(specs[0].amount, 0.5 ether);
@@ -184,6 +185,121 @@ contract Test_TierSplitRouting is UnitTestSetup {
         assertEq(specs[0].amount, 2.3 ether);
     }
 
+    // ──────────────────────────────────────────────
+    // Test: weight adjusted for splits
+    // ──────────────────────────────────────────────
+
+    function test_beforePayRecorded_weightAdjustedForSplits() public {
+        ForTest_JB721TiersHook testHook = _initializeForTestHook(0);
+        IJB721TiersHookStore hookStore = testHook.STORE();
+
+        // Add a tier with 30% split.
+        JB721TierConfig[] memory tierConfigs = new JB721TierConfig[](1);
+        tierConfigs[0] = _tierConfigWithSplit(1 ether, 300_000_000); // 30%
+        vm.prank(address(testHook));
+        uint256[] memory tierIds = hookStore.recordAddTiers(tierConfigs);
+
+        uint16[] memory mintIds = new uint16[](1);
+        mintIds[0] = uint16(tierIds[0]);
+        bytes memory payerMetadata = _buildPayerMetadata(address(testHook), mintIds);
+
+        JBBeforePayRecordedContext memory context = JBBeforePayRecordedContext({
+            terminal: mockTerminalAddress,
+            payer: beneficiary,
+            amount: JBTokenAmount({
+                token: JBConstants.NATIVE_TOKEN,
+                value: 1 ether,
+                decimals: 18,
+                currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
+            }),
+            projectId: projectId,
+            rulesetId: 0,
+            beneficiary: beneficiary,
+            weight: 10e18,
+            reservedPercent: 5000,
+            metadata: payerMetadata
+        });
+
+        (uint256 weight,) = testHook.beforePayRecordedWith(context);
+
+        // Weight adjusted for 30% split: 10e18 * 0.7 = 7e18.
+        assertEq(weight, 7e18);
+    }
+
+    function test_beforePayRecorded_noSplitPercent_weightUnchanged() public {
+        ForTest_JB721TiersHook testHook = _initializeForTestHook(0);
+        IJB721TiersHookStore hookStore = testHook.STORE();
+
+        // Add a tier with 0% split.
+        JB721TierConfig[] memory tierConfigs = new JB721TierConfig[](1);
+        tierConfigs[0] = _tierConfigWithSplit(1 ether, 0);
+        vm.prank(address(testHook));
+        uint256[] memory tierIds = hookStore.recordAddTiers(tierConfigs);
+
+        uint16[] memory mintIds = new uint16[](1);
+        mintIds[0] = uint16(tierIds[0]);
+        bytes memory payerMetadata = _buildPayerMetadata(address(testHook), mintIds);
+
+        JBBeforePayRecordedContext memory context = JBBeforePayRecordedContext({
+            terminal: mockTerminalAddress,
+            payer: beneficiary,
+            amount: JBTokenAmount({
+                token: JBConstants.NATIVE_TOKEN,
+                value: 1 ether,
+                decimals: 18,
+                currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
+            }),
+            projectId: projectId,
+            rulesetId: 0,
+            beneficiary: beneficiary,
+            weight: 10e18,
+            reservedPercent: 5000,
+            metadata: payerMetadata
+        });
+
+        (uint256 weight,) = testHook.beforePayRecordedWith(context);
+
+        // No split = weight unchanged.
+        assertEq(weight, 10e18);
+    }
+
+    function test_beforePayRecorded_fullSplitPercent_weightZero() public {
+        ForTest_JB721TiersHook testHook = _initializeForTestHook(0);
+        IJB721TiersHookStore hookStore = testHook.STORE();
+
+        // Add a tier with 100% split, priced at full payment amount.
+        JB721TierConfig[] memory tierConfigs = new JB721TierConfig[](1);
+        tierConfigs[0] = _tierConfigWithSplit(1 ether, 1_000_000_000); // 100%
+        vm.prank(address(testHook));
+        uint256[] memory tierIds = hookStore.recordAddTiers(tierConfigs);
+
+        uint16[] memory mintIds = new uint16[](1);
+        mintIds[0] = uint16(tierIds[0]);
+        bytes memory payerMetadata = _buildPayerMetadata(address(testHook), mintIds);
+
+        JBBeforePayRecordedContext memory context = JBBeforePayRecordedContext({
+            terminal: mockTerminalAddress,
+            payer: beneficiary,
+            amount: JBTokenAmount({
+                token: JBConstants.NATIVE_TOKEN,
+                value: 1 ether,
+                decimals: 18,
+                currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
+            }),
+            projectId: projectId,
+            rulesetId: 0,
+            beneficiary: beneficiary,
+            weight: 10e18,
+            reservedPercent: 5000,
+            metadata: payerMetadata
+        });
+
+        (uint256 weight,) = testHook.beforePayRecordedWith(context);
+
+        // 100% split of full amount = weight 0.
+        assertEq(weight, 0);
+    }
+
     // ──────────────────────────────────────────────
     // Test: afterPayRecordedWith distributes to split beneficiary
     // ──────────────────────────────────────────────
@@ -272,4 +388,110 @@ contract Test_TierSplitRouting is UnitTestSetup {
         // NFT should have been minted.
         assertEq(testHook.balanceOf(beneficiary), 1);
     }
+
+    // ──────────────────────────────────────────────
+    // Test: issueTokensForSplits flag gives full weight with partial splits
+    // ──────────────────────────────────────────────
+
+    function test_beforePayRecorded_issueTokensForSplits_fullWeight() public {
+        ForTest_JB721TiersHook testHook = _initializeForTestHook(0);
+        IJB721TiersHookStore hookStore = testHook.STORE();
+
+        // Set the issueTokensForSplits flag.
+        vm.prank(address(testHook));
+        hookStore.recordFlags(
+            JB721TiersHookFlags({
+                noNewTiersWithReserves: false,
+                noNewTiersWithVotes: false,
+                noNewTiersWithOwnerMinting: false,
+                preventOverspending: false,
+                issueTokensForSplits: true
+            })
+        );
+
+        // Add a tier with 50% split.
+        JB721TierConfig[] memory tierConfigs = new JB721TierConfig[](1);
+        tierConfigs[0] = _tierConfigWithSplit(1 ether, 500_000_000); // 50%
+        vm.prank(address(testHook));
+        uint256[] memory tierIds = hookStore.recordAddTiers(tierConfigs);
+
+        uint16[] memory mintIds = new uint16[](1);
+        mintIds[0] = uint16(tierIds[0]);
+        bytes memory payerMetadata = _buildPayerMetadata(address(testHook), mintIds);
+
+        JBBeforePayRecordedContext memory context = JBBeforePayRecordedContext({
+            terminal: mockTerminalAddress,
+            payer: beneficiary,
+            amount: JBTokenAmount({
+                token: JBConstants.NATIVE_TOKEN,
+                value: 1 ether,
+                decimals: 18,
+                currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
+            }),
+            projectId: projectId,
+            rulesetId: 0,
+            beneficiary: beneficiary,
+            weight: 10e18,
+            reservedPercent: 5000,
+            metadata: payerMetadata
+        });
+
+        (uint256 weight,) = testHook.beforePayRecordedWith(context);
+
+        // Flag set — weight should be full despite 50% split.
+        assertEq(weight, 10e18);
+    }
+
+    // ──────────────────────────────────────────────
+    // Test: issueTokensForSplits flag gives full weight even when splits consume entire payment
+    // ──────────────────────────────────────────────
+
+    function test_beforePayRecorded_issueTokensForSplits_fullSplit_stillFullWeight() public {
+        ForTest_JB721TiersHook testHook = _initializeForTestHook(0);
+        IJB721TiersHookStore hookStore = testHook.STORE();
+
+        // Set the issueTokensForSplits flag.
+        vm.prank(address(testHook));
+        hookStore.recordFlags(
+            JB721TiersHookFlags({
+                noNewTiersWithReserves: false,
+                noNewTiersWithVotes: false,
+                noNewTiersWithOwnerMinting: false,
+                preventOverspending: false,
+                issueTokensForSplits: true
+            })
+        );
+
+        // Add a tier with 100% split, priced at full payment amount.
+        JB721TierConfig[] memory tierConfigs = new JB721TierConfig[](1);
+        tierConfigs[0] = _tierConfigWithSplit(1 ether, 1_000_000_000); // 100%
+        vm.prank(address(testHook));
+        uint256[] memory tierIds = hookStore.recordAddTiers(tierConfigs);
+
+        uint16[] memory mintIds = new uint16[](1);
+        mintIds[0] = uint16(tierIds[0]);
+        bytes memory payerMetadata = _buildPayerMetadata(address(testHook), mintIds);
+
+        JBBeforePayRecordedContext memory context = JBBeforePayRecordedContext({
+            terminal: mockTerminalAddress,
+            payer: beneficiary,
+            amount: JBTokenAmount({
+                token: JBConstants.NATIVE_TOKEN,
+                value: 1 ether,
+                decimals: 18,
+                currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
+            }),
+            projectId: projectId,
+            rulesetId: 0,
+            beneficiary: beneficiary,
+            weight: 10e18,
+            reservedPercent: 5000,
+            metadata: payerMetadata
+        });
+
+        (uint256 weight,) = testHook.beforePayRecordedWith(context);
+
+        // Flag set — weight should be full despite 100% split consuming entire payment.
+        assertEq(weight, 10e18);
+    }
 }