@bananapus/permission-ids-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,32 @@
+# nana-permission-ids-v6
+
+Library of `uint8` constants defining all permission IDs used with `JBPermissions` across the Juicebox V6 ecosystem.
+
+## Architecture
+
+| Contract | Description |
+|----------|-------------|
+| `JBPermissionIds` | Solidity library with 34 `uint8 internal constant` permission IDs. No state, no functions. |
+
+### Permission ID Ranges
+
+| IDs | Repository | Permissions |
+|-----|------------|-------------|
+| 1 | All | `ROOT` -- grants all permissions. |
+| 2--20 | nana-core-v6 | `QUEUE_RULESETS`, `LAUNCH_RULESETS`, `CASH_OUT_TOKENS`, `SEND_PAYOUTS`, `MIGRATE_TERMINAL`, `SET_PROJECT_URI`, `DEPLOY_ERC20`, `SET_TOKEN`, `MINT_TOKENS`, `BURN_TOKENS`, `CLAIM_TOKENS`, `TRANSFER_CREDITS`, `SET_CONTROLLER`, `SET_TERMINALS`, `SET_PRIMARY_TERMINAL`, `USE_ALLOWANCE`, `SET_SPLIT_GROUPS`, `ADD_PRICE_FEED`, `ADD_ACCOUNTING_CONTEXTS` |
+| 21--24 | nana-721-hook-v6 | `ADJUST_721_TIERS`, `SET_721_METADATA`, `MINT_721`, `SET_721_DISCOUNT_PERCENT` |
+| 25--27 | nana-buyback-hook-v6 | `SET_BUYBACK_TWAP`, `SET_BUYBACK_POOL`, `SET_BUYBACK_HOOK` |
+| 28--30 | nana-swap-terminal-v6 | `ADD_SWAP_TERMINAL_POOL`, `ADD_SWAP_TERMINAL_TWAP_PARAMS`, `SET_SWAP_TERMINAL` |
+| 31--34 | nana-suckers-v6 | `MAP_SUCKER_TOKEN`, `DEPLOY_SUCKERS`, `SUCKER_SAFETY`, `SET_SUCKER_DEPRECATION` |
+
+## Install
+
+```bash
+npm install
+```
+
+## Develop
+
+| Command | Description |
+|---------|-------------|
+| `forge build` | Compile contracts |

package/SKILLS.md

@@ -0,0 +1,82 @@
+# nana-permission-ids-v5
+
+## Purpose
+
+Defines all `uint8` permission ID constants used across the Juicebox V5 ecosystem, passed to `JBPermissions.setPermissionsFor()` to grant scoped access to protocol functions.
+
+## Contracts
+
+| Contract | Role |
+|----------|------|
+| `JBPermissionIds` | Constants-only library. No state, no functions. Pragma `^0.8.0` for maximum compatibility. |
+
+## Key Functions
+
+N/A -- this is a constants-only library with no callable functions.
+
+## All Permission IDs
+
+| ID | Name | Grants access to |
+|----|------|-----------------|
+| 1 | `ROOT` | All permissions across every contract. |
+| 2 | `QUEUE_RULESETS` | `JBController.queueRulesetsOf`, `launchRulesetsFor` |
+| 3 | `CASH_OUT_TOKENS` | `JBMultiTerminal.cashOutTokensOf` |
+| 4 | `SEND_PAYOUTS` | `JBMultiTerminal.sendPayoutsOf` |
+| 5 | `MIGRATE_TERMINAL` | `JBMultiTerminal.migrateBalanceOf` |
+| 6 | `SET_PROJECT_URI` | `JBController.setUriOf` |
+| 7 | `DEPLOY_ERC20` | `JBController.deployERC20For` |
+| 8 | `SET_TOKEN` | `JBController.setTokenFor` |
+| 9 | `MINT_TOKENS` | `JBController.mintTokensOf` |
+| 10 | `BURN_TOKENS` | `JBController.burnTokensOf` |
+| 11 | `CLAIM_TOKENS` | `JBController.claimTokensFor` |
+| 12 | `TRANSFER_CREDITS` | `JBController.transferCreditsFrom` |
+| 13 | `SET_CONTROLLER` | `JBDirectory.setControllerOf` |
+| 14 | `SET_TERMINALS` | `JBDirectory.setTerminalsOf` |
+| 15 | `SET_PRIMARY_TERMINAL` | `JBDirectory.setPrimaryTerminalOf` |
+| 16 | `USE_ALLOWANCE` | `JBMultiTerminal.useAllowanceOf` |
+| 17 | `SET_SPLIT_GROUPS` | `JBController.setSplitGroupsOf` |
+| 18 | `ADD_PRICE_FEED` | `JBPrices.addPriceFeedFor` |
+| 19 | `ADD_ACCOUNTING_CONTEXTS` | `JBMultiTerminal.addAccountingContextsFor` |
+| 20 | `ADJUST_721_TIERS` | `JB721TiersHook.adjustTiers` |
+| 21 | `SET_721_METADATA` | `JB721TiersHook.setMetadata` |
+| 22 | `MINT_721` | `JB721TiersHook.mintFor` |
+| 23 | `SET_721_DISCOUNT_PERCENT` | `JB721TiersHook.setDiscountPercentOf` |
+| 24 | `SET_BUYBACK_TWAP` | `JBBuybackHook.setTwapWindowOf`, `setTwapSlippageToleranceOf` |
+| 25 | `SET_BUYBACK_POOL` | `JBBuybackHook.setPoolFor` |
+| 26 | `ADD_SWAP_TERMINAL_POOL` | `JBSwapTerminal.addDefaultPool` |
+| 27 | `ADD_SWAP_TERMINAL_TWAP_PARAMS` | `JBSwapTerminal.addTwapParamsFor` |
+| 28 | `MAP_SUCKER_TOKEN` | `BPSucker.mapToken` |
+| 29 | `DEPLOY_SUCKERS` | `BPSuckerRegistry.deploySuckersFor` |
+| 30 | `SUCKER_SAFETY` | `BPSucker.enableEmergencyHatchFor`, `setDeprecation` |
+
+## Integration Points
+
+| Dependency | Import | Used For |
+|------------|--------|----------|
+| None | -- | This library has no dependencies. It is imported by all permission-gated Juicebox contracts. |
+
+## Key Types
+
+N/A -- no structs or enums.
+
+## Gotchas
+
+- `ROOT` (ID 1) grants all permissions across every contract. Must be granted with extreme care.
+- `SET_TERMINALS` (ID 14) can be used to remove the primary terminal -- the comment in the source warns about this.
+- Permissions are scoped by `(operator, account, projectId)` tuple. Granting with `projectId=0` is a wildcard that applies to all projects for that account.
+- The `uint8` type limits IDs to 0--255. Currently 30 are defined (1--30).
+
+## Example Integration
+
+```solidity
+import {JBPermissionIds} from "@bananapus/permission-ids-v5/src/JBPermissionIds.sol";
+
+// Grant an operator permission to queue rulesets for project 5
+uint8[] memory permissionIds = new uint8[](1);
+permissionIds[0] = JBPermissionIds.QUEUE_RULESETS;
+permissions.setPermissionsFor(account, JBPermissionsData({
+    operator: operatorAddress,
+    projectId: 5,
+    permissionIds: permissionIds
+}));
+```

package/foundry.lock

@@ -0,0 +1,5 @@
+{
+  "lib/forge-std": {
+    "rev": "ae570fec082bfe1c1f45b0acca4a2b4f84d345ce"
+  }
+}

package/foundry.toml

@@ -0,0 +1,20 @@
+[profile.default]
+solc = '0.8.23'
+evm_version = 'paris'                   # Required for L2s (Optimism, Arbitrum, etc.)
+match_contract = "_Local"               # Do not run fork tests
+sizes = true
+verbosity = 3                           # display errors
+optimizer_runs = 200
+block_number = 14126430
+block_timestamp = 1643802347
+runs = 4096
+libs = ["node_modules", "lib"]
+
+[profile.fork] # run via FOUNDRY_PROFILE=fork foundry test
+fs_permissions = [{ access = "read", path = "./deployments/mainnet" }] # Get the deployment addresses for forking
+match_contract = "_Fork"
+
+[fmt]
+number_underscore = "thousands"
+multiline_func_header = "all"
+wrap_comments = true

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@bananapus/permission-ids-v6",
+  "version": "0.0.1",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Bananapus/nana-permission-ids-v6.git"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}

package/slither-ci.config.json

@@ -0,0 +1,10 @@
+{
+    "detectors_to_exclude": "timestamp,uninitialized-local,naming-convention,solc-version,shadowing-local",
+    "exclude_informational": true,
+    "exclude_low": false,
+    "exclude_medium": false,
+    "exclude_high": false,
+    "disable_color": false,
+    "filter_paths": "(mocks/|test/|node_modules/)",
+    "legacy_ast": false
+}

package/src/JBPermissionIds.sol

@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: MIT
+// slither-disable-next-line solc-version
+pragma solidity ^0.8.0;
+
+/// @notice Permission IDs for `JBPermissions`, used throughout the Bananapus ecosystem. See
+/// [`JBPermissions`](https://github.com/Bananapus/nana-core/blob/main/src/JBPermissions.sol)
+/// @dev `JBPermissions` allows one address to grant another address permission to call functions in Juicebox contracts
+/// on their behalf. Each ID in `JBPermissionIds` grants access to a specific set of these functions.
+library JBPermissionIds {
+    uint8 internal constant ROOT = 1; // All permissions across every contract. Very dangerous. BE CAREFUL!
+
+    /* Used by `nana-core`: https://github.com/Bananapus/nana-core */
+    uint8 internal constant QUEUE_RULESETS = 2; // Permission to call `JBController.queueRulesetsOf`.
+    uint8 internal constant LAUNCH_RULESETS = 3; // Permission to call `JBController.launchRulesetsFor`.
+    uint8 internal constant CASH_OUT_TOKENS = 4; // Permission to call `JBMultiTerminal.cashOutTokensOf`.
+    uint8 internal constant SEND_PAYOUTS = 5; // Permission to call `JBMultiTerminal.sendPayoutsOf`.
+    uint8 internal constant MIGRATE_TERMINAL = 6; // Permission to call `JBMultiTerminal.migrateBalanceOf`.
+    uint8 internal constant SET_PROJECT_URI = 7; // Permission to call `JBController.setUriOf`.
+    uint8 internal constant DEPLOY_ERC20 = 8; // Permission to call `JBController.deployERC20For`.
+    uint8 internal constant SET_TOKEN = 9; // Permission to call `JBController.setTokenFor`.
+    uint8 internal constant MINT_TOKENS = 10; // Permission to call `JBController.mintTokensOf`.
+    uint8 internal constant BURN_TOKENS = 11; // Permission to call `JBController.burnTokensOf`.
+    uint8 internal constant CLAIM_TOKENS = 12; // Permission to call `JBController.claimTokensFor`.
+    uint8 internal constant TRANSFER_CREDITS = 13; // Permission to call `JBController.transferCreditsFrom`.
+    uint8 internal constant SET_CONTROLLER = 14; // Permission to call `JBDirectory.setControllerOf`.
+    uint8 internal constant SET_TERMINALS = 15; // Permission to call `JBDirectory.setTerminalsOf`.
+    // Be careful - `SET_TERMINALS` can be used to remove the primary terminal.
+    uint8 internal constant SET_PRIMARY_TERMINAL = 16; // Permission to call `JBDirectory.setPrimaryTerminalOf`.
+    uint8 internal constant USE_ALLOWANCE = 17; // Permission to call `JBMultiTerminal.useAllowanceOf`.
+    uint8 internal constant SET_SPLIT_GROUPS = 18; // Permission to call `JBController.setSplitGroupsOf`.
+    uint8 internal constant ADD_PRICE_FEED = 19; // Permission to call `JBPrices.addPriceFeedFor`.
+    uint8 internal constant ADD_ACCOUNTING_CONTEXTS = 20; // Permission to call
+    // `JBMultiTerminal.addAccountingContextsFor`.
+
+    /* Used by `nana-721-hook`: https://github.com/Bananapus/nana-721-hook */
+    uint8 internal constant ADJUST_721_TIERS = 21; // Permission to call `JB721TiersHook.adjustTiers`.
+    uint8 internal constant SET_721_METADATA = 22; // Permission to call `JB721TiersHook.setMetadata`.
+    uint8 internal constant MINT_721 = 23; // Permission to call `JB721TiersHook.mintFor`.
+    uint8 internal constant SET_721_DISCOUNT_PERCENT = 24; // Permission to call `JB721TiersHook.setDiscountPercentOf`.
+
+    /* Used by `nana-buyback-hook`: https://github.com/Bananapus/nana-buyback-hook */
+    uint8 internal constant SET_BUYBACK_TWAP = 25; // Permission to call `JBBuybackHook.setTwapWindowOf`.
+    uint8 internal constant SET_BUYBACK_POOL = 26; // Permission to call `JBBuybackHook.setPoolFor`.
+    uint8 internal constant SET_BUYBACK_HOOK = 27; // Permission to call `JBBuybackHookRegistry.setHookFor` and
+    // `JBBuybackHookRegistry.lockHookFor`.
+
+    /* Used by `nana-swap-terminal`: https://github.com/Bananapus/nana-swap-terminal */
+    uint8 internal constant ADD_SWAP_TERMINAL_POOL = 28; // Permission to call `JBSwapTerminal.addDefaultPool`.
+    uint8 internal constant ADD_SWAP_TERMINAL_TWAP_PARAMS = 29; // Permission to call
+    // `JBSwapTerminal.addTwapParamsFor`.
+    uint8 internal constant SET_SWAP_TERMINAL = 30; // Permission to call `JBSwapTerminalRegistry.setTerminalFor` and
+    // `JBSwapTerminalRegistry.lockTerminalFor`.
+
+    /* Used by `nana-suckers`: https://github.com/Bananapus/nana-suckers */
+    uint8 internal constant MAP_SUCKER_TOKEN = 31; // Permission to call `JBSucker.mapToken`.
+    uint8 internal constant DEPLOY_SUCKERS = 32; // Permission to call `JBSuckerRegistry.deploySuckersFor`.
+    uint8 internal constant SUCKER_SAFETY = 33; // Permission to call `JBSucker.enableEmergencyHatchFor`.
+    uint8 internal constant SET_SUCKER_DEPRECATION = 34; // Permission to call `JBSucker.setDeprecation`.
+}