@bananapus/router-terminal-v6 0.0.47 → 0.0.49

package/package.json

@@ -1,18 +1,16 @@
 {
   "name": "@bananapus/router-terminal-v6",
-  "version": "0.0.47",
+  "version": "0.0.49",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Bananapus/nana-router-terminal-v6"
   },
   "files": [
-    "CHANGELOG.md",
     "foundry.toml",
     "references/",
     "remappings.txt",
-    "script/Deploy.s.sol",
-    "script/helpers/",
+    "script/",
     "src/"
   ],
   "engines": {

package/src/JBRouterTerminal.sol

@@ -847,8 +847,8 @@ contract JBRouterTerminal is
 
             // Decode only the buyback field used for route scoring. `minimumSwapAmountOut` is executable because the
             // hook will enforce it; the later raw quote word is diagnostic and can overstate what execution can prove.
-            (uint256 minimumSwapAmountOut,,,,,,) =
-                abi.decode(specification.metadata, (uint256, uint256, uint256, int24, uint128, PoolId, uint256));
+            (uint256 minimumSwapAmountOut,,,,,,,) =
+                abi.decode(specification.metadata, (uint256, uint256, uint256, int24, uint128, PoolId, uint256, bool));
 
             // Keep whichever understood executable hook commitment implies the strongest cash-out output.
             if (minimumSwapAmountOut > effectiveAmount) effectiveAmount = minimumSwapAmountOut;

package/CHANGELOG.md

@@ -1,117 +0,0 @@
-# Changelog
-
-## Scope
-
-This file describes the verified change from `nana-swap-terminal-v5` to the current `nana-router-terminal-v6` repo. In-v6 behavior changes that have semantic implications for integrators are also captured here.
-
-## In-v6 changes
-
-### Chain-same CREATE2 address for `JBRouterTerminal`
-
-`JBRouterTerminal` now deploys to the same address on every chain via CREATE2. The four chain-specific
-immutables (`WRAPPED_NATIVE_TOKEN`, `FACTORY`, `POOL_MANAGER`, `UNIV4_HOOK`) moved from `immutable` to public
-storage and are wired in after deployment via a new one-shot `setChainSpecificConstants(wrappedNativeToken, factory, poolManager, univ4Hook)` setter, gated by a `_DEPLOYER` internal immutable (same pattern as `JBBuybackHook` and `JBUniswapV4LPSplitHookDeployer`).
-
-- Constructor signature changed: `(IJBDirectory directory, IJBTokens tokens, IPermit2 permit2, address buybackHook, address trustedForwarder, address deployer)` — was 9 args, now 6. The four chain-different dependencies are no longer ctor inputs.
-- New external function: `setChainSpecificConstants(IWETH9 wrappedNativeToken, IUniswapV3Factory factory, IPoolManager poolManager, address univ4Hook)`. Reverts with `JBRouterTerminal_Unauthorized(caller)` if msg.sender != `_DEPLOYER`; reverts with `JBRouterTerminal_AlreadyConfigured()` if `WRAPPED_NATIVE_TOKEN` has already been set.
-- `BUYBACK_HOOK` stays as `public immutable` because `JBBuybackHook` is itself chain-same as of `@bananapus/buyback-hook-v6@0.0.44`.
-
-`JBPayRouteResolver` also lost its `WRAPPED_NATIVE_TOKEN` immutable but does NOT call back into the router for it. Instead, the router passes its `WRAPPED_NATIVE_TOKEN` storage value as a parameter (`address wrappedNativeToken`) on every external resolver call (`previewBestPayRoute`, `previewPayRouteForCandidate`, `previewFallbackRoute`, `resolveTokenOut`), and the resolver threads it through internal helpers (`_normalizedTokenOf`, `_hasSameRoutingAsset`, `_discoverAcceptedToken`, `_resolveTokenOut`, `_previewAmountToToken`, `_previewRoute`). `_normalizedTokenOf` and `_hasSameRoutingAsset` are `pure` again. This avoids an extra external call per normalization step (which would compound inside the loops in `_discoverAcceptedToken`).
-
-The resolver is still deployed in the router's constructor (chain-same input: just `directory`); its CREATE address is `router.address + nonce 1`, which is chain-same once the router itself is chain-same.
-
-Integrator impact: deployers must call `setChainSpecificConstants` once after construction (the script in `script/Deploy.s.sol` does this in the same transaction as the deploy). Tests and the local deploy script have been updated accordingly.
-
-Size: `JBRouterTerminal` 23,706 → 23,468 B (-238 B; headroom 870 → 1,108 B against the EIP-170 24,576 B limit). `JBPayRouteResolver` 10,438 → 10,398 B (-40 B).
-
-### Removed: credit cash-out input path
-
-The router no longer accepts unclaimed Juicebox credits as a payment input. The `cashOutSource` metadata key, the `sourceProjectIdOverride` parameter on `previewCashOutLoopOf`, the `IJBController.transferCreditsFrom` pull in `_acceptFundsFor`, and the `_cashOutSourceFrom` helper have all been removed. Credit holders should call `JBTokens.claimFor` to materialize their credits as an ERC-20 first, then route through the router as a normal ERC-20 payment.
-
-- Removed: `IJBController` import + `_CASH_OUT_SOURCE_ID` immutable.
-- Removed: 3 test files (`RouterTerminalCreditCashout.t.sol`, `regression/CreditCashoutSpoofedPayer.t.sol`, `regression/CreditCashoutPreferredTokenBypass.t.sol`, `regression/PreviewCashOutShortcircuitDivergence.t.sol`).
-- Changed: `IJBPayRoutePreviewer.previewCashOutLoopOf` signature — dropped the `uint256 sourceProjectIdOverride` parameter (now 5 args).
-- Frees ~580 B of runtime size; reduces attack surface (no msg.sender-vs-originalPayer ambiguity in the credit pull).
-
-Integrator impact: any frontend or backend that constructs the `cashOutSource` metadata key and routes JB credits via the router must switch to a two-step flow (`claimFor` → `router.pay`).
-
-### Threshold-protected `setDefaultTerminal`
-
-The registry owner's `setDefaultTerminal(IJBTerminal)` call now applies only to projects created AFTER the call. Existing projects without an explicit `setTerminalFor` override keep resolving to the default that was current when their project-ID cohort was active. The outgoing default is snapshotted into an append-only `_defaultTerminalHistory` array on every `setDefaultTerminal` call.
-
-- New view: `defaultTerminalFor(uint256 projectId)` returns the default applicable to a specific project (walks history if the project is in a legacy cohort).
-- New view: `defaultTerminalProjectIdThreshold()` returns `PROJECTS.count()` at the time of the most recent `setDefaultTerminal`.
-- New views: `defaultTerminalHistoryAt(uint256 index)` and `defaultTerminalHistoryLength()` expose the snapshot history.
-- New struct: `DefaultTerminalSegment { uint256 maxProjectId; IJBTerminal terminal; }` in `src/structs/`.
-- `lockTerminalFor` now snapshots the *cohort-correct* default into `_terminalOf` (via `_defaultTerminalFor(projectId)`) when locking a project that has no explicit terminal — not the current registry-wide default.
-
-Indexer impact: read `defaultTerminalFor(projectId)` rather than `defaultTerminal()` when computing the effective default for any specific project.
-
-Admin impact: the registry owner can no longer silently reroute payments for already-deployed projects by changing the default. See `ADMINISTRATION.md` for the updated boundary description.
-
-### `0.0.41` — Document multi-hop forwarding-cycle as accepted risk
-
-`JBRouterTerminalRegistry._requireNonCircularTerminalFor` only walks one hop of `IJBForwardingTerminal.terminalOf` when admitting a new explicit or default terminal. A multi-hop `A → B → registry` chain passes admission (the registry only sees `downstream == B ≠ self`), but once locked in, a subsequent `pay`/`addToBalanceOf` recurses through the registry until OOG. The `JBPayRouteResolver` swap-routing path already uses the bounded multi-hop helper `JBForwardingCheck.isCircularTerminal`; the registry admission path does not.
-
-This is documented as accepted in `RISKS.md` (§Registry & Forwarding Risks). Impact is bounded to a self-locking DoS on the project that constructs the multi-hop chain — external actors cannot trigger it, and the project owner can rotate the registry default to recover. Per-PR retrofit cost was judged non-trivial relative to that impact. Project owners installing chained forwarding terminals should run a manual `JBForwardingCheck.isCircularTerminal({target: registry, projectId: …, terminal: candidate})` simulation before approving the candidate.
-
-No runtime code change in this release — documentation only.
-
-## Current v6 surface
-
-- `JBRouterTerminal`
-- `JBRouterTerminalRegistry`
-- `JBPayRouteResolver`
-- `IJBRouterTerminal`
-- `IJBRouterTerminalRegistry`
-- `IJBPayRouteResolver`
-- `IJBPayRoutePreviewer`
-- `IJBForwardingTerminal`
-- `JBSwapLib`
-- `CashOutPathCandidates`
-
-## Summary
-
-- The deployed terminal model changed from a swap terminal to a router terminal. That is a real conceptual change, not just a rename.
-- Route discovery is now part of the product. The current repo is built around discovering paths and destination-token requirements instead of depending on the v5 manual pool-and-TWAP configuration style.
-- The router terminal can reason about JB token cash-out flows as part of routing, which did not match the old swap-terminal mental model.
-- The registry and terminal now share routing vocabulary with the v6 buyback hook through `JBSwapLib`.
-- The repo moved from the v5 `0.8.23` baseline to `0.8.28`.
-
-## Verified deltas
-
-- The old admin surface around `addDefaultPool(...)` and `addTwapParamsFor(...)` is gone from the main interface.
-- `IJBRouterTerminal` now extends `IJBTerminal`.
-- `discoverPool(...)` and `discoverBestPool(...)` are first-class query methods in the interface.
-- The current repo includes `previewPayFor(...)` routing behavior and JB-token cash-out path handling in its implementation and tests.
-
-## Breaking ABI changes
-
-- `IJBSwapTerminal` was replaced by `IJBRouterTerminal`.
-- The old pool-configuration functions are gone from the main terminal interface.
-- The terminal now inherits the broader `IJBTerminal` surface rather than exposing a narrow swap-only ABI.
-- Discovery functions replaced manual pool/TWAP configuration as the public model.
-
-## Indexer impact
-
-- Event topology changed with the router-terminal and registry model; do not assume swap-terminal event families map one-to-one.
-- Off-chain route computation can now rely on explicit discovery and preview methods instead of stored default-pool config.
-
-## Migration notes
-
-- Replace both terminology and ABI assumptions: `JBSwapTerminal` is not the right reference point for a v6 integration.
-- Re-check any off-chain service that used manually configured pool metadata as the primary source of truth.
-- Regenerate ABIs and re-index events from the current router-terminal contracts.
-
-## ABI appendix
-
-- Replaced interface
-  - `IJBSwapTerminal` -> `IJBRouterTerminal`
-- Removed swap-terminal-style admin/config functions
-  - `addDefaultPool(...)`
-  - `addTwapParamsFor(...)`
-- Added router-oriented query functions
-  - `discoverPool(...)`
-  - `discoverBestPool(...)`
-- Surface expansion
-  - now inherits the broader `IJBTerminal` interface