[MULTI ZNS] MAIN

.circleci/config.yml

@@ -1,13 +1,13 @@
 version: 2.1
 
 orbs:
-  node: circleci/node@4.7.0
+  node: circleci/node@6.1.0
   codecov: codecov/[email protected]
 
 defaults: &defaults
   working_directory: ~/repo
   docker:
-    - image: cimg/node:18.15.0
+    - image: cimg/node:20.17.0
     - image: mongo:7.0.0-rc5-jammy
 
 jobs:

.env.sample

@@ -32,9 +32,9 @@ SILENT_LOGGER="false" | "true"
 # Boolean value for if we deploy the mock
 # true = we deploy the mock
 # false = we use a hard coded address and pull data from chain
-MOCK_MEOW_TOKEN=
-# Address of the MEOW Token deployed to the network PRIOR to running Campaign or any other EXISTING token
-# This is only used if MOCK_MEOW_TOKEN is set to false (`test` and `prod` environments)
+MOCK_Z_TOKEN=
+# Address of the Z Token deployed to the network PRIOR to running Campaign or any other EXISTING token
+# This is only used if MOCK_Z_TOKEN is set to false (`test` and `prod` environments)
 STAKING_TOKEN_ADDRESS=
 
 # Environment variables to create an entirely custom config when `env_level` above is not dev

.eslintrc

@@ -5,6 +5,7 @@
       "files": ["src/**/*.ts", "test/**/*.ts", "./*.ts"],
       "extends": ["@zero-tech/eslint-config-cpt/node-ts/.eslintrc.json"],
       "rules": {
+		"jsdoc/newline-after-description": "off",
         "no-unused-expressions": "off",
         "no-console": "off",
         "no-shadow": "warn",

.gitignore

@@ -1,22 +1,26 @@
-node_modules
-.env
-coverage
-coverage.json
-typechain
-typechain-types
-.idea
-dist
-
-# Hardhat files
-cache
-artifacts
-
-# hardhat-tenderly plugin
-deployments
-
-*.env
-docker
-docker*.tgz
-
-# We don't ever use the generated manifests
-.openzeppelin
+node_modules
+.env
+coverage
+coverage.json
+typechain
+typechain-types
+.idea
+dist
+
+# Hardhat files
+cache
+artifacts
+
+# hardhat-tenderly plugin
+deployments
+
+*.env
+docker
+docker*.tgz
+
+# We don't ever use the generated manifests
+.openzeppelin
+/.vscode
+
+# Don't source control log files from deployment
+deploy-*.log

.solcover.js

@@ -1,4 +1,8 @@
 module.exports = {
+  mocha: {
+    grep: "@skip-on-coverage", // Find everything with this tag
+    invert: true               // Run the grep's inverse set.
+  },
   skipFiles: [
     'utils/StringUtils.sol',
     'token/mocks',

README.md

@@ -34,7 +34,7 @@ Create `.env` file in the root directory and add the following variables:
 ENV_LEVEL: "dev" # local dev environment
 MONGO_DB_URI: "mongodb://localhost:27018" # local instance of MongoDB in the Docker
 MONGO_DB_NAME: "zns-campaign" # name of the database
-MOCK_MEOW_TOKEN: "true" # use mock MeowToken contract for local testing
+MOCK_Z_TOKEN: "true" # use mock ZToken contract for local testing
 SILENT_LOGGER: "true" # disable logging for tests
 ```
 

contracts/access/AAccessControlled.sol

@@ -1,7 +1,8 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.18;
+pragma solidity 0.8.26;
 
 import { IZNSAccessController } from "./IZNSAccessController.sol";
+import { ZeroAddressPassed } from "../utils/CommonErrors.sol";
 
 
 /**
@@ -11,7 +12,6 @@ import { IZNSAccessController } from "./IZNSAccessController.sol";
  * this contract needs to be inherited by the module.
  */
 abstract contract AAccessControlled {
-
     /**
      * @notice Emitted when the access controller contract address is set.
      */
@@ -66,7 +66,7 @@ abstract contract AAccessControlled {
      * @param _accessController Address of the ZNSAccessController contract.
      */
     function _setAccessController(address _accessController) internal {
-        require(_accessController != address(0), "AC: _accessController is 0x0 address");
+        if (_accessController == address(0)) revert ZeroAddressPassed();
         accessController = IZNSAccessController(_accessController);
         emit AccessControllerSet(_accessController);
     }

contracts/access/IZNSAccessController.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.18;
+pragma solidity 0.8.26;
 
 import { IAccessControl } from "@openzeppelin/contracts/access/IAccessControl.sol";
 
@@ -15,10 +15,14 @@ interface IZNSAccessController is IAccessControl {
 
     function checkRegistrar(address account) external view;
 
+    function checkDomainToken(address account) external view;
+
     function isAdmin(address account) external view returns (bool);
 
     function isRegistrar(address account) external view returns (bool);
 
+    function isDomainToken(address account) external view returns (bool);
+
     function isGovernor(address account) external view returns (bool);
 
     function isExecutor(address account) external view returns (bool);

contracts/access/ZNSAccessController.sol

@@ -1,9 +1,10 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.18;
+pragma solidity 0.8.26;
 
 import { AccessControl } from "@openzeppelin/contracts/access/AccessControl.sol";
 import { IZNSAccessController } from "./IZNSAccessController.sol";
 import { ZNSRoles } from "./ZNSRoles.sol";
+import { ZeroAddressPassed } from "../utils/CommonErrors.sol";
 
 
 /**
@@ -33,6 +34,8 @@ contract ZNSAccessController is AccessControl, ZNSRoles, IZNSAccessController {
         _setRoleAdmin(GOVERNOR_ROLE, GOVERNOR_ROLE);
         // all of the admins control registrar
         _setRoleAdmin(REGISTRAR_ROLE, ADMIN_ROLE);
+        // all of the admins control domain token
+        _setRoleAdmin(DOMAIN_TOKEN_ROLE, ADMIN_ROLE);
     }
 
     // ** Access Validators **
@@ -53,6 +56,10 @@ contract ZNSAccessController is AccessControl, ZNSRoles, IZNSAccessController {
         _checkRole(REGISTRAR_ROLE, account);
     }
 
+    function checkDomainToken(address account) external view override {
+        _checkRole(DOMAIN_TOKEN_ROLE, account);
+    }
+
     // "is...()" functions return a boolean
     function isAdmin(address account) external view override returns (bool) {
         return hasRole(ADMIN_ROLE, account);
@@ -62,6 +69,10 @@ contract ZNSAccessController is AccessControl, ZNSRoles, IZNSAccessController {
         return hasRole(REGISTRAR_ROLE, account);
     }
 
+    function isDomainToken(address account) external view override returns (bool) {
+        return hasRole(DOMAIN_TOKEN_ROLE, account);
+    }
+
     function isGovernor(address account) external view override returns (bool) {
         return hasRole(GOVERNOR_ROLE, account);
     }
@@ -77,10 +88,8 @@ contract ZNSAccessController is AccessControl, ZNSRoles, IZNSAccessController {
     function _grantRoleToMany(bytes32 role, address[] memory addresses) internal {
         uint256 length = addresses.length;
         for (uint256 i = 0; i < length; ++i) {
-            require(
-                addresses[i] != address(0),
-                "ZNSAccessController: Can't grant role to zero address"
-            );
+            if (addresses[i] == address(0)) revert ZeroAddressPassed();
+
             _grantRole(role, addresses[i]);
         }
     }

contracts/access/ZNSRoles.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.18;
+pragma solidity 0.8.26;
 
 
 /**
@@ -22,6 +22,11 @@ abstract contract ZNSRoles {
      */
     bytes32 public constant REGISTRAR_ROLE = keccak256("REGISTRAR_ROLE");
 
+    /**
+     * @notice This role is here specifically for the ZNSDomainToken.sol contract
+     */
+    bytes32 public constant DOMAIN_TOKEN_ROLE = keccak256("DOMAIN_TOKEN_ROLE");
+
     /**
      * @notice Executor can be here to future proof, if we need a new role
      * so we don't have to upgrade all contracts

contracts/oz-proxies/ERC1967ProxyAcc.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.18;
+pragma solidity 0.8.26;
 
 // solhint-disable-next-line no-global-import
 import "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";

contracts/oz-proxies/TransparentUpgradeableProxyAcc.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.18;
+pragma solidity 0.8.26;
 
 // solhint-disable-next-line no-global-import
 import "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";

contracts/price/IZNSCurvePricer.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.18;
+pragma solidity 0.8.26;
 
 import { ICurvePriceConfig } from "../types/ICurvePriceConfig.sol";
 import { IZNSPricer } from "../types/IZNSPricer.sol";
@@ -8,16 +8,16 @@ import { IZNSPricer } from "../types/IZNSPricer.sol";
 interface IZNSCurvePricer is ICurvePriceConfig, IZNSPricer {
 
     /**
-     * @notice Emitted when the `maxPrice` is set in `CurvePriceConfig`
-     * @param price The new maxPrice value
+     * @notice Reverted when multiplier passed by the domain owner
+     * is equal to 0 or more than 10^18, which is too large.
      */
-    event MaxPriceSet(bytes32 domainHash, uint256 price);
+    error InvalidPrecisionMultiplierPassed(bytes32 domainHash);
 
     /**
-     * @notice Emitted when the `minPrice` is set in `CurvePriceConfig`
-     * @param price The new minPrice value
+     * @notice Emitted when the `maxPrice` is set in `CurvePriceConfig`
+     * @param price The new maxPrice value
      */
-    event MinPriceSet(bytes32 domainHash, uint256 price);
+    event MaxPriceSet(bytes32 domainHash, uint256 price);
 
     /**
      * @notice Emitted when the `baseLength` is set in `CurvePriceConfig`
@@ -43,18 +43,25 @@ interface IZNSCurvePricer is ICurvePriceConfig, IZNSPricer {
      */
     event FeePercentageSet(bytes32 domainHash, uint256 feePercentage);
 
+    /**
+     * @notice Emitted when the `curveMultiplier` is set in state
+     * @param curveMultiplier The new curveMultiplier value
+     */
+    event CurveMultiplierSet(bytes32 domainHash, uint256 curveMultiplier);
+
+
     /**
      * @notice Emitted when the full `CurvePriceConfig` is set in state
      * @param maxPrice The new `maxPrice` value
-     * @param minPrice The new `minPrice` 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
      */
     event PriceConfigSet(
         bytes32 domainHash,
         uint256 maxPrice,
-        uint256 minPrice,
+        uint256 curveMultiplier,
         uint256 maxLength,
         uint256 baseLength,
         uint256 precisionMultiplier,
@@ -94,12 +101,12 @@ interface IZNSCurvePricer is ICurvePriceConfig, IZNSPricer {
 
     function setMaxPrice(bytes32 domainHash, uint256 maxPrice) external;
 
-    function setMinPrice(bytes32 domainHash, uint256 minPrice) external;
-
     function setBaseLength(bytes32 domainHash, uint256 length) external;
 
     function setMaxLength(bytes32 domainHash, uint256 length) external;
 
+    function setCurveMultiplier(bytes32 domainHash, uint256 curveMultiplier) external;
+
     function setPrecisionMultiplier(bytes32 domainHash, uint256 multiplier) external;
 
     function setFeePercentage(bytes32 domainHash, uint256 feePercentage) external;

contracts/price/IZNSFixedPricer.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.18;
+pragma solidity 0.8.26;
 
 import { IZNSPricer } from "../types/IZNSPricer.sol";