@bananapus/core-v6 0.0.9 → 0.0.11

package/src/JBDirectory.sol

@@ -79,102 +79,10 @@ contract JBDirectory is JBPermissioned, Ownable, IJBDirectory {
         PROJECTS = projects;
     }
 
-    //*********************************************************************//
-    // ------------------------- external views -------------------------- //
-    //*********************************************************************//
-
-    /// @notice The primary terminal that a project uses for the specified token.
-    /// @dev Returns the first terminal that accepts the token if the project hasn't explicitly set a primary terminal
-    /// for it.
-    /// @dev Returns the zero address if no terminal accepts the token.
-    /// @param projectId The ID of the project to get the primary terminal of.
-    /// @param token The token that the terminal accepts.
-    /// @return The primary terminal's address.
-    function primaryTerminalOf(uint256 projectId, address token) external view override returns (IJBTerminal) {
-        // Keep a reference to the primary terminal for the provided project ID and token.
-        IJBTerminal primaryTerminal = _primaryTerminalOf[projectId][token];
-
-        // If a primary terminal for the token was explicitly set and it's one of the project's terminals, return it.
-        if (
-            primaryTerminal != IJBTerminal(address(0))
-                && isTerminalOf({projectId: projectId, terminal: primaryTerminal})
-        ) {
-            return primaryTerminal;
-        }
-
-        // Keep a reference to the project's terminals.
-        IJBTerminal[] memory terminals = _terminalsOf[projectId];
-
-        // Keep a reference to the number of terminals the project has.
-        uint256 numberOfTerminals = terminals.length;
-
-        // Return the first terminal which accepts the specified token.
-        for (uint256 i; i < numberOfTerminals; i++) {
-            // Keep a reference to the terminal being iterated on.
-            IJBTerminal terminal = terminals[i];
-
-            // If the terminal accepts the specified token, return it.
-            // slither-disable-next-line calls-loop
-            if (terminal.accountingContextForTokenOf({projectId: projectId, token: token}).token != address(0)) {
-                return terminal;
-            }
-        }
-
-        // Not found.
-        return IJBTerminal(address(0));
-    }
-
-    /// @notice The specified project's terminals.
-    /// @param projectId The ID of the project to get the terminals of.
-    /// @return An array of the project's terminal addresses.
-    function terminalsOf(uint256 projectId) external view override returns (IJBTerminal[] memory) {
-        return _terminalsOf[projectId];
-    }
-
-    //*********************************************************************//
-    // -------------------------- public views --------------------------- //
-    //*********************************************************************//
-
-    /// @notice Check if a project uses a specific terminal.
-    /// @param projectId The ID of the project to check.
-    /// @param terminal The terminal to check for.
-    /// @return A flag indicating whether the project uses the terminal.
-    function isTerminalOf(uint256 projectId, IJBTerminal terminal) public view override returns (bool) {
-        // Keep a reference to the project's terminals.
-        IJBTerminal[] memory terminals = _terminalsOf[projectId];
-
-        // Keep a reference to the number of terminals the project has.
-        uint256 numberOfTerminals = terminals.length;
-
-        // Loop through and return true if the terminal is found.
-        for (uint256 i; i < numberOfTerminals; i++) {
-            if (terminals[i] == terminal) return true;
-        }
-
-        // Otherwise, return false.
-        return false;
-    }
-
     //*********************************************************************//
     // ---------------------- external transactions ---------------------- //
     //*********************************************************************//
 
-    /// @notice Add or remove an address/contract from a list of trusted addresses which are allowed to set a first
-    /// controller for projects.
-    /// @dev Only this contract's owner can call this function.
-    /// @dev These addresses are vetted controllers as well as contracts designed to launch new projects.
-    /// @dev A project can set its own controller without being on this list.
-    /// @dev If you would like to add an address/contract to this list, please reach out to this contract's owner.
-    /// @param addr The address to allow or not allow.
-    /// @param flag Whether the address is allowed to set first controllers for projects. Use `true` to allow and
-    /// `false` to not allow.
-    function setIsAllowedToSetFirstController(address addr, bool flag) external override onlyOwner {
-        // Set the flag in the allowlist.
-        isAllowedToSetFirstController[addr] = flag;
-
-        emit SetIsAllowedToSetFirstController({addr: addr, isAllowed: flag, caller: msg.sender});
-    }
-
     /// @notice Set a project's controller. Controllers manage how terminals interact with tokens and rulesets.
     /// @dev Can only be called if:
     /// - The ruleset's metadata has `allowSetController` enabled, and the message's sender is the project's owner or an
@@ -240,6 +148,22 @@ contract JBDirectory is JBPermissioned, Ownable, IJBDirectory {
         }
     }
 
+    /// @notice Add or remove an address/contract from a list of trusted addresses which are allowed to set a first
+    /// controller for projects.
+    /// @dev Only this contract's owner can call this function.
+    /// @dev These addresses are vetted controllers as well as contracts designed to launch new projects.
+    /// @dev A project can set its own controller without being on this list.
+    /// @dev If you would like to add an address/contract to this list, please reach out to this contract's owner.
+    /// @param addr The address to allow or not allow.
+    /// @param flag Whether the address is allowed to set first controllers for projects. Use `true` to allow and
+    /// `false` to not allow.
+    function setIsAllowedToSetFirstController(address addr, bool flag) external override onlyOwner {
+        // Set the flag in the allowlist.
+        isAllowedToSetFirstController[addr] = flag;
+
+        emit SetIsAllowedToSetFirstController({addr: addr, isAllowed: flag, caller: msg.sender});
+    }
+
     /// @notice Set a project's primary terminal for a token.
     /// @dev The primary terminal for a token is where payments in that token are routed to by default.
     /// @dev This is useful in cases where a project has multiple terminals which accept the same token.
@@ -312,7 +236,83 @@ contract JBDirectory is JBPermissioned, Ownable, IJBDirectory {
     }
 
     //*********************************************************************//
-    // ------------------------ internal functions ----------------------- //
+    // ------------------------- external views -------------------------- //
+    //*********************************************************************//
+
+    /// @notice The primary terminal that a project uses for the specified token.
+    /// @dev Returns the first terminal that accepts the token if the project hasn't explicitly set a primary terminal
+    /// for it.
+    /// @dev Returns the zero address if no terminal accepts the token.
+    /// @param projectId The ID of the project to get the primary terminal of.
+    /// @param token The token that the terminal accepts.
+    /// @return The primary terminal's address.
+    function primaryTerminalOf(uint256 projectId, address token) external view override returns (IJBTerminal) {
+        // Keep a reference to the primary terminal for the provided project ID and token.
+        IJBTerminal primaryTerminal = _primaryTerminalOf[projectId][token];
+
+        // If a primary terminal for the token was explicitly set and it's one of the project's terminals, return it.
+        if (
+            primaryTerminal != IJBTerminal(address(0))
+                && isTerminalOf({projectId: projectId, terminal: primaryTerminal})
+        ) {
+            return primaryTerminal;
+        }
+
+        // Keep a reference to the project's terminals.
+        IJBTerminal[] memory terminals = _terminalsOf[projectId];
+
+        // Keep a reference to the number of terminals the project has.
+        uint256 numberOfTerminals = terminals.length;
+
+        // Return the first terminal which accepts the specified token.
+        for (uint256 i; i < numberOfTerminals; i++) {
+            // Keep a reference to the terminal being iterated on.
+            IJBTerminal terminal = terminals[i];
+
+            // If the terminal accepts the specified token, return it.
+            // slither-disable-next-line calls-loop
+            if (terminal.accountingContextForTokenOf({projectId: projectId, token: token}).token != address(0)) {
+                return terminal;
+            }
+        }
+
+        // Not found.
+        return IJBTerminal(address(0));
+    }
+
+    /// @notice The specified project's terminals.
+    /// @param projectId The ID of the project to get the terminals of.
+    /// @return An array of the project's terminal addresses.
+    function terminalsOf(uint256 projectId) external view override returns (IJBTerminal[] memory) {
+        return _terminalsOf[projectId];
+    }
+
+    //*********************************************************************//
+    // -------------------------- public views --------------------------- //
+    //*********************************************************************//
+
+    /// @notice Check if a project uses a specific terminal.
+    /// @param projectId The ID of the project to check.
+    /// @param terminal The terminal to check for.
+    /// @return A flag indicating whether the project uses the terminal.
+    function isTerminalOf(uint256 projectId, IJBTerminal terminal) public view override returns (bool) {
+        // Keep a reference to the project's terminals.
+        IJBTerminal[] memory terminals = _terminalsOf[projectId];
+
+        // Keep a reference to the number of terminals the project has.
+        uint256 numberOfTerminals = terminals.length;
+
+        // Loop through and return true if the terminal is found.
+        for (uint256 i; i < numberOfTerminals; i++) {
+            if (terminals[i] == terminal) return true;
+        }
+
+        // Otherwise, return false.
+        return false;
+    }
+
+    //*********************************************************************//
+    // ---------------------- internal transactions ---------------------- //
     //*********************************************************************//
 
     /// @notice If a terminal hasn't already been added to a project's list of terminals, add it.

package/src/JBERC20.sol

@@ -38,44 +38,6 @@ contract JBERC20 is ERC20Votes, ERC20Permit, Ownable, IJBToken {
 
     constructor() Ownable(address(this)) ERC20("invalid", "invalid") ERC20Permit("JBToken") {}
 
-    //*********************************************************************//
-    // -------------------------- public views --------------------------- //
-    //*********************************************************************//
-
-    /// @notice The balance of the given address.
-    /// @param account The account to get the balance of.
-    /// @return The number of tokens owned by the `account`, as a fixed point number with 18 decimals.
-    function balanceOf(address account) public view override(ERC20, IJBToken) returns (uint256) {
-        return super.balanceOf(account);
-    }
-
-    /// @notice This token can only be added to a project when its created by the `JBTokens` contract.
-    function canBeAddedTo(uint256) external pure override returns (bool) {
-        return false;
-    }
-
-    /// @notice The number of decimals used for this token's fixed point accounting.
-    /// @return The number of decimals.
-    function decimals() public view override(ERC20, IJBToken) returns (uint8) {
-        return super.decimals();
-    }
-
-    /// @notice The token's name.
-    function name() public view virtual override returns (string memory) {
-        return _name;
-    }
-
-    /// @notice The token's symbol.
-    function symbol() public view virtual override returns (string memory) {
-        return _symbol;
-    }
-
-    /// @notice The total supply of this ERC20 i.e. the total number of tokens in existence.
-    /// @return The total supply of this ERC20, as a fixed point number.
-    function totalSupply() public view override(ERC20, IJBToken) returns (uint256) {
-        return super.totalSupply();
-    }
-
     //*********************************************************************//
     // ---------------------- external transactions ---------------------- //
     //*********************************************************************//
@@ -115,13 +77,55 @@ contract JBERC20 is ERC20Votes, ERC20Permit, Ownable, IJBToken {
         _transferOwnership(owner);
     }
 
+    //*********************************************************************//
+    // ------------------------- external views -------------------------- //
+    //*********************************************************************//
+
+    /// @notice This token can only be added to a project when its created by the `JBTokens` contract.
+    function canBeAddedTo(uint256) external pure override returns (bool) {
+        return false;
+    }
+
+    //*********************************************************************//
+    // -------------------------- public views --------------------------- //
+    //*********************************************************************//
+
+    /// @notice The balance of the given address.
+    /// @param account The account to get the balance of.
+    /// @return The number of tokens owned by the `account`, as a fixed point number with 18 decimals.
+    function balanceOf(address account) public view override(ERC20, IJBToken) returns (uint256) {
+        return super.balanceOf(account);
+    }
+
+    /// @notice The number of decimals used for this token's fixed point accounting.
+    /// @return The number of decimals.
+    function decimals() public view override(ERC20, IJBToken) returns (uint8) {
+        return super.decimals();
+    }
+
+    /// @notice The token's name.
+    function name() public view virtual override returns (string memory) {
+        return _name;
+    }
+
     /// @notice Required override.
     function nonces(address owner) public view virtual override(ERC20Permit, Nonces) returns (uint256) {
         return super.nonces(owner);
     }
 
+    /// @notice The token's symbol.
+    function symbol() public view virtual override returns (string memory) {
+        return _symbol;
+    }
+
+    /// @notice The total supply of this ERC20 i.e. the total number of tokens in existence.
+    /// @return The total supply of this ERC20, as a fixed point number.
+    function totalSupply() public view override(ERC20, IJBToken) returns (uint256) {
+        return super.totalSupply();
+    }
+
     //*********************************************************************//
-    // ------------------------ internal functions ----------------------- //
+    // ---------------------- internal transactions ---------------------- //
     //*********************************************************************//
 
     /// @notice Required override.

package/src/JBFeelessAddresses.sol

@@ -26,18 +26,6 @@ contract JBFeelessAddresses is Ownable, IJBFeelessAddresses, IERC165 {
     /// @param owner This contract's owner.
     constructor(address owner) Ownable(owner) {}
 
-    //*********************************************************************//
-    // -------------------------- public views --------------------------- //
-    //*********************************************************************//
-
-    /// @notice Indicates whether this contract adheres to the specified interface.
-    /// @dev See {IERC165-supportsInterface}.
-    /// @param interfaceId The ID of the interface to check for adherence to.
-    /// @return A flag indicating if the provided interface ID is supported.
-    function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
-        return interfaceId == type(IJBFeelessAddresses).interfaceId || interfaceId == type(IERC165).interfaceId;
-    }
-
     //*********************************************************************//
     // ---------------------- external transactions ---------------------- //
     //*********************************************************************//
@@ -51,4 +39,16 @@ contract JBFeelessAddresses is Ownable, IJBFeelessAddresses, IERC165 {
 
         emit SetFeelessAddress({addr: addr, isFeeless: flag, caller: _msgSender()});
     }
+
+    //*********************************************************************//
+    // -------------------------- public views --------------------------- //
+    //*********************************************************************//
+
+    /// @notice Indicates whether this contract adheres to the specified interface.
+    /// @dev See {IERC165-supportsInterface}.
+    /// @param interfaceId The ID of the interface to check for adherence to.
+    /// @return A flag indicating if the provided interface ID is supported.
+    function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
+        return interfaceId == type(IJBFeelessAddresses).interfaceId || interfaceId == type(IERC165).interfaceId;
+    }
 }

package/src/JBFundAccessLimits.sol

@@ -57,6 +57,88 @@ contract JBFundAccessLimits is JBControlled, IJBFundAccessLimits {
     // solhint-disable-next-line no-empty-blocks
     constructor(IJBDirectory directory) JBControlled(directory) {}
 
+    //*********************************************************************//
+    // ---------------------- external transactions ---------------------- //
+    //*********************************************************************//
+
+    /// @notice Sets limits on the amount of funds a project can access from its terminals during a ruleset.
+    /// @dev Only a project's controller can set its fund access limits.
+    /// @dev Payout limits and surplus allowances must be specified in strictly increasing order (by currency) to
+    /// prevent duplicates.
+    /// @param projectId The ID of the project whose fund access limits are being set.
+    /// @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.
+    function setFundAccessLimitsFor(
+        uint256 projectId,
+        uint256 rulesetId,
+        JBFundAccessLimitGroup[] calldata fundAccessLimitGroups
+    )
+        external
+        override
+        onlyControllerOf(projectId)
+    {
+        // Save the number of fund access limit groups.
+        uint256 numberOfFundAccessLimitGroups = fundAccessLimitGroups.length;
+
+        // Set payout limits if there are any.
+        for (uint256 i; i < numberOfFundAccessLimitGroups; i++) {
+            // Set the limits being iterated on.
+            JBFundAccessLimitGroup calldata fundAccessLimitGroup = fundAccessLimitGroups[i];
+
+            // Keep a reference to the number of payout limits.
+            uint256 numberOfPayoutLimits = fundAccessLimitGroup.payoutLimits.length;
+
+            // Iterate through each payout limit to validate and store them.
+            for (uint256 j; j < numberOfPayoutLimits; j++) {
+                // Set the payout limit being iterated on.
+                JBCurrencyAmount calldata payoutLimit = fundAccessLimitGroup.payoutLimits[j];
+
+                // Make sure the payout limits are passed in strictly increasing order (sorted by currency) to prevent
+                // duplicates.
+                if (j != 0 && payoutLimit.currency <= fundAccessLimitGroup.payoutLimits[j - 1].currency) {
+                    revert JBFundAccessLimits_InvalidPayoutLimitCurrencyOrdering();
+                }
+
+                // Set the payout limit if there is one.
+                if (payoutLimit.amount > 0) {
+                    _packedPayoutLimitsDataOf[projectId][rulesetId][fundAccessLimitGroup.terminal][fundAccessLimitGroup.token].push(
+                        uint256(payoutLimit.amount) | (uint256(payoutLimit.currency) << 224)
+                    );
+                }
+            }
+
+            // Keep a reference to the number of surplus allowances.
+            uint256 numberOfSurplusAllowances = fundAccessLimitGroup.surplusAllowances.length;
+
+            // Iterate through each surplus allowance to validate and store them.
+            for (uint256 j; j < numberOfSurplusAllowances; j++) {
+                // Set the surplus allowance being iterated on.
+                JBCurrencyAmount calldata surplusAllowance = fundAccessLimitGroup.surplusAllowances[j];
+
+                // Make sure the surplus allowances are passed in strictly increasing order (sorted by currency) to
+                // prevent duplicates.
+                if (j != 0 && surplusAllowance.currency <= fundAccessLimitGroup.surplusAllowances[j - 1].currency) {
+                    revert JBFundAccessLimits_InvalidSurplusAllowanceCurrencyOrdering();
+                }
+
+                // Set the surplus allowance if there is one.
+                if (surplusAllowance.amount > 0) {
+                    _packedSurplusAllowancesDataOf[projectId][rulesetId][fundAccessLimitGroup.terminal][fundAccessLimitGroup.token].push(
+                        uint256(surplusAllowance.amount) | (uint256(surplusAllowance.currency) << 224)
+                    );
+                }
+            }
+
+            emit SetFundAccessLimits({
+                rulesetId: rulesetId,
+                projectId: projectId,
+                fundAccessLimitGroup: fundAccessLimitGroup,
+                caller: msg.sender
+            });
+        }
+    }
+
     //*********************************************************************//
     // ------------------------- external views -------------------------- //
     //*********************************************************************//
@@ -223,86 +305,4 @@ contract JBFundAccessLimits is JBControlled, IJBFundAccessLimits {
             });
         }
     }
-
-    //*********************************************************************//
-    // --------------------- external transactions ----------------------- //
-    //*********************************************************************//
-
-    /// @notice Sets limits on the amount of funds a project can access from its terminals during a ruleset.
-    /// @dev Only a project's controller can set its fund access limits.
-    /// @dev Payout limits and surplus allowances must be specified in strictly increasing order (by currency) to
-    /// prevent duplicates.
-    /// @param projectId The ID of the project whose fund access limits are being set.
-    /// @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.
-    function setFundAccessLimitsFor(
-        uint256 projectId,
-        uint256 rulesetId,
-        JBFundAccessLimitGroup[] calldata fundAccessLimitGroups
-    )
-        external
-        override
-        onlyControllerOf(projectId)
-    {
-        // Save the number of fund access limit groups.
-        uint256 numberOfFundAccessLimitGroups = fundAccessLimitGroups.length;
-
-        // Set payout limits if there are any.
-        for (uint256 i; i < numberOfFundAccessLimitGroups; i++) {
-            // Set the limits being iterated on.
-            JBFundAccessLimitGroup calldata fundAccessLimitGroup = fundAccessLimitGroups[i];
-
-            // Keep a reference to the number of payout limits.
-            uint256 numberOfPayoutLimits = fundAccessLimitGroup.payoutLimits.length;
-
-            // Iterate through each payout limit to validate and store them.
-            for (uint256 j; j < numberOfPayoutLimits; j++) {
-                // Set the payout limit being iterated on.
-                JBCurrencyAmount calldata payoutLimit = fundAccessLimitGroup.payoutLimits[j];
-
-                // Make sure the payout limits are passed in strictly increasing order (sorted by currency) to prevent
-                // duplicates.
-                if (j != 0 && payoutLimit.currency <= fundAccessLimitGroup.payoutLimits[j - 1].currency) {
-                    revert JBFundAccessLimits_InvalidPayoutLimitCurrencyOrdering();
-                }
-
-                // Set the payout limit if there is one.
-                if (payoutLimit.amount > 0) {
-                    _packedPayoutLimitsDataOf[projectId][rulesetId][fundAccessLimitGroup.terminal][fundAccessLimitGroup.token].push(
-                        uint256(payoutLimit.amount) | (uint256(payoutLimit.currency) << 224)
-                    );
-                }
-            }
-
-            // Keep a reference to the number of surplus allowances.
-            uint256 numberOfSurplusAllowances = fundAccessLimitGroup.surplusAllowances.length;
-
-            // Iterate through each surplus allowance to validate and store them.
-            for (uint256 j; j < numberOfSurplusAllowances; j++) {
-                // Set the surplus allowance being iterated on.
-                JBCurrencyAmount calldata surplusAllowance = fundAccessLimitGroup.surplusAllowances[j];
-
-                // Make sure the surplus allowances are passed in strictly increasing order (sorted by currency) to
-                // prevent duplicates.
-                if (j != 0 && surplusAllowance.currency <= fundAccessLimitGroup.surplusAllowances[j - 1].currency) {
-                    revert JBFundAccessLimits_InvalidSurplusAllowanceCurrencyOrdering();
-                }
-
-                // Set the surplus allowance if there is one.
-                if (surplusAllowance.amount > 0) {
-                    _packedSurplusAllowancesDataOf[projectId][rulesetId][fundAccessLimitGroup.terminal][fundAccessLimitGroup.token].push(
-                        uint256(surplusAllowance.amount) | (uint256(surplusAllowance.currency) << 224)
-                    );
-                }
-            }
-
-            emit SetFundAccessLimits({
-                rulesetId: rulesetId,
-                projectId: projectId,
-                fundAccessLimitGroup: fundAccessLimitGroup,
-                caller: msg.sender
-            });
-        }
-    }
 }