@rev-net/core-v6 0.0.44 → 0.0.46

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rev-net/core-v6",
-  "version": "0.0.44",
+  "version": "0.0.46",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -26,14 +26,14 @@
     "artifacts": "source ./.env && npx sphinx artifacts --org-id 'ea165b21-7cdc-4d7b-be59-ecdd4c26bee4' --project-name 'revnet-core-v6'"
   },
   "dependencies": {
-    "@bananapus/721-hook-v6": "0.0.43",
-    "@bananapus/buyback-hook-v6": "0.0.37",
-    "@bananapus/core-v6": "0.0.42",
-    "@bananapus/ownable-v6": "0.0.24",
-    "@bananapus/permission-ids-v6": "0.0.22",
-    "@bananapus/router-terminal-v6": "0.0.36",
-    "@bananapus/suckers-v6": "0.0.33",
-    "@croptop/core-v6": "0.0.39",
+    "@bananapus/721-hook-v6": "^0.0.47",
+    "@bananapus/buyback-hook-v6": "^0.0.39",
+    "@bananapus/core-v6": "^0.0.44",
+    "@bananapus/ownable-v6": "^0.0.24",
+    "@bananapus/permission-ids-v6": "^0.0.23",
+    "@bananapus/router-terminal-v6": "^0.0.37",
+    "@bananapus/suckers-v6": "^0.0.37",
+    "@croptop/core-v6": "^0.0.42",
     "@openzeppelin/contracts": "5.6.1",
     "@uniswap/permit2": "github:Uniswap/permit2#cc56ad0f3439c502c246fc5cfcc3db92bb8b7219"
   },

package/references/operations.md

@@ -266,6 +266,7 @@ REVConfig memory config = REVConfig({
     }),
     baseCurrency: 1,                       // ETH
     splitOperator: msg.sender,
+    scopeCashOutsToLocalBalances: false,
     stageConfigurations: stages
 });
 

package/script/Deploy.s.sol

@@ -271,6 +271,7 @@ contract DeployScript is Script, Sphinx {
             description: REVDescription({name: NAME, ticker: SYMBOL, uri: PROJECT_URI, salt: ERC20_SALT}),
             baseCurrency: ETH_CURRENCY,
             splitOperator: OPERATOR,
+            scopeCashOutsToLocalBalances: false,
             stageConfigurations: stageConfigurations
         });
 
@@ -497,7 +498,8 @@ contract DeployScript is Script, Sphinx {
                 feeRevnetId: FEE_PROJECT_ID,
                 suckerRegistry: suckers.registry,
                 loans: revloans,
-                hiddenTokens: revHiddenTokens
+                hiddenTokens: revHiddenTokens,
+                deployerBinder: msg.sender
             });
 
         // Deploy REVDeployer with the REVLoans, buyback hook, and REVOwner addresses.

package/src/REVDeployer.sol

@@ -316,11 +316,13 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IERC721Receiver {
 
     /// @notice Make a ruleset configuration for a revnet's stage.
     /// @param baseCurrency The base currency of the revnet.
+    /// @param scopeCashOutsToLocalBalances If true, cash-out calculations use only the local terminal's surplus.
     /// @param stageConfiguration The stage configuration to build a ruleset from.
     /// @param fundAccessLimitGroups The fund access limit groups to include in the ruleset.
     /// @return rulesetConfiguration The ruleset configuration.
     function _makeRulesetConfiguration(
         uint32 baseCurrency,
+        bool scopeCashOutsToLocalBalances,
         REVStageConfig calldata stageConfiguration,
         JBFundAccessLimitGroup[] memory fundAccessLimitGroups
     )
@@ -333,7 +335,7 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IERC721Receiver {
         metadata.reservedPercent = stageConfiguration.splitPercent;
         metadata.cashOutTaxRate = stageConfiguration.cashOutTaxRate;
         metadata.baseCurrency = baseCurrency;
-        metadata.useTotalSurplusForCashOuts = true; // Use surplus from all terminals for cash outs.
+        metadata.scopeCashOutsToLocalBalances = scopeCashOutsToLocalBalances;
         metadata.allowOwnerMinting = true; // Allow this contract to auto-mint tokens as the revnet's owner.
         metadata.useDataHookForPay = true; // Call this contract's `beforePayRecordedWith(…)` callback on payments.
         metadata.useDataHookForCashOut = true; // Call this contract's `beforeCashOutRecordedWith(…)` callback on cash
@@ -940,6 +942,7 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IERC721Receiver {
         // Add the base configuration to the byte-encoded configuration.
         bytes memory encodedConfiguration = abi.encode(
             configuration.baseCurrency,
+            configuration.scopeCashOutsToLocalBalances,
             configuration.description.name,
             configuration.description.ticker,
             configuration.description.salt
@@ -1002,6 +1005,7 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IERC721Receiver {
             // Set up the ruleset.
             rulesetConfigurations[i] = _makeRulesetConfiguration({
                 baseCurrency: configuration.baseCurrency,
+                scopeCashOutsToLocalBalances: configuration.scopeCashOutsToLocalBalances,
                 stageConfiguration: stageConfiguration,
                 fundAccessLimitGroups: fundAccessLimitGroups
             });

package/src/REVLoans.sol

@@ -372,14 +372,19 @@ contract REVLoans is ERC721, ERC2771Context, JBPermissioned, Ownable, IREVLoans
         // for the same collateral changes. A lower cashOutTaxRate in a later stage means more borrowable value per
         // collateral. This is by design: loan value tracks the current bonding curve parameters, just as cash-out
         // value does. Borrowers benefit from decreasing tax rates and are constrained by increasing ones.
-        // Add cross-chain remote values for proportional reclaim.
-        uint256 omnichainSurplus = localSurplus
-            + SUCKER_REGISTRY.remoteSurplusOf({projectId: revnetId, decimals: decimals, currency: currency});
-        uint256 omnichainSupply = localSupply + SUCKER_REGISTRY.remoteTotalSupplyOf(revnetId);
+        // Start with local values. If the ruleset aggregates cross-chain state, add remote supply and surplus.
+        uint256 effectiveSurplus = localSurplus;
+        uint256 effectiveSupply = localSupply;
+        if (!currentStage.scopeCashOutsToLocalBalances()) {
+            effectiveSurplus += SUCKER_REGISTRY.remoteSurplusOf({
+                projectId: revnetId, decimals: decimals, currency: currency
+            });
+            effectiveSupply += SUCKER_REGISTRY.remoteTotalSupplyOf(revnetId);
+        }
         uint256 reclaimable = JBCashOuts.cashOutFrom({
-            surplus: omnichainSurplus,
+            surplus: effectiveSurplus,
             cashOutCount: collateralCount,
-            totalSupply: omnichainSupply,
+            totalSupply: effectiveSupply,
             cashOutTaxRate: currentStage.cashOutTaxRate()
         });
         // Cap at local surplus — can't borrow more than what this chain's terminals actually hold.

package/src/REVOwner.sol

@@ -112,13 +112,16 @@ contract REVOwner is IJBRulesetDataHook, IJBCashOutHook, IJBPeerChainAdjustedAcc
     /// @param suckerRegistry The sucker registry.
     /// @param loans The loan contract.
     /// @param hiddenTokens The hidden tokens contract.
+    /// @param deployerBinder The account allowed to bind the canonical deployer via `setDeployer`. Passed explicitly
+    /// because CREATE2 deployments set `msg.sender` to the factory, not the intended operator.
     constructor(
         IJBBuybackHookRegistry buybackHook,
         IJBDirectory directory,
         uint256 feeRevnetId,
         IJBSuckerRegistry suckerRegistry,
         IREVLoans loans,
-        IREVHiddenTokens hiddenTokens
+        IREVHiddenTokens hiddenTokens,
+        address deployerBinder
     ) {
         BUYBACK_HOOK = buybackHook;
         DIRECTORY = directory;
@@ -126,7 +129,7 @@ contract REVOwner is IJBRulesetDataHook, IJBCashOutHook, IJBPeerChainAdjustedAcc
         SUCKER_REGISTRY = suckerRegistry;
         LOANS = loans;
         HIDDEN_TOKENS = hiddenTokens;
-        _DEPLOYER_BINDER = msg.sender;
+        _DEPLOYER_BINDER = deployerBinder;
     }
 
     //*********************************************************************//
@@ -190,15 +193,19 @@ contract REVOwner is IJBRulesetDataHook, IJBCashOutHook, IJBPeerChainAdjustedAcc
         // Get the terminal that will receive the cash out fee.
         IJBTerminal feeTerminal = DIRECTORY.primaryTerminalOf({projectId: FEE_REVNET_ID, token: context.surplus.token});
 
-        // Compute the cross-chain total supply (local + remote peer chain supplies) for cross-chain-aware bonding
-        // curve.
-        totalSupply = context.totalSupply + totalCollateral + SUCKER_REGISTRY.remoteTotalSupplyOf(context.projectId);
-        effectiveSurplusValue = context.surplus.value + totalBorrowed
-            + SUCKER_REGISTRY.remoteSurplusOf({
+        // Start with local supply and surplus (including collateral and borrowed amounts).
+        totalSupply = context.totalSupply + totalCollateral;
+        effectiveSurplusValue = context.surplus.value + totalBorrowed;
+
+        // If the ruleset aggregates cross-chain state, add remote supply and surplus.
+        if (!context.scopeCashOutsToLocalBalances) {
+            totalSupply += SUCKER_REGISTRY.remoteTotalSupplyOf(context.projectId);
+            effectiveSurplusValue += SUCKER_REGISTRY.remoteSurplusOf({
                 projectId: context.projectId,
                 decimals: context.surplus.decimals,
                 currency: uint256(context.surplus.currency)
             });
+        }
 
         // If there's no cash out tax (100% cash out tax rate), if there's no fee terminal, or if the beneficiary is
         // feeless (e.g. the router terminal routing value between projects), proxy to the buyback hook with our

package/src/structs/REVConfig.sol

@@ -11,10 +11,13 @@ import {REVStageConfig} from "./REVStageConfig.sol";
 /// @custom:member baseCurrency The currency that issuance pricing is denominated in (e.g. ETH or USD).
 /// @custom:member splitOperator The address that receives production splits and can reassign the operator role.
 /// Only the current operator can replace itself after deployment.
+/// @custom:member scopeCashOutsToLocalBalances If true, cash-out calculations use only the local terminal's surplus.
+/// When false, the bonding curve considers surplus from every terminal across all chains.
 /// @custom:member stageConfigurations The ordered stages that define how the revnet's tokenomics evolve over time.
 struct REVConfig {
     REVDescription description;
     uint32 baseCurrency;
     address splitOperator;
+    bool scopeCashOutsToLocalBalances;
     REVStageConfig[] stageConfigurations;
 }