@rev-net/core-v6 0.0.7 → 0.0.9

package/src/REVDeployer.sol

@@ -1,15 +1,17 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
+import {ERC2771Context} from "@openzeppelin/contracts/metatx/ERC2771Context.sol";
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
 import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
-import {ERC2771Context} from "@openzeppelin/contracts/metatx/ERC2771Context.sol";
-import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import {mulDiv} from "@prb/math/src/Common.sol";
 import {IJB721TiersHook} from "@bananapus/721-hook-v6/src/interfaces/IJB721TiersHook.sol";
 import {IJB721TiersHookDeployer} from "@bananapus/721-hook-v6/src/interfaces/IJB721TiersHookDeployer.sol";
-import {IJBBuybackHook} from "@bananapus/buyback-hook-v6/src/interfaces/IJBBuybackHook.sol";
+import {JB721TiersHookFlags} from "@bananapus/721-hook-v6/src/structs/JB721TiersHookFlags.sol";
+import {JBDeploy721TiersHookConfig} from "@bananapus/721-hook-v6/src/structs/JBDeploy721TiersHookConfig.sol";
+import {IJBBuybackHookRegistry} from "@bananapus/buyback-hook-v6/src/interfaces/IJBBuybackHookRegistry.sol";
 import {IJBCashOutHook} from "@bananapus/core-v6/src/interfaces/IJBCashOutHook.sol";
 import {IJBController} from "@bananapus/core-v6/src/interfaces/IJBController.sol";
 import {IJBDirectory} from "@bananapus/core-v6/src/interfaces/IJBDirectory.sol";
@@ -26,19 +28,20 @@ import {JBConstants} from "@bananapus/core-v6/src/libraries/JBConstants.sol";
 import {JBSplitGroupIds} from "@bananapus/core-v6/src/libraries/JBSplitGroupIds.sol";
 import {JBAccountingContext} from "@bananapus/core-v6/src/structs/JBAccountingContext.sol";
 import {JBAfterCashOutRecordedContext} from "@bananapus/core-v6/src/structs/JBAfterCashOutRecordedContext.sol";
-import {JBBeforePayRecordedContext} from "@bananapus/core-v6/src/structs/JBBeforePayRecordedContext.sol";
 import {JBBeforeCashOutRecordedContext} from "@bananapus/core-v6/src/structs/JBBeforeCashOutRecordedContext.sol";
+import {JBBeforePayRecordedContext} from "@bananapus/core-v6/src/structs/JBBeforePayRecordedContext.sol";
+import {JBCashOutHookSpecification} from "@bananapus/core-v6/src/structs/JBCashOutHookSpecification.sol";
 import {JBCurrencyAmount} from "@bananapus/core-v6/src/structs/JBCurrencyAmount.sol";
 import {JBFundAccessLimitGroup} from "@bananapus/core-v6/src/structs/JBFundAccessLimitGroup.sol";
-import {JBPermissionsData} from "@bananapus/core-v6/src/structs/JBPermissionsData.sol";
 import {JBPayHookSpecification} from "@bananapus/core-v6/src/structs/JBPayHookSpecification.sol";
+import {JBPermissionsData} from "@bananapus/core-v6/src/structs/JBPermissionsData.sol";
 import {JBRuleset} from "@bananapus/core-v6/src/structs/JBRuleset.sol";
 import {JBRulesetConfig} from "@bananapus/core-v6/src/structs/JBRulesetConfig.sol";
 import {JBRulesetMetadata} from "@bananapus/core-v6/src/structs/JBRulesetMetadata.sol";
 import {JBSplit} from "@bananapus/core-v6/src/structs/JBSplit.sol";
+import {JBTokenAmount} from "@bananapus/core-v6/src/structs/JBTokenAmount.sol";
 import {JBSplitGroup} from "@bananapus/core-v6/src/structs/JBSplitGroup.sol";
 import {JBTerminalConfig} from "@bananapus/core-v6/src/structs/JBTerminalConfig.sol";
-import {JBCashOutHookSpecification} from "@bananapus/core-v6/src/structs/JBCashOutHookSpecification.sol";
 import {JBPermissionIds} from "@bananapus/permission-ids-v6/src/JBPermissionIds.sol";
 import {IJBSuckerRegistry} from "@bananapus/suckers-v6/src/interfaces/IJBSuckerRegistry.sol";
 import {CTPublisher} from "@croptop/core-v6/src/CTPublisher.sol";
@@ -67,11 +70,11 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IJBRulesetDataHook, IJBCas
     error REVDeployer_CashOutsCantBeTurnedOffCompletely(uint256 cashOutTaxRate, uint256 maxCashOutTaxRate);
     error REVDeployer_MustHaveSplits();
     error REVDeployer_NothingToAutoIssue();
+    error REVDeployer_NothingToBurn();
     error REVDeployer_RulesetDoesNotAllowDeployingSuckers();
     error REVDeployer_StageNotStarted(uint256 stageId);
     error REVDeployer_StagesRequired();
     error REVDeployer_StageTimesMustIncrease();
-    error REVDeployer_NothingToBurn();
     error REVDeployer_Unauthorized(uint256 revnetId, address caller);
 
     //*********************************************************************//
@@ -95,6 +98,10 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IJBRulesetDataHook, IJBCas
     /// @dev 10_000 = 1%. This is the standard fee tier for most project token pairs.
     uint24 public constant DEFAULT_BUYBACK_POOL_FEE = 10_000;
 
+    /// @notice The default tick spacing used when auto-configuring buyback pools.
+    /// @dev 60 is the standard tick spacing for the 1% fee tier.
+    int24 public constant DEFAULT_BUYBACK_TICK_SPACING = 60;
+
     /// @notice The default TWAP window used when auto-configuring buyback pools.
     /// @dev 2 days provides robust manipulation resistance.
     uint32 public constant DEFAULT_BUYBACK_TWAP_WINDOW = 2 days;
@@ -104,7 +111,7 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IJBRulesetDataHook, IJBCas
     //*********************************************************************//
 
     /// @notice The buyback hook used as a data hook to route payments through buyback pools.
-    IJBRulesetDataHook public immutable override BUYBACK_HOOK;
+    IJBBuybackHookRegistry public immutable override BUYBACK_HOOK;
 
     /// @notice The controller used to create and manage Juicebox projects for revnets.
     IJBController public immutable override CONTROLLER;
@@ -193,7 +200,7 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IJBRulesetDataHook, IJBCas
         uint256 feeRevnetId,
         IJB721TiersHookDeployer hookDeployer,
         CTPublisher publisher,
-        IJBRulesetDataHook buybackHook,
+        IJBBuybackHookRegistry buybackHook,
         address loans,
         address trustedForwarder
     )
@@ -218,55 +225,15 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IJBRulesetDataHook, IJBCas
 
         // Give the loan contract permission to use the surplus allowance of all revnets.
         _setPermission({operator: LOANS, revnetId: 0, permissionId: JBPermissionIds.USE_ALLOWANCE});
+
+        // Give the buyback hook (registry) permission to configure pools on all revnets.
+        _setPermission({operator: address(BUYBACK_HOOK), revnetId: 0, permissionId: JBPermissionIds.SET_BUYBACK_POOL});
     }
 
     //*********************************************************************//
     // ------------------------- external views -------------------------- //
     //*********************************************************************//
 
-    /// @notice Before a revnet processes an incoming payment, determine the weight and pay hooks to use.
-    /// @dev This function is part of `IJBRulesetDataHook`, and gets called before the revnet processes a payment.
-    /// @param context Standard Juicebox payment context. See `JBBeforePayRecordedContext`.
-    /// @return weight The weight which revnet tokens are minted relative to. This can be used to customize how many
-    /// tokens get minted by a payment.
-    /// @return hookSpecifications Amounts (out of what's being paid in) to be sent to pay hooks instead of being paid
-    /// into the revnet. Useful for automatically routing funds from a treasury as payments come in.
-    function beforePayRecordedWith(JBBeforePayRecordedContext calldata context)
-        external
-        view
-        override
-        returns (uint256 weight, JBPayHookSpecification[] memory hookSpecifications)
-    {
-        // Keep a reference to the specifications provided by the buyback hook.
-        JBPayHookSpecification[] memory buybackHookSpecifications;
-
-        // Read the weight and specifications from the buyback hook.
-        (weight, buybackHookSpecifications) = BUYBACK_HOOK.beforePayRecordedWith(context);
-
-        // Keep a reference to the revnet's tiered ERC-721 hook.
-        IJB721TiersHook tiered721Hook = tiered721HookOf[context.projectId];
-
-        // Is there a tiered ERC-721 hook?
-        bool usesTiered721Hook = address(tiered721Hook) != address(0);
-
-        // Did the buyback hook return any specifications? (It won't when direct minting is cheaper than swapping.)
-        bool usesBuybackHook = buybackHookSpecifications.length > 0;
-
-        // Initialize the returned specification array with only the hooks that are present.
-        hookSpecifications = new JBPayHookSpecification[]((usesTiered721Hook ? 1 : 0) + (usesBuybackHook ? 1 : 0));
-
-        // If we have a tiered ERC-721 hook, add it to the array.
-        if (usesTiered721Hook) {
-            hookSpecifications[0] =
-                JBPayHookSpecification({hook: IJBPayHook(address(tiered721Hook)), amount: 0, metadata: bytes("")});
-        }
-
-        // Add the buyback hook specification if present.
-        if (usesBuybackHook) {
-            hookSpecifications[usesTiered721Hook ? 1 : 0] = buybackHookSpecifications[0];
-        }
-    }
-
     /// @notice Determine how a cash out from a revnet should be processed.
     /// @dev This function is part of `IJBRulesetDataHook`, and gets called before the revnet processes a cash out.
     /// @dev If a sucker is cashing out, no taxes or fees are imposed.
@@ -339,6 +306,63 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IJBRulesetDataHook, IJBCas
         return (context.cashOutTaxRate, nonFeeCashOutCount, context.totalSupply, hookSpecifications);
     }
 
+    /// @notice Before a revnet processes an incoming payment, determine the weight and pay hooks to use.
+    /// @dev This function is part of `IJBRulesetDataHook`, and gets called before the revnet processes a payment.
+    /// @param context Standard Juicebox payment context. See `JBBeforePayRecordedContext`.
+    /// @return weight The weight which revnet tokens are minted relative to. This can be used to customize how many
+    /// tokens get minted by a payment.
+    /// @return hookSpecifications Amounts (out of what's being paid in) to be sent to pay hooks instead of being paid
+    /// into the revnet. Useful for automatically routing funds from a treasury as payments come in.
+    function beforePayRecordedWith(JBBeforePayRecordedContext calldata context)
+        external
+        view
+        override
+        returns (uint256 weight, JBPayHookSpecification[] memory hookSpecifications)
+    {
+        // Get the 721 hook's spec and total split amount.
+        IJB721TiersHook tiered721Hook = tiered721HookOf[context.projectId];
+        JBPayHookSpecification memory tiered721HookSpec;
+        uint256 totalSplitAmount;
+        bool usesTiered721Hook = address(tiered721Hook) != address(0);
+        if (usesTiered721Hook) {
+            JBPayHookSpecification[] memory specs;
+            (, specs) = IJBRulesetDataHook(address(tiered721Hook)).beforePayRecordedWith(context);
+            // The 721 hook returns a single spec (itself) whose amount is the total split amount.
+            if (specs.length > 0) {
+                tiered721HookSpec = specs[0];
+                totalSplitAmount = tiered721HookSpec.amount;
+            }
+        }
+
+        // The amount entering the project after tier splits.
+        uint256 projectAmount = totalSplitAmount >= context.amount.value ? 0 : context.amount.value - totalSplitAmount;
+
+        // Get the buyback hook's weight and specs. Reduce the amount so it only considers funds entering the project.
+        JBPayHookSpecification[] memory buybackHookSpecs;
+        {
+            JBBeforePayRecordedContext memory buybackHookContext = context;
+            buybackHookContext.amount.value = projectAmount;
+            (weight, buybackHookSpecs) = BUYBACK_HOOK.beforePayRecordedWith(buybackHookContext);
+        }
+
+        // Scale the buyback hook's weight for splits so the terminal mints tokens only for the project's share.
+        // The terminal uses the full context.amount.value for minting (tokenCount = amount * weight / weightRatio),
+        // but only projectAmount actually enters the project. Without scaling, payers get token credit for the split
+        // portion too. Preserves weight=0 from the buyback hook (buying back, not minting).
+        if (projectAmount == 0) {
+            weight = 0;
+        } else if (projectAmount < context.amount.value) {
+            weight = mulDiv(weight, projectAmount, context.amount.value);
+        }
+
+        // Merge hook specifications: 721 hook spec first, then buyback hook spec.
+        bool usesBuybackHook = buybackHookSpecs.length > 0;
+        hookSpecifications = new JBPayHookSpecification[]((usesTiered721Hook ? 1 : 0) + (usesBuybackHook ? 1 : 0));
+
+        if (usesTiered721Hook) hookSpecifications[0] = tiered721HookSpec;
+        if (usesBuybackHook) hookSpecifications[usesTiered721Hook ? 1 : 0] = buybackHookSpecs[0];
+    }
+
     /// @notice A flag indicating whether an address has permission to mint a revnet's tokens on-demand.
     /// @dev Required by the `IJBRulesetDataHook` interface.
     /// @param revnetId The ID of the revnet to check permissions for.
@@ -459,18 +483,30 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IJBRulesetDataHook, IJBCas
                 });
 
                 // Configure a buyback pool for this terminal token with default fee and TWAP window.
-                // slither-disable-next-line unused-return,calls-loop
-                IJBBuybackHook(address(BUYBACK_HOOK))
-                    .setPoolFor({
-                        projectId: revnetId,
-                        fee: DEFAULT_BUYBACK_POOL_FEE,
-                        twapWindow: DEFAULT_BUYBACK_TWAP_WINDOW,
-                        terminalToken: accountingContext.token
-                    });
+                // slither-disable-next-line calls-loop
+                _trySetBuybackPoolFor(revnetId, accountingContext.token);
             }
         }
     }
 
+    /// @notice Try to configure a buyback pool for a terminal token. Silently catches failures (e.g., if the Uniswap V4
+    /// pool isn't initialized yet).
+    /// @param revnetId The ID of the revnet.
+    /// @param terminalToken The terminal token to configure a buyback pool for.
+    function _trySetBuybackPoolFor(uint256 revnetId, address terminalToken) internal {
+        // Try to set the pool — if the pool isn't initialized in the PoolManager yet, this will revert and be caught.
+        // The buyback hook constructs the PoolKey internally from the project token, terminal token, and pool params.
+        // slither-disable-next-line calls-loop
+        try BUYBACK_HOOK.setPoolFor({
+            projectId: revnetId,
+            fee: DEFAULT_BUYBACK_POOL_FEE,
+            tickSpacing: DEFAULT_BUYBACK_TICK_SPACING,
+            twapWindow: DEFAULT_BUYBACK_TWAP_WINDOW,
+            terminalToken: terminalToken
+        }) {}
+            catch {} // Pool may not be initialized yet — that's OK.
+    }
+
     /// @notice Make a ruleset configuration for a revnet's stage.
     /// @param baseCurrency The base currency of the revnet.
     /// @param stageConfiguration The stage configuration to make a ruleset for.
@@ -696,6 +732,17 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IJBRulesetDataHook, IJBCas
         return revnetId;
     }
 
+    /// @notice Burn any of a revnet's tokens held by this contract.
+    /// @dev Project tokens can end up here from reserved token distribution when splits don't sum to 100%.
+    /// @param revnetId The ID of the revnet whose tokens should be burned.
+    function burnHeldTokensOf(uint256 revnetId) external override {
+        uint256 balance = CONTROLLER.TOKENS().totalBalanceOf({holder: address(this), projectId: revnetId});
+        if (balance == 0) revert REVDeployer_NothingToBurn();
+        CONTROLLER.burnTokensOf({holder: address(this), projectId: revnetId, tokenCount: balance, memo: ""});
+        // slither-disable-next-line reentrancy-events
+        emit BurnHeldTokens(revnetId, balance, _msgSender());
+    }
+
     /// @notice Deploy new suckers for an existing revnet.
     /// @dev Only the revnet's split operator can deploy new suckers.
     /// @param revnetId The ID of the revnet to deploy suckers for.
@@ -777,17 +824,6 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IJBRulesetDataHook, IJBCas
         return (revnetId, hook);
     }
 
-    /// @notice Burn any of a revnet's tokens held by this contract.
-    /// @dev Project tokens can end up here from reserved token distribution when splits don't sum to 100%.
-    /// @param revnetId The ID of the revnet whose tokens should be burned.
-    function burnHeldTokensOf(uint256 revnetId) external override {
-        uint256 balance = CONTROLLER.TOKENS().totalBalanceOf({holder: address(this), projectId: revnetId});
-        if (balance == 0) revert REVDeployer_NothingToBurn();
-        CONTROLLER.burnTokensOf({holder: address(this), projectId: revnetId, tokenCount: balance, memo: ""});
-        // slither-disable-next-line reentrancy-events
-        emit BurnHeldTokens(revnetId, balance, _msgSender());
-    }
-
     /// @notice Change a revnet's split operator.
     /// @dev Only a revnet's current split operator can set a new split operator.
     /// @param revnetId The ID of the revnet to set the split operator of.
@@ -852,11 +888,32 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IJBRulesetDataHook, IJBCas
             revnetId: revnetId, configuration: configuration, terminalConfigurations: terminalConfigurations
         });
 
+        // Convert the REVBaseline721HookConfig to JBDeploy721TiersHookConfig, forcing issueTokensForSplits to false.
+        // Revnets do their own weight adjustment for splits, so the 721 hook must not also adjust.
+        JBDeploy721TiersHookConfig memory hookConfig = JBDeploy721TiersHookConfig({
+            name: tiered721HookConfiguration.baseline721HookConfiguration.name,
+            symbol: tiered721HookConfiguration.baseline721HookConfiguration.symbol,
+            baseUri: tiered721HookConfiguration.baseline721HookConfiguration.baseUri,
+            tokenUriResolver: tiered721HookConfiguration.baseline721HookConfiguration.tokenUriResolver,
+            contractUri: tiered721HookConfiguration.baseline721HookConfiguration.contractUri,
+            tiersConfig: tiered721HookConfiguration.baseline721HookConfiguration.tiersConfig,
+            reserveBeneficiary: tiered721HookConfiguration.baseline721HookConfiguration.reserveBeneficiary,
+            flags: JB721TiersHookFlags({
+                noNewTiersWithReserves: tiered721HookConfiguration.baseline721HookConfiguration.flags
+                .noNewTiersWithReserves,
+                noNewTiersWithVotes: tiered721HookConfiguration.baseline721HookConfiguration.flags.noNewTiersWithVotes,
+                noNewTiersWithOwnerMinting: tiered721HookConfiguration.baseline721HookConfiguration.flags
+                .noNewTiersWithOwnerMinting,
+                preventOverspending: tiered721HookConfiguration.baseline721HookConfiguration.flags.preventOverspending,
+                issueTokensForSplits: false
+            })
+        });
+
         // Deploy the tiered ERC-721 hook contract.
         // slither-disable-next-line reentrancy-benign
         hook = HOOK_DEPLOYER.deployHookFor({
             projectId: revnetId,
-            deployTiersHookConfig: tiered721HookConfiguration.baseline721HookConfiguration,
+            deployTiersHookConfig: hookConfig,
             salt: keccak256(abi.encode(tiered721HookConfiguration.salt, encodedConfigurationHash, _msgSender()))
         });