@bananapus/core-v6 0.0.1

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

@@ -0,0 +1,50 @@
+# IJBMultiTerminal
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBMultiTerminal.sol)
+
+**Inherits:**
+[IJBTerminal](/src/interfaces/IJBTerminal.sol/interface.IJBTerminal.md), [IJBFeeTerminal](/src/interfaces/IJBFeeTerminal.sol/interface.IJBFeeTerminal.md), [IJBCashOutTerminal](/src/interfaces/IJBCashOutTerminal.sol/interface.IJBCashOutTerminal.md), [IJBPayoutTerminal](/src/interfaces/IJBPayoutTerminal.sol/interface.IJBPayoutTerminal.md), [IJBPermitTerminal](/src/interfaces/IJBPermitTerminal.sol/interface.IJBPermitTerminal.md)
+
+
+## Functions
+### DIRECTORY
+
+
+```solidity
+function DIRECTORY() external view returns (IJBDirectory);
+```
+
+### PROJECTS
+
+
+```solidity
+function PROJECTS() external view returns (IJBProjects);
+```
+
+### RULESETS
+
+
+```solidity
+function RULESETS() external view returns (IJBRulesets);
+```
+
+### SPLITS
+
+
+```solidity
+function SPLITS() external view returns (IJBSplits);
+```
+
+### STORE
+
+
+```solidity
+function STORE() external view returns (IJBTerminalStore);
+```
+
+### TOKENS
+
+
+```solidity
+function TOKENS() external view returns (IJBTokens);
+```
+

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

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

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

@@ -0,0 +1,105 @@
+# IJBPayoutTerminal
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBPayoutTerminal.sol)
+
+**Inherits:**
+[IJBTerminal](/src/interfaces/IJBTerminal.sol/interface.IJBTerminal.md)
+
+A terminal that can send payouts.
+
+
+## Functions
+### sendPayoutsOf
+
+
+```solidity
+function sendPayoutsOf(
+    uint256 projectId,
+    address token,
+    uint256 amount,
+    uint256 currency,
+    uint256 minTokensPaidOut
+)
+    external
+    returns (uint256 netLeftoverPayoutAmount);
+```
+
+### useAllowanceOf
+
+
+```solidity
+function useAllowanceOf(
+    uint256 projectId,
+    address token,
+    uint256 amount,
+    uint256 currency,
+    uint256 minTokensPaidOut,
+    address payable beneficiary,
+    address payable feeBeneficiary,
+    string calldata memo
+)
+    external
+    returns (uint256 netAmountPaidOut);
+```
+
+## Events
+### PayoutReverted
+
+```solidity
+event PayoutReverted(uint256 indexed projectId, JBSplit split, uint256 amount, bytes reason, address caller);
+```
+
+### PayoutTransferReverted
+
+```solidity
+event PayoutTransferReverted(
+    uint256 indexed projectId, address addr, address token, uint256 amount, uint256 fee, bytes reason, address caller
+);
+```
+
+### SendPayouts
+
+```solidity
+event SendPayouts(
+    uint256 indexed rulesetId,
+    uint256 indexed rulesetCycleNumber,
+    uint256 indexed projectId,
+    address projectOwner,
+    uint256 amount,
+    uint256 amountPaidOut,
+    uint256 fee,
+    uint256 netLeftoverPayoutAmount,
+    address caller
+);
+```
+
+### SendPayoutToSplit
+
+```solidity
+event SendPayoutToSplit(
+    uint256 indexed projectId,
+    uint256 indexed rulesetId,
+    uint256 indexed group,
+    JBSplit split,
+    uint256 amount,
+    uint256 netAmount,
+    address caller
+);
+```
+
+### UseAllowance
+
+```solidity
+event UseAllowance(
+    uint256 indexed rulesetId,
+    uint256 indexed rulesetCycleNumber,
+    uint256 indexed projectId,
+    address beneficiary,
+    address feeBeneficiary,
+    uint256 amount,
+    uint256 amountPaidOut,
+    uint256 netAmountPaidOut,
+    string memo,
+    address caller
+);
+```
+

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

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

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

@@ -0,0 +1,74 @@
+# IJBPermissions
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBPermissions.sol)
+
+
+## Functions
+### WILDCARD_PROJECT_ID
+
+
+```solidity
+function WILDCARD_PROJECT_ID() external view returns (uint256);
+```
+
+### permissionsOf
+
+
+```solidity
+function permissionsOf(address operator, address account, uint256 projectId) external view returns (uint256);
+```
+
+### hasPermission
+
+
+```solidity
+function hasPermission(
+    address operator,
+    address account,
+    uint256 projectId,
+    uint256 permissionId,
+    bool includeRoot,
+    bool includeWildcardProjectId
+)
+    external
+    view
+    returns (bool);
+```
+
+### hasPermissions
+
+
+```solidity
+function hasPermissions(
+    address operator,
+    address account,
+    uint256 projectId,
+    uint256[] calldata permissionIds,
+    bool includeRoot,
+    bool includeWildcardProjectId
+)
+    external
+    view
+    returns (bool);
+```
+
+### setPermissionsFor
+
+
+```solidity
+function setPermissionsFor(address account, JBPermissionsData calldata permissionsData) external;
+```
+
+## Events
+### OperatorPermissionsSet
+
+```solidity
+event OperatorPermissionsSet(
+    address indexed operator,
+    address indexed account,
+    uint256 indexed projectId,
+    uint8[] permissionIds,
+    uint256 packed,
+    address caller
+);
+```
+

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

@@ -0,0 +1,15 @@
+# IJBPermitTerminal
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBPermitTerminal.sol)
+
+**Inherits:**
+[IJBTerminal](/src/interfaces/IJBTerminal.sol/interface.IJBTerminal.md)
+
+
+## Functions
+### PERMIT2
+
+
+```solidity
+function PERMIT2() external returns (IPermit2);
+```
+

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

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

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

@@ -0,0 +1,74 @@
+# IJBPrices
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBPrices.sol)
+
+
+## Functions
+### DEFAULT_PROJECT_ID
+
+
+```solidity
+function DEFAULT_PROJECT_ID() external view returns (uint256);
+```
+
+### PROJECTS
+
+
+```solidity
+function PROJECTS() external view returns (IJBProjects);
+```
+
+### priceFeedFor
+
+
+```solidity
+function priceFeedFor(
+    uint256 projectId,
+    uint256 pricingCurrency,
+    uint256 unitCurrency
+)
+    external
+    view
+    returns (IJBPriceFeed);
+```
+
+### pricePerUnitOf
+
+
+```solidity
+function pricePerUnitOf(
+    uint256 projectId,
+    uint256 pricingCurrency,
+    uint256 unitCurrency,
+    uint256 decimals
+)
+    external
+    view
+    returns (uint256);
+```
+
+### addPriceFeedFor
+
+
+```solidity
+function addPriceFeedFor(
+    uint256 projectId,
+    uint256 pricingCurrency,
+    uint256 unitCurrency,
+    IJBPriceFeed feed
+)
+    external;
+```
+
+## Events
+### AddPriceFeed
+
+```solidity
+event AddPriceFeed(
+    uint256 indexed projectId,
+    uint256 indexed pricingCurrency,
+    uint256 indexed unitCurrency,
+    IJBPriceFeed feed,
+    address caller
+);
+```
+

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

@@ -0,0 +1,19 @@
+# IJBProjectUriRegistry
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBProjectUriRegistry.sol)
+
+
+## Functions
+### uriOf
+
+
+```solidity
+function uriOf(uint256 projectId) external view returns (string memory);
+```
+
+### setUriOf
+
+
+```solidity
+function setUriOf(uint256 projectId, string calldata uri) external;
+```
+

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

@@ -0,0 +1,49 @@
+# IJBProjects
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBProjects.sol)
+
+**Inherits:**
+IERC721
+
+
+## Functions
+### count
+
+
+```solidity
+function count() external view returns (uint256);
+```
+
+### tokenUriResolver
+
+
+```solidity
+function tokenUriResolver() external view returns (IJBTokenUriResolver);
+```
+
+### createFor
+
+
+```solidity
+function createFor(address owner) external returns (uint256 projectId);
+```
+
+### setTokenUriResolver
+
+
+```solidity
+function setTokenUriResolver(IJBTokenUriResolver resolver) external;
+```
+
+## Events
+### Create
+
+```solidity
+event Create(uint256 indexed projectId, address indexed owner, address caller);
+```
+
+### SetTokenUriResolver
+
+```solidity
+event SetTokenUriResolver(IJBTokenUriResolver indexed resolver, address caller);
+```
+

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

@@ -0,0 +1,35 @@
+# IJBRulesetApprovalHook
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBRulesetApprovalHook.sol)
+
+**Inherits:**
+IERC165
+
+`IJBRulesetApprovalHook`s are used to determine whether the next ruleset in the ruleset queue is approved or
+rejected.
+
+*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.*
+
+
+## Functions
+### DURATION
+
+
+```solidity
+function DURATION() external view returns (uint256);
+```
+
+### approvalStatusOf
+
+
+```solidity
+function approvalStatusOf(
+    uint256 projectId,
+    uint256 rulesetId,
+    uint256 start
+)
+    external
+    view
+    returns (JBApprovalStatus);
+```
+

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

@@ -0,0 +1,97 @@
+# IJBRulesetDataHook
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBRulesetDataHook.sol)
+
+**Inherits:**
+IERC165
+
+Data hooks can extend a terminal's core pay/cashout functionality by overriding the weight or memo. They can
+also specify pay/cashout hooks for the terminal to fulfill, or allow addresses to mint a project's tokens on-demand.
+
+*If a project's ruleset has `useDataHookForPay` or `useDataHookForCashOut` enabled, its `dataHook` is called by
+the terminal upon payments/cashouts (respectively).*
+
+
+## Functions
+### hasMintPermissionFor
+
+A flag indicating whether an address has permission to mint a project's tokens on-demand.
+
+*A project's data hook can allow any address to mint its tokens.*
+
+
+```solidity
+function hasMintPermissionFor(uint256 projectId, address addr) external view returns (bool flag);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project whose token can be minted.|
+|`addr`|`address`|The address to check the token minting permission of.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`flag`|`bool`|A flag indicating whether the address has permission to mint the project's tokens on-demand.|
+
+
+### beforePayRecordedWith
+
+The data calculated before a payment is recorded in the terminal store. This data is provided to the
+terminal's `pay(...)` transaction.
+
+
+```solidity
+function beforePayRecordedWith(JBBeforePayRecordedContext calldata context)
+    external
+    view
+    returns (uint256 weight, JBPayHookSpecification[] memory hookSpecifications);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`context`|`JBBeforePayRecordedContext`|The context passed to this data hook by the `pay(...)` function as a `JBBeforePayRecordedContext` struct.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`weight`|`uint256`|The new `weight` to use, overriding the ruleset's `weight`.|
+|`hookSpecifications`|`JBPayHookSpecification[]`|The amount and data to send to pay hooks instead of adding to the terminal's balance.|
+
+
+### beforeCashOutRecordedWith
+
+The data calculated before a cash out is recorded in the terminal store. This data is provided to the
+terminal's `cashOutTokensOf(...)` transaction.
+
+
+```solidity
+function beforeCashOutRecordedWith(JBBeforeCashOutRecordedContext calldata context)
+    external
+    view
+    returns (
+        uint256 cashOutTaxRate,
+        uint256 cashOutCount,
+        uint256 totalSupply,
+        JBCashOutHookSpecification[] memory hookSpecifications
+    );
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`context`|`JBBeforeCashOutRecordedContext`|The context passed to this data hook by the `cashOutTokensOf(...)` function as a `JBBeforeCashOutRecordedContext` struct.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`cashOutTaxRate`|`uint256`|The rate determining the amount that should be reclaimable for a given surplus and token supply.|
+|`cashOutCount`|`uint256`|The amount of tokens that should be considered cashed out.|
+|`totalSupply`|`uint256`|The total amount of tokens that are considered to be existing.|
+|`hookSpecifications`|`JBCashOutHookSpecification[]`|The amount and data to send to cash out hooks instead of returning to the beneficiary.|
+
+