@bananapus/permission-ids-v6 0.0.29 → 0.0.31

package/README.md

@@ -12,7 +12,7 @@
 - [AUDIT_INSTRUCTIONS.md](./AUDIT_INSTRUCTIONS.md) — what to verify when auditing this repo
 - [SKILLS.md](./SKILLS.md) — quick-reference index for AI agents
 - [STYLE_GUIDE.md](./STYLE_GUIDE.md) — V6 ecosystem Solidity conventions
-- [CHANGELOG.md](./CHANGELOG.md) — release-by-release diff from `nana-permission-ids-v5`
+- [CHANGELOG.md](./CHANGELOG.md) - V5 to V6 permission-map changelog
 
 ## Overview
 
@@ -24,7 +24,7 @@ Use this repo as the single source of truth for permission numbers. Do not redef
 
 If the question is "who can do this action?" you still need `JBPermissions` in `nana-core-v6`. This repo only tells you what the numbers mean.
 
-## Current Permission Ranges
+## Current permission ranges
 
 | Range | Area |
 | --- | --- |
@@ -44,27 +44,27 @@ Two IDs deserve extra attention:
 - `SET_BUYBACK_HOOK` covers both setting and permanently locking the configured buyback hook
 - `SET_ROUTER_TERMINAL` covers both setting and permanently locking the configured router terminal
 
-## Mental Model
+## Mental model
 
 This repo is a naming registry, not a behavior repo. Its job is to make every other package use the same permission names for the same bit positions.
 
-## Read This File First
+## Read this file first
 
 1. `src/JBPermissionIds.sol`
 
-## Integration Traps
+## Integration traps
 
 - changing an existing numeric constant is an ecosystem breaking change
 - adding a new permission ID without coordinating downstream repos creates semantic drift even if code still compiles
 - wildcard project permissions are still dangerous even when the numeric IDs are correct
 
-## Where Meaning Lives
+## Where meaning lives
 
 - numeric permission labels: `JBPermissionIds.sol`
 - runtime permission checks: `nana-core-v6/src/JBPermissions.sol`
 - repo-specific uses of those IDs: the downstream repo that imports them
 
-## For AI Agents
+## For AI agents
 
 - Treat this repo as a naming registry for permission bits, not as the runtime permission engine.
 - If asked whether an action is allowed, inspect the downstream repo that checks the ID in addition to this file.
@@ -82,16 +82,18 @@ npm install
 forge build
 ```
 
-## Repository Layout
+## Repository layout
 
 ```text
 src/
   JBPermissionIds.sol
 ```
 
-## Risks And Notes
+## Risks and notes
 
 - `ROOT` is intentionally powerful and should be granted sparingly
 - wildcard project scope is convenient but easy to misuse
 - some IDs bundle configuration and irreversible locking authority, so their blast radius is larger than the short name suggests
 - any change to this file has ecosystem-wide consequences because other repos assume the values stay stable
+
+This repo is just numbers — but the numbers are load-bearing across every other V6 package.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bananapus/permission-ids-v6",
-  "version": "0.0.29",
+  "version": "0.0.31",
   "license": "MIT",
   "repository": {
     "type": "git",

package/references/runtime.md

@@ -2,16 +2,16 @@
 
 Use this file when you need to confirm the canonical numeric labels, not when you need to understand enforcement behavior.
 
-## Core Role
+## Core role
 
 - [`src/JBPermissionIds.sol`](../src/JBPermissionIds.sol) defines the canonical numeric labels used by the rest of the ecosystem.
 
-## High-Risk Areas
+## High-risk areas
 
 - Numeric drift: a local redefinition or renumbering breaks cross-repo assumptions.
 - Permission scope confusion: this repo names IDs, but enforcement still lives elsewhere.
 
-## Change Checklist
+## Change checklist
 
 - If you edit a constant, review every dependent repo that imports it.
 - If you need to know who can exercise a permission, follow the usage into the enforcing repo rather than stopping here.

package/src/JBPermissionIds.sol

@@ -8,11 +8,13 @@ pragma solidity 0.8.28;
 library JBPermissionIds {
     /// @notice Grants all permissions across every Juicebox contract. An operator with ROOT can do anything the
     /// project owner can do. Use with extreme caution.
+    /// @dev When checked with `includeRoot` set to `true`, holding bit 1 short-circuits any permission check, so a ROOT
+    /// grant is equivalent to granting every present and future ID.
     uint8 internal constant ROOT = 1;
 
-    /* ── nana-core-v6
-    ───────────────────────────────────────────────────
-    */
+    //*********************************************************************//
+    // -------------------------- nana-core-v6 --------------------------- //
+    //*********************************************************************//
 
     /// @notice Queue new rulesets for a project, scheduling future changes to its funding cycles, payouts, and rules
     /// (`JBController.queueRulesetsOf`).
@@ -104,9 +106,9 @@ library JBPermissionIds {
     /// @dev Used for Etherscan contract verification and other off-chain signature validation.
     uint8 internal constant SIGN_FOR_ERC20 = 23;
 
-    /* ── nana-721-hook-v6
-    ───────────────────────────────────────────────
-    */
+    //*********************************************************************//
+    // ------------------------ nana-721-hook-v6 ------------------------- //
+    //*********************************************************************//
 
     /// @notice Add, remove, or modify NFT tiers for a project's 721 hook
     /// (`JB721TiersHook.adjustTiers`).
@@ -124,9 +126,9 @@ library JBPermissionIds {
     /// (`JB721TiersHook.setDiscountPercentOf`).
     uint8 internal constant SET_721_DISCOUNT_PERCENT = 27;
 
-    /* ── nana-buyback-hook-v6
-    ───────────────────────────────────────────
-    */
+    //*********************************************************************//
+    // ---------------------- nana-buyback-hook-v6 ----------------------- //
+    //*********************************************************************//
 
     /// @notice Set the TWAP (time-weighted average price) window used by a project's buyback hook to determine when
     /// buying tokens on a DEX is cheaper than minting (`JBBuybackHook.setTwapWindowOf`).
@@ -141,18 +143,18 @@ library JBPermissionIds {
     /// @dev An operator with this permission can lock the hook, preventing future changes.
     uint8 internal constant SET_BUYBACK_HOOK = 30;
 
-    /* ── nana-router-terminal-v6
-    ────────────────────────────────────────
-    */
+    //*********************************************************************//
+    // --------------------- nana-router-terminal-v6 --------------------- //
+    //*********************************************************************//
 
     /// @notice Configure or permanently lock a project's router terminal, which routes payments through a DEX
     /// (`JBRouterTerminalRegistry.setTerminalFor` and `JBRouterTerminalRegistry.lockTerminalFor`).
     /// @dev An operator with this permission can lock the terminal, preventing future changes.
     uint8 internal constant SET_ROUTER_TERMINAL = 31;
 
-    /* ── nana-suckers-v6
-    ────────────────────────────────────────────────
-    */
+    //*********************************************************************//
+    // ------------------------- nana-suckers-v6 ------------------------- //
+    //*********************************************************************//
 
     /// @notice Map a token on one chain to its counterpart on another chain within a cross-chain sucker bridge
     /// (`JBSucker.mapToken`).
@@ -179,9 +181,9 @@ library JBPermissionIds {
     /// (`JBSucker.setDeprecation`).
     uint8 internal constant SET_SUCKER_DEPRECATION = 36;
 
-    /* ── revnet-core-v6
-    ─────────────────────────────────────────────────
-    */
+    //*********************************************************************//
+    // ------------------------- revnet-core-v6 -------------------------- //
+    //*********************************************************************//
 
     /// @notice Open a loan against project tokens as collateral on behalf of a token holder
     /// (`REVLoans.borrowFrom`).