@bananapus/core-v6 0.0.39 → 0.0.41

package/package.json

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

package/src/JBChainlinkV3SequencerPriceFeed.sol

@@ -8,7 +8,7 @@ import {JBChainlinkV3PriceFeed} from "./JBChainlinkV3PriceFeed.sol";
 
 /// @notice Extends `JBChainlinkV3PriceFeed` with L2 sequencer uptime checks (for Optimism, Arbitrum, etc.). Reverts if
 /// the sequencer is down or has not been back online for at least `GRACE_PERIOD_TIME` seconds — preventing stale
-/// prices from being used immediately after an outage.
+/// prices from to use immediately after an outage.
 contract JBChainlinkV3SequencerPriceFeed is JBChainlinkV3PriceFeed {
     //*********************************************************************//
     // --------------------------- custom errors ------------------------- //

package/src/JBController.sol

@@ -176,7 +176,7 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
     /// ruleset must have `allowAddPriceFeed` enabled.
     /// @param projectId The ID of the project to add the feed for.
     /// @param pricingCurrency The currency the feed's output price is in terms of.
-    /// @param unitCurrency The currency being priced by the feed.
+    /// @param unitCurrency The currency the feed prices.
     /// @param feed The address of the price feed to add.
     function addPriceFeedFor(
         uint256 projectId,
@@ -204,7 +204,7 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
 
     /// @notice Called after this controller has been set as the project's controller in the directory.
     /// @dev Can only be called by the directory.
-    /// @param from The controller being migrated from.
+    /// @param from The controller to migrate from.
     /// @param projectId The ID of the project that migrated to this controller.
     function afterReceiveMigrationFrom(IERC165 from, uint256 projectId) external view override {
         from; // Suppress unused variable warning.
@@ -214,9 +214,9 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
         if (_msgSender() != address(DIRECTORY)) revert JBController_OnlyDirectory(_msgSender(), DIRECTORY);
     }
 
-    /// @notice Prepares this controller to receive a project being migrated from another controller.
+    /// @notice Prepares this controller to receive a project to migrate from another controller.
     /// @dev This controller should not be the project's controller yet.
-    /// @param from The controller being migrated from.
+    /// @param from The controller to migrate from.
     /// @param projectId The ID of the project that will migrate to this controller.
     function beforeReceiveMigrationFrom(IERC165 from, uint256 projectId) external override {
         // Keep a reference to the sender.
@@ -243,8 +243,8 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
     /// @notice Burns a holder's project tokens (or credits), permanently removing them from supply. Used by terminals
     /// during cash outs, or directly by holders who want to burn voluntarily.
     /// @dev Can only be called by the holder, an operator with `BURN_TOKENS` permission, or a project terminal.
-    /// @param holder The address whose tokens are being burned.
-    /// @param projectId The ID of the project whose tokens are being burned.
+    /// @param holder The address to burn tokens for.
+    /// @param projectId The ID of the project to burn tokens for.
     /// @param tokenCount The number of tokens to burn.
     /// @param memo A memo to pass along to the emitted event.
     function burnTokensOf(
@@ -279,7 +279,7 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
     /// wallet. Credits and ERC-20 tokens are interchangeable — this just makes them transferable/tradeable.
     /// @dev Can only be called by the credit holder or an operator with `CLAIM_TOKENS` permission.
     /// @param holder The address to redeem credits from.
-    /// @param projectId The ID of the project whose tokens are being claimed.
+    /// @param projectId The ID of the project to claim tokens for.
     /// @param tokenCount The number of tokens to claim.
     /// @param beneficiary The account the claimed tokens will go to.
     function claimTokensFor(
@@ -338,9 +338,9 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
     /// terminal.
     /// @dev Can only be called by this controller.
     /// @param terminal The terminal to pay.
-    /// @param projectId The ID of the project being paid.
-    /// @param token The token being paid with.
-    /// @param splitTokenCount The number of tokens being paid.
+    /// @param projectId The ID of the project to pay.
+    /// @param token The token to pay with.
+    /// @param splitTokenCount The number of tokens to pay.
     /// @param beneficiary The payment's beneficiary.
     /// @param metadata The pay metadata sent to the terminal.
     function executePayReservedTokenToTerminal(
@@ -521,7 +521,7 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
     /// reserved percent (which accumulates until `sendReservedTokensToSplitsOf` is called).
     /// @dev Can be called by the project owner, an operator with `MINT_TOKENS` permission, a project terminal, or the
     /// data hook. If `allowOwnerMinting` is false in the current ruleset, only terminals and the data hook can mint.
-    /// @param projectId The ID of the project whose tokens are being minted.
+    /// @param projectId The ID of the project to mint tokens for.
     /// @param tokenCount The number of tokens to mint, including any reserved tokens.
     /// @param beneficiary The address which will receive the (non-reserved) tokens.
     /// @param memo A memo to pass along to the emitted event.
@@ -694,7 +694,7 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
     /// @notice Sets the name and symbol of a project's token.
     /// @dev Can only be called by the project's owner or an address with the owner's permission to
     /// `SET_TOKEN_METADATA`.
-    /// @param projectId The ID of the project whose token is being updated.
+    /// @param projectId The ID of the project to update the token for.
     /// @param name The new name.
     /// @param symbol The new symbol.
     function setTokenMetadataOf(uint256 projectId, string calldata name, string calldata symbol) external override {
@@ -729,7 +729,7 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
     /// @dev Can only be called by the credit holder or an operator with `TRANSFER_CREDITS` permission. The current
     /// ruleset must not have credit transfers paused.
     /// @param holder The address to transfer credits from.
-    /// @param projectId The ID of the project whose credits are being transferred.
+    /// @param projectId The ID of the project to transfer credits for.
     /// @param recipient The address to transfer credits to.
     /// @param creditCount The number of credits to transfer.
     function transferCreditsFrom(
@@ -844,7 +844,7 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
     }
 
     /// @notice Previews how many beneficiary and reserved tokens `mintTokensOf(...)` would produce.
-    /// @param projectId The ID of the project whose tokens are being minted.
+    /// @param projectId The ID of the project to mint tokens for.
     /// @param tokenCount The number of tokens to mint, including any reserved tokens.
     /// @param useReservedPercent Whether to apply the ruleset's reserved percent.
     /// @return beneficiaryTokenCount The number of tokens that would be minted for the beneficiary.
@@ -960,7 +960,7 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
 
     /// @notice Queues one or more rulesets and stores information pertinent to the configuration.
     /// @param projectId The ID of the project to queue rulesets for.
-    /// @param rulesetConfigurations The rulesets being queued.
+    /// @param rulesetConfigurations The rulesets to queue.
     /// @return rulesetId The ID of the last ruleset that was successfully queued.
     function _queueRulesets(
         uint256 projectId,
@@ -1238,7 +1238,7 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
 
     /// @notice Splits a token count into beneficiary and reserved portions.
     /// @param tokenCount The total token count, including reserved tokens.
-    /// @param reservedPercent The reserved percent to apply.
+    /// @param reservedPercent The reserved percent to apply, out of `JBConstants.MAX_RESERVED_PERCENT`.
     /// @return beneficiaryTokenCount The number of tokens for the beneficiary.
     /// @return reservedTokenCount The number of tokens to reserve.
     function _splitTokenCount(

package/src/JBDirectory.sol

@@ -93,7 +93,7 @@ contract JBDirectory is JBPermissioned, Ownable, IJBDirectory {
     /// `SET_CONTROLLER` permission.
     /// - OR the caller is the project's current controller.
     /// - OR the caller `isAllowedToSetFirstController` and the project has no controller yet.
-    /// @param projectId The ID of the project whose controller is being set.
+    /// @param projectId The ID of the project to set the controller for.
     /// @param controller The address of the controller to set.
     function setControllerOf(uint256 projectId, IERC165 controller) external override {
         // Keep a reference to the current controller.
@@ -172,9 +172,9 @@ contract JBDirectory is JBPermissioned, Ownable, IJBDirectory {
     /// @dev Can only be called by the project's owner or an address with `SET_PRIMARY_TERMINAL` permission. The
     /// terminal must accept the token for this project. If the terminal isn't already in the project's terminal list,
     /// it will be added automatically (requires `ADD_TERMINALS` permission).
-    /// @param projectId The ID of the project whose primary terminal is being set.
+    /// @param projectId The ID of the project to set the primary terminal for.
     /// @param token The token to set the primary terminal for.
-    /// @param terminal The terminal being set as the primary terminal.
+    /// @param terminal The terminal to set as the primary terminal.
     function setPrimaryTerminalOf(uint256 projectId, address token, IJBTerminal terminal) external override {
         // Enforce permissions.
         _requirePermissionFrom({
@@ -209,7 +209,7 @@ contract JBDirectory is JBPermissioned, Ownable, IJBDirectory {
     /// cash outs for a project. This overwrites the existing list.
     /// @dev Can only be called by the project's owner, an address with `SET_TERMINALS` permission, or the project's
     /// controller. Unless the caller is the controller, the ruleset must have `allowSetTerminals` enabled.
-    /// @param projectId The ID of the project whose terminals are being set.
+    /// @param projectId The ID of the project to set terminals for.
     /// @param terminals An array of terminal addresses to set for the project.
     function setTerminalsOf(uint256 projectId, IJBTerminal[] calldata terminals) external override {
         // Cache the controller to avoid redundant storage reads.

package/src/JBERC20.sol

@@ -127,7 +127,7 @@ contract JBERC20 is ERC20Votes, ERC20Permit, JBPermissioned, IERC1271, IJBToken
     /// @notice Validates a signature on behalf of this token contract (ERC-1271).
     /// @dev Allows the project owner or an operator with `SIGN_FOR_ERC20` permission to sign messages on behalf of
     /// this token. Useful for Etherscan contract verification and other off-chain signature flows.
-    /// @param hash The hash of the data being signed.
+    /// @param hash The hash of the data to sign.
     /// @param signature The signature to validate.
     /// @return magicValue `0x1626ba7e` if the signature is valid, `0xffffffff` otherwise.
     function isValidSignature(bytes32 hash, bytes memory signature) external view override returns (bytes4 magicValue) {
@@ -170,17 +170,17 @@ contract JBERC20 is ERC20Votes, ERC20Permit, JBPermissioned, IERC1271, IJBToken
         return super.decimals();
     }
 
-    /// @notice The token's name.
+    /// @notice The token's name, set during initialization.
     function name() public view virtual override returns (string memory) {
         return _name;
     }
 
-    /// @notice Required override.
+    /// @notice The current nonce for a given account, used for permit signatures.
     function nonces(address owner) public view virtual override(ERC20Permit, Nonces) returns (uint256) {
         return super.nonces(owner);
     }
 
-    /// @notice The token's symbol.
+    /// @notice The token's ticker symbol, set during initialization.
     function symbol() public view virtual override returns (string memory) {
         return _symbol;
     }
@@ -195,7 +195,7 @@ contract JBERC20 is ERC20Votes, ERC20Permit, JBPermissioned, IERC1271, IJBToken
     // ----------------------- public transactions ----------------------- //
     //*********************************************************************//
 
-    /// @notice Initializes the token.
+    /// @notice Initialize a new project token with the given name, symbol, and owner.
     /// @param name_ The token's name.
     /// @param symbol_ The token's symbol.
     /// @param tokens The JBTokens contract that manages this token.

package/src/JBFundAccessLimits.sol

@@ -70,7 +70,7 @@ contract JBFundAccessLimits is JBControlled, IJBFundAccessLimits {
     /// surplus. Both reset each funding cycle.
     /// @dev Only a project's controller can set fund access limits (called during `queueRulesetsOf`).
     /// @dev Limits within each group must be sorted by currency in strictly increasing order to prevent duplicates.
-    /// @param projectId The ID of the project whose fund access limits are being set.
+    /// @param projectId The ID of the project to set fund access limits for.
     /// @param rulesetId The ID of the ruleset that the limits will apply within.
     /// @param fundAccessLimitGroups An array containing payout limits and surplus allowances for each payment terminal.
     /// Amounts are fixed point numbers using the same number of decimals as the associated terminal.
@@ -159,7 +159,7 @@ contract JBFundAccessLimits is JBControlled, IJBFundAccessLimits {
 
     /// @notice Look up how much a project can distribute (via `sendPayoutsOf`) from a specific terminal and token,
     /// denominated in a specific currency. Returns 0 if no limit is configured for that currency.
-    /// @dev The fixed point return amount uses the same number of decimals as the terminal.
+    /// @dev The fixed point return amount uses the same number of decimals as the token's accounting context.
     /// @param projectId The project's ID.
     /// @param rulesetId The ruleset's ID.
     /// @param terminal The terminal the payout limit applies to.
@@ -203,7 +203,7 @@ contract JBFundAccessLimits is JBControlled, IJBFundAccessLimits {
 
     /// @notice Get all payout limits for a project's terminal and token during a ruleset. A project can have multiple
     /// payout limits denominated in different currencies (e.g. 10,000 USD + 5 ETH). Each is enforced independently.
-    /// @dev The fixed point `amount`s returned use the same number of decimals as the terminal.
+    /// @dev The fixed point `amount`s returned use the same number of decimals as the token's accounting context.
     /// @param projectId The project's ID.
     /// @param rulesetId The ruleset's ID.
     /// @param terminal The terminal the payout limits apply to.
@@ -250,7 +250,7 @@ contract JBFundAccessLimits is JBControlled, IJBFundAccessLimits {
 
     /// @notice Look up how much a project's owner can withdraw from the surplus (via `useAllowanceOf`) from a specific
     /// terminal and token, denominated in a specific currency. Returns 0 if no allowance is configured.
-    /// @dev The fixed point return amount uses the same number of decimals as the terminal.
+    /// @dev The fixed point return amount uses the same number of decimals as the token's accounting context.
     /// @param projectId The project's ID.
     /// @param rulesetId The ruleset's ID.
     /// @param terminal The terminal the surplus allowance applies to.
@@ -295,7 +295,7 @@ contract JBFundAccessLimits is JBControlled, IJBFundAccessLimits {
 
     /// @notice Get all surplus allowances for a project's terminal and token during a ruleset. Like payout limits, a
     /// project can have multiple surplus allowances in different currencies, each enforced independently.
-    /// @dev The fixed point `amount`s returned use the same number of decimals as the terminal.
+    /// @dev The fixed point `amount`s returned use the same number of decimals as the token's accounting context.
     /// @param projectId The project's ID.
     /// @param rulesetId The ruleset's ID.
     /// @param terminal The terminal the surplus allowances apply to.