IMarketConfigurationModule.sol

//SPDX-License-Identifier: MIT
pragma solidity >=0.8.11 <0.9.0;

/**
 * @title Module for market-specific configuration.
 */
interface IMarketConfigurationModule {
    /**
     * @notice thrown when wrap + unwrap fees are being set to a negative value in total
     */
    error InvalidWrapperFees();

    /**
     * @notice emitted when market utilization fees are set for specified market
     * @param synthMarketId market id
     * @param utilizationFeeRate utilization fee rate value
     */
    event MarketUtilizationFeesSet(uint256 indexed synthMarketId, uint256 utilizationFeeRate);

    /**
     * @notice emitted when the skew scale is set for a market
     * @param synthMarketId market id
     * @param skewScale skew scale value
     */
    event MarketSkewScaleSet(uint256 indexed synthMarketId, uint256 skewScale);

    /**
     * @notice emitted when the collateral leverage is set for a market
     * @param synthMarketId market id
     * @param collateralLeverage leverage value
     */
    event CollateralLeverageSet(uint256 indexed synthMarketId, uint256 collateralLeverage);

    /**
     * @notice emitted when the fixed fee for atomic orders is set.
     * @param synthMarketId market id
     * @param atomicFixedFee fee value
     */
    event AtomicFixedFeeSet(uint256 indexed synthMarketId, uint256 atomicFixedFee);

    /**
     * @notice emitted when the fixed fee for async orders is set.
     * @param synthMarketId market id
     * @param asyncFixedFee fee value
     */
    event AsyncFixedFeeSet(uint256 indexed synthMarketId, uint256 asyncFixedFee);

    /**
     * @notice emitted when the fixed fee is set for a given transactor
     * @dev this overrides the async/atomic fixed fees for a given transactor
     * @param synthMarketId Id of the market to set the fees for.
     * @param transactor fixed fee for the transactor (overrides the global fixed fee)
     * @param fixedFeeAmount the fixed fee for the corresponding market, and transactor
     */
    event TransactorFixedFeeSet(
        uint256 indexed synthMarketId,
        address transactor,
        uint256 fixedFeeAmount
    );

    /**
     * @notice emitted when custom fee collector is set for a given market
     * @param synthMarketId Id of the market to set the collector for.
     * @param feeCollector the address of the fee collector to set.
     */
    event FeeCollectorSet(uint256 indexed synthMarketId, address feeCollector);

    /**
     * @notice emitted when wrapper fees are set for a given market
     * @param synthMarketId Id of the market to set the wrapper fees.
     * @param wrapFee wrapping fee in %, 18 decimals. Can be negative.
     * @param unwrapFee unwrapping fee in %, 18 decimals. Can be negative.
     */
    event WrapperFeesSet(uint256 indexed synthMarketId, int256 wrapFee, int256 unwrapFee);

    /**
     * @notice Emitted when the share percentage for a referrer address has been updated.
     * @param marketId Id of the market
     * @param referrer The address of the referrer
     * @param sharePercentage The new share percentage for the referrer
     */
    event ReferrerShareUpdated(uint128 indexed marketId, address referrer, uint256 sharePercentage);

    /**
     * @notice Thrown when the fee collector does not implement the IFeeCollector interface
     */
    error InvalidFeeCollectorInterface(address invalidFeeCollector);

    /**
     * @notice gets the atomic fixed fee for a given market
     * @param synthMarketId Id of the market the fee applies to.
     * @return atomicFixedFee fixed fee amount represented in bips with 18 decimals.
     * @return asyncFixedFee fixed fee amount represented in bips with 18 decimals.
     * @return wrapFee wrapping fee in %, 18 decimals. Can be negative.
     * @return unwrapFee unwrapping fee in %, 18 decimals. Can be negative.
     */
    function getMarketFees(
        uint128 synthMarketId
    )
        external
        returns (uint256 atomicFixedFee, uint256 asyncFixedFee, int256 wrapFee, int256 unwrapFee);

    /**
     * @notice sets the atomic fixed fee for a given market
     * @dev only marketOwner can set the fee
     * @param synthMarketId Id of the market the fee applies to.
     * @param atomicFixedFee fixed fee amount represented in bips with 18 decimals.
     */
    function setAtomicFixedFee(uint128 synthMarketId, uint256 atomicFixedFee) external;

    /**
     * @notice sets the async fixed fee for a given market
     * @dev only marketOwner can set the fee
     * @param synthMarketId Id of the market the fee applies to.
     * @param asyncFixedFee fixed fee amount represented in bips with 18 decimals.
     */
    function setAsyncFixedFee(uint128 synthMarketId, uint256 asyncFixedFee) external;

    /**
     * @notice sets the skew scale for a given market
     * @dev only marketOwner can set the skew scale
     * @param synthMarketId Id of the market the skew scale applies to.
     * @param skewScale max amount of synth which makes the skew 100%. the fee is derived as a % of the max value.  100% premium means outstanding synth == skewScale.
     */
    function setMarketSkewScale(uint128 synthMarketId, uint256 skewScale) external;

    /**
     * @notice gets the skew scale for a given market
     * @param synthMarketId Id of the market the skew scale applies to.
     * @return skewScale max amount of synth which makes the skew 100%. the fee is derived as a % of the max value.  100% premium means outstanding synth == skewScale.
     */
    function getMarketSkewScale(uint128 synthMarketId) external view returns (uint256 skewScale);

    /**
     * @notice sets the market utilization fee for a given market
     * @dev only marketOwner can set the fee
     * @dev 100% utilization means the fee is 0.  120% utilization means the fee is 20% * this fee rate (in bips).
     * @param synthMarketId Id of the market the utilization fee applies to.
     * @param utilizationFeeRate the rate is represented in bips with 18 decimals and is the rate at which fee increases based on the % above 100% utilization of the delegated collateral for the market.
     */
    function setMarketUtilizationFees(uint128 synthMarketId, uint256 utilizationFeeRate) external;

    /**
     * @notice gets the market utilization fee for a given market
     * @dev 100% utilization means the fee is 0.  120% utilization means the fee is 20% * this fee rate (in bips).
     * @param synthMarketId Id of the market the utilization fee applies to.
     * @return utilizationFeeRate the rate is represented in bips with 18 decimals and is the rate at which fee increases based on the % above 100% utilization of the delegated collateral for the market.
     */
    function getMarketUtilizationFees(
        uint128 synthMarketId
    ) external view returns (uint256 utilizationFeeRate);

    /**
     * @notice sets the collateral leverage for a given market
     * @dev only marketOwner can set the leverage
     * @dev this leverage value is a value applied to delegated collateral which is compared to outstanding synth to determine utilization of market, and locked amounts
     * @param synthMarketId Id of the market the collateral leverage applies to.
     * @param collateralLeverage the leverage is represented as % with 18 decimals. 1 = 1x leverage
     */
    function setCollateralLeverage(uint128 synthMarketId, uint256 collateralLeverage) external;

    /**
     * @notice gets the collateral leverage for a given market
     * @dev this leverage value is a value applied to delegated collateral which is compared to outstanding synth to determine utilization of market, and locked amounts
     * @param synthMarketId Id of the market the collateral leverage applies to.
     * @return collateralLeverage the leverage is represented as % with 18 decimals. 1 = 1x leverage
     */
    function getCollateralLeverage(
        uint128 synthMarketId
    ) external view returns (uint256 collateralLeverage);

    /**
     * @notice sets the fixed fee for a given market and transactor
     * @dev overrides both the atomic and async fixed fees
     * @dev only marketOwner can set the fee
     * @dev especially useful for direct integrations where configured traders get a discount
     * @param synthMarketId Id of the market the custom transactor fee applies to.
     * @param transactor address of the trader getting discounted fees.
     * @param fixedFeeAmount the fixed fee applying to the provided transactor.
     */
    function setCustomTransactorFees(
        uint128 synthMarketId,
        address transactor,
        uint256 fixedFeeAmount
    ) external;

    /**
     * @notice gets the fixed fee for a given market and transactor
     * @dev overrides both the atomic and async fixed fees
     * @dev especially useful for direct integrations where configured traders get a discount
     * @param synthMarketId Id of the market the custom transactor fee applies to.
     * @param transactor address of the trader getting discounted fees.
     * @return fixedFeeAmount the fixed fee applying to the provided transactor.
     */
    function getCustomTransactorFees(
        uint128 synthMarketId,
        address transactor
    ) external view returns (uint256 fixedFeeAmount);

    /**
     * @notice sets a custom fee collector for a given market
     * @dev only marketOwner can set the fee collector
     * @dev a use case here would be if the market owner wants to collect the fees via this contract and distribute via rewards distributor to SNX holders for example.
     * @dev if fee collector is not set, the fees are deposited into the market manager.
     * @param synthMarketId Id of the market the fee collector applies to.
     * @param feeCollector address of the fee collector inheriting the IFeeCollector interface.
     */
    function setFeeCollector(uint128 synthMarketId, address feeCollector) external;

    /**
     * @notice gets a custom fee collector for a given market
     * @param synthMarketId Id of the market the fee collector applies to.
     * @return feeCollector address of the fee collector inheriting the IFeeCollector interface.
     */
    function getFeeCollector(uint128 synthMarketId) external view returns (address feeCollector);

    /**
     * @notice sets wrapper related fees.
     * @dev only marketOwner can set the wrapper fees
     * @dev fees can be negative.  this is a way to unwind the wrapper if needed by providing incentives.
     * @param synthMarketId Id of the market the wrapper fees apply to.
     * @param wrapFee wrapping fee in %, 18 decimals. Can be negative.
     * @param unwrapFee unwrapping fee in %, 18 decimals. Can be negative.
     */
    function setWrapperFees(uint128 synthMarketId, int256 wrapFee, int256 unwrapFee) external;

    /**
     * @notice Update the referral share percentage for a given market
     * @param marketId id of the market
     * @param referrer The address of the referrer
     * @param sharePercentage The new share percentage for the referrer
     */
    function updateReferrerShare(
        uint128 marketId,
        address referrer,
        uint256 sharePercentage
    ) external;

    /**
     * @notice get the referral share percentage for a given market
     * @param marketId id of the market
     * @param referrer The address of the referrer
     * @return sharePercentage The new share percentage for the referrer
     */
    function getReferrerShare(
        uint128 marketId,
        address referrer
    ) external view returns (uint256 sharePercentage);
}