deployer guard fix

Author: Arvolear

contracts/mock/utils/ERC20UpgradeableMock.sol

@@ -4,12 +4,12 @@ pragma solidity ^0.8.21;
 
 import {ERC20Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
 
-import {DeployerGuard} from "../../utils/DeployerGuard.sol";
+import {ADeployerGuard} from "../../utils/ADeployerGuard.sol";
 
-contract ERC20UpgradeableMock is DeployerGuard, ERC20Upgradeable {
+contract ERC20UpgradeableMock is ADeployerGuard, ERC20Upgradeable {
     uint8 internal _decimals;
 
-    constructor() DeployerGuard(msg.sender) {}
+    constructor() ADeployerGuard(msg.sender) {}
 
     function __ERC20UpgradeableMock_init(
         string memory name_,

contracts/utils/ABlockGuard.sol

@@ -10,7 +10,7 @@ pragma solidity ^0.8.21;
  * ## Usage example:
  *
  * ```
- * contract NotFlashloanable is BlockGuard {
+ * contract NotFlashloanable is ABlockGuard {
  *     function deposit(uint256 amount) external lockBlock("DEPOSIT", msg.sender) {
  *         . . .
  *     }

contracts/utils/DeployerGuard.sol renamed to contracts/utils/ADeployerGuard.sol

@@ -3,23 +3,40 @@ pragma solidity ^0.8.21;
 
 /**
  * @title DeployerGuard
- * @notice A utility contract that provides protected initialization capabilities for contracts
- * that depend on each other. This contract ensures that contracts are never left in an
- * unprotected state during deployment by allowing a second initialization phase that is
- * restricted to the deployer only.
+ * @notice A utility contract that provides protected initialization capabilities for other contracts.
+ *
+ * Generally speaking, the common "Initializer" approach is easily front-runnable and shouldn't be used on its own.
+ *
+ * This simple utility ensures that contracts are never left in an unprotected state during deployment by
+ * integrating a second validation step restricted to the deployer only.
+ *
+ * ## Usage example:
+ *
+ * ```
+ * contract ProtectedImpl is ADeployerGuard {
+ *     constructor() ADeployerGuard(msg.sender) {}
+ *
+ *     function __ERC20_init(
+ *         string memory name_,
+ *         string memory symbol_,
+ *     ) external initializer onlyDeployer {
+ *         __ERC20_init(name_, symbol_);
+ *     }
+ * }
+ * ```
  */
-contract DeployerGuard {
+abstract contract ADeployerGuard {
     /// @notice The address of the contract deployer
-    address private immutable __SOLARITY_GUARD_DEPLOYER;
+    address private immutable _GUARD_DEPLOYER;
 
     /// @notice Error thrown when a non-deployer address attempts to call deployer-only functions
     /// @param caller The address that attempted to call the function
     error OnlyDeployer(address caller);
 
     /**
      * @dev Modifier that restricts function access to the deployer only
-     * @notice This modifier should be used on second initialization functions
-     * to ensure only the original deployer can establish cross-contract references
+     * @notice This modifier should be used on the initialization functions
+     * to ensure their non-frontrunability
      */
     modifier onlyDeployer() {
         _requireDeployer(msg.sender);
@@ -30,7 +47,7 @@ contract DeployerGuard {
      * @dev Constructor that sets the deployer address
      */
     constructor(address deployer_) {
-        __SOLARITY_GUARD_DEPLOYER = deployer_;
+        _GUARD_DEPLOYER = deployer_;
     }
 
     /**
@@ -53,6 +70,6 @@ contract DeployerGuard {
      * @dev Internal function to get the deployer address
      */
     function _deployer() internal view virtual returns (address) {
-        return __SOLARITY_GUARD_DEPLOYER;
+        return _GUARD_DEPLOYER;
     }
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@solarity/solidity-lib",
-  "version": "3.1.5",
+  "version": "3.1.6",
   "license": "MIT",
   "author": "Distributed Lab",
   "readme": "README.md",