Skip to content
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.

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

Ra N06 add named parameters and improve descriptions #305

Merged
merged 2 commits into from
Apr 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -26,31 +26,31 @@ contract StateTransitionManager is IStateTransitionManager, ReentrancyGuard, Own
/// @notice Address of the bridgehub
address public immutable bridgehub;

/// @notice chainId => chainContract
mapping(uint256 => address) public stateTransition;
/// @notice The mapping from chainId => chainContract
mapping(uint256 chainId => address chainContract) public stateTransition;

/// @dev Batch hash zero, calculated at initialization
/// @dev The batch zero hash, calculated at initialization
bytes32 public storedBatchZero;

/// @dev Stored cutData for diamond cut
/// @dev The stored cutData for diamond cut
bytes32 public initialCutHash;

/// @dev genesisUpgrade contract address, used to setChainId
/// @dev The genesisUpgrade contract address, used to setChainId
address public genesisUpgrade;

/// @dev current protocolVersion
/// @dev The current protocolVersion
uint256 public protocolVersion;

/// @dev validatorTimelock contract address, used to setChainId
/// @dev The validatorTimelock contract address, used to setChainId
address public validatorTimelock;

/// @dev Stored cutData for upgrade diamond cut. protocolVersion => cutHash
mapping(uint256 => bytes32) public upgradeCutHash;
/// @dev The stored cutData for upgrade diamond cut. protocolVersion => cutHash
mapping(uint256 protocolVersion => bytes32 cutHash) public upgradeCutHash;

/// @dev used to manage non critical updates
/// @dev The address used to manage non critical updates
address public admin;

/// @dev used to accept the admin role
/// @dev The address to accept the admin role
address private pendingAdmin;

/// @dev Contract is expected to be used as proxy implementation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ contract ValidatorTimelock is IExecutor, Ownable2Step {
IStateTransitionManager public stateTransitionManager;

/// @dev The mapping of L2 chainId => batch number => timestamp when it was committed.
mapping(uint256 => LibMap.Uint32Map) internal committedBatchTimestamp;
mapping(uint256 chainId => LibMap.Uint32Map batchNumberToTimestampMapping) internal committedBatchTimestamp;

/// @dev The address that can commit/revert/validate/execute batches.
mapping(uint256 _chainId => mapping(address _validator => bool)) public validators;
Expand Down
Loading