@bananapus/core-v6 0.0.1

package/docs/src/src/JBTokens.sol/contract.JBTokens.md

@@ -0,0 +1,353 @@
+# JBTokens
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/JBTokens.sol)
+
+**Inherits:**
+[JBControlled](/src/abstract/JBControlled.sol/abstract.JBControlled.md), [IJBTokens](/src/interfaces/IJBTokens.sol/interface.IJBTokens.md)
+
+Manages minting, burning, and balances of projects' tokens and token credits.
+
+*Token balances can either be ERC-20s or token credits. This contract manages these two representations and
+allows credit -> ERC-20 claiming.*
+
+*The total supply of a project's tokens and the balance of each account are calculated in this contract.*
+
+*An ERC-20 contract must be set by a project's owner for ERC-20 claiming to become available. Projects can bring
+their own IJBToken if they prefer.*
+
+
+## State Variables
+### TOKEN
+A reference to the token implementation that'll be cloned as projects deploy their own tokens.
+
+
+```solidity
+IJBToken public immutable TOKEN;
+```
+
+
+### creditBalanceOf
+Each holder's credit balance for each project.
+
+
+```solidity
+mapping(address holder => mapping(uint256 projectId => uint256)) public override creditBalanceOf;
+```
+
+
+### projectIdOf
+Each token's project.
+
+
+```solidity
+mapping(IJBToken token => uint256) public override projectIdOf;
+```
+
+
+### tokenOf
+Each project's attached token contract.
+
+
+```solidity
+mapping(uint256 projectId => IJBToken) public override tokenOf;
+```
+
+
+### totalCreditSupplyOf
+The total supply of credits for each project.
+
+
+```solidity
+mapping(uint256 projectId => uint256) public override totalCreditSupplyOf;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(IJBDirectory directory, IJBToken token) JBControlled(directory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`directory`|`IJBDirectory`|A contract storing directories of terminals and controllers for each project.|
+|`token`|`IJBToken`|The implementation of the token contract that project can deploy.|
+
+
+### totalBalanceOf
+
+The total balance a holder has for a specified project, including both tokens and token credits.
+
+
+```solidity
+function totalBalanceOf(address holder, uint256 projectId) external view override returns (uint256 balance);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`holder`|`address`|The holder to get a balance for.|
+|`projectId`|`uint256`|The project to get the `_holder`s balance for.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`balance`|`uint256`|The combined token and token credit balance of the `_holder|
+
+
+### totalSupplyOf
+
+The total supply for a specific project, including both tokens and token credits.
+
+
+```solidity
+function totalSupplyOf(uint256 projectId) public view override returns (uint256 totalSupply);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project to get the total supply of.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`totalSupply`|`uint256`|The total supply of the project's tokens and token credits.|
+
+
+### burnFrom
+
+Burns (destroys) credits or tokens.
+
+*Credits are burned first, then tokens are burned.*
+
+*Only a project's current controller can burn its tokens.*
+
+
+```solidity
+function burnFrom(address holder, uint256 projectId, uint256 count) external override onlyControllerOf(projectId);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`holder`|`address`|The address that owns the tokens which are being burned.|
+|`projectId`|`uint256`|The ID of the project to the burned tokens belong to.|
+|`count`|`uint256`|The number of tokens to burn.|
+
+
+### claimTokensFor
+
+Redeem credits to claim tokens into a holder's wallet.
+
+*Only a project's controller can claim that project's tokens.*
+
+
+```solidity
+function claimTokensFor(
+    address holder,
+    uint256 projectId,
+    uint256 count,
+    address beneficiary
+)
+    external
+    override
+    onlyControllerOf(projectId);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`holder`|`address`|The owner of the credits being redeemed.|
+|`projectId`|`uint256`|The ID of the project whose tokens are being claimed.|
+|`count`|`uint256`|The number of tokens to claim.|
+|`beneficiary`|`address`|The account into which the claimed tokens will go.|
+
+
+### deployERC20For
+
+Deploys an ERC-20 token for a project. It will be used when claiming tokens.
+
+*Deploys a project's ERC-20 token contract.*
+
+*Only a project's controller can deploy its token.*
+
+
+```solidity
+function deployERC20For(
+    uint256 projectId,
+    string calldata name,
+    string calldata symbol,
+    bytes32 salt
+)
+    external
+    override
+    onlyControllerOf(projectId)
+    returns (IJBToken token);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project to deploy an ERC-20 token for.|
+|`name`|`string`|The ERC-20's name.|
+|`symbol`|`string`|The ERC-20's symbol.|
+|`salt`|`bytes32`|The salt used for ERC-1167 clone deployment. Pass a non-zero salt for deterministic deployment based on `msg.sender` and the `TOKEN` implementation address.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`token`|`IJBToken`|The address of the token that was deployed.|
+
+
+### mintFor
+
+Mint (create) new tokens or credits.
+
+*Only a project's current controller can mint its tokens.*
+
+
+```solidity
+function mintFor(
+    address holder,
+    uint256 projectId,
+    uint256 count
+)
+    external
+    override
+    onlyControllerOf(projectId)
+    returns (IJBToken token);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`holder`|`address`|The address receiving the new tokens.|
+|`projectId`|`uint256`|The ID of the project to which the tokens belong.|
+|`count`|`uint256`|The number of tokens to mint.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`token`|`IJBToken`|The address of the token that was minted, if the project has a token.|
+
+
+### setTokenFor
+
+Set a project's token if not already set.
+
+*Only a project's controller can set its token.*
+
+
+```solidity
+function setTokenFor(uint256 projectId, IJBToken token) external override onlyControllerOf(projectId);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project to set the token of.|
+|`token`|`IJBToken`|The new token's address.|
+
+
+### transferCreditsFrom
+
+Allows a holder to transfer credits to another account.
+
+*Only a project's controller can transfer credits for that project.*
+
+
+```solidity
+function transferCreditsFrom(
+    address holder,
+    uint256 projectId,
+    address recipient,
+    uint256 count
+)
+    external
+    override
+    onlyControllerOf(projectId);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`holder`|`address`|The address to transfer credits from.|
+|`projectId`|`uint256`|The ID of the project whose credits are being transferred.|
+|`recipient`|`address`|The recipient of the credits.|
+|`count`|`uint256`|The number of token credits to transfer.|
+
+
+## Errors
+### JBTokens_EmptyName
+
+```solidity
+error JBTokens_EmptyName();
+```
+
+### JBTokens_EmptySymbol
+
+```solidity
+error JBTokens_EmptySymbol();
+```
+
+### JBTokens_EmptyToken
+
+```solidity
+error JBTokens_EmptyToken();
+```
+
+### JBTokens_InsufficientCredits
+
+```solidity
+error JBTokens_InsufficientCredits(uint256 count, uint256 creditBalance);
+```
+
+### JBTokens_InsufficientTokensToBurn
+
+```solidity
+error JBTokens_InsufficientTokensToBurn(uint256 count, uint256 tokenBalance);
+```
+
+### JBTokens_OverflowAlert
+
+```solidity
+error JBTokens_OverflowAlert(uint256 value, uint256 limit);
+```
+
+### JBTokens_ProjectAlreadyHasToken
+
+```solidity
+error JBTokens_ProjectAlreadyHasToken(IJBToken token);
+```
+
+### JBTokens_TokenAlreadyBeingUsed
+
+```solidity
+error JBTokens_TokenAlreadyBeingUsed(uint256 projectId);
+```
+
+### JBTokens_TokenCantBeAdded
+
+```solidity
+error JBTokens_TokenCantBeAdded(uint256 projectId);
+```
+
+### JBTokens_TokenNotFound
+
+```solidity
+error JBTokens_TokenNotFound();
+```
+
+### JBTokens_TokensMustHave18Decimals
+
+```solidity
+error JBTokens_TokensMustHave18Decimals(uint256 decimals);
+```
+

package/docs/src/src/README.md

@@ -0,0 +1,25 @@
+
+
+# Contents
+- [abstract](/src/abstract)
+- [enums](/src/enums)
+- [interfaces](/src/interfaces)
+- [libraries](/src/libraries)
+- [periphery](/src/periphery)
+- [structs](/src/structs)
+- [JBChainlinkV3PriceFeed](JBChainlinkV3PriceFeed.sol/contract.JBChainlinkV3PriceFeed.md)
+- [JBChainlinkV3SequencerPriceFeed](JBChainlinkV3SequencerPriceFeed.sol/contract.JBChainlinkV3SequencerPriceFeed.md)
+- [JBController](JBController.sol/contract.JBController.md)
+- [JBDeadline](JBDeadline.sol/contract.JBDeadline.md)
+- [JBDirectory](JBDirectory.sol/contract.JBDirectory.md)
+- [JBERC20](JBERC20.sol/contract.JBERC20.md)
+- [JBFeelessAddresses](JBFeelessAddresses.sol/contract.JBFeelessAddresses.md)
+- [JBFundAccessLimits](JBFundAccessLimits.sol/contract.JBFundAccessLimits.md)
+- [JBMultiTerminal](JBMultiTerminal.sol/contract.JBMultiTerminal.md)
+- [JBPermissions](JBPermissions.sol/contract.JBPermissions.md)
+- [JBPrices](JBPrices.sol/contract.JBPrices.md)
+- [JBProjects](JBProjects.sol/contract.JBProjects.md)
+- [JBRulesets](JBRulesets.sol/contract.JBRulesets.md)
+- [JBSplits](JBSplits.sol/contract.JBSplits.md)
+- [JBTerminalStore](JBTerminalStore.sol/contract.JBTerminalStore.md)
+- [JBTokens](JBTokens.sol/contract.JBTokens.md)

package/docs/src/src/abstract/JBControlled.sol/abstract.JBControlled.md

@@ -0,0 +1,64 @@
+# JBControlled
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/abstract/JBControlled.sol)
+
+**Inherits:**
+[IJBControlled](/src/interfaces/IJBControlled.sol/interface.IJBControlled.md)
+
+Provides a modifier for contracts with functionality that can only be accessed by a project's controller.
+
+
+## State Variables
+### DIRECTORY
+The directory of terminals and controllers for projects.
+
+
+```solidity
+IJBDirectory public immutable override DIRECTORY;
+```
+
+
+## Functions
+### onlyControllerOf
+
+Only allows the controller of the specified project to proceed.
+
+
+```solidity
+modifier onlyControllerOf(uint256 projectId);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project.|
+
+
+### constructor
+
+
+```solidity
+constructor(IJBDirectory directory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`directory`|`IJBDirectory`|A contract storing directories of terminals and controllers for each project.|
+
+
+### _onlyControllerOf
+
+Only allows the controller of the specified project to proceed.
+
+
+```solidity
+function _onlyControllerOf(uint256 projectId) internal view;
+```
+
+## Errors
+### JBControlled_ControllerUnauthorized
+
+```solidity
+error JBControlled_ControllerUnauthorized(address controller);
+```
+

package/docs/src/src/abstract/JBPermissioned.sol/abstract.JBPermissioned.md

@@ -0,0 +1,84 @@
+# JBPermissioned
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/abstract/JBPermissioned.sol)
+
+**Inherits:**
+Context, [IJBPermissioned](/src/interfaces/IJBPermissioned.sol/interface.IJBPermissioned.md)
+
+Modifiers to allow access to transactions based on which permissions the message's sender has.
+
+
+## State Variables
+### PERMISSIONS
+A contract storing permissions.
+
+
+```solidity
+IJBPermissions public immutable override PERMISSIONS;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(IJBPermissions permissions);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`permissions`|`IJBPermissions`|A contract storing permissions.|
+
+
+### _requirePermissionFrom
+
+Require the message sender to be the account or have the relevant permission.
+
+
+```solidity
+function _requirePermissionFrom(address account, uint256 projectId, uint256 permissionId) internal view;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`account`|`address`|The account to allow.|
+|`projectId`|`uint256`|The project ID to check the permission under.|
+|`permissionId`|`uint256`|The required permission ID. The operator must have this permission within the specified project ID.|
+
+
+### _requirePermissionAllowingOverrideFrom
+
+If the 'alsoGrantAccessIf' condition is truthy, proceed. Otherwise, require the message sender to be the
+account or
+have the relevant permission.
+
+
+```solidity
+function _requirePermissionAllowingOverrideFrom(
+    address account,
+    uint256 projectId,
+    uint256 permissionId,
+    bool alsoGrantAccessIf
+)
+    internal
+    view;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`account`|`address`|The account to allow.|
+|`projectId`|`uint256`|The project ID to check the permission under.|
+|`permissionId`|`uint256`|The required permission ID. The operator must have this permission within the specified project ID.|
+|`alsoGrantAccessIf`|`bool`|An override condition which will allow access regardless of permissions.|
+
+
+## Errors
+### JBPermissioned_Unauthorized
+
+```solidity
+error JBPermissioned_Unauthorized(address account, address sender, uint256 projectId, uint256 permissionId);
+```
+

package/docs/src/src/abstract/README.md

@@ -0,0 +1,5 @@
+
+
+# Contents
+- [JBControlled](JBControlled.sol/abstract.JBControlled.md)
+- [JBPermissioned](JBPermissioned.sol/abstract.JBPermissioned.md)

package/docs/src/src/enums/JBApprovalStatus.sol/enum.JBApprovalStatus.md

@@ -0,0 +1,17 @@
+# JBApprovalStatus
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/enums/JBApprovalStatus.sol)
+
+A ruleset's approval status in a ruleset approval hook.
+
+
+```solidity
+enum JBApprovalStatus {
+    Empty,
+    Upcoming,
+    Active,
+    ApprovalExpected,
+    Approved,
+    Failed
+}
+```
+

package/docs/src/src/enums/README.md

@@ -0,0 +1,4 @@
+
+
+# Contents
+- [JBApprovalStatus](JBApprovalStatus.sol/enum.JBApprovalStatus.md)

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

@@ -0,0 +1,29 @@
+# IJBCashOutHook
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBCashOutHook.sol)
+
+**Inherits:**
+IERC165
+
+Hook called after a terminal's `cashOutTokensOf(...)` logic completes (if passed by the ruleset's data
+hook).
+
+
+## Functions
+### afterCashOutRecordedWith
+
+This function is called by the terminal's `cashOutTokensOf(...)` function after the cash out has been
+recorded in the terminal store.
+
+*Critical business logic should be protected by appropriate access control.*
+
+
+```solidity
+function afterCashOutRecordedWith(JBAfterCashOutRecordedContext calldata context) external payable;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`context`|`JBAfterCashOutRecordedContext`|The context passed in by the terminal, as a `JBAfterCashOutRecordedContext` struct.|
+
+

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

@@ -0,0 +1,57 @@
+# IJBCashOutTerminal
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBCashOutTerminal.sol)
+
+**Inherits:**
+[IJBTerminal](/src/interfaces/IJBTerminal.sol/interface.IJBTerminal.md)
+
+A terminal that can be cashed out from.
+
+
+## Functions
+### cashOutTokensOf
+
+
+```solidity
+function cashOutTokensOf(
+    address holder,
+    uint256 projectId,
+    uint256 cashOutCount,
+    address tokenToReclaim,
+    uint256 minTokensReclaimed,
+    address payable beneficiary,
+    bytes calldata metadata
+)
+    external
+    returns (uint256 reclaimAmount);
+```
+
+## Events
+### HookAfterRecordCashOut
+
+```solidity
+event HookAfterRecordCashOut(
+    IJBCashOutHook indexed hook,
+    JBAfterCashOutRecordedContext context,
+    uint256 specificationAmount,
+    uint256 fee,
+    address caller
+);
+```
+
+### CashOutTokens
+
+```solidity
+event CashOutTokens(
+    uint256 indexed rulesetId,
+    uint256 indexed rulesetCycleNumber,
+    uint256 indexed projectId,
+    address holder,
+    address beneficiary,
+    uint256 cashOutCount,
+    uint256 cashOutTaxRate,
+    uint256 reclaimAmount,
+    bytes metadata,
+    address caller
+);
+```
+

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

@@ -0,0 +1,12 @@
+# IJBControlled
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBControlled.sol)
+
+
+## Functions
+### DIRECTORY
+
+
+```solidity
+function DIRECTORY() external view returns (IJBDirectory);
+```
+