@bananapus/core-v6 0.0.1

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

@@ -0,0 +1,199 @@
+# JBPermissions
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/JBPermissions.sol)
+
+**Inherits:**
+[IJBPermissions](/src/interfaces/IJBPermissions.sol/interface.IJBPermissions.md)
+
+Stores permissions for all addresses and operators. Addresses can give permissions to any other address
+(i.e. an *operator*) to execute specific operations on their behalf.
+
+
+## State Variables
+### WILDCARD_PROJECT_ID
+The project ID considered a wildcard, meaning it will grant permissions to all projects.
+
+
+```solidity
+uint256 public constant override WILDCARD_PROJECT_ID = 0;
+```
+
+
+### permissionsOf
+The permissions that an operator has been given by an account for a specific project.
+
+*An account can give an operator permissions that only pertain to a specific project ID.*
+
+*There is no project with a ID of 0 – this ID is a wildcard which gives an operator permissions pertaining
+to *all* project IDs on an account's behalf. Use this with caution.*
+
+*Permissions are stored in a packed `uint256`. Each of the 256 bits represents the on/off state of a
+permission. Applications can specify the significance of each permission ID.*
+
+
+```solidity
+mapping(address operator => mapping(address account => mapping(uint256 projectId => uint256))) public override
+    permissionsOf;
+```
+
+
+## Functions
+### hasPermission
+
+Check if an operator has a specific permission for a specific address and project ID.
+
+
+```solidity
+function hasPermission(
+    address operator,
+    address account,
+    uint256 projectId,
+    uint256 permissionId,
+    bool includeRoot,
+    bool includeWildcardProjectId
+)
+    public
+    view
+    override
+    returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`operator`|`address`|The operator to check.|
+|`account`|`address`|The account being operated on behalf of.|
+|`projectId`|`uint256`|The project ID that the operator has permission to operate under. 0 represents all projects.|
+|`permissionId`|`uint256`|The permission ID to check for.|
+|`includeRoot`|`bool`|A flag indicating if the return value should default to true if the operator has the ROOT permission.|
+|`includeWildcardProjectId`|`bool`|A flag indicating if the return value should return true if the operator has the specified permission on the wildcard project ID.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bool`|A flag indicating whether the operator has the specified permission.|
+
+
+### hasPermissions
+
+Check if an operator has all of the specified permissions for a specific address and project ID.
+
+
+```solidity
+function hasPermissions(
+    address operator,
+    address account,
+    uint256 projectId,
+    uint256[] calldata permissionIds,
+    bool includeRoot,
+    bool includeWildcardProjectId
+)
+    external
+    view
+    override
+    returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`operator`|`address`|The operator to check.|
+|`account`|`address`|The account being operated on behalf of.|
+|`projectId`|`uint256`|The project ID that the operator has permission to operate under. 0 represents all projects.|
+|`permissionIds`|`uint256[]`|An array of permission IDs to check for.|
+|`includeRoot`|`bool`|A flag indicating if the return value should default to true if the operator has the ROOT permission.|
+|`includeWildcardProjectId`|`bool`|A flag indicating if the return value should return true if the operator has the specified permission on the wildcard project ID.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bool`|A flag indicating whether the operator has all specified permissions.|
+
+
+### _includesPermission
+
+Checks if a permission is included in a packed permissions data.
+
+
+```solidity
+function _includesPermission(uint256 permissions, uint256 permissionId) internal pure returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`permissions`|`uint256`|The packed permissions to check.|
+|`permissionId`|`uint256`|The ID of the permission to check for.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bool`|A flag indicating whether the permission is included.|
+
+
+### _packedPermissions
+
+Converts an array of permission IDs to a packed `uint256`.
+
+
+```solidity
+function _packedPermissions(uint8[] calldata permissionIds) internal pure returns (uint256 packed);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`permissionIds`|`uint8[]`|The IDs of the permissions to pack.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`packed`|`uint256`|The packed value.|
+
+
+### setPermissionsFor
+
+Sets permissions for an operator.
+
+*Only an address can give permissions to or revoke permissions from its operators.*
+
+
+```solidity
+function setPermissionsFor(address account, JBPermissionsData calldata permissionsData) external override;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`account`|`address`|The account setting its operators' permissions.|
+|`permissionsData`|`JBPermissionsData`|The data which specifies the permissions the operator is being given.|
+
+
+## Errors
+### JBPermissions_CantSetRootPermissionForWildcardProject
+
+```solidity
+error JBPermissions_CantSetRootPermissionForWildcardProject();
+```
+
+### JBPermissions_NoZeroPermission
+
+```solidity
+error JBPermissions_NoZeroPermission();
+```
+
+### JBPermissions_PermissionIdOutOfBounds
+
+```solidity
+error JBPermissions_PermissionIdOutOfBounds(uint256 permissionId);
+```
+
+### JBPermissions_Unauthorized
+
+```solidity
+error JBPermissions_Unauthorized();
+```
+

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

@@ -0,0 +1,154 @@
+# JBPrices
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/JBPrices.sol)
+
+**Inherits:**
+[JBControlled](/src/abstract/JBControlled.sol/abstract.JBControlled.md), [JBPermissioned](/src/abstract/JBPermissioned.sol/abstract.JBPermissioned.md), Ownable, [IJBPrices](/src/interfaces/IJBPrices.sol/interface.IJBPrices.md)
+
+Manages and normalizes price feeds. Price feeds are contracts which return the "pricing currency" cost of 1
+"unit currency".
+
+
+## State Variables
+### DEFAULT_PROJECT_ID
+The ID to store default values in.
+
+
+```solidity
+uint256 public constant override DEFAULT_PROJECT_ID = 0;
+```
+
+
+### PROJECTS
+Mints ERC-721s that represent project ownership and transfers.
+
+
+```solidity
+IJBProjects public immutable override PROJECTS;
+```
+
+
+### priceFeedFor
+The available price feeds.
+
+*The feed returns the `pricingCurrency` cost for one unit of the `unitCurrency`.*
+
+
+```solidity
+mapping(uint256 projectId => mapping(uint256 pricingCurrency => mapping(uint256 unitCurrency => IJBPriceFeed)))
+    public
+    override priceFeedFor;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(
+    IJBDirectory directory,
+    IJBPermissions permissions,
+    IJBProjects projects,
+    address owner
+)
+    JBControlled(directory)
+    JBPermissioned(permissions)
+    Ownable(owner);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`directory`|`IJBDirectory`|A contract storing directories of terminals and controllers for each project.|
+|`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.|
+
+
+### pricePerUnitOf
+
+Gets the `pricingCurrency` cost for one unit of the `unitCurrency`.
+
+
+```solidity
+function pricePerUnitOf(
+    uint256 projectId,
+    uint256 pricingCurrency,
+    uint256 unitCurrency,
+    uint256 decimals
+)
+    public
+    view
+    override
+    returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project to check the feed for. Feeds stored in ID 0 are used by default for all projects.|
+|`pricingCurrency`|`uint256`|The currency the feed's resulting price is in terms of.|
+|`unitCurrency`|`uint256`|The currency being priced by the feed.|
+|`decimals`|`uint256`|The number of decimals the returned fixed point price should include.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The `pricingCurrency` price of 1 `unitCurrency`, as a fixed point number with the specified number of decimals.|
+
+
+### addPriceFeedFor
+
+Add a price feed for the `unitCurrency`, priced in terms of the `pricingCurrency`.
+
+*Price feeds can only be added, not modified or removed.*
+
+*This contract's owner can add protocol-wide default price feed by passing a `projectId` of 0.*
+
+
+```solidity
+function addPriceFeedFor(
+    uint256 projectId,
+    uint256 pricingCurrency,
+    uint256 unitCurrency,
+    IJBPriceFeed feed
+)
+    external
+    override;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project to add a feed for. If `projectId` is 0, add a protocol-wide default price feed.|
+|`pricingCurrency`|`uint256`|The currency the feed's output price is in terms of.|
+|`unitCurrency`|`uint256`|The currency being priced by the feed.|
+|`feed`|`IJBPriceFeed`|The address of the price feed to add.|
+
+
+## Errors
+### JBPrices_PriceFeedAlreadyExists
+
+```solidity
+error JBPrices_PriceFeedAlreadyExists(IJBPriceFeed feed);
+```
+
+### JBPrices_PriceFeedNotFound
+
+```solidity
+error JBPrices_PriceFeedNotFound();
+```
+
+### JBPrices_ZeroPricingCurrency
+
+```solidity
+error JBPrices_ZeroPricingCurrency();
+```
+
+### JBPrices_ZeroUnitCurrency
+
+```solidity
+error JBPrices_ZeroUnitCurrency();
+```
+

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

@@ -0,0 +1,131 @@
+# JBProjects
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/JBProjects.sol)
+
+**Inherits:**
+ERC721, Ownable, [IJBProjects](/src/interfaces/IJBProjects.sol/interface.IJBProjects.md)
+
+Stores project ownership and metadata.
+
+*Projects are represented as ERC-721s.*
+
+
+## State Variables
+### count
+The number of projects that have been created using this contract.
+
+*The count is incremented with each new project created.*
+
+*The resulting ERC-721 token ID for each project is the newly incremented count value.*
+
+
+```solidity
+uint256 public override count;
+```
+
+
+### tokenUriResolver
+The contract resolving each project ID to its ERC721 URI.
+
+
+```solidity
+IJBTokenUriResolver public override tokenUriResolver;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(address owner, address feeProjectOwner) ERC721("Juicebox Projects", "JUICEBOX") Ownable(owner);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`owner`|`address`|The owner of the contract who can set metadata.|
+|`feeProjectOwner`|`address`|The address that will receive the fee-project. If `address(0)` the fee-project will not be minted.|
+
+
+### supportsInterface
+
+Indicates whether this contract adheres to the specified interface.
+
+*See [IERC165-supportsInterface](/src/JBFeelessAddresses.sol/contract.JBFeelessAddresses.md#supportsinterface).*
+
+
+```solidity
+function supportsInterface(bytes4 interfaceId) public view virtual override(IERC165, ERC721) 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.|
+
+
+### tokenURI
+
+Returns the URI where the ERC-721 standard JSON of a project is hosted.
+
+
+```solidity
+function tokenURI(uint256 projectId) public view override returns (string memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project to get a URI of.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`string`|The token URI to use for the provided `projectId`.|
+
+
+### setTokenUriResolver
+
+Sets the address of the resolver used to retrieve the tokenURI of projects.
+
+
+```solidity
+function setTokenUriResolver(IJBTokenUriResolver resolver) external override onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`resolver`|`IJBTokenUriResolver`|The address of the new resolver.|
+
+
+### createFor
+
+Create a new project for the specified owner, which mints an NFT (ERC-721) into their wallet.
+
+*Anyone can create a project on an owner's behalf.*
+
+
+```solidity
+function createFor(address owner) public override returns (uint256 projectId);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`owner`|`address`|The address that will be the owner of the project.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The token ID of the newly created project.|
+
+