[v1.5] Polymorphic Price Config [WIP]

contracts/price/IZNSCurvePricer.sol

@@ -1,115 +1,70 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import { ICurvePriceConfig } from "../types/ICurvePriceConfig.sol";
-import { IZNSPricer } from "../types/IZNSPricer.sol";
+import { IZNSPricer } from "./IZNSPricer.sol";
 
 
-interface IZNSCurvePricer is ICurvePriceConfig, IZNSPricer {
+interface IZNSCurvePricer is IZNSPricer {
 
     /**
-     * @notice Reverted when multiplier passed by the domain owner
-     * is equal to 0 or more than 10^18, which is too large.
+     * @notice Struct for each configurable variable for price and fee calculations.
      */
-    error InvalidPrecisionMultiplierPassed(bytes32 domainHash);
+    struct CurvePriceConfig {
+        /**
+         * @notice Maximum price for a domain returned at <= `baseLength`
+        */
+        uint256 maxPrice;
+        /**
+         * @notice Multiplier which we use to bend a curve of price on interval from `baseLength` to `maxLength`.
+         */
+        uint256 curveMultiplier;
+        /**
+         * @notice Maximum length of a domain name. If the name is longer than this
+         * value we return the price that was at the `maxLength`
+         */
+        uint256 maxLength;
+        /**
+         * @notice Base length of a domain name. If the name is less than or equal to
+         * this value we return the `maxPrice`
+         */
+        uint256 baseLength;
+        /**
+         * @notice The precision multiplier of the price. This multiplier
+         * should be picked based on the number of token decimals to calculate properly.
+         * e.g. if we use a token with 18 decimals, and want precision of 2,
+         * our precision multiplier will be equal 10^18 - 10^2 = 10^16
+         */
+        uint256 precisionMultiplier;
+        /**
+         * @notice The registration fee value in percentage as basis points (parts per 10,000)
+         *  so the 2% value would be represented as 200.
+         *  See [getRegistrationFee](#getregistrationfee) for the actual fee calc process.
+         */
+        uint256 feePercentage;
+    }
 
     /**
-     * @notice Emitted when the `maxPrice` is set in `CurvePriceConfig`
-     * @param price The new maxPrice value
-     */
-    event MaxPriceSet(bytes32 domainHash, uint256 price);
-
-    /**
-     * @notice Emitted when the `baseLength` is set in `CurvePriceConfig`
-     * @param length The new baseLength value
-     */
-    event BaseLengthSet(bytes32 domainHash, uint256 length);
-
-    /**
-     * @notice Emitted when the `maxLength` is set in `CurvePriceConfig`
-     * @param length The new maxLength value
-     */
-    event MaxLengthSet(bytes32 domainHash, uint256 length);
-
-    /**
-     * @notice Emitted when the `precisionMultiplier` is set in `CurvePriceConfig`
-     * @param precision The new precisionMultiplier value
-     */
-    event PrecisionMultiplierSet(bytes32 domainHash, uint256 precision);
-
-    /**
-     * @notice Emitted when the `feePercentage` is set in state
-     * @param feePercentage The new feePercentage value
+     * @notice Reverted when multiplier passed by the domain owner
+     * is equal to 0 or more than 10^18, which is too large.
      */
-    event FeePercentageSet(bytes32 domainHash, uint256 feePercentage);
+    error InvalidPrecisionMultiplierPassed();
 
     /**
-     * @notice Emitted when the `curveMultiplier` is set in state
-     * @param curveMultiplier The new curveMultiplier value
+     * @notice Reverted when `maxLength` smaller than `baseLength`.
      */
-    event CurveMultiplierSet(bytes32 domainHash, uint256 curveMultiplier);
-
+    error MaxLengthSmallerThanBaseLength();
 
     /**
-     * @notice Emitted when the full `CurvePriceConfig` is set in state
-     * @param maxPrice The new `maxPrice` value
-     * @param curveMultiplier The new `curveMultiplier` value
-     * @param maxLength The new `maxLength` value
-     * @param baseLength The new `baseLength` value
-     * @param precisionMultiplier The new `precisionMultiplier` value
+     * @notice Reverted when `curveMultiplier` AND `baseLength` are 0.
      */
-    event PriceConfigSet(
-        bytes32 domainHash,
-        uint256 maxPrice,
-        uint256 curveMultiplier,
-        uint256 maxLength,
-        uint256 baseLength,
-        uint256 precisionMultiplier,
-        uint256 feePercentage
-    );
-
-    function initialize(
-        address accessController_,
-        address registry_,
-        CurvePriceConfig calldata zeroPriceConfig_
-    ) external;
-
-    function getPrice(
-        bytes32 parentHash,
-        string calldata label,
-        bool skipValidityCheck
-    ) external view returns (uint256);
-
-    function getFeeForPrice(
-        bytes32 parentHash,
-        uint256 price
-    ) external view returns (uint256);
-
-    function getPriceAndFee(
-        bytes32 parentHash,
-        string calldata label,
-        bool skipValidityCheck
-    ) external view returns (
-        uint256 price,
-        uint256 stakeFee
-    );
-
-    function setPriceConfig(
-        bytes32 domainHash,
-        CurvePriceConfig calldata priceConfig
-    ) external;
-
-    function setMaxPrice(bytes32 domainHash, uint256 maxPrice) external;
-
-    function setBaseLength(bytes32 domainHash, uint256 length) external;
-
-    function setMaxLength(bytes32 domainHash, uint256 length) external;
-
-    function setCurveMultiplier(bytes32 domainHash, uint256 curveMultiplier) external;
+    error DivisionByZero();
 
-    function setPrecisionMultiplier(bytes32 domainHash, uint256 multiplier) external;
+    function encodeConfig(
+        CurvePriceConfig calldata config
+    ) external pure returns (bytes memory);
 
-    function setFeePercentage(bytes32 domainHash, uint256 feePercentage) external;
 
-    function setRegistry(address registry_) external;
+    function decodePriceConfig(
+        bytes memory priceConfig
+    ) external pure returns (CurvePriceConfig memory);
 }

contracts/price/IZNSFixedPricer.sol

@@ -1,10 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import { IZNSPricer } from "../types/IZNSPricer.sol";
+import { IZNSPricer } from "./IZNSPricer.sol";
+
 
 /**
- * @title IZNSFixedPricer.sol Below is the doc for PriceConfig struct.
+ * @title IZNSFixedPricer.sol Below is the doc for FixedPriceConfig struct.
  * @notice Struct for price configurations per domainHash that is used in the `priceConfigs` mapping
  *  - price The value determining how much a subdomain under a particular parent would cost
  *  - feePercentage The value determining how much fee is charged for a subdomain registration
@@ -14,55 +15,29 @@ import { IZNSPricer } from "../types/IZNSPricer.sol";
  */
 interface IZNSFixedPricer is IZNSPricer {
     /**
-     * @notice Emitted when the `PriceConfig.price` is set in state for a specific `domainHash`
+     * @notice Emitted when the `FixedPriceConfig.price` is set in state for a specific `domainHash`
      * @param domainHash The hash of the domain who sets the price for subdomains
      * @param newPrice The new price value set
     */
     event PriceSet(bytes32 indexed domainHash, uint256 indexed newPrice);
 
     /**
-     * @notice Emitted when the `PriceConfig.feePercentage` is set in state for a specific `domainHash`
+     * @notice Emitted when the `FixedPriceConfig.feePercentage` is set in state for a specific `domainHash`
      * @param domainHash The hash of the domain who sets the feePercentage for subdomains
      * @param feePercentage The new feePercentage value set
     */
     event FeePercentageSet(bytes32 indexed domainHash, uint256 indexed feePercentage);
 
-    struct PriceConfig {
+    struct FixedPriceConfig {
         uint256 price;
         uint256 feePercentage;
-        bool isSet;
     }
 
-    function initialize(address _accessController, address _registry) external;
-
-    function setPrice(bytes32 domainHash, uint256 _price) external;
-
-    function getPrice(
-        bytes32 parentHash,
-        string calldata label,
-        bool skipValidityCheck
-    ) external view returns (uint256);
-
-    function setFeePercentage(
-        bytes32 domainHash,
-        uint256 feePercentage
-    ) external;
-
-    function getFeeForPrice(
-        bytes32 parentHash,
-        uint256 price
-    ) external view returns (uint256);
-
-    function getPriceAndFee(
-        bytes32 parentHash,
-        string calldata label,
-        bool skipValidityCheck
-    ) external view returns (uint256 price, uint256 fee);
-
-    function setPriceConfig(
-        bytes32 domainHash,
-        PriceConfig calldata priceConfig
-    ) external;
+    function encodeConfig(
+        FixedPriceConfig memory config
+    ) external pure returns (bytes memory);
 
-    function setRegistry(address registry_) external;
+    function decodePriceConfig(
+        bytes memory priceConfig
+    ) external pure returns (FixedPriceConfig memory);
 }

contracts/types/IZNSPricer.sol → contracts/price/IZNSPricer.sol

@@ -8,27 +8,16 @@ pragma solidity 0.8.26;
  */
 interface IZNSPricer {
     /**
-     * @notice Reverted when someone is trying to buy a subdomain under a parent that is not set up for distribution.
-     * Specifically it's prices for subdomains.
+     * @notice Emitted when the given price config is not the expected length
      */
-    error ParentPriceConfigNotSet(bytes32 parentHash);
+    error IncorrectPriceConfigLength();
 
     /**
      * @notice Reverted when domain owner is trying to set it's stake fee percentage
      * higher than 100% (uint256 "10,000").
      */
     error FeePercentageValueTooLarge(uint256 feePercentage, uint256 maximum);
 
-    /**
-     * @notice Reverted when `maxLength` smaller than `baseLength`.
-     */
-    error MaxLengthSmallerThanBaseLength(bytes32 domainHash);
-
-    /**
-     * @notice Reverted when `curveMultiplier` AND `baseLength` are 0.
-     */
-    error DivisionByZero(bytes32 domainHash);
-
     /**
      * @dev `parentHash` param is here to allow pricer contracts
      *  to have different price configs for different subdomains
@@ -41,28 +30,36 @@ interface IZNSPricer {
      * possible to register.
      */
     function getPrice(
-        bytes32 parentHash,
+        bytes memory parentPriceConfig,
         string calldata label,
         bool skipValidityCheck
-    ) external view returns (uint256);
+    ) external pure returns (uint256);
 
     /**
      * @dev Fees are only supported for PaymentType.STAKE !
      *  This function will NOT be called if PaymentType != PaymentType.STAKE
      *  Instead `getPrice()` will be called.
      */
     function getPriceAndFee(
-        bytes32 parentHash,
+        bytes memory parentPriceConfig,
         string calldata label,
         bool skipValidityCheck
-    ) external view returns (uint256 price, uint256 fee);
+    ) external pure returns (uint256 price, uint256 fee);
 
     /**
      * @notice Returns the fee for a given price.
      * @dev Fees are only supported for PaymentType.STAKE !
      */
     function getFeeForPrice(
-        bytes32 parentHash,
+        bytes memory parentPriceConfig,
         uint256 price
-    ) external view returns (uint256);
+    ) external pure returns (uint256);
+
+    /**
+     * @notice Validate a given price config
+     * @param priceConfig The price config to validate
+     */
+    function validatePriceConfig(
+        bytes memory priceConfig
+    ) external pure;
 }