fix: ZDC integration of upgrade functionality

.circleci/config.yml

@@ -7,7 +7,7 @@ orbs:
 defaults: &defaults
   working_directory: ~/repo
   docker:
-    - image: cimg/node:18.15.0
+    - image: cimg/node:18.20.3
     - image: mongo:7.0.0-rc5-jammy
 
 jobs:

.eslintrc

@@ -9,9 +9,10 @@
         "no-console": "off",
         "no-shadow": "warn",
         "@typescript-eslint/no-shadow": "warn",
-        "no-invalid-this": "off"
+        "no-invalid-this": "off",
+        "jsdoc/newline-after-description": "off"
         // "@typescript-eslint/no-unused-vars": "off" // For debugging
       }
     }
   ]
-}
+}

.gitignore

@@ -5,6 +5,7 @@ coverage.json
 typechain
 typechain-types
 .idea
+dist
 
 # Hardhat files
 cache

.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

@@ -2,8 +2,70 @@
 
 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/zer0-os/zNS/tree/development.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/zer0-os/zNS/tree/development)
 
-# zNS
+# zNS - Zer0 Name Service Protocol
+________________________________________________________
+
+## System Documentation
 
 ### [System Architecture](./docs/architecture.md)
 ### [Smart Contract Docs](./docs/contracts)
-### [Flow Diagrams](./docs/flows.md)
+### [Flow Diagrams](./docs/flows.md)
+
+**Full Protocol Documentation - [zero.study](https://www.zero.study/)**
+________________________________________________________
+
+## About
+Zer0 Name Service, or zNS, is a protocol that allows you to create domain and subdomain NFTs that focus on community building and creation of unique, on-chain identification.
+
+Zero Website - [zero.tech](https://zero.tech/)
+
+## Developers
+
+### Install Dependencies
+We are using `yarn` as our package manager.
+```bash
+yarn install
+```
+> **Docker Engine** is required to run tests locally. You can install it from [here](https://docs.docker.com/engine/install/).
+
+### Setup Environment
+Create `.env` file in the root directory and add the following variables:
+```bash
+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
+SILENT_LOGGER: "true" # disable logging for tests
+```
+
+The full ENV setup with descriptions can be found in the [.env.sample](./.env.sample) file.
+
+### Build
+```bash
+yarn build
+```
+This will compile all the contracts and add a git tag and a last commit for the current version of the contracts
+that is **required** for the MongoDB where deployed contract data is stored.
+
+This will also run a bash script that will pull **tag and commit** from git and write
+it locally to `./artifacts/git-tag.txt` file. If you are using Windows, that script may fail. In that case you can
+pull git data manually and write it to the file or use the TS based script here: `./src/utils/save-tag.ts` simply by running `yarn save-tag`
+The resulting text in the `./artifacts/git-tag.txt` file should look like this:
+```
+v1.0.1:213334f3d4f47940779cb7e825aaf1fab77adb2e
+```
+
+### Run Tests
+```bash
+yarn test
+```
+This will launch `docker-compose` with MongoDB instance on it, required for some tests. Then launch all the tests in the `./test` directory.
+
+> Note: If you do not have Docker installed this will fail.
+
+### Submit Work
+All new code is submitted through Pull Requests **ONLY**. Please make sure that you have all the tests passing in CircleCI and that
+you have added new tests for your code before submitting for review. Codecov will fail the CI if the coverage drops. Pull Requests are not merged with a failing CI build.
+
+All new code is merged into `development` branch and that will make a new prerelease tag.
+`master` branch is used for production releases only. Code from `development` branch should be fully tested on the testnet before merging into `master`.

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";
 

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";
 
 
 /**
@@ -77,10 +78,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;
 
 
 /**

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,12 +1,29 @@
 // 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";
 
 
 interface IZNSCurvePricer is ICurvePriceConfig, IZNSPricer {
 
+    /**
+     * @notice Reverted when multiplier passed by the domain owner
+     * is equal to 0 or more than 10^18, which is too large.
+     */
+    error InvalidMultiplierPassed(uint256 multiplier);
+
+    /**
+     * @notice Reverted when `priceConfig` set by the owner does not result in a proper asymptotic curve
+     * and one of it's incorrect values causes the price spike at maxLength, meaning that the price
+     * for a domain label shorter than `baseLength` (the one before `minPrice`) becomes higher than `minPrice`.
+     */
+    error InvalidConfigCausingPriceSpikes(
+        bytes32 configsDomainHash,
+        uint256 minPrice,
+        uint256 previousToMinPrice
+    );
+
     /**
      * @notice Emitted when the `maxPrice` is set in `CurvePriceConfig`
      * @param price The new maxPrice value

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";
 

contracts/price/ZNSCurvePricer.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.18;
+pragma solidity 0.8.26;
 
 import { UUPSUpgradeable } from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
 import { IZNSCurvePricer } from "./IZNSCurvePricer.sol";
@@ -75,10 +75,7 @@ contract ZNSCurvePricer is AAccessControlled, ARegistryWired, UUPSUpgradeable, I
         string calldata label,
         bool skipValidityCheck
     ) public view override returns (uint256) {
-        require(
-            priceConfigs[parentHash].isSet,
-            "ZNSCurvePricer: parent's price config has not been set properly through IZNSPricer.setPriceConfig()"
-        );
+        if (!priceConfigs[parentHash].isSet) revert ParentPriceConfigNotSet(parentHash);
 
         if (!skipValidityCheck) {
             // Confirms string values are only [a-z0-9-]
@@ -256,8 +253,8 @@ contract ZNSCurvePricer is AAccessControlled, ARegistryWired, UUPSUpgradeable, I
         bytes32 domainHash,
         uint256 multiplier
     ) public override onlyOwnerOrOperator(domainHash) {
-        require(multiplier != 0, "ZNSCurvePricer: precisionMultiplier cannot be 0");
-        require(multiplier <= 10**18, "ZNSCurvePricer: precisionMultiplier cannot be greater than 10^18");
+        if (multiplier == 0 || multiplier > 10**18) revert InvalidMultiplierPassed(multiplier);
+
         priceConfigs[domainHash].precisionMultiplier = multiplier;
 
         emit PrecisionMultiplierSet(domainHash, multiplier);
@@ -275,10 +272,8 @@ contract ZNSCurvePricer is AAccessControlled, ARegistryWired, UUPSUpgradeable, I
     public
     override
     onlyOwnerOrOperator(domainHash) {
-        require(
-            feePercentage <= PERCENTAGE_BASIS,
-            "ZNSCurvePricer: feePercentage cannot be greater than PERCENTAGE_BASIS"
-        );
+        if (feePercentage > PERCENTAGE_BASIS)
+            revert FeePercentageValueTooLarge(feePercentage, PERCENTAGE_BASIS);
 
         priceConfigs[domainHash].feePercentage = feePercentage;
         emit FeePercentageSet(domainHash, feePercentage);
@@ -337,10 +332,12 @@ contract ZNSCurvePricer is AAccessControlled, ARegistryWired, UUPSUpgradeable, I
      */
     function _validateConfig(bytes32 domainHash) internal view {
         uint256 prevToMinPrice = _getPrice(domainHash, priceConfigs[domainHash].maxLength);
-        require(
-            priceConfigs[domainHash].minPrice <= prevToMinPrice,
-            "ZNSCurvePricer: incorrect value set causes the price spike at maxLength."
-        );
+        if (priceConfigs[domainHash].minPrice > prevToMinPrice)
+            revert InvalidConfigCausingPriceSpikes(
+                domainHash,
+                priceConfigs[domainHash].minPrice,
+                prevToMinPrice
+            );
     }
 
     /**

contracts/price/ZNSFixedPricer.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.18;
+pragma solidity 0.8.26;
 
 import { AAccessControlled } from "../access/AAccessControlled.sol";
 import { ARegistryWired } from "../registry/ARegistryWired.sol";
@@ -60,10 +60,7 @@ contract ZNSFixedPricer is AAccessControlled, ARegistryWired, UUPSUpgradeable, I
         string calldata label,
         bool skipValidityCheck
     ) public override view returns (uint256) {
-        require(
-            priceConfigs[parentHash].isSet,
-            "ZNSFixedPricer: parent's price config has not been set properly through IZNSPricer.setPriceConfig()"
-        );
+        if (!priceConfigs[parentHash].isSet) revert ParentPriceConfigNotSet(parentHash);
 
         if (!skipValidityCheck) {
             // Confirms string values are only [a-z0-9-]
@@ -161,10 +158,8 @@ contract ZNSFixedPricer is AAccessControlled, ARegistryWired, UUPSUpgradeable, I
      * @param feePercentage The new feePercentage
      */
     function _setFeePercentage(bytes32 domainHash, uint256 feePercentage) internal {
-        require(
-            feePercentage <= PERCENTAGE_BASIS,
-            "ZNSFixedPricer: feePercentage cannot be greater than PERCENTAGE_BASIS"
-        );
+        if (feePercentage > PERCENTAGE_BASIS)
+            revert FeePercentageValueTooLarge(feePercentage, PERCENTAGE_BASIS);
 
         priceConfigs[domainHash].feePercentage = feePercentage;
         emit FeePercentageSet(domainHash, feePercentage);

contracts/registrar/IZNSRootRegistrar.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.18;
+pragma solidity 0.8.26;
 
 import { IDistributionConfig } from "../types/IDistributionConfig.sol";
 import { PaymentConfig } from "../treasury/IZNSTreasury.sol";
@@ -42,13 +42,19 @@ struct CoreRegisterArgs {
  *      + `isStakePayment`: A flag for whether the payment is a stake payment or not
  */
 interface IZNSRootRegistrar is IDistributionConfig {
+    error NotTheOwnerOf(
+        OwnerOf ownerOf,
+        address candidate,
+        bytes32 domainHash
+    );
+
+    error InvalidOwnerOfEnumValue(OwnerOf value);
 
     enum OwnerOf {
         NAME,
         TOKEN,
         BOTH
     }
-
     /**
      * @notice Emitted when a NEW domain is registered.
      * @dev `domainAddress` parameter is the address to which a domain name will relate to in ZNS.