@bananapus/core-v6 0.0.80 → 0.0.82

package/README.md

@@ -36,7 +36,7 @@ Use this repo when you need the protocol's canonical accounting and execution lo
 
 If you only read one V6 repo before reading the rest, read this one.
 
-## Mental Model
+## Mental model
 
 It helps to think about core in four layers:
 
@@ -54,7 +54,7 @@ The shortest reading path is:
 3. `JBTerminalStore` for the accounting model
 4. `JBDirectory` and `JBPermissions` for routing and authority
 
-## Read These Files First
+## Read these files first
 
 1. `src/JBController.sol`
 2. `src/JBMultiTerminal.sol`
@@ -63,7 +63,7 @@ The shortest reading path is:
 5. `src/JBRulesets.sol`
 6. `src/JBPermissions.sol`
 
-## Key Contracts
+## Key contracts
 
 | Contract | Role |
 | --- | --- |
@@ -75,26 +75,24 @@ The shortest reading path is:
 | `JBPermissions` | Packed operator-permission registry. |
 | `JBPrices` | Price-feed routing used by terminals and integrations. |
 
-## Integration Traps
+## Integration traps
 
 - `JBMultiTerminal` is multi-token and multi-terminal. Do not assume one token or one balance.
 - Data hooks and cash-out hooks can change economics and side effects. They are part of the protocol surface.
 - Permission checks are not always against the project owner. Some flows are scoped to the token holder instead.
 - Preview and execution are intentionally close, but callers should still treat them as separate surfaces when hooks or routing can change behavior.
-- Fee-bearing cash-out, payout, and allowance calls can carry a referral project ID. This credits fee volume; it does not redirect the fee itself.
 
-## Where State Lives
+## Where state lives
 
 - project identity and ownership: `JBProjects`
 - controller and terminal routing: `JBDirectory`
 - ruleset history and activation: `JBRulesets`
 - balances, surplus, fees, and reclaim accounting: `JBTerminalStore`
-- referral fee-volume accounting: `JBTerminalStore`
 - operator authority: `JBPermissions`
 
 When a flow is unclear, read the contract that owns the state before the contract that forwards into it.
 
-## High-Signal Tests
+## High-signal tests
 
 1. `test/TestPayBurnRedeemFlow.sol`
 2. `test/TestTerminalPreviewParity.sol`
@@ -124,11 +122,11 @@ Useful scripts:
 - `npm run deploy:mainnets:periphery`
 - `npm run deploy:testnets:periphery`
 
-## Deployment Notes
+## Deployment notes
 
 This repo contains the main core deployments and periphery deployment helpers. Most other V6 packages assume these contracts exist first and treat them as the stable base layer.
 
-## Repository Layout
+## Repository layout
 
 ```text
 src/
@@ -141,7 +139,7 @@ script/
   helpers/
 ```
 
-## Risks And Notes
+## Risks and notes
 
 See [RISKS.md](./RISKS.md) for the full risk register. In short:
 
@@ -152,7 +150,7 @@ See [RISKS.md](./RISKS.md) for the full risk register. In short:
 
 The easiest way to misread V6 is to treat core like a simple crowdfunding terminal. It is closer to a configurable accounting and settlement layer.
 
-## For AI Agents
+## For AI agents
 
 - Start with `JBController`, `JBMultiTerminal`, and `JBTerminalStore`.
 - Keep controller configuration, terminal execution, and store accounting separate in your mental model.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bananapus/core-v6",
-  "version": "0.0.80",
+  "version": "0.0.82",
   "license": "MIT",
   "repository": {
     "type": "git",

package/references/entrypoints.md

@@ -28,7 +28,7 @@ The core Juicebox V6 protocol on EVM: a modular system for launching treasury-ba
 | `JBDeadline` | Approval hook: rejects rulesets queued within `DURATION` seconds of start. Ships as `JBDeadline3Hours`, `JBDeadline1Day`, `JBDeadline3Days`, `JBDeadline7Days`. |
 | `JBMatchingPriceFeed` | Always returns 1:1. For equivalent currencies (e.g. ETH/NATIVE_TOKEN). |
 
-## Key Functions
+## Key functions
 
 ### JBController
 
@@ -61,9 +61,9 @@ The core Juicebox V6 protocol on EVM: a modular system for launching treasury-ba
 | Function | What it does |
 |----------|--------------|
 | `pay(uint256 projectId, address token, uint256 amount, address beneficiary, uint256 minReturnedTokens, string memo, bytes metadata)` | Pays a project. Mints project tokens to beneficiary based on ruleset weight. Returns token count. |
-| `cashOutTokensOf(address holder, uint256 projectId, uint256 cashOutCount, address tokenToReclaim, uint256 minTokensReclaimed, address payable beneficiary, bytes metadata, uint256 referralProjectId)` | Burns project tokens and reclaims surplus terminal tokens via bonding curve. Optional referral credits protocol fee volume. |
-| `sendPayoutsOf(uint256 projectId, address token, uint256 amount, uint256 currency, uint256 minTokensPaidOut, uint256 referralProjectId)` | Distributes payouts from the project's balance to its payout split group, up to the payout limit. Optional referral credits protocol fee volume. |
-| `useAllowanceOf(uint256 projectId, address token, uint256 amount, uint256 currency, uint256 minTokensPaidOut, address payable beneficiary, address payable feeBeneficiary, string memo, uint256 referralProjectId)` | Withdraws from the project's surplus allowance to a beneficiary. The `feeBeneficiary` receives tokens minted by the fee payment. Optional referral credits protocol fee volume. |
+| `cashOutTokensOf(address holder, uint256 projectId, uint256 cashOutCount, address tokenToReclaim, uint256 minTokensReclaimed, address payable beneficiary, bytes metadata)` | Burns project tokens and reclaims surplus terminal tokens via bonding curve. |
+| `sendPayoutsOf(uint256 projectId, address token, uint256 amount, uint256 currency, uint256 minTokensPaidOut)` | Distributes payouts from the project's balance to its payout split group, up to the payout limit. |
+| `useAllowanceOf(uint256 projectId, address token, uint256 amount, uint256 currency, uint256 minTokensPaidOut, address payable beneficiary, address payable feeBeneficiary, string memo)` | Withdraws from the project's surplus allowance to a beneficiary. The `feeBeneficiary` receives tokens minted by the fee payment. |
 | `addToBalanceOf(uint256 projectId, address token, uint256 amount, bool shouldReturnHeldFees, string memo, bytes metadata)` | Adds funds to a project's balance without minting tokens. Can unlock held fees. |
 | `migrateBalanceOf(uint256 projectId, address token, IJBTerminal to)` | Migrates a project's token balance to another terminal. Requires `allowTerminalMigration`. |
 | `processHeldFeesOf(uint256 projectId, address token, uint256 count)` | Processes up to `count` held fees for a project, sending them to the fee beneficiary project. |
@@ -74,7 +74,6 @@ The core Juicebox V6 protocol on EVM: a modular system for launching treasury-ba
 | `previewPayFor(uint256 projectId, address token, uint256 amount, address beneficiary, bytes metadata)` | Simulates a full payment including the reserved/beneficiary token split. Returns `(ruleset, beneficiaryTokenCount, reservedTokenCount, hookSpecifications)`. Composes `STORE.previewPayFrom` + `controller.previewMintOf`. |
 | `previewCashOutFrom(address holder, uint256 projectId, uint256 cashOutCount, address tokenToReclaim, address payable beneficiary, bytes metadata)` | Simulates a full cash out including bonding curve and data hook effects. Cash-out data hooks may alter pricing inputs, but not the caller-supplied burn count. Returns `(ruleset, reclaimAmount, cashOutTaxRate, hookSpecifications)`. Delegates to `STORE.previewCashOutFrom`. |
 | `heldFeesOf(uint256 projectId, address token, uint256 count)` | Returns up to `count` held fees for a project/token. |
-| `currentReferralProjectId()` | Returns the in-flight packed referral `(chainId << 48) | projectId`, or 0 outside a fee-bearing call. |
 
 ### JBTerminalStore
 
@@ -94,11 +93,8 @@ The core Juicebox V6 protocol on EVM: a modular system for launching treasury-ba
 | `currentTotalReclaimableSurplusOf(uint256 projectId, uint256 cashOutCount, uint256 decimals, uint256 currency)` | Convenience view: reclaimable surplus across all terminals and all tokens. |
 | `currentSurplusOf(uint256 projectId, IJBTerminal[] terminals, address[] tokens, uint256 decimals, uint256 currency)` | Returns the current surplus across specified terminals and tokens. Empty arrays default to all. |
 | `currentTotalSurplusOf(uint256 projectId, uint256 decimals, uint256 currency)` | Convenience view: total surplus across all terminals and all tokens. |
-| `feeVolumeByReferralOf(address terminal, uint256 referralChainId, uint256 referralProjectId)` | Returns cumulative protocol fee volume credited to a referrer through a terminal. |
 | `previewPayFrom(address terminal, address payer, JBTokenAmount amount, uint256 projectId, address beneficiary, bytes metadata)` | Simulates a payment without modifying state. Uses the explicit `terminal` parameter for balance/surplus lookups. Invokes data hooks if configured. Returns ruleset, token count, and hook specifications. |
 | `previewCashOutFrom(address terminal, address holder, uint256 projectId, uint256 cashOutCount, address tokenToReclaim, bool beneficiaryIsFeeless, bytes metadata)` | Simulates a cash out without modifying state. Uses the explicit `terminal` parameter for balance/surplus lookups. Invokes data hooks if configured, including any pricing-only adjustments they return. Returns ruleset, reclaim amount, tax rate, and hook specifications. |
-| `recordFeeReferralCreditOf(uint256 referralProjectId, JBTokenAmount amount)` | Credits normalized fee volume to a packed referral project for the calling terminal. No-ops for zero referral, zero amount, or missing price feed. |
-| `totalFeeVolumeOf(address terminal)` | Returns total referral-creditable fee volume recorded for a terminal. |
 
 ### JBRulesets
 

package/references/types-errors-events.md

@@ -2,7 +2,7 @@
 
 Use this file when you need deeper protocol reference material after the repo-local `SKILLS.md` has already routed you to `nana-core-v6`.
 
-## Key Types
+## Key types
 
 | Struct/Enum | Key Fields | Used In |
 |-------------|------------|---------|
@@ -17,13 +17,13 @@ Use this file when you need deeper protocol reference material after the repo-lo
 | `JBCurrencyAmount` | `amount (uint224)`, `currency (uint32)` | Payout limits and surplus allowances |
 | `JBFundAccessLimitGroup` | `terminal (address)`, `token (address)`, `payoutLimits (JBCurrencyAmount[])`, `surplusAllowances (JBCurrencyAmount[])` | `JBRulesetConfig.fundAccessLimitGroups` |
 | `JBPermissionsData` | `operator (address)`, `projectId (uint64)`, `permissionIds (uint8[])` | `setPermissionsFor()` input |
-| `JBFee` | `amount (uint224)`, `referralChainId (uint32)`, `beneficiary (address)`, `unlockTimestamp (uint48)`, `referralProjectId (uint48)` | Held fees in `JBMultiTerminal`; referral fields preserve fee attribution until processing |
+| `JBFee` | `amount (uint224)`, `beneficiary (address)`, `unlockTimestamp (uint48)` | Held fees in `JBMultiTerminal` |
 | `JBSingleAllowance` | `sigDeadline (uint256)`, `amount (uint160)`, `expiration (uint48)`, `nonce (uint48)`, `signature (bytes)` | Permit2 allowance in terminal payments |
 | `JBRulesetWithMetadata` | `ruleset (JBRuleset)`, `metadata (JBRulesetMetadata)` | `allRulesetsOf()`, `currentRulesetOf()` return values |
 | `JBRulesetWeightCache` | `weight (uint112)`, `weightCutMultiple (uint168)` | Weight caching for long-running rulesets in `JBRulesets` |
 | `JBApprovalStatus` (enum) | `Empty`, `Upcoming`, `Active`, `ApprovalExpected`, `Approved`, `Failed` | Approval hook status for queued rulesets |
 
-### Hook Structs
+### Hook structs
 
 | Struct | Key Fields | Used In |
 |--------|------------|---------|
@@ -53,13 +53,13 @@ Use this file when you need deeper protocol reference material after the repo-lo
 | `1` | ETH |
 | `2` | USD |
 
-### Split Group IDs (`JBSplitGroupIds`)
+### Split group IDs (`JBSplitGroupIds`)
 
 | ID | Group |
 |----|-------|
 | `1` | `RESERVED_TOKENS` -- reserved token distribution |
 
-### Special Values
+### Special values
 
 | Value | Context | Meaning |
 |-------|---------|---------|
@@ -93,8 +93,7 @@ Use this file when you need deeper protocol reference material after the repo-lo
 - `JBProjects` constructor optionally mints project #1 to `feeProjectOwner` -- if `address(0)`, no fee project is created
 - `JBMultiTerminal` derives `DIRECTORY` from the provided `store` in its constructor -- not passed directly
 - `JBPrices.pricePerUnitOf()` checks project direct feeds, project inverse feeds, default direct feeds, then default inverse feeds. It skips feeds that revert or return zero.
-- `useAllowanceOf()` takes 9 args including `address payable feeBeneficiary` and `uint256 referralProjectId` -- do NOT omit them
-- `sendPayoutsOf()` and `cashOutTokensOf()` also take `uint256 referralProjectId`; pass `0` for no referral credit
+- `useAllowanceOf()` takes 8 args including `address payable feeBeneficiary` -- do NOT omit it
 - `JBFeelessAddresses.isFeelessFor()` takes 3 args: `(addr, projectId, caller)`. The optional hook can use `caller` to scope dynamic grants.
 - Cash out tax rate of 0% = proportional (1:1) redemption; 100% = nothing reclaimable (all surplus locked). Do NOT confuse with a "cash out rate" where 100% means full redemption.
 - `cashOutTaxRate` in `JBRulesetMetadata` is `uint16` (max 10,000 basis points), NOT 9-decimal precision
@@ -144,7 +143,7 @@ Quick-reference for the most common `JBPermissionIds` values (from `@bananapus/p
 
 IDs 22-33 are used by extension contracts (721 hook, buyback hook, router terminal, suckers).
 
-## Common Errors
+## Common errors
 
 Errors an agent is most likely to encounter. All are custom errors (revert with selector).
 
@@ -188,7 +187,7 @@ Errors an agent is most likely to encounter. All are custom errors (revert with
 | `JBRulesets_InvalidWeightCutPercent` | `JBRulesets` | `weightCutPercent` exceeds `MAX_WEIGHT_CUT_PERCENT`. |
 | `JBFundAccessLimits_InvalidPayoutLimitCurrencyOrdering` | `JBFundAccessLimits` | Payout limit currencies not in strictly increasing order. |
 
-## Key Events
+## Key events
 
 The most important events for indexing and off-chain monitoring. Indexed params marked with `*`.
 
@@ -214,7 +213,6 @@ The most important events for indexing and off-chain monitoring. Indexed params
 | `ProcessFee` | `IJBFeeTerminal` | `projectId*`, `token*`, `amount*`, `wasHeld`, `beneficiary` |
 | `ReturnHeldFees` | `IJBFeeTerminal` | `projectId*`, `token*`, `amount*`, `returnedFees`, `leftoverAmount` |
 | `FeeReverted` | `IJBFeeTerminal` | `projectId*`, `token*`, `feeProjectId*`, `amount`, `reason` |
-| `ReferralCredit` | `IJBTerminalStore` | `terminal*`, `referralChainId*`, `referralProjectId*`, `amount`, `newTotal` |
 | `Create` | `IJBProjects` | `projectId*`, `owner*` |
 | `SetTokenMetadata` | `IJBTokens` | `projectId*`, `name`, `symbol` |
 | `OperatorPermissionsSet` | `IJBPermissions` | (operator, account, projectId, permissionIds, packed, caller) |
@@ -222,7 +220,7 @@ The most important events for indexing and off-chain monitoring. Indexed params
 | `SetSplit` | `IJBSplits` | (projectId, rulesetId, groupId, split, caller) |
 | `AddPriceFeed` | `IJBPrices` | (projectId, pricingCurrency, unitCurrency, feed, caller) |
 
-## Hook Interface Return Types
+## Hook interface return types
 
 ### `IJBRulesetDataHook.beforePayRecordedWith()`
 
@@ -262,7 +260,7 @@ function hasMintPermissionFor(uint256 projectId, JBRuleset memory ruleset, addre
 
 Returns whether `addr` is allowed to mint tokens for the project. Called by `JBController.mintTokensOf` when the caller is not the owner and `allowOwnerMinting` is false -- the data hook can grant mint permission to specific addresses (e.g. suckers for omnichain bridging).
 
-## Example Integration
+## Example integration
 
 ```solidity
 // SPDX-License-Identifier: MIT

package/src/JBChainlinkV3PriceFeed.sol

@@ -17,8 +17,13 @@ contract JBChainlinkV3PriceFeed is IJBPriceFeed {
     // --------------------------- custom errors ------------------------- //
     //*********************************************************************//
 
+    /// @notice Thrown when the feed round is not finished or was not answered in the current round.
     error JBChainlinkV3PriceFeed_IncompleteRound(uint80 roundId, uint80 answeredInRound, uint256 updatedAt);
+
+    /// @notice Thrown when the feed reports a non-positive price.
     error JBChainlinkV3PriceFeed_NegativePrice(int256 price);
+
+    /// @notice Thrown when the feed's last update is older than the staleness threshold.
     error JBChainlinkV3PriceFeed_StalePrice(uint256 timestamp, uint256 threshold, uint256 updatedAt);
 
     //*********************************************************************//

package/src/JBChainlinkV3SequencerPriceFeed.sol

@@ -14,7 +14,10 @@ contract JBChainlinkV3SequencerPriceFeed is JBChainlinkV3PriceFeed {
     // --------------------------- custom errors ------------------------- //
     //*********************************************************************//
 
+    /// @notice Thrown when the sequencer uptime round is invalid (e.g. the uptime contract is not yet initialized).
     error JBChainlinkV3SequencerPriceFeed_InvalidRound(uint256 startedAt);
+
+    /// @notice Thrown when the L2 sequencer is down or has restarted too recently for the grace period to elapse.
     error JBChainlinkV3SequencerPriceFeed_SequencerDownOrRestarting(
         uint256 timestamp, uint256 gracePeriodTime, uint256 startedAt
     );

package/src/JBController.sol

@@ -58,21 +58,52 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
     // --------------------------- custom errors ------------------------- //
     //*********************************************************************//
 
+    /// @notice Thrown when the project's current ruleset does not allow adding price feeds.
     error JBController_AddingPriceFeedNotAllowed(uint256 projectId);
+
+    /// @notice Thrown when transferring credits while the current ruleset pauses credit transfers.
     error JBController_CreditTransfersPaused(uint256 projectId, uint256 rulesetId);
+
+    /// @notice Thrown when the cash out tax rate exceeds the allowed maximum.
     error JBController_InvalidCashOutTaxRate(uint256 rate, uint256 limit);
+
+    /// @notice Thrown when the native value sent does not equal the required creation fee.
     error JBController_InvalidCreationFee(uint256 value, uint256 requiredFee);
+
+    /// @notice Thrown when the reserved percent exceeds the allowed maximum.
     error JBController_InvalidReservedPercent(uint256 percent, uint256 limit);
+
+    /// @notice Thrown when the caller is not allowed to mint and is not a terminal or data hook for the project.
     error JBController_MintNotAllowedAndNotTerminalOrHook(address caller);
+
+    /// @notice Thrown when there are no reserved tokens to send to splits.
     error JBController_NoReservedTokens(uint256 projectId);
+
+    /// @notice Thrown when the caller is not the directory.
     error JBController_OnlyDirectory(address sender, IJBDirectory directory);
+
+    /// @notice Thrown when migrating a project that still has pending reserved tokens.
     error JBController_PendingReservedTokens(uint256 pendingReservedTokenBalance);
+
+    /// @notice Thrown when a reserved token split routes back into the same project via the terminal-payment path.
     error JBController_ReservedTokenSplitProjectSameAsOwner(uint256 projectId);
+
+    /// @notice Thrown when launching rulesets for a project that has already launched.
     error JBController_RulesetsAlreadyLaunched(uint256 projectId);
+
+    /// @notice Thrown when the ruleset configurations array is empty.
     error JBController_RulesetsArrayEmpty(uint256 projectId, uint256 rulesetConfigurationCount);
+
+    /// @notice Thrown when the project's current ruleset does not allow setting a custom token.
     error JBController_RulesetSetTokenNotAllowed(uint256 projectId);
+
+    /// @notice Thrown when the terminal did not pull the full token allowance during a payout.
     error JBController_TerminalTokensNotTransferred(address terminal, address token, uint256 allowance);
+
+    /// @notice Thrown when attempting to burn zero tokens.
     error JBController_ZeroTokensToBurn(uint256 projectId, address holder);
+
+    /// @notice Thrown when attempting to mint zero tokens.
     error JBController_ZeroTokensToMint(uint256 projectId, address beneficiary);
 
     //*********************************************************************//
@@ -707,7 +738,7 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
         // If there's no current ruleset, get a reference to the upcoming one.
         if (ruleset.id == 0) ruleset = _upcomingRulesetOf(projectId);
 
-        // If owner minting is disabled for the ruleset, the owner cannot change the token.
+        // If the ruleset doesn't allow setting a custom token, the owner cannot change the token.
         if (!ruleset.allowSetCustomToken()) revert JBController_RulesetSetTokenNotAllowed(projectId);
 
         TOKENS.setTokenFor({projectId: projectId, token: token});
@@ -783,8 +814,8 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
 
     /// @notice Returns a paginated history of a project's rulesets (with decoded metadata), sorted newest-first.
     /// @param projectId The ID of the project to get the rulesets of.
-    /// @param startingId The ID of the ruleset to begin with. This will be the latest ruleset in the result. If the
-    /// `startingId` is 0, passed, the project's latest ruleset will be used.
+    /// @param startingId The ID of the ruleset to begin with. This will be the latest ruleset in the result.
+    /// If 0 is passed, the project's latest ruleset will be used.
     /// @param size The maximum number of rulesets to return.
     /// @return rulesets The array of rulesets with their metadata.
     function allRulesetsOf(
@@ -1320,7 +1351,7 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
         return RULESETS.currentOf(projectId);
     }
 
-    /// @notice Indicates whether the provided address has mint permission for the project byway of the data hook.
+    /// @notice Indicates whether the provided address has mint permission for the project by way of the data hook.
     /// @param projectId The ID of the project to check.
     /// @param ruleset The ruleset to check.
     /// @param addr The address to check.

package/src/JBDirectory.sol

@@ -23,10 +23,19 @@ contract JBDirectory is JBPermissioned, Ownable, IJBDirectory {
     // --------------------------- custom errors ------------------------- //
     //*********************************************************************//
 
+    /// @notice Thrown when the same terminal appears more than once in the provided terminals list.
     error JBDirectory_DuplicateTerminals(IJBTerminal terminal);
+
+    /// @notice Thrown when the project ID is greater than the number of existing projects.
     error JBDirectory_InvalidProjectIdInDirectory(uint256 projectId, uint256 limit);
+
+    /// @notice Thrown when the project's current controller does not allow setting a new controller.
     error JBDirectory_SetControllerNotAllowed(uint256 projectId);
+
+    /// @notice Thrown when the project's current controller does not allow setting terminals.
     error JBDirectory_SetTerminalsNotAllowed(uint256 projectId);
+
+    /// @notice Thrown when the terminal being set as primary does not accept the given token.
     error JBDirectory_TokenNotAccepted(uint256 projectId, address token, IJBTerminal terminal);
 
     //*********************************************************************//

package/src/JBERC20.sol

@@ -25,7 +25,10 @@ contract JBERC20 is ERC20Votes, ERC20Permit, JBPermissioned, IERC1271, IJBToken
     // --------------------------- custom errors ------------------------- //
     //*********************************************************************//
 
+    /// @notice Thrown when initializing a token that already has a name set, or when the provided name is empty.
     error JBERC20_AlreadyInitialized(uint256 currentNameLength, uint256 newNameLength);
+
+    /// @notice Thrown when the caller is not the JBTokens contract that owns this token.
     error JBERC20_Unauthorized(address caller, address tokens);
 
     //*********************************************************************//

package/src/JBFeelessAddresses.sol

@@ -16,6 +16,7 @@ contract JBFeelessAddresses is Ownable, IJBFeelessAddresses, IERC165 {
     // --------------------------- custom errors ------------------------- //
     //*********************************************************************//
 
+    /// @notice Thrown when the provided feeless hook does not support the `IJBFeelessHook` interface.
     error JBFeelessAddresses_InvalidFeelessHook(IJBFeelessHook hook);
 
     //*********************************************************************//
@@ -33,6 +34,8 @@ contract JBFeelessAddresses is Ownable, IJBFeelessAddresses, IERC165 {
 
     /// @notice Raw feeless status per project per address.
     /// @dev `projectId = 0` stores the global (all-project) feeless status.
+    /// @custom:param projectId The ID of the project. A `projectId` of 0 is the global (all-project) key.
+    /// @custom:param addr The address whose feeless status is being stored.
     mapping(uint256 projectId => mapping(address addr => bool)) internal _isFeelessFor;
 
     //*********************************************************************//

package/src/JBFundAccessLimits.sol

@@ -18,12 +18,17 @@ contract JBFundAccessLimits is JBControlled, IJBFundAccessLimits {
     // --------------------------- custom errors ------------------------- //
     //*********************************************************************//
 
+    /// @notice Thrown when two fund access limit groups share the same terminal and token.
     error JBFundAccessLimits_DuplicateFundAccessLimitGroup(
         uint256 projectId, uint256 rulesetId, uint256 groupIndex, address terminal, address token
     );
+
+    /// @notice Thrown when payout limits within a group are not ordered by ascending currency.
     error JBFundAccessLimits_InvalidPayoutLimitCurrencyOrdering(
         uint256 projectId, uint256 rulesetId, uint256 groupIndex, uint256 limitIndex
     );
+
+    /// @notice Thrown when surplus allowances within a group are not ordered by ascending currency.
     error JBFundAccessLimits_InvalidSurplusAllowanceCurrencyOrdering(
         uint256 projectId, uint256 rulesetId, uint256 groupIndex, uint256 allowanceIndex
     );