refactor: initializers and add token name and symbol to the parameters library (#36)

* refactor: initializers

* style: remove unused import

* fix: typo in workflow

Author: heueristik

.github/workflows/ci.yml

@@ -64,6 +64,10 @@ jobs:
         run: bunx --bun solhint --config .solhint.other.json 'script/**/*.sol'
         id: solhint-script
 
+      - name: Install Upgrades-core
+        run: |
+          bun install @openzeppelin/upgrades-core@latest
+
       - name: Run Forge clean
         run: forge clean
         id: clean

package.json

@@ -1,5 +1,6 @@
 {
   "dependencies": {
+    "@openzeppelin/upgrades-core": "^1.44.1",
     "solhint": "^5.0.5"
   }
-}
+}

src/XanV1.sol

@@ -237,17 +237,22 @@ contract XanV1 is IXanV1, Initializable, ERC20Upgradeable, ERC20BurnableUpgradea
         lockedBalance = _getProposedUpgrades().lockedBalances[from];
     }
 
+    /// @notice Initializes the XanV1 contract and inherited contracts.
+    /// @param initialMintRecipient The initial recipient of the minted tokens.
     // solhint-disable-next-line func-name-mixedcase
     function __XanV1_init(address initialMintRecipient) internal onlyInitializing {
+        // Initialize inherited contracts
         __Context_init_unchained();
-        __ERC20_init_unchained("Anoma Token", "Xan");
-        __ERC20Burnable_init();
+        __ERC20_init_unchained({name_: Parameters.NAME, symbol_: Parameters.SYMBOL});
+        __ERC20Burnable_init_unchained();
         __UUPSUpgradeable_init_unchained();
 
+        // Initialize the XanV1 contract
         __XanV1_init_unchained(initialMintRecipient);
     }
 
-    /// @custom:oz-upgrades-unsafe-allow missing-initializer-call
+    /// @notice Initializes the XanV1 contract.
+    /// @param initialMintRecipient The initial recipient of the minted tokens.
     // solhint-disable-next-line func-name-mixedcase
     function __XanV1_init_unchained(address initialMintRecipient) internal onlyInitializing {
         _mint(initialMintRecipient, Parameters.SUPPLY);

src/drafts/XanV2.sol

@@ -10,7 +10,7 @@ import {XanV1} from "../XanV1.sol";
 contract XanV2 is IXanV2, XanV1 {
     /// @notice The [ERC-7201](https://eips.ethereum.org/EIPS/eip-7201) storage of the contract.
     /// @custom:storage-location erc7201:anoma.storage.Xan.v2
-    /// @param proposedUpgrades The upgrade proposed from a current implementation.
+    /// @param forwarder The forwarder being allowed to mint more tokens.
     struct XanV2Storage {
         address forwarder;
     }
@@ -28,6 +28,9 @@ contract XanV2 is IXanV2, XanV1 {
         _;
     }
 
+    /// @notice Initializes the proxy.
+    /// @param initialMintRecipient The initial recipient of the minted tokens.
+    /// @param xanV2Forwarder The XanV2 forwarder contract.
     /// @custom:oz-upgrades-validate-as-initializer
     // solhint-disable-next-line comprehensive-interface
     function initialize(address initialMintRecipient, address xanV2Forwarder) external reinitializer(2) {
@@ -39,6 +42,7 @@ contract XanV2 is IXanV2, XanV1 {
     /// @custom:oz-upgrades-validate-as-initializer
     // solhint-disable-next-line comprehensive-interface
     function initializeV2(address xanV2Forwarder) external reinitializer(2) {
+        // Initialize the XanV2 contract
         __XanV2_init({xanV2Forwarder: xanV2Forwarder});
     }
 
@@ -52,13 +56,16 @@ contract XanV2 is IXanV2, XanV1 {
         addr = _getXanV2Storage().forwarder;
     }
 
+    /// @notice Initializes the XanV2 contract and newly inherited contracts.
+    /// @param xanV2Forwarder The XanV2 forwarder contract.
     /// @custom:oz-upgrades-unsafe-allow missing-initializer-call
     // solhint-disable-next-line func-name-mixedcase
     function __XanV2_init(address xanV2Forwarder) internal onlyInitializing {
         __XanV2_init_unchained({xanV2Forwarder: xanV2Forwarder});
     }
 
-    /// @custom:oz-upgrades-unsafe-allow missing-initializer-call
+    /// @notice Initializes the XanV2 contract.
+    /// @param xanV2Forwarder The XanV2 forwarder contract.
     // solhint-disable-next-line func-name-mixedcase
     function __XanV2_init_unchained(address xanV2Forwarder) internal onlyInitializing {
         _getXanV2Storage().forwarder = xanV2Forwarder;

src/libs/Parameters.sol

@@ -2,6 +2,12 @@
 pragma solidity ^0.8.30;
 
 library Parameters {
+    /// @notice The name of the token.
+    string internal constant NAME = "Anoma";
+
+    /// @notice The symbol of the token.
+    string internal constant SYMBOL = "XAN";
+
     /// @notice The total supply amounting to 1 bn (10^9) tokens with 18 decimals.
     uint256 internal constant SUPPLY = 10 ** (9 + 18);