@rev-net/core-v6 0.0.6 → 0.0.8

package/docs/src/src/structs/REVLoan.sol/struct.REVLoan.md

@@ -1,5 +1,5 @@
 # REVLoan
-[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/structs/REVLoan.sol)
+[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/structs/REVLoan.sol)
 
 **Notes:**
 - member: borrowedAmount The amount that is being borrowed.
@@ -17,12 +17,12 @@
 
 ```solidity
 struct REVLoan {
-    uint112 amount;
-    uint112 collateral;
-    uint48 createdAt;
-    uint16 prepaidFeePercent;
-    uint32 prepaidDuration;
-    REVLoanSource source;
+uint112 amount;
+uint112 collateral;
+uint48 createdAt;
+uint16 prepaidFeePercent;
+uint32 prepaidDuration;
+REVLoanSource source;
 }
 ```
 

package/docs/src/src/structs/REVLoanSource.sol/struct.REVLoanSource.md

@@ -1,5 +1,5 @@
 # REVLoanSource
-[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/structs/REVLoanSource.sol)
+[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/structs/REVLoanSource.sol)
 
 **Notes:**
 - member: token The token that is being loaned.
@@ -9,8 +9,8 @@
 
 ```solidity
 struct REVLoanSource {
-    address token;
-    IJBPayoutTerminal terminal;
+address token;
+IJBPayoutTerminal terminal;
 }
 ```
 

package/docs/src/src/structs/REVStageConfig.sol/struct.REVStageConfig.md

@@ -1,5 +1,5 @@
 # REVStageConfig
-[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/structs/REVStageConfig.sol)
+[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/structs/REVStageConfig.sol)
 
 **Notes:**
 - member: startsAtOrAfter The timestamp to start a stage at the given rate at or after.
@@ -30,15 +30,15 @@ out.
 
 ```solidity
 struct REVStageConfig {
-    uint48 startsAtOrAfter;
-    REVAutoIssuance[] autoIssuances;
-    uint16 splitPercent;
-    JBSplit[] splits;
-    uint112 initialIssuance;
-    uint32 issuanceCutFrequency;
-    uint32 issuanceCutPercent;
-    uint16 cashOutTaxRate;
-    uint16 extraMetadata;
+uint48 startsAtOrAfter;
+REVAutoIssuance[] autoIssuances;
+uint16 splitPercent;
+JBSplit[] splits;
+uint112 initialIssuance;
+uint32 issuanceCutFrequency;
+uint32 issuanceCutPercent;
+uint16 cashOutTaxRate;
+uint16 extraMetadata;
 }
 ```
 

package/docs/src/src/structs/REVSuckerDeploymentConfig.sol/struct.REVSuckerDeploymentConfig.md

@@ -1,5 +1,5 @@
 # REVSuckerDeploymentConfig
-[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/structs/REVSuckerDeploymentConfig.sol)
+[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/structs/REVSuckerDeploymentConfig.sol)
 
 **Notes:**
 - member: deployerConfigurations The information for how to suck tokens to other chains.
@@ -9,8 +9,8 @@
 
 ```solidity
 struct REVSuckerDeploymentConfig {
-    JBSuckerDeployerConfig[] deployerConfigurations;
-    bytes32 salt;
+JBSuckerDeployerConfig[] deployerConfigurations;
+bytes32 salt;
 }
 ```
 

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.6",
+    "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",
@@ -17,16 +20,16 @@
         "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.7",
-        "@bananapus/buyback-hook-v6": "^0.0.4",
-        "@bananapus/core-v6": "^0.0.5",
-        "@bananapus/permission-ids-v6": "^0.0.3",
-        "@bananapus/suckers-v6": "^0.0.4",
+        "@bananapus/721-hook-v6": "^0.0.9",
+        "@bananapus/buyback-hook-v6": "^0.0.7",
+        "@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/slither-ci.config.json

@@ -5,6 +5,6 @@
   "exclude_medium": false,
   "exclude_high": false,
   "disable_color": false,
-  "filter_paths": "(mocks/|test/|node_modules/)",
+  "filter_paths": "(mocks/|test/|node_modules/|lib/)",
   "legacy_ast": false
 }

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.