chore(honey): move preview functions to reader contract

This also allow to fix UX issues that emerged from the frontend.

Author: dezzeus

script/base/actions/ValidateHoneyUpgrade.s.sol

@@ -28,6 +28,11 @@ contract ValidateHoneyUpgrade is Script {
         Upgrades.validateUpgrade("CollateralVault.sol", options);
         console2.log("CollateralVault can be upgraded successfully.");
 
+        // check HoneyFactoryReader safe upgrade
+        options.referenceContract = "HoneyFactoryReader_V0.sol:HoneyFactoryReader_V0";
+        Upgrades.validateUpgrade("HoneyFactoryReader.sol", options);
+        console2.log("HoneyFactoryReader can be upgraded successfully.");
+
         vm.stopBroadcast();
     }
 }

script/honey/HoneyAddresses.sol

@@ -6,6 +6,6 @@ address constant HONEY_FACTORY_ADDRESS = 0xA4aFef880F5cE1f63c9fb48F661E27F8B4216
 address constant HONEY_FACTORY_READER_ADDRESS = 0x285e147060CDc5ba902786d3A471224ee6cE0F91;
 // HoneyFactory and CollateralVault new implementation, compiled with `deploy` profile
 address constant HONEY_FACTORY_IMPL = 0x3Ba6452ED6C57f4E1A6334E0C3b810c481AdaC64;
-address constant HONEY_FACTORY_READER_IMPL = 0x8101047E260AFbe747D12498e7901dCB9E3267Cb;
+address constant HONEY_FACTORY_READER_IMPL = 0x5603fC37e35Ec730E2305e865CEC780831cF424A;
 address constant COLLATERAL_VAULT_IMPL = 0xb1bBa664fdAdeC06d57Ff49630Cb051f1e0EF483;
-address constant HONEY_FACTORY_PYTH_WRAPPER_ADDRESS = 0x1Ba9636b823D3aB50CA57819434B7f4C0c60E09B;
+address constant HONEY_FACTORY_PYTH_WRAPPER_ADDRESS = 0x4b7cb1c197f8EE4d309866B16C2c12E3B4E7E606;

src/honey/HoneyFactoryPythWrapper.sol

@@ -117,48 +117,6 @@ contract HoneyFactoryPythWrapper is IHoneyFactoryPythWrapper, IHoneyErrors {
         _refundAnyLeftover(asset);
     }
 
-    /// @inheritdoc IHoneyFactoryPythWrapper
-    /// @dev Implementation is copied 1:1 from HoneyFactory to not edit the original contract.
-    function isBasketModeEnabled(bool isMint, uint256[] memory prices) public view returns (bool basketMode) {
-        IHoneyFactory factory_ = IHoneyFactory(factory);
-        VaultAdmin v = VaultAdmin(factory);
-        uint256 registeredAssetsLen = v.numRegisteredAssets();
-
-        if (factory_.forcedBasketMode()) return true;
-
-        for (uint256 i = 0; i < registeredAssetsLen; i++) {
-            address asset = v.registeredAssets(i);
-            bool isPegged_ = isPegged(asset, prices[i]);
-
-            if (isMint) {
-                if (isPegged_ && !v.isBadCollateralAsset(asset)) {
-                    // Basket mode should be disabled. It means there is a good collateral.
-                    return false;
-                }
-            } else if (!isPegged_) {
-                // If the not pegged asset is a bad collateral and its vault doesn't have shares
-                // we can ignore it because it means it has been fully liquidated.
-                uint256 sharesWithoutFees = v.vaults(asset).balanceOf(factory) - v.collectedAssetFees(asset);
-                bool usedAsCollateral = sharesWithoutFees > 0;
-
-                if (!usedAsCollateral) {
-                    continue;
-                }
-                return true;
-            }
-        }
-
-        // When is mint and there is no asset that disable basket mode, return true.
-        // When is redeem and there is no asset that enable basket mode, return false.
-        return isMint ? true : false;
-    }
-
-    /// @inheritdoc IHoneyFactoryPythWrapper
-    function isPegged(address asset, uint256 price) public view returns (bool) {
-        return (1e18 - IHoneyFactory(factory).lowerPegOffsets(asset) <= price)
-            && (price <= 1e18 + IHoneyFactory(factory).upperPegOffsets(asset));
-    }
-
     ///////// INTERNAL /////////
 
     function _updatePyth(bytes[] memory updateData) internal {

src/honey/HoneyFactoryReader.sol

@@ -20,6 +20,7 @@ contract HoneyFactoryReader is AccessControlUpgradeable, UUPSUpgradeable, IHoney
     /// @notice The HoneyFactory contract.
     HoneyFactory public honeyFactory;
 
+    /// @custom:oz-upgrades-unsafe-allow constructor
     constructor() {
         _disableInitializers();
     }
@@ -41,11 +42,185 @@ contract HoneyFactoryReader is AccessControlUpgradeable, UUPSUpgradeable, IHoney
 
     /// @inheritdoc IHoneyFactoryReader
     /// @dev `asset` param is ignored if running in basket mode.
-    function previewMintCollaterals(address asset, uint256 honey) public view returns (uint256[] memory amounts) {
+    function previewMintCollaterals(address asset, uint256 honey) external view returns (uint256[] memory amounts) {
+        bool basketMode = honeyFactory.isBasketModeEnabled(true);
+
+        amounts = _previewMintCollaterals(asset, honey, basketMode);
+    }
+
+    /// @inheritdoc IHoneyFactoryReader
+    /// @dev `asset` param is ignored if running in basket mode.
+    function previewMintCollateralsWithPrices(
+        address asset,
+        uint256 honey,
+        uint256[] memory prices
+    )
+        external
+        view
+        returns (uint256[] memory amounts)
+    {
+        bool basketMode = isBasketModeEnabledWithPrices(true, prices);
+
+        amounts = _previewMintCollaterals(asset, honey, basketMode);
+    }
+
+    /// @inheritdoc IHoneyFactoryReader
+    function previewMintHoney(
+        address asset,
+        uint256 amount
+    )
+        external
+        view
+        returns (uint256[] memory collaterals, uint256 honey)
+    {
+        bool basketMode = honeyFactory.isBasketModeEnabled(true);
+
+        (collaterals, honey) = _previewMintHoney(asset, amount, basketMode);
+    }
+
+    /// @inheritdoc IHoneyFactoryReader
+    function previewMintHoneyWithPrices(
+        address asset,
+        uint256 amount,
+        uint256[] memory prices
+    )
+        external
+        view
+        returns (uint256[] memory collaterals, uint256 honey)
+    {
+        bool basketMode = isBasketModeEnabledWithPrices(true, prices);
+
+        (collaterals, honey) = _previewMintHoney(asset, amount, basketMode);
+    }
+
+    /// @inheritdoc IHoneyFactoryReader
+    /// @dev `asset` param is ignored if running in basket mode.
+    function previewRedeemCollaterals(
+        address asset,
+        uint256 honey
+    )
+        external
+        view
+        returns (uint256[] memory collaterals)
+    {
+        bool basketMode = honeyFactory.isBasketModeEnabled(false);
+
+        collaterals = _previewRedeemCollaterals(asset, honey, basketMode);
+    }
+
+    /// @inheritdoc IHoneyFactoryReader
+    /// @dev `asset` param is ignored if running in basket mode.
+    function previewRedeemCollateralsWithPrices(
+        address asset,
+        uint256 honey,
+        uint256[] memory prices
+    )
+        external
+        view
+        returns (uint256[] memory collaterals)
+    {
+        bool basketMode = isBasketModeEnabledWithPrices(false, prices);
+
+        collaterals = _previewRedeemCollaterals(asset, honey, basketMode);
+    }
+
+    /// @inheritdoc IHoneyFactoryReader
+    /// @dev If the basket mode is enabled, the required Honey amount will provide also other collaterals beside
+    /// required `amount` of `asset`.
+    function previewRedeemHoney(
+        address asset,
+        uint256 amount
+    )
+        external
+        view
+        returns (uint256[] memory collaterals, uint256 honey)
+    {
+        bool basketMode = honeyFactory.isBasketModeEnabled(false);
+
+        (collaterals, honey) = _previewRedeemHoney(asset, amount, basketMode);
+    }
+
+    /// @inheritdoc IHoneyFactoryReader
+    /// @dev If the basket mode is enabled, the required Honey amount will provide also other collaterals beside
+    /// required `amount` of `asset`.
+    function previewRedeemHoneyWithPrices(
+        address asset,
+        uint256 amount,
+        uint256[] memory prices
+    )
+        external
+        view
+        returns (uint256[] memory collaterals, uint256 honey)
+    {
+        bool basketMode = isBasketModeEnabledWithPrices(false, prices);
+
+        (collaterals, honey) = _previewRedeemHoney(asset, amount, basketMode);
+    }
+
+    /// @inheritdoc IHoneyFactoryReader
+    /// @dev Implementation is copied 1:1 from HoneyFactory to not edit the original contract.
+    function isBasketModeEnabledWithPrices(
+        bool isMint,
+        uint256[] memory prices
+    )
+        public
+        view
+        returns (bool basketMode)
+    {
+        uint256 registeredAssetsLen = honeyFactory.numRegisteredAssets();
+
+        if (honeyFactory.forcedBasketMode()) return true;
+
+        for (uint256 i = 0; i < registeredAssetsLen; i++) {
+            address asset = honeyFactory.registeredAssets(i);
+            bool isPegged_ = isPeggedWithPrice(asset, prices[i]);
+
+            if (isMint) {
+                if (isPegged_ && !honeyFactory.isBadCollateralAsset(asset)) {
+                    // Basket mode should be disabled. It means there is a good collateral.
+                    return false;
+                }
+            } else if (!isPegged_) {
+                // If the not pegged asset is a bad collateral and its vault doesn't have shares
+                // we can ignore it because it means it has been fully liquidated.
+                uint256 sharesWithoutFees = honeyFactory.vaults(asset).balanceOf(address(honeyFactory))
+                    - honeyFactory.collectedAssetFees(asset);
+                bool usedAsCollateral = sharesWithoutFees > 0;
+
+                if (!usedAsCollateral) {
+                    continue;
+                }
+                return true;
+            }
+        }
+
+        // When is mint and there is no asset that disable basket mode, return true.
+        // When is redeem and there is no asset that enable basket mode, return false.
+        return isMint ? true : false;
+    }
+
+    /// @inheritdoc IHoneyFactoryReader
+    function isPeggedWithPrice(address asset, uint256 price) public view returns (bool) {
+        return (1e18 - honeyFactory.lowerPegOffsets(asset) <= price)
+            && (price <= 1e18 + honeyFactory.upperPegOffsets(asset));
+    }
+
+    /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
+    /*                     INTERNAL FUNCTIONS                     */
+    /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
+
+    function _previewMintCollaterals(
+        address asset,
+        uint256 honey,
+        bool basketMode
+    )
+        internal
+        view
+        returns (uint256[] memory amounts)
+    {
         (address[] memory collaterals, uint256 num) = _getCollaterals();
         amounts = new uint256[](num);
         uint256[] memory weights = honeyFactory.getWeights();
-        bool basketMode = honeyFactory.isBasketModeEnabled(true);
         for (uint256 i = 0; i < num; i++) {
             if (!basketMode && collaterals[i] != asset) {
                 continue;
@@ -66,37 +241,34 @@ contract HoneyFactoryReader is AccessControlUpgradeable, UUPSUpgradeable, IHoney
         }
     }
 
-    /// @inheritdoc IHoneyFactoryReader
-    function previewMintHoney(
+    function _previewMintHoney(
         address asset,
-        uint256 amount
+        uint256 amount,
+        bool basketMode
     )
-        external
+        internal
         view
         returns (uint256[] memory collaterals, uint256 honey)
     {
-        bool basketMode = honeyFactory.isBasketModeEnabled(true);
         collaterals = _getWeightedCollaterals(asset, amount, basketMode);
         (address[] memory assets, uint256 num) = _getCollaterals();
         for (uint256 i = 0; i < num; i++) {
             honey += _previewMint(assets[i], collaterals[i]);
         }
     }
 
-    /// @inheritdoc IHoneyFactoryReader
-    /// @dev `asset` param is ignored if running in basket mode.
-    function previewRedeemCollaterals(
+    function _previewRedeemCollaterals(
         address asset,
-        uint256 honey
+        uint256 honey,
+        bool basketMode
     )
-        external
+        internal
         view
         returns (uint256[] memory collaterals)
     {
         (address[] memory assets, uint256 num) = _getCollaterals();
         collaterals = new uint256[](num);
 
-        bool basketMode = honeyFactory.isBasketModeEnabled(false);
         if (!basketMode) {
             (uint256 refAssetIndex,) = _getIndexOfAsset(assets, num, asset);
             collaterals[refAssetIndex] = _previewRedeem(asset, honey);
@@ -110,29 +282,22 @@ contract HoneyFactoryReader is AccessControlUpgradeable, UUPSUpgradeable, IHoney
         }
     }
 
-    /// @inheritdoc IHoneyFactoryReader
-    /// @dev If the basket mode is enabled, the required Honey amount will provide also other collaterals beside
-    /// required `amount` of `asset`.
-    function previewRedeemHoney(
+    function _previewRedeemHoney(
         address asset,
-        uint256 amount
+        uint256 amount,
+        bool basketMode
     )
-        external
+        internal
         view
         returns (uint256[] memory collaterals, uint256 honey)
     {
-        bool basketMode = honeyFactory.isBasketModeEnabled(false);
         collaterals = _getWeightedCollaterals(asset, amount, basketMode);
         (address[] memory assets, uint256 num) = _getCollaterals();
         for (uint256 i = 0; i < num; i++) {
             honey += _previewHoneyToRedeem(assets[i], collaterals[i]);
         }
     }
 
-    /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/
-    /*                     INTERNAL FUNCTIONS                     */
-    /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
-
     /// @notice Get the amount of Honey that can be minted with the given ERC20.
     /// @param asset The ERC20 to mint with.
     /// @param amount The amount of ERC20 to mint with.

src/honey/IHoneyFactoryPythWrapper.sol

@@ -69,15 +69,4 @@ interface IHoneyFactoryPythWrapper {
     /// @param asset The ERC20 asset to recapitalize.
     /// @param amount The amount provided.
     function recapitalize(bytes[] calldata updateData, address asset, uint256 amount) external payable;
-
-    /// @notice HoneyFactory isBasketModeEnabled with externally provided price.
-    /// @param isMint True if checking basket mode for minting.
-    /// @param prices The prices assumed to be valid.
-    function isBasketModeEnabled(bool isMint, uint256[] memory prices) external returns (bool basketMode);
-
-    /// @notice HoneyFactory isPegged with externally provided price.
-    /// @param asset The asset to check.
-    /// @param price The price assumed to be valid.
-    /// @return true if the asset is pegged.
-    function isPegged(address asset, uint256 price) external returns (bool);
 }