chore: update missing bridge on natspec (#69)

* chore: update missing bridge on natspec * fix: natspecs --------- Co-authored-by: agusduha <[email protected]>
ethereum-optimism · Sep 27, 2024 · 11fda67 · 11fda67
1 parent 6aaf905
commit 11fda67
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/packages/contracts-bedrock/semver-lock.json b/packages/contracts-bedrock/semver-lock.json
@@ -105,7 +105,7 @@
   },
   "src/L2/L2StandardBridgeInterop.sol": {
     "initCodeHash": "0xd43d07c2ba5a73af56181c0221c28f3b495851b03cf8e35f9b009857bb9538a6",
-    "sourceCodeHash": "0xc52d7a8b5d747167870d9048710e960e925d39650e3bd3fbc201b9b4f771e052"
+    "sourceCodeHash": "0x36087332a4365ee172eed8fa35aa48e804b08279e97332058a588c2d4ae30c6b"
   },
   "src/L2/L2ToL1MessagePasser.sol": {
     "initCodeHash": "0x13fe3729beb9ed966c97bef09acb9fe5043fe651d453145073d05f2567fa988d",
@@ -116,8 +116,8 @@
     "sourceCodeHash": "0x4b806cc85cead74c8df34ab08f4b6c6a95a1a387a335ec8a7cb2de4ea4e1cf41"
   },
   "src/L2/OptimismSuperchainERC20.sol": {
-    "initCodeHash": "0x9b48e5b8271d9b5d4407bf1a7327842844b4bd858123ffa6da0c55ad9d3b9d8e",
-    "sourceCodeHash": "0xaf5702655736e9c4b480a0bb4f0f2220f09834b2292f8e5419b5b245e0a20300"
+    "initCodeHash": "0x749dacbd29aad60c71c1e1878b21854c796759fb7a5ddc549b96ab9e39bb62b8",
+    "sourceCodeHash": "0xabd50b1b74d00aae459352899da16d937b6809699dd17c0b42c46cfd0e9a201d"
   },
   "src/L2/OptimismSuperchainERC20Beacon.sol": {
     "initCodeHash": "0x99ce8095b23c124850d866cbc144fee6cee05dbc6bb5d83acadfe00b90cf42c7",

diff --git a/packages/contracts-bedrock/src/L2/L2StandardBridgeInterop.sol b/packages/contracts-bedrock/src/L2/L2StandardBridgeInterop.sol
@@ -19,7 +19,7 @@ error InvalidDecimals();
 /// @notice Thrown when the legacy address is not found in the OptimismMintableERC20Factory.
 error InvalidLegacyERC20Address();
 
-/// @notice Thrown when the SuperchainERC20 address is not found in the SuperchainERC20Factory.
+/// @notice Thrown when the OptimismSuperchainERC20 address is not found in the OptimismSuperchainERC20Factory.
 error InvalidSuperchainERC20Address();
 
 /// @notice Thrown when the remote addresses of the tokens are not the same.
@@ -30,7 +30,7 @@ error InvalidTokenPair();
 /// @title L2StandardBridgeInterop
 /// @notice The L2StandardBridgeInterop is an extension of the L2StandardBridge that allows for
 ///         the conversion of tokens between legacy tokens (OptimismMintableERC20 or StandardL2ERC20)
-///         and SuperchainERC20 tokens.
+///         and OptimismSuperchainERC20 tokens.
 contract L2StandardBridgeInterop is L2StandardBridge {
     /// @notice Emitted when a conversion is made.
     /// @param from The token being converted from.
@@ -75,14 +75,14 @@ contract L2StandardBridgeInterop is L2StandardBridge {
 
     /// @notice Validates that the tokens are deployed by the correct factory.
     /// @param _legacyAddr The legacy token address (OptimismMintableERC20 or StandardL2ERC20).
-    /// @param _superAddr The SuperchainERC20 address.
+    /// @param _superAddr The OptimismSuperchainERC20 address.
     function _validateFactories(address _legacyAddr, address _superAddr) internal view {
         // 2. Valid legacy check
         address _legacyRemoteToken =
             IOptimismERC20Factory(Predeploys.OPTIMISM_MINTABLE_ERC20_FACTORY).deployments(_legacyAddr);
         if (_legacyRemoteToken == address(0)) revert InvalidLegacyERC20Address();
 
-        // 3. Valid SuperchainERC20 check
+        // 3. Valid OptimismSuperchainERC20 check
         address _superRemoteToken =
             IOptimismERC20Factory(Predeploys.OPTIMISM_SUPERCHAIN_ERC20_FACTORY).deployments(_superAddr);
         if (_superRemoteToken == address(0)) revert InvalidSuperchainERC20Address();

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.5
+    string public constant version = "1.0.0-beta.5";
 
     /// @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;