@bananapus/core-v6 0.0.1

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

@@ -0,0 +1,84 @@
+# JBDeadline
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/JBDeadline.sol)
+
+**Inherits:**
+[IJBRulesetApprovalHook](/src/interfaces/IJBRulesetApprovalHook.sol/interface.IJBRulesetApprovalHook.md)
+
+`JBDeadline` is a ruleset approval hook which rejects rulesets if they are not queued at least `duration`
+seconds before the current ruleset ends. In other words, rulesets must be queued before the deadline to take effect.
+
+*Project rulesets are stored in a queue. Rulesets take effect after the previous ruleset in the queue ends, and
+only if they are approved by the previous ruleset's approval hook.*
+
+
+## State Variables
+### DURATION
+The minimum number of seconds between the time a ruleset is queued and the time it starts. If the
+difference is greater than this number, the ruleset is `Approved`.
+
+
+```solidity
+uint256 public immutable override DURATION;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(uint256 duration);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`duration`|`uint256`|The minimum number of seconds between the time a ruleset is queued and the time it starts for it to be `Approved`.|
+
+
+### approvalStatusOf
+
+The approval status of a given ruleset.
+
+
+```solidity
+function approvalStatusOf(uint256, uint256 rulesetId, uint256 start) public view override returns (JBApprovalStatus);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`||
+|`rulesetId`|`uint256`|The ID of the ruleset to check the status of.|
+|`start`|`uint256`|The start timestamp of the ruleset to check the status of.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`JBApprovalStatus`|The ruleset's approval status.|
+
+
+### supportsInterface
+
+Indicates whether this contract adheres to the specified interface.
+
+*See [IERC165-supportsInterface](/lib/forge-std/src/mocks/MockERC721.sol/contract.MockERC721.md#supportsinterface).*
+
+
+```solidity
+function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`interfaceId`|`bytes4`|The ID of the interface to check for adherence to.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bool`|A flag indicating if this contract adheres to the specified interface.|
+
+

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

@@ -0,0 +1,294 @@
+# JBDirectory
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/JBDirectory.sol)
+
+**Inherits:**
+[JBPermissioned](/src/abstract/JBPermissioned.sol/abstract.JBPermissioned.md), Ownable, [IJBDirectory](/src/interfaces/IJBDirectory.sol/interface.IJBDirectory.md)
+
+`JBDirectory` tracks the terminals and the controller used by each project.
+
+*Tracks which `IJBTerminal`s each project is currently accepting funds through, and which `IJBController` is
+managing each project's tokens and rulesets.*
+
+
+## State Variables
+### PROJECTS
+Mints ERC-721s that represent project ownership and transfers.
+
+
+```solidity
+IJBProjects public immutable override PROJECTS;
+```
+
+
+### controllerOf
+The specified project's controller, which dictates how its terminals interact with its tokens and
+rulesets.
+
+
+```solidity
+mapping(uint256 projectId => IERC165) public override controllerOf;
+```
+
+
+### isAllowedToSetFirstController
+Whether the specified address is allowed to set a project's first controller on their behalf.
+
+*These addresses/contracts have been vetted by this contract's owner.*
+
+
+```solidity
+mapping(address addr => bool) public override isAllowedToSetFirstController;
+```
+
+
+### _primaryTerminalOf
+The primary terminal that a project uses for the specified token.
+
+
+```solidity
+mapping(uint256 projectId => mapping(address token => IJBTerminal)) internal _primaryTerminalOf;
+```
+
+
+### _terminalsOf
+The specified project's terminals.
+
+
+```solidity
+mapping(uint256 projectId => IJBTerminal[]) internal _terminalsOf;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(
+    IJBPermissions permissions,
+    IJBProjects projects,
+    address owner
+)
+    JBPermissioned(permissions)
+    Ownable(owner);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`permissions`|`IJBPermissions`|A contract storing permissions.|
+|`projects`|`IJBProjects`|A contract which mints ERC-721s that represent project ownership and transfers.|
+|`owner`|`address`|The address that will own the contract.|
+
+
+### primaryTerminalOf
+
+The primary terminal that a project uses for the specified token.
+
+*Returns the first terminal that accepts the token if the project hasn't explicitly set a primary terminal
+for it.*
+
+*Returns the zero address if no terminal accepts the token.*
+
+
+```solidity
+function primaryTerminalOf(uint256 projectId, address token) external view override returns (IJBTerminal);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project to get the primary terminal of.|
+|`token`|`address`|The token that the terminal accepts.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`IJBTerminal`|The primary terminal's address.|
+
+
+### terminalsOf
+
+The specified project's terminals.
+
+
+```solidity
+function terminalsOf(uint256 projectId) external view override returns (IJBTerminal[] memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project to get the terminals of.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`IJBTerminal[]`|An array of the project's terminal addresses.|
+
+
+### isTerminalOf
+
+Check if a project uses a specific terminal.
+
+
+```solidity
+function isTerminalOf(uint256 projectId, IJBTerminal terminal) public view override returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project to check.|
+|`terminal`|`IJBTerminal`|The terminal to check for.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bool`|A flag indicating whether the project uses the terminal.|
+
+
+### setIsAllowedToSetFirstController
+
+Add or remove an address/contract from a list of trusted addresses which are allowed to set a first
+controller for projects.
+
+*Only this contract's owner can call this function.*
+
+*These addresses are vetted controllers as well as contracts designed to launch new projects.*
+
+*A project can set its own controller without being on this list.*
+
+*If you would like to add an address/contract to this list, please reach out to this contract's owner.*
+
+
+```solidity
+function setIsAllowedToSetFirstController(address addr, bool flag) external override onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`addr`|`address`|The address to allow or not allow.|
+|`flag`|`bool`|Whether the address is allowed to set first controllers for projects. Use `true` to allow and `false` to not allow.|
+
+
+### setControllerOf
+
+Set a project's controller. Controllers manage how terminals interact with tokens and rulesets.
+
+*Can only be called if:
+- The ruleset's metadata has `allowSetController` enabled, and the message's sender is the project's owner or an
+address with the owner's permission to `SET_CONTROLLER`.
+- OR the message's sender is the project's current controller.
+- OR an address which `isAllowedToSetFirstController` is setting a project's first controller.*
+
+
+```solidity
+function setControllerOf(uint256 projectId, IERC165 controller) external override;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project whose controller is being set.|
+|`controller`|`IERC165`|The address of the controller to set.|
+
+
+### setPrimaryTerminalOf
+
+Set a project's primary terminal for a token.
+
+*The primary terminal for a token is where payments in that token are routed to by default.*
+
+*This is useful in cases where a project has multiple terminals which accept the same token.*
+
+*Can only be called by the project's owner, or an address with the owner's permission to
+`SET_PRIMARY_TERMINAL`.*
+
+
+```solidity
+function setPrimaryTerminalOf(uint256 projectId, address token, IJBTerminal terminal) external override;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project whose primary terminal is being set.|
+|`token`|`address`|The token to set the primary terminal for.|
+|`terminal`|`IJBTerminal`|The terminal being set as the primary terminal.|
+
+
+### setTerminalsOf
+
+Set a project's terminals.
+
+*Can only be called by the project's owner, an address with the owner's permission to `SET_TERMINALS`, or
+the project's controller.*
+
+*Unless the caller is the project's controller, the project's ruleset must allow setting terminals.*
+
+
+```solidity
+function setTerminalsOf(uint256 projectId, IJBTerminal[] calldata terminals) external override;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project whose terminals are being set.|
+|`terminals`|`IJBTerminal[]`|An array of terminal addresses to set for the project.|
+
+
+### _addTerminalIfNeeded
+
+If a terminal hasn't already been added to a project's list of terminals, add it.
+
+*The project's ruleset must have `allowSetTerminals` set to `true`.*
+
+
+```solidity
+function _addTerminalIfNeeded(uint256 projectId, IJBTerminal terminal) internal;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project to add the terminal to.|
+|`terminal`|`IJBTerminal`|The terminal to add.|
+
+
+## Errors
+### JBDirectory_DuplicateTerminals
+
+```solidity
+error JBDirectory_DuplicateTerminals(IJBTerminal terminal);
+```
+
+### JBDirectory_InvalidProjectIdInDirectory
+
+```solidity
+error JBDirectory_InvalidProjectIdInDirectory(uint256 projectId, uint256 limit);
+```
+
+### JBDirectory_SetControllerNotAllowed
+
+```solidity
+error JBDirectory_SetControllerNotAllowed();
+```
+
+### JBDirectory_SetTerminalsNotAllowed
+
+```solidity
+error JBDirectory_SetTerminalsNotAllowed();
+```
+
+### JBDirectory_TokenNotAccepted
+
+```solidity
+error JBDirectory_TokenNotAccepted(uint256 projectId, address token, IJBTerminal terminal);
+```
+

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

@@ -0,0 +1,190 @@
+# JBERC20
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/JBERC20.sol)
+
+**Inherits:**
+ERC20Votes, ERC20Permit, Ownable, [IJBToken](/src/interfaces/IJBToken.sol/interface.IJBToken.md)
+
+An ERC-20 token that can be used by a project in `JBTokens` and `JBController`.
+
+*By default, a project uses "credits" to track balances. Once a project sets their `IJBToken` using
+`JBController.deployERC20For(...)` or `JBController.setTokenFor(...)`, credits can be redeemed to claim tokens.*
+
+*`JBController.deployERC20For(...)` deploys a `JBERC20` contract and sets it as the project's token.*
+
+
+## State Variables
+### _name
+The token's name.
+
+
+```solidity
+string private _name;
+```
+
+
+### _symbol
+The token's symbol.
+
+
+```solidity
+string private _symbol;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor() Ownable(address(this)) ERC20("invalid", "invalid") ERC20Permit("JBToken");
+```
+
+### balanceOf
+
+The balance of the given address.
+
+
+```solidity
+function balanceOf(address account) public view override(ERC20, IJBToken) returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`account`|`address`|The account to get the balance of.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The number of tokens owned by the `account`, as a fixed point number with 18 decimals.|
+
+
+### canBeAddedTo
+
+This token can only be added to a project when its created by the `JBTokens` contract.
+
+
+```solidity
+function canBeAddedTo(uint256) external pure override returns (bool);
+```
+
+### decimals
+
+The number of decimals used for this token's fixed point accounting.
+
+
+```solidity
+function decimals() public view override(ERC20, IJBToken) returns (uint8);
+```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint8`|The number of decimals.|
+
+
+### name
+
+The token's name.
+
+
+```solidity
+function name() public view virtual override returns (string memory);
+```
+
+### symbol
+
+The token's symbol.
+
+
+```solidity
+function symbol() public view virtual override returns (string memory);
+```
+
+### totalSupply
+
+The total supply of this ERC20 i.e. the total number of tokens in existence.
+
+
+```solidity
+function totalSupply() public view override(ERC20, IJBToken) returns (uint256);
+```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The total supply of this ERC20, as a fixed point number.|
+
+
+### burn
+
+Burn some outstanding tokens.
+
+*Can only be called by this contract's owner.*
+
+
+```solidity
+function burn(address account, uint256 amount) external override onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`account`|`address`|The address to burn tokens from.|
+|`amount`|`uint256`|The amount of tokens to burn, as a fixed point number with 18 decimals.|
+
+
+### mint
+
+Mints more of this token.
+
+*Can only be called by this contract's owner.*
+
+
+```solidity
+function mint(address account, uint256 amount) external override onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`account`|`address`|The address to mint the new tokens to.|
+|`amount`|`uint256`|The amount of tokens to mint, as a fixed point number with 18 decimals.|
+
+
+### initialize
+
+Initializes the token.
+
+
+```solidity
+function initialize(string memory name_, string memory symbol_, address owner) public override;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`name_`|`string`|The token's name.|
+|`symbol_`|`string`|The token's symbol.|
+|`owner`|`address`|The token contract's owner.|
+
+
+### nonces
+
+Required override.
+
+
+```solidity
+function nonces(address owner) public view virtual override(ERC20Permit, Nonces) returns (uint256);
+```
+
+### _update
+
+Required override.
+
+
+```solidity
+function _update(address from, address to, uint256 value) internal virtual override(ERC20, ERC20Votes);
+```
+

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

@@ -0,0 +1,80 @@
+# JBFeelessAddresses
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/JBFeelessAddresses.sol)
+
+**Inherits:**
+Ownable, [IJBFeelessAddresses](/src/interfaces/IJBFeelessAddresses.sol/interface.IJBFeelessAddresses.md), IERC165
+
+Stores a list of addresses that shouldn't incur fees when sending or receiving payments.
+
+
+## State Variables
+### isFeeless
+Check if the specified address is feeless.
+
+*Feeless addresses can receive payouts without incurring a fee.*
+
+*Feeless addresses can use the surplus allowance without incurring a fee.*
+
+*Feeless addresses can be the beneficary of cash outs without incurring a fee.*
+
+
+```solidity
+mapping(address addr => bool) public override isFeeless;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(address owner) Ownable(owner);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`owner`|`address`|This contract's owner.|
+
+
+### supportsInterface
+
+Indicates whether this contract adheres to the specified interface.
+
+*See [IERC165-supportsInterface](/src/JBDeadline.sol/contract.JBDeadline.md#supportsinterface).*
+
+
+```solidity
+function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`interfaceId`|`bytes4`|The ID of the interface to check for adherence to.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bool`|A flag indicating if the provided interface ID is supported.|
+
+
+### setFeelessAddress
+
+Sets whether an address is feeless.
+
+*Can only be called by this contract's owner.*
+
+
+```solidity
+function setFeelessAddress(address addr, bool flag) external virtual override onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`addr`|`address`|The address to set as feeless or not feeless.|
+|`flag`|`bool`|Whether the address should be feeless (`true`) or not feeless (`false`).|
+
+