@rev-net/core-v6 0.0.7 → 0.0.8

package/foundry.toml

@@ -6,7 +6,7 @@ libs = ["node_modules", "lib"]
 fs_permissions = [{ access = "read-write", path = "./"}]
 
 [profile.ci_sizes]
-optimizer_runs = 200
+optimizer_runs = 500
 via_ir = true
 
 [fuzz]

package/package.json

@@ -1,15 +1,18 @@
 {
     "name": "@rev-net/core-v6",
-    "version": "0.0.7",
+    "version": "0.0.8",
     "license": "MIT",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/rev-net/revnet-core-v6"
     },
+    "engines": {
+        "node": ">=20.0.0"
+    },
     "scripts": {
         "postinstall": "find node_modules -name '*.sol' -type f | xargs grep -l 'pragma solidity 0.8.23;' 2>/dev/null | xargs sed -i '' 's/pragma solidity 0.8.23;/pragma solidity 0.8.26;/g' 2>/dev/null || true",
         "test": "forge test",
-        "coverage:integration": "forge coverage --match-path \"./src/*.sol\" --report lcov --report summary",
+        "coverage": "forge coverage --match-path \"./src/*.sol\" --report lcov --report summary",
         "deploy:mainnets": "source ./.env && export START_TIME=$(date +%s) && npx sphinx propose ./script/Deploy.s.sol --networks mainnets",
         "deploy:mainnets:1_1": "source ./.env && npx sphinx propose ./script/Deploy1_1.s.sol --networks mainnets",
         "deploy:testnets": "source ./.env && export START_TIME=$(date +%s) && npx sphinx propose ./script/Deploy.s.sol --networks testnets",
@@ -19,14 +22,14 @@
     "dependencies": {
         "@bananapus/721-hook-v6": "^0.0.9",
         "@bananapus/buyback-hook-v6": "^0.0.7",
-        "@bananapus/core-v6": "^0.0.9",
-        "@bananapus/permission-ids-v6": "^0.0.4",
-        "@bananapus/suckers-v6": "^0.0.6",
+        "@bananapus/core-v6": "^0.0.10",
+        "@bananapus/permission-ids-v6": "^0.0.5",
+        "@bananapus/suckers-v6": "^0.0.7",
         "@bananapus/router-terminal-v6": "^0.0.6",
         "@croptop/core-v6": "^0.0.6",
         "@openzeppelin/contracts": "^5.2.0"
     },
     "devDependencies": {
-        "@sphinx-labs/plugins": "^0.33.1"
+        "@sphinx-labs/plugins": "^0.33.2"
     }
 }

package/src/REVDeployer.sol

@@ -1,15 +1,18 @@
 // 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 {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
+import {IHooks} from "@uniswap/v4-core/src/interfaces/IHooks.sol";
+import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.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 +29,19 @@ 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 {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;
@@ -224,49 +231,6 @@ contract REVDeployer is ERC2771Context, IREVDeployer, IJBRulesetDataHook, IJBCas
     // ------------------------- 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 +303,49 @@ 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)
+    {
+        // 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 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 +466,45 @@ 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 {
+        // Normalize the terminal token (use WETH for native) and get the project token.
+        address normalizedTerminalToken = terminalToken == JBConstants.NATIVE_TOKEN
+            ? address(IJBBuybackHook(address(BUYBACK_HOOK)).WETH())
+            : terminalToken;
+        address projectToken = address(CONTROLLER.TOKENS().tokenOf(revnetId));
+
+        // Sort currencies numerically for the pool key (lower address = currency0).
+        (Currency currency0, Currency currency1) = normalizedTerminalToken < projectToken
+            ? (Currency.wrap(normalizedTerminalToken), Currency.wrap(projectToken))
+            : (Currency.wrap(projectToken), Currency.wrap(normalizedTerminalToken));
+
+        // Try to set the pool — if the pool isn't initialized in the PoolManager yet, this will revert and be caught.
+        try IJBBuybackHook(address(BUYBACK_HOOK))
+            .setPoolFor({
+                projectId: revnetId,
+                poolKey: PoolKey({
+                    currency0: currency0,
+                    currency1: currency1,
+                    fee: DEFAULT_BUYBACK_POOL_FEE,
+                    tickSpacing: DEFAULT_BUYBACK_TICK_SPACING,
+                    hooks: IHooks(address(0))
+                }),
+                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 +730,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 +822,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.

package/src/REVLoans.sol

@@ -57,14 +57,14 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
 
     error REVLoans_CollateralExceedsLoan(uint256 collateralToReturn, uint256 loanCollateral);
     error REVLoans_InvalidPrepaidFeePercent(uint256 prepaidFeePercent, uint256 min, uint256 max);
-    error REVLoans_NotEnoughCollateral();
-    error REVLoans_OverflowAlert(uint256 value, uint256 limit);
-    error REVLoans_OverMaxRepayBorrowAmount(uint256 maxRepayBorrowAmount, uint256 repayBorrowAmount);
-    error REVLoans_PermitAllowanceNotEnough(uint256 allowanceAmount, uint256 requiredAmount);
+    error REVLoans_LoanExpired(uint256 timeSinceLoanCreated, uint256 loanLiquidationDuration);
     error REVLoans_NewBorrowAmountGreaterThanLoanAmount(uint256 newBorrowAmount, uint256 loanAmount);
     error REVLoans_NoMsgValueAllowed();
+    error REVLoans_NotEnoughCollateral();
     error REVLoans_NothingToRepay();
-    error REVLoans_LoanExpired(uint256 timeSinceLoanCreated, uint256 loanLiquidationDuration);
+    error REVLoans_OverMaxRepayBorrowAmount(uint256 maxRepayBorrowAmount, uint256 repayBorrowAmount);
+    error REVLoans_OverflowAlert(uint256 value, uint256 limit);
+    error REVLoans_PermitAllowanceNotEnough(uint256 allowanceAmount, uint256 requiredAmount);
     error REVLoans_ReallocatingMoreCollateralThanBorrowedAmountAllows(uint256 newBorrowAmount, uint256 loanAmount);
     error REVLoans_SourceMismatch();
     error REVLoans_Unauthorized(address caller, address owner);
@@ -257,6 +257,13 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
         return _determineSourceFeeAmount(loan, amount);
     }
 
+    /// @notice The revnet ID for the loan with the provided loan ID.
+    /// @param loanId The loan ID of the loan to get the revnet ID of.
+    /// @return The ID of the revnet.
+    function revnetIdOfLoanWith(uint256 loanId) public pure override returns (uint256) {
+        return loanId / _ONE_TRILLION;
+    }
+
     /// @notice Returns the URI where the ERC-721 standard JSON of a loan is hosted.
     /// @param loanId The ID of the loan to get a URI of.
     /// @return The token URI to use for the provided `loanId`.
@@ -271,13 +278,6 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
         return resolver.getUri(loanId);
     }
 
-    /// @notice The revnet ID for the loan with the provided loan ID.
-    /// @param loanId The loan ID of the loan to get the revnet ID of.
-    /// @return The ID of the revnet.
-    function revnetIdOfLoanWith(uint256 loanId) public pure override returns (uint256) {
-        return loanId / _ONE_TRILLION;
-    }
-
     //*********************************************************************//
     // -------------------------- internal views ------------------------- //
     //*********************************************************************//
@@ -839,6 +839,56 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
     // --------------------- internal transactions ----------------------- //
     //*********************************************************************//
 
+    /// @notice Accepts an incoming token.
+    /// @param token The token being accepted.
+    /// @param amount The number of tokens being accepted.
+    /// @param allowance The permit2 context.
+    /// @return amount The number of tokens which have been accepted.
+    function _acceptFundsFor(
+        address token,
+        uint256 amount,
+        JBSingleAllowance memory allowance
+    )
+        internal
+        returns (uint256)
+    {
+        // If the token is the native token, override `amount` with `msg.value`.
+        if (token == JBConstants.NATIVE_TOKEN) return msg.value;
+
+        // If the token is not native, revert if there is a non-zero `msg.value`.
+        if (msg.value != 0) revert REVLoans_NoMsgValueAllowed();
+
+        // Check if the metadata contains permit data.
+        if (allowance.amount != 0) {
+            // Make sure the permit allowance is enough for this payment. If not we revert early.
+            if (allowance.amount < amount) {
+                revert REVLoans_PermitAllowanceNotEnough(allowance.amount, amount);
+            }
+
+            // Keep a reference to the permit rules.
+            IAllowanceTransfer.PermitSingle memory permitSingle = IAllowanceTransfer.PermitSingle({
+                details: IAllowanceTransfer.PermitDetails({
+                    token: token, amount: allowance.amount, expiration: allowance.expiration, nonce: allowance.nonce
+                }),
+                spender: address(this),
+                sigDeadline: allowance.sigDeadline
+            });
+
+            // Set the allowance to `spend` tokens for the user.
+            try PERMIT2.permit({owner: _msgSender(), permitSingle: permitSingle, signature: allowance.signature}) {}
+                catch (bytes memory) {}
+        }
+
+        // Get a reference to the balance before receiving tokens.
+        uint256 balanceBefore = _balanceOf(token);
+
+        // Transfer tokens to this terminal from the msg sender.
+        _transferFrom({from: _msgSender(), to: payable(address(this)), token: token, amount: amount});
+
+        // The amount should reflect the change in balance.
+        return _balanceOf(token) - balanceBefore;
+    }
+
     /// @notice Adds collateral to a loan by burning the collateral tokens permanently.
     /// @dev The collateral tokens are burned via the controller, not held in escrow. They are only re-minted if the
     /// loan is repaid. If the loan expires and is liquidated, the burned collateral is permanently lost.
@@ -1028,67 +1078,118 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
         }
     }
 
-    /// @notice Accepts an incoming token.
-    /// @param token The token being accepted.
-    /// @param amount The number of tokens being accepted.
-    /// @param allowance The permit2 context.
-    /// @return amount The number of tokens which have been accepted.
-    function _acceptFundsFor(
-        address token,
-        uint256 amount,
-        JBSingleAllowance memory allowance
+    /// @notice Logic to be triggered before transferring tokens from this contract.
+    /// @param to The address the transfer is going to.
+    /// @param token The token being transferred.
+    /// @param amount The number of tokens being transferred, as a fixed point number with the same number of decimals
+    /// as the token specifies.
+    /// @return payValue The value to attach to the transaction being sent.
+    function _beforeTransferTo(address to, address token, uint256 amount) internal returns (uint256) {
+        // If the token is the native token, no allowance needed.
+        if (token == JBConstants.NATIVE_TOKEN) return amount;
+        IERC20(token).safeIncreaseAllowance(to, amount);
+        return 0;
+    }
+
+    /// @notice Reallocates collateral from a loan by making a new loan based on the original, with reduced collateral.
+    /// @param loanId The ID of the loan to reallocate collateral from.
+    /// @param revnetId The ID of the revnet the loan is from.
+    /// @param collateralCountToRemove The amount of collateral to remove from the loan.
+    /// @return reallocatedLoanId The ID of the loan.
+    /// @return reallocatedLoan The reallocated loan.
+    function _reallocateCollateralFromLoan(
+        uint256 loanId,
+        uint256 revnetId,
+        uint256 collateralCountToRemove
     )
         internal
-        returns (uint256)
+        returns (uint256 reallocatedLoanId, REVLoan storage reallocatedLoan)
     {
-        // If the token is the native token, override `amount` with `msg.value`.
-        if (token == JBConstants.NATIVE_TOKEN) return msg.value;
+        // Burn the original loan.
+        _burn(loanId);
 
-        // If the token is not native, revert if there is a non-zero `msg.value`.
-        if (msg.value != 0) revert REVLoans_NoMsgValueAllowed();
+        // Keep a reference to loan having its collateral reduced.
+        REVLoan storage loan = _loanOf[loanId];
 
-        // Check if the metadata contains permit data.
-        if (allowance.amount != 0) {
-            // Make sure the permit allowance is enough for this payment. If not we revert early.
-            if (allowance.amount < amount) {
-                revert REVLoans_PermitAllowanceNotEnough(allowance.amount, amount);
-            }
+        // Make sure there is enough collateral to transfer.
+        if (collateralCountToRemove > loan.collateral) revert REVLoans_NotEnoughCollateral();
 
-            // Keep a reference to the permit rules.
-            IAllowanceTransfer.PermitSingle memory permitSingle = IAllowanceTransfer.PermitSingle({
-                details: IAllowanceTransfer.PermitDetails({
-                    token: token, amount: allowance.amount, expiration: allowance.expiration, nonce: allowance.nonce
-                }),
-                spender: address(this),
-                sigDeadline: allowance.sigDeadline
-            });
+        // Keep a reference to the new collateral amount.
+        uint256 newCollateralCount = loan.collateral - collateralCountToRemove;
 
-            // Set the allowance to `spend` tokens for the user.
-            try PERMIT2.permit({owner: _msgSender(), permitSingle: permitSingle, signature: allowance.signature}) {}
-                catch (bytes memory) {}
+        // Keep a reference to the new borrow amount.
+        uint256 borrowAmount = _borrowAmountFrom({loan: loan, revnetId: revnetId, collateralCount: newCollateralCount});
+
+        // Make sure the borrow amount is not less than the original loan's amount.
+        if (borrowAmount < loan.amount) {
+            revert REVLoans_ReallocatingMoreCollateralThanBorrowedAmountAllows(borrowAmount, loan.amount);
         }
 
-        // Get a reference to the balance before receiving tokens.
-        uint256 balanceBefore = _balanceOf(token);
+        // Get a reference to the replacement loan ID.
+        reallocatedLoanId = _generateLoanId({revnetId: revnetId, loanNumber: ++totalLoansBorrowedFor[revnetId]});
 
-        // Transfer tokens to this terminal from the msg sender.
-        _transferFrom({from: _msgSender(), to: payable(address(this)), token: token, amount: amount});
+        // Get a reference to the loan being created.
+        reallocatedLoan = _loanOf[reallocatedLoanId];
 
-        // The amount should reflect the change in balance.
-        return _balanceOf(token) - balanceBefore;
+        // Set the reallocated loan's values the same as the original loan.
+        reallocatedLoan.amount = loan.amount;
+        reallocatedLoan.collateral = loan.collateral;
+        reallocatedLoan.createdAt = loan.createdAt;
+        reallocatedLoan.prepaidFeePercent = loan.prepaidFeePercent;
+        reallocatedLoan.prepaidDuration = loan.prepaidDuration;
+        reallocatedLoan.source = loan.source;
+
+        // Reduce the collateral of the reallocated loan.
+        _adjust({
+            loan: reallocatedLoan,
+            revnetId: revnetId,
+            newBorrowAmount: reallocatedLoan.amount, // Don't change the borrow amount.
+            newCollateralCount: newCollateralCount,
+            sourceFeeAmount: 0,
+            beneficiary: payable(_msgSender()) // use the msgSender as the beneficiary, who will have the returned
+            // collateral tokens debited from their balance for the new loan.
+        });
+
+        // Mint the replacement loan.
+        _mint({to: _msgSender(), tokenId: reallocatedLoanId});
+
+        // Clear stale loan data for gas refund.
+        delete _loanOf[loanId];
+
+        emit ReallocateCollateral({
+            loanId: loanId,
+            revnetId: revnetId,
+            reallocatedLoanId: reallocatedLoanId,
+            reallocatedLoan: reallocatedLoan,
+            removedCollateralCount: collateralCountToRemove,
+            caller: _msgSender()
+        });
     }
 
-    /// @notice Logic to be triggered before transferring tokens from this contract.
-    /// @param to The address the transfer is going to.
-    /// @param token The token being transferred.
-    /// @param amount The number of tokens being transferred, as a fixed point number with the same number of decimals
-    /// as the token specifies.
-    /// @return payValue The value to attach to the transaction being sent.
-    function _beforeTransferTo(address to, address token, uint256 amount) internal returns (uint256) {
-        // If the token is the native token, no allowance needed.
-        if (token == JBConstants.NATIVE_TOKEN) return amount;
-        IERC20(token).safeIncreaseAllowance(to, amount);
-        return 0;
+    /// @notice Pays off a loan.
+    /// @param loan The loan being paid off.
+    /// @param revnetId The ID of the revnet the loan is being paid off in.
+    /// @param repaidBorrowAmount The amount being paid off, denominated in the token of the source's accounting
+    /// context.
+    function _removeFrom(REVLoan memory loan, uint256 revnetId, uint256 repaidBorrowAmount) internal {
+        // Decrement the total amount of a token being loaned out by the revnet from its terminal.
+        totalBorrowedFrom[revnetId][loan.source.terminal][loan.source.token] -= repaidBorrowAmount;
+
+        // Increase the allowance for the beneficiary.
+        uint256 payValue = _beforeTransferTo({
+            to: address(loan.source.terminal), token: loan.source.token, amount: repaidBorrowAmount
+        });
+
+        // Add the loaned amount back to the revnet.
+        // slither-disable-next-line arbitrary-send-eth
+        loan.source.terminal.addToBalanceOf{value: payValue}({
+            projectId: revnetId,
+            token: loan.source.token,
+            amount: repaidBorrowAmount,
+            shouldReturnHeldFees: false,
+            memo: "Paying off loan",
+            metadata: bytes(abi.encodePacked(REV_ID))
+        });
     }
 
     /// @notice Pays down a loan.
@@ -1196,107 +1297,6 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
         }
     }
 
-    /// @notice Reallocates collateral from a loan by making a new loan based on the original, with reduced collateral.
-    /// @param loanId The ID of the loan to reallocate collateral from.
-    /// @param revnetId The ID of the revnet the loan is from.
-    /// @param collateralCountToRemove The amount of collateral to remove from the loan.
-    /// @return reallocatedLoanId The ID of the loan.
-    /// @return reallocatedLoan The reallocated loan.
-    function _reallocateCollateralFromLoan(
-        uint256 loanId,
-        uint256 revnetId,
-        uint256 collateralCountToRemove
-    )
-        internal
-        returns (uint256 reallocatedLoanId, REVLoan storage reallocatedLoan)
-    {
-        // Burn the original loan.
-        _burn(loanId);
-
-        // Keep a reference to loan having its collateral reduced.
-        REVLoan storage loan = _loanOf[loanId];
-
-        // Make sure there is enough collateral to transfer.
-        if (collateralCountToRemove > loan.collateral) revert REVLoans_NotEnoughCollateral();
-
-        // Keep a reference to the new collateral amount.
-        uint256 newCollateralCount = loan.collateral - collateralCountToRemove;
-
-        // Keep a reference to the new borrow amount.
-        uint256 borrowAmount = _borrowAmountFrom({loan: loan, revnetId: revnetId, collateralCount: newCollateralCount});
-
-        // Make sure the borrow amount is not less than the original loan's amount.
-        if (borrowAmount < loan.amount) {
-            revert REVLoans_ReallocatingMoreCollateralThanBorrowedAmountAllows(borrowAmount, loan.amount);
-        }
-
-        // Get a reference to the replacement loan ID.
-        reallocatedLoanId = _generateLoanId({revnetId: revnetId, loanNumber: ++totalLoansBorrowedFor[revnetId]});
-
-        // Get a reference to the loan being created.
-        reallocatedLoan = _loanOf[reallocatedLoanId];
-
-        // Set the reallocated loan's values the same as the original loan.
-        reallocatedLoan.amount = loan.amount;
-        reallocatedLoan.collateral = loan.collateral;
-        reallocatedLoan.createdAt = loan.createdAt;
-        reallocatedLoan.prepaidFeePercent = loan.prepaidFeePercent;
-        reallocatedLoan.prepaidDuration = loan.prepaidDuration;
-        reallocatedLoan.source = loan.source;
-
-        // Reduce the collateral of the reallocated loan.
-        _adjust({
-            loan: reallocatedLoan,
-            revnetId: revnetId,
-            newBorrowAmount: reallocatedLoan.amount, // Don't change the borrow amount.
-            newCollateralCount: newCollateralCount,
-            sourceFeeAmount: 0,
-            beneficiary: payable(_msgSender()) // use the msgSender as the beneficiary, who will have the returned
-            // collateral tokens debited from their balance for the new loan.
-        });
-
-        // Mint the replacement loan.
-        _mint({to: _msgSender(), tokenId: reallocatedLoanId});
-
-        // Clear stale loan data for gas refund.
-        delete _loanOf[loanId];
-
-        emit ReallocateCollateral({
-            loanId: loanId,
-            revnetId: revnetId,
-            reallocatedLoanId: reallocatedLoanId,
-            reallocatedLoan: reallocatedLoan,
-            removedCollateralCount: collateralCountToRemove,
-            caller: _msgSender()
-        });
-    }
-
-    /// @notice Pays off a loan.
-    /// @param loan The loan being paid off.
-    /// @param revnetId The ID of the revnet the loan is being paid off in.
-    /// @param repaidBorrowAmount The amount being paid off, denominated in the token of the source's accounting
-    /// context.
-    function _removeFrom(REVLoan memory loan, uint256 revnetId, uint256 repaidBorrowAmount) internal {
-        // Decrement the total amount of a token being loaned out by the revnet from its terminal.
-        totalBorrowedFrom[revnetId][loan.source.terminal][loan.source.token] -= repaidBorrowAmount;
-
-        // Increase the allowance for the beneficiary.
-        uint256 payValue = _beforeTransferTo({
-            to: address(loan.source.terminal), token: loan.source.token, amount: repaidBorrowAmount
-        });
-
-        // Add the loaned amount back to the revnet.
-        // slither-disable-next-line arbitrary-send-eth
-        loan.source.terminal.addToBalanceOf{value: payValue}({
-            projectId: revnetId,
-            token: loan.source.token,
-            amount: repaidBorrowAmount,
-            shouldReturnHeldFees: false,
-            memo: "Paying off loan",
-            metadata: bytes(abi.encodePacked(REV_ID))
-        });
-    }
-
     /// @notice Returns collateral from a loan.
     /// @param revnetId The ID of the revnet the loan is being returned in.
     /// @param collateralCount The amount of collateral being returned from the loan.

package/src/interfaces/IREVDeployer.sol

@@ -12,21 +12,37 @@ import {JBRulesetConfig} from "@bananapus/core-v6/src/structs/JBRulesetConfig.so
 import {JBTerminalConfig} from "@bananapus/core-v6/src/structs/JBTerminalConfig.sol";
 import {IJBSuckerRegistry} from "@bananapus/suckers-v6/src/interfaces/IJBSuckerRegistry.sol";
 import {CTPublisher} from "@croptop/core-v6/src/CTPublisher.sol";
-
 import {REVConfig} from "../structs/REVConfig.sol";
 import {REVCroptopAllowedPost} from "../structs/REVCroptopAllowedPost.sol";
 import {REVDeploy721TiersHookConfig} from "../structs/REVDeploy721TiersHookConfig.sol";
 import {REVSuckerDeploymentConfig} from "../structs/REVSuckerDeploymentConfig.sol";
 
+/// @notice Deploys and manages revnets -- Juicebox projects with pre-configured tokenomics.
 interface IREVDeployer {
-    event ReplaceSplitOperator(uint256 indexed revnetId, address indexed newSplitOperator, address caller);
-    event DeploySuckers(
-        uint256 indexed revnetId,
-        bytes32 encodedConfigurationHash,
-        REVSuckerDeploymentConfig suckerDeploymentConfiguration,
-        address caller
+    /// @notice Emitted when tokens are auto-issued for a beneficiary during a stage.
+    /// @param revnetId The ID of the revnet.
+    /// @param stageId The ID of the stage.
+    /// @param beneficiary The address receiving the auto-issued tokens.
+    /// @param count The number of tokens auto-issued.
+    /// @param caller The address that triggered the auto-issuance.
+    event AutoIssue(
+        uint256 indexed revnetId, uint256 indexed stageId, address indexed beneficiary, uint256 count, address caller
     );
 
+    /// @notice Emitted when held tokens are burned from the deployer contract.
+    /// @param revnetId The ID of the revnet whose tokens were burned.
+    /// @param count The number of tokens burned.
+    /// @param caller The address that triggered the burn.
+    event BurnHeldTokens(uint256 indexed revnetId, uint256 count, address caller);
+
+    /// @notice Emitted when a new revnet is deployed.
+    /// @param revnetId The ID of the deployed revnet.
+    /// @param configuration The revnet's configuration.
+    /// @param terminalConfigurations The terminals configured for the revnet.
+    /// @param suckerDeploymentConfiguration The sucker deployment configuration.
+    /// @param rulesetConfigurations The rulesets configured for the revnet.
+    /// @param encodedConfigurationHash The hash of the encoded configuration.
+    /// @param caller The address that deployed the revnet.
     event DeployRevnet(
         uint256 indexed revnetId,
         REVConfig configuration,
@@ -37,42 +53,64 @@ interface IREVDeployer {
         address caller
     );
 
-    event SetCashOutDelay(uint256 indexed revnetId, uint256 cashOutDelay, address caller);
-
-    event AutoIssue(
-        uint256 indexed revnetId, uint256 indexed stageId, address indexed beneficiary, uint256 count, address caller
+    /// @notice Emitted when suckers are deployed for a revnet.
+    /// @param revnetId The ID of the revnet.
+    /// @param encodedConfigurationHash The hash of the encoded configuration.
+    /// @param suckerDeploymentConfiguration The sucker deployment configuration.
+    /// @param caller The address that deployed the suckers.
+    event DeploySuckers(
+        uint256 indexed revnetId,
+        bytes32 encodedConfigurationHash,
+        REVSuckerDeploymentConfig suckerDeploymentConfiguration,
+        address caller
     );
 
+    /// @notice Emitted when the split operator of a revnet is replaced.
+    /// @param revnetId The ID of the revnet.
+    /// @param newSplitOperator The address of the new split operator.
+    /// @param caller The address that replaced the split operator.
+    event ReplaceSplitOperator(uint256 indexed revnetId, address indexed newSplitOperator, address caller);
+
+    /// @notice Emitted when the cash out delay is set for a revnet.
+    /// @param revnetId The ID of the revnet.
+    /// @param cashOutDelay The cash out delay in seconds.
+    /// @param caller The address that set the delay.
+    event SetCashOutDelay(uint256 indexed revnetId, uint256 cashOutDelay, address caller);
+
+    /// @notice Emitted when an auto-issuance amount is stored for a beneficiary during a stage.
+    /// @param revnetId The ID of the revnet.
+    /// @param stageId The ID of the stage.
+    /// @param beneficiary The address the tokens will be issued to.
+    /// @param count The number of tokens stored for auto-issuance.
+    /// @param caller The address that stored the amount.
     event StoreAutoIssuanceAmount(
         uint256 indexed revnetId, uint256 indexed stageId, address indexed beneficiary, uint256 count, address caller
     );
 
-    event BurnHeldTokens(uint256 indexed revnetId, uint256 count, address caller);
+    /// @notice The number of revnet tokens that can be auto-minted for a beneficiary during a stage.
+    /// @param revnetId The ID of the revnet.
+    /// @param stageId The ID of the stage.
+    /// @param beneficiary The beneficiary of the auto-mint.
+    /// @return The number of tokens available to auto-issue.
+    function amountToAutoIssue(uint256 revnetId, uint256 stageId, address beneficiary) external view returns (uint256);
+
+    /// @notice The buyback hook used as a data hook to route payments through buyback pools.
+    /// @return The buyback hook contract.
+    function BUYBACK_HOOK() external view returns (IJBRulesetDataHook);
 
     /// @notice The number of seconds until a revnet's participants can cash out after deploying to a new network.
     /// @return The cash out delay in seconds.
     function CASH_OUT_DELAY() external view returns (uint256);
 
+    /// @notice The timestamp when cash outs become available for a revnet's participants.
+    /// @param revnetId The ID of the revnet.
+    /// @return The cash out delay timestamp.
+    function cashOutDelayOf(uint256 revnetId) external view returns (uint256);
+
     /// @notice The controller used to create and manage Juicebox projects for revnets.
     /// @return The controller contract.
     function CONTROLLER() external view returns (IJBController);
 
-    /// @notice The directory of terminals and controllers for Juicebox projects.
-    /// @return The directory contract.
-    function DIRECTORY() external view returns (IJBDirectory);
-
-    /// @notice The contract that mints ERC-721s representing project ownership.
-    /// @return The projects contract.
-    function PROJECTS() external view returns (IJBProjects);
-
-    /// @notice The contract that stores Juicebox project access permissions.
-    /// @return The permissions contract.
-    function PERMISSIONS() external view returns (IJBPermissions);
-
-    /// @notice The cash out fee as a fraction out of `JBConstants.MAX_FEE`.
-    /// @return The fee value.
-    function FEE() external view returns (uint256);
-
     /// @notice The default Uniswap pool fee tier for auto-configured buyback pools.
     /// @return The fee tier (10_000 = 1%).
     function DEFAULT_BUYBACK_POOL_FEE() external view returns (uint24);
@@ -81,63 +119,52 @@ interface IREVDeployer {
     /// @return The TWAP window in seconds.
     function DEFAULT_BUYBACK_TWAP_WINDOW() external view returns (uint32);
 
-    /// @notice The registry that deploys and tracks suckers for revnets.
-    /// @return The sucker registry contract.
-    function SUCKER_REGISTRY() external view returns (IJBSuckerRegistry);
+    /// @notice The directory of terminals and controllers for Juicebox projects.
+    /// @return The directory contract.
+    function DIRECTORY() external view returns (IJBDirectory);
+
+    /// @notice The cash out fee as a fraction out of `JBConstants.MAX_FEE`.
+    /// @return The fee value.
+    function FEE() external view returns (uint256);
 
     /// @notice The Juicebox project ID of the revnet that receives cash out fees.
     /// @return The fee revnet ID.
     function FEE_REVNET_ID() external view returns (uint256);
 
-    /// @notice The croptop publisher revnets can use to publish ERC-721 posts to their tiered ERC-721 hooks.
-    /// @return The publisher contract.
-    function PUBLISHER() external view returns (CTPublisher);
-
-    /// @notice The buyback hook used as a data hook to route payments through buyback pools.
-    /// @return The buyback hook contract.
-    function BUYBACK_HOOK() external view returns (IJBRulesetDataHook);
+    /// @notice The hashed encoded configuration of each revnet.
+    /// @param revnetId The ID of the revnet.
+    /// @return The hashed encoded configuration.
+    function hashedEncodedConfigurationOf(uint256 revnetId) external view returns (bytes32);
 
     /// @notice The deployer used to create tiered ERC-721 hooks for revnets.
     /// @return The hook deployer contract.
     function HOOK_DEPLOYER() external view returns (IJB721TiersHookDeployer);
 
+    /// @notice Whether an address is a revnet's split operator.
+    /// @param revnetId The ID of the revnet.
+    /// @param addr The address to check.
+    /// @return A flag indicating whether the address is the revnet's split operator.
+    function isSplitOperatorOf(uint256 revnetId, address addr) external view returns (bool);
+
     /// @notice The loan contract used by all revnets.
     /// @return The loans contract address.
     function LOANS() external view returns (address);
 
-    /// @notice The number of revnet tokens that can be auto-minted for a beneficiary during a stage.
-    /// @param revnetId The ID of the revnet.
-    /// @param stageId The ID of the stage.
-    /// @param beneficiary The beneficiary of the auto-mint.
-    /// @return The number of tokens available to auto-issue.
-    function amountToAutoIssue(uint256 revnetId, uint256 stageId, address beneficiary) external view returns (uint256);
-
-    /// @notice The timestamp when cash outs become available for a revnet's participants.
-    /// @param revnetId The ID of the revnet.
-    /// @return The cash out delay timestamp.
-    function cashOutDelayOf(uint256 revnetId) external view returns (uint256);
+    /// @notice The contract that stores Juicebox project access permissions.
+    /// @return The permissions contract.
+    function PERMISSIONS() external view returns (IJBPermissions);
 
-    /// @notice Deploy new suckers for an existing revnet.
-    /// @param revnetId The ID of the revnet to deploy suckers for.
-    /// @param suckerDeploymentConfiguration The suckers to set up for the revnet.
-    /// @return suckers The addresses of the deployed suckers.
-    function deploySuckersFor(
-        uint256 revnetId,
-        REVSuckerDeploymentConfig calldata suckerDeploymentConfiguration
-    )
-        external
-        returns (address[] memory suckers);
+    /// @notice The contract that mints ERC-721s representing project ownership.
+    /// @return The projects contract.
+    function PROJECTS() external view returns (IJBProjects);
 
-    /// @notice The hashed encoded configuration of each revnet.
-    /// @param revnetId The ID of the revnet.
-    /// @return The hashed encoded configuration.
-    function hashedEncodedConfigurationOf(uint256 revnetId) external view returns (bytes32);
+    /// @notice The croptop publisher revnets can use to publish ERC-721 posts to their tiered ERC-721 hooks.
+    /// @return The publisher contract.
+    function PUBLISHER() external view returns (CTPublisher);
 
-    /// @notice Whether an address is a revnet's split operator.
-    /// @param revnetId The ID of the revnet.
-    /// @param addr The address to check.
-    /// @return A flag indicating whether the address is the revnet's split operator.
-    function isSplitOperatorOf(uint256 revnetId, address addr) external view returns (bool);
+    /// @notice The registry that deploys and tracks suckers for revnets.
+    /// @return The sucker registry contract.
+    function SUCKER_REGISTRY() external view returns (IJBSuckerRegistry);
 
     /// @notice Each revnet's tiered ERC-721 hook.
     /// @param revnetId The ID of the revnet.
@@ -150,6 +177,10 @@ interface IREVDeployer {
     /// @param beneficiary The address to auto-mint tokens to.
     function autoIssueFor(uint256 revnetId, uint256 stageId, address beneficiary) external;
 
+    /// @notice Burn any of a revnet's tokens held by this contract.
+    /// @param revnetId The ID of the revnet whose tokens should be burned.
+    function burnHeldTokensOf(uint256 revnetId) external;
+
     /// @notice Deploy a revnet, or initialize an existing Juicebox project as a revnet.
     /// @param revnetId The ID of the Juicebox project to initialize. Send 0 to deploy a new revnet.
     /// @param configuration Core revnet configuration.
@@ -165,6 +196,17 @@ interface IREVDeployer {
         external
         returns (uint256);
 
+    /// @notice Deploy new suckers for an existing revnet.
+    /// @param revnetId The ID of the revnet to deploy suckers for.
+    /// @param suckerDeploymentConfiguration The suckers to set up for the revnet.
+    /// @return suckers The addresses of the deployed suckers.
+    function deploySuckersFor(
+        uint256 revnetId,
+        REVSuckerDeploymentConfig calldata suckerDeploymentConfiguration
+    )
+        external
+        returns (address[] memory suckers);
+
     /// @notice Deploy a revnet with tiered ERC-721s and optional croptop posting support.
     /// @param revnetId The ID of the Juicebox project to initialize. Send 0 to deploy a new revnet.
     /// @param configuration Core revnet configuration.
@@ -189,8 +231,4 @@ interface IREVDeployer {
     /// @param revnetId The ID of the revnet.
     /// @param newSplitOperator The new split operator's address.
     function setSplitOperatorOf(uint256 revnetId, address newSplitOperator) external;
-
-    /// @notice Burn any of a revnet's tokens held by this contract.
-    /// @param revnetId The ID of the revnet whose tokens should be burned.
-    function burnHeldTokensOf(uint256 revnetId) external;
 }

package/src/interfaces/IREVLoans.sol

@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-import {IPermit2} from "@uniswap/permit2/src/interfaces/IPermit2.sol";
 import {IJBController} from "@bananapus/core-v6/src/interfaces/IJBController.sol";
 import {IJBDirectory} from "@bananapus/core-v6/src/interfaces/IJBDirectory.sol";
 import {IJBPayoutTerminal} from "@bananapus/core-v6/src/interfaces/IJBPayoutTerminal.sol";
@@ -9,11 +8,22 @@ import {IJBPrices} from "@bananapus/core-v6/src/interfaces/IJBPrices.sol";
 import {IJBProjects} from "@bananapus/core-v6/src/interfaces/IJBProjects.sol";
 import {IJBTokenUriResolver} from "@bananapus/core-v6/src/interfaces/IJBTokenUriResolver.sol";
 import {JBSingleAllowance} from "@bananapus/core-v6/src/structs/JBSingleAllowance.sol";
-
+import {IPermit2} from "@uniswap/permit2/src/interfaces/IPermit2.sol";
 import {REVLoan} from "./../structs/REVLoan.sol";
 import {REVLoanSource} from "./../structs/REVLoanSource.sol";
 
+/// @notice Manages loans against revnet token collateral.
 interface IREVLoans {
+    /// @notice Emitted when a loan is created by borrowing from a revnet.
+    /// @param loanId The ID of the newly created loan.
+    /// @param revnetId The ID of the revnet being borrowed from.
+    /// @param loan The loan data.
+    /// @param source The source of the loan (terminal and token).
+    /// @param borrowAmount The amount borrowed.
+    /// @param collateralCount The amount of collateral tokens locked.
+    /// @param sourceFeeAmount The fee amount charged by the source.
+    /// @param beneficiary The address receiving the borrowed funds.
+    /// @param caller The address that created the loan.
     event Borrow(
         uint256 indexed loanId,
         uint256 indexed revnetId,
@@ -25,7 +35,41 @@ interface IREVLoans {
         address payable beneficiary,
         address caller
     );
+
+    /// @notice Emitted when a loan is liquidated after exceeding the liquidation duration.
+    /// @param loanId The ID of the liquidated loan.
+    /// @param revnetId The ID of the revnet the loan was from.
+    /// @param loan The liquidated loan data.
+    /// @param caller The address that triggered the liquidation.
     event Liquidate(uint256 indexed loanId, uint256 indexed revnetId, REVLoan loan, address caller);
+
+    /// @notice Emitted when collateral is reallocated from one loan to a new loan.
+    /// @param loanId The ID of the original loan.
+    /// @param revnetId The ID of the revnet.
+    /// @param reallocatedLoanId The ID of the loan after reallocation.
+    /// @param reallocatedLoan The reallocated loan data.
+    /// @param removedCollateralCount The amount of collateral removed from the original loan.
+    /// @param caller The address that triggered the reallocation.
+    event ReallocateCollateral(
+        uint256 indexed loanId,
+        uint256 indexed revnetId,
+        uint256 indexed reallocatedLoanId,
+        REVLoan reallocatedLoan,
+        uint256 removedCollateralCount,
+        address caller
+    );
+
+    /// @notice Emitted when a loan is repaid.
+    /// @param loanId The ID of the loan being repaid.
+    /// @param revnetId The ID of the revnet.
+    /// @param paidOffLoanId The ID of the loan after repayment.
+    /// @param loan The original loan data.
+    /// @param paidOffLoan The loan data after repayment.
+    /// @param repayBorrowAmount The amount repaid.
+    /// @param sourceFeeAmount The fee amount charged by the source.
+    /// @param collateralCountToReturn The amount of collateral returned.
+    /// @param beneficiary The address receiving the returned collateral.
+    /// @param caller The address that repaid the loan.
     event RepayLoan(
         uint256 indexed loanId,
         uint256 indexed revnetId,
@@ -38,55 +82,11 @@ interface IREVLoans {
         address payable beneficiary,
         address caller
     );
-    event ReallocateCollateral(
-        uint256 indexed loanId,
-        uint256 indexed revnetId,
-        uint256 indexed reallocatedLoanId,
-        REVLoan reallocatedLoan,
-        uint256 removedCollateralCount,
-        address caller
-    );
-    event SetTokenUriResolver(IJBTokenUriResolver indexed resolver, address caller);
-
-    /// @notice The duration after which a loan expires and its collateral is permanently lost.
-    /// @return The loan liquidation duration in seconds.
-    function LOAN_LIQUIDATION_DURATION() external view returns (uint256);
-
-    /// @notice The permit2 utility used for token transfers.
-    /// @return The permit2 contract.
-    function PERMIT2() external view returns (IPermit2);
 
-    /// @notice The controller that manages revnets using this loans contract.
-    /// @return The controller contract.
-    function CONTROLLER() external view returns (IJBController);
-
-    /// @notice The directory of terminals and controllers for revnets.
-    /// @return The directory contract.
-    function DIRECTORY() external view returns (IJBDirectory);
-
-    /// @notice The contract that stores prices for each revnet.
-    /// @return The prices contract.
-    function PRICES() external view returns (IJBPrices);
-
-    /// @notice The contract that mints ERC-721s representing project ownership.
-    /// @return The projects contract.
-    function PROJECTS() external view returns (IJBProjects);
-
-    /// @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);
-
-    /// @notice The fee percent charged by the REV revnet on each loan, in terms of `JBConstants.MAX_FEE`.
-    /// @return The REV prepaid fee percent.
-    function REV_PREPAID_FEE_PERCENT() external view returns (uint256);
-
-    /// @notice The minimum fee percent that must be prepaid when borrowing, in terms of `JBConstants.MAX_FEE`.
-    /// @return The minimum prepaid fee percent.
-    function MIN_PREPAID_FEE_PERCENT() external view returns (uint256);
-
-    /// @notice The maximum fee percent that can be prepaid when borrowing, in terms of `JBConstants.MAX_FEE`.
-    /// @return The maximum prepaid fee percent.
-    function MAX_PREPAID_FEE_PERCENT() external view returns (uint256);
+    /// @notice Emitted when the token URI resolver is changed.
+    /// @param resolver The new token URI resolver.
+    /// @param caller The address that set the resolver.
+    event SetTokenUriResolver(IJBTokenUriResolver indexed resolver, address caller);
 
     /// @notice The amount that can be borrowed from a revnet given a certain amount of collateral.
     /// @param revnetId The ID of the revnet to check for borrowable assets from.
@@ -104,6 +104,10 @@ interface IREVLoans {
         view
         returns (uint256);
 
+    /// @notice The controller that manages revnets using this loans contract.
+    /// @return The controller contract.
+    function CONTROLLER() external view returns (IJBController);
+
     /// @notice Determines the source fee amount for a loan being paid off a certain amount.
     /// @param loan The loan having its source fee amount determined.
     /// @param amount The amount being paid off.
@@ -116,6 +120,10 @@ interface IREVLoans {
         view
         returns (uint256 sourceFeeAmount);
 
+    /// @notice The directory of terminals and controllers for revnets.
+    /// @return The directory contract.
+    function DIRECTORY() external view returns (IJBDirectory);
+
     /// @notice Whether a revnet currently has outstanding loans from the specified terminal in the specified token.
     /// @param revnetId The ID of the revnet issuing the loan.
     /// @param terminal The terminal that the loan is issued from.
@@ -123,6 +131,10 @@ interface IREVLoans {
     /// @return A flag indicating if the revnet has an active loan source.
     function isLoanSourceOf(uint256 revnetId, IJBPayoutTerminal terminal, address token) external view returns (bool);
 
+    /// @notice The duration after which a loan expires and its collateral is permanently lost.
+    /// @return The loan liquidation duration in seconds.
+    function LOAN_LIQUIDATION_DURATION() external view returns (uint256);
+
     /// @notice Get a loan's details.
     /// @param loanId The ID of the loan to retrieve.
     /// @return The loan data.
@@ -136,13 +148,33 @@ interface IREVLoans {
     /// @return The array of loan sources.
     function loanSourcesOf(uint256 revnetId) external view returns (REVLoanSource[] memory);
 
-    /// @notice The cumulative number of loans ever created for a revnet, used as a loan ID sequence counter.
-    /// @dev This counter only increments and never decrements. It does NOT represent the count of currently active
-    /// loans -- repaid and liquidated loans leave permanent gaps in the sequence. Do not use this value to determine
-    /// how many loans are currently outstanding.
-    /// @param revnetId The ID of the revnet to get the cumulative loan count for.
-    /// @return The cumulative number of loans ever created.
-    function totalLoansBorrowedFor(uint256 revnetId) external view returns (uint256);
+    /// @notice The maximum fee percent that can be prepaid when borrowing, in terms of `JBConstants.MAX_FEE`.
+    /// @return The maximum prepaid fee percent.
+    function MAX_PREPAID_FEE_PERCENT() external view returns (uint256);
+
+    /// @notice The minimum fee percent that must be prepaid when borrowing, in terms of `JBConstants.MAX_FEE`.
+    /// @return The minimum prepaid fee percent.
+    function MIN_PREPAID_FEE_PERCENT() external view returns (uint256);
+
+    /// @notice The permit2 utility used for token transfers.
+    /// @return The permit2 contract.
+    function PERMIT2() external view returns (IPermit2);
+
+    /// @notice The contract that stores prices for each revnet.
+    /// @return The prices contract.
+    function PRICES() external view returns (IJBPrices);
+
+    /// @notice The contract that mints ERC-721s representing project ownership.
+    /// @return The projects contract.
+    function PROJECTS() external view returns (IJBProjects);
+
+    /// @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);
+
+    /// @notice The fee percent charged by the REV revnet on each loan, in terms of `JBConstants.MAX_FEE`.
+    /// @return The REV prepaid fee percent.
+    function REV_PREPAID_FEE_PERCENT() external view returns (uint256);
 
     /// @notice The revnet ID for the loan with the provided loan ID.
     /// @param loanId The loan ID to get the revnet ID of.
@@ -172,6 +204,14 @@ interface IREVLoans {
     /// @return The total collateral count.
     function totalCollateralOf(uint256 revnetId) external view returns (uint256);
 
+    /// @notice The cumulative number of loans ever created for a revnet, used as a loan ID sequence counter.
+    /// @dev This counter only increments and never decrements. It does NOT represent the count of currently active
+    /// loans -- repaid and liquidated loans leave permanent gaps in the sequence. Do not use this value to determine
+    /// how many loans are currently outstanding.
+    /// @param revnetId The ID of the revnet to get the cumulative loan count for.
+    /// @return The cumulative number of loans ever created.
+    function totalLoansBorrowedFor(uint256 revnetId) external view returns (uint256);
+
     /// @notice Open a loan by borrowing from a revnet. Collateral tokens are burned and only re-minted upon repayment.
     /// @param revnetId The ID of the revnet being borrowed from.
     /// @param source The source of the loan (terminal and token).
@@ -198,25 +238,6 @@ interface IREVLoans {
     /// @param count The number of loans to iterate over.
     function liquidateExpiredLoansFrom(uint256 revnetId, uint256 startingLoanId, uint256 count) external;
 
-    /// @notice Repay a loan or return excess collateral no longer needed to support the loan.
-    /// @param loanId The ID of the loan being repaid.
-    /// @param maxRepayBorrowAmount The maximum amount to repay, denominated in the source's token.
-    /// @param collateralCountToReturn The amount of collateral to return from the loan.
-    /// @param beneficiary The address receiving the returned collateral and fee payment tokens.
-    /// @param allowance A permit2 allowance to facilitate the repayment transfer.
-    /// @return paidOffLoanId The ID of the loan after it has been paid off.
-    /// @return paidOffloan The loan after it has been paid off.
-    function repayLoan(
-        uint256 loanId,
-        uint256 maxRepayBorrowAmount,
-        uint256 collateralCountToReturn,
-        address payable beneficiary,
-        JBSingleAllowance calldata allowance
-    )
-        external
-        payable
-        returns (uint256 paidOffLoanId, REVLoan memory paidOffloan);
-
     /// @notice Refinance a loan by transferring extra collateral from an existing loan to a new loan.
     /// @param loanId The ID of the loan to reallocate collateral from.
     /// @param collateralCountToTransfer The amount of collateral to transfer from the original loan.
@@ -241,6 +262,25 @@ interface IREVLoans {
         external
         returns (uint256 reallocatedLoanId, uint256 newLoanId, REVLoan memory reallocatedLoan, REVLoan memory newLoan);
 
+    /// @notice Repay a loan or return excess collateral no longer needed to support the loan.
+    /// @param loanId The ID of the loan being repaid.
+    /// @param maxRepayBorrowAmount The maximum amount to repay, denominated in the source's token.
+    /// @param collateralCountToReturn The amount of collateral to return from the loan.
+    /// @param beneficiary The address receiving the returned collateral and fee payment tokens.
+    /// @param allowance A permit2 allowance to facilitate the repayment transfer.
+    /// @return paidOffLoanId The ID of the loan after it has been paid off.
+    /// @return paidOffloan The loan after it has been paid off.
+    function repayLoan(
+        uint256 loanId,
+        uint256 maxRepayBorrowAmount,
+        uint256 collateralCountToReturn,
+        address payable beneficiary,
+        JBSingleAllowance calldata allowance
+    )
+        external
+        payable
+        returns (uint256 paidOffLoanId, REVLoan memory paidOffloan);
+
     /// @notice Sets 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/test/mock/MockBuybackDataHook.sol

@@ -4,13 +4,14 @@ pragma solidity 0.8.26;
 import {IJBRulesetDataHook} from "@bananapus/core-v6/src/interfaces/IJBRulesetDataHook.sol";
 import {IJBPayHook} from "@bananapus/core-v6/src/interfaces/IJBPayHook.sol";
 import {IJBBuybackHook} from "@bananapus/buyback-hook-v6/src/interfaces/IJBBuybackHook.sol";
+import {IWETH9} from "@bananapus/buyback-hook-v6/src/interfaces/external/IWETH9.sol";
 import {JBBeforePayRecordedContext} from "@bananapus/core-v6/src/structs/JBBeforePayRecordedContext.sol";
 import {JBBeforeCashOutRecordedContext} from "@bananapus/core-v6/src/structs/JBBeforeCashOutRecordedContext.sol";
 import {JBPayHookSpecification} from "@bananapus/core-v6/src/structs/JBPayHookSpecification.sol";
 import {JBCashOutHookSpecification} from "@bananapus/core-v6/src/structs/JBCashOutHookSpecification.sol";
 import {JBAfterPayRecordedContext} from "@bananapus/core-v6/src/structs/JBAfterPayRecordedContext.sol";
 import {JBRuleset} from "@bananapus/core-v6/src/structs/JBRuleset.sol";
-import {IUniswapV3Pool} from "@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol";
+import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
 /// @notice A minimal mock buyback data hook for tests. Returns the default weight and a no-op pay hook specification.
@@ -49,11 +50,14 @@ contract MockBuybackDataHook is IJBRulesetDataHook, IJBPayHook {
 
     function afterPayRecordedWith(JBAfterPayRecordedContext calldata) external payable override {}
 
-    /// @notice No-op pool configuration for tests.
-    function setPoolFor(uint256, uint24, uint256, address) external pure returns (IUniswapV3Pool) {
-        return IUniswapV3Pool(address(0));
+    /// @notice Returns a dummy WETH address for tests.
+    function WETH() external pure returns (IWETH9) {
+        return IWETH9(address(1));
     }
 
+    /// @notice No-op pool configuration for tests.
+    function setPoolFor(uint256, PoolKey calldata, uint256, address) external pure {}
+
     function supportsInterface(bytes4 interfaceId) external pure override returns (bool) {
         return interfaceId == type(IJBRulesetDataHook).interfaceId || interfaceId == type(IJBPayHook).interfaceId
             || interfaceId == type(IERC165).interfaceId;

package/test/mock/MockBuybackDataHookMintPath.sol

@@ -3,13 +3,14 @@ pragma solidity 0.8.26;
 
 import {IJBRulesetDataHook} from "@bananapus/core-v6/src/interfaces/IJBRulesetDataHook.sol";
 import {IJBPayHook} from "@bananapus/core-v6/src/interfaces/IJBPayHook.sol";
+import {IWETH9} from "@bananapus/buyback-hook-v6/src/interfaces/external/IWETH9.sol";
 import {JBBeforePayRecordedContext} from "@bananapus/core-v6/src/structs/JBBeforePayRecordedContext.sol";
 import {JBBeforeCashOutRecordedContext} from "@bananapus/core-v6/src/structs/JBBeforeCashOutRecordedContext.sol";
 import {JBPayHookSpecification} from "@bananapus/core-v6/src/structs/JBPayHookSpecification.sol";
 import {JBCashOutHookSpecification} from "@bananapus/core-v6/src/structs/JBCashOutHookSpecification.sol";
 import {JBAfterPayRecordedContext} from "@bananapus/core-v6/src/structs/JBAfterPayRecordedContext.sol";
 import {JBRuleset} from "@bananapus/core-v6/src/structs/JBRuleset.sol";
-import {IUniswapV3Pool} from "@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol";
+import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
 /// @notice Mock buyback hook that simulates the "mint path" — returns EMPTY hookSpecifications.
@@ -50,10 +51,13 @@ contract MockBuybackDataHookMintPath is IJBRulesetDataHook, IJBPayHook {
 
     function afterPayRecordedWith(JBAfterPayRecordedContext calldata) external payable override {}
 
-    function setPoolFor(uint256, uint24, uint256, address) external pure returns (IUniswapV3Pool) {
-        return IUniswapV3Pool(address(0));
+    /// @notice Returns a dummy WETH address for tests.
+    function WETH() external pure returns (IWETH9) {
+        return IWETH9(address(1));
     }
 
+    function setPoolFor(uint256, PoolKey calldata, uint256, address) external pure {}
+
     function supportsInterface(bytes4 interfaceId) external pure override returns (bool) {
         return interfaceId == type(IJBRulesetDataHook).interfaceId || interfaceId == type(IJBPayHook).interfaceId
             || interfaceId == type(IERC165).interfaceId;