@bananapus/721-hook-v6 0.0.1 → 0.0.2

package/package.json

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

package/src/JB721TiersHook.sol

@@ -1,26 +1,35 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.23;
 
+import {IJBCashOutHook} from "@bananapus/core-v6/src/interfaces/IJBCashOutHook.sol";
 import {IJBDirectory} from "@bananapus/core-v6/src/interfaces/IJBDirectory.sol";
+import {IJBPayHook} from "@bananapus/core-v6/src/interfaces/IJBPayHook.sol";
 import {IJBPermissions} from "@bananapus/core-v6/src/interfaces/IJBPermissions.sol";
 import {IJBPrices} from "@bananapus/core-v6/src/interfaces/IJBPrices.sol";
+import {IJBRulesetDataHook} from "@bananapus/core-v6/src/interfaces/IJBRulesetDataHook.sol";
 import {IJBRulesets} from "@bananapus/core-v6/src/interfaces/IJBRulesets.sol";
+import {IJBTerminal} from "@bananapus/core-v6/src/interfaces/IJBTerminal.sol";
+import {JBConstants} from "@bananapus/core-v6/src/libraries/JBConstants.sol";
 import {JBMetadataResolver} from "@bananapus/core-v6/src/libraries/JBMetadataResolver.sol";
 import {JBRulesetMetadataResolver} from "@bananapus/core-v6/src/libraries/JBRulesetMetadataResolver.sol";
+import {JBAfterCashOutRecordedContext} from "@bananapus/core-v6/src/structs/JBAfterCashOutRecordedContext.sol";
 import {JBAfterPayRecordedContext} from "@bananapus/core-v6/src/structs/JBAfterPayRecordedContext.sol";
 import {JBBeforeCashOutRecordedContext} from "@bananapus/core-v6/src/structs/JBBeforeCashOutRecordedContext.sol";
+import {JBBeforePayRecordedContext} from "@bananapus/core-v6/src/structs/JBBeforePayRecordedContext.sol";
+import {JBCashOutHookSpecification} from "@bananapus/core-v6/src/structs/JBCashOutHookSpecification.sol";
+import {JBPayHookSpecification} from "@bananapus/core-v6/src/structs/JBPayHookSpecification.sol";
 import {JBRuleset} from "@bananapus/core-v6/src/structs/JBRuleset.sol";
 import {JBOwnable} from "@bananapus/ownable-v6/src/JBOwnable.sol";
 import {JBPermissionIds} from "@bananapus/permission-ids-v6/src/JBPermissionIds.sol";
+import {IERC2981} from "@openzeppelin/contracts/interfaces/IERC2981.sol";
 import {ERC2771Context} from "@openzeppelin/contracts/metatx/ERC2771Context.sol";
 import {Context} from "@openzeppelin/contracts/utils/Context.sol";
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
-import {mulDiv} from "@prb/math/src/Common.sol";
-
-import {JB721Hook} from "./abstract/JB721Hook.sol";
+import {ERC721} from "./abstract/ERC721.sol";
 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 {JB721TiersRulesetMetadataResolver} from "./libraries/JB721TiersRulesetMetadataResolver.sol";
 import {JBIpfsDecoder} from "./libraries/JBIpfsDecoder.sol";
 import {JB721Tier} from "./structs/JB721Tier.sol";
@@ -35,23 +44,33 @@ import {JB721TiersMintReservesConfig} from "./structs/JB721TiersMintReservesConf
 /// the project is paid, the hook may mint NFTs to the payer, depending on the hook's setup, the amount paid, and
 /// information specified by the payer. The project's owner can enable NFT cash outs through this hook, allowing
 /// holders to burn their NFTs to reclaim funds from the project (in proportion to the NFT's price).
-contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook {
+contract JB721TiersHook is JBOwnable, ERC2771Context, ERC721, IJB721TiersHook {
     //*********************************************************************//
     // --------------------------- custom errors ------------------------- //
     //*********************************************************************//
 
     error JB721TiersHook_AlreadyInitialized(uint256 projectId);
     error JB721TiersHook_CurrencyMismatch(uint256 paymentCurrency, uint256 tierCurrency);
+    error JB721TiersHook_InvalidCashOut();
+    error JB721TiersHook_InvalidPay();
     error JB721TiersHook_InvalidPricingDecimals(uint256 decimals);
     error JB721TiersHook_MintReserveNftsPaused();
     error JB721TiersHook_NoProjectId();
     error JB721TiersHook_Overspending(uint256 leftoverAmount);
     error JB721TiersHook_TierTransfersPaused();
+    error JB721TiersHook_UnauthorizedToken(uint256 tokenId, address holder);
+    error JB721TiersHook_UnexpectedTokenCashedOut();
 
     //*********************************************************************//
     // --------------- public immutable stored properties ---------------- //
     //*********************************************************************//
 
+    /// @notice The directory of terminals and controllers for projects.
+    IJBDirectory public immutable override DIRECTORY;
+
+    /// @notice The ID used when parsing metadata.
+    address public immutable override METADATA_ID_TARGET;
+
     /// @notice The contract storing and managing project rulesets.
     IJBRulesets public immutable override RULESETS;
 
@@ -61,6 +80,10 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
     //*********************************************************************//
     // ---------------------- public stored properties ------------------- //
     //*********************************************************************//
+
+    /// @notice The ID of the project that this contract is associated with.
+    uint256 public override PROJECT_ID;
+
     /// @notice The base URI for the NFT `tokenUris`.
     string public override baseURI;
 
@@ -105,9 +128,10 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
         address trustedForwarder
     )
         JBOwnable(permissions, directory.PROJECTS(), msg.sender, uint88(0))
-        JB721Hook(directory)
         ERC2771Context(trustedForwarder)
     {
+        DIRECTORY = directory;
+        METADATA_ID_TARGET = address(this);
         RULESETS = rulesets;
         STORE = store;
     }
@@ -116,6 +140,61 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
     // ------------------------- external views -------------------------- //
     //*********************************************************************//
 
+    /// @notice The data calculated before a cash out is recorded in the terminal store. This data is provided to the
+    /// terminal's `cashOutTokensOf(...)` transaction.
+    /// @dev Sets this contract as the cash out hook. Part of `IJBRulesetDataHook`.
+    /// @dev This function is used for NFT cash outs, and will only be called if the project's ruleset has
+    /// `useDataHookForCashOut` set to `true`.
+    /// @param context The cash out context passed to this contract by the `cashOutTokensOf(...)` function.
+    /// @return cashOutTaxRate The cash out tax rate influencing the reclaim amount.
+    /// @return cashOutCount The amount of tokens that should be considered cashed out.
+    /// @return totalSupply The total amount of tokens that are considered to be existing.
+    /// @return hookSpecifications The amount and data to send to cash out hooks (this contract) instead of returning to
+    /// the beneficiary.
+    function beforeCashOutRecordedWith(JBBeforeCashOutRecordedContext calldata context)
+        public
+        view
+        virtual
+        override
+        returns (
+            uint256 cashOutTaxRate,
+            uint256 cashOutCount,
+            uint256 totalSupply,
+            JBCashOutHookSpecification[] memory hookSpecifications
+        )
+    {
+        // Make sure (fungible) project tokens aren't also being cashed out.
+        if (context.cashOutCount > 0) revert JB721TiersHook_UnexpectedTokenCashedOut();
+
+        // Fetch the cash out hook metadata using the corresponding metadata ID.
+        (bool metadataExists, bytes memory metadata) = JBMetadataResolver.getDataFor({
+            id: JBMetadataResolver.getId({purpose: "cashOut", target: METADATA_ID_TARGET}), metadata: context.metadata
+        });
+
+        // Use this contract as the only cash out hook.
+        hookSpecifications = new JBCashOutHookSpecification[](1);
+        hookSpecifications[0] = JBCashOutHookSpecification({hook: this, amount: 0, metadata: bytes("")});
+
+        uint256[] memory decodedTokenIds;
+
+        // Decode the metadata.
+        if (metadataExists) decodedTokenIds = abi.decode(metadata, (uint256[]));
+
+        // Use the cash out weight of the provided 721s.
+        cashOutCount = STORE.cashOutWeightOf({hook: address(this), tokenIds: decodedTokenIds});
+
+        // Use the total cash out weight of the 721s.
+        totalSupply = STORE.totalCashOutWeight(address(this));
+
+        // Use the cash out tax rate from the context.
+        cashOutTaxRate = context.cashOutTaxRate;
+    }
+
+    /// @notice Required by the IJBRulesetDataHook interfaces. Return false to not leak any permissions.
+    function hasMintPermissionFor(uint256, JBRuleset memory, address) external pure returns (bool) {
+        return false;
+    }
+
     /// @notice The first owner of an NFT.
     /// @dev This is generally the address which paid for the NFT.
     /// @param tokenId The token ID of the NFT to get the first owner of.
@@ -158,7 +237,40 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
         return STORE.balanceOf({hook: address(this), owner: owner});
     }
 
-    /// @notice Initializes a cloned copy of the original `JB721Hook` contract.
+    /// @notice The data calculated before a payment is recorded in the terminal store. This data is provided to the
+    /// terminal's `pay(...)` transaction.
+    /// @dev Sets this contract as the pay hook. Part of `IJBRulesetDataHook`.
+    /// @param context The payment context passed to this contract by the `pay(...)` function.
+    /// @return weight The new `weight` to use, overriding the ruleset's `weight`.
+    /// @return hookSpecifications The amount and data to send to pay hooks (this contract) instead of adding to the
+    /// terminal's balance.
+    function beforePayRecordedWith(JBBeforePayRecordedContext calldata context)
+        public
+        view
+        virtual
+        override
+        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);
+
+        hookSpecifications[0] = JBPayHookSpecification({hook: this, amount: totalSplitAmount, metadata: splitMetadata});
+    }
+
+    /// @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.
+    function supportsInterface(bytes4 interfaceId) public view virtual override(ERC721, IERC165) returns (bool) {
+        return interfaceId == type(IJB721TiersHook).interfaceId || interfaceId == type(IJBRulesetDataHook).interfaceId
+            || interfaceId == type(IJBPayHook).interfaceId || interfaceId == type(IJBCashOutHook).interfaceId
+            || interfaceId == type(IERC2981).interfaceId || super.supportsInterface(interfaceId);
+    }
+
+    /// @notice Initializes a cloned copy of the original hook contract.
     /// @param projectId The ID of the project this this hook is associated with.
     /// @param name The name of the NFT collection.
     /// @param symbol The symbol representing the NFT collection.
@@ -187,8 +299,9 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
         // Make sure a projectId is provided.
         if (projectId == 0) revert JB721TiersHook_NoProjectId();
 
-        // Initialize the superclass.
-        JB721Hook._initialize({projectId: projectId, name: name, symbol: symbol});
+        // Initialize ERC721 and set the project ID.
+        ERC721._initialize({name_: name, symbol_: symbol});
+        PROJECT_ID = projectId;
 
         // Validate pricing decimals are within a reasonable range.
         if (tiersConfig.decimals > 18) revert JB721TiersHook_InvalidPricingDecimals(tiersConfig.decimals);
@@ -230,31 +343,6 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
         _transferOwnership(_msgSender());
     }
 
-    /// @notice The combined cash out weight of the NFTs with the specified token IDs.
-    /// @dev An NFT's cash out weight is its price.
-    /// @dev To get their relative cash out weight, divide the result by the `totalCashOutWeight(...)`.
-    /// @param tokenIds The token IDs of the NFTs to get the cumulative cash out weight of.
-    /// @return weight The cash out weight of the tokenIds.
-    function cashOutWeightOf(
-        uint256[] memory tokenIds,
-        JBBeforeCashOutRecordedContext calldata
-    )
-        public
-        view
-        virtual
-        override
-        returns (uint256)
-    {
-        return STORE.cashOutWeightOf({hook: address(this), tokenIds: tokenIds});
-    }
-
-    /// @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.
-    function supportsInterface(bytes4 interfaceId) public view override(IERC165, JB721Hook) returns (bool) {
-        return interfaceId == type(IJB721TiersHook).interfaceId || JB721Hook.supportsInterface(interfaceId);
-    }
-
     /// @notice The metadata URI of the NFT with the specified token ID.
     /// @dev Defers to the `tokenUriResolver` if it is set. Otherwise, use the `tokenUri` corresponding with the NFT's
     /// tier.
@@ -274,51 +362,75 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
         });
     }
 
-    /// @notice The combined cash out weight of all outstanding NFTs.
-    /// @dev An NFT's cash out weight is its price.
-    /// @return weight The total cash out weight.
-    function totalCashOutWeight(JBBeforeCashOutRecordedContext calldata)
-        public
-        view
+    //*********************************************************************//
+    // ---------------------- external transactions ---------------------- //
+    //*********************************************************************//
+
+    /// @notice Mints one or more NFTs to the `context.beneficiary` upon payment if conditions are met. Part of
+    /// `IJBPayHook`.
+    /// @dev Reverts if the calling contract is not one of the project's terminals.
+    /// @param context The payment context passed in by the terminal.
+    // slither-disable-next-line locked-ether
+    function afterPayRecordedWith(JBAfterPayRecordedContext calldata context) external payable virtual override {
+        uint256 projectId = PROJECT_ID;
+
+        // Make sure the caller is a terminal of the project, and that the call is being made on behalf of an
+        // interaction with the correct project.
+        if (!DIRECTORY.isTerminalOf(projectId, IJBTerminal(msg.sender)) || context.projectId != projectId) {
+            revert JB721TiersHook_InvalidPay();
+        }
+
+        // Process the payment.
+        _processPayment(context);
+    }
+
+    /// @notice Burns the specified NFTs upon token holder cash out, reclaiming funds from the project's balance for
+    /// `context.beneficiary`. Part of `IJBCashOutHook`.
+    /// @dev Reverts if the calling contract is not one of the project's terminals.
+    /// @param context The cash out context passed in by the terminal.
+    // slither-disable-next-line locked-ether
+    function afterCashOutRecordedWith(JBAfterCashOutRecordedContext calldata context)
+        external
+        payable
         virtual
         override
-        returns (uint256)
     {
-        return STORE.totalCashOutWeight(address(this));
-    }
+        // Keep a reference to the project ID.
+        uint256 projectId = PROJECT_ID;
 
-    //*********************************************************************//
-    // -------------------------- internal views ------------------------- //
-    //*********************************************************************//
+        // Make sure the caller is a terminal of the project, and that the call is being made on behalf of an
+        // interaction with the correct project.
+        if (
+            msg.value != 0 || !DIRECTORY.isTerminalOf({projectId: projectId, terminal: IJBTerminal(msg.sender)})
+                || context.projectId != projectId
+        ) revert JB721TiersHook_InvalidCashOut();
+
+        // Fetch the cash out hook metadata using the corresponding metadata ID.
+        (bool metadataExists, bytes memory metadata) = JBMetadataResolver.getDataFor({
+            id: JBMetadataResolver.getId({purpose: "cashOut", target: METADATA_ID_TARGET}),
+            metadata: context.cashOutMetadata
+        });
 
-    /// @dev ERC-2771 specifies the context as being a single address (20 bytes).
-    function _contextSuffixLength() internal view virtual override(ERC2771Context, Context) returns (uint256) {
-        return super._contextSuffixLength();
-    }
+        uint256[] memory decodedTokenIds;
 
-    /// @notice The project's current ruleset.
-    /// @param projectId The ID of the project to check.
-    /// @return The project's current ruleset.
-    function _currentRulesetOf(uint256 projectId) internal view returns (JBRuleset memory) {
-        // slither-disable-next-line calls-loop
-        return RULESETS.currentOf(projectId);
-    }
+        // Decode the metadata.
+        if (metadataExists) decodedTokenIds = abi.decode(metadata, (uint256[]));
 
-    /// @notice Returns the calldata, preferred to use over `msg.data`
-    /// @return calldata the `msg.data` of this call
-    function _msgData() internal view override(ERC2771Context, Context) returns (bytes calldata) {
-        return ERC2771Context._msgData();
-    }
+        // Iterate through the NFTs, burning them if the owner is correct.
+        for (uint256 i; i < decodedTokenIds.length; i++) {
+            // Set the current NFT's token ID.
+            uint256 tokenId = decodedTokenIds[i];
 
-    /// @notice Returns the sender, preferred to use over `msg.sender`
-    /// @return sender the sender address of this call.
-    function _msgSender() internal view override(ERC2771Context, Context) returns (address sender) {
-        return ERC2771Context._msgSender();
-    }
+            // Make sure the token's owner is correct.
+            if (_ownerOf(tokenId) != context.holder) revert JB721TiersHook_UnauthorizedToken(tokenId, context.holder);
 
-    //*********************************************************************//
-    // ---------------------- external transactions ---------------------- //
-    //*********************************************************************//
+            // Burn the token.
+            _burn(tokenId);
+        }
+
+        // Add to burned counter.
+        STORE.recordBurn(decodedTokenIds);
+    }
 
     /// @notice Add or delete tiers.
     /// @dev Only the contract's owner or an operator with the `ADJUST_TIERS` permission from the owner can adjust the
@@ -332,28 +444,10 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
             account: owner(), projectId: PROJECT_ID, permissionId: JBPermissionIds.ADJUST_721_TIERS
         });
 
-        // Remove the tiers.
-        if (tierIdsToRemove.length != 0) {
-            // Emit events for each removed tier.
-            for (uint256 i; i < tierIdsToRemove.length; i++) {
-                emit RemoveTier({tierId: tierIdsToRemove[i], caller: _msgSender()});
-            }
-
-            // Record the removed tiers.
-            // slither-disable-next-line reentrancy-events
-            STORE.recordRemoveTierIds(tierIdsToRemove);
-        }
-
-        // Add the tiers.
-        if (tiersToAdd.length != 0) {
-            // Record the added tiers in the store.
-            uint256[] memory tierIdsAdded = STORE.recordAddTiers(tiersToAdd);
-
-            // Emit events for each added tier.
-            for (uint256 i; i < tiersToAdd.length; i++) {
-                emit AddTier({tierId: tierIdsAdded[i], tier: tiersToAdd[i], caller: _msgSender()});
-            }
-        }
+        // Delegate to the library (via DELEGATECALL) for tier removal, addition, event emission, and split setting.
+        JB721TiersHookLib.adjustTiersFor(
+            STORE, DIRECTORY, PROJECT_ID, address(this), _msgSender(), tiersToAdd, tierIdsToRemove
+        );
     }
 
     /// @notice Manually mint NFTs from the provided tiers .
@@ -522,16 +616,38 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
     }
 
     //*********************************************************************//
-    // ------------------------ internal functions ----------------------- //
+    // -------------------------- internal views ------------------------- //
     //*********************************************************************//
 
-    /// @notice A function which gets called after NFTs have been cashed out and recorded by the terminal.
-    /// @param tokenIds The token IDs of the NFTs that were burned.
-    function _didBurn(uint256[] memory tokenIds) internal virtual override {
-        // Add to burned counter.
-        STORE.recordBurn(tokenIds);
+    /// @dev ERC-2771 specifies the context as being a single address (20 bytes).
+    function _contextSuffixLength() internal view virtual override(ERC2771Context, Context) returns (uint256) {
+        return super._contextSuffixLength();
+    }
+
+    /// @notice The project's current ruleset.
+    /// @param projectId The ID of the project to check.
+    /// @return The project's current ruleset.
+    function _currentRulesetOf(uint256 projectId) internal view returns (JBRuleset memory) {
+        // slither-disable-next-line calls-loop
+        return RULESETS.currentOf(projectId);
     }
 
+    /// @notice Returns the calldata, preferred to use over `msg.data`
+    /// @return calldata the `msg.data` of this call
+    function _msgData() internal view override(ERC2771Context, Context) returns (bytes calldata) {
+        return ERC2771Context._msgData();
+    }
+
+    /// @notice Returns the sender, preferred to use over `msg.sender`
+    /// @return sender the sender address of this call.
+    function _msgSender() internal view override(ERC2771Context, Context) returns (address sender) {
+        return ERC2771Context._msgSender();
+    }
+
+    //*********************************************************************//
+    // ------------------------ internal functions ----------------------- //
+    //*********************************************************************//
+
     /// @notice Mints one NFT from each of the specified tiers for the beneficiary.
     /// @dev The same tier can be specified more than once.
     /// @param amount The amount to base the mints on. The total price of the NFTs being minted cannot be larger than
@@ -581,36 +697,19 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
     /// the payer's existing credits are NOT applied to the mint. Only the beneficiary's credits are combined with
     /// the incoming payment value. Leftover funds after minting are stored as credits for the beneficiary.
     /// @param context Payment context provided by the terminal after it has recorded the payment in the terminal store.
-    function _processPayment(JBAfterPayRecordedContext calldata context) internal virtual override {
+    function _processPayment(JBAfterPayRecordedContext calldata context) internal virtual {
         // Normalize the payment value based on the pricing context.
         uint256 value;
-
         {
-            uint256 packed = _packedPricingContext;
-            // pricing currency in bits 0-31 (32 bits).
-            uint256 pricingCurrency = uint256(uint32(packed));
-            if (context.amount.currency == pricingCurrency) {
-                value = context.amount.value;
-            } else {
-                // prices in bits 40-199 (160 bits).
-                IJBPrices prices = IJBPrices(address(uint160(packed >> 40)));
-                if (prices != IJBPrices(address(0))) {
-                    // pricing decimals in bits 32-39 (8 bits).
-                    uint256 pricingDecimals = uint256(uint8(packed >> 32));
-                    value = mulDiv(
-                        context.amount.value,
-                        10 ** pricingDecimals,
-                        prices.pricePerUnitOf({
-                            projectId: PROJECT_ID,
-                            pricingCurrency: context.amount.currency,
-                            unitCurrency: pricingCurrency,
-                            decimals: context.amount.decimals
-                        })
-                    );
-                } else {
-                    revert JB721TiersHook_CurrencyMismatch(context.amount.currency, pricingCurrency);
-                }
-            }
+            bool valid;
+            (value, valid) = JB721TiersHookLib.normalizePaymentValue(
+                _packedPricingContext,
+                PROJECT_ID,
+                context.amount.value,
+                context.amount.currency,
+                context.amount.decimals
+            );
+            if (!valid) return;
         }
 
         // Keep a reference to the number of NFT credits the beneficiary already has.
@@ -662,17 +761,14 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
             }
         }
 
-        // If overspending is allowed and there are leftover funds, add those funds to the beneficiary's NFT credits.
-        if (leftoverAmount != 0) {
-            // If overspending isn't allowed, revert.
-            if (!allowOverspending) revert JB721TiersHook_Overspending(leftoverAmount);
+        // If overspending isn't allowed, revert.
+        if (leftoverAmount != 0 && !allowOverspending) revert JB721TiersHook_Overspending(leftoverAmount);
 
-            // Store the leftover amount as NFT credits.
-            unchecked {
-                // Keep a reference to the amount of new NFT credits.
-                uint256 newPayCredits = leftoverAmount + unusedPayCredits;
+        // Update NFT credits if they changed.
+        unchecked {
+            uint256 newPayCredits = leftoverAmount + unusedPayCredits;
 
-                // Emit the change in NFT credits.
+            if (newPayCredits != payCredits) {
                 if (newPayCredits > payCredits) {
                     emit AddPayCredits({
                         amount: newPayCredits - payCredits,
@@ -680,7 +776,7 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
                         account: context.beneficiary,
                         caller: _msgSender()
                     });
-                } else if (payCredits > newPayCredits) {
+                } else {
                     emit UsePayCredits({
                         amount: payCredits - newPayCredits,
                         newTotalCredits: newPayCredits,
@@ -689,21 +785,15 @@ contract JB721TiersHook is JBOwnable, ERC2771Context, JB721Hook, IJB721TiersHook
                     });
                 }
 
-                // Store the new NFT credits for the beneficiary.
                 payCreditsOf[context.beneficiary] = newPayCredits;
             }
-            // Otherwise, reset their NFT credits.
-        } else if (payCredits != unusedPayCredits) {
-            // Emit the change in NFT credits.
-            emit UsePayCredits({
-                amount: payCredits - unusedPayCredits,
-                newTotalCredits: unusedPayCredits,
-                account: context.beneficiary,
-                caller: _msgSender()
-            });
+        }
 
-            // Store the new NFT credits.
-            payCreditsOf[context.beneficiary] = unusedPayCredits;
+        // Distribute any forwarded funds to tier split groups.
+        if (context.hookMetadata.length != 0 && context.forwardedAmount.value != 0) {
+            JB721TiersHookLib.distributeAll(
+                DIRECTORY, PROJECT_ID, address(this), context.forwardedAmount.token, context.hookMetadata
+            );
         }
     }
 

package/src/JB721TiersHookDeployer.sol

@@ -100,6 +100,7 @@ contract JB721TiersHookDeployer is ERC2771Context, IJB721TiersHookDeployer {
         JBOwnable(address(newHook)).transferOwnership(_msgSender());
 
         // Increment the nonce.
+        // slither-disable-next-line reentrancy-benign
         ++_nonce;
 
         // Add the hook to the address registry. This contract's nonce starts at 1.

package/src/JB721TiersHookStore.sol

@@ -139,6 +139,13 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
     /// @custom:returns The following tier's ID.
     mapping(address hook => mapping(uint256 tierId => uint256)) internal _tierIdAfter;
 
+    /// @notice Returns the custom voting units for the provided tier ID on the provided hook.
+    /// @dev Only populated when `useVotingUnits` is true. When not set, voting power defaults to the tier's price.
+    /// @custom:param hook The address of the 721 contract.
+    /// @custom:param tierId The ID of the tier.
+    /// @custom:returns The voting units for the tier.
+    mapping(address hook => mapping(uint256 tierId => uint32)) internal _tierVotingUnitsOf;
+
     //*********************************************************************//
     // ------------------------- external views -------------------------- //
     //*********************************************************************//
@@ -232,7 +239,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
         (,, bool useVotingUnits,,) = _unpackBools(storedTier.packedBools);
 
         // Return the address' voting units within the tier.
-        return balance * (useVotingUnits ? storedTier.votingUnits : storedTier.price);
+        return balance * (useVotingUnits ? _tierVotingUnitsOf[hook][tierId] : storedTier.price);
     }
 
     /// @notice Gets an array of currently active 721 tiers for the provided 721 contract.
@@ -368,7 +375,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
 
             // Add the voting units for the address' balance in this tier.
             // Use custom voting units if set. Otherwise, use the tier's price.
-            units += balance * (useVotingUnits ? storedTier.votingUnits : storedTier.price);
+            units += balance * (useVotingUnits ? _tierVotingUnitsOf[hook][i] : storedTier.price);
         }
     }
 
@@ -529,7 +536,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
             price: storedTier.price,
             remainingSupply: storedTier.remainingSupply,
             initialSupply: storedTier.initialSupply,
-            votingUnits: useVotingUnits ? storedTier.votingUnits : storedTier.price,
+            votingUnits: useVotingUnits ? _tierVotingUnitsOf[hook][tierId] : storedTier.price,
             // No reserve frequency if there is no reserve beneficiary.
             reserveFrequency: reserveBeneficiary == address(0) ? 0 : storedTier.reserveFrequency,
             reserveBeneficiary: reserveBeneficiary,
@@ -540,6 +547,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
             transfersPausable: transfersPausable,
             cannotBeRemoved: cannotBeRemoved,
             cannotIncreaseDiscountPercent: cannotIncreaseDiscountPercent,
+            splitPercent: storedTier.splitPercent,
             resolvedUri: !includeResolvedUri || tokenUriResolverOf[hook] == IJB721TokenUriResolver(address(0))
                 ? ""
                 : tokenUriResolverOf[hook].tokenUriOf({
@@ -848,7 +856,7 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
                 price: uint104(tierToAdd.price),
                 remainingSupply: uint32(tierToAdd.initialSupply),
                 initialSupply: uint32(tierToAdd.initialSupply),
-                votingUnits: uint32(tierToAdd.votingUnits),
+                splitPercent: uint32(tierToAdd.splitPercent),
                 reserveFrequency: uint16(tierToAdd.reserveFrequency),
                 category: uint24(tierToAdd.category),
                 discountPercent: uint8(tierToAdd.discountPercent),
@@ -861,6 +869,11 @@ contract JB721TiersHookStore is IJB721TiersHookStore {
                 })
             });
 
+            // Store voting units in a separate mapping if custom voting units are used.
+            if (tierToAdd.useVotingUnits && tierToAdd.votingUnits != 0) {
+                _tierVotingUnitsOf[msg.sender][tierId] = uint32(tierToAdd.votingUnits);
+            }
+
             // If this is the first tier in a new category, store it as the first tier in that category.
             // The `_startingTierIdOfCategory` of the category "0" will always be the same as the `_tierIdAfter` the 0th
             // tier.