0.0.5 • Published 2 months ago

@bananapus/permission-ids v0.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
2 months ago

Bananapus Permission ID

This repository contains permission IDs to grant scoped permissions through the JBPermissions contract and JBPermissioned modifier.

Permission IDsRepository
1-20nana-core
21nana-project-handles
22-24nana-721-hook
25-26nana-buyback-hook
27-28nana-swap-terminal
29-30nana-suckers

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:

CommandDescription
forge buildCompile the contracts and write artifacts to out.
forge fmtLint.
forge testRun the tests.
forge build --sizesGet contract sizes.
forge coverageGenerate a test coverage report.
foundryupUpdate foundry. Run this periodically.
forge cleanRemove the build artifacts and cache directories.

To learn more, visit the Foundry Book docs.