Skip to content

ctb: Add natspec to the StandardValidator #15969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maurelian merged 4 commits into from
May 15, 2025
Merged

ctb: Add natspec to the StandardValidator #15969

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
77bc3b5
ctb: Add natspec to the StandardValidator
maurelian May 15, 2025
6638e51
Remove @return comments, we don't use them in most other contracts
maurelian May 15, 2025
c63aa33
remove @param too
maurelian May 15, 2025
1342504
Remove stringEq
maurelian May 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions packages/contracts-bedrock/src/L1/StandardValidator.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,25 +27,60 @@ import { IResourceMetering } from "interfaces/L1/IResourceMetering.sol";
import { IOptimismPortal2 } from "interfaces/L1/IOptimismPortal2.sol";
import { IPreimageOracle } from "interfaces/cannon/IPreimageOracle.sol";

/// @title StandardValidator
/// @notice This contract is used to validate the configuration of the L1 contracts of an OP Stack chain.
/// It is a stateless contract that can be used to ensure that the L1 contracts are configured correctly.
/// It is intended to be used by the L1 PAO multisig to validate the configuration of the L1 contracts
/// before and after an upgrade.
contract StandardValidator {
/// @notice The SuperchainConfig contract.
ISuperchainConfig public superchainConfig;

/// @notice The L1 PAO multisig address.
address public l1PAOMultisig;

/// @notice The challenger address for permissioned dispute games.
address public challenger;

/// @notice The withdrawal delay in seconds for the DelayedWETH contract.
uint256 public withdrawalDelaySeconds;

// Implementation addresses as state variables

/// @notice The L1ERC721Bridge implementation address.
address public l1ERC721BridgeImpl;

/// @notice The OptimismPortal implementation address.
address public optimismPortalImpl;

/// @notice The ETHLockbox implementation address.
address public ethLockboxImpl;

/// @notice The SystemConfig implementation address.
address public systemConfigImpl;

/// @notice The OptimismMintableERC20Factory implementation address.
address public optimismMintableERC20FactoryImpl;

/// @notice The L1CrossDomainMessenger implementation address.
address public l1CrossDomainMessengerImpl;

/// @notice The L1StandardBridge implementation address.
address public l1StandardBridgeImpl;

/// @notice The DisputeGameFactory implementation address.
address public disputeGameFactoryImpl;

/// @notice The AnchorStateRegistry implementation address.
address public anchorStateRegistryImpl;

/// @notice The DelayedWETH implementation address.
address public delayedWETHImpl;

/// @notice The MIPS implementation address.
address public mipsImpl;

/// @notice Struct containing the implementation addresses of the L1 contracts.
struct Implementations {
address l1ERC721BridgeImpl;
address optimismPortalImpl;
Expand All @@ -60,18 +95,21 @@ contract StandardValidator {
address mipsImpl;
}

/// @notice Struct containing the input parameters for the validation process.
struct ValidationInput {
IProxyAdmin proxyAdmin;
ISystemConfig sysCfg;
bytes32 absolutePrestate;
uint256 l2ChainID;
}

/// @notice Struct containing override parameters for the validation process.
struct ValidationOverrides {
address l1PAOMultisig;
address challenger;
}

/// @notice Constructor for the StandardValidator contract.
constructor(
Implementations memory _implementations,
ISuperchainConfig _superchainConfig,
Expand All @@ -98,6 +136,7 @@ contract StandardValidator {
mipsImpl = _implementations.mipsImpl;
}

/// @notice Returns a string representing the overrides that are set.
function getOverridesString(ValidationOverrides memory _overrides) private pure returns (string memory) {
string memory overridesError;

Expand All @@ -113,77 +152,94 @@ contract StandardValidator {
return overridesError;
}

/// @notice Returns the expected L1 PAO multisig address.
function expectedL1PAOMultisig(ValidationOverrides memory _overrides) internal view returns (address) {
if (_overrides.l1PAOMultisig != address(0)) {
return _overrides.l1PAOMultisig;
}
return l1PAOMultisig;
}

/// @notice Returns the expected challenger address.
function expectedChallenger(ValidationOverrides memory _overrides) internal view returns (address) {
if (_overrides.challenger != address(0)) {
return _overrides.challenger;
}
return challenger;
}

/// @notice Returns the expected SystemConfig version.
function systemConfigVersion() public pure returns (string memory) {
return "3.3.0";
}

/// @notice Returns the expected OptimismPortal version.
function optimismPortalVersion() public pure returns (string memory) {
return "4.6.0";
}

/// @notice Returns the expected L1CrossDomainMessenger version.
function l1CrossDomainMessengerVersion() public pure returns (string memory) {
return "2.9.0";
}

/// @notice Returns the expected L1ERC721Bridge version.
function l1ERC721BridgeVersion() public pure returns (string memory) {
return "2.7.0";
}

/// @notice Returns the expected L1StandardBridge version.
function l1StandardBridgeVersion() public pure returns (string memory) {
return "2.6.0";
}

/// @notice Returns the expected MIPS version.
function mipsVersion() public pure returns (string memory) {
return "1.3.0";
}

/// @notice Returns the expected OptimismMintableERC20Factory version.
function optimismMintableERC20FactoryVersion() public pure returns (string memory) {
return "1.10.1";
}

/// @notice Returns the expected DisputeGameFactory version.
function disputeGameFactoryVersion() public pure returns (string memory) {
return "1.2.0";
}

/// @notice Returns the expected AnchorStateRegistry version.
function anchorStateRegistryVersion() public pure returns (string memory) {
return "3.5.0";
}

/// @notice Returns the expected DelayedWETH version.
function delayedWETHVersion() public pure returns (string memory) {
return "1.5.0";
}

/// @notice Returns the expected PermissionedDisputeGame version.
function permissionedDisputeGameVersion() public pure returns (string memory) {
return "1.7.0";
}

/// @notice Returns the expected PreimageOracle version.
function preimageOracleVersion() public pure returns (string memory) {
return "1.1.4";
}

/// @notice Returns the expected ETHLockbox version.
function ethLockboxVersion() public pure returns (string memory) {
return "1.2.0";
}

/// @notice Asserts that the SuperchainConfig contract is valid.
function assertValidSuperchainConfig(string memory _errors) internal view returns (string memory) {
_errors = internalRequire(!superchainConfig.paused(address(0)), "SPRCFG-10", _errors);
return _errors;
}

/// @notice Asserts that the ProxyAdmin contract is valid.
function assertValidProxyAdmin(
string memory _errors,
IProxyAdmin _admin,
Expand All @@ -198,6 +254,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that the SystemConfig contract is valid.
function assertValidSystemConfig(
string memory _errors,
ISystemConfig _sysCfg,
Expand Down Expand Up @@ -229,6 +286,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that the L1CrossDomainMessenger contract is valid.
function assertValidL1CrossDomainMessenger(
string memory _errors,
ISystemConfig _sysCfg,
Expand Down Expand Up @@ -260,6 +318,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that the L1StandardBridge contract is valid.
function assertValidL1StandardBridge(
string memory _errors,
ISystemConfig _sysCfg,
Expand All @@ -285,6 +344,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that the OptimismMintableERC20Factory contract is valid.
function assertValidOptimismMintableERC20Factory(
string memory _errors,
ISystemConfig _sysCfg,
Expand All @@ -308,6 +368,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that the L1ERC721Bridge contract is valid.
function assertValidL1ERC721Bridge(
string memory _errors,
ISystemConfig _sysCfg,
Expand All @@ -332,6 +393,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that the OptimismPortal contract is valid.
function assertValidOptimismPortal(
string memory _errors,
ISystemConfig _sysCfg,
Expand All @@ -354,6 +416,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that the ETHLockbox contract is valid.
function assertValidETHLockbox(
string memory _errors,
ISystemConfig _sysCfg,
Expand All @@ -375,6 +438,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that the DisputeGameFactory contract is valid.
function assertValidDisputeGameFactory(
string memory _errors,
ISystemConfig _sysCfg,
Expand All @@ -396,6 +460,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that the PermissionedDisputeGame contract is valid.
function assertValidPermissionedDisputeGame(
string memory _errors,
ISystemConfig _sysCfg,
Expand Down Expand Up @@ -447,6 +512,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that the PermissionlessDisputeGame contract is valid.
function assertValidPermissionlessDisputeGame(
string memory _errors,
ISystemConfig _sysCfg,
Expand Down Expand Up @@ -491,6 +557,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that a DisputeGame contract is valid.
function assertValidDisputeGame(
string memory _errors,
ISystemConfig _sysCfg,
Expand Down Expand Up @@ -543,6 +610,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that the DelayedWETH contract is valid.
function assertValidDelayedWETH(
string memory _errors,
ISystemConfig _sysCfg,
Expand Down Expand Up @@ -573,6 +641,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that the AnchorStateRegistry contract is valid.
function assertValidAnchorStateRegistry(
string memory _errors,
ISystemConfig _sysCfg,
Expand Down Expand Up @@ -604,6 +673,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Asserts that the PreimageOracle contract is valid.
function assertValidPreimageOracle(
string memory _errors,
IPreimageOracle _oracle,
Expand All @@ -623,6 +693,7 @@ contract StandardValidator {
return _errors;
}

/// @notice Internal function to require a condition to be true, otherwise append an error message.
function internalRequire(
bool _condition,
string memory _message,
Expand All @@ -643,11 +714,13 @@ contract StandardValidator {
return _errors;
}

/// @notice Validates the configuration of the L1 contracts.
function validate(ValidationInput memory _input, bool _allowFailure) external view returns (string memory) {
return
validate(_input, _allowFailure, ValidationOverrides({ l1PAOMultisig: address(0), challenger: address(0) }));
}

/// @notice Validates the configuration of the L1 contracts.
function validate(
ValidationInput memory _input,
bool _allowFailure,
Expand Down