@bananapus/core-v6 0.0.53 → 0.0.55

package/CHANGELOG.md

@@ -13,17 +13,6 @@ This file describes the verified change from `nana-core-v5` to the current `nana
 - `JBTokens`
 - the shared core interfaces, structs, and libraries under `src/`
 
-## 0.0.53 — Drop the `via_ir` requirement
-
-`JBCashOutHookSpecsLib.fulfill` originally took 10 named arguments. When `JBMultiTerminal._cashOutTokensOf` and `_payAfterCashOutTokensOf` called it, the call site ran past solc 0.8.28's 16-slot Yul stack ceiling, which forced every consumer of `@bananapus/core-v6` to enable `via_ir = true` in their own `foundry.toml` profile. That cascaded into stack-too-deep failures in downstream packages whose own functions couldn't tolerate `via_ir` (notably `nana-721-hook-v6`'s `JB721TiersHookStore.tiersOf`).
-
-This release reshapes `fulfill` to accept the existing `JBAfterCashOutRecordedContext` directly — the same struct the hook receives — so no parallel arg bundle is needed. The new signature is `fulfill(IJBFeelessAddresses, JBAfterCashOutRecordedContext, JBCashOutHookSpecification[])`. The per-iteration loop body is extracted into a private `_fulfillOne` helper so its locals don't share `fulfill`'s stack frame. Both call sites in `JBMultiTerminal` build the context field-by-field (one stack slot per assignment) instead of via a struct literal (which would push all ten fields onto the stack at once and trip the same ceiling at the caller).
-
-Integrator impact:
-- `JBCashOutHookSpecsLib.fulfill(IJBFeelessAddresses, uint256, JBTokenAmount, address, uint256, bytes, JBRuleset, uint256, address payable, JBCashOutHookSpecification[])` → `fulfill(IJBFeelessAddresses, JBAfterCashOutRecordedContext, JBCashOutHookSpecification[])`. The only on-chain caller is `JBMultiTerminal` (this PR updates both call sites), so the public ABI surface of `JBMultiTerminal` is unchanged.
-- Consumers of `@bananapus/core-v6@^0.0.53` can drop `via_ir = true` from their `foundry.toml` profiles if they only enabled it because of `JBCashOutHookSpecsLib`. `nana-core-v6`'s own profile flips `via_ir` to `false` to lock in the property.
-- All 997 unit/non-fork tests pass on the refactored library + call sites.
-
 ## Summary
 
 - v6 adds explicit preview APIs for pay and cash-out flows. Integrations can simulate more of the terminal path directly from the core contracts.
@@ -41,23 +30,6 @@ Integrator impact:
 - `IJBController.addPriceFeed(...)` became `addPriceFeedFor(...)`.
 - `IJBTerminal.currentSurplusOf(...)` now takes `address[] calldata tokens` instead of the old accounting-context array input.
 - The interface surface adds explicit hook-spec return types to preview flows, which changes what off-chain callers can and should decode.
-- `IJBCashOutTerminal.payAfterCashOutTokensOf(...)` is new. It burns source-project tokens and pays the
-  reclaim into another project via that project's primary terminal for the reclaim token (which may itself
-  be a router that swaps before paying). Source-side cashout fee is skipped; the equivalent fee is bound on
-  the destination project's side by crediting `_feeFreeSurplusOf[beneficiaryProjectId][token]` on the first of the destination project's accounting contexts on this
-  terminal whose balance grows during the routing. Reverts if no delivery lands on this terminal under any
-  of the destination project's accounting contexts.
-- `IJBCashOutTerminal.addToBalanceAfterCashOutTokensOf(...)` is new. Sibling of
-  `payAfterCashOutTokensOf` that adds the reclaim to the destination project's balance instead of paying
-  (no destination tokens minted). Same source-side fee-skip + destination-side `_feeFreeSurplusOf` credit
-  semantics, same opt-out via `pauseCrossProjectFeeFreeInflows`. Held-fee return on the destination side
-  is hardcoded to `false` so this entrypoint cannot unlock B's held fees.
-- `JBRulesetMetadata.pauseCrossProjectFeeFreeInflows` is new (bit 80 in the packed metadata word). Opt-out
-  flag on the destination project's current ruleset; when set, `payAfterCashOutTokensOf` and
-  `addToBalanceAfterCashOutTokensOf` calls targeting the destination project revert. Default
-  `false` allows inflows — matching the existing intra-terminal payout semantic where receiving projects
-  accumulate `_feeFreeSurplusOf` credits from other projects' outflows. The trailing `metadata` field
-  narrowed from 14 to 13 bits to make room.
 
 ## Breaking ABI changes
 
@@ -66,16 +38,8 @@ Integrator impact:
 - `IJBController.previewMintOf(...)` is new.
 - `IJBTerminal.previewPayFor(...)` is new.
 - `IJBCashOutTerminal.previewCashOutFrom(...)` is new.
-- `IJBCashOutTerminal.payAfterCashOutTokensOf(...)` is new.
-- `IJBCashOutTerminal.addToBalanceAfterCashOutTokensOf(...)` is new.
-- `IJBFeeTerminal.FEE()` is REMOVED. The terminal no longer re-exports the protocol fee constant; read
-  `JBConstants.FEE` directly. Off-chain integrators that previously called `terminal.FEE()` must switch to
-  reading the constant from `JBConstants`.
 - `IJBTerminalStore.previewPayFrom(...)` and `previewCashOutFrom(...)` are new.
 - `IJBTerminal.currentSurplusOf(...)` changed parameter shape.
-- `JBRulesetMetadata` adds `pauseCrossProjectFeeFreeInflows` and narrows `metadata` from 14 to 13 bits.
-  Packed `JBRuleset.metadata` layout has shifted accordingly. Integrators that read the packed word directly
-  must rebuild against the new layout.
 
 ## Indexer impact
 
@@ -94,24 +58,12 @@ Integrator impact:
 - Added functions
   - `IJBTerminal.previewPayFor(...)`
   - `IJBCashOutTerminal.previewCashOutFrom(...)`
-  - `IJBCashOutTerminal.payAfterCashOutTokensOf(...)`
-  - `IJBCashOutTerminal.addToBalanceAfterCashOutTokensOf(...)`
   - `IJBTerminalStore.previewPayFrom(...)`
   - `IJBTerminalStore.previewCashOutFrom(...)`
   - `IJBController.previewMintOf(...)`
   - `IJBController.setTokenMetadataOf(...)`
-- Added ruleset metadata flags
-  - `JBRulesetMetadata.pauseCrossProjectFeeFreeInflows` (bit 80; narrowed `metadata` field from 14 to 13 bits)
-- Added libraries
-  - `JBHeldFeesLib` (held-fee bookkeeping extracted from `JBMultiTerminal` to relieve bytecode budget;
-    called via delegatecall, storage refs preserved)
-  - `JBCashOutHookSpecsLib` (cash-out hook specification fulfillment extracted from `JBMultiTerminal` to
-    relieve bytecode budget after adding `addToBalanceAfterCashOutTokensOf`; called via delegatecall, emits
-    `HookAfterRecordCashOut` from the terminal address)
 - Renamed functions
   - `IJBController.addPriceFeed(...)` -> `addPriceFeedFor(...)`
-- Removed functions
-  - `IJBFeeTerminal.FEE()` (read `JBConstants.FEE` directly)
 - Changed function shapes
   - `IJBTerminal.currentSurplusOf(...)`
 - Added events

package/foundry.toml

@@ -3,7 +3,6 @@ solc = '0.8.28'
 bytecode_hash = "none"
 evm_version = 'cancun'
 optimizer_runs = 200
-via_ir = false
 libs = ["node_modules", "lib"]
 fs_permissions = [{ access = "read-write", path = "./"}]
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bananapus/core-v6",
-  "version": "0.0.53",
+  "version": "0.0.55",
   "license": "MIT",
   "repository": {
     "type": "git",

package/script/helpers/CoreDeploymentLib.sol

@@ -43,11 +43,10 @@ library CoreDeploymentLib {
     string constant PROJECT_NAME = "nana-core-v6";
 
     function getDeployment(string memory path) internal returns (CoreDeployment memory deployment) {
-        // get chainId for which we need to get the deployment.
+        // Match the current chain ID to the Sphinx network name used in deployment artifacts.
         uint256 chainId = block.chainid;
 
-        // Deploy to get the constants.
-        // TODO: get constants without deploy.
+        // `SphinxConstants` exposes Sphinx's supported chain ID to network name mapping.
         SphinxConstants sphinxConstants = new SphinxConstants();
         NetworkInfo[] memory networks = sphinxConstants.getNetworkInfoArray();
 

package/src/JBController.sol

@@ -1061,7 +1061,8 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
             JBSplit memory split = splits[i];
 
             // Calculate the amount to send to the split.
-            uint256 splitTokenCount = mulDiv(tokenCount, split.percent, JBConstants.SPLITS_TOTAL_PERCENT);
+            uint256 splitTokenCount =
+                mulDiv({x: tokenCount, y: split.percent, denominator: JBConstants.SPLITS_TOTAL_PERCENT});
 
             // Mints tokens for the split if needed.
             if (splitTokenCount > 0) {
@@ -1264,8 +1265,11 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
         returns (uint256 beneficiaryTokenCount, uint256 reservedTokenCount)
     {
         // Compute the beneficiary's portion after removing the reserved share.
-        beneficiaryTokenCount =
-            mulDiv(tokenCount, JBConstants.MAX_RESERVED_PERCENT - reservedPercent, JBConstants.MAX_RESERVED_PERCENT);
+        beneficiaryTokenCount = mulDiv({
+            x: tokenCount,
+            y: JBConstants.MAX_RESERVED_PERCENT - reservedPercent,
+            denominator: JBConstants.MAX_RESERVED_PERCENT
+        });
 
         // The remaining tokens are reserved.
         reservedTokenCount = tokenCount - beneficiaryTokenCount;

package/src/JBERC20.sol

@@ -41,7 +41,7 @@ contract JBERC20 is ERC20Votes, ERC20Permit, JBPermissioned, IERC1271, IJBToken
 
     /// @notice The JBTokens contract that owns this token.
     /// @dev Set via `initialize` because JBERC20 is deployed before JBTokens (circular dependency).
-    IJBTokens public TOKENS;
+    IJBTokens public tokens;
 
     //*********************************************************************//
     // -------------------- private stored properties -------------------- //
@@ -80,7 +80,7 @@ contract JBERC20 is ERC20Votes, ERC20Permit, JBPermissioned, IERC1271, IJBToken
     /// @notice Only the JBTokens contract can call this function.
     // forge-lint: disable-next-line(unwrapped-modifier-logic)
     modifier onlyTokens() {
-        if (msg.sender != address(TOKENS)) revert JBERC20_Unauthorized({caller: msg.sender, tokens: address(TOKENS)});
+        if (msg.sender != address(tokens)) revert JBERC20_Unauthorized({caller: msg.sender, tokens: address(tokens)});
         _;
     }
 
@@ -130,11 +130,11 @@ contract JBERC20 is ERC20Votes, ERC20Permit, JBPermissioned, IERC1271, IJBToken
     /// @return magicValue `0x1626ba7e` if the signature is valid, `0xffffffff` otherwise.
     function isValidSignature(bytes32 hash, bytes memory signature) external view override returns (bytes4 magicValue) {
         // Recover the signer from the signature. Return invalid if recovery fails.
-        (address signer, ECDSA.RecoverError error,) = ECDSA.tryRecover(hash, signature);
+        (address signer, ECDSA.RecoverError error,) = ECDSA.tryRecover({hash: hash, signature: signature});
         if (error != ECDSA.RecoverError.NoError) return 0xffffffff;
 
         // Get the project ID this token belongs to.
-        uint256 projectId = TOKENS.projectIdOf(IJBToken(address(this)));
+        uint256 projectId = tokens.projectIdOf(IJBToken(address(this)));
 
         // Get the project owner (the NFT holder).
         address projectOwner = PROJECTS.ownerOf(projectId);
@@ -195,8 +195,8 @@ contract JBERC20 is ERC20Votes, ERC20Permit, JBPermissioned, IERC1271, IJBToken
     /// @notice Initialize a new project token with the given name, symbol, and owner.
     /// @param name_ The token's name.
     /// @param symbol_ The token's symbol.
-    /// @param tokens The JBTokens contract that manages this token.
-    function initialize(string memory name_, string memory symbol_, address tokens) public override {
+    /// @param tokensAddress The JBTokens contract that manages this token.
+    function initialize(string memory name_, string memory symbol_, address tokensAddress) public override {
         // Prevent re-initialization by reverting if a name is already set or if the provided name is empty.
         if (bytes(_name).length != 0 || bytes(name_).length == 0) {
             revert JBERC20_AlreadyInitialized({
@@ -206,7 +206,7 @@ contract JBERC20 is ERC20Votes, ERC20Permit, JBPermissioned, IERC1271, IJBToken
 
         _name = name_;
         _symbol = symbol_;
-        TOKENS = IJBTokens(tokens);
+        tokens = IJBTokens(tokensAddress);
     }
 
     //*********************************************************************//

package/src/JBFeelessAddresses.sol

@@ -5,12 +5,28 @@ import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
 import {IJBFeelessAddresses} from "./interfaces/IJBFeelessAddresses.sol";
+import {IJBFeelessHook} from "./interfaces/IJBFeelessHook.sol";
 
 /// @notice A registry of addresses exempt from the protocol's 2.5% fee. Feeless addresses don't incur fees on
 /// payouts they receive, surplus allowance they use, or cash outs where they are the beneficiary.
 /// @dev All feeless status is managed by the contract owner (typically the protocol multisig).
 /// @dev `projectId = 0` is the wildcard — an address feeless for project 0 is feeless for ALL projects.
 contract JBFeelessAddresses is Ownable, IJBFeelessAddresses, IERC165 {
+    //*********************************************************************//
+    // --------------------------- custom errors ------------------------- //
+    //*********************************************************************//
+
+    error JBFeelessAddresses_InvalidFeelessHook(IJBFeelessHook hook);
+
+    //*********************************************************************//
+    // --------------------- public stored properties -------------------- //
+    //*********************************************************************//
+
+    /// @notice Optional hook consulted (in addition to the static mappings) when computing feeless status.
+    /// @dev OR'd with the mappings — the hook can only widen the feeless set, never shrink it. `address(0)` disables
+    /// hook consultation.
+    IJBFeelessHook public override feelessHook;
+
     //*********************************************************************//
     // -------------------- internal stored properties ------------------- //
     //*********************************************************************//
@@ -53,19 +69,48 @@ contract JBFeelessAddresses is Ownable, IJBFeelessAddresses, IERC165 {
         emit SetFeelessAddress({projectId: projectId, addr: addr, isFeeless: flag, caller: _msgSender()});
     }
 
+    /// @notice Sets (or clears) the feeless hook consulted by `isFeelessFor`.
+    /// @dev Can only be called by this contract's owner (typically the protocol multisig).
+    /// @dev If `hook` is non-zero, it must report ERC-165 support for `IJBFeelessHook` or this call reverts.
+    /// @param hook The new hook. Pass `address(0)` to disable hook consultation.
+    function setFeelessHook(IJBFeelessHook hook) external virtual override onlyOwner {
+        if (address(hook) != address(0) && !hook.supportsInterface(type(IJBFeelessHook).interfaceId)) {
+            revert JBFeelessAddresses_InvalidFeelessHook(hook);
+        }
+
+        feelessHook = hook;
+
+        emit SetFeelessHook({hook: hook, caller: _msgSender()});
+    }
+
     //*********************************************************************//
-    // -------------------------- public views --------------------------- //
+    // ------------------------- external views -------------------------- //
     //*********************************************************************//
 
-    /// @notice Returns whether the specified address is feeless for a specific project, considering both the wildcard
-    /// (projectId 0) and project-specific feeless status.
+    /// @notice Returns whether the specified address is feeless for a specific project, considering the wildcard
+    /// (projectId 0) feeless status, the project-specific feeless status, and the feeless hook (if set).
+    /// @dev The hook is invoked via try/catch — a reverting or out-of-gas hook is treated as `false` so it cannot
+    /// brick the fee path in terminals.
     /// @param addr The address to check.
     /// @param projectId The ID of the project to check.
-    /// @return A flag indicating whether the address is feeless (globally or for the project).
+    /// @return A flag indicating whether the address is feeless (globally, for the project, or per the hook).
     function isFeelessFor(address addr, uint256 projectId) external view override returns (bool) {
-        return _isFeelessFor[0][addr] || _isFeelessFor[projectId][addr];
+        if (_isFeelessFor[0][addr] || _isFeelessFor[projectId][addr]) return true;
+
+        IJBFeelessHook hook = feelessHook;
+        if (address(hook) == address(0)) return false;
+
+        try hook.isFeeless({projectId: projectId, addr: addr}) returns (bool result) {
+            return result;
+        } catch {
+            return false;
+        }
     }
 
+    //*********************************************************************//
+    // -------------------------- public views --------------------------- //
+    //*********************************************************************//
+
     /// @notice Indicates whether this contract adheres to the specified interface.
     /// @dev See {IERC165-supportsInterface}.
     /// @param interfaceId The ID of the interface to check for adherence to.