@bananapus/core-v6 0.0.1

package/docs/src/src/interfaces/IJBController.sol/interface.IJBController.md

@@ -0,0 +1,334 @@
+# IJBController
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBController.sol)
+
+**Inherits:**
+IERC165, [IJBProjectUriRegistry](/src/interfaces/IJBProjectUriRegistry.sol/interface.IJBProjectUriRegistry.md), [IJBDirectoryAccessControl](/src/interfaces/IJBDirectoryAccessControl.sol/interface.IJBDirectoryAccessControl.md)
+
+
+## Functions
+### DIRECTORY
+
+
+```solidity
+function DIRECTORY() external view returns (IJBDirectory);
+```
+
+### FUND_ACCESS_LIMITS
+
+
+```solidity
+function FUND_ACCESS_LIMITS() external view returns (IJBFundAccessLimits);
+```
+
+### PRICES
+
+
+```solidity
+function PRICES() external view returns (IJBPrices);
+```
+
+### PROJECTS
+
+
+```solidity
+function PROJECTS() external view returns (IJBProjects);
+```
+
+### RULESETS
+
+
+```solidity
+function RULESETS() external view returns (IJBRulesets);
+```
+
+### SPLITS
+
+
+```solidity
+function SPLITS() external view returns (IJBSplits);
+```
+
+### TOKENS
+
+
+```solidity
+function TOKENS() external view returns (IJBTokens);
+```
+
+### allRulesetsOf
+
+
+```solidity
+function allRulesetsOf(
+    uint256 projectId,
+    uint256 startingId,
+    uint256 size
+)
+    external
+    view
+    returns (JBRulesetWithMetadata[] memory rulesets);
+```
+
+### currentRulesetOf
+
+
+```solidity
+function currentRulesetOf(uint256 projectId)
+    external
+    view
+    returns (JBRuleset memory ruleset, JBRulesetMetadata memory metadata);
+```
+
+### getRulesetOf
+
+
+```solidity
+function getRulesetOf(
+    uint256 projectId,
+    uint256 rulesetId
+)
+    external
+    view
+    returns (JBRuleset memory ruleset, JBRulesetMetadata memory metadata);
+```
+
+### latestQueuedRulesetOf
+
+
+```solidity
+function latestQueuedRulesetOf(uint256 projectId)
+    external
+    view
+    returns (JBRuleset memory, JBRulesetMetadata memory metadata, JBApprovalStatus);
+```
+
+### pendingReservedTokenBalanceOf
+
+
+```solidity
+function pendingReservedTokenBalanceOf(uint256 projectId) external view returns (uint256);
+```
+
+### totalTokenSupplyWithReservedTokensOf
+
+
+```solidity
+function totalTokenSupplyWithReservedTokensOf(uint256 projectId) external view returns (uint256);
+```
+
+### upcomingRulesetOf
+
+
+```solidity
+function upcomingRulesetOf(uint256 projectId)
+    external
+    view
+    returns (JBRuleset memory ruleset, JBRulesetMetadata memory metadata);
+```
+
+### addPriceFeed
+
+
+```solidity
+function addPriceFeed(uint256 projectId, uint256 pricingCurrency, uint256 unitCurrency, IJBPriceFeed feed) external;
+```
+
+### burnTokensOf
+
+
+```solidity
+function burnTokensOf(address holder, uint256 projectId, uint256 tokenCount, string calldata memo) external;
+```
+
+### claimTokensFor
+
+
+```solidity
+function claimTokensFor(address holder, uint256 projectId, uint256 tokenCount, address beneficiary) external;
+```
+
+### deployERC20For
+
+
+```solidity
+function deployERC20For(
+    uint256 projectId,
+    string calldata name,
+    string calldata symbol,
+    bytes32 salt
+)
+    external
+    returns (IJBToken token);
+```
+
+### launchProjectFor
+
+
+```solidity
+function launchProjectFor(
+    address owner,
+    string calldata projectUri,
+    JBRulesetConfig[] calldata rulesetConfigurations,
+    JBTerminalConfig[] memory terminalConfigurations,
+    string calldata memo
+)
+    external
+    returns (uint256 projectId);
+```
+
+### launchRulesetsFor
+
+
+```solidity
+function launchRulesetsFor(
+    uint256 projectId,
+    JBRulesetConfig[] calldata rulesetConfigurations,
+    JBTerminalConfig[] memory terminalConfigurations,
+    string calldata memo
+)
+    external
+    returns (uint256 rulesetId);
+```
+
+### mintTokensOf
+
+
+```solidity
+function mintTokensOf(
+    uint256 projectId,
+    uint256 tokenCount,
+    address beneficiary,
+    string calldata memo,
+    bool useReservedPercent
+)
+    external
+    returns (uint256 beneficiaryTokenCount);
+```
+
+### queueRulesetsOf
+
+
+```solidity
+function queueRulesetsOf(
+    uint256 projectId,
+    JBRulesetConfig[] calldata rulesetConfigurations,
+    string calldata memo
+)
+    external
+    returns (uint256 rulesetId);
+```
+
+### sendReservedTokensToSplitsOf
+
+
+```solidity
+function sendReservedTokensToSplitsOf(uint256 projectId) external returns (uint256);
+```
+
+### setSplitGroupsOf
+
+
+```solidity
+function setSplitGroupsOf(uint256 projectId, uint256 rulesetId, JBSplitGroup[] calldata splitGroups) external;
+```
+
+### setTokenFor
+
+
+```solidity
+function setTokenFor(uint256 projectId, IJBToken token) external;
+```
+
+### transferCreditsFrom
+
+
+```solidity
+function transferCreditsFrom(address holder, uint256 projectId, address recipient, uint256 creditCount) external;
+```
+
+## Events
+### BurnTokens
+
+```solidity
+event BurnTokens(address indexed holder, uint256 indexed projectId, uint256 tokenCount, string memo, address caller);
+```
+
+### LaunchProject
+
+```solidity
+event LaunchProject(uint256 rulesetId, uint256 projectId, string projectUri, string memo, address caller);
+```
+
+### LaunchRulesets
+
+```solidity
+event LaunchRulesets(uint256 rulesetId, uint256 projectId, string memo, address caller);
+```
+
+### MintTokens
+
+```solidity
+event MintTokens(
+    address indexed beneficiary,
+    uint256 indexed projectId,
+    uint256 tokenCount,
+    uint256 beneficiaryTokenCount,
+    string memo,
+    uint256 reservedPercent,
+    address caller
+);
+```
+
+### PrepMigration
+
+```solidity
+event PrepMigration(uint256 indexed projectId, address from, address caller);
+```
+
+### QueueRulesets
+
+```solidity
+event QueueRulesets(uint256 rulesetId, uint256 projectId, string memo, address caller);
+```
+
+### ReservedDistributionReverted
+
+```solidity
+event ReservedDistributionReverted(
+    uint256 indexed projectId, JBSplit split, uint256 tokenCount, bytes reason, address caller
+);
+```
+
+### SendReservedTokensToSplit
+
+```solidity
+event SendReservedTokensToSplit(
+    uint256 indexed projectId,
+    uint256 indexed rulesetId,
+    uint256 indexed groupId,
+    JBSplit split,
+    uint256 tokenCount,
+    address caller
+);
+```
+
+### SendReservedTokensToSplits
+
+```solidity
+event SendReservedTokensToSplits(
+    uint256 indexed rulesetId,
+    uint256 indexed rulesetCycleNumber,
+    uint256 indexed projectId,
+    address owner,
+    uint256 tokenCount,
+    uint256 leftoverAmount,
+    address caller
+);
+```
+
+### SetUri
+
+```solidity
+event SetUri(uint256 indexed projectId, string uri, address caller);
+```
+

package/docs/src/src/interfaces/IJBDirectory.sol/interface.IJBDirectory.md

@@ -0,0 +1,108 @@
+# IJBDirectory
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBDirectory.sol)
+
+
+## Functions
+### PROJECTS
+
+
+```solidity
+function PROJECTS() external view returns (IJBProjects);
+```
+
+### controllerOf
+
+
+```solidity
+function controllerOf(uint256 projectId) external view returns (IERC165);
+```
+
+### isAllowedToSetFirstController
+
+
+```solidity
+function isAllowedToSetFirstController(address account) external view returns (bool);
+```
+
+### isTerminalOf
+
+
+```solidity
+function isTerminalOf(uint256 projectId, IJBTerminal terminal) external view returns (bool);
+```
+
+### primaryTerminalOf
+
+
+```solidity
+function primaryTerminalOf(uint256 projectId, address token) external view returns (IJBTerminal);
+```
+
+### terminalsOf
+
+
+```solidity
+function terminalsOf(uint256 projectId) external view returns (IJBTerminal[] memory);
+```
+
+### setControllerOf
+
+
+```solidity
+function setControllerOf(uint256 projectId, IERC165 controller) external;
+```
+
+### setIsAllowedToSetFirstController
+
+
+```solidity
+function setIsAllowedToSetFirstController(address account, bool flag) external;
+```
+
+### setPrimaryTerminalOf
+
+
+```solidity
+function setPrimaryTerminalOf(uint256 projectId, address token, IJBTerminal terminal) external;
+```
+
+### setTerminalsOf
+
+
+```solidity
+function setTerminalsOf(uint256 projectId, IJBTerminal[] calldata terminals) external;
+```
+
+## Events
+### AddTerminal
+
+```solidity
+event AddTerminal(uint256 indexed projectId, IJBTerminal indexed terminal, address caller);
+```
+
+### SetController
+
+```solidity
+event SetController(uint256 indexed projectId, IERC165 indexed controller, address caller);
+```
+
+### SetIsAllowedToSetFirstController
+
+```solidity
+event SetIsAllowedToSetFirstController(address indexed addr, bool indexed isAllowed, address caller);
+```
+
+### SetPrimaryTerminal
+
+```solidity
+event SetPrimaryTerminal(
+    uint256 indexed projectId, address indexed token, IJBTerminal indexed terminal, address caller
+);
+```
+
+### SetTerminals
+
+```solidity
+event SetTerminals(uint256 indexed projectId, IJBTerminal[] terminals, address caller);
+```
+

package/docs/src/src/interfaces/IJBDirectoryAccessControl.sol/interface.IJBDirectoryAccessControl.md

@@ -0,0 +1,19 @@
+# IJBDirectoryAccessControl
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBDirectoryAccessControl.sol)
+
+
+## Functions
+### setControllerAllowed
+
+
+```solidity
+function setControllerAllowed(uint256 projectId) external view returns (bool);
+```
+
+### setTerminalsAllowed
+
+
+```solidity
+function setTerminalsAllowed(uint256 projectId) external view returns (bool);
+```
+

package/docs/src/src/interfaces/IJBFeeTerminal.sol/interface.IJBFeeTerminal.md

@@ -0,0 +1,91 @@
+# IJBFeeTerminal
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBFeeTerminal.sol)
+
+**Inherits:**
+[IJBTerminal](/src/interfaces/IJBTerminal.sol/interface.IJBTerminal.md)
+
+A terminal that can process and hold fees.
+
+
+## Functions
+### FEE
+
+
+```solidity
+function FEE() external view returns (uint256);
+```
+
+### FEELESS_ADDRESSES
+
+
+```solidity
+function FEELESS_ADDRESSES() external view returns (IJBFeelessAddresses);
+```
+
+### heldFeesOf
+
+
+```solidity
+function heldFeesOf(uint256 projectId, address token, uint256 count) external view returns (JBFee[] memory);
+```
+
+### processHeldFeesOf
+
+
+```solidity
+function processHeldFeesOf(uint256 projectId, address token, uint256 count) external;
+```
+
+## Events
+### FeeReverted
+
+```solidity
+event FeeReverted(
+    uint256 indexed projectId,
+    address indexed token,
+    uint256 indexed feeProjectId,
+    uint256 amount,
+    bytes reason,
+    address caller
+);
+```
+
+### HoldFee
+
+```solidity
+event HoldFee(
+    uint256 indexed projectId,
+    address indexed token,
+    uint256 indexed amount,
+    uint256 fee,
+    address beneficiary,
+    address caller
+);
+```
+
+### ProcessFee
+
+```solidity
+event ProcessFee(
+    uint256 indexed projectId,
+    address indexed token,
+    uint256 indexed amount,
+    bool wasHeld,
+    address beneficiary,
+    address caller
+);
+```
+
+### ReturnHeldFees
+
+```solidity
+event ReturnHeldFees(
+    uint256 indexed projectId,
+    address indexed token,
+    uint256 indexed amount,
+    uint256 returnedFees,
+    uint256 leftoverAmount,
+    address caller
+);
+```
+

package/docs/src/src/interfaces/IJBFeelessAddresses.sol/interface.IJBFeelessAddresses.md

@@ -0,0 +1,26 @@
+# IJBFeelessAddresses
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBFeelessAddresses.sol)
+
+
+## Functions
+### isFeeless
+
+
+```solidity
+function isFeeless(address account) external view returns (bool);
+```
+
+### setFeelessAddress
+
+
+```solidity
+function setFeelessAddress(address account, bool flag) external;
+```
+
+## Events
+### SetFeelessAddress
+
+```solidity
+event SetFeelessAddress(address indexed addr, bool indexed isFeeless, address caller);
+```
+

package/docs/src/src/interfaces/IJBFundAccessLimits.sol/interface.IJBFundAccessLimits.md

@@ -0,0 +1,88 @@
+# IJBFundAccessLimits
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBFundAccessLimits.sol)
+
+
+## Functions
+### payoutLimitOf
+
+
+```solidity
+function payoutLimitOf(
+    uint256 projectId,
+    uint256 rulesetId,
+    address terminal,
+    address token,
+    uint256 currency
+)
+    external
+    view
+    returns (uint256 payoutLimit);
+```
+
+### payoutLimitsOf
+
+
+```solidity
+function payoutLimitsOf(
+    uint256 projectId,
+    uint256 rulesetId,
+    address terminal,
+    address token
+)
+    external
+    view
+    returns (JBCurrencyAmount[] memory payoutLimits);
+```
+
+### surplusAllowanceOf
+
+
+```solidity
+function surplusAllowanceOf(
+    uint256 projectId,
+    uint256 rulesetId,
+    address terminal,
+    address token,
+    uint256 currency
+)
+    external
+    view
+    returns (uint256 surplusAllowance);
+```
+
+### surplusAllowancesOf
+
+
+```solidity
+function surplusAllowancesOf(
+    uint256 projectId,
+    uint256 rulesetId,
+    address terminal,
+    address token
+)
+    external
+    view
+    returns (JBCurrencyAmount[] memory surplusAllowances);
+```
+
+### setFundAccessLimitsFor
+
+
+```solidity
+function setFundAccessLimitsFor(
+    uint256 projectId,
+    uint256 rulesetId,
+    JBFundAccessLimitGroup[] memory fundAccessLimitGroups
+)
+    external;
+```
+
+## Events
+### SetFundAccessLimits
+
+```solidity
+event SetFundAccessLimits(
+    uint256 indexed rulesetId, uint256 indexed projectId, JBFundAccessLimitGroup fundAccessLimitGroup, address caller
+);
+```
+

package/docs/src/src/interfaces/IJBMigratable.sol/interface.IJBMigratable.md

@@ -0,0 +1,29 @@
+# IJBMigratable
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBMigratable.sol)
+
+**Inherits:**
+IERC165
+
+
+## Functions
+### migrate
+
+
+```solidity
+function migrate(uint256 projectId, IERC165 to) external;
+```
+
+### beforeReceiveMigrationFrom
+
+
+```solidity
+function beforeReceiveMigrationFrom(IERC165 from, uint256 projectId) external;
+```
+
+## Events
+### Migrate
+
+```solidity
+event Migrate(uint256 indexed projectId, IERC165 to, address caller);
+```
+