use DeployUtils lib for deployments in deploy script (#12070)

* use DeployUtils lib for deployments in deploy script

* type safety for constructor args and use encode constructor

* add comments to helper functions

* add commentsd, deploy scripts cleanup

* fix assertion

* modify interface checker script to always expect a pseudo-constructor, modify failing interfaces

* assert contracts with no constructors to have pseudo-constructors with no input

* use pseudo-constructor encoding for contracts with no constructor defined

packages/contracts-bedrock/scripts/checks/check-interfaces.sh

@@ -208,6 +208,29 @@ for interface_file in $JSON_FILES; do
     normalized_interface_abi=$(normalize_abi "$interface_abi")
     normalized_contract_abi=$(normalize_abi "$contract_abi")
 
+    # Check if the contract ABI has no constructor but the interface is missing __constructor__
+    contract_has_constructor=$(echo "$normalized_contract_abi" | jq 'any(.[]; .type == "constructor")')
+    interface_has_default_pseudo_constructor=$(echo "$normalized_interface_abi" | jq 'any(.[]; .type == "constructor" and .inputs == [])')
+
+    # If any contract has no constructor and its corresponding interface also does not have one, flag it as a detected issue
+    if [ "$contract_has_constructor" = false ] && [ "$interface_has_default_pseudo_constructor" = false ]; then
+        if ! grep -q "^$contract_name$" "$REPORTED_INTERFACES_FILE"; then
+            echo "$contract_name" >> "$REPORTED_INTERFACES_FILE"
+            if ! is_excluded "$contract_name"; then
+                echo "Issue found in ABI for interface $contract_name from file $interface_file."
+                echo "Interface $contract_name must have a function named '__constructor__' as the corresponding contract has no constructor in its ABI."
+                issues_detected=true
+            fi
+        fi
+        continue
+    fi
+
+    # removes the pseudo constructor json entry from the interface files where the corresponding contract file has no constructor
+    # this is to ensure it is not flagged as a diff in the next step below
+    if [ "$contract_has_constructor" = false ] && [ "$interface_has_default_pseudo_constructor" ]; then
+      normalized_interface_abi=$(echo "$normalized_interface_abi" | jq 'map(select(.type != "constructor"))')
+    fi
+
     # Use jq to compare the ABIs
     if ! diff_result=$(diff -u <(echo "$normalized_interface_abi" | jq 'sort') <(echo "$normalized_contract_abi" | jq 'sort')); then
         if ! grep -q "^$contract_name$" "$REPORTED_INTERFACES_FILE"; then

packages/contracts-bedrock/scripts/fpac/FPACOPS2.s.sol

@@ -91,12 +91,14 @@ contract FPACOPS2 is Deploy, StdAssertions {
     function deployCannonDisputeGame() internal broadcast {
         console.log("Deploying CannonFaultDisputeGame implementation");
 
-        save(
-            "CannonFaultDisputeGame",
-            address(
-                _deploy(
-                    "FaultDisputeGame",
-                    abi.encode(
+        DeployUtils.create2AndSave({
+            _save: this,
+            _name: "FaultDisputeGame",
+            _nick: "CannonFaultDisputeGame",
+            _args: DeployUtils.encodeConstructor(
+                abi.encodeCall(
+                    IFaultDisputeGame.__constructor__,
+                    (
                         GameTypes.CANNON,
                         loadMipsAbsolutePrestate(),
                         cfg.faultGameMaxDepth(),
@@ -109,20 +111,22 @@ contract FPACOPS2 is Deploy, StdAssertions {
                         cfg.l2ChainID()
                     )
                 )
-            )
-        );
+            ),
+            _salt: _implSalt()
+        });
     }
 
     /// @notice Deploys the PermissionedDisputeGame.
     function deployPermissionedDisputeGame() internal broadcast {
         console.log("Deploying PermissionedDisputeGame implementation");
 
-        save(
-            "PermissionedDisputeGame",
-            address(
-                _deploy(
-                    "PermissionedDisputeGame",
-                    abi.encode(
+        DeployUtils.create2AndSave({
+            _save: this,
+            _name: "PermissionedDisputeGame",
+            _args: DeployUtils.encodeConstructor(
+                abi.encodeCall(
+                    IPermissionedDisputeGame.__constructor__,
+                    (
                         GameTypes.PERMISSIONED_CANNON,
                         loadMipsAbsolutePrestate(),
                         cfg.faultGameMaxDepth(),
@@ -137,8 +141,9 @@ contract FPACOPS2 is Deploy, StdAssertions {
                         cfg.l2OutputOracleChallenger()
                     )
                 )
-            )
-        );
+            ),
+            _salt: _implSalt()
+        });
     }
 
     /// @notice Initializes the DelayedWETH proxy.

packages/contracts-bedrock/scripts/libraries/DeployUtils.sol

@@ -8,6 +8,7 @@ import { Artifacts } from "scripts/Artifacts.s.sol";
 
 // Libraries
 import { LibString } from "@solady/utils/LibString.sol";
+import { Bytes } from "src/libraries/Bytes.sol";
 
 // Contracts
 import { Proxy } from "src/universal/Proxy.sol";
@@ -198,6 +199,15 @@ library DeployUtils {
         return address(uint160(uint256(keccak256(abi.encode(_sender, _identifier)))));
     }
 
+    /// @notice Strips the first 4 bytes of `_data` and returns the remaining bytes
+    ///         If `_data` is not greater than 4 bytes, it returns empty bytes type.
+    /// @param _data constructor arguments prefixed with a psuedo-constructor function signature
+    /// @return encodedData_ constructor arguments without the psuedo-constructor function signature prefix
+    function encodeConstructor(bytes memory _data) internal pure returns (bytes memory encodedData_) {
+        require(_data.length >= 4, "encodeConstructor takes in _data of length >= 4");
+        encodedData_ = Bytes.slice(_data, 4);
+    }
+
     /// @notice Asserts that the given address is a valid contract address.
     /// @param _who Address to check.
     function assertValidContractAddress(address _who) internal view {

packages/contracts-bedrock/src/L1/interfaces/IL1CrossDomainMessenger.sol

@@ -18,4 +18,6 @@ interface IL1CrossDomainMessenger is ICrossDomainMessenger {
     function superchainConfig() external view returns (address);
     function systemConfig() external view returns (address);
     function version() external view returns (string memory);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/L1/interfaces/IL1ERC721Bridge.sol

@@ -37,4 +37,6 @@ interface IL1ERC721Bridge is IERC721Bridge {
     function paused() external view returns (bool);
     function superchainConfig() external view returns (ISuperchainConfig);
     function version() external view returns (string memory);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/L1/interfaces/IL1StandardBridge.sol

@@ -72,4 +72,6 @@ interface IL1StandardBridge is IStandardBridge {
     function superchainConfig() external view returns (ISuperchainConfig);
     function systemConfig() external view returns (ISystemConfig);
     function version() external view returns (string memory);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/L1/interfaces/IOptimismPortal.sol

@@ -82,4 +82,6 @@ interface IOptimismPortal {
     function superchainConfig() external view returns (ISuperchainConfig);
     function systemConfig() external view returns (ISystemConfig);
     function version() external pure returns (string memory);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/L1/interfaces/IResourceMetering.sol

@@ -22,4 +22,6 @@ interface IResourceMetering {
     event Initialized(uint8 version);
 
     function params() external view returns (uint128 prevBaseFee, uint64 prevBoughtGas, uint64 prevBlockNum); // nosemgrep
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/L1/interfaces/ISystemConfigInterop.sol

@@ -79,4 +79,6 @@ interface ISystemConfigInterop {
     )
         external;
     function version() external pure returns (string memory);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/L2/interfaces/IBaseFeeVault.sol

@@ -3,13 +3,27 @@ pragma solidity ^0.8.0;
 
 import { IFeeVault } from "src/universal/interfaces/IFeeVault.sol";
 
-interface IBaseFeeVault is IFeeVault {
+interface IBaseFeeVault {
+    event Withdrawal(uint256 value, address to, address from);
+    event Withdrawal(uint256 value, address to, address from, IFeeVault.WithdrawalNetwork withdrawalNetwork);
+
+    receive() external payable;
+
+    function MIN_WITHDRAWAL_AMOUNT() external view returns (uint256);
+    function RECIPIENT() external view returns (address);
+    function WITHDRAWAL_NETWORK() external view returns (IFeeVault.WithdrawalNetwork);
+    function minWithdrawalAmount() external view returns (uint256 amount_);
+    function recipient() external view returns (address recipient_);
+    function totalProcessed() external view returns (uint256);
+    function withdraw() external;
+    function withdrawalNetwork() external view returns (IFeeVault.WithdrawalNetwork network_);
+
     function version() external view returns (string memory);
 
     function __constructor__(
         address _recipient,
         uint256 _minWithdrawalAmount,
-        WithdrawalNetwork _withdrawalNetwork
+        IFeeVault.WithdrawalNetwork _withdrawalNetwork
     )
         external;
 }

packages/contracts-bedrock/src/L2/interfaces/IETHLiquidity.sol

@@ -11,4 +11,6 @@ interface IETHLiquidity {
     function burn() external payable;
     function mint(uint256 _amount) external;
     function version() external view returns (string memory);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/L2/interfaces/IGasPriceOracle.sol

@@ -20,4 +20,6 @@ interface IGasPriceOracle {
     function setEcotone() external;
     function setFjord() external;
     function version() external view returns (string memory);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/L2/interfaces/IL1Block.sol

@@ -36,4 +36,6 @@ interface IL1Block {
     function setL1BlockValuesEcotone() external;
     function timestamp() external view returns (uint64);
     function version() external pure returns (string memory);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/L2/interfaces/IL1BlockIsthmus.sol

@@ -55,4 +55,6 @@ interface IL1BlockIsthmus {
     function setL1BlockValuesIsthmus() external;
     function timestamp() external view returns (uint64);
     function version() external pure returns (string memory);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/L2/interfaces/IL1FeeVault.sol

@@ -3,13 +3,27 @@ pragma solidity ^0.8.0;
 
 import { IFeeVault } from "src/universal/interfaces/IFeeVault.sol";
 
-interface IL1FeeVault is IFeeVault {
+interface IL1FeeVault {
+    event Withdrawal(uint256 value, address to, address from);
+    event Withdrawal(uint256 value, address to, address from, IFeeVault.WithdrawalNetwork withdrawalNetwork);
+
+    receive() external payable;
+
+    function MIN_WITHDRAWAL_AMOUNT() external view returns (uint256);
+    function RECIPIENT() external view returns (address);
+    function WITHDRAWAL_NETWORK() external view returns (IFeeVault.WithdrawalNetwork);
+    function minWithdrawalAmount() external view returns (uint256 amount_);
+    function recipient() external view returns (address recipient_);
+    function totalProcessed() external view returns (uint256);
+    function withdraw() external;
+    function withdrawalNetwork() external view returns (IFeeVault.WithdrawalNetwork network_);
+
     function version() external view returns (string memory);
 
     function __constructor__(
         address _recipient,
         uint256 _minWithdrawalAmount,
-        WithdrawalNetwork _withdrawalNetwork
+        IFeeVault.WithdrawalNetwork _withdrawalNetwork
     )
         external;
 }

packages/contracts-bedrock/src/L2/interfaces/IL2StandardBridgeInterop.sol

@@ -95,4 +95,6 @@ interface IL2StandardBridgeInterop is IStandardBridge {
 
     function convert(address _from, address _to, uint256 _amount) external;
     function version() external pure returns (string memory);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/L2/interfaces/IL2ToL1MessagePasser.sol

@@ -21,4 +21,6 @@ interface IL2ToL1MessagePasser {
     function messageNonce() external view returns (uint256);
     function sentMessages(bytes32) external view returns (bool);
     function version() external view returns (string memory);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/L2/interfaces/ISequencerFeeVault.sol

@@ -3,14 +3,28 @@ pragma solidity ^0.8.0;
 
 import { IFeeVault } from "src/universal/interfaces/IFeeVault.sol";
 
-interface ISequencerFeeVault is IFeeVault {
+interface ISequencerFeeVault {
+    event Withdrawal(uint256 value, address to, address from);
+    event Withdrawal(uint256 value, address to, address from, IFeeVault.WithdrawalNetwork withdrawalNetwork);
+
+    receive() external payable;
+
+    function MIN_WITHDRAWAL_AMOUNT() external view returns (uint256);
+    function RECIPIENT() external view returns (address);
+    function WITHDRAWAL_NETWORK() external view returns (IFeeVault.WithdrawalNetwork);
+    function minWithdrawalAmount() external view returns (uint256 amount_);
+    function recipient() external view returns (address recipient_);
+    function totalProcessed() external view returns (uint256);
+    function withdraw() external;
+    function withdrawalNetwork() external view returns (IFeeVault.WithdrawalNetwork network_);
+
     function version() external view returns (string memory);
     function l1FeeWallet() external view returns (address);
 
     function __constructor__(
         address _recipient,
         uint256 _minWithdrawalAmount,
-        WithdrawalNetwork _withdrawalNetwork
+        IFeeVault.WithdrawalNetwork _withdrawalNetwork
     )
         external;
 }

packages/contracts-bedrock/src/L2/interfaces/ISuperchainERC20.sol

@@ -53,4 +53,6 @@ interface ISuperchainERC20Errors {
 
 /// @title ISuperchainERC20
 /// @notice Combines Solady's ERC20 interface with the SuperchainERC20Extensions interface.
-interface ISuperchainERC20 is IERC20Solady, ISuperchainERC20Extensions, ISuperchainERC20Errors { }
+interface ISuperchainERC20 is IERC20Solady, ISuperchainERC20Extensions, ISuperchainERC20Errors {
+    function __constructor__() external;
+}

packages/contracts-bedrock/src/L2/interfaces/ISuperchainWETH.sol

@@ -30,4 +30,6 @@ interface ISuperchainWETH {
     function transferFrom(address src, address dst, uint256 wad) external returns (bool);
     function version() external view returns (string memory);
     function withdraw(uint256 wad) external;
+
+    function __constructor__() external;
 }

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

@@ -27,4 +27,6 @@ interface IDelayedWETH is IWETH {
     function withdraw(address _guy, uint256 _wad) external;
     function withdrawals(address _owner, address _guy) external view returns (uint256, uint256);
     function version() external view returns (string memory);
+
+    function __constructor__(uint256 _delay) external;
 }

packages/contracts-bedrock/src/legacy/interfaces/IAddressManager.sol

@@ -10,4 +10,6 @@ interface IAddressManager is IOwnable {
 
     function getAddress(string memory _name) external view returns (address);
     function setAddress(string memory _name, address _address) external;
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/legacy/interfaces/IDeployerWhitelist.sol

@@ -17,4 +17,6 @@ interface IDeployerWhitelist {
     function setWhitelistedDeployer(address _deployer, bool _isWhitelisted) external;
     function version() external view returns (string memory);
     function whitelist(address) external view returns (bool);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/legacy/interfaces/IL1BlockNumber.sol

@@ -11,4 +11,6 @@ interface IL1BlockNumber is ISemver {
     receive() external payable;
 
     function getL1BlockNumber() external view returns (uint256);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/legacy/interfaces/ILegacyMessagePasser.sol

@@ -8,4 +8,6 @@ import { ISemver } from "src/universal/interfaces/ISemver.sol";
 interface ILegacyMessagePasser is ISemver {
     function passMessageToL1(bytes memory _message) external;
     function sentMessages(bytes32) external view returns (bool);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/universal/interfaces/ICrossDomainMessenger.sol

@@ -35,4 +35,6 @@ interface ICrossDomainMessenger {
     function sendMessage(address _target, bytes memory _message, uint32 _minGasLimit) external payable;
     function successfulMessages(bytes32) external view returns (bool);
     function xDomainMessageSender() external view returns (address);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/universal/interfaces/IERC721Bridge.sol

@@ -44,4 +44,6 @@ interface IERC721Bridge {
     function messenger() external view returns (ICrossDomainMessenger);
     function otherBridge() external view returns (IERC721Bridge);
     function paused() external view returns (bool);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/universal/interfaces/IFeeVault.sol

@@ -20,4 +20,6 @@ interface IFeeVault {
     function totalProcessed() external view returns (uint256);
     function withdraw() external;
     function withdrawalNetwork() external view returns (WithdrawalNetwork network_);
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/universal/interfaces/IOwnable.sol

@@ -9,4 +9,6 @@ interface IOwnable {
     function owner() external view returns (address);
     function renounceOwnership() external;
     function transferOwnership(address newOwner) external; // nosemgrep
+
+    function __constructor__() external;
 }

packages/contracts-bedrock/src/universal/interfaces/IStandardBridge.sol

@@ -61,4 +61,6 @@ interface IStandardBridge {
     function messenger() external view returns (ICrossDomainMessenger);
     function otherBridge() external view returns (IStandardBridge);
     function paused() external view returns (bool);
+
+    function __constructor__() external;
 }