@rev-net/core-v6 0.0.63 → 0.0.65

package/package.json

@@ -1,18 +1,16 @@
 {
   "name": "@rev-net/core-v6",
-  "version": "0.0.63",
+  "version": "0.0.65",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/rev-net/revnet-core-v6"
   },
   "files": [
-    "CHANGELOG.md",
     "foundry.toml",
     "references/",
     "remappings.txt",
-    "script/Deploy.s.sol",
-    "script/helpers/",
+    "script/",
     "src/"
   ],
   "engines": {

package/src/REVLoans.sol

@@ -72,6 +72,8 @@ contract REVLoans is ERC721, ERC2771Context, JBPermissioned, Ownable, IREVLoans
     error REVLoans_PermitAllowanceNotEnough(uint256 allowanceAmount, uint256 requiredAmount);
     error REVLoans_ReallocatingMoreCollateralThanBorrowedAmountAllows(uint256 newBorrowAmount, uint256 loanAmount);
     error REVLoans_ReentrantLoanAction();
+    error REVLoans_ReferralChainIdTooLarge(uint256 referralChainId);
+    error REVLoans_ReferralProjectIdTooLarge(uint256 referralProjectId);
     error REVLoans_SourceMismatch(address expectedToken, address actualToken);
     error REVLoans_UnderMinBorrowAmount(uint256 minBorrowAmount, uint256 borrowAmount);
     error REVLoans_ZeroBorrowAmount(uint256 revnetId, uint256 collateralCount);
@@ -138,6 +140,12 @@ contract REVLoans is ERC721, ERC2771Context, JBPermissioned, Ownable, IREVLoans
     /// @custom:param token The token source to check.
     mapping(uint256 revnetId => mapping(address token => bool)) public override isLoanSourceOf;
 
+    /// @notice The packed `(referralChainId << 48) | referralProjectId` reference credited as the referrer on every
+    /// `useAllowanceOf` call this contract makes against `TERMINAL`. Defaults to `(1, REV_ID)` so fee-volume credit
+    /// accrues to the REV revnet on Ethereum mainnet regardless of which chain the loan originates from. Settable
+    /// by the contract owner via `setReferralProjectId` to retarget governance (e.g. if REV migrates chains).
+    uint256 public override referralProjectId;
+
     /// @notice The contract resolving each project ID to its ERC721 URI.
     IJBTokenUriResolver public override tokenUriResolver;
 
@@ -212,6 +220,10 @@ contract REVLoans is ERC721, ERC2771Context, JBPermissioned, Ownable, IREVLoans
         REV_ID = revId;
         PERMIT2 = permit2;
         SUCKER_REGISTRY = suckerRegistry;
+
+        // Default referrer reference: REV revnet on Ethereum mainnet. Encoded `(chainId << 48) | projectId` per
+        // `JBMultiTerminal.currentReferralProjectId`. Owner can retarget via `setReferralProjectId`.
+        referralProjectId = (uint256(1) << 48) | revId;
     }
 
     //*********************************************************************//
@@ -945,6 +957,36 @@ contract REVLoans is ERC721, ERC2771Context, JBPermissioned, Ownable, IREVLoans
         }
     }
 
+    /// @notice Update the referrer reference credited on every `useAllowanceOf` call this contract makes.
+    /// @dev Stores the packed `(newReferralChainId << 48) | newReferralProjectId` value used by
+    /// `JBMultiTerminal.currentReferralProjectId`. Either field may be zero — passing `(0, 0)` disables the
+    /// referral credit entirely (the terminal treats `referralProjectId == 0` as "no credit"). Bounded so the
+    /// pack is lossless: `newReferralProjectId` must fit in `uint48`, `newReferralChainId` must fit in
+    /// `uint208` (so the left-shift by 48 doesn't drop high bits).
+    /// @param newReferralProjectId The referring project's bare ID on `newReferralChainId`.
+    /// @param newReferralChainId The EIP-155 chain ID of the referrer's home chain.
+    function setReferralProjectId(
+        uint256 newReferralProjectId,
+        uint256 newReferralChainId
+    )
+        external
+        override
+        onlyOwner
+    {
+        // Bound the inputs to the on-chain encoding so the pack is lossless. The same shape JBMultiTerminal uses:
+        // projectId in bits [47:0], chainId in bits [255:48].
+        if (newReferralProjectId > type(uint48).max) {
+            revert REVLoans_ReferralProjectIdTooLarge(newReferralProjectId);
+        }
+        if (newReferralChainId >> 208 != 0) revert REVLoans_ReferralChainIdTooLarge(newReferralChainId);
+
+        referralProjectId = (newReferralChainId << 48) | newReferralProjectId;
+
+        emit SetReferralProjectId({
+            referralChainId: newReferralChainId, referralProjectId: newReferralProjectId, caller: _msgSender()
+        });
+    }
+
     /// @notice Set the address of the resolver used to retrieve the tokenURI of loans.
     /// @param resolver The address of the new resolver.
     function setTokenUriResolver(IJBTokenUriResolver resolver) external override onlyOwner {
@@ -1055,16 +1097,12 @@ contract REVLoans is ERC721, ERC2771Context, JBPermissioned, Ownable, IREVLoans
             JBAccountingContext memory context =
                 TERMINAL.accountingContextForTokenOf({projectId: revnetId, token: sourceToken});
 
-            // Pull the amount to be loaned out of the revnet. This will incure the protocol fee. Crediting `REV_ID`
-            // as the referrer attributes the protocol fee volume from every Revnet loan back to the REV revnet
-            // itself — REV is the project that facilitated the activity, regardless of which revnet is borrowing.
-            //
-            // The referrer reference is encoded as `(referralChainId << 48) | referralProjectId` per
-            // `JBMultiTerminal`'s `currentReferralProjectId` packing. REV lives on Ethereum mainnet, so we hard-code
-            // `referralChainId = 1`
-            // here: this ensures the protocol fee volume credit accrues to REV on mainnet regardless of which chain
-            // the loan originates from. (Auto-resolving to `block.chainid` would scatter credit across L2s where REV
-            // has no canonical project ID, so we pin mainnet explicitly.)
+            // Pull the amount to be loaned out of the revnet. This will incure the protocol fee. The configured
+            // `referralProjectId` (default `(1, REV_ID)`, owner-settable via `setReferralProjectId`) attributes the
+            // protocol fee volume from every Revnet loan back to the REV revnet — REV is the project that
+            // facilitated the activity, regardless of which revnet is borrowing. The packing is
+            // `(chainId << 48) | projectId` per `JBMultiTerminal.currentReferralProjectId`; pinning mainnet by
+            // default avoids scattering credit across L2s where REV has no canonical project ID.
             netAmountPaidOut = TERMINAL.useAllowanceOf({
                 projectId: revnetId,
                 token: sourceToken,
@@ -1074,7 +1112,7 @@ contract REVLoans is ERC721, ERC2771Context, JBPermissioned, Ownable, IREVLoans
                 beneficiary: payable(address(this)),
                 feeBeneficiary: beneficiary,
                 memo: "",
-                referralProjectId: (uint256(1) << 48) | REV_ID
+                referralProjectId: referralProjectId
             });
         }
 

package/src/interfaces/IREVLoans.sol

@@ -82,6 +82,12 @@ interface IREVLoans {
         address caller
     );
 
+    /// @notice Emitted when the referrer reference for fee-volume credit is updated.
+    /// @param referralChainId The EIP-155 chain ID of the new referrer's home chain.
+    /// @param referralProjectId The new referring project's bare project ID on `referralChainId`.
+    /// @param caller The address that set the new referrer.
+    event SetReferralProjectId(uint256 indexed referralChainId, uint256 indexed referralProjectId, address caller);
+
     /// @notice Emitted when the token URI resolver is changed.
     /// @param resolver The new token URI resolver.
     /// @param caller The address that set the resolver.
@@ -162,6 +168,12 @@ interface IREVLoans {
     /// @return The prices contract.
     function PRICES() external view returns (IJBPrices);
 
+    /// @notice The packed `(referralChainId << 48) | referralProjectId` reference credited as the referrer on
+    /// every `useAllowanceOf` call this contract makes. Defaults to `(1, REV_ID)` so credit accrues to REV on
+    /// Ethereum mainnet; owner-settable via `setReferralProjectId`.
+    /// @return The packed referrer reference.
+    function referralProjectId() external view returns (uint256);
+
     /// @notice The ID of the REV revnet that receives protocol fees from loans.
     /// @return The REV revnet ID.
     function REV_ID() external view returns (uint256);
@@ -277,6 +289,15 @@ interface IREVLoans {
         payable
         returns (uint256 paidOffLoanId, REVLoan memory paidOffloan);
 
+    /// @notice Update the referrer reference credited on every `useAllowanceOf` call this contract makes.
+    /// @dev Stores the packed `(newReferralChainId << 48) | newReferralProjectId` value used by
+    /// `JBMultiTerminal.currentReferralProjectId`. Either field may be zero (passing `(0, 0)` disables the
+    /// referral credit). Bounded so the pack is lossless: `newReferralProjectId <= type(uint48).max`,
+    /// `newReferralChainId <= type(uint208).max`.
+    /// @param newReferralProjectId The referring project's bare ID on `newReferralChainId`.
+    /// @param newReferralChainId The EIP-155 chain ID of the referrer's home chain.
+    function setReferralProjectId(uint256 newReferralProjectId, uint256 newReferralChainId) external;
+
     /// @notice Set the address of the resolver used to retrieve the token URI of loans.
     /// @param resolver The new token URI resolver.
     function setTokenUriResolver(IJBTokenUriResolver resolver) external;

package/CHANGELOG.md

@@ -1,112 +0,0 @@
-# Changelog
-
-## 0.0.62 — Omit unset router terminal registry
-
-- `REVDeployer` now omits `ROUTER_TERMINAL_REGISTRY` from the canonical terminal configuration when it was
-  constructed with `address(0)`.
-- This supports chains where the router terminal stack is unavailable while still launching revnets with the canonical
-  multi terminal.
-
-## 0.0.56 — Bump v6 deps to nana-core-v6 0.0.53 cohort
-
-- `@bananapus/core-v6`: `^0.0.48 → ^0.0.53` ([PR #145](https://github.com/Bananapus/nana-core-v6/pull/145)).
-- `@bananapus/721-hook-v6`: `^0.0.47 → ^0.0.50`.
-- `@bananapus/buyback-hook-v6`: `^0.0.39 → ^0.0.46`.
-- `@bananapus/router-terminal-v6`: `^0.0.37 → ^0.0.43`.
-- `@bananapus/suckers-v6`: `^0.0.37 → ^0.0.46`.
-- `@bananapus/permission-ids-v6`: `^0.0.24 → ^0.0.25`.
-- Test updates:
-  - `jbMultiTerminal().FEE()` → `JBConstants.FEE` (FEE moved to a compile-time constant in core 0.0.52+).
-  - `JBBuybackHook` constructor signature changed in 0.0.45 (V4 PoolManager + Hooks moved to a one-shot setter). Updated `ForkTestBase` and `TestSplitWeightFork` to construct then call `setChainSpecificConstants`.
-  - All `JBRulesetMetadata` test literals patched to include `pauseCrossProjectFeeFreeInflows: false`. `REVConfig` and `JBBeforeCashOutRecordedContext` literals are unchanged (no new fields).
-
-## Scope
-
-This file describes the verified change from `revnet-core-v5` to the current `revnet-core-v6` repo.
-
-## Current v6 surface
-
-- `REVDeployer`
-- `REVOwner`
-- `REVLoans`
-- `IREVDeployer`
-- `IREVOwner`
-- `IREVLoans`
-
-## Summary
-
-- The current repo assumes 721 hooks are part of the normal revnet deployment path rather than a separate special case.
-- Buyback and loans configuration are more centralized than in v5. The repo is oriented around shared infrastructure instead of repeating per-revnet setup.
-- `REVOwner` is now a real part of the repo's runtime surface. That split matters because the hook behavior no longer lives only on `REVDeployer`.
-- The v6 test tree is substantially broader than the v5 tree, with dedicated regression, fork, attack, and invariant coverage for loans, cash-outs, split weights, and lifecycle edges.
-- The repo moved from the v5 `0.8.23` baseline to `0.8.28`.
-
-## In-v6 changes
-
-### `0.0.52` — Cap reported surplus on `REVOwner.beforeCashOutRecordedWith` to fit local liquidity
-
-PR #149 scaled the fee + reclaim proportionally when the gross global outflow exceeded local terminal liquidity, preserving a nonzero fee. But the data hook still returned the **unscaled** `effectiveSurplusValue` to `JBTerminalStore._cashOutWithDataHook`, which recomputes the beneficiary reclaim as `cashOutFrom(effSurplus, cashOutCount, totalSupply, taxRate)` and caps it at local surplus before adding the fee spec — so `balanceDiff = localSurplus + feeAmount > localSurplus` reverted with `InadequateTerminalStoreBalance`. Omnichain holders could not cash out locally when global surplus dominated.
-
-`cashOutFrom` is linear in `surplus`. After the existing PR #149 scaling, `REVOwner` now lowers the reported `effectiveSurplusValue` proportionally so the store's recomputed reclaim is at most `localSurplus - feeAmount`, leaving exact room for the (preserved) fee spec. The buyback hook still receives the full pre-cap global surplus for its routing decision — only the store-facing return is capped.
-
-The fee is **never** trimmed or zeroed: that was the regression PR #149 fixed.
-
-Integrator impact: omnichain cash-outs that previously reverted with `InadequateTerminalStoreBalance` when local liquidity was the binding cap now settle. The beneficiary receives `localSurplus - feeAmount` and the fee revnet receives `feeAmount`. The user still burns the full `context.cashOutCount` tokens — semantics are the same as the pre-existing local-cap protocol behavior, just now reachable end-to-end.
-
-## Operator delegation
-
-- Added new `JBPermissionIds` for operator delegation in `@bananapus/permission-ids-v6`:
-  - `OPEN_LOAN` — open a loan on behalf of a token holder via `REVLoans.borrowFrom`
-  - `REALLOCATE_LOAN` — reallocate loan collateral on behalf of a loan owner via `REVLoans.reallocateCollateralFromLoan`
-  - `REPAY_LOAN` — repay a loan on behalf of a loan owner via `REVLoans.repayLoan`
-- `REVLoans.borrowFrom` now accepts a `holder` parameter. The loan NFT is minted to `holder`, and collateral is burned from `holder`. An operator with `OPEN_LOAN` permission can borrow on behalf of a holder.
-- `REVLoans.repayLoan` now allows permissioned operators with `REPAY_LOAN` to repay on behalf of the loan NFT owner. Replacement loans are minted to the original loan owner.
-- `REVLoans.reallocateCollateralFromLoan` now allows permissioned operators with `REALLOCATE_LOAN` to reallocate on behalf of the loan NFT owner. Returned collateral and replacement loans go to the original loan owner.
-- `REVLoans` stores a `PERMISSIONS` immutable for inline permission checks (cannot inherit `JBPermissioned` due to existing `ERC721 + ERC2771Context + Ownable` inheritance).
-
-### Breaking ABI changes from delegation
-
-- `IREVLoans.borrowFrom` signature changed: added `address holder` as last parameter
-
-## Verified deltas
-
-- `IREVDeployer.deployWith721sFor(...)` is gone.
-- `IREVDeployer.deployFor(...)` now has overloads that return `(uint256, IJB721TiersHook)`.
-- `IREVDeployer.BUYBACK_HOOK()`, `LOANS()`, and `OWNER()` are explicit v6 surface area.
-- `IREVOwner` is a new interface and runtime counterpart to the deployer.
-- The old caller-supplied `REVBuybackHookConfig` path is no longer part of the deployer interface.
-
-## Breaking ABI changes
-
-- `deployWith721sFor(...)` was removed.
-- `deployFor(...)` overloads changed shape and return the deployed 721 hook.
-- `REVConfig` no longer carries `loanSources` or `loans`.
-- `REVDeploy721TiersHookConfig` now uses `REVBaseline721HookConfig` and inverted `preventOperator*` booleans.
-- `IREVOwner` is a new interface that some integrations must track separately from `IREVDeployer`.
-
-## Indexer impact
-
-- Runtime hook activity may now come from `REVOwner`, not only `REVDeployer`.
-- Deployment indexing should assume a 721 hook is returned and present by default.
-- Any schema built around caller-supplied buyback-hook config in deploy events needs to be revisited.
-
-## Migration notes
-
-- Re-check any integration that assumed `REVDeployer` was the only important runtime address. `REVOwner` now matters.
-- Update deployment and indexing code for the default-721-hook assumption.
-- Rebuild ABI expectations from the current interfaces and structs. The revnet surface is not a light-touch v5 upgrade.
-
-## ABI appendix
-
-- Removed functions
-  - `deployWith721sFor(...)`
-- Changed functions
-  - `deployFor(...)` overloads now return the 721 hook
-- Added interfaces / runtime addresses
-  - `IREVOwner`
-  - `OWNER()`
-- Changed structs
-  - `REVConfig`
-  - `REVDeploy721TiersHookConfig`
-- Removed config path
-  - caller-supplied `REVBuybackHookConfig`