@bananapus/univ4-lp-split-hook-v6 0.0.11 → 0.0.12

package/ADMINISTRATION.md

@@ -33,23 +33,23 @@ Admin privileges and their scope in univ4-lp-split-hook-v6.
 
 | Function | Required Role | Permission ID | Scope | What It Does |
 |----------|--------------|---------------|-------|-------------|
-| `deployPool(projectId, terminalToken, amount0Min, amount1Min, minCashOutReturn)` | Project owner or SET_BUYBACK_POOL operator. **Becomes permissionless** when the current ruleset weight has decayed to 1/10th or less of `initialWeightOf[projectId]`. | `JBPermissionIds.SET_BUYBACK_POOL` (26) | Per-project, single terminal-token path | Creates a Uniswap V4 pool at the geometric mean of issuance/cashout rates. Cashes out a computed fraction of accumulated project tokens for terminal tokens, mints a concentrated LP position, and transitions the project from accumulation to burn mode. This permanently commits the hook instance to one terminal-token path for that project. |
-| `rebalanceLiquidity(projectId, terminalToken, ...)` | Project owner or SET_BUYBACK_POOL operator | `JBPermissionIds.SET_BUYBACK_POOL` (26) | Per-project, per-terminal-token | Burns the existing LP position NFT, collects and routes accrued fees, recalculates tick bounds from current issuance/cashout rates, and mints a new position with updated bounds. Reverts with `InsufficientLiquidity` if the new position would have zero liquidity. (Lines 559-658) |
-| `claimFeeTokensFor(projectId, beneficiary)` | Project owner or SET_BUYBACK_POOL operator | `JBPermissionIds.SET_BUYBACK_POOL` (26) | Per-project | Transfers accumulated fee-project tokens to the specified beneficiary address. Validates the caller's permission, not the beneficiary's identity. Zeroes `claimableFeeTokens[projectId]` before transferring. (Lines 441-456) |
-| `processSplitWith(context)` | JB Controller (system) | None (checked via `controllerOf`) | Per-project | Only callable by the project's registered controller. Accumulates project tokens (pre-deployment) or burns them (post-deployment). Validates `context.split.hook == address(this)`, `groupId == 1`, and controller identity. (Lines 534-555) |
-| `initialize(feeProjectId, feePercent)` | Anyone (once only) | None | Per-clone instance | Sets `FEE_PROJECT_ID` and `FEE_PERCENT` on a clone. Can only be called once per clone (`initialized` flag). In practice, called immediately by the deployer factory. (Lines 177-194) |
+| `deployPool(projectId, terminalToken, minCashOutReturn)` | Project owner or SET_BUYBACK_POOL operator. **Becomes permissionless** when the current ruleset weight has decayed to 1/10th or less of `initialWeightOf[projectId]`. | `JBPermissionIds.SET_BUYBACK_POOL` (26) | Per-project, single terminal-token path | Creates a Uniswap V4 pool at the geometric mean of issuance/cashout rates. Cashes out a computed fraction of accumulated project tokens for terminal tokens, mints a concentrated LP position, and transitions the project from accumulation to burn mode. This permanently commits the hook instance to one terminal-token path for that project. |
+| `rebalanceLiquidity(projectId, terminalToken, ...)` | Project owner or SET_BUYBACK_POOL operator | `JBPermissionIds.SET_BUYBACK_POOL` (26) | Per-project, per-terminal-token | Burns the existing LP position NFT, collects and routes accrued fees, recalculates tick bounds from current issuance/cashout rates, and mints a new position with updated bounds. Reverts with `InsufficientLiquidity` if the new position would have zero liquidity. (Lines 632-667) |
+| `claimFeeTokensFor(projectId, beneficiary)` | Project owner or SET_BUYBACK_POOL operator | `JBPermissionIds.SET_BUYBACK_POOL` (26) | Per-project | Transfers accumulated fee-project tokens to the specified beneficiary address. Validates the caller's permission, not the beneficiary's identity. Zeroes `claimableFeeTokens[projectId]` before transferring. (Lines 490-505) |
+| `processSplitWith(context)` | JB Controller (system) | None (checked via `controllerOf`) | Per-project | Only callable by the project's registered controller. Accumulates project tokens (pre-deployment) or burns them (post-deployment). Validates `context.split.hook == address(this)`, `groupId == 1`, and controller identity. (Lines 596-627) |
+| `initialize(feeProjectId, feePercent)` | Anyone (once only) | None | Per-clone instance | Sets `FEE_PROJECT_ID` and `FEE_PERCENT` on a clone. Can only be called once per clone (`initialized` flag). In practice, called immediately by the deployer factory. (Lines 215-232) |
 
 ### JBUniswapV4LPSplitHookDeployer
 
 | Function | Required Role | Permission ID | Scope | What It Does |
 |----------|--------------|---------------|-------|-------------|
-| `deployHookFor(feeProjectId, feePercent, salt)` | Anyone | None | Global | Deploys a new hook clone via `LibClone`, calls `initialize()` on it, and registers it in the `JBAddressRegistry`. CREATE2 salt is scoped to `msg.sender`. (Lines 52-84) |
+| `deployHookFor(feeProjectId, feePercent, salt)` | Anyone | None | Global | Deploys a new hook clone via `LibClone`, calls `initialize()` on it, and registers it in the `JBAddressRegistry`. CREATE2 salt is scoped to `msg.sender`. (Lines 53-85) |
 
 ### Permissionless Functions (No Privilege Required)
 
 | Function | Scope | What It Does |
 |----------|-------|-------------|
-| `collectAndRouteLPFees(projectId, terminalToken)` | Per-project, per-terminal-token | Collects accrued V4 position fees and routes them: `FEE_PERCENT` of terminal token fees to the fee project via `terminal.pay()`, the remainder to the original project via `addToBalanceOf()`. Project token fees are burned. Safe because funds always go to verified project terminals. (Lines 459-488) |
+| `collectAndRouteLPFees(projectId, terminalToken)` | Per-project, per-terminal-token | Collects accrued V4 position fees and routes them: `FEE_PERCENT` of terminal token fees to the fee project via `terminal.pay()`, the remainder to the original project via `addToBalanceOf()`. Project token fees are burned. Safe because funds always go to verified project terminals. (Lines 509-549) |
 | `isPoolDeployed(projectId, terminalToken)` | View | Returns whether `tokenIdOf[projectId][terminalToken] != 0`. |
 | `poolKeyOf(projectId, terminalToken)` | View | Returns the stored `PoolKey` for a deployed pool. |
 | `supportsInterface(interfaceId)` | View | Returns `true` for `IJBUniswapV4LPSplitHook` and `IJBSplitHook`. |
@@ -63,19 +63,19 @@ These values are set at deploy time and cannot be changed afterward.
 
 | Parameter | Set In | Value Source |
 |-----------|--------|-------------|
-| `DIRECTORY` | Constructor (line 168) | JBDirectory address |
-| `TOKENS` | Constructor (line 169) | JBTokens address |
-| `POOL_MANAGER` | Constructor (line 170) | Uniswap V4 PoolManager address |
-| `POSITION_MANAGER` | Constructor (line 171) | Uniswap V4 PositionManager address |
-| `ORACLE_HOOK` | Constructor (line 183) | Oracle hook (`IHooks`) for all JB V4 pools. Set in `PoolKey.hooks` when creating pools. Provides TWAP via `observe()`. |
-| `PERMISSIONS` | Inherited from `JBPermissioned` constructor (line 161) | JBPermissions address |
+| `DIRECTORY` | Constructor (line 202) | JBDirectory address |
+| `TOKENS` | Constructor (line 207) | JBTokens address |
+| `POOL_MANAGER` | Constructor (line 205) | Uniswap V4 PoolManager address |
+| `POSITION_MANAGER` | Constructor (line 206) | Uniswap V4 PositionManager address |
+| `ORACLE_HOOK` | Constructor (line 203) | Oracle hook (`IHooks`) for all JB V4 pools. Set in `PoolKey.hooks` when creating pools. Provides TWAP via `observe()`. |
+| `PERMISSIONS` | Inherited from `JBPermissioned` constructor (line 195) | JBPermissions address |
 
 ### Clone-Level (initialize(), Per-Instance)
 
 | Parameter | Set In | Value Source |
 |-----------|--------|-------------|
-| `FEE_PROJECT_ID` | `initialize()` (line 192) | Project ID receiving LP fee share |
-| `FEE_PERCENT` | `initialize()` (line 193) | Basis points (0-10000) of LP fees routed to fee project |
+| `FEE_PROJECT_ID` | `initialize()` (line 230) | Project ID receiving LP fee share |
+| `FEE_PERCENT` | `initialize()` (line 231) | Basis points (0-10000) of LP fees routed to fee project |
 
 ### Protocol Constants (Hardcoded)
 

package/README.md

@@ -130,8 +130,14 @@ test/
   IntegrationLifecycle.t.sol                 # Full end-to-end workflow
   Fork.t.sol                                 # Fork tests with real V4 + JB core
   fork/GeomeanLPFork.t.sol                  # Geometric mean pricing fork tests
+  fork/TickBoundsAndFeeFork.t.sol           # Tick bounds and fee fork tests
+  invariant/LPSplitHookInvariant.t.sol      # Invariant/fuzz tests
   TestBaseV4.sol                             # Shared test infrastructure
-  regression/                               # Targeted regression tests
+  regression/
+    FeeProjectIdValidation.t.sol            # Fee project ID validation
+    ReinitAfterRenounce.t.sol               # Re-init after renounce
+    StaleTokenIdOf.t.sol                    # Stale tokenIdOf regression
+    TickBoundsInversion.t.sol               # Tick bounds inversion
 script/
   Deploy.s.sol                               # Sphinx deployment script
 ```

package/SKILLS.md

@@ -23,7 +23,7 @@ Juicebox reserved-token split hook that accumulates project tokens, deploys a Un
 
 | Function | What it does |
 |----------|-------------|
-| `deployPool(projectId, terminalToken, amount0Min, amount1Min, minCashOutReturn)` | Requires `SET_BUYBACK_POOL` permission unless the current ruleset's weight has decayed to 1/10th or less of `initialWeightOf[projectId]` (becomes permissionless). Creates V4 pool at geometric mean of [cashOut, issuance] rates. Computes optimal cash-out fraction, cashes out tokens via terminal, mints concentrated LP position, handles leftovers (burns project tokens, adds terminal tokens to project balance). Once a pool exists, a different `terminalToken` for the same project is rejected. |
+| `deployPool(projectId, terminalToken, minCashOutReturn)` | Requires `SET_BUYBACK_POOL` permission unless the current ruleset's weight has decayed to 1/10th or less of `initialWeightOf[projectId]` (becomes permissionless). Creates V4 pool at geometric mean of [cashOut, issuance] rates. Computes optimal cash-out fraction, cashes out tokens via terminal, mints concentrated LP position, handles leftovers (burns project tokens, adds terminal tokens to project balance). Once a pool exists, a different `terminalToken` for the same project is rejected. |
 
 ### Fee Management
 
@@ -175,8 +175,6 @@ IJBUniswapV4LPSplitHook hook = deployer.deployHookFor({
 hook.deployPool({
     projectId: projectId,
     terminalToken: JBConstants.NATIVE_TOKEN,  // ETH
-    amount0Min: 0,                            // slippage (0 = no check)
-    amount1Min: 0,                            // slippage (0 = no check)
     minCashOutReturn: 0                       // 0 = auto 3% tolerance
 });
 
@@ -190,9 +188,7 @@ hook.rebalanceLiquidity({
     projectId: projectId,
     terminalToken: JBConstants.NATIVE_TOKEN,
     decreaseAmount0Min: 0,
-    decreaseAmount1Min: 0,
-    increaseAmount0Min: 0,
-    increaseAmount1Min: 0
+    decreaseAmount1Min: 0
 });
 
 // --- Claim accumulated fee-project tokens (requires permission) ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bananapus/univ4-lp-split-hook-v6",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "license": "MIT",
   "repository": {
     "type": "git",