Skip to content

Commit

Permalink
DualGovernance and Timelock section comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Psirex committed Sep 25, 2024
1 parent 0c8f50e commit 2b9b021
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
12 changes: 8 additions & 4 deletions contracts/DualGovernance.sol
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ contract DualGovernance is IDualGovernance {
event ResealCommitteeSet(address resealCommittee);

// ---
// Sanity Check Parameters
// Sanity Check Parameters & Immutables
// ---

/// @notice The parameters for the sanity checks.
Expand Down Expand Up @@ -138,6 +138,10 @@ contract DualGovernance is IDualGovernance {
/// period of time when the Dual Governance proposal adoption is blocked.
address internal _resealCommittee;

// ---
// Constructor
// ---

constructor(ExternalDependencies memory dependencies, SanityCheckParams memory sanityCheckParams) {
TIMELOCK = dependencies.timelock;
RESEAL_MANAGER = dependencies.resealManager;
Expand Down Expand Up @@ -471,11 +475,11 @@ contract DualGovernance is IDualGovernance {
}

// ---
// Reseal executor
// Sealables Resealing
// ---

/// @notice Allows the reseal committee to "reseal" (pause indefinitely) an instance of a sealable contract through
/// the ResealManager contract.
/// the ResealManager contract.
/// @param sealable The address of the sealable contract to be resealed.
function resealSealable(address sealable) external {
_stateMachine.activateNextState(ESCROW_MASTER_COPY);
Expand All @@ -498,7 +502,7 @@ contract DualGovernance is IDualGovernance {
}

// ---
// Private methods
// Internal methods
// ---

function _checkCallerIsAdminExecutor() internal view {
Expand Down
2 changes: 1 addition & 1 deletion contracts/EmergencyProtectedTimelock.sol
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ contract EmergencyProtectedTimelock is IEmergencyProtectedTimelock {
}

// ---
// Private Methods
// Internal Methods
// ---

function _checkCallerIsAdminExecutor() internal view {
Expand Down

0 comments on commit 2b9b021

Please sign in to comment.