feat: port minter-burner role from v0.5.1

Author: ZeroEkkusu

src/etc/Versioned.sol

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: LicenseRef-PolygonLabs-Source-Available
-// Vault Bridge (last updated v1.1.0) (etc/Versioned.sol)
+// Vault Bridge (last updated v1.1.1) (etc/Versioned.sol)
 
 pragma solidity 0.8.29;
 
 /// @author See https://github.com/agglayer/vault-bridge
 abstract contract Versioned {
     /// @notice The version of the contract.
     function VAULT_BRIDGE_PROTOCOL() public pure returns (string memory) {
-        return "1.1.0";
+        return "1.1.1";
     }
 }

src/secondary-chain/CustomToken.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: LicenseRef-PolygonLabs-Source-Available
-// Vault Bridge (last updated v1.1.0) (secondary-chain/CustomToken.sol)
+// Vault Bridge (last updated v1.1.1) (secondary-chain/CustomToken.sol)
 
 pragma solidity 0.8.29;
 
@@ -38,6 +38,7 @@ abstract contract CustomToken is
         address bridge;
         address nativeConverter;
         uint256 _secondaryChainBalance;
+        mapping(address => uint256) _netMintedByAdditionalMintersBurners;
     }
 
     /// @dev The storage slot at which Custom Token storage starts, following the EIP-7201 standard.
@@ -48,6 +49,10 @@ abstract contract CustomToken is
     // Basic roles.
     // @remind Document.
     bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");
+    bytes32 public constant MINTER_BURNER_ROLE = keccak256("MINTER_BURNER_ROLE");
+
+    // Events.
+    event AlreadyMinted(uint256 indexed value);
 
     // Errors.
     error Unauthorized();
@@ -60,6 +65,45 @@ abstract contract CustomToken is
     error NativeConverterAlreadySet();
     error FunctionNotSupportedWithThisBridgeProvider();
 
+    // -----================= ::: MODIFIERS ::: =================-----
+
+    /// @dev Checks if the sender is The Bridge or Native Converter or an additional minter-burner.
+    /// @dev This modifier is used to restrict the minting of Custom Token.
+    modifier mintController(address account, uint256 value) {
+        CustomTokenStorage storage $ = _getCustomTokenStorage();
+
+        bool senderIsBridgeOrNativeConverter = msg.sender == $.bridge || msg.sender == $.nativeConverter;
+        bool senderIsAdditionalMinterBurner = hasRole(MINTER_BURNER_ROLE, msg.sender);
+
+        // Only The Bridge and Native Converter and additional minter-burners can mint Custom Token.
+        require(senderIsBridgeOrNativeConverter || senderIsAdditionalMinterBurner, Unauthorized());
+
+        _;
+
+        // If `account` is address zero, that means special logic will (or will not) be executed in the `mint` function.
+        if (account != address(0) && senderIsAdditionalMinterBurner && !senderIsBridgeOrNativeConverter) {
+            $._netMintedByAdditionalMintersBurners[msg.sender] += value;
+        }
+    }
+
+    /// @dev Checks if the sender is The Bridge or Native Converter or an additional minter-burner.
+    /// @dev This modifier is used to restrict the burning of Custom Token.
+    modifier burnController(uint256 value) {
+        CustomTokenStorage storage $ = _getCustomTokenStorage();
+
+        bool senderIsBridgeOrNativeConverter = msg.sender == $.bridge || msg.sender == $.nativeConverter;
+        bool senderIsAdditionalBurner = hasRole(MINTER_BURNER_ROLE, msg.sender);
+
+        // Only The Bridge and Native Converter and additional burners can burn Custom Token.
+        require(senderIsBridgeOrNativeConverter || senderIsAdditionalBurner, Unauthorized());
+
+        if (senderIsAdditionalBurner && !senderIsBridgeOrNativeConverter) {
+            $._netMintedByAdditionalMintersBurners[msg.sender] -= value;
+        }
+
+        _;
+    }
+
     // -----================= ::: SETUP ::: =================-----
 
     /// @dev Preserves the `name` and `symbol` of the bridged vbToken.

src/secondary-chain/agglayer/CustomTokenAgglayer.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: LicenseRef-PolygonLabs-Source-Available
-// Vault Bridge (last updated v1.0.0) (secondary-chain/agglayer/CustomTokenAgglayer.sol)
+// Vault Bridge (last updated v1.1.1) (secondary-chain/agglayer/CustomTokenAgglayer.sol)
 
 pragma solidity 0.8.29;
 
@@ -12,26 +12,10 @@ import {NativeConverter} from "../NativeConverter.sol";
 // @remind Document.
 /// @author See https://github.com/agglayer/vault-bridge
 abstract contract CustomTokenAgglayer is CustomToken {
-    // Events.
-    event AlreadyMinted(uint256 indexed value);
-
-    // -----================= ::: MODIFIERS ::: =================-----
-
-    /// @dev Checks if the sender is Agglayer Bridge or Native Converter.
-    /// @dev This modifier is used to restrict minting and burning of Custom Token.
-    modifier onlyAgglayerBridgeAndNativeConverter() {
-        // Only Agglayer Bridge and Native Converter can mint and burn Custom Token.
-        require(msg.sender == bridge() || msg.sender == nativeConverter(), Unauthorized());
-        _;
-    }
-
     // -----================= ::: CUSTOM TOKEN ::: =================-----
 
-    // @remind Redocument (the entire function).
-    /// @notice Mints Custom Tokens to the recipient.
-    /// @notice This function can be called by Agglayer Bridge and Native Converter only.
-    /// @param account @note CAUTION! Minting to `address(0)` will result in no tokens minted! This is to enable vbToken on Primary Chain to bridge tokens to address zero on Secondary Chain at the end of the process of migrating backing from Native Converter to Primary Chain. Please refer to `NativeConverter.sol` for more information.
-    function mint(address account, uint256 value) external onlyAgglayerBridgeAndNativeConverter nonReentrant {
+    /// @notice This function can be called by Agglayer Bridge, Native Converter, and additional minter-burners only.
+    function mint(address account, uint256 value) external whenNotPaused mintController(account, value) nonReentrant {
         if (msg.sender == bridge() && account == address(0)) {
             NativeConverter(nativeConverter()).removeMigrationInProgress(value);
 
@@ -42,18 +26,12 @@ abstract contract CustomTokenAgglayer is CustomToken {
 
         _requireNotPaused();
 
-        // Mint.
         _mint(account, value);
     }
 
     /// @notice Burns Custom Tokens from a holder.
-    /// @notice This function can be called by Agglayer Bridge and Native Converter only.
-    function burn(address account, uint256 value)
-        external
-        whenNotPaused
-        onlyAgglayerBridgeAndNativeConverter
-        nonReentrant
-    {
+    /// @notice This function can be called by Agglayer Bridge, Native Converter, and additional minter-burners only.
+    function burn(address account, uint256 value) external whenNotPaused burnController(value) nonReentrant {
         _burn(account, value);
     }
 

test/unit/secondary-chain/agglayer/GenericCustomTokenAgglayer.t.sol

@@ -50,7 +50,7 @@ contract GenericCustomTokenAgglayerTest is GenericCustomTokenAgglayerTestBase {
         uint256 amount = 1000e18;
 
         vm.expectEmit(true, true, true, true);
-        emit CustomTokenAgglayer.AlreadyMinted(amount);
+        emit CustomToken.AlreadyMinted(amount);
 
         vm.prank(address(mockAgglayerBridge));
         genericCustomTokenAgglayer.mint(address(0), amount);