[Multi ZNS] Multi zNS Prototype [WIP]

.env.sample

@@ -37,7 +37,7 @@ MOCK_Z_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
+# Environment variables to create an entirely custom config for CurvePricer when `env_level` above is not dev
 MAX_PRICE=
 MIN_PRICE=
 MAX_LENGTH=
@@ -65,10 +65,19 @@ ADMIN_ADDRESSES=
 MONITOR_CONTRACTS="false"
 VERIFY_CONTRACTS="false"
 
-DEFENDER_KEY=
-DEFENDER_SECRET=
-RELAYER_KEY=
-RELAYER_SECRET=
+# Data for Cross-Chain contract deployment
+# Common data for both L1 and L2. Needs to be reset for EVERY deploy to every network !!!
+SRC_CHAIN_NAME= # Has to match one of the networks in `SupportedChains` enum in `get-portal-dm.ts`
+MOCK_ZKEVM_BRIDGE= # "true" | "false" to make Campaign deploy a Mocked version of the bridge for local testing
+ZK_EVM_BRIDGE= # HAS to be provided if MOCK_ZKEVM_BRIDGE is set to "false", this would use actual Bridge from the chain
+NETWORK_ID= # (For the Mocked Bridge) Network ID withing Polygon ZkEVM of the current chain we are deploying to
+BRIDGE_TOKEN= # (For the Mocked Bridge) Address of the Bridge Token on the current chain we are deploying to
+# Data for L1/Ethereum ZNS
+DEST_NETWORK_ID= # Network ID withing Polygon ZkEVM of the destination chain (ZChain) where the other ZNS lies
+DEST_CHAIN_NAME= # Has to match one of the networks in `SupportedChains` enum in `get-portal-dm.ts`
+DEST_CHAIN_ID= # Chain ID of the destination chain (ZChain) where the other ZNS lies
+# Data for L2/ZChain ZNS
+SRC_ZNS_PORTAL= # Address of the ZNS Portal on the source chain (Ethereum ZNS)
 
 # Tenderly
 # this is your key to access Tenderly Zer0 Org

.eslintrc

@@ -15,4 +15,4 @@
       }
     }
   ]
-}
+}

.gitignore

@@ -1,26 +1,29 @@
-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
+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
+
+# Local tests and ops
+test-data

contracts/access/IZNSAccessController.sol

@@ -1,29 +1,33 @@
-// SPDX-License-Identifier: MIT
-pragma solidity 0.8.26;
-
-import { IAccessControl } from "@openzeppelin/contracts/access/IAccessControl.sol";
-
-
-interface IZNSAccessController is IAccessControl {
-    function setRoleAdmin(bytes32 role, bytes32 adminRole) external;
-
-    function checkGovernor(address account) external view;
-
-    function checkAdmin(address account) external view;
-
-    function checkExecutor(address account) external view;
-
-    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);
-}
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.26;
+
+import { IAccessControl } from "@openzeppelin/contracts/access/IAccessControl.sol";
+
+
+interface IZNSAccessController is IAccessControl {
+    function setRoleAdmin(bytes32 role, bytes32 adminRole) external;
+
+    function checkGovernor(address account) external view;
+
+    function checkAdmin(address account) external view;
+
+    function checkExecutor(address account) external view;
+
+    function checkRegistrar(address account) external view;
+
+    function checkPortal(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 isPortal(address account) external view returns (bool);
+
+    function isExecutor(address account) external view returns (bool);
+}

contracts/access/ZNSAccessController.sol

@@ -1,96 +1,107 @@
-// SPDX-License-Identifier: MIT
-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";
-
-
-/**
- * @title The main module for system-wide Access Control.
- * @dev ZNS Business Logic Contract access to this module is outlined in `AAccessControlled.sol`.
- * Uses a role-based access control scheme with levels:
- * - GOVERNOR: The highest rank, assigns Admins, new roles and Role Admins
- * - ADMIN: The main maintainer role, that gets access to all system functions (managed by Governor)
- * - EXECUTOR: Can be here to future proof, if we need a new role (managed by Governor)
- * - REGISTRAR: This role is here specifically for the ZNSRootRegistrar.sol contract (managed by Admin)
- *
- * > This contract is NOT proxied. When new implementation is needed, a new contract will be deployed
- * and all modules will be updated to use the new address, since they all inherit from `AAccessControlled.sol`.
- */
-contract ZNSAccessController is AccessControl, ZNSRoles, IZNSAccessController {
-    constructor(
-        address[] memory governorAddresses,
-        address[] memory adminAddresses
-    ) {
-        // give roles to all addresses
-        _grantRoleToMany(GOVERNOR_ROLE, governorAddresses);
-        _grantRoleToMany(ADMIN_ROLE, adminAddresses);
-
-        // all of the governors control admins
-        _setRoleAdmin(ADMIN_ROLE, GOVERNOR_ROLE);
-        // all of the governors control governors
-        _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 **
-    // "check...()" functions revert with a specific message
-    function checkGovernor(address account) external view override {
-        _checkRole(GOVERNOR_ROLE, account);
-    }
-
-    function checkAdmin(address account) external view override {
-        _checkRole(ADMIN_ROLE, account);
-    }
-
-    function checkExecutor(address account) external view override {
-        _checkRole(EXECUTOR_ROLE, account);
-    }
-
-    function checkRegistrar(address account) external view override {
-        _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);
-    }
-
-    function isRegistrar(address account) external view override returns (bool) {
-        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);
-    }
-
-    function isExecutor(address account) external view override returns (bool) {
-        return hasRole(EXECUTOR_ROLE, account);
-    }
-
-    function setRoleAdmin(bytes32 role, bytes32 adminRole) external override onlyRole(GOVERNOR_ROLE) {
-        _setRoleAdmin(role, adminRole);
-    }
-
-    function _grantRoleToMany(bytes32 role, address[] memory addresses) internal {
-        uint256 length = addresses.length;
-        for (uint256 i = 0; i < length; ++i) {
-            if (addresses[i] == address(0)) revert ZeroAddressPassed();
-
-            _grantRole(role, addresses[i]);
-        }
-    }
-}
+// SPDX-License-Identifier: MIT
+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";
+
+
+/**
+ * @title The main module for system-wide Access Control.
+ * @dev ZNS Business Logic Contract access to this module is outlined in `AAccessControlled.sol`.
+ * Uses a role-based access control scheme with levels:
+ * - GOVERNOR: The highest rank, assigns Admins, new roles and Role Admins
+ * - ADMIN: The main maintainer role, that gets access to all system functions (managed by Governor)
+ * - EXECUTOR: Can be here to future proof, if we need a new role (managed by Governor)
+ * - REGISTRAR: This role is here specifically for the ZNSRootRegistrar.sol contract (managed by Admin)
+ * - PORTAL: Role for cross-chain Portal contracts that call certain functions on ZNS contracts (managed by Admin)
+ *
+ * > This contract is NOT proxied. When new implementation is needed, a new contract will be deployed
+ * and all modules will be updated to use the new address, since they all inherit from `AAccessControlled.sol`.
+ */
+contract ZNSAccessController is AccessControl, ZNSRoles, IZNSAccessController {
+    constructor(
+        address[] memory governorAddresses,
+        address[] memory adminAddresses
+    ) {
+        // give roles to all addresses
+        _grantRoleToMany(GOVERNOR_ROLE, governorAddresses);
+        _grantRoleToMany(ADMIN_ROLE, adminAddresses);
+
+        // all of the governors control admins
+        _setRoleAdmin(ADMIN_ROLE, GOVERNOR_ROLE);
+        // all of the governors control governors
+        _setRoleAdmin(GOVERNOR_ROLE, GOVERNOR_ROLE);
+        // all of the admins control registrar
+        _setRoleAdmin(REGISTRAR_ROLE, ADMIN_ROLE);
+        // all of the admins control portals
+        _setRoleAdmin(PORTAL_ROLE, ADMIN_ROLE);
+        // all of the admins control domain token
+        _setRoleAdmin(DOMAIN_TOKEN_ROLE, ADMIN_ROLE);
+    }
+
+    // ** Access Validators **
+    // "check...()" functions revert with a specific message
+    function checkGovernor(address account) external view override {
+        _checkRole(GOVERNOR_ROLE, account);
+    }
+
+    function checkAdmin(address account) external view override {
+        _checkRole(ADMIN_ROLE, account);
+    }
+
+    function checkExecutor(address account) external view override {
+        _checkRole(EXECUTOR_ROLE, account);
+    }
+
+    function checkRegistrar(address account) external view override {
+        _checkRole(REGISTRAR_ROLE, account);
+    }
+
+    function checkDomainToken(address account) external view override {
+        _checkRole(DOMAIN_TOKEN_ROLE, account);
+    }
+
+    function checkPortal(address account) external view override {
+        _checkRole(PORTAL_ROLE, account);
+    }
+
+    // "is...()" functions return a boolean
+    function isAdmin(address account) external view override returns (bool) {
+        return hasRole(ADMIN_ROLE, account);
+    }
+
+    function isRegistrar(address account) external view override returns (bool) {
+        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);
+    }
+
+    function isPortal(address account) external view override returns (bool) {
+        return hasRole(PORTAL_ROLE, account);
+    }
+
+    function isExecutor(address account) external view override returns (bool) {
+        return hasRole(EXECUTOR_ROLE, account);
+    }
+
+    function setRoleAdmin(bytes32 role, bytes32 adminRole) external override onlyRole(GOVERNOR_ROLE) {
+        _setRoleAdmin(role, adminRole);
+    }
+
+    function _grantRoleToMany(bytes32 role, address[] memory addresses) internal {
+        uint256 length = addresses.length;
+        for (uint256 i = 0; i < length; ++i) {
+            if (addresses[i] == address(0)) revert ZeroAddressPassed();
+
+            _grantRole(role, addresses[i]);
+        }
+    }
+}