fix: superchain bridge natspec (#83)

ethereum-optimism · Oct 4, 2024 · 83757ea · 83757ea
1 parent a5aca61
commit 83757ea
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 12 deletions.
diff --git a/packages/contracts-bedrock/semver-lock.json b/packages/contracts-bedrock/semver-lock.json
@@ -137,7 +137,7 @@
   },
   "src/L2/SuperchainERC20Bridge.sol": {
     "initCodeHash": "0xf85225ea25a87ba670b6ce0172a4814fda712d1c8a174fd4e8ce72b1cebcc2a0",
-    "sourceCodeHash": "0x66b56c0ac0d49b6da84da01a318f43418ef486e5fb40ae0af487568fde8566fb"
+    "sourceCodeHash": "0x4fabf65703f4a02bdd7e2b6f2425448f2c54162ae12bbbbaed1fbb8ec569a873"
   },
   "src/L2/SuperchainWETH.sol": {
     "initCodeHash": "0x5db03c5c4cd6ea9e4b3e74e28f50d04fd3e130af5109b34fa208808fa9ba7742",

diff --git a/packages/contracts-bedrock/src/L2/SuperchainERC20Bridge.sol b/packages/contracts-bedrock/src/L2/SuperchainERC20Bridge.sol
@@ -23,11 +23,7 @@ contract SuperchainERC20Bridge is ISuperchainERC20Bridge {
     /// @custom:semver 1.0.0-beta.1
     string public constant version = "1.0.0-beta.1";
 
-    /// @notice Sends tokens to some target address on another chain.
-    /// @param _token   Token to send.
-    /// @param _to      Address to send tokens to.
-    /// @param _amount  Amount of tokens to send.
-    /// @param _chainId Chain ID of the destination chain.
+    /// @inheritdoc ISuperchainERC20Bridge
     function sendERC20(address _token, address _to, uint256 _amount, uint256 _chainId) external {
         if (_to == address(0)) revert ZeroAddress();
 
@@ -39,11 +35,7 @@ contract SuperchainERC20Bridge is ISuperchainERC20Bridge {
         emit SendERC20(_token, msg.sender, _to, _amount, _chainId);
     }
 
-    /// @notice Relays tokens received from another chain.
-    /// @param _token  Token to relay.
-    /// @param _from   Address of the msg.sender of sendERC20 on the source chain.
-    /// @param _to     Address to relay tokens to.
-    /// @param _amount Amount of tokens to relay.
+    /// @inheritdoc ISuperchainERC20Bridge
     function relayERC20(address _token, address _from, address _to, uint256 _amount) external {
         if (msg.sender != MESSENGER) revert CallerNotL2ToL2CrossDomainMessenger();
 

diff --git a/packages/contracts-bedrock/src/L2/interfaces/ISuperchainERC20Bridge.sol b/packages/contracts-bedrock/src/L2/interfaces/ISuperchainERC20Bridge.sol
@@ -35,14 +35,16 @@ interface ISuperchainERC20Bridge is ISemver {
     /// @param source        Chain ID of the source chain.
     event RelayERC20(address indexed token, address indexed from, address indexed to, uint256 amount, uint256 source);
 
-    /// @notice Sends tokens to some target address on another chain.
+    /// @notice Sends tokens to a target address on another chain.
+    /// @dev Tokens are burned on the source chain.
     /// @param _token   Token to send.
     /// @param _to      Address to send tokens to.
     /// @param _amount  Amount of tokens to send.
     /// @param _chainId Chain ID of the destination chain.
     function sendERC20(address _token, address _to, uint256 _amount, uint256 _chainId) external;
 
     /// @notice Relays tokens received from another chain.
+    /// @dev Tokens are minted on the destination chain.
     /// @param _token   Token to relay.
     /// @param _from    Address of the msg.sender of sendERC20 on the source chain.
     /// @param _to      Address to relay tokens to.