chore: update missing bridge on natspec

defi-wonderland · Sep 27, 2024 · 7f5c4e7 · 7f5c4e7
1 parent 2a22161
commit 7f5c4e7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/packages/contracts-bedrock/src/L2/OptimismSuperchainERC20.sol b/packages/contracts-bedrock/src/L2/OptimismSuperchainERC20.sol
@@ -52,8 +52,8 @@ contract OptimismSuperchainERC20 is ERC20, Initializable, ERC165, IOptimismSuper
     }
 
     /// @notice Semantic version.
-    /// @custom:semver 1.0.0-beta.3
-    string public constant version = "1.0.0-beta.3";
+    /// @custom:semver 1.0.0-beta.4
+    string public constant version = "1.0.0-beta.4";
 
     /// @notice Constructs the OptimismSuperchainERC20 contract.
     constructor() {
@@ -81,7 +81,7 @@ contract OptimismSuperchainERC20 is ERC20, Initializable, ERC165, IOptimismSuper
         _storage.decimals = _decimals;
     }
 
-    /// @notice Allows the L2StandardBridge to mint tokens.
+    /// @notice Allows the L2StandardBridge and SuperchainERC20Bridge bridges to mint tokens.
     /// @param _to     Address to mint tokens to.
     /// @param _amount Amount of tokens to mint.
     function mint(address _to, uint256 _amount) external virtual onlyAuthorizedBridge {
@@ -92,7 +92,7 @@ contract OptimismSuperchainERC20 is ERC20, Initializable, ERC165, IOptimismSuper
         emit Mint(_to, _amount);
     }
 
-    /// @notice Allows the L2StandardBridge to burn tokens.
+    /// @notice Allows the L2StandardBridge and SuperchainERC20Bridge bridges to burn tokens.
     /// @param _from   Address to burn tokens from.
     /// @param _amount Amount of tokens to burn.
     function burn(address _from, uint256 _amount) external virtual onlyAuthorizedBridge {

diff --git a/packages/contracts-bedrock/src/L2/interfaces/IOptimismSuperchainERC20.sol b/packages/contracts-bedrock/src/L2/interfaces/IOptimismSuperchainERC20.sol
@@ -30,12 +30,12 @@ interface IOptimismSuperchainERC20Extension is IOptimismSuperchainERC20Errors {
     /// @param amount  Amount of tokens burned.
     event Burn(address indexed account, uint256 amount);
 
-    /// @notice Allows the L2StandardBridge to mint tokens.
+    /// @notice Allows the L2StandardBridge and SuperchainERC20Bridge bridges to mint tokens.
     /// @param _to     Address to mint tokens to.
     /// @param _amount Amount of tokens to mint.
     function mint(address _to, uint256 _amount) external;
 
-    /// @notice Allows the L2StandardBridge to burn tokens.
+    /// @notice Allows the L2StandardBridge and SuperchainERC20Bridge bridges to burn tokens.
     /// @param _from   Address to burn tokens from.
     /// @param _amount Amount of tokens to burn.
     function burn(address _from, uint256 _amount) external;