@bananapus/ownable-v6 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Bananapus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,51 @@
+# nana-ownable-v6
+
+Juicebox-aware ownership model that ties contract ownership to a Juicebox project NFT or an address, with delegated access through `JBPermissions`.
+
+This is a variation on OpenZeppelin [`Ownable`](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/access/Ownable.sol) that adds:
+
+- The ability to transfer contract ownership to a Juicebox project instead of a specific address.
+- The ability to grant other addresses `onlyOwner` access using `JBPermissions`.
+- `JBPermissioned` modifiers with support for OpenZeppelin `Context` (enabling optional meta-transaction support).
+
+All features are backwards compatible with OpenZeppelin `Ownable`. This should be a drop-in replacement. Only use `JBOwnableOverrides` if you are overriding OpenZeppelin `Ownable` v4.7.0 or higher.
+
+Forked from [`jbx-protocol/juice-ownable`](https://github.com/jbx-protocol/juice-ownable).
+
+_If you have questions, take a look at the [core protocol contracts](https://github.com/Bananapus/nana-core) and the [documentation](https://docs.juicebox.money/) first, or reach out on [Discord](https://discord.com/invite/ErQYmth4dS)._
+
+## Architecture
+
+| Contract | Description |
+|----------|-------------|
+| `JBOwnable` | Concrete implementation providing an `onlyOwner` modifier and ownership transfer events. Inherits `JBOwnableOverrides`. |
+| `JBOwnableOverrides` | Abstract base containing all ownership logic: owner resolution, transfers, renunciation, and permission delegation via `JBPermissions`. |
+
+### Supporting Types
+
+| Type | Description |
+|------|-------------|
+| `JBOwner` | Struct packing `address owner`, `uint88 projectId`, and `uint8 permissionId` into a single slot. |
+| `IJBOwnable` | Interface exposing ownership queries, transfers, renunciation, and permission ID management. |
+
+### Ownership Modes
+
+1. **Project ownership** -- If `JBOwner.projectId` is nonzero, the holder of that `JBProjects` ERC-721 is the owner.
+2. **Address ownership** -- If `projectId` is zero, `JBOwner.owner` is the owner directly.
+3. **Delegated access** -- The owner can grant others access via `JBPermissions.setPermissionsFor(...)` using the configured `permissionId`.
+
+The `permissionId` resets to 0 on every ownership transfer to prevent permission clashes.
+
+## Install
+
+```bash
+npm install
+```
+
+## Develop
+
+| Command | Description |
+|---------|-------------|
+| `forge build` | Compile contracts |
+| `forge test` | Run tests |
+| `forge coverage --match-path "./src/*.sol" --report lcov --report summary` | Generate coverage report |

package/SKILLS.md

@@ -0,0 +1,62 @@
+# nana-ownable-v6
+
+## Purpose
+
+Drop-in Juicebox-aware replacement for OpenZeppelin `Ownable` that lets a contract be owned by a Juicebox project (via its ERC-721) or a plain address, with delegated access through `JBPermissions`.
+
+## Contracts
+
+| Contract | Role |
+|----------|------|
+| `JBOwnable` | Concrete modifier (`onlyOwner`) and event emission for ownership transfers. |
+| `JBOwnableOverrides` | Abstract base with ownership state, resolution, transfers, renunciation, and permission delegation. |
+
+## Key Functions
+
+| Function | Contract | What it does |
+|----------|----------|--------------|
+| `owner()` | `JBOwnableOverrides` | Returns the current owner address -- resolves project NFT holder if `projectId` is set. |
+| `transferOwnership(address)` | `JBOwnableOverrides` | Transfers ownership to a new address. Resets `permissionId`. |
+| `transferOwnershipToProject(uint256)` | `JBOwnableOverrides` | Transfers ownership to a Juicebox project. The project NFT holder becomes owner. |
+| `renounceOwnership()` | `JBOwnableOverrides` | Permanently gives up ownership (sets owner to zero address, projectId to 0). |
+| `setPermissionId(uint8)` | `JBOwnableOverrides` | Changes which `JBPermissions` permission ID grants delegated owner access. |
+| `_checkOwner()` | `JBOwnableOverrides` | Internal view used by `onlyOwner`; calls `_requirePermissionFrom` against the resolved owner. |
+
+## Integration Points
+
+| Dependency | Import | Used For |
+|------------|--------|----------|
+| `nana-core-v6` | `IJBPermissions`, `JBPermissioned` | Permission checks for delegated access |
+| `nana-core-v6` | `IJBProjects` | Resolving project NFT holder as owner |
+| `@openzeppelin/contracts` | `Context` | `_msgSender()` support |
+
+## Key Types
+
+| Struct/Enum | Key Fields | Used In |
+|-------------|------------|---------|
+| `JBOwner` | `address owner`, `uint88 projectId`, `uint8 permissionId` | `JBOwnableOverrides.jbOwner` -- single storage slot (160+88+8=256 bits) |
+
+## Gotchas
+
+- You cannot set both `owner` and `projectId` to nonzero values simultaneously -- `_transferOwnership` reverts with `JBOwnableOverrides_InvalidNewOwner`.
+- Constructor reverts if both `initialOwner` and `initialProjectIdOwner` are zero. To create an unowned contract, set an owner then call `renounceOwnership()` in the constructor body.
+- `_transferOwnership` resets `permissionId` to 0 on every transfer, which revokes all previously delegated access.
+- `projectId` is `uint88`, so project IDs above `type(uint88).max` are rejected by `transferOwnershipToProject`.
+
+## Example Integration
+
+```solidity
+import {JBOwnable} from "@bananapus/ownable-v6/src/JBOwnable.sol";
+
+contract MyHook is JBOwnable {
+    constructor(
+        IJBPermissions permissions,
+        IJBProjects projects,
+        uint88 projectId
+    ) JBOwnable(permissions, projects, address(0), projectId) {}
+
+    function restrictedAction() external onlyOwner {
+        // Only the project NFT holder (or delegated addresses) can call this.
+    }
+}
+```

package/docs/book.css

@@ -0,0 +1,13 @@
+table {
+    margin: 0 auto;
+    border-collapse: collapse;
+    width: 100%;
+}
+
+table td:first-child {
+    width: 15%;
+}
+  
+table td:nth-child(2) {
+    width: 25%;
+}

package/docs/book.toml

@@ -0,0 +1,12 @@
+[book]
+src = "src"
+title = ""
+
+[output.html]
+no-section-label = true
+additional-js = ["solidity.min.js"]
+additional-css = ["book.css"]
+git-repository-url = "https://github.com/Bananapus/nana-ownable"
+
+[output.html.fold]
+enable = true

package/docs/solidity.min.js

@@ -0,0 +1,74 @@
+hljs.registerLanguage("solidity",(()=>{"use strict";function e(){try{return!0
+}catch(e){return!1}}
+var a=/-?(\b0[xX]([a-fA-F0-9]_?)*[a-fA-F0-9]|(\b[1-9](_?\d)*(\.((\d_?)*\d)?)?|\.\d(_?\d)*)([eE][-+]?\d(_?\d)*)?|\b0)(?!\w|\$)/
+;e()&&(a=a.source.replace(/\\b/g,"(?<!\\$)\\b"));var s={className:"number",
+begin:a,relevance:0},n={
+keyword:"assembly let function if switch case default for leave break continue u256 jump jumpi stop return revert selfdestruct invalid",
+built_in:"add sub mul div sdiv mod smod exp not lt gt slt sgt eq iszero and or xor byte shl shr sar addmod mulmod signextend keccak256 pc pop dup1 dup2 dup3 dup4 dup5 dup6 dup7 dup8 dup9 dup10 dup11 dup12 dup13 dup14 dup15 dup16 swap1 swap2 swap3 swap4 swap5 swap6 swap7 swap8 swap9 swap10 swap11 swap12 swap13 swap14 swap15 swap16 mload mstore mstore8 sload sstore msize gas address balance selfbalance caller callvalue calldataload calldatasize calldatacopy codesize codecopy extcodesize extcodecopy returndatasize returndatacopy extcodehash create create2 call callcode delegatecall staticcall log0 log1 log2 log3 log4 chainid origin gasprice basefee blockhash coinbase timestamp number difficulty gaslimit",
+literal:"true false"},i={className:"string",
+begin:/\bhex'(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?'/},t={className:"string",
+begin:/\bhex"(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?"/};function r(e){
+return e.inherit(e.APOS_STRING_MODE,{begin:/(\bunicode)?'/})}function l(e){
+return e.inherit(e.QUOTE_STRING_MODE,{begin:/(\bunicode)?"/})}var o={
+SOL_ASSEMBLY_KEYWORDS:n,baseAssembly:e=>{
+var a=r(e),o=l(e),c=/[A-Za-z_$][A-Za-z_$0-9.]*/,d=e.inherit(e.TITLE_MODE,{
+begin:/[A-Za-z$_][0-9A-Za-z$_]*/,lexemes:c,keywords:n}),u={className:"params",
+begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,lexemes:c,keywords:n,
+contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,o,s]},_={
+className:"operator",begin:/:=|->/};return{keywords:n,lexemes:c,
+contains:[a,o,i,t,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,s,_,{
+className:"function",lexemes:c,beginKeywords:"function",end:"{",excludeEnd:!0,
+contains:[d,u,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,_]}]}},
+solAposStringMode:r,solQuoteStringMode:l,HEX_APOS_STRING_MODE:i,
+HEX_QUOTE_STRING_MODE:t,SOL_NUMBER:s,isNegativeLookbehindAvailable:e}
+;const{baseAssembly:c,solAposStringMode:d,solQuoteStringMode:u,HEX_APOS_STRING_MODE:_,HEX_QUOTE_STRING_MODE:m,SOL_NUMBER:b,isNegativeLookbehindAvailable:E}=o
+;return e=>{for(var a=d(e),s=u(e),n=[],i=0;i<32;i++)n[i]=i+1
+;var t=n.map((e=>8*e)),r=[];for(i=0;i<=80;i++)r[i]=i
+;var l=n.map((e=>"bytes"+e)).join(" ")+" ",o=t.map((e=>"uint"+e)).join(" ")+" ",g=t.map((e=>"int"+e)).join(" ")+" ",M=[].concat.apply([],t.map((e=>r.map((a=>e+"x"+a))))),p={
+keyword:"var bool string int uint "+g+o+"byte bytes "+l+"fixed ufixed "+M.map((e=>"fixed"+e)).join(" ")+" "+M.map((e=>"ufixed"+e)).join(" ")+" enum struct mapping address new delete if else for while continue break return throw emit try catch revert unchecked _ function modifier event constructor fallback receive error virtual override constant immutable anonymous indexed storage memory calldata external public internal payable pure view private returns import from as using pragma contract interface library is abstract type assembly",
+literal:"true false wei gwei szabo finney ether seconds minutes hours days weeks years",
+built_in:"self this super selfdestruct suicide now msg block tx abi blockhash gasleft assert require Error Panic sha3 sha256 keccak256 ripemd160 ecrecover addmod mulmod log0 log1 log2 log3 log4"
+},O={className:"operator",begin:/[+\-!~*\/%<>&^|=]/
+},C=/[A-Za-z_$][A-Za-z_$0-9]*/,N={className:"params",begin:/\(/,end:/\)/,
+excludeBegin:!0,excludeEnd:!0,lexemes:C,keywords:p,
+contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,s,b,"self"]},f={
+begin:/\.\s*/,end:/[^A-Za-z0-9$_\.]/,excludeBegin:!0,excludeEnd:!0,keywords:{
+built_in:"gas value selector address length push pop send transfer call callcode delegatecall staticcall balance code codehash wrap unwrap name creationCode runtimeCode interfaceId min max"
+},relevance:2},y=e.inherit(e.TITLE_MODE,{begin:/[A-Za-z$_][0-9A-Za-z$_]*/,
+lexemes:C,keywords:p}),w={className:"built_in",
+begin:(E()?"(?<!\\$)\\b":"\\b")+"(gas|value|salt)(?=:)"};function x(e,a){return{
+begin:(E()?"(?<!\\$)\\b":"\\b")+e+"\\.\\s*",end:/[^A-Za-z0-9$_\.]/,
+excludeBegin:!1,excludeEnd:!0,lexemes:C,keywords:{built_in:e+" "+a},
+contains:[f],relevance:10}}var h=c(e),v=e.inherit(h,{
+contains:h.contains.concat([{begin:/\./,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,
+excludeEnd:!0,keywords:{built_in:"slot offset length address selector"},
+relevance:2},{begin:/_/,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,excludeEnd:!0,
+keywords:{built_in:"slot offset"},relevance:2}])});return{aliases:["sol"],
+keywords:p,lexemes:C,
+contains:[a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,b,w,O,{
+className:"function",lexemes:C,
+beginKeywords:"function modifier event constructor fallback receive error",
+end:/[{;]/,excludeEnd:!0,
+contains:[y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE],illegal:/%/
+},x("msg","gas value data sender sig"),x("block","blockhash coinbase difficulty gaslimit basefee number timestamp chainid"),x("tx","gasprice origin"),x("abi","decode encode encodePacked encodeWithSelector encodeWithSignature encodeCall"),x("bytes","concat"),f,{
+className:"class",lexemes:C,beginKeywords:"contract interface library",end:"{",
+excludeEnd:!0,illegal:/[:"\[\]]/,contains:[{beginKeywords:"is",lexemes:C
+},y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{lexemes:C,
+beginKeywords:"struct enum",end:"{",excludeEnd:!0,illegal:/[:"\[\]]/,
+contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{
+beginKeywords:"import",end:";",lexemes:C,keywords:"import from as",
+contains:[y,a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{
+beginKeywords:"using",end:";",lexemes:C,keywords:"using for",
+contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{className:"meta",
+beginKeywords:"pragma",end:";",lexemes:C,keywords:{
+keyword:"pragma solidity experimental abicoder",
+built_in:"ABIEncoderV2 SMTChecker v1 v2"},
+contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(a,{
+className:"meta-string"}),e.inherit(s,{className:"meta-string"})]},{
+beginKeywords:"assembly",end:/\b\B/,
+contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(v,{begin:"{",
+end:"}",endsParent:!0,contains:v.contains.concat([e.inherit(v,{begin:"{",
+end:"}",contains:v.contains.concat(["self"])})])})]}],illegal:/#/}}})());
+
+// Ugly hack to reload HLJS
+hljs.initHighlightingOnLoad();

package/docs/src/README.md

@@ -0,0 +1,131 @@
+# Bananapus Ownable
+
+A Bananapus variation on OpenZeppelin [`Ownable`](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/access/Ownable.sol) to enable owner-based access control incorporating Juicebox project ownership and `JBPermissions`.
+
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li><a href="#repository-layout">Repository Layout</a></li>
+    <li><a href="#usage">Usage</a></li>
+  <ul>
+    <li><a href="#install">Install</a></li>
+    <li><a href="#develop">Develop</a></li>
+    <li><a href="#scripts">Scripts</a></li>
+    <li><a href="#tips">Tips</a></li>
+    </ul>
+  </ul>
+  </ol>
+</details>
+
+This implementation adds:
+
+- The ability to transfer contract ownership to a Juicebox Project instead of a specific address.
+- The ability to grant other addresses `OnlyOwner` access using `JBPermissions`.
+- Includes the `JBPermissioned` modifiers with support for OpenZeppelin [`Context`](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/Context.sol). This enables optional meta-transaction support.
+
+All features are backwards compatible with OpenZeppelin `Ownable`. This should be a drop-in replacement.
+
+This repo contains 2 contracts:
+
+1. If your contract does not already use `Ownable` or access controls, use `JBOwnable`.
+2. If your contract extends a contract you cannot easily modify (e.g. a core dependency), and that contract inherits from OpenZeppelin `Ownable`, use `JBOwnableOverride`.
+
+**NOTICE:** Only use `JBOwnableOverride` if you are overriding OpenZeppelin `Ownable` v4.7.0 or higher. Otherwise, `JBPermissions` functionality for `onlyOwner` will not work.
+
+This repo was forked from [`jbx-protocol/juice-ownable`](https://github.com/jbx-protocol/juice-ownable).
+
+_If you're having trouble understanding this contract, take a look at the [core protocol contracts](https://github.com/Bananapus/nana-core) and the [documentation](https://docs.juicebox.money/) first. If you have questions, reach out on [Discord](https://discord.com/invite/ErQYmth4dS)._
+
+## Repository Layout
+
+The root directory contains this README, an MIT license, and config files.
+
+```
+nana-ownable/
+├── src/ - The Solidity source code for the contracts.
+│   ├── JBOwnable.sol - Implements ownable access control for Juicebox projects/permissions.
+│   ├── JBOwnableOverrides.sol - Abstract base contract used by JBOwnable.
+│   ├── interfaces/ - Contract interfaces.
+│   │   └── IJBOwnable.sol - Interface used by JBOwnableOverrides.
+│   └── structs/ - Structs.
+│       └── JBOwner.sol - Owner information for a given instance of JBOwnableOverrides.
+├── test/ - Forge tests and testing utilities. Top level contains the main test files.
+│   ├── handlers/ - Custom handlers for tests.
+│   ├── mock/ - Mocking utilities.
+│   ├── Ownable.t.sol - Main tests.
+│   └── OwnableInvariantTests.t.sol - Invariant test.
+└── .github/
+    └── workflows/ - CI/CD workflows.
+```
+
+## Usage
+
+### Install
+
+How to install `nana-ownable` in another project.
+
+For projects using `npm` to manage dependencies (recommended):
+
+```bash
+npm install @bananapus/ownable
+```
+
+For projects using `forge` to manage dependencies (not recommended):
+
+```bash
+forge install Bananapus/nana-ownable
+```
+
+If you're using `forge` to manage dependencies, add `@bananapus/ownable/=lib/nana-ownable/` to `remappings.txt`. You'll also need to install `nana-ownable`'s dependencies and add similar remappings for them.
+
+### Develop
+
+`nana-ownable` uses [npm](https://www.npmjs.com/) (version >=20.0.0) for package management and the [Foundry](https://github.com/foundry-rs/foundry) development toolchain for builds, tests, and deployments. To get set up, [install Node.js](https://nodejs.org/en/download) and install [Foundry](https://github.com/foundry-rs/foundry):
+
+```bash
+curl -L https://foundry.paradigm.xyz | sh
+```
+
+You can download and install dependencies with:
+
+```bash
+npm ci && forge install
+```
+
+If you run into trouble with `forge install`, try using `git submodule update --init --recursive` to ensure that nested submodules have been properly initialized.
+
+Some useful commands:
+
+| Command               | Description                                         |
+| --------------------- | --------------------------------------------------- |
+| `forge build`         | Compile the contracts and write artifacts to `out`. |
+| `forge fmt`           | Lint.                                               |
+| `forge test`          | Run the tests.                                      |
+| `forge build --sizes` | Get contract sizes.                                 |
+| `forge coverage`      | Generate a test coverage report.                    |
+| `foundryup`           | Update foundry. Run this periodically.              |
+| `forge clean`         | Remove the build artifacts and cache directories.   |
+
+To learn more, visit the [Foundry Book](https://book.getfoundry.sh/) docs.
+
+### Scripts
+
+For convenience, several utility commands are available in `package.json`.
+
+| Command                           | Description                            |
+| --------------------------------- | -------------------------------------- |
+| `npm test`                        | Run local tests.                       |
+| `npm run test:fork`               | Run fork tests (for use in CI).        |
+| `npm run coverage`           | Generate an LCOV test coverage report. |
+
+### Tips
+
+To view test coverage, run `npm run coverage` to generate an LCOV test report. You can use an extension like [Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters) to view coverage in your editor.
+
+If you're using Nomic Foundation's [Solidity](https://marketplace.visualstudio.com/items?itemName=NomicFoundation.hardhat-solidity) extension in VSCode, you may run into LSP errors because the extension cannot find dependencies outside of `lib`. You can often fix this by running:
+
+```bash
+forge remappings >> remappings.txt
+```
+
+This makes the extension aware of default remappings.

package/docs/src/SUMMARY.md

@@ -0,0 +1,9 @@
+# Summary
+- [Home](README.md)
+# src
+  - [❱ interfaces](src/interfaces/README.md)
+    - [IJBOwnable](src/interfaces/IJBOwnable.sol/interface.IJBOwnable.md)
+  - [❱ structs](src/structs/README.md)
+    - [JBOwner](src/structs/JBOwner.sol/structs.JBOwner.md)
+  - [JBOwnable](src/JBOwnable.sol/contract.JBOwnable.md)
+  - [JBOwnableOverrides](src/JBOwnableOverrides.sol/abstract.JBOwnableOverrides.md)

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

@@ -0,0 +1,71 @@
+# JBOwnable
+[Git Source](https://github.com/Bananapus/nana-ownable/blob/a74b3181e75adaf0ee0c93cb00bcc5709ca8f314/src/JBOwnable.sol)
+
+**Inherits:**
+[JBOwnableOverrides](/src/JBOwnableOverrides.sol/abstract.JBOwnableOverrides.md)
+
+A function restricted by `JBOwnable` can only be called by a Juicebox project's owner, a specified owner
+address (if set), or addresses with permission from the owner.
+
+*A function with the `onlyOwner` modifier from `JBOwnable` can only be called by addresses with owner access
+based on a `JBOwner` struct:
+1. If `JBOwner.projectId` isn't zero, the address holding the `JBProjects` NFT with the `JBOwner.projectId` ID is
+the owner.
+2. If `JBOwner.projectId` is set to `0`, the `JBOwner.owner` address is the owner.
+3. The owner can give other addresses access with `JBPermissions.setPermissionsFor(...)`, using the
+`JBOwner.permissionId` permission.*
+
+*To use `onlyOwner`, inherit this contract and apply the modifier to a function.*
+
+
+## Functions
+### constructor
+
+*To make a Juicebox project's owner this contract's owner, pass that project's ID as the
+`initialProjectIdOwner`.*
+
+*To make a specific address the owner, pass that address as the `initialOwner` and `0` as the
+`initialProjectIdOwner`.*
+
+*The owner can give other addresses owner access through the `permissions` contract.*
+
+
+```solidity
+constructor(
+    IJBPermissions permissions,
+    IJBProjects projects,
+    address initialOwner,
+    uint88 initialProjectIdOwner
+)
+    JBOwnableOverrides(permissions, projects, initialOwner, initialProjectIdOwner);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`permissions`|`IJBPermissions`|A contract storing permissions.|
+|`projects`|`IJBProjects`|Mints ERC-721s that represent project ownership and transfers.|
+|`initialOwner`|`address`|An address with owner access (until ownership is transferred).|
+|`initialProjectIdOwner`|`uint88`|The ID of the Juicebox project whose owner has owner access (until ownership is transferred).|
+
+
+### onlyOwner
+
+Reverts if called by an address without owner access.
+
+
+```solidity
+modifier onlyOwner() virtual;
+```
+
+### _emitTransferEvent
+
+Either `newOwner` or `newProjectId` is non-zero or both are zero. But they can never both be non-zero.
+
+*This function exists because some contracts will try to deploy contracts for a project before*
+
+
+```solidity
+function _emitTransferEvent(address previousOwner, address newOwner, uint88 newProjectId) internal virtual override;
+```
+

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

@@ -0,0 +1,216 @@
+# JBOwnableOverrides
+[Git Source](https://github.com/Bananapus/nana-ownable/blob/a74b3181e75adaf0ee0c93cb00bcc5709ca8f314/src/JBOwnableOverrides.sol)
+
+**Inherits:**
+Context, JBPermissioned, [IJBOwnable](/src/interfaces/IJBOwnable.sol/interface.IJBOwnable.md)
+
+An abstract base for `JBOwnable`, which restricts functions so they can only be called by a Juicebox
+project's owner or a specific owner address. The owner can give access permission to other addresses with
+`JBPermissions`.
+
+
+## State Variables
+### PROJECTS
+Mints ERC-721s that represent project ownership and transfers.
+
+
+```solidity
+IJBProjects public immutable override PROJECTS;
+```
+
+
+### jbOwner
+This contract's owner information.
+
+
+```solidity
+JBOwner public override jbOwner;
+```
+
+
+## Functions
+### constructor
+
+*To restrict access to a Juicebox project's owner, pass that project's ID as the `initialProjectIdOwner` and
+the zero address as the `initialOwner`.
+To restrict access to a specific address, pass that address as the `initialOwner` and `0` as the
+`initialProjectIdOwner`.*
+
+*The owner can give owner access to other addresses through the `permissions` contract.*
+
+
+```solidity
+constructor(
+    IJBPermissions permissions,
+    IJBProjects projects,
+    address initialOwner,
+    uint88 initialProjectIdOwner
+)
+    JBPermissioned(permissions);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`permissions`|`IJBPermissions`|A contract storing permissions.|
+|`projects`|`IJBProjects`|Mints ERC-721s that represent project ownership and transfers.|
+|`initialOwner`|`address`|The owner if the `intialProjectIdOwner` is 0 (until ownership is transferred).|
+|`initialProjectIdOwner`|`uint88`|The ID of the Juicebox project whose owner is this contract's owner (until ownership is transferred).|
+
+
+### owner
+
+Returns the owner's address based on this contract's `JBOwner`.
+
+
+```solidity
+function owner() public view virtual returns (address);
+```
+
+### _checkOwner
+
+Reverts if the sender is not the owner.
+
+
+```solidity
+function _checkOwner() internal view virtual;
+```
+
+### renounceOwnership
+
+Gives up ownership of this contract, making it impossible to call `onlyOwner` and `_checkOwner`
+functions.
+
+This can only be called by the current owner.
+
+
+```solidity
+function renounceOwnership() public virtual override;
+```
+
+### setPermissionId
+
+Sets the permission ID the owner can use to give other addresses owner access.
+
+This can only be called by the current owner.
+
+
+```solidity
+function setPermissionId(uint8 permissionId) public virtual override;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`permissionId`|`uint8`|The permission ID to use for `onlyOwner`.|
+
+
+### transferOwnership
+
+Transfers ownership of this contract to a new address (the `newOwner`). Can only be called by the
+current owner.
+
+This can only be called by the current owner.
+
+
+```solidity
+function transferOwnership(address newOwner) public virtual override;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`newOwner`|`address`|The address to transfer ownership to.|
+
+
+### transferOwnershipToProject
+
+Transfer ownership of this contract to a new Juicebox project.
+
+This can only be called by the current owner.
+
+*The `projectId` must fit within a `uint88`.*
+
+
+```solidity
+function transferOwnershipToProject(uint256 projectId) public virtual override;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project to transfer ownership to.|
+
+
+### _emitTransferEvent
+
+Either `newOwner` or `newProjectId` is non-zero or both are zero. But they can never both be non-zero.
+
+*This function exists because some contracts will try to deploy contracts for a project before*
+
+
+```solidity
+function _emitTransferEvent(address previousOwner, address newOwner, uint88 newProjectId) internal virtual;
+```
+
+### _setPermissionId
+
+Sets the permission ID the owner can use to give other addresses owner access.
+
+*Internal function without access restriction.*
+
+
+```solidity
+function _setPermissionId(uint8 permissionId) internal virtual;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`permissionId`|`uint8`|The permission ID to use for `onlyOwner`.|
+
+
+### _transferOwnership
+
+Helper to allow for drop-in replacement of OpenZeppelin `Ownable`.
+
+
+```solidity
+function _transferOwnership(address newOwner) internal virtual;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`newOwner`|`address`|The address that should receive ownership of this contract.|
+
+
+### _transferOwnership
+
+Transfers this contract's ownership to an address (`newOwner`) OR a Juicebox project (`projectId`).
+
+*Updates this contract's `JBOwner` owner information and resets the `JBOwner.permissionId`.*
+
+*If both `newOwner` and `projectId` are set, this will revert.*
+
+*Internal function without access restriction.*
+
+
+```solidity
+function _transferOwnership(address newOwner, uint88 projectId) internal virtual;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`newOwner`|`address`|The address that should become this contract's owner.|
+|`projectId`|`uint88`|The ID of the project whose owner should become this contract's owner.|
+
+
+## Errors
+### JBOwnableOverrides_InvalidNewOwner
+
+```solidity
+error JBOwnableOverrides_InvalidNewOwner();
+```
+

package/docs/src/src/README.md

@@ -0,0 +1,7 @@
+
+
+# Contents
+- [interfaces](/src/interfaces)
+- [struct](/src/struct)
+- [JBOwnable](JBOwnable.sol/contract.JBOwnable.md)
+- [JBOwnableOverrides](JBOwnableOverrides.sol/abstract.JBOwnableOverrides.md)