@bananapus/core-v6 0.0.81 → 0.0.83

package/src/interfaces/IJBController.sol

@@ -329,8 +329,8 @@ interface IJBController is IERC165, IJBProjectUriRegistry, IJBDirectoryAccessCon
     /// @notice Mints new project tokens (or credits) to a beneficiary, optionally reserving a portion for the ruleset's
     /// reserved splits.
     /// @param projectId The ID of the project whose project tokens are being minted.
-    /// @param tokenCount The total number of project tokens to mint (the beneficiary's share plus the reserved share if
-    /// `useReservedPercent` is true).
+    /// @param tokenCount The total number of project tokens to mint, including reserved tokens if
+    /// `useReservedPercent` is true.
     /// @param beneficiary The address that receives the non-reserved portion of the minted project tokens.
     /// @param memo A memo to pass along to the emitted event.
     /// @param useReservedPercent Whether to apply the ruleset's reserved percent.

package/src/interfaces/IJBFeelessAddresses.sol

@@ -13,8 +13,7 @@ interface IJBFeelessAddresses {
     /// @param caller The address that set the feeless status.
     event SetFeelessAddress(uint256 indexed projectId, address indexed addr, bool indexed isFeeless, address caller);
 
-    /// @notice The optional hook (set by the owner) that can grant feeless status with arbitrary logic. Set to the
-    /// zero address to disable.
+    /// @notice The optional owner-set hook that can grant feeless status. Set to the zero address to disable.
     /// @param hook The new feeless hook. The zero address disables hook consultation.
     /// @param caller The address that set the hook.
     event SetFeelessHook(IJBFeelessHook indexed hook, address caller);

package/src/interfaces/IJBFeelessHook.sol

@@ -17,8 +17,8 @@ interface IJBFeelessHook is IERC165 {
     /// the terminal (so it gets fee-free cash-outs when zapping, but does NOT get feeless status when it merely
     /// appears as a split recipient of someone else's payout).
     /// @param projectId The ID of the project the fee would be charged on behalf of.
-    /// @param addr The address being checked (typically a payout recipient, surplus allowance beneficiary, or
-    /// cash-out beneficiary).
+    /// @param addr The address being checked, typically a payout recipient, surplus allowance beneficiary, or cash-out
+    /// beneficiary.
     /// @param caller The outer caller that initiated the terminal operation, or `address(0)` if not provided.
     /// @return A flag indicating whether the address is feeless for the project under the hook's custom logic.
     function isFeeless(uint256 projectId, address addr, address caller) external view returns (bool);

package/src/libraries/JBMetadataResolver.sol

@@ -25,9 +25,16 @@ pragma solidity 0.8.28;
  *            +-----------------------+
  */
 library JBMetadataResolver {
+    /// @notice Thrown when the data to add is not padded to a multiple of 32 bytes.
     error JBMetadataResolver_DataNotPadded(uint256 dataLength);
+
+    /// @notice Thrown when the IDs and datas arrays have mismatched lengths.
     error JBMetadataResolver_LengthMismatch(uint256 idsLength, uint256 datasLength);
+
+    /// @notice Thrown when the metadata offset exceeds the maximum addressable offset of 255.
     error JBMetadataResolver_MetadataTooLong(uint256 offset, uint256 maxOffset);
+
+    /// @notice Thrown when the metadata is shorter than the minimum required length.
     error JBMetadataResolver_MetadataTooShort(uint256 metadataLength, uint256 minMetadataLength);
 
     // Constants alphabetized per STYLE_GUIDE; trailing comments document derivation.
@@ -260,7 +267,7 @@ library JBMetadataResolver {
             if (parsedId == id) {
                 // Are we at the end of the lookup table (either at the start of data's or next offset is 0/in the
                 // padding)
-                // If not, only return until from this offset to the begining of the next offset
+                // If not, only return until from this offset to the beginning of the next offset
                 uint256 end = (i + NEXT_ID_OFFSET >= firstOffset * WORD_SIZE || metadata[i + NEXT_ID_OFFSET] == 0)
                     ? metadata.length
                     : uint256(uint8(metadata[i + NEXT_ID_OFFSET])) * WORD_SIZE;
@@ -295,6 +302,7 @@ library JBMetadataResolver {
     /// @param start The start index to slice at.
     /// @param end The end index to slice at.
     /// @param slicedBytes The sliced array.
+    /// @return slicedBytes The sliced array.
     function _sliceBytes(bytes memory data, uint256 start, uint256 end)
         private
         pure

package/src/libraries/JBPayoutSplitGroupLib.sol

@@ -44,8 +44,22 @@ interface IJBPayoutSplitGroupExecutor {
 /// @dev Extracted as an external library to reduce `JBMultiTerminal` bytecode size. Called via DELEGATECALL, so events
 /// are emitted from the terminal's address.
 library JBPayoutSplitGroupLib {
+    /// @notice A payout to a split reverted, so the amount was returned to the project's balance.
+    /// @param projectId The ID of the project whose payout reverted.
+    /// @param split The split that was being paid when the revert occurred.
+    /// @param amount The amount that was being sent to the split.
+    /// @param reason The reason the payout reverted.
+    /// @param caller The address that called the payout function.
     event PayoutReverted(uint256 indexed projectId, JBSplit split, uint256 amount, bytes reason, address caller);
 
+    /// @notice A payout was sent to a split.
+    /// @param projectId The ID of the project that the payout was made from.
+    /// @param rulesetId The ID of the ruleset the split belongs to.
+    /// @param group The group the split belongs to.
+    /// @param split The split that was paid.
+    /// @param amount The amount that was sent to the split.
+    /// @param netAmount The amount that the split recipient actually received, after fees.
+    /// @param caller The address that called the payout function.
     event SendPayoutToSplit(
         uint256 indexed projectId,
         uint256 indexed rulesetId,

package/src/periphery/JBMatchingPriceFeed.sol

@@ -8,7 +8,9 @@ import {IJBPriceFeed} from "../interfaces/IJBPriceFeed.sol";
 contract JBMatchingPriceFeed is IJBPriceFeed {
     constructor() {}
 
-    /// @inheritdoc IJBPriceFeed
+    /// @notice Gets the current price (per 1 unit) from the feed.
+    /// @param decimals The number of decimals the return value should use.
+    /// @return The current unit price from the feed, as a fixed point number with the specified number of decimals.
     function currentUnitPrice(uint256 decimals) public view virtual override returns (uint256) {
         return 10 ** decimals;
     }

package/src/structs/JBAccountingContext.sol

@@ -1,8 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-/// @notice Describes how a terminal accounts for a specific token — its address, decimal precision, and which
-/// currency
+/// @notice Describes how a terminal accounts for a specific token — its address, decimal precision, and the currency
 /// it's priced in. Used when recording payments, payouts, and cash outs to ensure correct fixed-point arithmetic.
 /// @custom:member token The token address (use `JBConstants.NATIVE_TOKEN` for ETH).
 /// @custom:member decimals The number of decimals for this token's fixed-point amounts (e.g. 18 for ETH, 6 for USDC).

package/src/structs/JBAfterCashOutRecordedContext.sol

@@ -9,8 +9,7 @@ import {JBTokenAmount} from "./JBTokenAmount.sol";
 /// @custom:member cashOutCount The number of project tokens to cash out.
 /// @custom:member cashOutTaxRate The current ruleset's cash out tax rate, out of
 /// `JBConstants.MAX_CASH_OUT_TAX_RATE`.
-/// @custom:member reclaimedAmount The token amount reclaimed from the project's terminal balance. Includes the
-/// token
+/// @custom:member reclaimedAmount The token amount reclaimed from the project's terminal balance. Includes the token
 /// reclaimed, the value, the number of decimals included, and the currency of the amount.
 /// @custom:member forwardedAmount The token amount forwarded to the cash out hook. Includes the token
 /// forwarded, the value, the number of decimals included, and the currency of the amount.

package/src/structs/JBCashOutHookSpecification.sol

@@ -3,8 +3,7 @@ pragma solidity ^0.8.0;
 
 import {IJBCashOutHook} from "../interfaces/IJBCashOutHook.sol";
 
-/// @notice A cash out hook specification sent from the ruleset's data hook back to the terminal. This specification is
-/// fulfilled by the terminal.
+/// @notice A cash out hook specification sent from the ruleset's data hook back to the terminal for fulfillment.
 /// @custom:member hook The cash out hook to use when fulfilling this specification.
 /// @custom:member noop A flag indicating if the hook callback should be skipped.
 /// @custom:member amount The amount to send to the hook.

package/src/structs/JBPayHookSpecification.sol

@@ -3,8 +3,7 @@ pragma solidity ^0.8.0;
 
 import {IJBPayHook} from "../interfaces/IJBPayHook.sol";
 
-/// @notice A pay hook specification sent from the ruleset's data hook back to the terminal. This specification is
-/// fulfilled by the terminal.
+/// @notice A pay hook specification sent from the ruleset's data hook back to the terminal for fulfillment.
 /// @custom:member hook The pay hook to use when fulfilling this specification.
 /// @custom:member noop A flag indicating if the hook callback should be skipped.
 /// @custom:member amount The amount to send to the hook.

package/src/structs/JBSplit.sol

@@ -15,8 +15,7 @@ import {IJBSplitHook} from "./../interfaces/IJBSplitHook.sol";
 /// `beneficiary`.
 /// @custom:member percent The percent of the total token amount that this split sends. This number is out of
 /// `JBConstants.SPLITS_TOTAL_PERCENT`.
-/// @custom:member projectId The ID of a project to `pay`, if applicable. Resulting tokens will be routed to the
-/// `beneficiary`.
+/// @custom:member projectId The ID of a project to `pay`, if applicable. Resulting tokens are routed to `beneficiary`.
 /// @custom:member beneficiary Receives this split's tokens if the `hook` and `projectId` are zero. If the `projectId`
 /// is specified, the `beneficiary` receives any project tokens minted by this split. If `beneficiary` is `address(0)`,
 /// the application processing the split decides on the recipient. For example, the terminal uses `msg.sender` for