@bananapus/core-v6 0.0.30 → 0.0.32

package/src/JBRulesets.sol

@@ -355,7 +355,8 @@ contract JBRulesets is JBControlled, IJBRulesets {
     /// @dev If a current ruleset of the project is not found, returns an empty ruleset with all properties set to 0.
     /// @dev The first cycle returns the stored ruleset directly (cycleNumber=1, original weight). Subsequent cycles
     /// simulate cycling with weight decay via `_simulateCycledRulesetBasedOn`. Payout limits reset each cycle because
-    /// the terminal store keys usage by rulesetId, and each cycle produces a new simulated rulesetId.
+    /// they are keyed by `cycleNumber`, but the simulated cycle keeps the same `rulesetId` / config id as the stored
+    /// ruleset it is based on.
     /// @param projectId The ID of the project to get the current ruleset of.
     /// @return ruleset The project's current ruleset.
     function currentOf(uint256 projectId) external view override returns (JBRuleset memory ruleset) {
@@ -671,17 +672,19 @@ contract JBRulesets is JBControlled, IJBRulesets {
             revert JBRulesets_WeightCacheRequired(projectId);
         }
 
-        for (uint256 i; i < weightCutMultiple; i++) {
-            // The number of times to apply the weight cut percent.
+        // Cache the cut factor and max percent to avoid recomputing each iteration.
+        uint256 cutFactor = JBConstants.MAX_WEIGHT_CUT_PERCENT - baseRulesetWeightCutPercent;
+        uint256 maxPercent = JBConstants.MAX_WEIGHT_CUT_PERCENT;
+
+        for (uint256 i; i < weightCutMultiple;) {
             // Base the new weight on the specified ruleset's weight.
-            weight = mulDiv(
-                weight,
-                JBConstants.MAX_WEIGHT_CUT_PERCENT - baseRulesetWeightCutPercent,
-                JBConstants.MAX_WEIGHT_CUT_PERCENT
-            );
+            weight = mulDiv(weight, cutFactor, maxPercent);
 
             // The calculation doesn't need to continue if the weight is 0.
             if (weight == 0) break;
+            unchecked {
+                ++i;
+            }
         }
     }
 
@@ -720,6 +723,7 @@ contract JBRulesets is JBControlled, IJBRulesets {
         }
 
         // Get a reference to the latest ruleset's struct.
+        // Note: full metadata is loaded because `_approvalStatusOf` forwards the struct to external approval hooks.
         JBRuleset memory baseRuleset = _getStructFor({projectId: projectId, rulesetId: latestId});
 
         // Get a reference to the approval status.
@@ -742,7 +746,9 @@ contract JBRulesets is JBControlled, IJBRulesets {
                     && approvalStatus != JBApprovalStatus.ApprovalExpected
                     && approvalStatus != JBApprovalStatus.Empty)
         ) {
-            baseRuleset = _getStructFor({projectId: projectId, rulesetId: baseRuleset.basedOnId});
+            // Metadata not needed — the fallback ruleset is only used for intrinsic fields (start, basedOnId, etc.)
+            // and not forwarded to any external approval hook.
+            baseRuleset = _getStructWithoutMetadataFor({projectId: projectId, rulesetId: baseRuleset.basedOnId});
         }
 
         // Make sure the ruleset starts after the base ruleset.
@@ -895,11 +901,14 @@ contract JBRulesets is JBControlled, IJBRulesets {
         // slither-disable-next-line incorrect-equality
         if (ruleset.basedOnId == 0) return JBApprovalStatus.Empty;
 
-        // Get the struct of the ruleset with the approval hook.
-        JBRuleset memory approvalHookRuleset = _getStructFor({projectId: projectId, rulesetId: ruleset.basedOnId});
+        // Read only the packed user properties to extract the approval hook address,
+        // avoiding the cost of loading the full parent ruleset struct.
+        uint256 packedUserProperties = _packedUserPropertiesOf[projectId][ruleset.basedOnId];
+        // forge-lint: disable-next-line(unsafe-typecast)
+        IJBRulesetApprovalHook approvalHook = IJBRulesetApprovalHook(address(uint160(packedUserProperties)));
 
         // If there is no approval hook, it's considered empty.
-        if (approvalHookRuleset.approvalHook == IJBRulesetApprovalHook(address(0))) {
+        if (approvalHook == IJBRulesetApprovalHook(address(0))) {
             return JBApprovalStatus.Empty;
         }
 
@@ -908,9 +917,7 @@ contract JBRulesets is JBControlled, IJBRulesets {
         // Note: A malicious hook that consumes all gas (e.g. infinite loop) could still DoS via gas exhaustion.
         // This is accepted risk since the project owner chose their own approval hook.
         // slither-disable-next-line calls-loop
-        try approvalHookRuleset.approvalHook.approvalStatusOf({projectId: projectId, ruleset: ruleset}) returns (
-            JBApprovalStatus status
-        ) {
+        try approvalHook.approvalStatusOf({projectId: projectId, ruleset: ruleset}) returns (JBApprovalStatus status) {
             return status;
         } catch {
             return JBApprovalStatus.Failed;
@@ -927,8 +934,8 @@ contract JBRulesets is JBControlled, IJBRulesets {
         // Get a reference to the project's latest ruleset.
         uint256 rulesetId = latestRulesetIdOf[projectId];
 
-        // Get the struct for the latest ruleset.
-        JBRuleset memory ruleset = _getStructFor({projectId: projectId, rulesetId: rulesetId});
+        // Get the struct for the latest ruleset (metadata not needed — only traversal fields are checked).
+        JBRuleset memory ruleset = _getStructWithoutMetadataFor({projectId: projectId, rulesetId: rulesetId});
 
         // Loop through all most recently queued rulesets until an approvable one is found, or we've proven one can't
         // exist.
@@ -944,12 +951,64 @@ contract JBRulesets is JBControlled, IJBRulesets {
                 return ruleset.id;
             }
 
-            ruleset = _getStructFor({projectId: projectId, rulesetId: ruleset.basedOnId});
+            ruleset = _getStructWithoutMetadataFor({projectId: projectId, rulesetId: ruleset.basedOnId});
         } while (ruleset.cycleNumber != 0);
 
         return 0;
     }
 
+    /// @notice Unpack a ruleset's intrinsic and user properties without loading metadata.
+    /// @dev Saves one cold SLOAD (~2,100 gas) compared to `_getStructFor`. Use this for linked-list traversal where
+    /// only `id`, `start`, `duration`, `basedOnId`, `cycleNumber`, `weight`, `weightCutPercent`, and `approvalHook`
+    /// are needed.
+    /// @param projectId The ID of the project the ruleset belongs to.
+    /// @param rulesetId The ID of the ruleset to get the struct for.
+    /// @return ruleset A ruleset struct with `metadata` set to 0.
+    function _getStructWithoutMetadataFor(
+        uint256 projectId,
+        uint256 rulesetId
+    )
+        internal
+        view
+        returns (JBRuleset memory ruleset)
+    {
+        // Return an empty ruleset if the specified `rulesetId` is 0.
+        // slither-disable-next-line incorrect-equality
+        if (rulesetId == 0) return ruleset;
+
+        // forge-lint: disable-next-line(unsafe-typecast)
+        ruleset.id = uint48(rulesetId);
+
+        uint256 packedIntrinsicProperties = _packedIntrinsicPropertiesOf[projectId][rulesetId];
+
+        // `weight` in bits 0-111 bits.
+        // forge-lint: disable-next-line(unsafe-typecast)
+        ruleset.weight = uint112(packedIntrinsicProperties);
+        // `basedOnId` in bits 112-159 bits.
+        // forge-lint: disable-next-line(unsafe-typecast)
+        ruleset.basedOnId = uint48(packedIntrinsicProperties >> 112);
+        // `start` in bits 160-207 bits.
+        // forge-lint: disable-next-line(unsafe-typecast)
+        ruleset.start = uint48(packedIntrinsicProperties >> 160);
+        // `cycleNumber` in bits 208-255 bits.
+        // forge-lint: disable-next-line(unsafe-typecast)
+        ruleset.cycleNumber = uint48(packedIntrinsicProperties >> 208);
+
+        uint256 packedUserProperties = _packedUserPropertiesOf[projectId][rulesetId];
+
+        // approval hook in bits 0-159 bits.
+        // forge-lint: disable-next-line(unsafe-typecast)
+        ruleset.approvalHook = IJBRulesetApprovalHook(address(uint160(packedUserProperties)));
+        // `duration` in bits 160-191 bits.
+        // forge-lint: disable-next-line(unsafe-typecast)
+        ruleset.duration = uint32(packedUserProperties >> 160);
+        // weight cut percent in bits 192-223 bits.
+        // forge-lint: disable-next-line(unsafe-typecast)
+        ruleset.weightCutPercent = uint32(packedUserProperties >> 192);
+
+        // metadata intentionally not loaded — saves one cold SLOAD (~2,100 gas).
+    }
+
     /// @notice Unpack a ruleset's packed stored values into an easy-to-work-with ruleset struct.
     /// @param projectId The ID of the project the ruleset belongs to.
     /// @param rulesetId The ID of the ruleset to get the full struct for.
@@ -1066,8 +1125,8 @@ contract JBRulesets is JBControlled, IJBRulesets {
         // Get a reference to the ID of the project's latest ruleset.
         rulesetId = latestRulesetIdOf[projectId];
 
-        // Get the struct for the latest ruleset.
-        JBRuleset memory ruleset = _getStructFor({projectId: projectId, rulesetId: rulesetId});
+        // Get the struct for the latest ruleset (metadata not needed — only traversal fields are checked).
+        JBRuleset memory ruleset = _getStructWithoutMetadataFor({projectId: projectId, rulesetId: rulesetId});
 
         // There is no upcoming ruleset if the latest ruleset has already started.
         // slither-disable-next-line incorrect-equality
@@ -1085,7 +1144,7 @@ contract JBRulesets is JBControlled, IJBRulesets {
 
         // Find the base ruleset that is not still queued.
         while (true) {
-            baseRuleset = _getStructFor({projectId: projectId, rulesetId: basedOnId});
+            baseRuleset = _getStructWithoutMetadataFor({projectId: projectId, rulesetId: basedOnId});
 
             // If the base ruleset starts in the future,
             if (block.timestamp < baseRuleset.start) {
@@ -1099,8 +1158,8 @@ contract JBRulesets is JBControlled, IJBRulesets {
             }
         }
 
-        // Get the ruleset struct for the ID found.
-        ruleset = _getStructFor({projectId: projectId, rulesetId: rulesetId});
+        // Get the ruleset struct for the ID found (metadata not needed — only `start` and `duration` are checked).
+        ruleset = _getStructWithoutMetadataFor({projectId: projectId, rulesetId: rulesetId});
 
         // If the latest ruleset doesn't start until after another base ruleset return 0.
         if (baseRuleset.duration != 0 && block.timestamp < ruleset.start - baseRuleset.duration) {

package/src/JBSplits.sol

@@ -97,15 +97,13 @@ contract JBSplits is JBControlled, IJBSplits {
         // Cache whether the controller check has already passed to avoid repeated external calls.
         bool controllerChecked;
 
-        // Set each grouped splits.
-        for (uint256 i; i < splitGroups.length; i++) {
-            // Get a reference to the grouped split being iterated on.
-            JBSplitGroup memory splitGroup = splitGroups[i];
-
+        // Set each grouped splits. Access calldata directly to avoid copying each split group to memory.
+        for (uint256 i; i < splitGroups.length;) {
             // Self-auth: lower 160 bits must match msg.sender AND upper 96 bits must be non-zero.
             // GroupIds with zero upper bits are reserved for protocol use (e.g. terminal payout groups)
             // and always require controller authorization to prevent token contracts from hijacking payouts.
-            bool isSelfManaged = splitGroup.groupId >> 160 != 0 && address(uint160(splitGroup.groupId)) == msg.sender;
+            bool isSelfManaged =
+                splitGroups[i].groupId >> 160 != 0 && address(uint160(splitGroups[i].groupId)) == msg.sender;
 
             if (!isSelfManaged && !controllerChecked) {
                 _onlyControllerOf(projectId);
@@ -114,8 +112,14 @@ contract JBSplits is JBControlled, IJBSplits {
 
             // Set the splits for the group.
             _setSplitsOf({
-                projectId: projectId, rulesetId: rulesetId, groupId: splitGroup.groupId, splits: splitGroup.splits
+                projectId: projectId,
+                rulesetId: rulesetId,
+                groupId: splitGroups[i].groupId,
+                splits: splitGroups[i].splits
             });
+            unchecked {
+                ++i;
+            }
         }
     }
 
@@ -168,7 +172,7 @@ contract JBSplits is JBControlled, IJBSplits {
         uint256 numberOfCurrentSplits = currentSplits.length;
 
         // Check to see if all locked splits are included in the array of splits which is being set.
-        for (uint256 i; i < numberOfCurrentSplits; i++) {
+        for (uint256 i; i < numberOfCurrentSplits;) {
             // If not locked, continue.
             if (
                 block.timestamp < currentSplits[i].lockedUntil
@@ -176,6 +180,9 @@ contract JBSplits is JBControlled, IJBSplits {
             ) {
                 revert JBSplits_PreviousLockedSplitsNotIncluded(projectId, rulesetId);
             }
+            unchecked {
+                ++i;
+            }
         }
 
         // Add up all the `percent`s to make sure their total is under 100%.
@@ -184,7 +191,7 @@ contract JBSplits is JBControlled, IJBSplits {
         // Keep a reference to the number of splits to set.
         uint256 numberOfSplits = splits.length;
 
-        for (uint256 i; i < numberOfSplits; i++) {
+        for (uint256 i; i < numberOfSplits;) {
             // Set the split being iterated on.
             JBSplit memory split = splits[i];
 
@@ -228,6 +235,9 @@ contract JBSplits is JBControlled, IJBSplits {
             emit SetSplit({
                 projectId: projectId, rulesetId: rulesetId, groupId: groupId, split: split, caller: msg.sender
             });
+            unchecked {
+                ++i;
+            }
         }
 
         // Store the number of splits for the project, ruleset, and group.
@@ -235,9 +245,12 @@ contract JBSplits is JBControlled, IJBSplits {
 
         // Clean up stale storage slots if the new split count is less than the previous count.
         // This zeroes out leftover packed data to reclaim gas via storage refunds.
-        for (uint256 i = numberOfSplits; i < numberOfCurrentSplits; i++) {
+        for (uint256 i = numberOfSplits; i < numberOfCurrentSplits;) {
             delete _packedSplitParts1Of[projectId][rulesetId][groupId][i];
             delete _packedSplitParts2Of[projectId][rulesetId][groupId][i];
+            unchecked {
+                ++i;
+            }
         }
     }
 
@@ -267,7 +280,7 @@ contract JBSplits is JBControlled, IJBSplits {
         JBSplit[] memory splits = new JBSplit[](splitCount);
 
         // Loop through each split and unpack the values into structs.
-        for (uint256 i; i < splitCount; i++) {
+        for (uint256 i; i < splitCount;) {
             // Get a reference to the first part of the split's packed data.
             uint256 packedSplitPart1 = _packedSplitParts1Of[projectId][rulesetId][groupId][i];
 
@@ -301,6 +314,9 @@ contract JBSplits is JBControlled, IJBSplits {
 
             // Add the split to the value being returned.
             splits[i] = split;
+            unchecked {
+                ++i;
+            }
         }
 
         return splits;
@@ -314,7 +330,7 @@ contract JBSplits is JBControlled, IJBSplits {
         // Keep a reference to the number of splits.
         uint256 numberOfSplits = splits.length;
 
-        for (uint256 i; i < numberOfSplits; i++) {
+        for (uint256 i; i < numberOfSplits;) {
             // Set the split being iterated on.
             JBSplit memory split = splits[i];
 
@@ -326,6 +342,9 @@ contract JBSplits is JBControlled, IJBSplits {
                     && split.preferAddToBalance == lockedSplit.preferAddToBalance
                     && split.lockedUntil >= lockedSplit.lockedUntil
             ) return true;
+            unchecked {
+                ++i;
+            }
         }
 
         return false;