@bananapus/core-v6 0.0.1

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

@@ -0,0 +1,151 @@
+# IJBTokens
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBTokens.sol)
+
+
+## Functions
+### creditBalanceOf
+
+
+```solidity
+function creditBalanceOf(address holder, uint256 projectId) external view returns (uint256);
+```
+
+### projectIdOf
+
+
+```solidity
+function projectIdOf(IJBToken token) external view returns (uint256);
+```
+
+### tokenOf
+
+
+```solidity
+function tokenOf(uint256 projectId) external view returns (IJBToken);
+```
+
+### totalCreditSupplyOf
+
+
+```solidity
+function totalCreditSupplyOf(uint256 projectId) external view returns (uint256);
+```
+
+### totalBalanceOf
+
+
+```solidity
+function totalBalanceOf(address holder, uint256 projectId) external view returns (uint256 result);
+```
+
+### totalSupplyOf
+
+
+```solidity
+function totalSupplyOf(uint256 projectId) external view returns (uint256);
+```
+
+### burnFrom
+
+
+```solidity
+function burnFrom(address holder, uint256 projectId, uint256 count) external;
+```
+
+### claimTokensFor
+
+
+```solidity
+function claimTokensFor(address holder, uint256 projectId, uint256 count, address beneficiary) external;
+```
+
+### deployERC20For
+
+
+```solidity
+function deployERC20For(
+    uint256 projectId,
+    string calldata name,
+    string calldata symbol,
+    bytes32 salt
+)
+    external
+    returns (IJBToken token);
+```
+
+### mintFor
+
+
+```solidity
+function mintFor(address holder, uint256 projectId, uint256 count) external returns (IJBToken token);
+```
+
+### setTokenFor
+
+
+```solidity
+function setTokenFor(uint256 projectId, IJBToken token) external;
+```
+
+### transferCreditsFrom
+
+
+```solidity
+function transferCreditsFrom(address holder, uint256 projectId, address recipient, uint256 count) external;
+```
+
+## Events
+### DeployERC20
+
+```solidity
+event DeployERC20(
+    uint256 indexed projectId, IJBToken indexed token, string name, string symbol, bytes32 salt, address caller
+);
+```
+
+### Burn
+
+```solidity
+event Burn(
+    address indexed holder,
+    uint256 indexed projectId,
+    uint256 count,
+    uint256 creditBalance,
+    uint256 tokenBalance,
+    address caller
+);
+```
+
+### ClaimTokens
+
+```solidity
+event ClaimTokens(
+    address indexed holder,
+    uint256 indexed projectId,
+    uint256 creditBalance,
+    uint256 count,
+    address beneficiary,
+    address caller
+);
+```
+
+### Mint
+
+```solidity
+event Mint(address indexed holder, uint256 indexed projectId, uint256 count, bool tokensWereClaimed, address caller);
+```
+
+### SetToken
+
+```solidity
+event SetToken(uint256 indexed projectId, IJBToken indexed token, address caller);
+```
+
+### TransferCredits
+
+```solidity
+event TransferCredits(
+    address indexed holder, uint256 indexed projectId, address indexed recipient, uint256 count, address caller
+);
+```
+

package/docs/src/src/interfaces/README.md

@@ -0,0 +1,33 @@
+
+
+# Contents
+- [IJBCashOutHook](IJBCashOutHook.sol/interface.IJBCashOutHook.md)
+- [IJBCashOutTerminal](IJBCashOutTerminal.sol/interface.IJBCashOutTerminal.md)
+- [IJBControlled](IJBControlled.sol/interface.IJBControlled.md)
+- [IJBController](IJBController.sol/interface.IJBController.md)
+- [IJBDirectory](IJBDirectory.sol/interface.IJBDirectory.md)
+- [IJBDirectoryAccessControl](IJBDirectoryAccessControl.sol/interface.IJBDirectoryAccessControl.md)
+- [IJBFeeTerminal](IJBFeeTerminal.sol/interface.IJBFeeTerminal.md)
+- [IJBFeelessAddresses](IJBFeelessAddresses.sol/interface.IJBFeelessAddresses.md)
+- [IJBFundAccessLimits](IJBFundAccessLimits.sol/interface.IJBFundAccessLimits.md)
+- [IJBMigratable](IJBMigratable.sol/interface.IJBMigratable.md)
+- [IJBMultiTerminal](IJBMultiTerminal.sol/interface.IJBMultiTerminal.md)
+- [IJBPayHook](IJBPayHook.sol/interface.IJBPayHook.md)
+- [IJBPayoutTerminal](IJBPayoutTerminal.sol/interface.IJBPayoutTerminal.md)
+- [IJBPermissioned](IJBPermissioned.sol/interface.IJBPermissioned.md)
+- [IJBPermissions](IJBPermissions.sol/interface.IJBPermissions.md)
+- [IJBPermitTerminal](IJBPermitTerminal.sol/interface.IJBPermitTerminal.md)
+- [IJBPriceFeed](IJBPriceFeed.sol/interface.IJBPriceFeed.md)
+- [IJBPrices](IJBPrices.sol/interface.IJBPrices.md)
+- [IJBProjectUriRegistry](IJBProjectUriRegistry.sol/interface.IJBProjectUriRegistry.md)
+- [IJBProjects](IJBProjects.sol/interface.IJBProjects.md)
+- [IJBRulesetApprovalHook](IJBRulesetApprovalHook.sol/interface.IJBRulesetApprovalHook.md)
+- [IJBRulesetDataHook](IJBRulesetDataHook.sol/interface.IJBRulesetDataHook.md)
+- [IJBRulesets](IJBRulesets.sol/interface.IJBRulesets.md)
+- [IJBSplitHook](IJBSplitHook.sol/interface.IJBSplitHook.md)
+- [IJBSplits](IJBSplits.sol/interface.IJBSplits.md)
+- [IJBTerminal](IJBTerminal.sol/interface.IJBTerminal.md)
+- [IJBTerminalStore](IJBTerminalStore.sol/interface.IJBTerminalStore.md)
+- [IJBToken](IJBToken.sol/interface.IJBToken.md)
+- [IJBTokenUriResolver](IJBTokenUriResolver.sol/interface.IJBTokenUriResolver.md)
+- [IJBTokens](IJBTokens.sol/interface.IJBTokens.md)

package/docs/src/src/libraries/JBCashOuts.sol/library.JBCashOuts.md

@@ -0,0 +1,40 @@
+# JBCashOuts
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/libraries/JBCashOuts.sol)
+
+Cash out calculations.
+
+
+## Functions
+### cashOutFrom
+
+Returns the amount of surplus terminal tokens which can be reclaimed based on the total surplus, the
+number of tokens being cashed out, the total token supply, and the ruleset's cash out tax rate.
+
+
+```solidity
+function cashOutFrom(
+    uint256 surplus,
+    uint256 cashOutCount,
+    uint256 totalSupply,
+    uint256 cashOutTaxRate
+)
+    internal
+    pure
+    returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`surplus`|`uint256`|The total amount of surplus terminal tokens.|
+|`cashOutCount`|`uint256`|The number of tokens being cashed out, as a fixed point number with 18 decimals.|
+|`totalSupply`|`uint256`|The total token supply, as a fixed point number with 18 decimals.|
+|`cashOutTaxRate`|`uint256`|The current ruleset's cash out tax rate.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|reclaimableSurplus The amount of surplus tokens that can be reclaimed.|
+
+

package/docs/src/src/libraries/JBConstants.sol/library.JBConstants.md

@@ -0,0 +1,52 @@
+# JBConstants
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/libraries/JBConstants.sol)
+
+Global constants used across Juicebox contracts.
+
+
+## State Variables
+### NATIVE_TOKEN
+Each chain's native token address in Juicebox is represented by
+0x000000000000000000000000000000000000EEEe.
+
+
+```solidity
+address public constant NATIVE_TOKEN = address(0x000000000000000000000000000000000000EEEe);
+```
+
+
+### MAX_RESERVED_PERCENT
+
+```solidity
+uint16 public constant MAX_RESERVED_PERCENT = 10_000;
+```
+
+
+### MAX_CASH_OUT_TAX_RATE
+
+```solidity
+uint16 public constant MAX_CASH_OUT_TAX_RATE = 10_000;
+```
+
+
+### MAX_WEIGHT_CUT_PERCENT
+
+```solidity
+uint32 public constant MAX_WEIGHT_CUT_PERCENT = 1_000_000_000;
+```
+
+
+### SPLITS_TOTAL_PERCENT
+
+```solidity
+uint32 public constant SPLITS_TOTAL_PERCENT = 1_000_000_000;
+```
+
+
+### MAX_FEE
+
+```solidity
+uint16 public constant MAX_FEE = 1000;
+```
+
+

package/docs/src/src/libraries/JBCurrencyIds.sol/library.JBCurrencyIds.md

@@ -0,0 +1,19 @@
+# JBCurrencyIds
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/libraries/JBCurrencyIds.sol)
+
+
+## State Variables
+### ETH
+
+```solidity
+uint32 public constant ETH = 1;
+```
+
+
+### USD
+
+```solidity
+uint32 public constant USD = 2;
+```
+
+

package/docs/src/src/libraries/JBFees.sol/library.JBFees.md

@@ -0,0 +1,52 @@
+# JBFees
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/libraries/JBFees.sol)
+
+Fee calculations.
+
+
+## Functions
+### feeAmountResultingIn
+
+Returns the amount of tokens to pay as a fee relative to the specified `amount`.
+
+
+```solidity
+function feeAmountResultingIn(uint256 amountAfterFee, uint256 feePercent) internal pure returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`amountAfterFee`|`uint256`|The amount that the fee is based on, as a fixed point number.|
+|`feePercent`|`uint256`|The fee percent, out of `JBConstants.MAX_FEE`.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The amount of tokens to pay as a fee, as a fixed point number with the same number of decimals as the provided `amount`.|
+
+
+### feeAmountFrom
+
+Returns the fee that would have been paid based on an `amount` which has already had the fee subtracted
+from it.
+
+
+```solidity
+function feeAmountFrom(uint256 amountBeforeFee, uint256 feePercent) internal pure returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`amountBeforeFee`|`uint256`|The amount that the fee is based on, as a fixed point number with the same amount of decimals as this terminal.|
+|`feePercent`|`uint256`|The fee percent, out of `JBConstants.MAX_FEE`.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The amount of the fee, as a fixed point number with the same amount of decimals as this terminal.|
+
+

package/docs/src/src/libraries/JBFixedPointNumber.sol/library.JBFixedPointNumber.md

@@ -0,0 +1,12 @@
+# JBFixedPointNumber
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/libraries/JBFixedPointNumber.sol)
+
+
+## Functions
+### adjustDecimals
+
+
+```solidity
+function adjustDecimals(uint256 value, uint256 decimals, uint256 targetDecimals) internal pure returns (uint256);
+```
+

package/docs/src/src/libraries/JBMetadataResolver.sol/library.JBMetadataResolver.md

@@ -0,0 +1,242 @@
+# JBMetadataResolver
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/libraries/JBMetadataResolver.sol)
+
+Library to parse and create metadata to store {id: data} entries.
+
+*Metadata are built as:
+- 32B of reserved space for the protocol
+- a lookup table `Id: offset`, defining the offset of the data for a given 4 bytes id.
+The offset fits 1 bytes, the ID 4 bytes. This table is padded to 32B.
+- the data for each id, padded to 32B each
++-----------------------+ offset: 0
+| 32B reserved          |
++-----------------------+ offset: 1 = end of first 32B
+|      (ID1,offset1)    |
+|      (ID2,offset2)    |
+|       0's padding     |
++-----------------------+ offset: offset1 = 1 + number of words taken by the padded table
+|       id1 data1       |
+| 0's padding           |
++-----------------------+ offset: offset2 = offset1 + number of words taken by the data1
+|       id2 data2       |
+| 0's padding           |
++-----------------------+*
+
+
+## State Variables
+### ID_SIZE
+
+```solidity
+uint256 constant ID_SIZE = 4;
+```
+
+
+### ID_OFFSET_SIZE
+
+```solidity
+uint256 constant ID_OFFSET_SIZE = 1;
+```
+
+
+### WORD_SIZE
+
+```solidity
+uint256 constant WORD_SIZE = 32;
+```
+
+
+### TOTAL_ID_SIZE
+
+```solidity
+uint256 constant TOTAL_ID_SIZE = 5;
+```
+
+
+### NEXT_ID_OFFSET
+
+```solidity
+uint256 constant NEXT_ID_OFFSET = 9;
+```
+
+
+### RESERVED_SIZE
+
+```solidity
+uint256 constant RESERVED_SIZE = 32;
+```
+
+
+### MIN_METADATA_LENGTH
+
+```solidity
+uint256 constant MIN_METADATA_LENGTH = 37;
+```
+
+
+## Functions
+### addToMetadata
+
+Add an {id: data} entry to an existing metadata. This is an append-only mechanism.
+
+
+```solidity
+function addToMetadata(
+    bytes memory originalMetadata,
+    bytes4 idToAdd,
+    bytes memory dataToAdd
+)
+    internal
+    pure
+    returns (bytes memory newMetadata);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`originalMetadata`|`bytes`|The original metadata|
+|`idToAdd`|`bytes4`|The id to add|
+|`dataToAdd`|`bytes`|The data to add|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`newMetadata`|`bytes`|The new metadata with the entry added|
+
+
+### createMetadata
+
+Create the metadata for a list of {id:data}
+
+*Intended for offchain use (gas heavy)*
+
+
+```solidity
+function createMetadata(bytes4[] memory ids, bytes[] memory datas) internal pure returns (bytes memory metadata);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`ids`|`bytes4[]`|The list of ids|
+|`datas`|`bytes[]`|The list of corresponding datas|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`metadata`|`bytes`|The resulting metadata|
+
+
+### getDataFor
+
+Parse the metadata to find the data for a specific ID
+
+*Returns false and an empty bytes if no data is found*
+
+
+```solidity
+function getDataFor(bytes4 id, bytes memory metadata) internal pure returns (bool found, bytes memory targetData);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`id`|`bytes4`|The ID to find.|
+|`metadata`|`bytes`|The metadata to parse.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`found`|`bool`|Whether the {id:data} was found|
+|`targetData`|`bytes`|The data for the ID (can be empty)|
+
+
+### getId
+
+Returns an unique id following a suggested format (`xor(address(this), purpose name)` where purpose name
+is a string giving context to the id (Permit2, quoteForSwap, etc)
+
+
+```solidity
+function getId(string memory purpose) internal view returns (bytes4);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`purpose`|`string`|A string describing the purpose associated with the id|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes4`|id The resulting ID.|
+
+
+### getId
+
+Returns an unique id following a suggested format (`xor(address(this), purpose name)` where purpose name
+is a string giving context to the id (Permit2, quoteForSwap, etc)
+
+
+```solidity
+function getId(string memory purpose, address target) internal pure returns (bytes4);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`purpose`|`string`|A string describing the purpose associated with the id|
+|`target`|`address`|The target which will use the metadata|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes4`|id The resulting ID.|
+
+
+### _sliceBytes
+
+Slice bytes from a start index to an end index.
+
+
+```solidity
+function _sliceBytes(bytes memory data, uint256 start, uint256 end) private pure returns (bytes memory slicedBytes);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`data`|`bytes`|The bytes array to slice|
+|`start`|`uint256`|The start index to slice at.|
+|`end`|`uint256`|The end index to slice at.|
+
+
+## Errors
+### JBMetadataResolver_DataNotPadded
+
+```solidity
+error JBMetadataResolver_DataNotPadded();
+```
+
+### JBMetadataResolver_LengthMismatch
+
+```solidity
+error JBMetadataResolver_LengthMismatch();
+```
+
+### JBMetadataResolver_MetadataTooLong
+
+```solidity
+error JBMetadataResolver_MetadataTooLong();
+```
+
+### JBMetadataResolver_MetadataTooShort
+
+```solidity
+error JBMetadataResolver_MetadataTooShort();
+```
+