apply Solidity style guide conventions

Author: xenoliss

base/src/Bridge.sol

@@ -122,21 +122,19 @@ contract Bridge is Initializable {
     }
 
     /// @notice Sends ERC20 tokens to the sender's address on the other chain.
-    /// @param _localToken  Address of the ERC20 on this chain.
-    /// @param _remoteToken Address of the corresponding token on the remote chain.
-    /// @param _to          Solana pubkey to send tokens to
-    /// @param _amount      Amount of local tokens to deposit.
-    /// @param _extraData   Extra data to be sent with the transaction. Note that the recipient will
+    /// @param localToken  Address of the ERC20 on this chain.
+    /// @param remoteToken Address of the corresponding token on the remote chain.
+    /// @param to          Solana pubkey to send tokens to
+    /// @param amount      Amount of local tokens to deposit.
+    /// @param extraData   Extra data to be sent with the transaction. Note that the recipient will
     ///                     not be triggered with this data, but it will be emitted and can be used
     ///                     to identify the transaction.
-    function bridgeToken(
-        address _localToken,
-        bytes32 _remoteToken,
-        bytes32 _to,
-        uint64 _amount,
-        bytes calldata _extraData
-    ) public virtual onlyEOA {
-        _initiateBridgeERC20(_localToken, _remoteToken, msg.sender, _to, _amount, _extraData);
+    function bridgeToken(address localToken, bytes32 remoteToken, bytes32 to, uint64 amount, bytes calldata extraData)
+        public
+        virtual
+        onlyEOA
+    {
+        _initiateBridgeERC20(localToken, remoteToken, msg.sender, to, amount, extraData);
     }
 
     /// @notice Finalizes a token bridge on this chain. Can only be triggered by the Bridge contract on the remote
@@ -186,49 +184,49 @@ contract Bridge is Initializable {
     //////////////////////////////////////////////////////////////
 
     /// @notice Sends ERC20 tokens to a receiver's address on the other chain.
-    /// @param _localToken  Address of the ERC20 on this chain.
-    /// @param _remoteToken Address of the corresponding token on the remote chain.
-    /// @param _to          Address of the receiver.
-    /// @param _amount      Amount of local tokens to deposit.
-    /// @param _extraData   Extra data to be sent with the transaction. Note that the recipient will
+    /// @param localToken  Address of the ERC20 on this chain.
+    /// @param remoteToken Address of the corresponding token on the remote chain.
+    /// @param to          Address of the receiver.
+    /// @param amount      Amount of local tokens to deposit.
+    /// @param extraData   Extra data to be sent with the transaction. Note that the recipient will
     ///                     not be triggered with this data, but it will be emitted and can be used
     ///                     to identify the transaction.
     function _initiateBridgeERC20(
-        address _localToken,
-        bytes32 _remoteToken,
-        address _from,
-        bytes32 _to,
-        uint64 _amount,
-        bytes memory _extraData
+        address localToken,
+        bytes32 remoteToken,
+        address from,
+        bytes32 to,
+        uint64 amount,
+        bytes memory extraData
     ) internal {
         require(msg.value == 0, "StandardBridge: cannot send value");
 
-        if (_isCrossChainERC20(_localToken)) {
+        if (_isCrossChainERC20(localToken)) {
             require(
-                _isCorrectTokenPair(CrossChainERC20(_localToken), _remoteToken),
+                _isCorrectTokenPair(CrossChainERC20(localToken), remoteToken),
                 "StandardBridge: wrong remote token for Optimism Mintable ERC20 local token"
             );
 
-            CrossChainERC20(_localToken).burn(_from, _amount);
+            CrossChainERC20(localToken).burn(from, amount);
         } else {
-            SafeTransferLib.safeTransferFrom({token: _localToken, from: _from, to: address(this), amount: _amount});
-            deposits[_localToken][_remoteToken] = deposits[_localToken][_remoteToken] + _amount;
+            SafeTransferLib.safeTransferFrom({token: localToken, from: from, to: address(this), amount: amount});
+            deposits[localToken][remoteToken] = deposits[localToken][remoteToken] + amount;
         }
 
-        emit ERC20BridgeInitiated(_localToken, _remoteToken, _from, _to, _amount, _extraData);
+        emit ERC20BridgeInitiated(localToken, remoteToken, from, to, amount, extraData);
 
         MessagePasser.Instruction[] memory messageIxs = new MessagePasser.Instruction[](1);
         messageIxs[0] = MessagePasser.Instruction({
             programId: remoteBridge,
             accounts: new MessagePasser.AccountMeta[](0),
             data: Encoder.encodeBridgePayload(
                 BridgePayload({
-                    localToken: _remoteToken,
-                    remoteToken: _localToken,
-                    from: _from,
-                    to: _to,
-                    amount: _amount,
-                    extraData: _extraData
+                    localToken: remoteToken,
+                    remoteToken: localToken,
+                    from: from,
+                    to: to,
+                    amount: amount,
+                    extraData: extraData
                 })
             )
         });

base/src/CrossChainERC20.sol

@@ -21,6 +21,7 @@ contract CrossChainERC20 is ERC20 {
     /// @param from Address of the account tokens are being burned from.
     /// @param amount  Amount of tokens burned.
     event Burn(address indexed from, uint256 amount);
+
     //////////////////////////////////////////////////////////////
     ///                       Constants                        ///
     //////////////////////////////////////////////////////////////
@@ -72,32 +73,33 @@ contract CrossChainERC20 is ERC20 {
         return "1.0.1";
     }
 
-    /// @dev Returns the bridge address.
+    /// @notice Returns the bridge address.
     function bridge() public view returns (address) {
         return _bridge;
     }
 
-    /// @dev Returns the remote token address.
+    /// @notice Returns the remote token address.
     function remoteToken() public view returns (bytes32) {
         return _remoteToken;
     }
 
-    /// @dev Returns the name of the token.
+    /// @notice Returns the name of the token.
     function name() public view override returns (string memory) {
         return _name;
     }
 
-    /// @dev Returns the symbol of the token.
+    /// @notice Returns the symbol of the token.
     function symbol() public view override returns (string memory) {
         return _symbol;
     }
 
-    /// @dev Returns the decimals places of the token.
+    /// @notice Returns the decimals places of the token.
     function decimals() public view override returns (uint8) {
         return _decimals;
     }
 
     /// @notice Allows the Bridge to mint tokens.
+    ///
     /// @param to Address to mint tokens to.
     /// @param amount Amount of tokens to mint.
     function mint(address to, uint256 amount) external onlyBridge {
@@ -108,6 +110,7 @@ contract CrossChainERC20 is ERC20 {
     }
 
     /// @notice Allows the Bridge to burn tokens.
+    ///
     /// @param from Address to burn tokens from.
     /// @param amount Amount of tokens to burn.
     function burn(address from, uint256 amount) external onlyBridge {

base/src/CrossChainMessenger.sol

@@ -124,6 +124,15 @@ contract CrossChainMessenger is Initializable {
         return _xChainMsgSender;
     }
 
+    /// @notice Retrieves the next message nonce. Message version will be added to the upper two
+    ///         bytes of the message nonce. Message version allows us to treat messages as having
+    ///         different structures.
+    ///
+    /// @return Nonce of the next message to be sent, with added message version.
+    function messageNonce() public view returns (uint256) {
+        return Encoding.encodeVersionedNonce(_msgNonce, MESSAGE_VERSION);
+    }
+
     /// @notice Initializer.
     ///
     /// @param remoteMessenger_ Address of the messenger on the remote chain.
@@ -247,15 +256,6 @@ contract CrossChainMessenger is Initializable {
         }
     }
 
-    /// @notice Retrieves the next message nonce. Message version will be added to the upper two
-    ///         bytes of the message nonce. Message version allows us to treat messages as having
-    ///         different structures.
-    ///
-    /// @return Nonce of the next message to be sent, with added message version.
-    function messageNonce() public view returns (uint256) {
-        return Encoding.encodeVersionedNonce(_msgNonce, MESSAGE_VERSION);
-    }
-
     //////////////////////////////////////////////////////////////
     ///                       Internal Functions               ///
     //////////////////////////////////////////////////////////////

base/src/MessagePasser.sol

@@ -88,6 +88,15 @@ contract MessagePasser {
         return "1.1.2";
     }
 
+    /// @notice Retrieves the next message nonce. Message version will be added to the upper two
+    ///         bytes of the message nonce. Message version allows us to treat messages as having
+    ///         different structures.
+    ///
+    /// @return Nonce of the next message to be sent, with added message version.
+    function messageNonce() public view returns (uint256) {
+        return Encoding.encodeVersionedNonce(_msgNonce, MESSAGE_VERSION);
+    }
+
     /// @notice Sends a message from L2 to L1.
     ///
     /// @param ixs Instructions to execute.
@@ -104,25 +113,16 @@ contract MessagePasser {
         }
     }
 
-    /// @notice Retrieves the next message nonce. Message version will be added to the upper two
-    ///         bytes of the message nonce. Message version allows us to treat messages as having
-    ///         different structures.
-    ///
-    /// @return Nonce of the next message to be sent, with added message version.
-    function messageNonce() public view returns (uint256) {
-        return Encoding.encodeVersionedNonce(_msgNonce, MESSAGE_VERSION);
-    }
-
     //////////////////////////////////////////////////////////////
     ///                       Internal Functions               ///
     //////////////////////////////////////////////////////////////
 
     /// @notice Derives the withdrawal hash according to the encoding in the L2 Withdrawer contract
     ///
-    /// @param _tx Withdrawal transaction to hash.
+    /// @param withdrawal Withdrawal transaction to hash.
     ///
     /// @return Hashed withdrawal transaction.
-    function _hashWithdrawal(WithdrawalTransaction memory _tx) internal pure returns (bytes32) {
-        return keccak256(Encoder.encodeMessage(_tx.nonce, _tx.sender, _tx.ixs));
+    function _hashWithdrawal(WithdrawalTransaction memory withdrawal) internal pure returns (bytes32) {
+        return keccak256(Encoder.encodeMessage(withdrawal.nonce, withdrawal.sender, withdrawal.ixs));
     }
 }