Bananapus Permission ID
This repository contains permission IDs to grant scoped permissions through the JBPermissions
contract and JBPermissioned
modifier.
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.
Install
For npm
projects (recommended):
npm install @bananapus/permission-ids
For forge
projects (not recommended):
forge install Bananapus/nana-permission-ids
Add @bananapus/permission-ids/=lib/nana-permission-ids/
to remappings.txt
. You'll also need to install nana-permission-ids
' dependencies and add similar remappings for them.
Develop
nana-permission-ids
uses npm 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:
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 docs.