Merge pull request #6910 from ethereum-optimism/refcell/contract-styling

chore: DisputeGameFactory Styling Touchups

packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol

@@ -83,7 +83,7 @@ contract DisputeGameFactory is OwnableUpgradeable, IDisputeGameFactory, Semver {
         bytes calldata _extraData
     )
         external
-        returns (IDisputeGame proxy)
+        returns (IDisputeGame proxy_)
     {
         // Grab the implementation contract for the given `GameType`.
         IDisputeGame impl = gameImpls[_gameType];
@@ -92,8 +92,8 @@ contract DisputeGameFactory is OwnableUpgradeable, IDisputeGameFactory, Semver {
         if (address(impl) == address(0)) revert NoImplementation(_gameType);
 
         // Clone the implementation contract and initialize it with the given parameters.
-        proxy = IDisputeGame(address(impl).clone(abi.encodePacked(_rootClaim, _extraData)));
-        proxy.initialize();
+        proxy_ = IDisputeGame(address(impl).clone(abi.encodePacked(_rootClaim, _extraData)));
+        proxy_.initialize();
 
         // Compute the unique identifier for the dispute game.
         Hash uuid = getGameUUID(_gameType, _rootClaim, _extraData);
@@ -101,12 +101,12 @@ contract DisputeGameFactory is OwnableUpgradeable, IDisputeGameFactory, Semver {
         // If a dispute game with the same UUID already exists, revert.
         if (GameId.unwrap(_disputeGames[uuid]) != bytes32(0)) revert GameAlreadyExists(uuid);
 
-        GameId id = LibGameId.pack(_gameType, Timestamp.wrap(uint64(block.timestamp)), proxy);
+        GameId id = LibGameId.pack(_gameType, Timestamp.wrap(uint64(block.timestamp)), proxy_);
 
         // Store the dispute game id in the mapping & emit the `DisputeGameCreated` event.
         _disputeGames[uuid] = id;
         _disputeGameList.push(id);
-        emit DisputeGameCreated(address(proxy), _gameType, _rootClaim);
+        emit DisputeGameCreated(address(proxy_), _gameType, _rootClaim);
     }
 
     /// @inheritdoc IDisputeGameFactory
@@ -117,7 +117,7 @@ contract DisputeGameFactory is OwnableUpgradeable, IDisputeGameFactory, Semver {
     )
         public
         pure
-        returns (Hash _uuid)
+        returns (Hash uuid_)
     {
         assembly {
             // Grab the offsets of the other memory locations we will need to temporarily overwrite.
@@ -141,7 +141,7 @@ contract DisputeGameFactory is OwnableUpgradeable, IDisputeGameFactory, Semver {
             let hashLen := and(add(mload(_extraData), 0x9F), not(0x1F))
 
             // Hash the memory to produce the UUID digest
-            _uuid := keccak256(gameTypeOffset, hashLen)
+            uuid_ := keccak256(gameTypeOffset, hashLen)
 
             // Restore the memory prior to `extraData`
             mstore(gameTypeOffset, tempA)

packages/contracts-bedrock/src/dispute/interfaces/IDisputeGameFactory.sol

@@ -26,16 +26,16 @@ interface IDisputeGameFactory {
     /// @notice `games` queries an internal mapping that maps the hash of
     ///         `gameType ++ rootClaim ++ extraData` to the deployed `DisputeGame` clone.
     /// @dev `++` equates to concatenation.
-    /// @param gameType The type of the DisputeGame - used to decide the proxy implementation
-    /// @param rootClaim The root claim of the DisputeGame.
-    /// @param extraData Any extra data that should be provided to the created dispute game.
+    /// @param _gameType The type of the DisputeGame - used to decide the proxy implementation
+    /// @param _rootClaim The root claim of the DisputeGame.
+    /// @param _extraData Any extra data that should be provided to the created dispute game.
     /// @return proxy_ The clone of the `DisputeGame` created with the given parameters.
     ///         Returns `address(0)` if nonexistent.
     /// @return timestamp_ The timestamp of the creation of the dispute game.
     function games(
-        GameType gameType,
-        Claim rootClaim,
-        bytes calldata extraData
+        GameType _gameType,
+        Claim _rootClaim,
+        bytes calldata _extraData
     )
         external
         view
@@ -56,9 +56,9 @@ interface IDisputeGameFactory {
     /// @notice `gameImpls` is a mapping that maps `GameType`s to their respective
     ///         `IDisputeGame` implementations.
     /// @param _gameType The type of the dispute game.
-    /// @return _impl The address of the implementation of the game type.
+    /// @return impl_ The address of the implementation of the game type.
     ///         Will be cloned on creation of a new dispute game with the given `gameType`.
-    function gameImpls(GameType _gameType) external view returns (IDisputeGame _impl);
+    function gameImpls(GameType _gameType) external view returns (IDisputeGame impl_);
 
     /// @notice Creates a new DisputeGame proxy contract.
     /// @param _gameType The type of the DisputeGame - used to decide the proxy implementation.
@@ -85,7 +85,7 @@ interface IDisputeGameFactory {
     /// @param _gameType The type of the DisputeGame.
     /// @param _rootClaim The root claim of the DisputeGame.
     /// @param _extraData Any extra data that should be provided to the created dispute game.
-    /// @return _uuid The unique identifier for the given dispute game parameters.
+    /// @return uuid_ The unique identifier for the given dispute game parameters.
     function getGameUUID(
         GameType _gameType,
         Claim _rootClaim,
@@ -93,5 +93,5 @@ interface IDisputeGameFactory {
     )
         external
         pure
-        returns (Hash _uuid);
+        returns (Hash uuid_);
 }