@bananapus/ownable v0.0.7

Bananapus Ownable

A Bananapus variation on OpenZeppelin Ownable to enable owner-based access control incorporating Juicebox project ownership and JBPermissions.

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. 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.

If you're having trouble understanding this contract, take a look at the core protocol contracts and the documentation first. If you have questions, reach out on Discord.

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):

npm install @bananapus/ownable

For projects using forge to manage dependencies (not recommended):

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 (version >=20.0.0) for package management and the Foundry development toolchain for builds, tests, and deployments. To get set up, install Node.js and install Foundry:

curl -L https://foundry.paradigm.xyz | sh

You can download and install dependencies with:

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:

To learn more, visit the Foundry Book docs.

Scripts

For convenience, several utility commands are available in package.json.

Tips

To view test coverage, run npm run coverage to generate an LCOV test report. You can use an extension like Coverage Gutters to view coverage in your editor.

If you're using Nomic Foundation's 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:

forge remappings >> remappings.txt

This makes the extension aware of default remappings.