@venusprotocol/protocol-reserve 1.3.0 → 1.4.0-dev.1

package/contracts/TokenConverter/ConverterNetwork.sol

@@ -0,0 +1,243 @@
+// SPDX-License-Identifier: BSD-3-Clause
+pragma solidity 0.8.13;
+
+import { AccessControlledV8 } from "@venusprotocol/governance-contracts/contracts/Governance/AccessControlledV8.sol";
+import { MaxLoopsLimitHelper } from "@venusprotocol/solidity-utilities/contracts/MaxLoopsLimitHelper.sol";
+import { ensureNonzeroAddress } from "@venusprotocol/solidity-utilities/contracts/validators.sol";
+
+import { sort } from "../Utils/ArrayHelpers.sol";
+import { IAbstractTokenConverter } from "./IAbstractTokenConverter.sol";
+import { IConverterNetwork } from "../Interfaces/IConverterNetwork.sol";
+
+/// @title ConverterNetwork
+/// @author Venus
+/// @notice ConverterNetwork keeps track of all the converters and is used to fetch valid converters which provide conversions according to token addresses provided
+/// @custom:security-contact https://github.com/VenusProtocol/protocol-reserve#discussion
+contract ConverterNetwork is IConverterNetwork, AccessControlledV8, MaxLoopsLimitHelper {
+    /// @notice Array holding all the converters
+    IAbstractTokenConverter[] public allConverters;
+
+    /// @notice Emitted when new converter is added
+    event ConverterAdded(address indexed converter);
+
+    /// @notice Emitted when converter is removed
+    event ConverterRemoved(address indexed converter);
+
+    /// @notice Error thrown when converter already exists
+    error ConverterAlreadyExists();
+
+    /// @notice Error thrown converter does not exist
+    error ConverterDoesNotExist();
+
+    /// @notice Error thrown when converter address is invalid
+    error InvalidTokenConverterAddress();
+
+    /// @notice Error thrown when loops limit is invalid
+    error InvalidMaxLoopsLimit(uint256 loopsLimit);
+
+    /// @custom:oz-upgrades-unsafe-allow constructor
+    constructor() {
+        // Note that the contract is upgradeable. Use initialize() or reinitializers
+        // to set the state variables.
+        _disableInitializers();
+    }
+
+    /// @notice ConverterNetwork initializer
+    /// @param _accessControlManager The address of ACM contract
+    /// @param _loopsLimit Limit for the loops in the contract to avoid DOS
+    /// @custom:event ConverterAdded is emitted for each converter added on success
+    /// @custom:error InvalidMaxLoopsLimit is thrown when when loops limit is invalid
+    function initialize(address _accessControlManager, uint256 _loopsLimit) external initializer {
+        ensureNonzeroAddress(_accessControlManager);
+        __AccessControlled_init(_accessControlManager);
+
+        if (_loopsLimit >= type(uint128).max) revert InvalidMaxLoopsLimit(_loopsLimit);
+        _setMaxLoopsLimit(_loopsLimit);
+    }
+
+    /**
+     * @notice Set the limit for the loops can iterate to avoid the DOS
+     * @param limit Limit for the max loops can execute at a time
+     * @custom:error InvalidMaxLoopsLimit is thrown when when loops limit is invalid
+     * @custom:access Only owner
+     */
+    function setMaxLoopsLimit(uint256 limit) external onlyOwner {
+        if (limit >= type(uint128).max) revert InvalidMaxLoopsLimit(limit);
+        _setMaxLoopsLimit(limit);
+    }
+
+    /// @notice Adds new converter to the array
+    /// @param _tokenConverter Address of the token converter
+    /// @custom:event ConverterAdded is emitted on success
+    /// @custom:access Only Governance
+    function addTokenConverter(IAbstractTokenConverter _tokenConverter) external {
+        _checkAccessAllowed("addTokenConverter(address)");
+        _addTokenConverter(_tokenConverter);
+    }
+
+    /// @notice Removes converter from the array
+    /// @param _tokenConverter Address of the token converter
+    /// @custom:error ConverterDoesNotExist is thrown when converter to remove does not exist
+    /// @custom:event ConverterRemoved is emitted on success
+    /// @custom:access Only Governance
+    function removeTokenConverter(IAbstractTokenConverter _tokenConverter) external {
+        _checkAccessAllowed("removeTokenConverter(address)");
+
+        // Find the index of the converter in the array
+        uint128 indexToRemove = _findConverterIndex(_tokenConverter);
+
+        // Ensure that the converter exists in the array
+        if (indexToRemove == type(uint128).max) revert ConverterDoesNotExist();
+
+        // Swap the element to remove with the last element
+        allConverters[indexToRemove] = allConverters[allConverters.length - 1];
+
+        // Remove the last element (which is now a duplicate)
+        allConverters.pop();
+
+        emit ConverterRemoved(address(_tokenConverter));
+    }
+
+    /// @notice Used to get the array of converters supporting conversions, arranged in descending order based on token balances
+    /// It will return the converters which are open to users for conversion
+    /// @param _tokenAddressIn Address of tokenIn
+    /// @param _tokenAddressOut Address of tokenOut
+    /// @return converters Array of the conveters on the basis of the tokens pair
+    /// @return convertersBalance Array of balances with respect to token out
+    function findTokenConverters(address _tokenAddressIn, address _tokenAddressOut)
+        external
+        returns (address[] memory converters, uint256[] memory convertersBalance)
+    {
+        (converters, convertersBalance) = _findTokenConverters(_tokenAddressIn, _tokenAddressOut, false);
+    }
+
+    /// @notice Used to get the array of converters supporting conversions, arranged in descending order based on token balances
+    /// It will return the converters which are open to converters for conversion.
+    /// @param _tokenAddressIn Address of tokenIn
+    /// @param _tokenAddressOut Address of tokenOut
+    /// @return converters Array of the conveters on the basis of the tokens pair
+    /// @return convertersBalance Array of balances with respect to token out
+    function findTokenConvertersForConverters(address _tokenAddressIn, address _tokenAddressOut)
+        external
+        returns (address[] memory converters, uint256[] memory convertersBalance)
+    {
+        (converters, convertersBalance) = _findTokenConverters(_tokenAddressIn, _tokenAddressOut, true);
+    }
+
+    /// @notice This function returns the array containing all the converters addresses
+    /// @return converters Array containing all the converters addresses
+    function getAllConverters() external view returns (IAbstractTokenConverter[] memory converters) {
+        converters = allConverters;
+    }
+
+    /// @notice This function checks if the given address is a converter or not
+    /// @param _tokenConverter Address of the token converter
+    /// @return isConverter true if given address is converter otherwise false
+    function isTokenConverter(address _tokenConverter) external view returns (bool isConverter) {
+        uint128 index = _findConverterIndex(IAbstractTokenConverter(_tokenConverter));
+
+        if (index != type(uint128).max) {
+            isConverter = true;
+        }
+    }
+
+    /// @notice Adds new converter contract to the array
+    /// @param _tokenConverter Address of the token converter
+    /// @custom:error ConverterAlreadyExists is thrown when new tokenconverter to add already exists
+    /// @custom:event ConverterAdded is emitted on success
+    function _addTokenConverter(IAbstractTokenConverter _tokenConverter) internal {
+        if (
+            (address(_tokenConverter) == address(0)) || (address(_tokenConverter.converterNetwork()) != address(this))
+        ) {
+            revert InvalidTokenConverterAddress();
+        }
+
+        uint128 index = _findConverterIndex(_tokenConverter);
+        if (index != type(uint128).max) revert ConverterAlreadyExists();
+
+        allConverters.push(_tokenConverter);
+        _ensureMaxLoops(allConverters.length);
+
+        emit ConverterAdded(address(_tokenConverter));
+    }
+
+    /// @notice Used to get the array of converters supporting conversions, arranged in descending order based on token balances
+    /// @param _tokenAddressIn Address of tokenIn
+    /// @param _tokenAddressOut Address of tokenOut
+    /// @param forConverters Bool to filter out converters on the basis of the conversionAccess
+    /// @return converters Array of converters
+    /// @return convertersBalance Array of balances with respect to token out
+    function _findTokenConverters(
+        address _tokenAddressIn,
+        address _tokenAddressOut,
+        bool forConverters
+    ) internal returns (address[] memory converters, uint256[] memory convertersBalance) {
+        uint128 convertersLength = uint128(allConverters.length);
+
+        // Create a dynamic array to store the matching converters
+        converters = new address[](convertersLength);
+        convertersBalance = new uint256[](convertersLength);
+        uint128 count;
+
+        for (uint128 i; i < convertersLength; ) {
+            IAbstractTokenConverter converter = allConverters[i];
+
+            unchecked {
+                ++i;
+            }
+
+            if ((address(converter.converterNetwork()) != address(this)) || msg.sender == address(converter)) {
+                continue;
+            }
+
+            (, IAbstractTokenConverter.ConversionAccessibility conversionAccess) = converter.conversionConfigurations(
+                _tokenAddressIn,
+                _tokenAddressOut
+            );
+
+            if (conversionAccess == IAbstractTokenConverter.ConversionAccessibility.ALL) {
+                converters[count] = address(converter);
+                convertersBalance[count] = converter.balanceOf(_tokenAddressOut);
+                ++count;
+            } else if (
+                forConverters &&
+                (conversionAccess == IAbstractTokenConverter.ConversionAccessibility.ONLY_FOR_CONVERTERS)
+            ) {
+                converters[count] = address(converter);
+                convertersBalance[count] = converter.balanceOf(_tokenAddressOut);
+                ++count;
+            } else if (
+                !forConverters && (conversionAccess == IAbstractTokenConverter.ConversionAccessibility.ONLY_FOR_USERS)
+            ) {
+                converters[count] = address(converter);
+                convertersBalance[count] = converter.balanceOf(_tokenAddressOut);
+                ++count;
+            }
+        }
+
+        // Resize the array to the actual number of matching converters
+        assembly {
+            mstore(converters, count)
+            mstore(convertersBalance, count)
+        }
+        sort(convertersBalance, converters);
+    }
+
+    /// @notice Used to get the index of the converter stored in the array
+    /// This will return the index if the converter exists in the array otherwise will return type(uint128).max
+    /// @param _tokenConverter Address of the token converter
+    /// @return index of the converter address in the allConverters array
+    function _findConverterIndex(IAbstractTokenConverter _tokenConverter) internal view returns (uint128 index) {
+        index = type(uint128).max; // Not found, return a large value
+
+        uint128 convertersLength = uint128(allConverters.length);
+        for (uint128 i; i < convertersLength; ) {
+            if (allConverters[i] == _tokenConverter) {
+                index = i;
+            }
+            unchecked {
+                ++i;
+            }
+        }
+    }
+}

package/contracts/TokenConverter/IAbstractTokenConverter.sol

@@ -0,0 +1,178 @@
+// SPDX-License-Identifier: BSD-3-Clause
+pragma solidity 0.8.13;
+
+import { ResilientOracle } from "@venusprotocol/oracle/contracts/ResilientOracle.sol";
+import { IConverterNetwork } from "../Interfaces/IConverterNetwork.sol";
+
+/// @notice Interface for AbstractTokenConverter
+/// @custom:security-contact https://github.com/VenusProtocol/protocol-reserve#discussion
+interface IAbstractTokenConverter {
+    /// @notice This enum define the all possible ways of conversion can happen
+    enum ConversionAccessibility {
+        NONE, // Conversion is disable for the pair
+        ALL, // Conversion is enable for private conversion and users
+        ONLY_FOR_CONVERTERS, // Conversion is enable only for private conversion
+        ONLY_FOR_USERS // Conversion is enable only for users
+    }
+
+    /// @notice This struct represents the configuration for a token conversion.
+    struct ConversionConfig {
+        /// incentive on conversion of tokens in mantissa i.e 10% incentive would be 0.1 * 1e18
+        uint256 incentive;
+        /// enable or disable conversion for users or converters or both or none
+        ConversionAccessibility conversionAccess;
+    }
+
+    /// @notice Pause conversion of tokens
+    function pauseConversion() external;
+
+    /// @notice Resume conversion of tokens.
+    function resumeConversion() external;
+
+    /// @notice Sets a new price oracle
+    /// @param priceOracle_ Address of the new price oracle to set
+    function setPriceOracle(ResilientOracle priceOracle_) external;
+
+    /// @notice Set the configuration for new or existing convert pair
+    /// @param tokenAddressIn Address of tokenIn
+    /// @param tokenAddressOut Address of tokenOut
+    /// @param conversionConfig ConversionConfig config details to update
+    function setConversionConfig(
+        address tokenAddressIn,
+        address tokenAddressOut,
+        ConversionConfig calldata conversionConfig
+    ) external;
+
+    /// @notice Convert exact amount of tokenAddressIn for tokenAddressOut
+    /// @dev Method does not support deflationary tokens transfer
+    /// @param amountInMantissa Amount of tokenAddressIn
+    /// @param amountOutMinMantissa Min amount of tokenAddressOut required as output
+    /// @param tokenAddressIn Address of the token to convert
+    /// @param tokenAddressOut Address of the token to get after convert
+    /// @param to Address of the tokenAddressOut receiver
+    function convertExactTokens(
+        uint256 amountInMantissa,
+        uint256 amountOutMinMantissa,
+        address tokenAddressIn,
+        address tokenAddressOut,
+        address to
+    ) external returns (uint256 actualAmountIn, uint256 actualAmountOut);
+
+    /// @notice Convert tokens for tokenAddressIn for exact amount of tokenAddressOut
+    /// @dev Method does not support deflationary tokens transfer
+    /// @param amountInMaxMantissa Max amount of tokenAddressIn
+    /// @param amountOutMantissa Amount of tokenAddressOut required as output
+    /// @param tokenAddressIn Address of the token to convert
+    /// @param tokenAddressOut Address of the token to get after convert
+    /// @param to Address of the tokenAddressOut receiver
+    function convertForExactTokens(
+        uint256 amountInMaxMantissa,
+        uint256 amountOutMantissa,
+        address tokenAddressIn,
+        address tokenAddressOut,
+        address to
+    ) external returns (uint256 actualAmountIn, uint256 actualAmountOut);
+
+    /// @notice Convert exact amount of tokenAddressIn for tokenAddressOut
+    /// @param amountInMantissa Amount of tokenAddressIn
+    /// @param amountOutMinMantissa Min amount of tokenAddressOut required as output
+    /// @param tokenAddressIn Address of the token to convert
+    /// @param tokenAddressOut Address of the token to get after convert
+    /// @param to Address of the tokenAddressOut receiver
+    function convertExactTokensSupportingFeeOnTransferTokens(
+        uint256 amountInMantissa,
+        uint256 amountOutMinMantissa,
+        address tokenAddressIn,
+        address tokenAddressOut,
+        address to
+    ) external returns (uint256 actualAmountIn, uint256 actualAmountOut);
+
+    /// @notice Convert tokens for tokenAddressIn for exact amount of tokenAddressOut
+    /// @param amountInMaxMantissa Max amount of tokenAddressIn
+    /// @param amountOutMantissa Amount of tokenAddressOut required as output
+    /// @param tokenAddressIn Address of the token to convert
+    /// @param tokenAddressOut Address of the token to get after convert
+    /// @param to Address of the tokenAddressOut receiver
+    function convertForExactTokensSupportingFeeOnTransferTokens(
+        uint256 amountInMaxMantissa,
+        uint256 amountOutMantissa,
+        address tokenAddressIn,
+        address tokenAddressOut,
+        address to
+    ) external returns (uint256 actualAmountIn, uint256 actualAmountOut);
+
+    /// @notice Get the configuration for the pair of the tokens
+    /// @param tokenAddressIn Address of the token to convert
+    /// @param tokenAddressOut Address of the token to get after conversion
+    /// @return incentives Percentage of incentives to be distributed for the pair of tokens
+    /// @return conversionAccess Accessibility for the pair of tokens
+    function conversionConfigurations(address tokenAddressIn, address tokenAddressOut)
+        external
+        returns (uint256 incentives, ConversionAccessibility conversionAccess);
+
+    /// @notice Get the address of the converterNetwork
+    function converterNetwork() external returns (IConverterNetwork converterNetwork);
+
+    /// @notice To get the amount of tokenAddressOut tokens sender could receive on providing amountInMantissa tokens of tokenAddressIn
+    /// @param amountInMantissa Amount of tokenAddressIn
+    /// @param tokenAddressIn Address of the token to convert
+    /// @param tokenAddressOut Address of the token to get after conversion
+    /// @return amountConvertedMantissa Amount of tokenAddressIn should be transferred after conversion
+    /// @return amountOutMantissa Amount of the tokenAddressOut sender should receive after conversion
+    /// @custom:error InsufficientInputAmount error is thrown when given input amount is zero
+    /// @custom:error ConversionConfigNotEnabled is thrown when conversion is disabled or config does not exist for given pair
+    function getUpdatedAmountOut(
+        uint256 amountInMantissa,
+        address tokenAddressIn,
+        address tokenAddressOut
+    ) external returns (uint256 amountConvertedMantissa, uint256 amountOutMantissa);
+
+    /// @notice To get the amount of tokenAddressIn tokens sender would send on receiving amountOutMantissa tokens of tokenAddressOut
+    /// @param amountOutMantissa Amount of tokenAddressOut user wants to receive
+    /// @param tokenAddressIn Address of the token to convert
+    /// @param tokenAddressOut Address of the token to get after conversion
+    /// @return amountConvertedMantissa Amount of tokenAddressOut should be transferred after conversion
+    /// @return amountInMantissa Amount of the tokenAddressIn sender would send to contract before conversion
+    /// @custom:error InsufficientInputAmount error is thrown when given input amount is zero
+    /// @custom:error ConversionConfigNotEnabled is thrown when conversion is disabled or config does not exist for given pair
+    function getUpdatedAmountIn(
+        uint256 amountOutMantissa,
+        address tokenAddressIn,
+        address tokenAddressOut
+    ) external returns (uint256 amountConvertedMantissa, uint256 amountInMantissa);
+
+    /// @notice To get the amount of tokenAddressIn tokens sender would send on receiving amountOutMantissa tokens of tokenAddressOut
+    /// @dev This function retrieves values without altering token prices.
+    /// @param amountOutMantissa Amount of tokenAddressOut user wants to receive
+    /// @param tokenAddressIn Address of the token to convert
+    /// @param tokenAddressOut Address of the token to get after conversion
+    /// @return amountConvertedMantissa Amount of tokenAddressOut should be transferred after conversion
+    /// @return amountInMantissa Amount of the tokenAddressIn sender would send to contract before conversion
+    /// @custom:error InsufficientInputAmount error is thrown when given input amount is zero
+    /// @custom:error ConversionConfigNotEnabled is thrown when conversion is disabled or config does not exist for given pair
+    function getAmountIn(
+        uint256 amountOutMantissa,
+        address tokenAddressIn,
+        address tokenAddressOut
+    ) external view returns (uint256 amountConvertedMantissa, uint256 amountInMantissa);
+
+    /// @notice To get the amount of tokenAddressOut tokens sender could receive on providing amountInMantissa tokens of tokenAddressIn
+    /// @dev This function retrieves values without altering token prices.
+    /// @param amountInMantissa Amount of tokenAddressIn
+    /// @param tokenAddressIn Address of the token to convert
+    /// @param tokenAddressOut Address of the token to get after conversion
+    /// @return amountConvertedMantissa Amount of tokenAddressIn should be transferred after conversion
+    /// @return amountOutMantissa Amount of the tokenAddressOut sender should receive after conversion
+    /// @custom:error InsufficientInputAmount error is thrown when given input amount is zero
+    /// @custom:error ConversionConfigNotEnabled is thrown when conversion is disabled or config does not exist for given pair
+    function getAmountOut(
+        uint256 amountInMantissa,
+        address tokenAddressIn,
+        address tokenAddressOut
+    ) external view returns (uint256 amountConvertedMantissa, uint256 amountOutMantissa);
+
+    /// @notice Get the balance for specific token
+    /// @param token Address of the token
+    /// @return tokenBalance Balance of the token the contract has
+    function balanceOf(address token) external view returns (uint256 tokenBalance);
+}